delta_force 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+*.swp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+gemspec
+
+gem 'activerecord', '2.3.11'

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    delta_force (0.0.1)
+      activerecord (~> 2.3.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activerecord (2.3.11)
+      activesupport (= 2.3.11)
+    activesupport (2.3.11)
+    columnize (0.3.2)
+    factory_girl (1.3.3)
+    linecache (0.43)
+    pg (0.10.1)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 2.3.11)
+  delta_force!
+  factory_girl
+  pg
+  ruby-debug
+  shoulda

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2011 by Joe Lind
+
+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,80 @@
+= DeltaForce
+
+DeltaForce allows you to use some Postgres 8.4+ window functions in named scopes on your ActiveRecord models.
+
+It is very much still a work in progress; please contribute if possible and let me know what I can do better!
+
+== Installing
+
+<b>DeltaForce only works with Rails 2.3</b>. I will be adding Rails 3 compatibility shortly.
+
+In your Gemfile:
+
+  gem "delta_force"
+
+== Example
+
+Consider the following schema and model:
+
+  create_table "foos", :force => true do |t|
+    t.integer  "bar_id"
+    t.float    "x"
+    t.float    "y"
+    t.float    "z"
+    t.date     "period"
+  end
+
+  class Foo < ActiveRecord::Base
+    tracks_changes_over_time do |changes|
+      changes.values :x, :y, :z, :over => :period, :by => :bar_id
+    end
+  end
+
+
+You can now get the opening and closing values by bar_id as follows:
+  Foo.changes_in_x_and_y_and_z_by_bar_id_over_period
+
+If the following Foo objects exist:
+
+  #<Foo id: 1, bar_id: 1, x: 1.0, y: 10.0, z: 100.0, period: "2011-03-11">
+  #<Foo id: 2, bar_id: 1, x: 2.0, y: 20.0, z: 200.0, period: "2011-03-10">
+  #<Foo id: 3, bar_id: 1, x: 3.0, y: 30.0, z: 300.0, period: "2011-03-09">
+  #<Foo id: 4, bar_id: 2, x: 4.0, y: 40.0, z: 400.0, period: "2011-03-08">
+  #<Foo id: 5, bar_id: 2, x: 5.0, y: 50.0, z: 500.0, period: "2011-03-07">
+  #<Foo id: 6, bar_id: 2, x: 6.0, y: 60.0, z: 600.0, period: "2011-03-06">
+  #<Foo id: 7, bar_id: 2, x: 7.0, y: 70.0, z: 700.0, period: "2011-03-05">
+
+You can retrieve a set of modified Foo objects that have opening and closing values, partitioned by bar_id, for x, y, and z as follows:
+
+  Foo.changes_in_x_and_y_and_z_by_bar_id_over_period
+  => [#<Foo bar_id: 1>, #<Foo bar_id: 2>]
+
+  Foo.changes_in_x_and_y_and_z_by_bar_id_over_period.first.opening_x
+   => "3"
+
+  Foo.changes_in_x_and_y_and_z_by_bar_id_over_period.first.closing_x
+   => "1"
+
+  Foo.changes_in_x_and_y_and_z_by_bar_id_over_period.first.closing_y
+   => "10"
+
+  Foo.changes_in_x_and_y_and_z_by_bar_id_over_period.first.opening_y
+   => "30"
+
+  Foo.changes_in_x_and_y_and_z_by_bar_id_over_period.first.opening_period
+   => "2011-03-09"
+
+  Foo.changes_in_x_and_y_and_z_by_bar_id_over_period.first.closing_period
+   => "2011-03-11"
+
+Note that opening_* and closing_* values are not currently typecast.  I'd like to support that in the future.
+
+== Under the hood
+
+DeltaForce uses {Postgres 8.4+ window functions}[http://www.postgresql.org/docs/current/static/tutorial-window.html] to partition data by an arbitrary key.
+
+This has been tested agains Postgres 8.4 and should also work with Postgres 9.  Oracle provides the same set of functions, but I have not been able to test it against an Oracle instance yet.
+
+== Copyright
+
+Copyright (c) 2011 {Joe Lind}[http://github.com/joelind]. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+#require 'rspec/core/rake_task'
+require 'rake/testtask'
+
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+end
+
+task :default => :test

data/delta_force.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "delta_force/version"
+
+Gem::Specification.new do |s|
+  s.name        = "delta_force"
+  s.version     = DeltaForce::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Joe Lind"]
+  s.email       = ["joelind@gmail.com"]
+  s.homepage    = "http://github.com/joelind/delta_force"
+  s.summary     = %q{ActiveRecord named scopes with Postgres window functions.}
+  s.description = %q{
+      DeltaForce lets you use Postgres 8.4+ window functions with ActiveRecord
+    }
+  s.post_install_message = %q{
+*** Thanks for installing DeltaForce! ***
+}
+
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+
+  s.rubyforge_project = "delta_force"
+
+  s.add_dependency 'activerecord', '~> 2.3.0'
+  s.add_development_dependency 'shoulda'
+  s.add_development_dependency 'factory_girl'
+  s.add_development_dependency 'ruby-debug'
+  s.add_development_dependency 'pg'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/delta_force/change_proxy.rb

@@ -0,0 +1,97 @@
+
+module DeltaForce
+  class ChangeProxy
+
+    attr_reader :klass
+
+    def initialize(klass)
+      @klass = klass
+    end
+
+    def values(*value_fields)
+      options = value_fields.extract_options!.symbolize_keys
+
+      partition_column = "#{table_name}.#{options[:by].to_s}"
+      id_column = "#{table_name}.id"
+
+      period_field_name = options[:over].to_s
+      period_column = "#{table_name}.#{period_field_name}"
+
+      scope_name = options[:scope_name] || default_scope_name(value_fields, options)
+
+      window = "
+        (
+           PARTITION BY #{partition_column}
+           ORDER BY #{period_column} DESC, #{id_column} DESC ROWS
+           BETWEEN UNBOUNDED PRECEDING AND UNBOUNDED FOLLOWING
+        )"
+
+      value_expressions = value_fields.collect do |value_field|
+        value_field_name = value_field.to_s
+        value_column = "#{table_name}.#{value_field_name}"
+
+        [
+          "last_value(#{value_column}) over #{window} as opening_#{value_field_name}",
+          "first_value(#{value_column}) over #{window} as closing_#{value_field_name}"
+        ]
+      end.flatten
+
+      klass.named_scope scope_name, :select => "distinct #{partition_column},
+        last_value(#{period_column}) over #{window} as opening_#{period_field_name},
+        first_value(#{period_column}) over #{window} as closing_#{period_field_name},
+        #{value_expressions.join ','}
+      "
+    end
+
+    alias :value :values
+
+    private
+
+    def default_scope_name(value_fields, options)
+      value_fields = value_fields.map(&:to_s).sort
+      period = options[:over].to_s
+      partition = options[:by].to_s
+
+      value_fields = value_fields.to_sentence(:words_connector => '_and_',
+                                              :two_words_connector => '_and_',
+                                              :last_word_connector => '_and_')
+
+      "changes_in_#{value_fields}_by_#{partition}_over_#{period}"
+    end
+
+    def table_name
+      klass.table_name
+    end
+
+    def calculate_changes(value_field_name, options = {})
+      options = options.symbolize_keys
+
+      value_field_name = value_field_name.to_s
+
+      partition_field_name = options[:partition_by]
+      partition_column = "#{table_name}.#{partition_field_name.to_s}"
+
+      value_column = "#{table_name}.#{value_field_name}"
+      id_column = "#{table_name}.id"
+
+      period_field_name = options[:period] || 'period'
+      period_column = "#{table_name}.#{period_field_name}"
+
+      scope_name = "changes_in_#{value_field_name}".to_sym
+
+      window = "
+        (
+           PARTITION BY #{partition_column}
+           ORDER BY #{period_column} DESC, #{id_column} DESC ROWS
+           BETWEEN UNBOUNDED PRECEDING AND UNBOUNDED FOLLOWING
+        )"
+
+      named_scope scope_name, :select => "distinct #{partition_column},
+        last_value(#{period_column}) over #{window} as opening_#{period_field_name},
+        first_value(#{period_column}) over #{window} as closing_#{period_field_name},
+        last_value(#{value_column}) over #{window} as opening_#{value_field_name},
+        first_value(#{value_column}) over #{window} as closing_#{value_field_name}
+        "
+    end
+  end
+end

data/lib/delta_force/class_methods.rb

@@ -0,0 +1,41 @@
+require 'delta_force/change_proxy'
+
+module DeltaForce
+  module ClassMethods
+
+    def tracks_changes_over_time
+      yield DeltaForce::ChangeProxy.new(self)
+    end
+
+    def calculates_changes_in(value_field_name, options = {})
+      options = options.symbolize_keys
+
+      value_field_name = value_field_name.to_s
+
+      partition_field_name = options[:partition_by]
+      partition_column = "#{table_name}.#{partition_field_name.to_s}"
+
+      value_column = "#{table_name}.#{value_field_name}"
+      id_column = "#{table_name}.id"
+
+      period_field_name = options[:period] || 'period'
+      period_column = "#{table_name}.#{period_field_name}"
+
+      scope_name = "changes_in_#{value_field_name}".to_sym 
+
+      window = "
+        (
+           PARTITION BY #{partition_column}
+           ORDER BY #{period_column} DESC, #{id_column} DESC ROWS
+           BETWEEN UNBOUNDED PRECEDING AND UNBOUNDED FOLLOWING
+        )"
+
+      named_scope scope_name, :select => "distinct #{partition_column},
+        last_value(#{period_column}) over #{window} as opening_#{period_field_name},
+        first_value(#{period_column}) over#{window} as closing_#{period_field_name},
+        last_value(#{value_column}) over #{window} as opening_#{value_field_name},
+        first_value(#{value_column}) over #{window} as closing_#{value_field_name}
+        "
+    end
+  end
+end

data/lib/delta_force/version.rb

@@ -0,0 +1,3 @@
+module DeltaForce
+  VERSION = "0.0.1"
+end

data/lib/delta_force.rb

@@ -0,0 +1,6 @@
+require 'delta_force/class_methods'
+
+module DeltaForce
+end
+
+ActiveRecord::Base.extend DeltaForce::ClassMethods

data/test/factories/bar.rb

@@ -0,0 +1,2 @@
+Factory.define :bar do |bar|
+end

data/test/factories/foo.rb

@@ -0,0 +1,7 @@
+Factory.define :foo do |foo|
+  foo.sequence(:period) { |n| n.days.ago.to_date }
+  foo.association(:bar)
+  foo.sequence(:x) { |n| n }
+  foo.sequence(:y) { |n| 10 * n }
+  foo.sequence(:z) { |n| 100 * n }
+end

data/test/fixtures/bar.rb

@@ -0,0 +1,3 @@
+class Bar < ActiveRecord::Base
+  has_many :foos
+end

data/test/fixtures/foo.rb

@@ -0,0 +1,3 @@
+class Foo < ActiveRecord::Base
+  belongs_to :bar
+end

data/test/fixtures/schema.rb

@@ -0,0 +1,12 @@
+ActiveRecord::Schema.define do
+
+  create_table "bars", :force => true
+
+  create_table "foos", :force => true do |t|
+    t.integer  "bar_id"
+    t.float    "x"
+    t.float    "y"
+    t.float    "z"
+    t.date     "period"
+  end
+end

data/test/helper.rb

@@ -0,0 +1,30 @@
+require "rubygems"
+require "bundler"
+Bundler.setup
+require 'test/unit'
+require 'shoulda'
+require 'factory_girl'
+require 'active_record'
+require 'delta_force'
+
+FIXTURES_PATH = File.join(File.dirname(__FILE__), 'fixtures')
+
+ActiveRecord::Base.establish_connection(
+  :adapter => 'postgresql',
+  :database => 'delta_force_test'
+)
+
+dep = defined?(ActiveSupport::Dependencies) ? ActiveSupport::Dependencies : ::Dependencies
+dep.autoload_paths.unshift FIXTURES_PATH
+
+ActiveRecord::Base.silence do
+  ActiveRecord::Migration.verbose = false
+  load File.join(FIXTURES_PATH, 'schema.rb')
+end
+
+Dir[File.expand_path(File.dirname(__FILE__)) + "/factories/*.rb"].each do |file|
+    require file
+end
+
+class Test::Unit::TestCase
+end

data/test/test_active_record_integration.rb

@@ -0,0 +1,71 @@
+require 'helper'
+
+class TestActiveRecordIntegration < Test::Unit::TestCase
+  context 'tracks_changes_over_time' do
+    setup do
+      Foo.tracks_changes_over_time do |changes|
+        changes.values :x, :y, :z, :over => :period, :by => :bar_id
+      end
+    end
+
+    should 'add a changes_in_* named scope' do
+      assert Foo.respond_to?(:changes_in_x_and_y_and_z_by_bar_id_over_period)
+    end
+
+    context 'with foos for a given bar' do
+      setup do
+        @bar = Factory(:bar)
+
+        @foos = 3.times.collect do |i|
+          2.times.collect do
+            Factory :foo, :bar => @bar, :period => i.days.from_now.to_date,
+              :x=> (10 * i), :y => (100 * i), :z => (1000 * i)
+          end
+        end.flatten
+
+        #decoy foo
+        Factory :foo
+      end
+
+      context 'bar.foos.changes_in_x_and_y_and_z_by_bar_id_over_period' do
+        subject { @bar.foos.changes_in_x_and_y_and_z_by_bar_id_over_period }
+
+        should 'return a scope containig one object' do
+          assert_equal 1, subject.all.size
+        end
+
+        should 'return an object with opening_period' do
+          assert_equal @foos.first.period, subject.first.opening_period.to_date
+        end
+
+        should 'return an object with closing_period' do
+          assert_equal @foos.last.period, subject.first.closing_period.to_date
+        end
+
+        should 'return an object with closing_x' do
+          assert_equal @foos.last.x, subject.first.closing_x.to_f
+        end
+
+        should 'return an object with opening_x' do
+          assert_equal @foos.first.x, subject.first.opening_x.to_f
+        end
+
+        should 'return an object with closing_y' do
+          assert_equal @foos.last.y, subject.first.closing_y.to_f
+        end
+
+        should 'return an object with opening_y' do
+          assert_equal @foos.first.y, subject.first.opening_y.to_f
+        end
+
+        should 'return an object with closing_z' do
+          assert_equal @foos.last.z, subject.first.closing_z.to_f
+        end
+
+        should 'return an object with opening_z' do
+          assert_equal @foos.first.z, subject.first.opening_z.to_f
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification 
+name: delta_force
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Joe Lind
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-12 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: factory_girl
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: pg
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: "\n      DeltaForce lets you use Postgres 8.4+ window functions with ActiveRecord\n    "
+email: 
+- joelind@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- delta_force.gemspec
+- lib/delta_force.rb
+- lib/delta_force/change_proxy.rb
+- lib/delta_force/class_methods.rb
+- lib/delta_force/version.rb
+- test/factories/bar.rb
+- test/factories/foo.rb
+- test/fixtures/bar.rb
+- test/fixtures/foo.rb
+- test/fixtures/schema.rb
+- test/helper.rb
+- test/test_active_record_integration.rb
+has_rdoc: true
+homepage: http://github.com/joelind/delta_force
+licenses: []
+
+post_install_message: |
+  
+  *** Thanks for installing DeltaForce! ***
+
+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: delta_force
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: ActiveRecord named scopes with Postgres window functions.
+test_files: 
+- test/factories/bar.rb
+- test/factories/foo.rb
+- test/fixtures/bar.rb
+- test/fixtures/foo.rb
+- test/fixtures/schema.rb
+- test/helper.rb
+- test/test_active_record_integration.rb