calculable_attrs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e0b5dd4bb3612fe4d97e9abf8c246d1e2e0fc540
+  data.tar.gz: c1f98f2e019eff2f6caa8b2a973f432a991b1512
+SHA512:
+  metadata.gz: 531805fd07f189896eed424f7613469fc3c7b16cd36f79997fbe7624bcec6551edd0aa6cf7430d232e755d5663a7c5f69946a6df7a1167df29128bd90e4f748f
+  data.tar.gz: 19a1fd7a6a42b6047a852e7bb746324708b5e733f5b1dc88049f61dc99026ae1bd3192cd8a79294931defdefec2e6664cfe97c04baff3a72dde8e431f86f832d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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/Rakefile

@@ -0,0 +1,21 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CalculableAttrs'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/calculable_attrs/active_record/base.rb

@@ -0,0 +1,77 @@
+module CalculableAttrs::ActiveRecord::Base
+  module ClassMethods
+    def calculable_attr(attrs, &block)
+      relation = block ? lambda(&block) : attrs.delete(:from)
+      raise "CALCULABLE_ATTRS: Relation was missed." unless relation
+
+      foreign_key = attrs.delete(:foreign_key) || "#{ name.tableize }.id"
+      raise "CALCULABLE_ATTRS: At least one calculable attribute required." if attrs.empty?
+
+      calculator = CalculableAttrs::Calculator.new(foreign_key: foreign_key, relation: relation, attributes: attrs)
+
+      attrs.keys.each do |k|
+        calculable_attrs_calculators[k.to_sym] = calculator
+        class_eval <<-ruby
+          def #{ k }
+            calculable_attr_value(:#{ k })
+          end
+        ruby
+      end
+    end
+
+    def calculable_attrs_calculators
+      @calculable_attrs_calculators ||= {}
+    end
+
+    def calculable_attrs
+      calculable_attrs_calculators.keys
+    end
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  def calculable_attr_value(name)
+    name = name.to_sym
+    check_calculable_attr_name!(name)
+    unless calculable_attrs_calculated_flags[name]
+      recalc_calculable_attr_with_siblings(name)
+    end
+    calculable_attrs_values[name]
+  end
+
+  def set_calculable_attr_value(name, value)
+    name = name.to_sym
+    check_calculable_attr_name!(name)
+    calculable_attrs_calculated_flags[name] = true
+    calculable_attrs_values[name] = value
+  end
+
+  def calculable_attrs_values
+    @calculable_attrs_values ||= {}
+  end
+
+  def calculable_attrs_values=(values)
+    values.each { |key, value| set_calculable_attr_value(key, value) }
+  end
+
+  def recalc_calculable_attr_with_siblings(name)
+    name = name.to_sym
+    check_calculable_attr_name!(name)
+    calculator = self.class.calculable_attrs_calculators[name]
+    self.calculable_attrs_values = calculator.calculate_all(id)
+  end
+
+  private
+
+  def calculable_attrs_calculated_flags
+    @calculable_attrs_calculated_flags ||= {}
+  end
+
+  def check_calculable_attr_name!(name)
+    unless self.class.calculable_attrs_calculators[name.to_sym]
+      raise "CALCULABLE_ATTRS:  Unknown calculable attribute  #{ name } for model #{ self.class.name }"
+    end
+  end
+end

data/lib/calculable_attrs/active_record/querying.rb

@@ -0,0 +1,3 @@
+module CalculableAttrs::ActiveRecord::Querying
+   delegate :calculate_attrs, to: :all
+end

data/lib/calculable_attrs/active_record/relation.rb

@@ -0,0 +1,121 @@
+module CalculableAttrs::ActiveRecord::Relation
+  def calculate_attrs(*attrs)
+    spawn.calculate_attrs!(*attrs)
+  end
+
+  def calculate_attrs!(*attrs)
+    attrs.reject!(&:blank?)
+    attrs.flatten!
+
+    attrs = [true] if attrs.empty?
+
+    self.calculate_attrs_values |= attrs
+    self
+  end
+
+  def calculate_attrs_values
+    @values[:calculate_attrs] || []
+  end
+
+  def calculate_attrs_values=(values)
+    raise ImmutableRelation if @loaded
+    @values[:calculate_attrs] = values
+  end
+
+
+  def self.included(base)
+    base.class_eval do
+      alias_method :calculable_orig_exec_queries, :exec_queries
+      def exec_queries
+        calculable_orig_exec_queries
+        append_calculable_attrs
+        @records
+      end
+    end
+  end
+
+  private
+
+  def append_calculable_attrs
+    unless calculate_attrs_values.empty?
+      models_calculable_scopes= {}
+      collect_models_calculable_attrs(models_calculable_scopes, klass, calculate_attrs_values)
+      models_calculable_scopes = models_calculable_scopes.select { |model, scope| scope.has_attrs }
+      collect_models_ids(models_calculable_scopes, @records, calculate_attrs_values)
+      models_calculable_scopes.each { |model, sope| sope.calculate }
+      put_calcaulated_values(models_calculable_scopes, @records, calculate_attrs_values)
+    end
+
+    @records
+  end
+
+  def collect_models_calculable_attrs(models_calculable_scopes, klass, attrs_to_calcualte)
+    attrs_to_calcualte = [attrs_to_calcualte] unless attrs_to_calcualte.is_a?(Array)
+    scope = (models_calculable_scopes[klass] ||= CalculableAttrs::ModelCalculableAttrsScope.new(klass))
+    attrs_to_calcualte.each do |attrs_to_calcualte_item|
+
+      case attrs_to_calcualte_item
+      when Symbol
+        if klass.reflect_on_association(attrs_to_calcualte_item)
+          collect_association_calculable_attrs(models_calculable_scopes, klass, attrs_to_calcualte_item, true)
+        else
+          scope.add_attr(attrs_to_calcualte_item)
+        end
+      when true
+        scope.add_all_attrs
+      when Hash
+        attrs_to_calcualte_item.each do |association_name, association_attrs_to_calcualte|
+          collect_association_calculable_attrs(models_calculable_scopes, klass, association_name, association_attrs_to_calcualte)
+        end
+      end
+    end
+  end
+
+  def collect_association_calculable_attrs(models_calculable_scopes, klass, assocaition_name, association_attrs_to_calcualte)
+    assocaition = klass.reflect_on_association(assocaition_name)
+    if assocaition
+      collect_models_calculable_attrs(models_calculable_scopes, assocaition.klass, association_attrs_to_calcualte)
+    else
+      p "CALCUALBLE_ATTRS: WAINING: Model #{ klass.name } does't have association attribute #{ assocaition_name }."
+    end
+  end
+
+  def collect_models_ids(models_calculable_scopes, records, attrs_to_calculate)
+    itereate_scoped_records_recursively(models_calculable_scopes, records, attrs_to_calculate) do |scope, record|
+      scope.add_id(record.id)
+    end
+  end
+
+
+  def put_calcaulated_values(models_calculable_scopes, records, attrs_to_calculate)
+    itereate_scoped_records_recursively(models_calculable_scopes, records, attrs_to_calculate) do |scope, record|
+      record.calculable_attrs_values = scope.calcualted_attrs_values(record.id)
+    end
+  end
+
+  def itereate_scoped_records_recursively(models_calculable_scopes, records, attrs_to_calculate, &block)
+    itereate_records_recursively(records, attrs_to_calculate) do |record|
+      scope = models_calculable_scopes[record.class]
+      block.call(scope, record) if scope
+    end
+  end
+
+  def itereate_records_recursively(records, attrs_to_calculate, &block)
+    attrs_to_calcualte = [attrs_to_calcualte] unless attrs_to_calcualte.is_a?(Array)
+    records = [records] unless records.is_a?(Array)
+
+    records.each do |record|
+      block.call(record)
+
+      attrs_to_calculate.select {|item| item.is_a?(Hash)}.each do |hash|
+        hash.each do |assocaition_name, assocaition_attributes|
+          if record.respond_to?(assocaition_name)
+            associated_records = record.send(assocaition_name)
+            associated_records = associated_records.respond_to?(:to_a) ? associated_records.to_a : associated_records
+            itereate_records_recursively(associated_records, attrs_to_calculate, &block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/calculable_attrs/active_record.rb

@@ -0,0 +1,5 @@
+module CalculableAttrs::ActiveRecord; end
+
+require 'calculable_attrs/active_record/base'
+require 'calculable_attrs/active_record/relation'
+require 'calculable_attrs/active_record/querying'

data/lib/calculable_attrs/calculator.rb

@@ -0,0 +1,85 @@
+class CalculableAttrs::Calculator
+  CALCULABLE_FOREIGN_KEY = '__calculable_id__'
+  attr_reader :attrs
+
+  def initialize(relation: nil, foreign_key: nil, attributes: nil)
+    @relation = relation
+    @foreign_key = foreign_key
+
+    @attrs = []
+    @formulas = {}
+    @defaults = {}
+
+    attributes.each do |key, val|
+      key = key.to_sym
+      save_attribute_value(key, val)
+      @attrs << key
+    end
+  end
+
+  def calculate(attrs, id)
+    if(id.is_a?(Array))
+      calculate_many(attrs, id)
+    else
+      calculate_one(attrs, id)
+    end
+  end
+
+  def calculate_many(attrs, ids)
+    query = base_query(attrs, ids).select("#{ @foreign_key } AS #{ CALCULABLE_FOREIGN_KEY }").group(@foreign_key)
+    records = query.load
+    noramlize_many_records_result(ids, attrs, records)
+  end
+
+  def calculate_one(attrs, id)
+    record = base_query(attrs, id).load.first
+    noramlize_one_record_result(attrs, record)
+  end
+
+  def calculate_all(id)
+    calculate(attrs, id)
+  end
+
+  private
+
+  def save_attribute_value(name, value)
+    case value
+    when String
+      @formulas[name] = value
+    when Array
+      if value.size == 2
+        @formulas[name] = value[0]
+        @defaults[name] = value[1]
+      else
+        raise "CALCUALBEL_ATTRS: Invalid attribute array for  #{ name }. Expected ['formula', default_value]"
+      end
+    else
+      raise "CALCUALBEL_ATTRS: Invalid attribute value for  #{ name }"
+    end
+  end
+
+  def base_query(attrs, id)
+    @relation.call.select(build_select(attrs)).where( @foreign_key => id)
+  end
+
+  def noramlize_many_records_result(ids, attrs, records)
+    normalized = {}
+    records.each do |row|
+      id = row[CALCULABLE_FOREIGN_KEY].to_i
+      normalized[id] = noramlize_one_record_result(attrs, row)
+    end
+    ids.each  do |id|
+      normalized[id] ||= noramlize_one_record_result(attrs, nil)
+    end
+    normalized
+  end
+
+  def noramlize_one_record_result(attrs, record)
+    attrs.map { |a| [a, record.try(a) || ( @defaults.key?(a) ? @defaults[a] : 0)] }.to_h
+  end
+
+
+  def build_select(attrs)
+    attrs.map { |a| "#{ @formulas[a] } AS #{ a }" }.join(', ')
+  end
+end

data/lib/calculable_attrs/model_calculable_attrs_scope.rb

@@ -0,0 +1,58 @@
+class CalculableAttrs::ModelCalculableAttrsScope
+  attr_reader :model, :ids, :attrs
+
+  def initialize(model)
+    @model = model
+    @attrs = []
+    @ids = []
+  end
+
+  def add_attr(attrribute)
+    attrribute = attrribute.to_sym
+    @attrs.push(attrribute) unless @attrs.include?(attrribute)
+  end
+
+  def add_all_attrs
+    @attrs = model.calculable_attrs
+  end
+
+  def has_attrs
+    @attrs.size > 0
+  end
+
+  def add_id(id)
+    @ids.push(id.to_i)
+  end
+
+  def calculate
+    @calculable_attrs_values = nil
+    calculators_to_use.each do |calulator|
+      calcualted_values = calulator.calculate_many(attrs | @attrs, ids)
+      merge_calculated_values(calcualted_values)
+    end
+  end
+
+  def calcualted_attrs_values(id)
+    @calculable_attrs_values[id.to_i]
+  end
+
+
+  private
+
+  def merge_calculated_values(calcualted_values)
+    if @calculable_attrs_values
+      calcualted_values.each {|id,values| @calculable_attrs_values[id].merge!(calcualted_values[id]) }
+    else
+      @calculable_attrs_values = calcualted_values
+    end
+  end
+
+  def calculators_to_use
+    calculators_to_use = []
+    @attrs.each do |attribute|
+      calulator = @model.calculable_attrs_calculators[attribute]
+      calculators_to_use.push(calulator) unless calculators_to_use.include?(calulator)
+    end
+    calculators_to_use
+  end
+end

data/lib/calculable_attrs/version.rb

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

data/lib/calculable_attrs.rb

@@ -0,0 +1,9 @@
+module Calculable; end
+
+require 'calculable_attrs/active_record'
+require 'calculable_attrs/calculator'
+require 'calculable_attrs/model_calculable_attrs_scope'
+
+::ActiveRecord::Base.include(CalculableAttrs::ActiveRecord::Base)
+::ActiveRecord::Relation.include(CalculableAttrs::ActiveRecord::Relation)
+::ActiveRecord::Base.extend(CalculableAttrs::ActiveRecord::Querying)

data/lib/tasks/calculable_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :calculable do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: calculable_attrs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dmitry Sharkov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      Imagine you an Account model which has many transactions.
+      calculable_attrs gem allows you to define Accoutn#blalace and SUM(transactions.amount) directrly in your Account model.
+      And solves n+1 problem for you in an elegant way.
+email:
+- dmitry.sharkov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- lib/calculable_attrs.rb
+- lib/calculable_attrs/active_record.rb
+- lib/calculable_attrs/active_record/base.rb
+- lib/calculable_attrs/active_record/querying.rb
+- lib/calculable_attrs/active_record/relation.rb
+- lib/calculable_attrs/calculator.rb
+- lib/calculable_attrs/model_calculable_attrs_scope.rb
+- lib/calculable_attrs/version.rb
+- lib/tasks/calculable_tasks.rake
+homepage: https://github.com/dmitrysharkov/calculable_attrs
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Simplifies work with dynamically calculable fields.
+test_files: []