edge_rider 0.3.3 → 1.0.0

data/README.md

@@ -31,13 +31,13 @@ Say we have a `Post` model and each `Post` belongs to an author:
   
 To turn a relation of posts into a relation of its authors:
 
-    posts = Post.where(:archived => false)
+    posts = Post.where(archived: false)
     authors = posts.traverse_association(:author)
     
 You can traverse multiple associations in a single call.
 E.g. to turn a relation of posts into a relation of all posts of their authors:
 
-    posts = Post.where(:archived => false)
+    posts = Post.where(archived: false)
     posts_by_same_authors = posts.traverse_association(:author, :posts)
 
 *Implementation note:* The traversal is achieved internally by collecting all foreign keys in the current relation
@@ -56,10 +56,10 @@ its ID.
 Edge Rider has a better way. Your relations gain a method `#collect_ids` that will
 fetch all IDs in a single query without instantiating a single ActiveRecord object:
 
-    posts = Post.where(:archived => false)
+    posts = Post.where(archived: false)
     post_ids = posts.collect_ids
 
-*Implementation note:* In Rails 3.2+, `#collect_ids` delegates to [`#pluck`](http://apidock.com/rails/ActiveRecord/Calculations/pluck),
+*Implementation note:* `#collect_ids` delegates to [`#pluck`](https://apidock.com/rails/ActiveRecord/Calculations/pluck),
 which can be used for the same purpose.
 
 
@@ -76,7 +76,7 @@ any kind of argument that can be turned into a list of IDs:
 
 For this use case Edge Rider defines `#collect_ids` on many different types:
 
-    Post.where(:id => [1, 2]).collect_ids    # => [1, 2]
+    Post.where(id: [1, 2]).collect_ids    # => [1, 2]
     [Post.find(1), Post.find(2)].collect_ids # => [1, 2]
     Post.find(1).collect_ids                 # => [1]
     [1, 2, 3].collect_ids                    # => [1, 2, 3]
@@ -89,7 +89,7 @@ You can now write `Post.by_author` from the example above without a single `if`
       belongs_to :author
 
       def self.for_author(author_or_authors)
-        where(:author_id => author_or_authors.collect_ids)
+        where(author_id: author_or_authors.collect_ids)
       end
 
     end
@@ -106,42 +106,23 @@ its column value.
 Edge Rider has a better way. Your relations gain a method `#collect_column` that will
 fetch all column values in a single query without instantiating a single ActiveRecord object:
 
-    posts = Post.where(:archived => false)
+    posts = Post.where(archived: false)
     subjects = posts.collect_column(:subject)
 
-*Implementation note:* In Rails 3.2+, `#collect_column` delegates to [`#pluck`](http://apidock.com/rails/ActiveRecord/Calculations/pluck),
+*Implementation note:* `#collect_column` delegates to [`#pluck`](https://apidock.com/rails/ActiveRecord/Calculations/pluck),
 which can be used for the same effect.
 
 #### Collect unique values in a relation's column
 
-If you only care about *unique* values, use the `:distinct => true` option:
+If you only care about *unique* values, use the `distinct: true` option:
 
-    posts = Post.where(:archived => false)
-    distinct_subjects = posts.collect_column(:subject, :distinct => true)
+    posts = Post.where(archived: false)
+    distinct_subjects = posts.collect_column(:subject, distinct: true)
 
 With this options duplicates are discarded by the database before making their way into Ruby.
 
-*Implementation note:* In Rails 3.2+, the `:distinct` option is implemented with [`#uniq`](http://apidock.com/rails/ActiveRecord/QueryMethods/uniq)
- which can be used for the same effect.
-
-
-### Retrieve the SQL a relation would produce
-
-Sometimes it is useful to ask a relation which SQL query it would trigger,
-if it was evaluated right now. For this, Edge Rider gives your relations a method
-`#to_sql`:
-
-    # Rails 2 scope
-    Post.scoped(:conditions => { :id => [1, 2] }).to_sql 
-    # => "SELECT `posts`.* FROM `posts` WHERE `posts.id` IN (1, 2)"
-
-    # Rails 3 relation
-    Post.where(:id => [1, 2]).to_sql 
-    # => "SELECT `posts`.* FROM `posts` WHERE `posts.id` IN (1, 2)"
-
-*Implementation note*: Rails 3+ implements `#to_sql`. Edge Rider backports this method to Rails 2 so you can use it
-regardless of your Rails version.
-
+*Implementation note:* The `:distinct` option is implemented with [`#uniq`](https://apidock.com/rails/ActiveRecord/QueryMethods/uniq)
+ or [`#distinct`](https://apidock.com/rails/ActiveRecord/QueryMethods/distinct) which can be used for the same effect.
 
 ### Simplify a complex relation for better chainability
 
@@ -155,7 +136,7 @@ mashes together strings that mostly happen to look like a MySQL query in the end
 
 Edge Rider gives your relations a new method `#to_id_query`:
 
-    Site.joins(:user).where(:users => { :name => 'Bruce' }).to_id_query
+    Site.joins(user).where(:users: { name: 'Bruce' }).to_id_query
 
 `#to_id_query` will immediately run an SQL query where it collects all the IDs that match your relation:
 
@@ -173,9 +154,9 @@ Sometimes you want to fetch associations for records that you already instantiat
 Edge Rider gives your model classes a method `.preload_associations`. The method can be used to preload associations for loaded objects like this:
 
     @user = User.find(params[:id])
-    User.preload_associations [@user], { :threads => { :posts => :author }, :messages => :sender }
+    User.preload_associations [@user], { threads: { posts: :author }, messages: :sender }
 
-*Implementation note*: Rails 2.3 and Rails 3.0 already has a method [`.preload_associations`](http://apidock.com/rails/ActiveRecord/AssociationPreload/ClassMethods/preload_associations)
+*Implementation note*: Rails 3.0 already has a method [`.preload_associations`](https://apidock.com/rails/ActiveRecord/AssociationPreload/ClassMethods/preload_associations)
 which Edge Rider merely makes public. Edge Rider ports this method forward to Rails 3.1+.
 
 
@@ -188,7 +169,7 @@ This is useful e.g. to perform unscoped record look-up.
     Post.recent.origin_class
     # => Post
 
-Note that `#origin_class` it roughly equivalent to the blockless form of [`unscoped`](http://apidock.com/rails/ActiveRecord/Scoping/Default/ClassMethods/unscoped) from Rails 3.2+,
+Note that `#origin_class` it roughly equivalent to the blockless form of [`unscoped`](https://apidock.com/rails/ActiveRecord/Scoping/Default/ClassMethods/unscoped) from Rails 3.2+,
 but it works consistently across all Rails versions.
 
 
@@ -202,8 +183,8 @@ across all versions of Rails.
     User.scoped # just calls User.all in Rails 4
     User.active.scoped(conditions: { admin: true })
 
-*Implementation note*: Rails 2 and 3 already have a method
-[`.scoped`](http://apidock.com/rails/ActiveRecord/Scoping/Named/ClassMethods/scoped) which Edge Rider does not touch. Rails 4 has removed this method and
+*Implementation note*: Rails 3 already have a method
+[`.scoped`](https://apidock.com/rails/ActiveRecord/Scoping/Named/ClassMethods/scoped) which Edge Rider does not touch. Rails 4 has removed this method and
 splits its functionality into the query methods known from Rails 3 (`.where`,
 `.order` etc.) and an `.all` method that just returns a scope.
 
@@ -227,10 +208,10 @@ Development
 -----------
 
 - There are tests in `spec`. We only accept PRs with tests.
-- We currently develop using Ruby 2.2.4 (see `.ruby-version`) since that version works for all versions of ActiveRecord that we support. Travis CI will test additional Ruby versions (2.1.8 and 2.3.1).
+- We currently develop using the Ruby version in `.ruby-version`. It is required to change the Ruby Version to cover all Rails version or just use Travis CI.
 - Put your database credentials into `spec/support/database.yml`. There's a `database.sample.yml` you can use as a template.
 - Create a database `edge_rider_test` in both MySQL and PostgreSQL.
-- There are gem bundles in `gemfiles` for each combination of ActiveRecord version and database type that we support.
+- There are gem bundles in the project root for each combination of ActiveRecord version and database type that we support.
 - You can bundle all test applications by saying `bundle exec rake matrix:install`
 - You can run specs from the project root by saying `bundle exec rake matrix:spec`. This will run all gemfiles compatible with your current Ruby.
 
@@ -245,5 +226,3 @@ Credits
 -------
 
 Henning Koch from [makandra](http://makandra.com/)
-
-

data/Rakefile

@@ -7,4 +7,4 @@ rescue LoadError
   puts 'Run `gem install gemika` for additional tasks'
 end
 
-task :default => 'matrix:spec'
+task default: 'matrix:spec'

data/lib/edge_rider.rb

@@ -12,4 +12,3 @@ require 'edge_rider/origin_class'
 require 'edge_rider/scoped'
 require 'edge_rider/traverse_association'
 require 'edge_rider/to_id_query'
-require 'edge_rider/to_sql'

data/lib/edge_rider/collect_column.rb

@@ -4,23 +4,16 @@ module EdgeRider
     def collect_column(column_name, find_options = {})
       distinct = find_options.delete(:distinct)
       qualified_column_name = EdgeRider::Util.qualify_column_name(self, column_name)
-      if respond_to?(:pluck) # Rails 3.2+
-        scope = scoped({})
-        if distinct
-          if ActiveRecord::VERSION::MAJOR < 5
-            scope = scope.uniq
-          else
-            scope = scope.distinct
-          end
+
+      scope = scoped({})
+      if distinct
+        if ActiveRecord::VERSION::MAJOR < 5
+          scope = scope.uniq
+        else
+          scope = scope.distinct
         end
-        scope.pluck(qualified_column_name)
-      else # Rails 2
-        select = distinct ? "DISTINCT #{qualified_column_name}" : qualified_column_name
-        query = scoped(find_options.merge(:select => select)).to_sql
-        raw_values = connection.select_values(query)
-        column = columns_hash[column_name.to_s] or raise "Could not retrieve column information: #{column_name}"
-        raw_values.collect { |value| column.type_cast(value) }
       end
+      scope.pluck(qualified_column_name)
     end
 
     ActiveRecord::Base.extend(self)

data/lib/edge_rider/origin_class.rb

@@ -3,16 +3,8 @@ module EdgeRider
 
     def origin_class
       scope = scoped({})
-      if Util.activerecord2?
-        # Rails 2
-        while scope.respond_to?(:proxy_scope, true)
-          scope = scope.proxy_scope
-        end
-      else
-        # Rails 3
-        while scope.respond_to?(:klass, true)
-          scope = scope.klass
-        end
+      while scope.respond_to?(:klass, true)
+        scope = scope.klass
       end
       scope
     end

data/lib/edge_rider/scoped.rb

@@ -3,7 +3,7 @@ module EdgeRider
     
     VALID_FIND_OPTIONS = [ :conditions, :include, :joins, :limit, :offset,
                            :order, :select, :readonly, :group, :having, :from, :lock ]
-    
+
     def scoped(options = nil)
       options ||= {}
       relation = all

data/lib/edge_rider/to_id_query.rb

@@ -3,7 +3,7 @@ module EdgeRider
 
     def to_id_query
       ids = collect_ids
-      EdgeRider::Util.exclusive_query(self, :id => ids)
+      EdgeRider::Util.exclusive_query(self, id: ids)
     end
 
     ActiveRecord::Base.send(:extend, self)

data/lib/edge_rider/traverse_association.rb

@@ -18,8 +18,8 @@ module EdgeRider
         raise NotImplementedError if reflection.options[:conditions] or (reflection.respond_to?(:scope) && reflection.scope)
            
         if reflection.macro == :belongs_to # belongs_to
-          ids = scope.collect_column(foreign_key, :distinct => true)
-          scope = EdgeRider::Util.exclusive_query(reflection.klass, :id => ids)
+          ids = scope.collect_column(foreign_key, distinct: true)
+          scope = EdgeRider::Util.exclusive_query(reflection.klass, id: ids)
         elsif reflection.macro == :has_many || reflection.macro == :has_one
           if reflection.through_reflection # has_many :through
             scope = scope.traverse_association(reflection.through_reflection.name, reflection.source_reflection.name)

data/lib/edge_rider/util.rb

@@ -21,13 +21,7 @@ module EdgeRider
     end
 
     def exclusive_query(model, conditions)
-      if activerecord2?
-        model.send(:with_exclusive_scope) do
-          model.scoped(:conditions => conditions)
-        end
-      else
-        model.unscoped.where(conditions)
-      end
+      model.unscoped.where(conditions)
     end
 
     def scope?(object)
@@ -35,13 +29,16 @@ module EdgeRider
     end
     
     def define_scope(klass, name, lambda)
-      if ActiveRecord::VERSION::MAJOR < 4 # Rails 2/3
-        scope_definition = ActiveRecord::VERSION::MAJOR < 3 ? :named_scope : :scope
-        klass.send scope_definition, name, lambda
+      if ActiveRecord::VERSION::MAJOR == 3
+        klass.send :scope, name, lambda
       else
         klass.send :scope, name, lambda { |*args|
           options = lambda.call(*args)
-          klass.scoped(options.slice :conditions)
+          if ActiveRecord::VERSION::MAJOR < 6
+            klass.scoped(options.slice :conditions)
+          else
+            scoped(options.slice :conditions)
+          end
         }
       end      
     end
@@ -63,10 +60,6 @@ module EdgeRider
       ActiveRecord::VERSION::MAJOR
     end
 
-    def activerecord2?
-      active_record_version < 3
-    end
-
     def rspec_version
       if defined?(Spec)
         1

data/lib/edge_rider/version.rb

@@ -1,3 +1,3 @@
 module EdgeRider
-  VERSION = '0.3.3'
+  VERSION = '1.0.0'
 end

data/spec/edge_rider/collect_column_spec.rb

@@ -5,16 +5,16 @@ describe EdgeRider::CollectColumn do
   describe '#collect_column' do
 
     it 'should collect the given value from a scope' do
-      Forum.create!(:id => 1, :name => 'Name 1')
-      Forum.create!(:id => 2, :name => 'Name 2')
-      Forum.create!(:id => 3, :name => 'Name 3')
-      scope = Forum.scoped(:conditions => { :id => [2, 3] })
+      Forum.create!(id: 1, name: 'Name 1')
+      Forum.create!(id: 2, name: 'Name 2')
+      Forum.create!(id: 3, name: 'Name 3')
+      scope = Forum.scoped(conditions: { id: [2, 3] })
       scope.collect_column(:name).should =~ ['Name 2', 'Name 3']
     end
 
     it 'should collect the given value from an ActiveRecord class' do
-      Forum.create!(:id => 1, :name => 'Name 1')
-      Forum.create!(:id => 2, :name => 'Name 2')
+      Forum.create!(id: 1, name: 'Name 1')
+      Forum.create!(id: 2, name: 'Name 2')
       Forum.collect_column(:name).should =~ ['Name 1', 'Name 2']
     end
 
@@ -24,23 +24,23 @@ describe EdgeRider::CollectColumn do
     end
 
     it 'should not instantiate ActiveRecord objects when collecting values' do
-      Forum.create!(:name => 'Name')
+      Forum.create!(name: 'Name')
       Forum.should_not_receive(:new)
       Forum.collect_column(:name).should == ['Name']
     end
 
     it 'should qualify the column name to resolve any ambiguities' do
-      expect { Topic.scoped(:joins => :forum).collect_column(:id) }.to_not raise_error
+      expect { Topic.scoped(joins: :forum).collect_column(:id) }.to_not raise_error
     end
 
     context 'with :distinct option' do
 
       it 'should return unique values' do
-        Forum.create!(:id => 1, :name => 'Name 1')
-        Forum.create!(:id => 2, :name => 'Name 2')
-        Forum.create!(:id => 3, :name => 'Name 2')
-        scope = Forum.scoped(:conditions => { :id => [2, 3] })
-        scope.collect_column(:name, :distinct => true).should =~ ['Name 2']
+        Forum.create!(id: 1, name: 'Name 1')
+        Forum.create!(id: 2, name: 'Name 2')
+        Forum.create!(id: 3, name: 'Name 2')
+        scope = Forum.scoped(conditions: { id: [2, 3] })
+        scope.collect_column(:name, distinct: true).should =~ ['Name 2']
       end
 
     end
@@ -49,8 +49,8 @@ describe EdgeRider::CollectColumn do
 
       it 'should collect the given value' do
         topic = Topic.create!
-        post = Post.create!(:topic => topic, :id => 1)
-        post = Post.create!(:topic => topic, :id => 2)
+        post = Post.create!(topic: topic, id: 1)
+        post = Post.create!(topic: topic, id: 2)
         topic.reload
         topic.posts.to_a
         topic.posts.collect_column(:id).should =~ [1,2]
@@ -58,21 +58,21 @@ describe EdgeRider::CollectColumn do
 
       it 'should return values when further restricted with an anonymous scope' do
         topic = Topic.create!
-        post = Post.create!(:topic => topic, :id => 1)
-        post = Post.create!(:topic => topic, :id => 2)
+        post = Post.create!(topic: topic, id: 1)
+        post = Post.create!(topic: topic, id: 2)
         topic.reload
         topic.posts.to_a
         if topic.posts.respond_to?(:where)
-          topic.posts.where(:id => [1]).collect_ids.should =~ [1]
+          topic.posts.where(id: [1]).collect_ids.should =~ [1]
         else
-          topic.posts.scoped(:conditions => {:id => [1]}).collect_column(:id).should =~ [1]
+          topic.posts.scoped(conditions: {id: [1]}).collect_column(:id).should =~ [1]
         end
       end
 
       it 'should return values when further restricted with a named scope' do
         topic = Topic.create!
-        post = Post.create!(:topic => topic, :id => 1)
-        post = Post.create!(:topic => topic, :id => 2)
+        post = Post.create!(topic: topic, id: 1)
+        post = Post.create!(topic: topic, id: 2)
         topic.reload
         topic.posts.to_a
         topic.posts.these([1]).collect_column(:id).should =~ [1]

data/spec/edge_rider/collect_ids_spec.rb

@@ -7,8 +7,8 @@ describe EdgeRider::CollectIds do
     context 'when called on an ActiveRecord class' do
 
       it 'should return the ids for all records of that class' do
-        Forum.create!(:id => 1)
-        Forum.create!(:id => 2)
+        Forum.create!(id: 1)
+        Forum.create!(id: 2)
         Forum.collect_ids.should =~ [1, 2]
       end
 
@@ -17,10 +17,10 @@ describe EdgeRider::CollectIds do
     context 'when called on a scope' do
 
       it 'should return the ids for all records matching that scope' do
-        Forum.create!(:id => 1, :name => 'Name 1')
-        Forum.create!(:id => 2, :name => 'Name 2')
-        Forum.create!(:id => 3, :name => 'Name 2')
-        scope = Forum.scoped(:conditions => { :name => 'Name 2' })
+        Forum.create!(id: 1, name: 'Name 1')
+        Forum.create!(id: 2, name: 'Name 2')
+        Forum.create!(id: 3, name: 'Name 2')
+        scope = Forum.scoped(conditions: { name: 'Name 2' })
         scope.collect_ids.should =~ [2, 3]
       end
 
@@ -53,8 +53,8 @@ describe EdgeRider::CollectIds do
     context 'when called on an array of ActiveRecords' do
 
       it 'should return the ids collected from that list' do
-        forum_1 = Forum.create!(:id => 1)
-        forum_2 = Forum.create!(:id => 2)
+        forum_1 = Forum.create!(id: 1)
+        forum_2 = Forum.create!(id: 2)
         [forum_1, forum_2].collect_ids.should =~ [1, 2]
       end
 
@@ -72,8 +72,8 @@ describe EdgeRider::CollectIds do
 
       it 'should return the ids' do
         topic = Topic.create!
-        post = Post.create!(:topic => topic, :id => 1)
-        post = Post.create!(:topic => topic, :id => 2)
+        post = Post.create!(topic: topic, id: 1)
+        post = Post.create!(topic: topic, id: 2)
         topic.reload
         topic.posts.to_a
         topic.posts.collect_ids.should =~ [1,2]
@@ -81,21 +81,21 @@ describe EdgeRider::CollectIds do
 
       it 'should return ids when further restricted with an anonymous scope' do
         topic = Topic.create!
-        post = Post.create!(:topic => topic, :id => 1)
-        post = Post.create!(:topic => topic, :id => 2)
+        post = Post.create!(topic: topic, id: 1)
+        post = Post.create!(topic: topic, id: 2)
         topic.reload
         topic.posts.to_a
         if topic.posts.respond_to?(:where)
-          topic.posts.where(:id => [1]).collect_ids.should =~ [1]
+          topic.posts.where(id: [1]).collect_ids.should =~ [1]
         else
-          topic.posts.scoped(:conditions => {:id => [1]}).collect_ids.should =~ [1]
+          topic.posts.scoped(conditions: {id: [1]}).collect_ids.should =~ [1]
         end
       end
 
       it 'should return ids when further restricted with a named scope' do
         topic = Topic.create!
-        post = Post.create!(:topic => topic, :id => 1)
-        post = Post.create!(:topic => topic, :id => 2)
+        post = Post.create!(topic: topic, id: 1)
+        post = Post.create!(topic: topic, id: 2)
         topic.reload
         topic.posts.to_a
         topic.posts.these([1]).collect_ids.should =~ [1]