edge_rider 1.0.0 → 2.1.0

data/Gemfile.7.0.pg.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: .
+  specs:
+    edge_rider (2.1.0)
+      activerecord (>= 3.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.0.1)
+      activesupport (= 7.0.1)
+    activerecord (7.0.1)
+      activemodel (= 7.0.1)
+      activesupport (= 7.0.1)
+    activesupport (7.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    database_cleaner (2.0.1)
+      database_cleaner-active_record (~> 2.0.0)
+    database_cleaner-active_record (2.0.1)
+      activerecord (>= 5.a)
+      database_cleaner-core (~> 2.0.0)
+    database_cleaner-core (2.0.1)
+    db-query-matchers (0.8.0)
+    diff-lcs (1.5.0)
+    gemika (0.6.1)
+    has_defaults (1.0.0)
+      activerecord
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.15.0)
+    pg (1.2.3)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  activerecord (~> 7.0.1)
+  database_cleaner
+  db-query-matchers
+  edge_rider!
+  gemika (>= 0.5.0)
+  has_defaults
+  pg
+  pry-byebug
+  rake
+  rspec
+
+BUNDLED WITH
+   2.3.4

data/Gemfile.lock

@@ -0,0 +1 @@
+Gemfile.6.1.pg.lock

data/README.md

@@ -1,8 +1,6 @@
-Edge Rider [![Build Status](https://secure.travis-ci.org/makandra/edge_rider.png?branch=master)](https://travis-ci.org/makandra/edge_rider)
-====================================
+# Edge Rider [![Tests](https://github.com/makandra/edge_rider/workflows/Tests/badge.svg)](https://github.com/makandra/edge_rider/actions)
 
-Power tools for ActiveRecord relations (scopes)
--------------------------------------------------
+## Power tools for ActiveRecord relations (scopes)
 
 In ActiveRecord, relations (or scopes) allow you to construct complex queries piece-by-piece
 and then trigger a query or update at a precisely defined moment. If you write any kind
@@ -14,9 +12,7 @@ Edge Rider was created with two intents:
 2. Provide a stable API for working with relations across multiple versions of Rails (since
 Rails has a tradition of breaking details of its relation API every other release).
 
-
-Usage
------
+## Usage
 
 ### Traversing a relation along an association
 
@@ -25,20 +21,26 @@ returns a new relation by "pivoting" around a named association.
 
 Say we have a `Post` model and each `Post` belongs to an author:
 
-    class Post < ActiveRecord::Base
-      belongs_to :author
-    end
-  
+```ruby
+class Post < ActiveRecord::Base
+  belongs_to :author
+end
+```
+
 To turn a relation of posts into a relation of its authors:
 
-    posts = Post.where(archived: false)
-    authors = posts.traverse_association(:author)
-    
+```ruby
+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_by_same_authors = posts.traverse_association(:author, :posts)
+```ruby
+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
 and return a new relation with an `IN(...)` query (which is very efficient even for many thousand keys).
@@ -56,8 +58,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)
-    post_ids = posts.collect_ids
+```ruby
+posts = Post.where(archived: false)
+post_ids = posts.collect_ids
+```
 
 *Implementation note:* `#collect_ids` delegates to [`#pluck`](https://apidock.com/rails/ActiveRecord/Calculations/pluck),
 which can be used for the same purpose.
@@ -68,33 +72,39 @@ which can be used for the same purpose.
 When writing a method that filters by record IDs, you can make it more useful by accepting
 any kind of argument that can be turned into a list of IDs:
 
-    Post.by_author(1)
-    Post.by_author([1, 2, 3])
-    Post.by_author(Author.find(1))
-    Post.by_author([Author.find(1), Author.find(2)])
-    Post.by_author(Author.active)
+```ruby
+Post.by_author(1)
+Post.by_author([1, 2, 3])
+Post.by_author(Author.find(1))
+Post.by_author([Author.find(1), Author.find(2)])
+Post.by_author(Author.active)
+```
 
 For this use case Edge Rider defines `#collect_ids` on many different types:
 
-    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]
-    1.collect_ids                            # => [1]
+```ruby
+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]
+1.collect_ids                            # => [1]
+```
 
 You can now write `Post.by_author` from the example above without a single `if` or `case`:
 
-    class Post < ActiveRecord::Base
-    
-      belongs_to :author
+```ruby
+class Post < ActiveRecord::Base
+
+  belongs_to :author
+
+  def self.for_author(author_or_authors)
+    where(author_id: author_or_authors.collect_ids)
+  end
+
+end
+```
 
-      def self.for_author(author_or_authors)
-        where(author_id: author_or_authors.collect_ids)
-      end
 
-    end
-    
-    
 ### Efficiently collect all values in a relation's column
 
 You often want to ask a relation for an array of all values ofin a given column.
@@ -106,8 +116,10 @@ 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)
-    subjects = posts.collect_column(:subject)
+```ruby
+posts = Post.where(archived: false)
+subjects = posts.collect_column(:subject)
+```
 
 *Implementation note:* `#collect_column` delegates to [`#pluck`](https://apidock.com/rails/ActiveRecord/Calculations/pluck),
 which can be used for the same effect.
@@ -116,8 +128,10 @@ which can be used for the same effect.
 
 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)
