wherever-positions 0.1.1

data/spec/wherever/custom_grouping_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe Wherever, 'with a custom grouping' do
+  let(:create_options) { ["keys" => keys, "database" => 'wherever_test', "key_groups" => key_groups, "key" => "trade_id"] }
+  let(:wherever) { 
+    Wherever.new(*create_options) do |values, data, record, keys|
+      values["settled"] += data["settled"]
+      values["unsettled"] += data["settled"] * -2.5
+    end
+  }
+
+  context 'add a record' do
+    let(:keys) { ["fund_id"] }
+    let(:key_groups) { nil }
+    let(:options) { {"unique" => {"trade_id" => 12, "version" => 1}, "keys" => {"fund_id" => 2}} }
+
+    before do
+      wherever.add({"settled" => 100, "unsettled" => 0}, options)
+    end
+    
+    it 'the identifier record' do
+      wherever.get_key_store("identifier").datasets.should ==
+          [DbStore::Dataset.new("values" => {"unsettled" => -250, "settled" => 100}, "fund_id" => 2, "version" => 1, "trade_id" => 12)] 
+    end
+
+    it 'the grouped record' do
+      wherever.get_key_store("fund").datasets.should ==
+          [DbStore::Dataset.new("values" => {"unsettled" => -250, "settled" => 100}, "fund_id" => 2)] 
+    end
+  end
+  
+  context 'get a record' do
+    let(:keys) { ["fund_id", "security_id"] }
+    let(:key_groups) { ["fund_id"] }
+    let(:options_one) { {"unique" => {"trade_id" => 12, "version" => 1}, "keys" => {"fund_id" => 2, "security_id" => 14}} }
+    let(:options_two) { {"unique" => {"trade_id" => 15, "version" => 1}, "keys" => {"fund_id" => 2, "security_id" => 14}} }
+
+    before do
+      wherever.add({"settled" => 100, "unsettled" => 0}, options_one)
+    end
+    
+    it 'gets the value for a non key field' do
+      wherever.get("security_id" => 14).should == {"settled" => 100, "unsettled" => -250}
+    end
+    
+    it 'gets the value for a non key field when multiple records' do
+      wherever.add({"settled" => 200, "unsettled" => 0}, options_two)
+      wherever.get("security_id" => 14).should == {"settled" => 300, "unsettled" => -750}
+    end
+  end
+end

data/spec/wherever/getter_spec.rb

@@ -0,0 +1,47 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Wherever" do
+  let(:wherever) { Wherever.new("keys" => keys, "database" => 'wherever_test', "key_groups" => key_groups, "key" => "trade_id") }
+  let(:keys) { ["fund_id"] }
+  let(:key_groups) { nil }
+
+  context 'getting the record data' do
+    before do
+      wherever.add({"settled" => 100, "unsettled" => 0}, {"unique" => {"trade_id" => 12, "version" => 2}, "keys" => {"fund_id" => 3}})
+    end
+
+    it 'for one of the key groups' do
+      wherever.get("fund_id" => 3).should == {"settled" => 100, "unsettled" => 0}
+    end
+    
+    it 'get a value that does not exist' do
+      wherever.get("fund_id" => 4).should == {}
+    end
+  end
+  
+  context 'a more complex example' do
+    let(:keys) { ["fund_id", "security_id"] }
+    let(:key_groups) { ["fund", ["fund", "security"]] }
+    let(:options) { {"unique" => {"trade_id" => 12, "version" => 2}, "keys" => {"fund_id" => 3, "security_id" => 12}} }
+    
+    before do
+      wherever.add({"settled" => 100, "unsettled" => 0}, options)
+    end
+    
+    it 'get by a single value key' do
+      wherever.get("fund_id" => 3).should == {"settled" => 100, "unsettled" => 0}
+    end
+
+    it 'get by a field that is not a key' do
+      wherever.get("security_id" => 12).should == {"settled" => 100, "unsettled" => 0}
+    end
+    
+    it 'get by a multi value key' do
+      wherever.get("fund_id" => 3, "security_id" => 12).should == {"settled" => 100, "unsettled" => 0}
+    end
+    
+    it 'invalid selector field' do
+      expect { wherever.get("broker_id" => 3) }.to raise_error InvalidSelector, "Unknown Selector: broker_id"
+    end
+  end
+end

