Class: PackwizardParser::Item

Inherits:
Object
  • Object
show all
Defined in:
lib/packwizard_parser/item.rb

Overview

Represents a single item in a PackWizard list

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, weight:, total_weight:, quantity:, description: nil, image_url: nil, consumable: false, total_consumable_weight: nil, worn: false, worn_quantity:, total_worn_weight:) ⇒ Item

Returns a new instance of Item.

Parameters:

  • name (String) —

    The name of the item

  • description (String, nil) (defaults to: nil) —

    Optional description

  • weight (Float) —

    Weight per item in grams

  • total_weight (Float) —

    Total weight (weight * quantity) in grams

  • quantity (Integer) —

    Number of items

  • image_url (String, nil) (defaults to: nil) —

    Optional URL to item image

  • consumable (Boolean) (defaults to: false) —

    Whether the item is consumable

  • total_consumable_weight (Float, nil) (defaults to: nil) —

    Total consumable weight if consumable

  • worn (Boolean) (defaults to: false) —

    Whether the item is worn

  • worn_quantity (Integer) —

    Number of worn items (1 if worn)

  • total_worn_weight (Float) —

    Total worn weight if worn



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/packwizard_parser/item.rb', line 32

def initialize(name:, weight:, total_weight:, quantity:, description: nil,
               image_url: nil, consumable: false, total_consumable_weight: nil,
               worn: false, worn_quantity:, total_worn_weight:)
  @name = name
  @weight = weight
  @description = description
  @total_weight = total_weight
  @quantity = quantity
  @image_url = image_url
  @consumable = consumable
  @total_consumable_weight = total_consumable_weight
  @worn = worn
  @worn_quantity = worn_quantity
  @total_worn_weight = total_worn_weight
end

Instance Attribute Details

#consumable ⇒ Boolean (readonly) Also known as: consumable?

Whether the item is consumable

Returns:

  • (Boolean) —

    the current value of consumable



18
19
20
 
# File 'lib/packwizard_parser/item.rb', line 18

def consumable
  @consumable
end

#description ⇒ String? (readonly)

Optional description of the item

Returns:

  • (String, nil) —

    the current value of description



18
19
20
 
# File 'lib/packwizard_parser/item.rb', line 18

def description
  @description
end

#image_url ⇒ String? (readonly)

Optional URL to item image

Returns:

  • (String, nil) —

    the current value of image_url



18
19
20
 
# File 'lib/packwizard_parser/item.rb', line 18

def image_url
  @image_url
end

#name ⇒ String (readonly)

The name of the item

Returns:

  • (String) —

    the current value of name



18
19
20
 
# File 'lib/packwizard_parser/item.rb', line 18

def name
  @name
end

#price ⇒ Object (readonly)

Returns the value of attribute price.



19
20
21
 
# File 'lib/packwizard_parser/item.rb', line 19

def price
  @price
end

#quantity ⇒ Integer (readonly)

Number of items

Returns:

  • (Integer) —

    the current value of quantity



18
19
20
 
# File 'lib/packwizard_parser/item.rb', line 18

def quantity
  @quantity
end

#total_consumable_weight ⇒ Float? (readonly)

Total consumable weight (weight * quantity) if consumable, nil otherwise

Returns:

  • (Float, nil) —

    the current value of total_consumable_weight



18
19
20
 
# File 'lib/packwizard_parser/item.rb', line 18

def total_consumable_weight
  @total_consumable_weight
end

#total_price ⇒ Object (readonly)

Returns the value of attribute total_price.



19
20
21
 
# File 'lib/packwizard_parser/item.rb', line 19

def total_price
  @total_price
end

#total_weight ⇒ Float (readonly)

Total weight (weight * quantity) in grams

Returns:

  • (Float) —

    the current value of total_weight



18
19
20
 
# File 'lib/packwizard_parser/item.rb', line 18

def total_weight
  @total_weight
end

#total_worn_weight ⇒ Float (readonly)

Total worn weight (weight * 1) if worn, 0.0 otherwise

Returns:

  • (Float) —

    the current value of total_worn_weight



18
19
20
 
# File 'lib/packwizard_parser/item.rb', line 18

def total_worn_weight
  @total_worn_weight
end

#weight ⇒ Float (readonly)

Weight per item in grams

Returns:

  • (Float) —

    the current value of weight



18
19
20
 
# File 'lib/packwizard_parser/item.rb', line 18

def weight
  @weight
end

#worn ⇒ Boolean (readonly) Also known as: worn?

Whether the item is worn

Returns:

  • (Boolean) —

    the current value of worn



18
19
20
 
# File 'lib/packwizard_parser/item.rb', line 18

def worn
  @worn
end

#worn_quantity ⇒ Integer (readonly)

Number of worn items (always 1 if worn, 0 otherwise)

Returns:

  • (Integer) —

    the current value of worn_quantity



18
19
20
 
# File 'lib/packwizard_parser/item.rb', line 18

def worn_quantity
  @worn_quantity
end

Instance Method Details

#to_h ⇒ Hash

Convert to hash

Returns:

  • (Hash) —

    Hash representation of the item



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/packwizard_parser/item.rb', line 55

def to_h
  {
    name: name,
    description: description,
    weight: weight,
    total_weight: total_weight,
    quantity: quantity,
    image_url: image_url,
    consumable: consumable,
    total_consumable_weight: total_consumable_weight,
    worn: worn,
    worn_quantity: worn_quantity,
    total_worn_weight: total_worn_weight
  }
end