arel-helpers 2.8.0 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e692ef35ca5dfd967971eeb47c87ef93b6ca21c142e03ecb29b608c1e8e533e0
-  data.tar.gz: 719115c3d5f7a9c86d89d6bc720e390906eac6a9d5b60d29c19bebe751aa8c5b
+  metadata.gz: b15a810e483ddccf300cec2e2926a44b05be707e557fa7f89d432fa6542ddc72
+  data.tar.gz: 8acaece31ba468798d127deab33ac06c8569b71d51e0a813902f398a5f3efbcc
 SHA512:
-  metadata.gz: 946f6a173a8a3da761ad79b9a416cc7b7871ba0ce879ecd0cb32b2348199c65109df1f7ebee1ec438bdf3cf443d840282935e97d56eed009ac54a31b79cb9d83
-  data.tar.gz: 346d3fcbe5be8208734ca9a35f47870531524d008f8e67d307912eb3582d134b2b51c5a721ff31b5488efb519ade8c6c7830db509aa38450280e764147974527
+  metadata.gz: 265f9cd3e9cbc2d8e3b4c4aa6cb4d2b3cbab4ab8cba267a7088ec56da4cc038271da0ca51d3e2d2d3923cf04d04fc4c8ee79fda0cd571f2b59561677b8dba6d2
+  data.tar.gz: 60de9c7c46e7d1ed33f8d5ac9466613075e8ab1fd0b9a3335a1f88c6ccc19b64a388297c151578fb23d090c58847151a01c4af5a3365702941fb607c9f0512c5

data/Gemfile

@@ -1,16 +1,2 @@
-source "https://rubygems.org"
-
-gemspec
-
-group :development, :test do
-  gem 'pry-byebug'
-
-  # lock to 10.0 until rspec is upgraded
-  gem 'rake', '~> 10.0'
-end
-
-group :test do
-  gem 'rspec', '~> 2.11.0'
-  gem 'rr',    '~> 1.0.4'
-  gem 'sqlite3'
-end
+ENV['BUNDLE_GEMFILE'] = File.expand_path('../Gemfile-rails-6.0.x', __FILE__)
+Bundler.load

data/README.md

@@ -155,7 +155,7 @@ class PostQueryBuilder < ArelHelpers::QueryBuilder
   def with_comments_by(usernames)
     reflect(
       query
-        .joins(:comments => :author)
+        .joins(comments: :author)
         .where(author[:username].in(usernames))
     )
   end
