fin 0.1.0

data/spec/fin/models/shared_examples.rb

@@ -0,0 +1,5 @@
+shared_examples_for 'model' do
+ it 'has index method' do
+   expect {subject.index }.to_not raise_error
+ end
+end

data/spec/fin/order_list_spec.rb

@@ -0,0 +1,140 @@
+require 'spec_helper'
+require 'fin/shared_examples.rb'
+
+describe Fin::OrderList do
+  subject { Fin::OrderList.new }
+  let(:item_index) { @item.id }
+  let (:new_item_book_index) {new_item.price}
+
+  before(:each) do
+    @item = Fin::Order.new :isin_id => 1234, :id => 0, :price => 20
+    @item1 = Fin::Order.new :isin_id => 1234, :id => 1, :price => 10
+    @same_isin_item = @item1
+    @item2 = Fin::Order.new :isin_id => 5678, :id => 2, :price => 10
+    @diff_isin_item = @item2
+    @zero_price_item = Fin::Order.new :isin_id => 1234, :id => 3, :price => 0
+    @repeat_item = Fin::Order.new :isin_id => 1234, :id => 0, :price => 13
+    @repeat_zero_price_item = Fin::Order.new :isin_id => 1234, :id => 0, :price => 0
+  end
+
+  it_behaves_like 'changed_list'
+
+  specify { subject.books.should be_empty }
+
+  it 'returns order_book for any isin_id, even if it was not initialized' do
+    order_book = subject.books[1313]
+    order_book.should_not be_nil
+    order_book.should be_an Fin::Book
+    order_book.should be_empty
+  end
+
+  describe 'adding item' do
+    let(:expected_number_of_books) { 1 }
+
+    context 'to empty OrderList' do
+      let(:new_item) { @item }
+
+      it_behaves_like 'adding_item_to_books'
+
+      context 'with zero price' do
+        let(:new_item) { @zero_price_item }
+
+        it_behaves_like 'not_adding_item_to_books'
+      end
+    end
+
+    context 'to non-empty OrderList' do
+      before(:each) do
+        subject.add(@item).size.should == 1
+      end
+
+      context 'with existing isin' do
+        let(:new_item) { @same_isin_item }
+
+        it_behaves_like 'adding_item_to_books'
+      end
+
+      context 'with different isin' do
+        let(:new_item) { @diff_isin_item }
+        let(:expected_number_of_books) { 2 }
+
+        it_behaves_like 'adding_item_to_books'
+      end
+
+      context 'with zero price' do
+        let(:new_item) { @zero_price_item }
+
+        it_behaves_like 'not_adding_item_to_books'
+      end
+
+      context 'with repeat isin/id and non-zero price' do
+        let(:new_item) { @repeat_item }
+
+        it_behaves_like 'adding_item_to_books'
+
+        it 'changes price of item in list' do
+          subject.add new_item
+          subject[item_index].price.should_not == @item.price
+          subject[item_index].price.should == @repeat_item.price
+        end
+
+        it 'removes old item from appropriate order book' do
+          subject.add new_item
+          order_book = subject.books[@item.isin_id]
+          order_book.should_not have_key @item.price
+        end
+      end
+
+      context 'with repeat isin/id and zero price' do
+        let(:new_item) { @repeat_zero_price_item }
+
+        it_behaves_like 'not_adding_item_to_books'
+
+        it 'removes old item from appropriate order book' do
+          subject.add new_item
+          order_book = subject.books[@item.isin_id]
+          order_book.should_not have_key @item.price
+          order_book.size.should == 0
+        end
+      end
+    end
+  end
+
+  describe 'removing item' do
+    before(:each) do
+      subject.add(@item).size.should == 1
+    end
+
+    context 'with existing item' do
+      let(:unwanted_item) { @item }
+      let(:expected_size) { 0 }
+
+      it 'deletes item from the list' do
+        subject.remove(unwanted_item)
+        subject[unwanted_item.id].should == nil
+        subject.size.should == expected_size
+      end
+
+      it 'removes item from its related order book' do
+        subject.remove(unwanted_item)
+        subject.books[unwanted_item.isin_id].should_not have_key unwanted_item.price
+      end
+    end
+
+    context 'with non-existing item' do
+      let(:unwanted_item) { @item1 }
+      let(:expected_size) { 1 }
+
+      it 'still returns the list itself' do
+        subject.remove(unwanted_item).should == subject
+      end
+
+      it 'deletes nothing from the list' do
+        subject.remove(unwanted_item)
+        subject[item_index].should == @item
+        subject.size.should == expected_size
+      end
+    end
+  end
+end
+

data/spec/fin/shared_examples.rb

