wherever-positions 0.1.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create 1.8.7-p72@wherever

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+
+gem 'bson_ext'
+gem 'mongoid'
+
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "cucumber", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+  gem 'ruby-debug'
+  gem 'database_cleaner'
+  
+end

data/Gemfile.lock

@@ -0,0 +1,71 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.1.1)
+      activesupport (= 3.1.1)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activesupport (3.1.1)
+      multi_json (~> 1.0)
+    bson (1.4.1)
+    bson_ext (1.4.1)
+    builder (3.0.0)
+    columnize (0.3.4)
+    cucumber (1.1.0)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.2)
+      gherkin (~> 2.5.0)
+      json (>= 1.4.6)
+      term-ansicolor (>= 1.0.6)
+    database_cleaner (0.6.7)
+    diff-lcs (1.1.3)
+    gherkin (2.5.4)
+      json (>= 1.4.6)
+    git (1.2.5)
+    i18n (0.6.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json (1.6.1)
+    linecache (0.46)
+      rbx-require-relative (> 0.0.4)
+    mongo (1.4.1)
+      bson (= 1.4.1)
+    mongoid (2.3.2)
+      activemodel (~> 3.1)
+      mongo (~> 1.4)
+      tzinfo (~> 0.3.22)
+    multi_json (1.0.3)
+    rake (0.9.2.2)
+    rbx-require-relative (0.0.5)
+    rcov (0.9.11)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+    term-ansicolor (1.0.7)
+    tzinfo (0.3.30)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bson_ext
+  bundler (~> 1.0.0)
+  cucumber
+  database_cleaner
+  jeweler (~> 1.6.4)
+  mongoid
+  rcov
+  rspec (~> 2.3.0)
+  ruby-debug

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 David Henry
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,143 @@
+= WHEREVER
+
+Storage and retrieve of data for identifying keys, with advanced summary options.
+
+== Install
+
+gem install wherever
+
+== Setup
+
+Create a reference to the Gem:
+
+  Wherever.new("keys" => keys,
+               "database" => database,
+               "key_groups" => key_groups,
+               "key" => key)
+
+  keys =>       Key fields to be stored with individual records, fields my be listed here be used in key_groups below
+  database =>   Name of the Mongo DB to store the data in
+  key_groups => Field combinations to be used for grouping
+  key =>        Key for unique records in the dataset
+
+example:
+
+Store data with fields "group_one_id", "group_two_id" and "unique_id".
+Data should be grouped and stored for quick retrieval by "group_one_id" or "group_one_id" and "group_two_id".
+
+  @wherever = Wherever.new("keys" => ["group_one_id", "group_two_id"],
+                           "database" => "wherever_dev",
+                           "key_groups" => ["group_one_id", ["group_one_id", "group_two_id"]],
+                           "key" => "unique_id")
+               
+NOTE: In the previous example data could still be retrieved for grouping "group_two_id" but this would need to be calculated on the fly and would be significantly slower.
+
+The setup takes an optional block which can the be used to summarise the group data which takes the following parameters:
+  values => Hash to store the data in. (This should support summing of the data across multiple inserts)
+  data =>   Hash containing the data to be stored
+  record => MongoDB record for the unique record => useful to retrieve lookup data (see below)
+  keys =>   "key_group" that is currently being summarised.
+
+The below is the default grouping that is applied
+
+  @wherever = Wherever.new(*options) do |values, data, record, keys|
+    data.keys.each do  |key|
+      values[key] += data[key]
+    end
+  end
+
+
+== Data Insertion
+
+  @wherever.add(values, options)
+  
+  values =>     Raw data values to be stored. This should be a hash containing "version" and "key" (as defined on setup) values.
+  options =>    Relevant options relating to the data being inserted.  This should be a hash containing "unique" and "keys" values.
+      unique =>     This should be a hash containing "version" and "key" (as defined on setup) fields.
+      keys =>       This should be a hash with a value for each key defined in "keys" on setup.
+      
+== Data Retrieval
+
+  @wherever.get(options)
+  
+  options =>    Hash containing "keys" (for setup above) with desired lookup value.  
+                Data is returned as a hash the values which are stored on the record or generated via the summary block.
+
+== Data Lookup
+
+Store lookup data for the use in data summarisation block.
+
+In order to use a lookup store you first need to create it using:
+
+  @wherever.create_lookup(name, keys)
+  
+  name =>       Name of the lookup to be created.  This is used to create set_<name> and get_<name> methods for the lookup.
+  keys =>       Keys that are required to on the stored keys to correctly determine the correct lookup value
+  
+The setter method can then be used to store data:
+
+  wherever.set_<name>(lookup_version, data)
+  
+  lookup_version => This is used to allow storage of multiple sets of lookup values.
+                    * Recommend using the storage time as this must be a unique value.
+  data =>           Hash of the data to be stored.  The key should match to the "keys" fields declared above joined by "_" character.
+  
+The data can the be retrieved using the the getter method:
+
+  wherever.get_<name>(lookup_version, record)
+
+  lookup_version => This is used to allow storage of multiple sets of lookup values.
+                    * Recommend using the storage time as this must be a unique value.
+  record =>         This is a record that contains the required fields ("keys" in create above) to perform the lookup
+
+Lookups can then be used to create more sophisticated data summarisation process.
+
+example: The below is a complex summary method which is the main reason for building the whole gem (field names have been changed to protect the innocent).
+
+  Wherever.new(*options) do |values, data, record, keys|
+    value_two = wherever.get_lookup(record.lookup_key, record)
+    if keys.include?("group_one_id")
+      values["value_one"] += data["value_one"] if data
+      values["value_two"] =  value_two
+    end
+    if data
+      values["value_three"] += data["value_one"] * value_two
+    else
+      values["value_three"] = values["value_one"] * value_two
+    end
+  end
+  
+== Remaining Work
+
+* Allow marked points in time to be modified by changing the data version they represent.
+* Allow pricing data on marked data points to be modified.
+
+== Data Storage Levels
+
+=== Unique Records
+
+Data is passed in for each identifier and version.  This is then used to store each record as a diff to it's previous level.  Meaning the data at any point in time can be generated by summing all previous versions.  This data is only stored once within the system with each marked version just storing the version for each trade that was used to generated the summed date.
+
+=== Identifier Records
+
+This stores the current value of each identifier and is used when data is required to be regenerated at a summed level as a result of a change in lookup values.
+
+=== Grouped Records
+
+These are stored to allow quick and easy access to the data. 
+ 
+== Contributing to wherever
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 David Henry. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "wherever-positions"
+  gem.homepage = "http://github.com/dw_henry/wherever"
+  gem.license = "MIT"
+  gem.summary = %Q{Store and Retrieve positions by location}
+  gem.description = %Q{Allow Store of positions by multiple keys with teh option to mark specific points in time for use later}
+  gem.email = "dw_henry@yahoo.com.au"
+  gem.authors = ["David Henry"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features)
+
+task :default => :spec
+

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/features/step_definitions/wherever_steps.rb

@@ -0,0 +1,14 @@
+Given /^a configured wherever system with keys "([^"]*)"$/ do |keys|
+  @interface = Wherever.new(:keys => keys.split(','))
+end
+
+When /^I add data to the system for:$/ do |string|
+  hash = JSON.parse(string)
+  p hash
+  @interface.add(hash)
+end
+
+Then /^I have have the following data:$/ do |table|
+  # table is a Cucumber::Ast::Table
+  pending # express the regexp above with the code you wish you had
+end

