calculated_attributes 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 114648311fe5389527380b81d89677279f8e9019
-  data.tar.gz: 42e5dc334c01643eaf56d97e4eb42aca0cb0113d
+  metadata.gz: 31b050a3311b7b6c70f23b201f4761b103b6137f
+  data.tar.gz: 875255b28e9c8e597b4bf0d912f3f02283544d18
 SHA512:
-  metadata.gz: 6635d62772fca4d1da02752555ed19fd55c8b04d9047e95086c233f89ee83822c7e277257ba21607e9bf7bf484b518e2547477333f5da84a1ccd0bcea223cc7d
-  data.tar.gz: f5881cb7665e8132f22ee7dbfd932b7695d420cd5fec33fb7e2248a40cdd2975ca093a37fca39ff0375e493e1039fef630c06213935eefa771a13392ebe16772
+  metadata.gz: 9dd904985c4d11aa47ecbc53e90b9500f5a427437ec934e8666ffdb29db88c129151843899f93dad9dc6f9aa884903933ad529b0f5bf03c8e15ad5a23e718f18
+  data.tar.gz: 493f1937397278a71be5743c39160f12582ebe30a93530de9e9138454423e475259fc72e0d1c26d800314a4a5b39f7d956443855827bd014c9a05bc2658c54c2

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/README.md