@@ -0,0 +1,355 @@
+shared_examples_for 'removing items' do
+  context 'removing existing item' do
+    it 'returns to indicate success' do
+      remove_operation(@item).should == returns_if_remove_success #@item
+    end
+
+    it 'removes item from indexed list' do
+      remove_operation(@item)
+      subject.values.should_not include @item
+      subject.should_not have_key item_index
+      subject[item_index].should == nil
+    end
+
+    it 'does not remove other items' do
+      remove_operation(@item)
+      subject.values.should include @item1
+      subject.size.should == 1
+    end
+  end
+
+  context 'deleting non-included items' do
+    it 'returns to indicate failure' do
+      remove_operation(@item2).should == returns_if_remove_failed #nil
+    end
+
+    it 'removes nothing from the list' do
+      remove_operation(@item2)
+      subject.values.should include @item, @item1
+      subject.size.should == 2
+    end
+
+    it 'does not raise if given nonsense instead of proper item to delete' do
+      [nil, 0, 123, 'nonsense', [1, 2, 3], {:this => 'sucks'}].each do |non_item|
+        remove_operation(non_item)
+      end
+    end
+  end
+end
+
+shared_examples_for 'adding items' do
+  it 'runs check on item' do
+    subject.should_receive(:check).with(@item)
+    add_operation(@item)
+  end
+
+  it 'adds item only if it passes check' do
+    subject.should_receive(:check).with(@item).and_return(false)
+    add_operation(@item).should == returns_if_add_failed
+    subject.values.should_not include @item
+    subject.should_not have_key item_index
+    subject.size.should == 0
+  end
+
+  it 'returns either self or item in case of success' do
+    add_operation(@item).should == returns_if_add_success
+  end
+
+  it 'adds items to indexed list' do
+    add_operation(@item)
+    subject.values.should include @item
+    subject.should have_key item_index
+    subject[item_index].should == @item
+    subject.size.should == 1
+  end
+
+  it 'does not add same items twice' do
+    subject.add(@item)
+    add_operation(@item)
+    subject.values.should include @item
+    subject.should have_key item_index
+    subject[item_index].should == @item
+    subject.size.should == 1
+  end
+
+  it 'even adds item using << as alias to #add' do
+    subject << @item
+    subject.values.should include @item
+    subject.should have_key item_index
+    subject[item_index].should == @item
+    subject.size.should == 1
+  end
+end
+
+
+shared_examples_for 'changed_list' do
+  it_behaves_like 'index_list'
+
+  it 'has changed and updated attributes, true at creation' do
+    subject.changed.should == true
+    subject.updated.should == true
+  end
+
+  it 'has change_count attribute, 0 at creation' do
+    subject.change_count.should == 0
+  end
+
+  it 'allows setting of updated attribute externally' do
+    subject.updated = false
+    subject.updated.should == false
+    subject.updated = true
+    subject.updated.should == true
+  end
+
+  context 'when item is being added to list' do
+    before(:each) { subject.changed = false; subject.updated = false }
+
+    context 'successfully' do
+      it 'auto-sets changed attribute, but not updated attribute' do
+        subject.add @item
+        subject.changed.should == true
+        subject.updated.should == false
+      end
+
+      it 'increases changed_count' do
+        subject.add @item
+        subject.change_count.should == 1
+      end
+    end
+
+    unless described_class == Fin::ChangedList # it can add ANYTHING...
+      context 'unsuccessfully' do
+        [nil, "none", 1313, [1, 2, 3]].each do |non_item|
+          it 'doesn`t set changed or updated attributes' do
+            subject.add non_item
+            subject.changed.should == false
+            subject.updated.should == false
+          end
+
+          it 'doesn`t increase changed_count' do
+            subject.add non_item
+            subject.change_count.should == 0
+          end
+        end
+      end
+    end
+  end
+
+  context 'when item is being removed from list' do
+    before(:each) do
+      subject.add(@item)
+      subject.changed = false
+      subject.updated = false
+    end
+
+    context 'successfully' do
+      it 'auto-sets changed attribute, but not updated attribute' do
+        subject.remove @item
+        subject.changed.should == true
+        subject.updated.should == false
+      end
+
+      it 'increases changed_count' do
+        subject.remove @item
+        subject.change_count.should == 2 # added, then removed
+      end
+    end
+
+    context 'unsuccessfully' do
+      [nil, "none", 1313, [1, 2, 3], @item1].each do |non_item|
+        it ' doesn`t set changed or updated attributes' do
+          subject.remove non_item
+          subject.changed.should == false
+          subject.updated.should == false
+        end
+
+        it 'doesn`t increase changed_count' do
+          subject.remove non_item
+          subject.change_count.should == 1 # initial addition, but not removal
+        end
+      end
+    end
+  end
+end
+
+
+shared_examples_for 'index_list' do
+
+  describe 'items get/set' do
+    it 'returns item from list by their index' do
+      p subject.add(@item)
+      p item_index
+      subject[item_index].should == @item
+    end
+
+    it 'returns nil when item with requested index not in collection' do
+      subject[item_index].should == nil
+    end
+
+    it 'is not possible to add item into collection directly' do
+      expect { subject[item_index] = @item }.to raise_error NoMethodError
+    end
+  end
+
+  describe '#index' do
+    it 'indexes arbitrary items by their index (redefined in subclasses)' do
+      subject.index(@item).should == item_index
+    end
+  end
+
+  describe '#add?' do
+    def add_operation item
+      subject.add? item
+    end
+
+    let(:returns_if_add_success) { @item }
+    let(:returns_if_add_failed) { nil }
+    it_behaves_like 'adding items'
+  end
+
+  describe '#add' do
+    def add_operation item
+      subject.add item
+    end
+
+    let(:returns_if_add_success) { subject }
+    let(:returns_if_add_failed) { subject }
+    it_behaves_like 'adding items'
+  end
+
+  context 'with couple of items in the list' do
+    before(:each) { subject.add(@item).add(@item1).size.should == 2 }
+
+    describe '#remove?' do
+      def remove_operation item
+        subject.remove? item
+      end
+
+      let(:returns_if_remove_success) { @item }
+      let(:returns_if_remove_failed) { nil }
+      it_behaves_like 'removing items'
+    end
+
+    describe '#remove' do
+      def remove_operation item
+        subject.remove item
+      end
+
+      let(:returns_if_remove_success) { subject }
+      let(:returns_if_remove_failed) { subject }
+      it_behaves_like 'removing items'
+    end
+
+    describe '#clear' do
+      context 'without block' do
+        it 'removes all items from list' do
+          subject.clear
+          subject.should be_empty
+        end
+
+        it 'ensures that #remove method is called once for each item in list' do
+          subject.should_receive(:remove).twice
+          subject.clear
+        end
+      end
+
+      context 'with block given' do
+        it 'yields items from list in index order' do
+          @count = 0
+          @items = []
+          subject.clear do |item|
+            @count += 1
+            @items << item
+          end
+          @count.should == 2
+          if subject.index(@item) < subject.index(@item1)
+            @items.should == [@item, @item1]
+          else
+            @items.should == [@item1, @item]
+          end
+        end
+
+        it 'only removes items for which given block returns true' do
+          subject.should_receive(:remove).once
+          subject.clear { |item| true if item == @item1 }
+          subject.should have_key item_index
+        end
+      end
+    end
+
+    describe '#each' do
+      it 'yields items from list in index order' do
+        @count = 0
+        @items = []
+        subject.each do |item|
+          @count += 1
+          @items << item
+        end
+        @count.should == 2
+        if subject.index(@item) < subject.index(@item1)
+          @items.should == [@item, @item1]
+        else
+          @items.should == [@item1, @item]
+        end
+      end
+
+      it 'returns list item in array, sorted by their index, if no block given' do
+        if subject.index(@item) < subject.index(@item1)
+          subject.each.should == [@item, @item1]
+        else
+          subject.each.should == [@item1, @item]
+        end
+      end
+    end
+  end
+end
+
+shared_examples_for 'adding_item_to_books' do
+  it_behaves_like 'creating_books'
+
+  it 'adds this item to appropriate book' do
+    subject.add new_item
+    book = subject.books[new_item.isin_id]
+    book.should have_key new_item_book_index
+    book[new_item_book_index].should == new_item
+  end
+end
+
+shared_examples_for 'not_adding_item_to_books' do
+  it_behaves_like 'creating_books'
+
+  it 'does not add this item to list' do
+    subject.add new_item
+    book = subject.books[new_item.isin_id]
+    book.should_not have_key new_item_book_index
+    book[new_item_book_index].should == nil
+  end
+end
+
+shared_examples_for 'creating_books' do
+  it 'creates appropriate order book' do
+    subject.add(new_item)
+    subject.books.should have(expected_number_of_books).books
+    book = subject.books[new_item.isin_id]
+    book.should be_an Fin::Book
+    book.isin_id.should == new_item.isin_id
+  end
+
+  it 'sets item`s book property correctly' do
+    subject.add(new_item)
+    book = subject.books[new_item.isin_id]
+    if new_item_book_index == 0
+      case subject
+        when Fin::OrderList
+          new_item.book.should == nil
+        else
+          new_item.book.should == book
+      end
+    else
+      new_item.book.should == book
+    end
+  end
+end
+
+
+