data/features/support/env.rb

@@ -0,0 +1,13 @@
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'wherever'
+require 'ruby-debug'
+require 'rspec/expectations'

data/features/wherever.feature

@@ -0,0 +1,18 @@
+Feature: I can add and retrieve data fro the system
+
+  Scenario: I add data to the system
+    Given a configured wherever system with keys "fund_id"
+    When I add data to the system for:
+    """
+    {
+      "keys": {"fund_id": 1},
+      "unique": {"id": 1, "version": 1},
+      "position": 100,
+      "settled": true
+    }
+    """
+    Then I have have the following data:
+      | table  | keys                                        | settled positon | unsettled position |
+      | keys   | {"fund_id": 1}                              | 100             | 0                  |
+      | unique | {"fund_id": 1, "trade_id": 1}               | 100             | 0                  |
+      | all    | {"fund_id": 1, "trade_id": 1, "version": 1} | 100             | 0                  |

data/lib/wherever/configure.rb

@@ -0,0 +1,20 @@
+class Configure
+  attr_accessor :keys, :key_groups, :_id
+  def initialize(options)
+    host = options["host"] || 'localhost'
+    database = options["database"] || 'wherever'
+    user = options["user"]
+    password = options["password"]
+    @_id = options["key"] ||= "unqiue_id"
+
+    Mongoid.config do |config|
+      mongo_connection = Mongo::Connection.new(host).db(database)
+      mongo_connection.authenticate(user, password) if user
+      config.master = mongo_connection
+    end
+  
+    @keys = options["keys"]
+    groups = options["key_groups"] || @keys.map{|k| k.gsub(/_id$/,'')}
+    @key_groups = groups.map{|g| Array(g)}
+  end
+end

data/lib/wherever/db_store/dataset.rb

@@ -0,0 +1,20 @@
+module DbStore
+  class Dataset
+    include Mongoid::Document
+    include DbStore::RecordMatcher
+    embedded_in :store, :class_name => 'DbStore::Store'
+    field :values, :type => Hash, :default => Hash.new(0)
+    
+    def price
+      self.store.marker.price
+    end
+    
+    def diff(record)
+      res = {}
+      record.keys.each do |key|
+        res[key] = record[key] - self.values[key]
+      end
+      res
+    end 
+  end
+end

data/lib/wherever/db_store/identifier.rb

@@ -0,0 +1,10 @@
+module DbStore
+  class Identifier
+    include Mongoid::Document
+    embedded_in :store, :class_name => 'DbStore::Store'
+    include DbStore::RecordMatcher
+    
+    field :_id, :type => Integer
+    field :version, :type => Integer
+  end
+end

data/lib/wherever/db_store/lookup.rb

@@ -0,0 +1,15 @@
+module DbStore
+  class Lookup
+    include Mongoid::Document
+    embeds_many :versions, :class_name => 'DbStore::Version'
+    field :name, :type => String
+    field :keys, :type => Hash
+  end
+  
+  class Version
+    include Mongoid::Document
+    embedded_in :lookup, :class_name => 'DbStore::Lookup'
+    field :name, :type => String
+    field :values, :type => Hash, :default => Hash.new(0)
+  end
+end

data/lib/wherever/db_store/marker.rb

@@ -0,0 +1,12 @@
+module DbStore
+  class Marker
+    include Mongoid::Document
+    embeds_many :stores, :class_name => 'DbStore::Store'
+    field :name, :type => String
+    field :price, :type => String
+    
+    def self.find_by_name(name)
+      find_or_create_by({:name => name})
+    end
+  end
+end