data/spec/wherever/key_store_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Wherever" do
+  let(:wherever) { Wherever.new("keys" => keys, "database" => 'wherever_test', "key_groups" => key_groups, "key" => "trade_id") }
+  let(:keys) { ["fund_id"] }
+  let(:key_groups) { nil }
+    
+  context 'get the key store' do
+    context 'when a single element key' do
+      let(:store) { wherever.get_key_store("fund") }
+      it 'sets the class name' do
+        store.key.should == ["fund"]
+      end
+    end
+
+    context 'when a multiple element keys' do
+      let(:store) { wherever.get_key_store("fund", "security") }
+      it 'sets the class name' do
+        store.key.should == ["fund", "security"]
+      end
+    end
+  end
+end

data/spec/wherever/mark_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe Wherever, 'mark a time point' do
+  let(:create_options) { ["keys" => keys, "database" => 'wherever_test', "key_groups" => key_groups, "key" => "trade_id"] }
+  let(:wherever) { 
+    Wherever.new(*create_options) do |values, data, record, keys|
+      price = wherever.get_price(record.price, record)
+      if keys.include?("security_id")
+        values["position"] += data["position"] if data
+        values["price"] =  price
+      end
+      if data
+        values["trade_value"] += data["position"] * price
+      else
+        values["trade_value"] = values["position"] * price
+      end
+    end
+  }
+  let(:keys) { ["fund_id", "security_id"] }
+  let(:key_groups) { ["fund", "security", ["fund", "security"]] }
+  
+  let(:options_one) { {"unique" => {"trade_id" => 12, "version" => 1}, "keys" => {"fund_id" => 2, "security_id" => 4}} }
+  let(:options_two) { {"unique" => {"trade_id" => 14, "version" => 1}, "keys" => {"fund_id" => 2, "security_id" => 4}} }
+
+  before do
+    wherever.create_lookup('price', ["security_id"])
+    wherever.set_price('20111029_01', {4 => 12.5})
+    wherever.add({"position" => 100}, options_one)
+    wherever.mark('COB 20111009')
+  end
+
+  it 'can retrieve data via marker name' do
+    wherever.get({"fund_id" => 2}, 'COB 20111009').should == {"trade_value" => 1250}
+  end
+  
+  context 'adding new record' do
+    it 'does not change marker record' do
+      wherever.add({"position" => 100}, options_two)
+      wherever.get({"fund_id" => 2}, 'COB 20111009').should == {"trade_value" => 1250}
+      wherever.get({"fund_id" => 2}).should == {"trade_value" => 2500}
+    end
+  end
+  
+  context 'adding price data' do
+    it 'does not change marker record' do
+      wherever.set_price('20111029_02', {4 => 13.5})
+      wherever.get({"fund_id" => 2}, 'COB 20111009').should == {"trade_value" => 1250}
+      wherever.get({"fund_id" => 2}).should == {"trade_value" => 1350}
+    end
+  end
+end

data/spec/wherever/setter_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Wherever, 'setting values' do
+  let(:wherever) { Wherever.new("keys" => keys, "database" => 'wherever_test', "key_groups" => key_groups, "key" => "trade_id") }
+  let(:keys) { ["fund_id"] }
+  let(:key_groups) { nil }
+  
+  context 'data storage' do
+    before do
+      wherever.create_lookup('price', ["security_id"])
+    end
+    
+    it 'can save and retrieve version data' do
+      record = {"security_id" => 12}
+      wherever.set_price('current', {12 => 13.45})
+      wherever.get_price('current', record).should == 13.45
+    end
+    
+    it 'can not set the same version name twice' do
+      wherever.set_price('current', {12 => 13.45})
+      expect { wherever.set_price('current', {12 => 13.45}) }.to raise_error InvalidLookupSetter, "Lookup 'current' for 'price' already set"
+    end
+  end
+end

