compute 1.0.4

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea
+.rvmrc
+.rspec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in compute.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Venkat Dinavahi
+
+MIT License
+
+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.md

@@ -0,0 +1,87 @@
+# Compute
+
+Compute is like Excel for your ActiveRecord models.
+It lets you define computed attributes stored that get stored the database.
+
+The main benefits are
+- Performance: computed columns are only updated when the values they depend on change
+- Querying: you can now easy include these columns in your queries
+
+Here are some sample use cases
+- Having an field which depends on the users birthday. Now you can easily query on age instead of having custom SQL.
+- An SHA1 hash that gets updated when the a file path changes
+- A bill could have tax, tip, and total which all depend on subtotal
+- Having a city and state column get computed from longitude and latitude (using the Google Geocoding API)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'compute'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install compute
+
+## Usage
+
+The compute method accepts a block. 
+The names of the arguments in the block MUST match up with the properties of the model.
+The following example keeps the user.age column in sync with the user.time column. 
+
+```
+class User < ActiveRecord::Base
+
+  compute :age do |birthday|
+    unless birthday.blank?
+      now = Time.now.utc.to_date
+      now.year - birthday.year - ((now.month > birthday.month || (now.month == birthday.month && now.day >= birthday.day)) ? 0 : 1)
+    end
+  end
+
+end
+```
+
+The compute method accepts multiple arguments. Computations are also run in the correct order.
+In the block, self will be set to the model instance.
+In the following example, total will be calculated after tax and tip are calculated. Again, think of it like Excel!
+
+```
+class RestaurantBill < ActiveRecord::Base
+
+  compute(:date) { |created_at| created_at.to_date }
+
+  compute :total do |tax, tip|
+    tax + tip
+  end
+
+  compute :tax do |subtotal|
+    subtotal * tax_rate
+  end
+
+  compute :tip do |subtotal|
+    subtotal * tip_rate
+  end
+
+  def tax_rate
+    0.08
+  end
+
+  def tip_rate
+    0.15
+  end
+
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/compute.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/compute/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Venkat Dinavahi"]
+  gem.email         = ["vendiddy@gmail.com"]
+  gem.description   = %q{ActiveRecord extension for providing computed fields.}
+  gem.summary       = %q{
+    Provides a compute DSL for creating ActiveRecord columns that are computed from other ones.
+    Automatically keeps the columns up to date.
+  }
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "compute"
+  gem.require_paths = ["lib"]
+  gem.version       = Compute::VERSION
+  gem.required_ruby_version = '>= 1.9.3'
+
+  gem.add_dependency "activerecord"
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "sqlite3"
+  gem.add_development_dependency "debugger"
+  gem.add_development_dependency "with_model"
+end

data/lib/compute.rb

@@ -0,0 +1,57 @@
+require "compute/version"
+require "compute/railtie" if defined? Rails
+
+require 'compute/computation'
+require 'compute/computation_graph'
+
+module Compute
+
+  module ClassMethods
+
+    def compute(property, &block)
+      computations << Computation.new(self, property, &block)
+    end
+
+    def computations
+      @computations ||= ComputationGraph.new
+    end
+
+    def recompute!(*properties)
+      scoped.each { |record| record.recompute!(*properties) }
+    end
+
+  end
+
+  def self.included(base)
+    base.extend ClassMethods
+    base.class_eval do
+      around_save :execute_outdated_computations
+    end
+  end
+
+  def recompute!(*properties)
+    properties = properties.compact.flatten
+    if properties.empty?
+      self.class.computations.each_in_order { |c| c.execute(self) }
+    else
+      properties.each do |property|
+        computation = self.class.computations.for_property(property)
+        computation.execute(self)
+      end
+    end
+    save
+  end
+
+  private
+
+  def execute_outdated_computations
+    yield
+
+    each_outdated_computation { |computation| computation.execute(self) }
+  end
+
+  def each_outdated_computation
+    self.class.computations.for_changed_properties(self.changed).each { |c| yield c }
+  end
+
+end

data/lib/compute/computation.rb

@@ -0,0 +1,40 @@
+module Compute
+
+  class Computation
+
+    attr_accessor :property
+
+    def initialize(model, property, &block)
+      @model = model
+      @property = property
+      @proc = Proc.new(&block)
+    end
+
+    def dependencies
+      @dependencies ||= calculate_dependencies(@proc)
+    end
+
+    def needs_update?(changed_properties)
+      common_changes = changed_properties.map(&:to_sym) & @dependencies
+      common_changes.count > 0
+    end
+
+    def execute(record)
+      source_values = source_values(record)
+      destination_result = record.instance_exec(*source_values, &@proc)
+      record.send(@property.to_s + '=', destination_result)
+    end
+
+    private
+
+    def calculate_dependencies(proc)
+      proc.parameters.map { |arg| arg[1] }
+    end
+
+    def source_values(record)
+      @dependencies.map { |property| record.send(property) }
+    end
+
+  end
+
+end

data/lib/compute/computation_graph.rb

@@ -0,0 +1,70 @@
+require 'tsort'
+
+module Compute
+
+  class CyclicComputation < StandardError
+  end
+
+  class ComputationGraph < Hash
+    include TSort
+
+    def initialize
+      @sorted_computations = []
+      @computations_for_changed_properties = Hash.new do |h, changed_properties|
+        @sorted_computations.select { |c| c.needs_update?(changed_properties) }
+      end
+    end
+
+    def <<(computation)
+      self[computation.property] = computation
+      sort!
+    end
+
+    def each_in_order
+      @sorted_computations.each { |c| yield c }
+    end
+
+    def for_property(property)
+      self[property.to_sym]
+    end
+
+    def for_changed_properties(changed_properties)
+      @computations_for_changed_properties[changed_properties]
+    end
+
+    private
+
+    def sort!
+      begin
+        @sorted_computations = tsort.map { |p| self[p] }.compact
+      rescue TSort::Cyclic => e
+        raise CyclicComputation, "You have a circular dependency. (#{circular_dependency_string})"
+      end
+    end
+
+    def circular_dependency_string
+      circular_dependencies.map do |dependencies|
+        dependencies << dependencies.first
+        dependencies.join(' -> ')
+      end.join(', ')
+    end
+
+    def circular_dependencies
+      strongly_connected_components.select { |x| x.count > 1 }
+    end
+
+    def tsort_each_node
+      each do |_, computation|
+        yield computation.property
+      end
+    end
+
+    def tsort_each_child(property)
+      if self.has_key?(property)
+        self[property].dependencies.each { |p| yield p }
+      end
+    end
+
+  end
+
+end

data/lib/compute/railtie.rb

@@ -0,0 +1,9 @@
+module Compute
+  class Railtie < Rails::Railtie
+    initializer 'compute.model_additions' do
+      ActiveSupport.on_load :active_record do
+        ActiveRecord::Base.send :include, Compute
+      end
+    end
+  end
+end

data/lib/compute/version.rb

@@ -0,0 +1,3 @@
+module Compute
+  VERSION = "1.0.4"
+end

data/spec/compute/compute_spec.rb

@@ -0,0 +1,245 @@
+require 'spec_helper'
+
+describe Compute do
+
+  with_model :User do
+    table do |t|
+      t.string :first_name
+      t.string :last_name
+      t.string :full_name
+      t.string :first_initial
+      t.string :initials
+      t.date :date
+      t.timestamps
+    end
+
+    model do
+      include Compute
+
+      compute :first_initial do |first_name|
+        first_name[0]
+      end
+
+      compute :full_name do |first_name, last_name|
+        "#{first_name} #{last_name}"
+      end
+
+      compute :date do |created_at|
+        created_at.to_date
+      end
+
+    end
+
+  end
+
+  with_model :Bill do
+    table do |t|
+      t.integer :subtotal
+      t.integer :tax
+      t.integer :tip
+      t.integer :total
+    end
+
+    model do
+      include Compute
+
+      # total is put first to ensure dependency tracker correctly sorts
+      compute :total do |subtotal, tax, tip|
+        subtotal + tax + tip
+      end
+
+      compute :tax do |subtotal|
+        (subtotal * 0.05).to_i
+      end
+
+      compute :tip do |subtotal|
+        (subtotal * 0.15).to_i
+      end
+    end
+  end
+
+  with_model :ModelWithCycles do
+
+    table do |t|
+      t.integer :a
+      t.integer :b
+    end
+
+    model do
+      include Compute
+    end
+
+  end
+
+
+  it "should work when updated as a field" do
+    u = User.new
+    u.first_name = "George"
+    u.save
+
+    u.first_initial.should == 'G'
+  end
+
+  it "should work when added in the constructor" do
+    u = User.create(first_name: "Wally")
+    u.first_initial.should == 'W'
+  end
+
+  it "should allow multiple sources for a computed field" do
+    u = User.create(first_name: "John", last_name: "Doe")
+    u.full_name.should == "John Doe"
+  end
+
+  it "should work with timestamps" do
+    u = User.create(first_name: "John", last_name: "Doe")
+    u.created_at.should_not be_nil
+    u.date.should_not be_nil
+  end
+
+  it "should raise a CyclicComputation error when there is a circular dependency" do
+    expect do
+      class ModelWithCycles
+        compute(:a) { |b| b * 2 }
+        compute(:b) { |a| a / 2 }
+      end
+    end.to raise_error(Compute::CyclicComputation)
+  end
+
+  it "should update the computed field if even one of the values changes" do
+    u = User.create(first_name: "John", last_name: "Doe")
+
+    u.first_name = "Bob"
+    u.save
+    u.full_name.should == "Bob Doe"
+
+    u.last_name = "Schmoe"
+    u.save
+    u.full_name.should == "Bob Schmoe"
+  end
+
+  it "should take dependencies into consideration" do
+    restaurant_bill = Bill.create(subtotal: 100)
+    restaurant_bill.tax.should == 5
+    restaurant_bill.tip.should == 15
+    restaurant_bill.total.should == 120
+  end
+
+  it "should update dependent fields when a field is updated" do
+    bill = Bill.create(subtotal: 100)
+
+    bill.update_attributes(subtotal: 200)
+
+    bill.tax.should == 10
+    bill.tip.should == 30
+    bill.total.should == 240
+  end
+
+  describe "recompute!" do
+
+    it "should only recompute the specified field" do
+      bill = Bill.create(subtotal: 100)
+      [:tax, :tip, :total].each { |c| bill.update_column(c, 0) }
+
+      bill.recompute!(:tax)
+      bill.tax.should == 5
+      bill.tip.should == 0
+      bill.total.should == 105
+    end
+
+    it "should work with multiple fields regardless of order" do
+      bill = Bill.create(subtotal: 100)
+      [:tax, :tip, :total].each { |c| bill.update_column(c, 0) }
+
+      bill.tax.should == 0
+      bill.tip.should == 0
+      bill.total.should == 0
+
+      bill.recompute!(:total, :tax, :tip)
+      bill.tax.should == 5
+      bill.tip.should == 15
+      bill.total.should == 120
+    end
+
+    it "should work with an array" do
+      bill = Bill.create(subtotal: 100)
+      [:tax, :tip, :total].each { |c| bill.update_column(c, 0) }
+
+      bill.recompute!([:tax, :tip])
+      bill.tax.should == 5
+      bill.tip.should == 15
+    end
+
+    it "should propagate all changes" do
+      bill = Bill.create(subtotal: 100)
+      bill.update_column(:subtotal, 200)
+
+      bill.recompute!
+      bill.tax.should == 10
+      bill.tip.should == 30
+      bill.total.should == 240
+    end
+
+    it "should work on multiple records for all columns" do
+      bill1 = Bill.create(subtotal: 100)
+      bill1.update_column(:tax, 0)
+      bill1.update_column(:tip, 0)
+
+      bill2 = Bill.create(subtotal: 200)
+      bill2.update_column(:tax, 0)
+      bill2.update_column(:tip, 0)
+
+      Bill.recompute!
+      bill1.reload
+      bill2.reload
+
+      bill1.tip.should == 15
+      bill2.tip.should == 30
+
+      bill1.tax.should == 5
+      bill2.tax.should == 10
+    end
+
+    it "should work on multiple records for specific columns" do
+      bill1 = Bill.create(subtotal: 100)
+      bill1.update_column(:tax, 0)
+      bill1.update_column(:tip, 0)
+
+      bill2 = Bill.create(subtotal: 200)
+      bill2.update_column(:tax, 0)
+      bill2.update_column(:tip, 0)
+
+      Bill.recompute!(:tip)
+      bill1.reload
+      bill2.reload
+
+      bill1.tip.should == 15
+      bill2.tip.should == 30
+
+      bill1.tax.should == 0
+      bill2.tax.should == 0
+    end
+
+    it "should work on an ActiveRecord relation" do
+      bill1 = Bill.create(subtotal: 100)
+      bill1.update_column(:tax, 0)
+      bill1.update_column(:tip, 0)
+
+      bill2 = Bill.create(subtotal: 200)
+      bill2.update_column(:tax, 0)
+      bill2.update_column(:tip, 0)
+
+      Bill.where(id: [bill1.id, bill2.id]).recompute!(:tip)
+      bill1.reload
+      bill2.reload
+
+      bill1.tip.should == 15
+      bill2.tip.should == 30
+
+      bill1.tax.should == 0
+      bill2.tax.should == 0
+    end
+
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'compute'
+require "active_record"
+require 'with_model'
+
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ":memory:")
+
+RSpec.configure do |config|
+  config.extend WithModel
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: compute
+version: !ruby/object:Gem::Version
+  version: 1.0.4
+  prerelease: 
+platform: ruby
+authors:
+- Venkat Dinavahi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: with_model
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ActiveRecord extension for providing computed fields.
+email:
+- vendiddy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- compute.gemspec
+- lib/compute.rb
+- lib/compute/computation.rb
+- lib/compute/computation_graph.rb
+- lib/compute/railtie.rb
+- lib/compute/version.rb
+- spec/compute/compute_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Provides a compute DSL for creating ActiveRecord columns that are computed
+  from other ones. Automatically keeps the columns up to date.
+test_files:
+- spec/compute/compute_spec.rb
+- spec/spec_helper.rb