list-tool 1.0.0

data/spec/list_tool/item_spec.rb

@@ -0,0 +1,42 @@
+require_relative '../spec_helper.rb'
+
+describe ListTool::Item do
+  let (:item){ListTool::Item.new(Factory.item)}
+  
+  describe '#initialize' do
+
+    context 'hash given' do
+      context 'success' do
+        it 'stores text' do
+          expect(item.text).to eq 'item1'
+        end
+      end
+
+      context 'failure' do
+        it 'raises ArgumentError' do
+          expect{ ListTool::Item.new({"text" => 123}) }.to raise_error(ArgumentError)
+        end
+      end
+    end
+
+    context 'string given' do
+      it 'stores text' do
+        expect(ListTool::Item.new('text').text).to eq 'text'
+      end
+    end
+
+    context 'wrong argument given' do
+      it 'raises ArgumentError' do
+        expect{ListTool::Item.new(123)}.to raise_error(ArgumentError)
+      end
+    end
+
+  end
+
+  describe '#to_json' do
+    it 'returns correct json' do
+      expect(item.to_json).to eq "{\"text\":\"item1\"}"
+    end
+  end
+
+end

data/spec/list_tool/json_parser_spec.rb

@@ -0,0 +1,14 @@
+require_relative '../spec_helper.rb'
+
+describe ListTool::JsonParser do
+
+  describe '.parse' do
+    it 'parses json' do
+      json = "{\"test\":0}"
+      allow(JSON).to receive(:parse).with(json).and_return({'test'=>0})
+
+      expect( ListTool::JsonParser.parse(json) ).to eq({"test" => 0})
+    end
+  end 
+
+end

data/spec/list_tool/list_spec.rb

@@ -0,0 +1,221 @@
+require_relative '../spec_helper.rb'
+
+describe ListTool::List do
+
+  let (:list) { ListTool::List.new(Factory.list) }
+
+  describe '#initialize' do
+
+    it 'stores items' do
+      expect(list.items[0]).to be_an_instance_of(ListTool::Item)
+    end
+
+    context 'hash given' do
+
+      context 'correct' do
+        it 'stores list name' do
+          expect(list.name).to eq 'Todolist'
+        end
+
+        it 'stores 2 items' do
+          expect(list.items.length).to eq 2
+        end
+
+      end
+
+      context 'incorrect' do
+        context 'name is not a string' do
+          it 'raises ArgumentError' do
+            expect{ListTool::List.new({'name' => 123, 'items' => []})}.to raise_error(ArgumentError)
+          end
+        end
+
+        context 'items is not an array or nil' do
+          it 'raises ArgumentError' do
+            expect{ListTool::List.new({'name' => 'name', 'items' => 'not an array'})}.to raise_error(ArgumentError)
+          end
+        end
+
+        context 'items is nil' do
+          it 'creates list with no items' do
+            expect(ListTool::List.new({'name' => 'name'}).items.length).to be 0
+          end
+        end
+      end
+
+    end
+
+    context 'string given' do
+      let (:list) { ListTool::List.new('name') }
+
+      it 'creates blank list' do
+        expect(list.items).to be_empty
+      end
+
+      it 'stores name' do
+        expect(list.name).to eq 'name'
+      end
+
+    end
+
+    context 'wrong argument given' do
+      it 'raises ArgumentError' do
+        expect{ListTool::List.new(123)}.to raise_error(ArgumentError)
+      end
+    end
+
+  end
+
+
+  describe '#clear!' do
+    it "clears items array" do
+      list.clear!
+      expect(list.items).to be_empty
+    end
+  end
+
+
+  describe '#rename' do
+    context 'argument is a string' do
+      it 'renames list' do
+        list.rename('new name')
+        expect(list.name).to eq 'new name'
+      end
+
+      it 'returns old name' do
+        expect( list.rename('new name') ).to eq 'Todolist'
+      end
+    end
+
+    context 'argument is not a string' do
+      it 'raises ArgumentError' do
+        expect{list.rename(123)}.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe '#add_item' do
+    it 'adds item to self' do
+      list.add_item('new item')
+      expect(list.items.length).to eq 3
+    end
+
+    it 'returns not nil' do
+      expect(list.add_item('new item')).not_to be_nil
+    end
+  end
+
+  describe '#delete_item' do
+
+    context 'success' do
+      it 'removes item with given number' do
+        list.delete_item(1)
+        expect(list.items[1]).to be_nil
+      end
+
+      it 'returns not nil' do
+        expect( list.delete_item(1) ).not_to be_nil
+      end
+    end
+
+    context 'no item with given number' do
+      it 'returns nil' do
+        expect( list.delete_item(3) ).to be_nil
+      end 
+    end
+  end
+
+  describe '#change_item' do
+    context 'success' do
+      it 'replaces text of speified item' do
+        list.change_item(1, 'new_text')
+        expect(list.items[1].text).to eq 'new_text'
+      end
+
+      it 'returns not nil' do
+        expect( list.change_item(1, 'new_text') ).not_to be_nil
+      end
+    end
+
+    context 'failure' do
+
+      context 'no item with given index' do
+        it 'returns nil' do
+          expect( list.change_item(3, 'test') ).to be_nil
+        end
+      end
+
+      context 'index is not an integer' do
+        it 'raises ArgumentError' do
+          expect{ list.change_item('abc', 'test') }.to raise_error(ArgumentError)
+        end
+      end
+
+      context 'new_text is not a string' do
+        it 'raises ArgumentError' do
+          expect{ list.change_item(0, 1) }.to raise_error(ArgumentError)
+        end
+      end
+
+    end
+  end
+
+  describe '#move_item' do
+
+    context 'correct pos given' do
+      it 'moves item up' do
+        list.move_item(1, :up)
+        expect(list.items[0].text).to eq 'item2'
+      end
+
+      it 'moves item down' do
+        list.move_item(0, :down)
+        expect(list.items[1].text).to eq 'item1'
+      end
+
+      it 'returns not nil' do
+        expect( list.move_item(1, :up) ).not_to be_nil
+      end
+    end
+
+    context 'incorrect pos given' do
+
+      context 'too high pos' do
+        it 'does nothing when moving up' do
+          items = list.items.dup
+          list.move_item(2, :up)
+          expect(list.items).to eq items
+        end
+
+        it 'does nothing when moving down' do
+          items = list.items.dup
+          list.move_item(2, :down)
+          expect(list.items).to eq items
+        end
+      end
+
+      context 'too low pos' do
+        it 'does nothing when moving up' do
+          items = list.items.dup
+          list.move_item(0, :up)
+          expect(list.items).to eq items
+        end
+
+        it 'does nothing when moving down' do
+          items = list.items.dup
+          list.move_item(-1, :down)
+          expect(list.items).to eq items
+        end
+      end
+    end
+
+  end
+
+  describe '#to_json' do
+    it 'returns json representation of list' do
+      json_str = "{\"name\":\"Todolist\",\"items\":[{\"text\":\"item1\"},{\"text\":\"item2\"}]}"
+      expect(list.to_json).to eq json_str
+    end
+  end
+
+end