+```ruby
+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.
 
@@ -136,38 +150,49 @@ 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
+```ruby
+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:
 
-    SELECT sites.id FROM sites INNER JOIN users WHERE sites.user_id = sites.id AND users.name = 'Bruce'
+```sql
+SELECT sites.id FROM sites INNER JOIN users WHERE sites.user_id = sites.id AND users.name = 'Bruce'
+```
 
 It now uses these IDs to return a new relation that has **no joins** and a single condition on the `id` column:
 
-    SELECT * FROM sites WHERE sites.user_id IN (3, 17, 103)
+```sql
+SELECT * FROM sites WHERE sites.user_id IN (3, 17, 103)
+```
 
 
 ### Preload associations for loaded ActiveRecords
 
 Sometimes you want to fetch associations for records that you already instantiated, e.g. when it has deeply nested associations.
 
-Edge Rider gives your model classes a method `.preload_associations`. The method can be used to preload associations for loaded objects like this:
+Edge Rider gives your model classes and instances 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 }
+```ruby
+@user = User.find(params[:id])
+User.preload_associations [@user], { threads: { posts: :author }, messages: :sender }
+# or
+user.preload_associations { threads: { posts: :author }, messages: :sender }
+```
 
 *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+.
 
 
-
 ### Retrieve the class a relation is based on
 
 Edge Rider gives your relations a method `#origin_class` that returns the class the relation is based on.
 This is useful e.g. to perform unscoped record look-up.
 
-    Post.recent.origin_class
-    # => Post
+```ruby
+Post.recent.origin_class
+# => Post
+```
 
 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.
