unscoped_associations 0.6.5 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2cd5582dcc1e8d3a4fe22a00bd5d1a93a6466df5
-  data.tar.gz: 21129a908c3f75f70462e000b7e145d8a8dd57be
+  metadata.gz: 073c884846d75afaa72c4d70c5b085e59cfbd5cc
+  data.tar.gz: 1646ec2a8addf850400b89601622caa1205be995
 SHA512:
-  metadata.gz: 7e39f18b8aefb84c2e4fd288f6706367397bf08e8a89cfb8945a82b4339cde54f72306a2441391077b09a10cbbb9df4b6bf51319549b6efe714211245953ac14
-  data.tar.gz: 19574587b4d3d79b10513e26d022938e7ba57717be501712d5bb662e42c28bcfa0aa4b87acfcc68b879335858c46abf95b5345db22180fdb48ee7267f2a20bfa
+  metadata.gz: 5ded23dbed093edd84b46c97ef0a1bd0ea764681a083d945f6fb37bf824f067e7cc97c00590097bf871e7b5d2a4f7a83611311d8350db39b83d3f8560d7e2411
+  data.tar.gz: 46028f5d2bb6f15d8da7bb320c9a31c5b749e5ac070b93d1bc74152db731abc13839a5a4f0e9a02892e715436794dd1509ab68d6fb16c0a8334f16f69c5e078c

data/.gitignore

@@ -2,3 +2,5 @@
 pkg
 .rvmrc
 Gemfile.lock
+*.gemfile.lock
+.byebug_history

data/.travis.yml

@@ -1,5 +1,22 @@
 language: ruby
+sudo: false
 rvm:
+  - 2.3.3
+  - 2.2.6
   - 2.1
   - 2.0
-  - 1.9.3
+  - 1.9.3
+gemfile:
+  - gemfiles/activerecord_5.0.gemfile
+  - gemfiles/activerecord_4.2.gemfile
+  - gemfiles/activerecord_4.1.gemfile
+  - gemfiles/activerecord_4.0.gemfile
+  - gemfiles/activerecord_3.2.gemfile
+matrix:
+  exclude:
+    - rvm: 1.9.3
+      gemfile: gemfiles/activerecord_5.0.gemfile
+    - rvm: 2.0
+      gemfile: gemfiles/activerecord_5.0.gemfile
+    - rvm: 2.1
+      gemfile: gemfiles/activerecord_5.0.gemfile

data/Appraisals

