calculated_attributes 0.0.17 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db793fb3f8cf8a0192e4fe046c8f1d2acd1cd143
-  data.tar.gz: e86982af1eb38cb12fc7f921e2f2f1cacd671a08
+  metadata.gz: b751dd8a58b1f4de0e48f23776273daa460cdf81
+  data.tar.gz: 0caef728cf0c2314840f443ee08fd57d50eef14e
 SHA512:
-  metadata.gz: b5b7505f38be178579646967ef554b2c83892bc4a567036e172f035ef8375def0069e0cc3665a76bb106fdcc588058bc6b1c1467737701d2e609e8a80c6c4572
-  data.tar.gz: 56a72312eba86c092a1349d73348ef8a1aecaa5b948d012d549553284aafa218ebe58698a924ec7db0ab23b8e6840c78c5d67bd64adff49d0e99f68596404608
+  metadata.gz: 82e7bc56070d8594c59b590a70fbdd7f71445e2fabee1599382e2776c099ced798fce0035bd134ceb0b742a0378804638554555ea55d28ec25df85a2a318abcd
+  data.tar.gz: 02e510a66e63e67f636f1a41a2073a2c952f321974c2ace9e0b4f6eaed6327b45ed23d8d8b243188d927c77bf0dc0529669230aacba99b3801bc878bf9e2710d

data/Appraisals

@@ -0,0 +1,11 @@
+appraise 'rails3' do
+  gem 'activerecord', '3.2.21'
+end
+
+appraise 'rails4_1' do
+  gem 'activerecord', '4.1.11'
+end
+
+appraise 'rails4_2' do
+  gem 'activerecord', '4.2.2'
+end

data/README.md

@@ -24,51 +24,77 @@ Add each calculated attribute to your model using the `calculated` keyword. It a
 
 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:
 
-    class Post < ActiveRecord::Base
-    ...
-      calculated :comments_count, -> { "select count(*) from comments where comments.post_id = posts.id" }
-    ...
-    end
+```ruby
+class Post < ActiveRecord::Base
+...
+  calculated :comments_count, -> { "select count(*) from comments where comments.post_id = posts.id" }
+...
+end
+```
     
 Then, the comments count may be accessed as follows:
 
-    Post.scoped.calculated(:comments_count).first.comments_count
-    #=> 5
+```ruby
+Post.scoped.calculated(:comments_count).first.comments_count
+#=> 5
+```
     
 Multiple calculated attributes may be attached to each model. If we add a `Tag` model that also has a `post_id`, we can update the Post model as following:
 
-    class Post < ActiveRecord::Base
-    ...
-      calculated :comments_count, -> { "select count(*) from comments where comments.post_id = posts.id" }
-      calculated :tags_count, -> { "select count(*) from tags where tags.post_id = posts.id" }
-    ...
-    end
-    
+```ruby
+class Post < ActiveRecord::Base
+...
+  calculated :comments_count, -> { "select count(*) from comments where comments.post_id = posts.id" }
+  calculated :tags_count, -> { "select count(*) from tags where tags.post_id = posts.id" }
+...
+end
+```
+
 And then access both the `comments_count` and `tags_count` like so:
 
-    post = Post.scoped.calculated(:comments_count, :tags_count).first
-    post.comments_count
-    #=> 5
-    post.tags_count
-    #=> 2
-    
+```ruby
+post = Post.scoped.calculated(:comments_count, :tags_count).first
+post.comments_count
+#=> 5
+post.tags_count
+#=> 2
+```
+
+Note that you must call `calculated` on a relation in order to get the desired result. `Post.calculated(:comments_count)` will give you the currently defined lambda for calculating the comments count. `Post.scoped.calculated(:comments_count)` (Rails 3) or `Post.all.calculated(:comments_count)` (Rails 4) will give you an ActiveRecord relation including the calculated attribute.
+
 You may also use the `calculated` method on a single model instance, like so:
 