data/spec/wherever/using_lookup_in_grouping_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe Wherever, 'using lookup in grouping calculation' do
+  let(:create_options) { ["keys" => keys, "database" => 'wherever_test', "key_groups" => key_groups, "key" => "trade_id"] }
+  let(:wherever) { 
+    Wherever.new(*create_options) do |values, data, record, keys|
+      price = wherever.get_price(record.price, record)
+      if keys.include?("security_id")
+        values["position"] += data["position"] if data
+        values["price"] =  price
+      end
+      if data
+        values["trade_value"] += data["position"] * price
+      else
+        values["trade_value"] = values["position"] * price
+      end
+    end
+  }
+  let(:keys) { ["fund_id", "security_id"] }
+  let(:key_groups) { ["fund", "security", ["fund", "security"]] }
+  
+  context 'add record after price' do
+    context 'has the correct trade value calculation' do
+      let(:options_one) { {"unique" => {"trade_id" => 12, "version" => 1}, "keys" => {"fund_id" => 2, "security_id" => 4}} }
+      let(:options_two) { {"unique" => {"trade_id" => 12, "version" => 2}, "keys" => {"fund_id" => 2, "security_id" => 4}} }
+      let(:options_three) { {"unique" => {"trade_id" => 14, "version" => 1}, "keys" => {"fund_id" => 2, "security_id" => 4}} }
+
+      before do
+        wherever.create_lookup('price', ["security_id"])
+        wherever.set_price('current', {4 => 12.5})
+        wherever.add({"position" => 100}, options_one)
+      end
+      
+      it 'on identifier record' do
+        wherever.get_key_store("identifier").datasets.should ==
+            [DbStore::Dataset.new("values" => {"position" => 100, "price" => 12.5, "trade_value" => 1250}, 
+                "trade_id" => 12, "version" => 1, "fund_id" => 2, "security_id" => 4)] 
+      end
+      
+      it 'on fund record' do
+        wherever.get_key_store("fund").datasets.should ==
+            [DbStore::Dataset.new("values" => {"trade_value" => 1250}, "fund_id" => 2)] 
+      end
+
+      it 'on fund record with trade edit' do
+        wherever.add({"position" => 110}, options_two)
+        wherever.get_key_store("fund").datasets.should ==
+            [DbStore::Dataset.new("values" => {"trade_value" => 1375}, "fund_id" => 2)] 
+      end
+
+      it 'on fund record with two trades' do
+        wherever.add({"position" => 200}, options_three)
+        wherever.get_key_store("fund").datasets.should ==
+            [DbStore::Dataset.new("values" => {"trade_value" => 3750}, "fund_id" => 2)] 
+      end
+    end
+  end
+  
+  context 'add price after record' do
+    context 'has the correct trade value calculation' do
+      let(:options_one) { {"unique" => {"trade_id" => 12, "version" => 1}, "keys" => {"fund_id" => 2, "security_id" => 4}} }
+      let(:options_two) { {"unique" => {"trade_id" => 12, "version" => 2}, "keys" => {"fund_id" => 2, "security_id" => 4}} }
+      let(:options_three) { {"unique" => {"trade_id" => 14, "version" => 1}, "keys" => {"fund_id" => 2, "security_id" => 4}} }
+
+      before do
+        wherever.create_lookup('price', ["security_id"])
+        wherever.add({"position" => 100}, options_one)
+      end
+      
+      it 'on identifier record' do
+        wherever.create_lookup('price', ["security_id"])
+        wherever.set_price('current', {4 => 12.5})
+        wherever.get_key_store("identifier").datasets.should ==
+            [DbStore::Dataset.new("values" => {"position" => 100, "price" => 12.5, "trade_value" => 1250}, 
+                "trade_id" => 12, "version" => 1, "fund_id" => 2, "security_id" => 4)] 
+      end
+      
+      it 'on fund record' do
+        wherever.create_lookup('price', ["security_id"])
+        wherever.set_price('current', {4 => 12.5})
+        wherever.get_key_store("fund").datasets.should ==
+            [DbStore::Dataset.new("values" => {"trade_value" => 1250}, "fund_id" => 2)] 
+      end
+
+      it 'on fund record with trade edit' do
+        wherever.add({"position" => 110}, options_two)
+        wherever.create_lookup('price', ["security_id"])
+        wherever.set_price('current', {4 => 12.5})
+        wherever.get_key_store("fund").datasets.should ==
+            [DbStore::Dataset.new("values" => {"trade_value" => 1375}, "fund_id" => 2)] 
+      end
+
+      it 'on fund record with two trades' do
+        wherever.add({"position" => 200}, options_three)
+        wherever.set_price('current', {4 => 12.5})
+        wherever.get_key_store("fund").datasets.should ==
+            [DbStore::Dataset.new("values" => {"trade_value" => 3750}, "fund_id" => 2)] 
+      end
+    end
+  end
+end

data/wherever.gemspec

