attribute-depends-calculator 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a046d88fe7d1ad88d0ae1b29dd7041ccfc43b2d2
+  data.tar.gz: 6596be90ac350adf829691445a560a4cee535513
+SHA512:
+  metadata.gz: 79677cba067d8d844f4acc3659f5688b12a932e5305aab398c23d306f0a88bcff11f98a42d5ea4905a316d22cc910d01633a5edfd9398e0b189b22c63808e3cd
+  data.tar.gz: be9f7bc1aa6256fdfed2ac55b29ac8d5d11dc67e8d9939ca7e0df2dd74870350cc621fae59babd9ab64612bea9d7bb6ce492a21a5a18b5dd08cc86e9e0bf6ab9

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version
+.idea/
+.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.0
+  - 2.1.5
+  - 2.2
+  - 2.3.0
+script: xvfb-run rspec
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in attribute-depends-calculator.gemspec
+gemspec
+
+group :test do
+  gem 'rails', '>=4.2.5'
+  gem 'sqlite3', '>=1.3.6'
+  gem 'rspec', '~> 2.11'
+  gem 'database_cleaner'
+  gem 'coveralls', require: false
+end

data/README.md

@@ -0,0 +1,52 @@
+# Attribute Depends Calculator [![Build Status](https://travis-ci.org/falm/attribute-depends-calculator.svg?branch=master)](https://travis-ci.org/falm/attribute-depends-calculator) [![Coverage Status](https://coveralls.io/repos/github/falm/attribute-depends-calculator/badge.svg)](https://coveralls.io/github/falm/attribute-depends-calculator)
+
+The scenario of the gem is when you have a attribute on model that value depends of a calculation of other model's attribute which attribute's model related. AttributeDependsCalculator will help you solve the case
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'attribute-depends-calculator'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+Assume you have model order and order-item
+```ruby
+class Order < ActiveRecord::Base
+  has_many :order_items
+  depends total_price: {order_items: :price}
+end
+
+class OrderItem < ActiveRecord::Base
+  belongs_to :order
+end
+```
+And you can
+```ruby
+order = Order.first
+order.total_price
+#=> 100.0
+order.order_items.pluck(:price)
+#=> [50.0, 50.0]
+order_item = order.order_items.first
+order_item.update(price: 100)
+order.reload.total_price
+#=> 150.0
+```
+As above price of order automatically update when whatever order_items changes
+
+## Contributing
+
+1. Fork it ( http://github.com/zmbacker/enum_help/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+MIT © [Falm](https://github.com/falm)

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/attribute-depends-calculator.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'attribute_depends_calculator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "attribute-depends-calculator"
+  spec.version       = AttributeDependsCalculator::VERSION
+  spec.authors       = ["Jason Hou"]
+  spec.email         = ["hjj1992@gmail.com"]
+
+  spec.summary       = %q{calculate depends attribute automatically}
+  spec.description   = %q{auto calculate collect of depends attribute value and save when that changes}
+  spec.homepage      = "https://github.com/falm/attribute-depends-calculator"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.licenses      = ["MIT"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rack', '~> 1.5'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "attribute/depends/calculator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/attribute-depends-calculator.rb

@@ -0,0 +1 @@
+require 'attribute_depends_calculator'

data/lib/attribute_depends_calculator.rb

@@ -0,0 +1,6 @@
+#encoding: utf-8
+
+Gem.find_files('attribute_depends_calculator/**/*.rb').each { |file| require file }
+
+module AttributeDependsCalculator
+end

data/lib/attribute_depends_calculator/engine.rb

@@ -0,0 +1,10 @@
+
+module AttributeDependsCalculator
+
+  class Engine < ::Rails::Engine
+    isolate_namespace AttributeDependsCalculator
+    initializer 'attribute_depends_calculator.extend_active_record' do
+      ActiveRecord::Base.send :extend, AttributeDependsCalculator::Macro
+    end
+  end
+end

data/lib/attribute_depends_calculator/factory.rb

@@ -0,0 +1,67 @@
+module AttributeDependsCalculator
+  class Factory
+    attr_accessor :klass, :column, :params, :association, :associate_column, :association_name
+    def initialize(klass, column, params)
+      self.klass, self.column = klass, column
+      self.association, self.associate_column, self.association_name = fetch_association(params)
+    end
+
+    def perform
+      define_calculator
+      append_callbacks
+    end
+
+    private
+
+    def define_calculator
+      self.klass.class_eval <<-METHOD, __FILE__, __LINE__
+        def #{calculate_method_name}
+          total = self.#{association_name}.pluck(:#{associate_column}).compact.reduce(0, :+)
+          update(:#{column} => total)
+        end
+      METHOD
+    end
+
+    def calculate_method_name
+      "calculate_and_update_#{column}"
+    end
+
+    def klass_assoc_name
+      klass.table_name.singularize
+    end
+
+    def fetch_association(params)
+      assoc = params.keys.first
+      [klass.reflect_on_association(assoc).class_name.constantize, params.values.first, assoc]
+    end
+
+    def append_callbacks
+      append_callback_hook
+      define_callback_methods
+    end
+
+    def append_callback_hook
+      self.association.class_eval <<-METHOD, __FILE__, __LINE__
+        after_save :depends_update_#{column}
+        around_destroy :depends_update_#{column}_around
+      METHOD
+    end
+
+    def define_callback_methods
+      self.association.class_eval <<-METHOD, __FILE__, __LINE__
+        private
+
+        def depends_update_#{column}
+          self.#{klass_assoc_name}.#{calculate_method_name}
+        end
+
+        def depends_update_#{column}_around
+          _relation = self.#{klass_assoc_name}
+          yield
+          _relation.#{calculate_method_name}
+        end
+      METHOD
+    end
+
+  end
+end

data/lib/attribute_depends_calculator/macro.rb

@@ -0,0 +1,11 @@
+module AttributeDependsCalculator
+  module Macro
+    def depend(options)
+      options.each do |column, option|
+        Factory.new(self, column, option).perform
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :extend, AttributeDependsCalculator::Macro

data/lib/attribute_depends_calculator/version.rb

@@ -0,0 +1,4 @@
+
+module AttributeDependsCalculator
+  VERSION = '0.1'
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: attribute-depends-calculator
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Jason Hou
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: auto calculate collect of depends attribute value and save when that
+  changes
+email:
+- hjj1992@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- attribute-depends-calculator.gemspec
+- bin/console
+- bin/setup
+- lib/attribute-depends-calculator.rb
+- lib/attribute_depends_calculator.rb
+- lib/attribute_depends_calculator/engine.rb
+- lib/attribute_depends_calculator/factory.rb
+- lib/attribute_depends_calculator/macro.rb
+- lib/attribute_depends_calculator/version.rb
+homepage: https://github.com/falm/attribute-depends-calculator
+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.6.6
+signing_key: 
+specification_version: 4
+summary: calculate depends attribute automatically
+test_files: []