@@ -1,4 +1,5 @@
-[![Gem Version](https://badge.fury.io/rb/calculated_attributes.svg)](https://badge.fury.io/rb/calculated_attributes)
+[![Gem Version](https://badge.fury.io/rb/calculated_attributes.svg)](https://badge.fury.io/rb/calculated_attributes) 
+[![CircleCI](https://circleci.com/gh/aha-app/calculated_attributes.svg?style=shield)](https://circleci.com/gh/aha-app/calculated_attributes)
 
 # CalculatedAttributes
 
@@ -22,7 +23,7 @@ Or install it yourself as:
 
 ## Usage
 
-Add each calculated attribute to your model using the `calculated` keyword. It accepts two parameters: a symbol representing the name of the calculated attribute, and a lambda containing a string to calculate the attribute.
+Add each calculated attribute to your model using the `calculated` keyword. It accepts two parameters: a symbol representing the name of the calculated attribute, and a lambda containing a string to calculate the attribute. The lambda can accept arguments.
 
 For example, if we have two models, `Post` and `Comment`, and `Comment` has a `post_id` attribute, we might write the following code to add a comments count to each `Post` record in a relation:
 
@@ -30,6 +31,7 @@ For example, if we have two models, `Post` and `Comment`, and `Comment` has a `p
 class Post < ActiveRecord::Base
 ...
   calculated :comments_count, -> { "select count(*) from comments where comments.post_id = posts.id" }
+  calculated :comments_count_by_user, ->(user) { ["select count(*) from comments where comments.post_id = posts.id and posts.user_id = '%s'", user.id] }
 ...
 end
 ```
@@ -38,6 +40,7 @@ Then, the comments count may be accessed as follows:
 
 ```ruby
 Post.scoped.calculated(:comments_count).first.comments_count
+Post.scoped.calculated(comments_count_by_user: user).first.comments_count_by_user
 #=> 5
 ```
     
@@ -69,6 +72,9 @@ You may also use the `calculated` method on a single model instance, like so:
 ```ruby
 Post.first.calculated(:comments_count).comments_count
 #=> 5
+
+Post.first.calculated(comments_count_by_user: user).comments_count_by_user
+#=> 0
 ```
 
 If you have defined a `calculated` method, results of that method will be returned rather than throwing a method missing error even if you don't explicitly use the `calculated()` call on the instance:
@@ -76,6 +82,8 @@ If you have defined a `calculated` method, results of that method will be return
 ```ruby
 Post.first.comments_count
 #=> 5
+Post.first.comments_count_by_user(user)
+#=> 0
 ```
 
 If you like, you may define `calculated` lambdas using Arel syntax:
@@ -108,4 +116,4 @@ will error. This is because of an [ActiveRecord issue](https://github.com/rails/
 
 ## Credits
 
-Written by Zach Schneider based on ideas from Chris Waters.
+Written by Zach Schneider based on ideas from Chris Waters.

data/calculated_attributes.gemspec

@@ -18,7 +18,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'appraisal', '~> 1.0.3'
-  spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.1'
   spec.add_development_dependency 'rubocop', '~> 0.32.0'

data/circle.yml

@@ -0,0 +1,3 @@
+database:
+  override:
+    - echo "no database setup"

data/gemfiles/rails3.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    calculated_attributes (0.1.2)
+    calculated_attributes (0.1.4)
       activerecord (>= 3.2.20)
 
 GEM
@@ -27,7 +27,6 @@ GEM
     astrolabe (1.3.0)
       parser (>= 2.2.0.pre.3, < 3.0)
     builder (3.0.4)
-    byebug (6.0.2)
     diff-lcs (1.2.5)
     i18n (0.7.0)
     multi_json (1.11.1)
@@ -66,10 +65,11 @@ PLATFORMS
 DEPENDENCIES
   activerecord (= 3.2.21)
   appraisal (~> 1.0.3)
-  bundler (~> 1.7)
-  byebug
   calculated_attributes!
   rake (~> 10.0)
   rspec (~> 3.1)
   rubocop (~> 0.32.0)
   sqlite3 (~> 1.3.10)
+
+BUNDLED WITH
+   1.11.2

data/gemfiles/rails4_1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    calculated_attributes (0.1.2)
+    calculated_attributes (0.1.4)
       activerecord (>= 3.2.20)
 
 GEM
@@ -29,7 +29,6 @@ GEM
     astrolabe (1.3.0)
       parser (>= 2.2.0.pre.3, < 3.0)
     builder (3.2.2)
-    byebug (6.0.2)
     diff-lcs (1.2.5)
     i18n (0.7.0)
     json (1.8.3)
@@ -71,10 +70,11 @@ PLATFORMS
 DEPENDENCIES
   activerecord (= 4.1.11)
   appraisal (~> 1.0.3)
-  bundler (~> 1.7)
-  byebug
   calculated_attributes!
   rake (~> 10.0)
   rspec (~> 3.1)
   rubocop (~> 0.32.0)
   sqlite3 (~> 1.3.10)
+
+BUNDLED WITH
+   1.11.2

data/gemfiles/rails4_2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    calculated_attributes (0.1.2)
+    calculated_attributes (0.1.4)
       activerecord (>= 3.2.20)
 
 GEM
@@ -29,7 +29,6 @@ GEM
     astrolabe (1.3.0)
       parser (>= 2.2.0.pre.3, < 3.0)
     builder (3.2.2)
-    byebug (6.0.2)
     diff-lcs (1.2.5)
     i18n (0.7.0)
     json (1.8.3)
@@ -71,10 +70,11 @@ PLATFORMS
 DEPENDENCIES
   activerecord (= 4.2.2)
   appraisal (~> 1.0.3)
-  bundler (~> 1.7)
-  byebug
   calculated_attributes!
   rake (~> 10.0)
   rspec (~> 3.1)
   rubocop (~> 0.32.0)
   sqlite3 (~> 1.3.10)
+
+BUNDLED WITH
+   1.11.2

data/lib/calculated_attributes/model_methods.rb

@@ -42,9 +42,9 @@ class ActiveRecord::Base
           self.class.base_class
         end
       if class_with_attr.respond_to? :scoped
-        class_with_attr.scoped.calculated(sym).find(id).send(sym)
+        class_with_attr.scoped.calculated(sym => args).find(id).send(sym)
       else
-        class_with_attr.all.calculated(sym).find(id).send(sym)
+        class_with_attr.all.calculated(sym => args).find(id).send(sym)
       end
     else
       super(sym, *args, &block)
@@ -67,16 +67,24 @@ end
 class ActiveRecord::Relation
   def calculated(*args)
     projections = arel.projections
-    args.each do |arg|
-      lam = klass.calculated.calculated[arg] || klass.base_class.calculated.calculated[arg]
-      sql = lam.call
+    args = args.flat_map do |arg|
+      case arg
+      when Symbol then [[arg, []]]
+      when Hash then arg.to_a
+      end
+    end
+
+    args.each do |attribute, arguments|
+      lam = klass.calculated.calculated[attribute] || klass.base_class.calculated.calculated[attribute]
+      sql = lam.call(*arguments)
+      sql = klass.send(:sanitize_sql, *sql) if sql.is_a?(Array)
       new_projection = 
         if sql.is_a?(String)
-          Arel.sql("(#{sql})").as(arg.to_s)
+          Arel.sql("(#{sql})").as(attribute.to_s)
         elsif sql.respond_to? :to_sql
-          Arel.sql("(#{sql.to_sql})").as(arg.to_s)
+          Arel.sql("(#{sql.to_sql})").as(attribute.to_s)
         else
-          sql.as(arg.to_s)
+          sql.as(attribute.to_s)
         end
       new_projection.calculated_attr!
       projections.push new_projection

data/lib/calculated_attributes/version.rb

@@ -1,3 +1,3 @@
 module CalculatedAttributes
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

data/spec/lib/calculated_attributes_spec.rb

@@ -13,6 +13,13 @@ describe 'calculated_attributes' do
     expect(model_scoped(Post).calculated(:comments_count).first.comments_count).to eq(1)
   end
 
+  it 'includes parametric calculated attributes' do
+    expect(model_scoped(Post).calculated(comments_by_user: [User.where(username: 'unused').first])
+             .first.comments_by_user).to eq(0)
+    expect(model_scoped(Post).calculated(comments_by_user: [User.where(username: 'test').first])
+             .first.comments_by_user).to eq(1)
+  end
+
   it 'includes multiple calculated attributes' do
     post = model_scoped(Post).calculated(:comments_count, :comments_two).first
     expect(post.comments_count).to eq(1)
@@ -37,10 +44,18 @@ describe 'calculated_attributes' do
     expect(Post.first.calculated(:comments_count).comments_count).to eq(1)
   end
 
+  it 'allows access via model instance method with parameters' do
+    expect(Post.first.calculated(comments_by_user: [User.where(username: 'test').first]).comments_by_user).to eq(1)
+  end
+
   it 'allows anonymous access via model instance method' do
     expect(Post.first.comments_count).to eq(1)
   end
 
+  it 'allows access via model instance method with parameters' do
+    expect(Post.first.comments_by_user(User.where(username: 'test').first)).to eq(1)
+  end
+
   it 'allows anonymous access via model instance method with STI and lambda on base class' do
     expect(Tutorial.first.comments_count).to eq(1)
   end

data/spec/support/data.rb

@@ -1,5 +1,7 @@
-p = Post.create(text: 'First post!')
-Comment.create(post_id: p.id, text: 'First comment!')
+u = User.create(username: 'test')
+User.create(username: 'unused')
+p = Post.create(text: 'First post!', user: u)
+Comment.create(post_id: p.id, text: 'First comment!', user: u)
 Post.create(text: 'Second post!')
 t = Tutorial.create(text: 'Tutorial!')
 Comment.create(post_id: t.id, text: 'First comment!')

data/spec/support/models.rb

@@ -2,6 +2,7 @@ class Post < ActiveRecord::Base
   has_many :comments
   belongs_to :user
 
+  calculated :comments_by_user, ->(user) { "select count(*) from comments where comments.post_id = posts.id and comments.user_id = #{user.id}" }
   calculated :comments_count, -> { 'select count(*) from comments where comments.post_id = posts.id' }
   calculated :comments_two, -> { 'select count(*) from comments where comments.post_id = posts.id' }
   calculated :comments_arel, -> { Comment.where(Comment.arel_table[:post_id].eq(Post.arel_table[:id])).select(Arel.sql('count(*)')) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calculated_attributes
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Zach Schneider
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-01 00:00:00.000000000 Z
+date: 2016-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.3
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -118,12 +104,14 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - Appraisals
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - calculated_attributes.gemspec
+- circle.yml
 - gemfiles/rails3.gemfile
 - gemfiles/rails3.gemfile.lock
 - gemfiles/rails4_1.gemfile
@@ -162,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Automatically add calculated attributes to ActiveRecord models.