@@ -0,0 +1,98 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{wherever}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["David Henry"]
+  s.date = %q{2011-10-30}
+  s.description = %q{Allow Store of positions by multiple keys with teh option to mark specific points in time for use later}
+  s.email = %q{dw_henry@yahoo.com.au}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".rvmrc",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "features/step_definitions/wherever_steps.rb",
+    "features/support/env.rb",
+    "features/wherever.feature",
+    "lib/wherever.rb",
+    "lib/wherever/configure.rb",
+    "lib/wherever/db_store.rb",
+    "lib/wherever/db_store/dataset.rb",
+    "lib/wherever/db_store/identifier.rb",
+    "lib/wherever/db_store/lookup.rb",
+    "lib/wherever/db_store/marker.rb",
+    "lib/wherever/db_store/record_matcher.rb",
+    "lib/wherever/db_store/store.rb",
+    "lib/wherever/wherever.rb",
+    "lib/wherever/wherever/accessors.rb",
+    "lib/wherever/wherever/adder.rb",
+    "lib/wherever/wherever/getter.rb",
+    "lib/wherever/wherever/lookup.rb",
+    "lib/wherever/wherever/mark.rb",
+    "spec/spec_helper.rb",
+    "spec/wherever/adder_spec.rb",
+    "spec/wherever/custom_grouping_spec.rb",
+    "spec/wherever/getter_spec.rb",
+    "spec/wherever/key_store_spec.rb",
+    "spec/wherever/mark_spec.rb",
+    "spec/wherever/setter_spec.rb",
+    "spec/wherever/using_lookup_in_grouping_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/dw_henry/wherever}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Store and Retrieve positions by location}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<bson_ext>, [">= 0"])
+      s.add_runtime_dependency(%q<mongoid>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<cucumber>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<ruby-debug>, [">= 0"])
+      s.add_development_dependency(%q<database_cleaner>, [">= 0"])
+    else
+      s.add_dependency(%q<bson_ext>, [">= 0"])
+      s.add_dependency(%q<mongoid>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<cucumber>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<ruby-debug>, [">= 0"])
+      s.add_dependency(%q<database_cleaner>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<bson_ext>, [">= 0"])
+    s.add_dependency(%q<mongoid>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<cucumber>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<ruby-debug>, [">= 0"])
+    s.add_dependency(%q<database_cleaner>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,234 @@
+--- !ruby/object:Gem::Specification 
+name: wherever-positions
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- David Henry
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-30 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bson_ext
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :runtime
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :runtime
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  prerelease: false
+  type: :development
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  prerelease: false
+  type: :development
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  prerelease: false
+  type: :development
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  requirement: *id007
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  requirement: *id008
+- !ruby/object:Gem::Dependency 
+  name: database_cleaner
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  requirement: *id009
+description: Allow Store of positions by multiple keys with teh option to mark specific points in time for use later
+email: dw_henry@yahoo.com.au
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- features/step_definitions/wherever_steps.rb
+- features/support/env.rb
+- features/wherever.feature
+- lib/wherever.rb
+- lib/wherever/configure.rb
+- lib/wherever/db_store.rb
+- lib/wherever/db_store/dataset.rb
+- lib/wherever/db_store/identifier.rb
+- lib/wherever/db_store/lookup.rb
+- lib/wherever/db_store/marker.rb
+- lib/wherever/db_store/record_matcher.rb
+- lib/wherever/db_store/store.rb
+- lib/wherever/wherever.rb
+- lib/wherever/wherever/accessors.rb
+- lib/wherever/wherever/adder.rb
+- lib/wherever/wherever/getter.rb
+- lib/wherever/wherever/lookup.rb
+- lib/wherever/wherever/mark.rb
+- spec/spec_helper.rb
+- spec/wherever/adder_spec.rb
+- spec/wherever/custom_grouping_spec.rb
+- spec/wherever/getter_spec.rb
+- spec/wherever/key_store_spec.rb
+- spec/wherever/mark_spec.rb
+- spec/wherever/setter_spec.rb
+- spec/wherever/using_lookup_in_grouping_spec.rb
+- wherever.gemspec
+has_rdoc: true
+homepage: http://github.com/dw_henry/wherever
+licenses: 
+- MIT
+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.6.2
+signing_key: 
+specification_version: 3
+summary: Store and Retrieve positions by location
+test_files: []
+