@@ -0,0 +1,19 @@
+appraise "activerecord-5.0" do
+  gem "activerecord", "~> 5.0.0"
+end
+
+appraise "activerecord-4.2" do
+  gem "activerecord", "~> 4.2.0"
+end
+
+appraise "activerecord-4.1" do
+  gem "activerecord", "~> 4.1.0"
+end
+
+appraise "activerecord-4.0" do
+  gem "activerecord", "~> 4.0.0"
+end
+
+appraise "activerecord-3.2" do
+  gem "activerecord", "~> 3.2.0"
+end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2013-2014 Marc Anguera Insa
+Copyright 2013-2017 Marc Anguera Insa
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -3,10 +3,15 @@
 [![Gem Version](https://badge.fury.io/rb/unscoped_associations.svg)](http://badge.fury.io/rb/unscoped_associations)
 [![Build Status](https://travis-ci.org/markets/unscoped_associations.svg?branch=master)](https://travis-ci.org/markets/unscoped_associations)
 
-Want to skip the `default_scope` when you get objects through associations (for some strange reasons)? Do it easily with this lib. Supported associations:
-* `:belongs_to`
-* `:has_one`
-* `:has_many`
+Have you ever needed to skip the `default_scope` when fetching objects through associations methods (for some strange reasons)? Do it easily with this `Active Record` extension!
+
+Supported associations:
+
+- `:belongs_to`
+- `:has_one`
+- `:has_many`
+
+Officially supported (tested) `Active Record` versions: 3.2, 4.0, 4.1, 4.2 and 5.0.
 
 ## Installation
 
@@ -28,9 +33,8 @@ Basic usage example:
 
 ```ruby
 class User < ActiveRecord::Base
-  has_many :comments # or , unscoped: false
+  has_many :comments
   has_many :all_comments, class_name: 'Comment', unscoped: true
-  has_one  :last_comment, class_name: 'Comment', order: 'created_at DESC', unscoped: true
 
   default_scope { where(active: true) }
 end
@@ -40,32 +44,58 @@ class Comment < ActiveRecord::Base
 
   default_scope { where(public: true) }
 end
+```
 
-@user.comments # => return public comments
-@user.all_comments # => return all comments skipping default_scope
-@user.last_comment # => return last comment skipping default_scope
-@comment.user # => return user w/o taking account 'active' flag
+From now on, you get:
 
-```
+- `@user.comments`: return all public comments
+- `@user.all_comments`: return all comments skipping the default_scope
+- `@comment.user`: return the user without taking account the 'active' flag
 
 ## Status
 
-Tested on Rails 3 series and Rails 4. Originally was thought and built for Rails 3, but Rails 4 is also supported.
+This project was originally thought and built for a Rails 3.2 application.
 
-**NOTE** Rails 4 introduces some updates (and more planned for upcoming releases) related to this part. For example, in Rails 4, you are able to customize associations using a scope block, so you can skip the `default_scope` by:
+Rails 4 introduces some updates regarding associations. For example, since Rails 4 (AR 4 to be precise), you are able to customize associations using a scope block (overriding conditions), so you can skip the `default_scope` conditions by:
 
-```
+```ruby
 class User < ActiveRecord::Base
   has_many :all_comments, -> { where(public: [true, false]) }, class_name: 'Comment'
 end
 ```
 
-Anyway, you can use `unscoped` option, if you prefer.
+Since Rails 4.1, you can also override the default conditions using the `unscope` method:
+
+```ruby
+class User < ActiveRecord::Base
+  has_many :all_comments, -> { unscope(where: :public) }, class_name: 'Comment'
+end
+```
+
+Anyway, you can continue using `unscoped_associations`, could be useful in certain situations, for example, if you prefer to bypass the entire `default_scope`, given a scope with multiple conditions, like:
+
+```ruby
+default_scope { where(public: true).order(:updated_at) }
+```
+
+It was also supported for Rails 4.X series and 5.0 as a migration path.
+
+## Notes
+
+- Under the hood, Unscoped Associations relies on the `unscoped` method (from AR). So, chaining unscoped associations with other AR query methods won't work. E.g.: `@user.all_comments.count` will load comments with the `defaul_scope` applied. In this case, `@user.all_comments.to_a.count` should work.
+- Unscoped Associations doen't touch the preloading layer, so `includes`, `joins`, ... with unscoped associations, can cause `N+1` problems.
 
 ## Contributing
 
-Ideas, fixes, improvements or any comment are welcome!
+Any kind of fixes, both code and docs, or enhancements are really welcome!
+
+To contribute, just fork the repo, hack on it and send a pull request. Don't forget to add specs for behaviour changes and run the tests by:
+
+```
+bundle exec rspec
+bundle exec appraisal rspec # run against all supported AR versions
+```
 
 ## License
 
-Copyright (c) 2013-2014 Marc Anguera. Unscoped Associations is released under the [MIT](LICENSE) License.
+Copyright (c) Marc Anguera. Unscoped Associations is released under the [MIT](LICENSE) License.

data/gemfiles/activerecord_3.2.gemfile

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

data/gemfiles/activerecord_4.0.gemfile

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

data/gemfiles/activerecord_4.1.gemfile

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

data/gemfiles/activerecord_4.2.gemfile

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

data/gemfiles/activerecord_5.0.gemfile

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

data/lib/unscoped_associations.rb

@@ -3,7 +3,7 @@ require 'unscoped_associations/version'
 module UnscopedAssociations
   def self.included(base)
     base.extend ClassMethods
-    (class << base; self; end).instance_eval do
+    class << base
       alias_method_chain :belongs_to, :unscoped
       alias_method_chain :has_many, :unscoped
       alias_method_chain :has_one, :unscoped
@@ -36,26 +36,25 @@ module UnscopedAssociations
       end
 
       if scope
-        self.send("#{assoc_type}_without_unscoped", assoc_name, scope, options, &extension)
+        send("#{assoc_type}_without_unscoped", assoc_name, scope, options, &extension)
       else
-        self.send("#{assoc_type}_without_unscoped", assoc_name, options, &extension)
+        send("#{assoc_type}_without_unscoped", assoc_name, options, &extension)
       end
     end
 
     def add_unscoped_association(association_name)
-      define_method(association_name) do
-        if self.class.reflect_on_association(association_name).options.key?(:polymorphic)
-          self.association(association_name).klass.unscoped do
-            super(association_name)
-          end
+      define_method(association_name) do |*args|
+        force_reload = args[0]
+        if !force_reload && instance_variable_get("@_cache_#{association_name}")
+          instance_variable_get("@_cache_#{association_name}")
         else
-          self.class.reflect_on_association(association_name).klass.unscoped do
-            super(association_name)
-          end
+          instance_variable_set("@_cache_#{association_name}",
+            association(association_name).klass.unscoped { super(true) }
+          )
         end
       end
     end
   end
 end
 
-ActiveRecord::Base.instance_eval { include UnscopedAssociations }
+ActiveRecord::Base.send(:include, UnscopedAssociations)

data/lib/unscoped_associations/version.rb

@@ -1,3 +1,3 @@
 module UnscopedAssociations
-  VERSION = "0.6.5"
+  VERSION = "0.7.0"
 end

data/spec/spec_helper.rb

@@ -1,12 +1,10 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-
 require 'active_record'
+require 'logger'
 require 'unscoped_associations'
 
 ActiveRecord::Base.logger = Logger.new(STDOUT)
 
-Dir["./spec/support/**/*.rb"].sort.each {|f| require f}
+Dir["./spec/support/**/*.rb"].sort.each { |f| require f}
 
 RSpec.configure do |config|
   config.run_all_when_everything_filtered = true

data/spec/support/models.rb

@@ -11,8 +11,13 @@ class User < ActiveRecord::Base
     end
   end
 
-  has_one  :last_comment, class_name: 'Comment', order: 'created_at DESC'
-  has_one  :unscoped_last_comment, class_name: 'Comment', order: 'created_at DESC', unscoped: true
+  if ActiveRecord::VERSION::MAJOR >= 4
+    has_one  :last_comment, -> { order('created_at DESC') }, class_name: 'Comment'
+    has_one  :unscoped_last_comment, -> { order('created_at DESC') }, class_name: 'Comment', unscoped: true
+  else
+    has_one  :last_comment, class_name: 'Comment', order: ('created_at DESC')
+    has_one  :unscoped_last_comment, class_name: 'Comment', unscoped: true, order: ('created_at DESC')
+  end
 
   has_many :votes, as: :votable, unscoped: true
 

data/spec/unscoped_associations_spec.rb

@@ -2,9 +2,9 @@ require 'spec_helper'
 
 describe UnscopedAssociations do
   let!(:user) { User.create(active: false) }
-  let!(:comment) { Comment.create(user_id: user.id, public: false) }
-  let!(:user_vote) { user.votes.create(public: false) }
-  let!(:comment_vote) { comment.votes.create }
+  let!(:comment) { Comment.create(unscoped_user: user, public: false) }
+  let!(:user_vote) { Vote.create(votable: user, public: false) }
+  let!(:comment_vote) { Vote.create(votable: comment) }
 
   context 'a belongs to association' do
     it 'scoped' do
@@ -44,6 +44,12 @@ describe UnscopedAssociations do
       expect(user.unscoped_comments).to eq([comment])
     end
 
+    it 'unscoped accepts force_reload' do
+      comments_count = user.unscoped_comments.to_a.count
+      Comment.create(unscoped_user: user, public: false)
+      expect(user.unscoped_comments(true).to_a.count).to eq(comments_count + 1)
+    end
+
     it 'unscoped with an extension' do
       # Extended methods take the default_scope
       expect(user.unscoped_comments.today).to be_empty

data/unscoped_associations.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |spec|
   spec.version       = UnscopedAssociations::VERSION
   spec.authors       = ["Marc Anguera Insa"]
   spec.email         = ["srmarc.ai@gmail.com"]
-  spec.description   = %q{Skip default_scope in your associations}
-  spec.summary       = %q{Skip default_scope in your associations}
+  spec.description   = "Skip default_scope in your associations"
+  spec.summary       = "Skip default_scope in your associations"
   spec.homepage      = "https://github.com/markets/unscoped_associations"
   spec.license       = "MIT"
 
@@ -16,10 +16,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activerecord", ">= 0"
+  spec.add_dependency "activerecord", ">= 3.2.0", "<= 5.1.0"
 
+  spec.add_development_dependency "appraisal"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", '~> 3.1'
   spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "byebug" if RUBY_VERSION.to_i >= 2
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unscoped_associations
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.7.0
 platform: ruby
 authors:
 - Marc Anguera Insa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-15 00:00:00.000000000 Z
+date: 2017-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,9 +16,29 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
   type: :runtime
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,6 +86,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: Skip default_scope in your associations
 email:
 - srmarc.ai@gmail.com
@@ -75,10 +109,16 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- Appraisals
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- gemfiles/activerecord_3.2.gemfile
+- gemfiles/activerecord_4.0.gemfile
+- gemfiles/activerecord_4.1.gemfile
+- gemfiles/activerecord_4.2.gemfile
+- gemfiles/activerecord_5.0.gemfile
 - lib/unscoped_associations.rb
 - lib/unscoped_associations/version.rb
 - spec/spec_helper.rb
@@ -106,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Skip default_scope in your associations