data/spec/list_tool/lister_spec.rb

@@ -0,0 +1,186 @@
+require_relative '../spec_helper.rb'
+
+describe ListTool::Lister do
+  let(:lister){ ListTool::Lister.from_hash(Factory.data) }
+
+  describe '#initialize' do
+
+    it 'creates Lister with empty data' do
+      expect(ListTool::Data).to receive(:new).with no_args
+      ListTool::Lister.new
+    end
+
+  end
+
+
+  describe '.from_hash' do
+    it 'creates new Lister from given hash' do
+      expect( lister.lists ).to eq( {'Todolist'=>2, 'Wishlist'=>0} )
+    end
+  end
+
+
+  describe '.from_json' do
+    it 'creates new Lister from given json string' do
+      allow( ListTool::JsonParser ).to receive(:parse).and_return(Factory.data)
+
+      lister = ListTool::Lister.from_json( Factory.json )
+      expect( lister.lists ).to eq( {'Todolist'=>2, 'Wishlist'=>0} )
+    end
+  end
+
+
+  describe '#lists' do
+    it 'returna a hash of list names and item counts' do
+      expect( lister.lists ).to eq( {'Todolist'=>2, 'Wishlist'=>0} )
+    end
+  end
+
+
+  describe '#load' do
+    let (:lister){ListTool::Lister.new}
+
+    it 'loads data from given file' do
+      json = Factory.json
+      allow( ListTool::FileManager ).to receive(:load).and_return( json )
+      allow( ListTool::JsonParser ).to receive(:parse).with(json).and_return( Factory.data )
+      lister.load('data_file')
+      expect( lister.lists ).to eq( {'Todolist'=>2, 'Wishlist'=>0} )
+    end
+
+    it 'returns self' do
+      allow( ListTool::FileManager ).to receive(:load)
+      allow( ListTool::JsonParser ).to receive(:parse)
+      allow( ListTool::Data ).to receive(:new).and_return( ListTool::Data.new() )
+      expect( lister.load('data_file') ).to eq lister
+    end
+  end
+
+
+  describe '#save' do
+    let (:lister){ListTool::Lister.new}
+    let(:filename){ 'test_file' }
+
+    it 'calls FileManager.save to save its data to file' do
+      data = ListTool::Data.new
+      lister.instance_variable_set(:@data, data)
+      expect( ListTool::FileManager ).to receive(:save).with(filename, data)
+      lister.save(filename)
+    end
+  end
+
+
+  describe '#list' do
+
+    context 'success' do
+      context 'no options' do
+        it 'returns hash with list name and array of item texts' do
+          expect( lister.list(0) ).to eq( {name: 'Todolist', items: ['item1', 'item2']} )
+        end
+      end
+
+      context 'list number not given' do
+        it 'returns contents of default list' do
+          expect( lister.list ).to eq( {name: 'Todolist', items: ['item1', 'item2']} )
+        end
+      end
+    end
+
+    context 'failure' do
+      context 'no list with given index' do
+        it 'returns nil' do
+          expect( lister.list(2) ).to be_nil
+        end
+      end
+
+      context 'default list not set and list not given' do
+        it 'raises NoDefaultListError' do
+          lister = ListTool::Lister.new
+          expect{ lister.list }.to raise_error(ListTool::NoDefaultListError)
+        end
+      end
+    end
+
+  end
+
+
+  describe '#inspect' do
+    it "returns '#<ListTool:obj_id>'" do
+      expect( lister.inspect ).to eq "#<ListTool::Lister:0x#{lister.__id__.to_s(16)}>"
+    end
+  end
+
+
+  describe '#method_missing' do
+
+    context 'success' do
+
+      it 'returns self' do
+        expect( lister.add_item('text') ).to eq lister
+      end
+
+      context '_list method given' do
+        it 'deligates method call to @data' do
+          data = lister.instance_variable_get(:@data)
+          expect( data ).to receive(:add_list).with('new_list')
+          lister.add_list('new_list')
+        end
+      end
+
+      context '_item method given' do
+
+        context 'list number not specified' do
+          it 'deligates method call to default list' do
+            default_list = lister.instance_variable_get(:@data).default_list
+            expect( default_list ).to receive(:add_item).with('new_item')
+
+            lister.add_item('new_item')
+          end
+        end
+
+        context 'list number specified' do
+          it 'deligates method call to specified list' do
+            list = lister.instance_variable_get(:@data).lists[0]
+            expect( list ).to receive(:add_item).with('new_item')
+
+            lister.add_item('new_item', list: 0)
+          end
+        end
+
+      end
+
+    end
+
+    context 'failure' do
+
+      context 'call to unknown method' do
+        it 'raises NoMethodError' do
+          message = "undefined method 'no_such_method' for #{lister.inspect}"
+          expect{lister.no_such_method}.to raise_error(NoMethodError, message)
+        end
+      end
+
+      context 'no list with specified number' do
+        it 'returns nil' do
+          expect( lister.add_item('new_item', list: 3) ).to be_nil
+        end
+      end
+
+      context 'method returned nil' do
+        it 'returns nil' do
+          expect( lister.delete_item(3) ).to be_nil
+        end
+      end
+
+      context 'list number not specified and default list not set' do
+        it 'raises NoDefaultListError' do
+          lister = ListTool::Lister.new
+          expect{ lister.add_item('new item') }.to raise_error(ListTool::NoDefaultListError)
+        end
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+# require 'simplecov'
+# SimpleCov.start
+
+require 'rspec'
+require_relative '../lib/list_tool'
+require_relative 'support/factory'
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.mock_framework = :rspec
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/factory.rb

@@ -0,0 +1,33 @@
+require 'json'
+
+class Factory
+
+  def self.blank_data
+    {'lists'=>[]}
+  end
+
+  def self.raw_data
+    File.read(File.join('spec', 'fixtures', 'data.json'))
+  end
+
+  def self.json
+    data.to_json
+  end
+
+  def self.data
+    JSON.parse raw_data
+  end
+
+  def self.list
+    data['lists'][0]
+  end
+
+  def self.blank_list
+    data['lists'][1]
+  end
+
+  def self.item
+    list['items'][0]
+  end
+
+end