shopping-list 0.0.2

data/README

@@ -0,0 +1 @@
+Use this gem to mimic the behavior of a shopping list.

data/lib/shopping_list.rb

@@ -0,0 +1 @@
+require 'shopping_list/shopping_list'

data/lib/shopping_list/item.rb

@@ -0,0 +1,12 @@
+class Item
+
+  attr_accessor :name, :category
+
+  #When creating items, they must be given a name and a category.
+  def initialize(name, category)
+    self.name = name
+    self.category = category
+  end
+
+
+end

data/lib/shopping_list/shopping_list.rb

@@ -0,0 +1,82 @@
+require 'shopping_list/shopping_list_item'
+
+class ShoppingList
+
+  attr_reader :item_list
+
+  #An empty shopping list will be an empty
+  #array that will hold shopping list items.
+  def initialize
+    @item_list = []
+  end
+
+  #Adding a shopping list item to the list
+  #will increment the quantity of that item
+  #if it is already on the list.
+  def add_to_list(item, note = "")
+    current_item = contains?(item)
+    if current_item
+      current_item.increment_quantity
+    else
+      @item_list << ShoppingListItem.new(item, note)
+    end
+  end
+
+  #Return the item if it is already in the shopping
+  #list.
+  def contains?(item)
+    @item_list.find { |item_on_list| item_on_list.item == item}
+  end
+
+  #Edit the item's note only if it is in the 
+  #shopping list. Otherwise, return nil.
+  def edit_item_note(item, note)
+    current_item = contains?(item)
+    if current_item
+      current_item.edit_note(note)
+    else
+      nil
+    end
+  end
+
+  def clear_item_notes(item)
+    current_item = contains?(item)
+    if current_item
+      current_item.clear_notes()
+    end
+  end
+
+  #Change the item's quantity to the
+  #desired amount (qty). 
+  #--
+  #TODO: Should test what happens for negative quantities.
+  #++    
+  #If the desired amount is zero, then
+  #the item should be removed from
+  #the list.
+  def edit_item_quantity(item, qty)
+    current_item = contains?(item)
+    if current_item
+      current_item.edit_quantity(qty)
+      if qty == 0
+        remove_from_list(item)
+      end
+    else
+      nil
+    end
+  end
+
+  def remove_from_list(item)
+    current_item = contains?(item)
+    if current_item
+      @item_list.delete(current_item)
+    else
+      nil
+    end
+  end
+
+  def shopping_list_size
+    @item_list.size
+  end
+
+end

data/lib/shopping_list/shopping_list_item.rb

@@ -0,0 +1,44 @@
+class ShoppingListItem
+
+  attr_reader :item, :quantity, :note
+
+  #Create a shopping list item by
+  #passing in an item.
+  #Notes on an item do not have 
+  #to be set, as the default is
+  #an empty note.
+  def initialize(item, note = "")
+    @item = item
+    @quantity = 1
+    @note = note
+  end
+
+  def increment_quantity
+    @quantity += 1
+  end
+
+  def edit_quantity(qty)
+    @quantity = qty unless qty < 0
+  end
+
+  #Notes on a shopping list item
+  #will be separated by a newline.
+  #If using in a web app, the newline
+  #will not display. If this is the
+  #case, the newline might be replaced
+  #with a line break ( <br /> ).
+  def edit_note(note)
+    if !note.empty?
+      if @note.empty?
+        @note = note
+      else
+        @note << "\n" << note
+      end
+    end
+  end
+
+  def clear_notes()
+    @note = ""
+  end
+
+end

data/test/test_item.rb

@@ -0,0 +1,18 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require 'test/unit'
+require 'item'
+
+class TestItem < Test::Unit::TestCase
+  def setup
+    @item = Item.new('Apple', 'Produce')
+  end
+
+  def test_item_name
+    assert_equal('Apple', @item.name)
+  end
+
+  def test_item_category
+    assert_equal('Produce', @item.category)
+  end
+
+end

data/test/test_shopping_list.rb

@@ -0,0 +1,36 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require 'test/unit'
+require 'item'
+require 'shopping_list'
+
+class TestShoppingList < Test::Unit::TestCase
+
+  def setup
+    @shopping_list = ShoppingList.new()
+    @apple = Item.new('Apple', 'Produce')
+    @shopping_list.add_to_list(@apple, 'Granny Smith type.')
+  end
+
+  def test_apple_should_be_on_shopping_list
+    assert(@shopping_list.contains?(@apple), "Apple is not in the list!")
+  end
+
+  def test_shopping_list_should_be_empty
+    @shopping_list.remove_from_list(@apple)
+    assert_equal(0, @shopping_list.shopping_list_size)
+  end
+
+  def test_shopping_list_should_be_empty_when_quantity_is_changed_to_zero
+    @shopping_list.edit_item_quantity(@apple, 0)
+    assert_equal(0, @shopping_list.shopping_list_size)
+  end
+
+  def test_should_be_able_to_edit_an_item_note
+    assert_not_nil(@shopping_list.edit_item_note(@apple, "Test Note."))
+  end
+
+  def test_empty_note_will_do_nothing
+    assert_nil(@shopping_list.edit_item_note(@apple, ""))
+  end
+
+end

data/test/test_shopping_list_item.rb

@@ -0,0 +1,53 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib/shopping_list")
+require 'shopping_list_item'
+require 'item'
+require 'test/unit'
+
+class TestShoppingListItem < Test::Unit::TestCase
+
+  def setup
+    @shopping_list_item = ShoppingListItem.new(Item.new('Apple', 'Produce'))
+  end
+
+  def test_quantity_equals_one
+    assert_equal(1, @shopping_list_item.quantity)
+  end
+
+  def test_quantity_did_not_change
+    #negative quantities are not valid, so quantity will be unaffected
+    old_qty = @shopping_list_item.quantity
+    @shopping_list_item.edit_quantity(-1)
+    new_qty = @shopping_list_item.quantity
+
+    assert_equal(old_qty, new_qty)
+  end
+
+  def test_quantity_equals_zero
+    assert_equal(0, @shopping_list_item.edit_quantity(0))
+  end
+
+  def test_quantity_equals_thirty
+    assert_equal(30, @shopping_list_item.edit_quantity(30))
+  end
+
+  def test_increment_quantity
+    assert_equal(2, @shopping_list_item.increment_quantity)
+  end
+
+  def test_adding_a_note_when_note_is_empty
+    @shopping_list_item.edit_note("Granny Smith Type.")
+    assert_equal('Granny Smith Type.', @shopping_list_item.note)
+  end
+
+  def test_adding_a_note_when_note_is_not_empty
+    @shopping_list_item.edit_note("Granny Smith Type.")
+    @shopping_list_item.edit_note("")
+    @shopping_list_item.edit_note('Produce Section.')
+    assert_equal("Granny Smith Type.\nProduce Section.", @shopping_list_item.note)
+  end
+
+  def test_notes_should_be_empty_when_cleared
+    assert_equal("", @shopping_list_item.clear_notes)
+  end
+
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: shopping-list
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Miguel Patino
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-02 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: 
+email: chiomig@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib/shopping_list/item.rb
+- lib/shopping_list/shopping_list.rb
+- lib/shopping_list/shopping_list_item.rb
+- lib/shopping_list.rb
+- README
+- test/test_shopping_list_item.rb
+- test/test_shopping_list.rb
+- test/test_item.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: A gem to mimic a shopping list
+test_files: 
+- test/test_shopping_list_item.rb
+- test/test_shopping_list.rb
+- test/test_item.rb