-    Post.first.calculated(:comments_count).comments_count
-    #=> 5
-    
+```ruby
+Post.first.calculated(:comments_count).comments_count
+#=> 5
+```
+
 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:
 
-    Post.first.comments_count
-    #=> 5
-    
+```ruby
+Post.first.comments_count
+#=> 5
+```
+
 If you like, you may define `calculated` lambdas using Arel syntax:
 
-    class Post < ActiveRecord::Base
-    ...
-      calculated :comments_count, -> { Comment.select(Arel::Nodes::NamedFunction.new("COUNT", [Comment.arel_table[:id]])).where(Comment.arel_table[:post_id].eq(Post.arel_table[:id])) }
-    ...
-    end
+```ruby
+class Post < ActiveRecord::Base
+...
+  calculated :comments_count, -> { Comment.select(Arel::Nodes::NamedFunction.new("COUNT", [Comment.arel_table[:id]])).where(Comment.arel_table[:post_id].eq(Post.arel_table[:id])) }
+...
+end
+```
+
+## Known Issues
+
+In Rails 4.x, you cannot call `count` on a relation with calculated attributes, e.g.
+
+```ruby
+`Post.scoped.calculated(:comments_count).count`
+```
+
+will error. This is because of an [ActiveRecord issue](https://github.com/rails/rails/blob/master/activerecord/lib/active_record/relation/calculations.rb#L368-L375) that does not permit Arel nodes in the count method.
 
 ## Contributing
 

data/calculated_attributes.gemspec

@@ -17,11 +17,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   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'
-  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'rubocop', '~> 0.32.0'
+  spec.add_development_dependency 'sqlite3', '~> 1.3.10'
 
-  spec.add_dependency 'activerecord', '~> 3.2.21'
+  spec.add_dependency 'activerecord', '>= 3.2.20'
 end

data/gemfiles/rails3.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "3.2.21"
+
+gemspec :path => "../"

data/gemfiles/rails3.gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: ../
+  specs:
+    calculated_attributes (0.0.18)
+      activerecord (>= 3.2.20)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.21)
+      activesupport (= 3.2.21)
+      builder (~> 3.0.0)
+    activerecord (3.2.21)
+      activemodel (= 3.2.21)
+      activesupport (= 3.2.21)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.21)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    appraisal (1.0.3)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (3.0.3)
+    ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
+    builder (3.0.4)
+    diff-lcs (1.2.5)
+    i18n (0.7.0)
+    multi_json (1.11.1)
+    parser (2.3.0.pre.2)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.1)
+    rainbow (2.0.0)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.0)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    rubocop (0.32.0)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.2.5, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.5)
+    sqlite3 (1.3.10)
+    thor (0.19.1)
+    tzinfo (0.3.44)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 3.2.21)
+  appraisal (~> 1.0.3)
+  bundler (~> 1.7)
+  calculated_attributes!
+  rake (~> 10.0)
+  rspec (~> 3.1)
+  rubocop (~> 0.32.0)
+  sqlite3 (~> 1.3.10)

data/gemfiles/rails4_1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "4.1.11"
+
+gemspec :path => "../"

data/gemfiles/rails4_1.gemfile.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: ../
+  specs:
+    calculated_attributes (0.0.18)
+      activerecord (>= 3.2.20)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.1.11)
+      activesupport (= 4.1.11)
+      builder (~> 3.1)
+    activerecord (4.1.11)
+      activemodel (= 4.1.11)
+      activesupport (= 4.1.11)
+      arel (~> 5.0.0)
+    activesupport (4.1.11)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    appraisal (1.0.3)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (5.0.1.20140414130214)
+    ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
+    builder (3.2.2)
+    diff-lcs (1.2.5)
+    i18n (0.7.0)
+    json (1.8.3)
+    minitest (5.7.0)
+    parser (2.2.2.5)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.1)
+    rainbow (2.0.0)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.1)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    rubocop (0.32.0)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.2.5, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.5)
+    sqlite3 (1.3.10)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 4.1.11)
+  appraisal (~> 1.0.3)
+  bundler (~> 1.7)
+  calculated_attributes!
+  rake (~> 10.0)
+  rspec (~> 3.1)
+  rubocop (~> 0.32.0)
+  sqlite3 (~> 1.3.10)