@@ -180,8 +205,10 @@ Edge Rider ports `Model.scoped` forward to Rails 4+ (taken from
 enables you to consistently turn models into scopes or narrow down scopes
 across all versions of Rails.
 
-    User.scoped # just calls User.all in Rails 4
-    User.active.scoped(conditions: { admin: true })
+```ruby
+User.scoped # just calls User.all in Rails 4
+User.active.scoped(conditions: { admin: true })
+```
 
 *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
@@ -194,21 +221,21 @@ slightly different in all versions of Rails (see
 methods are not modified.
 
 
-Installation
-------------
+## Installation
 
 In your `Gemfile` say:
 
-    gem 'edge_rider'
+```ruby
+gem 'edge_rider'
+```
 
 Now run `bundle install` and restart your server.
 
 
-Development
------------
+## Development
 
 - There are tests in `spec`. We only accept PRs with tests.
-- 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.
+- 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 Github Actions.
 - 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 the project root for each combination of ActiveRecord version and database type that we support.
@@ -222,7 +249,6 @@ If you would like to contribute:
 - Send me a pull request.
 
 
-Credits
--------
+## Credits
 
 Henning Koch from [makandra](http://makandra.com/)

data/edge_rider.gemspec

@@ -1,20 +1,30 @@
-$:.push File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "edge_rider/version"
 
-Gem::Specification.new do |s|
-  s.name = 'edge_rider'
-  s.version = EdgeRider::VERSION
-  s.authors = ["Henning Koch"]
-  s.email = 'henning.koch@makandra.de'
-  s.homepage = 'https://github.com/makandra/edge_rider'
-  s.summary = 'Power tools for ActiveRecord relations (scopes)'
-  s.description = s.summary
-  s.license = 'MIT'
+Gem::Specification.new do |spec|
+  spec.name = 'edge_rider'
+  spec.version = EdgeRider::VERSION
+  spec.required_ruby_version = '>= 2.3.0'
+  spec.authors = ['Henning Koch']
+  spec.email = ['henning.koch@makandra.de']
 
-  s.files         = `git ls-files`.split("\n").select { |path| File.exist?(path) && !File.symlink?(path) }
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n").select { |path| File.exist?(path) && !File.symlink?(path) }
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  spec.summary = 'Power tools for ActiveRecord relations (scopes)'
+  spec.description = spec.summary
+  spec.homepage = 'https://github.com/makandra/edge_rider'
+  spec.license = 'MIT'
+  spec.metadata = { 'rubygems_mfa_required' => 'true' }
 
-  s.add_dependency('activerecord')
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r(^exe/)) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency('activerecord', '>=3.2')
+
+  # Development dependencies are defined in the Gemfile (therefore no `spec.add_development_dependency` directives)
 end

data/lib/edge_rider/preload_associations.rb

@@ -1,25 +1,27 @@
 module EdgeRider
   module PreloadAssociations
+    module PreloadAssociationsInstanceMethod
+      def preload_associations(*args)
+        self.class.preload_associations([self], *args)
+      end
+    end
 
     def preload_associations(*args)
       preloader = ActiveRecord::Associations::Preloader
 
-      if preloader.method_defined?(:preload) # Rails 4
-        preloader.new.preload(*args)
-      else
+      if preloader.method_defined?(:run) # Rails 3.2 / Rails 4
         preloader.new(*args).run
+      elsif preloader.method_defined?(:preload) # Rails 5 to Rails 6.1
+        preloader.new.preload(*args)
+      else # Rails 7+
+        records = args.first
+        associations = args.second
+        options = args[2] || {}
+        preloader.new(records: records, associations: associations, **options).call
       end
     end
 
-    if ActiveRecord::Base.respond_to?(:preload_associations, true) # Rails 2/3.0
-      ActiveRecord::Base.class_eval do
-        class << self
-          public :preload_associations
-        end
-      end
-    else # Rails 3.2+
-      ActiveRecord::Base.send(:extend, self)
-    end
-
+    ActiveRecord::Base.send(:extend, self)
+    ActiveRecord::Base.send(:include, PreloadAssociationsInstanceMethod)
   end
 end

data/lib/edge_rider/traverse_association.rb

@@ -8,7 +8,7 @@ module EdgeRider
 
       scope = scoped({})
 
-      associations.each_with_index do |association, index|
+      associations.each do |association|
 
         reflection = scope.reflect_on_association(association) or raise UnknownAssociation, "Could not find association: #{self.name}##{association}"
         foreign_key = reflection.respond_to?(:foreign_key) ? reflection.foreign_key : reflection.primary_key_name
@@ -24,8 +24,12 @@ module EdgeRider
           if reflection.through_reflection # has_many :through
             scope = scope.traverse_association(reflection.through_reflection.name, reflection.source_reflection.name)
           else # has_many or has_one
-            ids = scope.collect_ids
-            scope = EdgeRider::Util.exclusive_query(reflection.klass, foreign_key => ids)
+            conditions = {}
+            # A polymorphic association has a type attribute, e.g. record_type, that needs to be added to condition.
+            conditions[reflection.type] = self.name if reflection.type.present?
+            conditions[foreign_key] = scope.collect_ids
+
+            scope = EdgeRider::Util.exclusive_query(reflection.klass, conditions)
           end
         else
           raise UnsupportedAssociation, "Unsupport association type: #{reflection.macro}"

data/lib/edge_rider/util.rb

@@ -52,7 +52,7 @@ module EdgeRider
         # but Rails 2 does not have it.
         other_options = options.slice!(:conditions)
         scope = lambda { |*args| scoped(options) }
-        owner.send association, target, scope, other_options
+        owner.send association, target, scope, **other_options
       end
     end
 

data/lib/edge_rider/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: edge_rider
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Henning Koch
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2019-06-12 00:00:00.000000000 Z
+date: 2022-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,26 +16,27 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
 description: Power tools for ActiveRecord relations (scopes)
-email: henning.koch@makandra.de
+email:
+- henning.koch@makandra.de
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
+- ".rspec"
 - ".ruby-version"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile.3.2.mysql2
-- Gemfile.3.2.mysql2.lock
+- Gemfile
 - Gemfile.4.2.mysql2
 - Gemfile.4.2.mysql2.lock
 - Gemfile.4.2.pg
@@ -44,8 +45,11 @@ files:
 - Gemfile.5.2.mysql2.lock
 - Gemfile.5.2.pg
 - Gemfile.5.2.pg.lock
-- Gemfile.6.0.pg
-- Gemfile.6.0.pg.lock
+- Gemfile.6.1.pg
+- Gemfile.6.1.pg.lock
+- Gemfile.7.0.pg
+- Gemfile.7.0.pg.lock
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -61,23 +65,11 @@ files:
 - lib/edge_rider/traverse_association.rb
 - lib/edge_rider/util.rb
 - lib/edge_rider/version.rb
-- spec/edge_rider/collect_column_spec.rb
-- spec/edge_rider/collect_ids_spec.rb
-- spec/edge_rider/origin_class_spec.rb
-- spec/edge_rider/preload_associations_spec.rb
-- spec/edge_rider/scoped_spec.rb
-- spec/edge_rider/to_id_query_spec.rb
-- spec/edge_rider/traverse_association_spec.rb
-- spec/edge_rider/util_spec.rb
-- spec/spec_helper.rb
-- spec/support/database.rb
-- spec/support/database.sample.yml
-- spec/support/database.travis.yml
-- spec/support/models.rb
 homepage: https://github.com/makandra/edge_rider
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -86,15 +78,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: Power tools for ActiveRecord relations (scopes)

data/.travis.yml

@@ -1,63 +0,0 @@
-language: ruby
-
-rvm:
-  - '2.2.4'
-  - '2.3.1'
-  - '2.4.1'
-  - '2.5.3'
-
-gemfile:
-  - 'Gemfile.3.2.mysql2'
-  - 'Gemfile.4.2.mysql2'
-  - 'Gemfile.4.2.pg'
-  - 'Gemfile.5.2.mysql2'
-  - 'Gemfile.5.2.pg'
-  - 'Gemfile.6.0.pg'
-
-matrix:
-  exclude:
-    # Rails 3.2
-    - gemfile: 'Gemfile.3.2.mysql2'
-      rvm: '2.3.1'
-    - gemfile: 'Gemfile.3.2.mysql2'
-      rvm: '2.4.1'
-    - gemfile: 'Gemfile.3.2.mysql2'
-      rvm: '2.5.3'
-    # Rails 4.2
-    - gemfile: 'Gemfile.4.2.mysql2'
-      rvm: '2.4.1'
-    - gemfile: 'Gemfile.4.2.pg'
-      rvm: '2.4.1'
-    - gemfile: 'Gemfile.4.2.mysql2'
-      rvm: '2.5.3'
-    - gemfile: 'Gemfile.4.2.pg'
-      rvm: '2.5.3'
-    # Rails 5.2
-    # Rails 6
-    - gemfile: 'Gemfile.6.0.pg'
-      rvm: '2.2.4'
-    - gemfile: 'Gemfile.6.0.pg'
-      rvm: '2.3.1'
-    - gemfile: 'Gemfile.6.0.pg'
-      rvm: '2.4.1'
-
-services:
-  - mysql
-
-install:
-  # Replace default Travis CI bundler script with a version that doesn't
-  # explode when lockfile doesn't match recently bumped version
-  - bundle install --no-deployment --jobs=3 --retry=3 --path=${BUNDLE_PATH:-vendor/bundle}
-
-addons:
-  postgresql: 9.3
-
-before_script:
-  - psql -c 'create database edge_rider_test;' -U postgres
-  - mysql -e 'create database IF NOT EXISTS edge_rider_test;'
-
-script: bundle exec rake current_rspec
-
-notifications:
-  email:
-    - fail@makandra.de