@@ -187,6 +187,32 @@ PostQueryBuilder.new
   .since_yesterday
 ```
 
+#### Conditional reflections
+
+If you have parts of a query that should only be added under certain conditions you can return `reflect(query)` from your method. E.g:
+
+```ruby
+  def with_comments_by(usernames)
+    if usernames
+      reflect(
+        query.where(post[:title].matches("%#{title}%"))
+      )
+    else
+      reflect(query)
+    end
+  end
+```
+
+This can become repetitive, and as an alternative you can choose to prepend `not_nil` to your method definition:
+
+```ruby
+  class PostQueryBuilder < ArelHelpers::QueryBuilder
+    not_nil def with_comments_by(usernames)
+      reflect(query.where(post[:title].matches("%#{title}%"))) if usernames
+    end
+  end
+```
+
 ## Requirements
 
 Requires ActiveRecord >= 3.1.0, < 6, tested against Ruby 2.2.4. Depends on SQLite for testing purposes.

data/arel-helpers.gemspec

@@ -11,13 +11,12 @@ Gem::Specification.new do |s|
   s.description = s.summary = "Useful tools to help construct database queries with ActiveRecord and Arel."
 
   s.platform = Gem::Platform::RUBY
-  s.has_rdoc = true
 
-  if ENV["AR"]
-    s.add_dependency 'activerecord', ENV["AR"]
-  else
-    s.add_dependency 'activerecord', '>= 3.1.0', '< 6'
-  end
+  s.add_dependency 'activerecord', '>= 3.1.0', '< 7'
+
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rspec', '~> 2.11'
+  s.add_development_dependency 'rr', '~> 1.0'
 
   s.require_path = 'lib'
   s.files = Dir["{lib,spec}/**/*", "Gemfile", "History.txt", "README.md", "Rakefile", "arel-helpers.gemspec"]

data/lib/arel-helpers/join_association.rb

@@ -18,7 +18,9 @@ module ArelHelpers
       # This method encapsulates that functionality and yields an intermediate object for chaining.
       # It also allows you to use an outer join instead of the default inner via the join_type arg.
       def join_association(table, association, join_type = Arel::Nodes::InnerJoin, options = {}, &block)
-        if version >= '5.2.1'
+        if version >= '6.0.0'
+          join_association_6_0_0(table, association, join_type, options, &block)
+        elsif version >= '5.2.1'
           join_association_5_2_1(table, association, join_type, options, &block)
         elsif version >= '5.2.0'
           join_association_5_2(table, association, join_type, options, &block)
@@ -217,6 +219,35 @@ module ArelHelpers
         end
       end
 
+      def join_association_6_0_0(table, association, join_type, options = {})
+        aliases = options.fetch(:aliases, [])
+        associations = association.is_a?(Array) ? association : [association]
+
+        alias_tracker = ActiveRecord::Associations::AliasTracker.create(
+          table.connection, table.name, {}
+        )
+
+        join_dependency = ActiveRecord::Associations::JoinDependency.new(
+          table, table.arel_table, associations, join_type
+        )
+
+        constraints = join_dependency.join_constraints([], alias_tracker)
+
+        constraints.map do |join|
+          right = if block_given?
+            yield join.left.name.to_sym, join.right
+          else
+            join.right
+          end
+
+          if found_alias = find_alias(join.left.name, aliases)
+            join.left.table_alias = found_alias.name
+          end
+
+          join_type.new(join.left, right)
+        end
+      end
+
       private
 
       def to_sql(node, table, binds)

data/lib/arel-helpers/query_builder.rb

@@ -16,6 +16,21 @@ module ArelHelpers
 
     def_delegators :@query, *TERMINAL_METHODS
 
+    def self.not_nil(name)
+      mod = Module.new do
+        define_method(name) do |*args|
+          if (value = super(*args))
+            value
+          else
+            reflect(query)
+          end
+        end
+      end
+
+      prepend mod
+      name
+    end
+
     def initialize(query)
       @query = query
     end

data/lib/arel-helpers/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 
 module ArelHelpers
-  VERSION = '2.8.0'
+  VERSION = '2.11.0'
 end

data/spec/env/migrations.rb

@@ -1,6 +1,10 @@
 # encoding: UTF-8
 
-SuperClass = ActiveRecord::VERSION::MAJOR >= 5 && ActiveRecord::VERSION::MINOR >= 1 ? ActiveRecord::Migration[5.1] : ActiveRecord::Migration
+SuperClass = if ActiveRecord::VERSION::MAJOR >= 5
+  ActiveRecord::Migration["#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}".to_f]
+else
+  ActiveRecord::Migration
+end
 
 class CreatePostsTable < SuperClass
   def change

data/spec/query_builder_spec.rb

@@ -13,6 +13,10 @@ class TestQueryBuilder < ArelHelpers::QueryBuilder
   def noop
     reflect(query)
   end
+
+  not_nil def optional(skip:)
+    reflect(query.where(title: "BarBar")) unless skip
+  end
 end
 
 describe ArelHelpers::QueryBuilder do
@@ -57,4 +61,14 @@ describe ArelHelpers::QueryBuilder do
       builder.public_send(method)
     end
   end
+
+  it "returns reflect on existing query if method returns a falsy value" do
+    builder.optional(skip: true).to_sql.strip.should == 'SELECT "posts".* FROM "posts"'
+  end
+
+  it "returns reflect on new query for default chainable method if value is truthy" do
+    builder.optional(skip: false).to_sql.strip.gsub(/\s+/, " ").should == %Q{
+      SELECT \"posts\".* FROM \"posts\" WHERE \"posts\".\"title\" = 'BarBar'
+    }.strip
+  end
 end

data/spec/spec_helper.rb

@@ -5,7 +5,6 @@ $:.push(File.dirname(__FILE__))
 require 'rspec'
 require 'arel-helpers'
 require 'fileutils'
-require 'pry-byebug'
 
 require 'env'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arel-helpers
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.11.0
 platform: ruby
 authors:
 - Cameron Dutro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-16 00:00:00.000000000 Z
+date: 2019-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -19,7 +19,7 @@ dependencies:
         version: 3.1.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,49 @@ dependencies:
         version: 3.1.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: Useful tools to help construct database queries with ActiveRecord and
   Arel.
 email:
@@ -76,8 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Useful tools to help construct database queries with ActiveRecord and Arel.