data/gemfiles/rails4_2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "4.2.2"
+
+gemspec :path => "../"

data/gemfiles/rails4_2.gemfile.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: ../
+  specs:
+    calculated_attributes (0.0.18)
+      activerecord (>= 3.2.20)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.2)
+      activesupport (= 4.2.2)
+      builder (~> 3.1)
+    activerecord (4.2.2)
+      activemodel (= 4.2.2)
+      activesupport (= 4.2.2)
+      arel (~> 6.0)
+    activesupport (4.2.2)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    appraisal (1.0.3)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (6.0.0)
+    ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
+    builder (3.2.2)
+    diff-lcs (1.2.5)
+    i18n (0.7.0)
+    json (1.8.3)
+    minitest (5.7.0)
+    parser (2.2.2.5)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.1)
+    rainbow (2.0.0)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.1)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    rubocop (0.32.0)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.2.5, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.5)
+    sqlite3 (1.3.10)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 4.2.2)
+  appraisal (~> 1.0.3)
+  bundler (~> 1.7)
+  calculated_attributes!
+  rake (~> 10.0)
+  rspec (~> 3.1)
+  rubocop (~> 0.32.0)
+  sqlite3 (~> 1.3.10)

data/lib/calculated_attributes.rb

@@ -22,11 +22,21 @@ ActiveRecord::Base.extend CalculatedAttributes
 
 ActiveRecord::Base.send(:include, Module.new do
   def calculated(*args)
-    self.class.scoped.calculated(*args).find(id)
+    if self.class.respond_to? :scoped
+      self.class.scoped.calculated(*args).find(id)
+    else
+      self.class.all.calculated(*args).find(id)
+    end
   end
 
   def method_missing(sym, *args, &block)
-    if !@attributes.include?(sym.to_s) && (self.class.calculated.calculated[sym] || self.class.base_class.calculated.calculated[sym])
+    no_sym_in_attr =
+      if @attributes.respond_to? :include?
+        !@attributes.include?(sym.to_s)
+      else
+        !@attributes.key?(sym.to_s)
+      end
+    if no_sym_in_attr && (self.class.calculated.calculated[sym] || self.class.base_class.calculated.calculated[sym])
       Rails.logger.warn("Using calculated value without including it in the relation: #{sym}") if defined? Rails
       class_with_attr =
         if self.class.calculated.calculated[sym]
@@ -34,14 +44,24 @@ ActiveRecord::Base.send(:include, Module.new do
         else
           self.class.base_class
         end
-      class_with_attr.scoped.calculated(sym).find(id).send(sym)
+      if class_with_attr.respond_to? :scoped
+        class_with_attr.scoped.calculated(sym).find(id).send(sym)
+      else
+        class_with_attr.all.calculated(sym).find(id).send(sym)
+      end
     else
       super(sym, *args, &block)
     end
   end
 
   def respond_to?(method, include_private = false)
-    super || (!@attributes.include?(method.to_s) && (self.class.calculated.calculated[method] || self.class.base_class.calculated.calculated[method]))
+    no_sym_in_attr =
+      if @attributes.respond_to? :include?
+        !@attributes.include?(method.to_s)
+      else
+        !@attributes.key?(method.to_s)
+      end
+    super || (no_sym_in_attr && (self.class.calculated.calculated[method] || self.class.base_class.calculated.calculated[method]))
   end
 end)
 

data/lib/calculated_attributes/version.rb

@@ -1,3 +1,3 @@
 module CalculatedAttributes
-  VERSION = '0.0.17'
+  VERSION = '0.0.18'
 end

data/spec/lib/calculated_attributes_spec.rb

@@ -1,18 +1,26 @@
 require 'spec_helper'
 
+def model_scoped(klass)
+  if klass.respond_to? :scoped
+    klass.scoped
+  else
+    klass.all
+  end
+end
+
 describe 'calculated_attributes' do
   it 'includes calculated attributes' do
-    expect(Post.scoped.calculated(:comments).first.comments).to eq(1)
+    expect(model_scoped(Post).calculated(:comments).first.comments).to eq(1)
   end
 
   it 'includes multiple calculated attributes' do
-    post = Post.scoped.calculated(:comments, :comments_two).first
+    post = model_scoped(Post).calculated(:comments, :comments_two).first
     expect(post.comments).to eq(1)
     expect(post.comments_two).to eq(1)
   end
 
   it 'includes chained calculated attributes' do
-    post = Post.scoped.calculated(:comments).calculated(:comments_two).first
+    post = model_scoped(Post).calculated(:comments).calculated(:comments_two).first
     expect(post.comments).to eq(1)
     expect(post.comments_two).to eq(1)
   end
@@ -56,26 +64,24 @@ describe 'calculated_attributes' do
   end
 
   it 'allows attributes to be defined using AREL' do
-    expect(Post.scoped.calculated(:comments_arel).first.comments_arel).to eq(1)
+    expect(model_scoped(Post).calculated(:comments_arel).first.comments_arel).to eq(1)
   end
 
   it 'maintains previous scope' do
-    expect(Post.where(text: 'First post!').calculated(:comments).count).to eq(1)
     expect(Post.where(text: 'First post!').calculated(:comments).first.comments).to eq(1)
     expect(Post.where("posts.text = 'First post!'").calculated(:comments).first.comments).to eq(1)
   end
 
   it 'maintains subsequent scope' do
-    expect(Post.scoped.calculated(:comments).where(text: 'First post!').count).to eq(1)
-    expect(Post.scoped.calculated(:comments).where(text: 'First post!').first.comments).to eq(1)
-    expect(Post.scoped.calculated(:comments).where("posts.text = 'First post!'").first.comments).to eq(1)
+    expect(model_scoped(Post).calculated(:comments).where(text: 'First post!').first.comments).to eq(1)
+    expect(model_scoped(Post).calculated(:comments).where("posts.text = 'First post!'").first.comments).to eq(1)
   end
 
   it 'includes calculated attributes with STI and lambda on base class' do
-    expect(Tutorial.scoped.calculated(:comments).first.comments).to eq(1)
+    expect(model_scoped(Tutorial).calculated(:comments).first.comments).to eq(1)
   end
 
   it 'includes calculated attributes with STI and lambda on subclass' do
-    expect(Article.scoped.calculated(:sub_comments).first.sub_comments).to eq(1)
+    expect(model_scoped(Article).calculated(:sub_comments).first.sub_comments).to eq(1)
   end
 end

data/spec/support/schema.rb

@@ -3,12 +3,12 @@ ActiveRecord::Schema.define do
 
   create_table :posts, force: true do |t|
     t.string :text
-    t.timestamps
+    t.timestamps null: false
   end
 
   create_table :comments, force: true do |t|
     t.integer :post_id
     t.string :text
-    t.timestamps
+    t.timestamps null: false
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: calculated_attributes
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.0.18
 platform: ruby
 authors:
 - Zach Schneider
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2015-06-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -56,44 +70,44 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.32.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.32.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.10
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.21
+        version: 3.2.20
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.21
+        version: 3.2.20
 description: 
 email:
 - zach@aha.io
@@ -104,11 +118,18 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- Appraisals
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - calculated_attributes.gemspec
+- gemfiles/rails3.gemfile
+- gemfiles/rails3.gemfile.lock
+- gemfiles/rails4_1.gemfile
+- gemfiles/rails4_1.gemfile.lock
+- gemfiles/rails4_2.gemfile
+- gemfiles/rails4_2.gemfile.lock
 - lib/calculated_attributes.rb
 - lib/calculated_attributes/version.rb
 - spec/lib/calculated_attributes_spec.rb