arel-helpers 2.10.0 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 209526ee9962414d0eb5bab7820f6c97cfc51edf362d4ccdaf6b7309e7196fbe
-  data.tar.gz: e3923216fd30b2ab762c581ef0056145a1b09758433159123bee1df3443bc924
+  metadata.gz: b15a810e483ddccf300cec2e2926a44b05be707e557fa7f89d432fa6542ddc72
+  data.tar.gz: 8acaece31ba468798d127deab33ac06c8569b71d51e0a813902f398a5f3efbcc
 SHA512:
-  metadata.gz: 48814845832553b87d496b70982c46a905b0a2aecba5426d3f9e36f3fc2436cee0e71e68ab733fbc0b37cf90981515de695f309d5a4ea35d49becc83d4d1703f
-  data.tar.gz: 638fa0c5ed41050e17bdd642fab0b4dfc94e0d3bb8084a1ca9c6cc89a9d340f11aadc0d0ba98d78628ecf4bbacd465385074cc1f0f82167f1b50298361672472
+  metadata.gz: 265f9cd3e9cbc2d8e3b4c4aa6cb4d2b3cbab4ab8cba267a7088ec56da4cc038271da0ca51d3e2d2d3923cf04d04fc4c8ee79fda0cd571f2b59561677b8dba6d2
+  data.tar.gz: 60de9c7c46e7d1ed33f8d5ac9466613075e8ab1fd0b9a3335a1f88c6ccc19b64a388297c151578fb23d090c58847151a01c4af5a3365702941fb607c9f0512c5

data/README.md

@@ -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/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.10.0'
+  VERSION = '2.11.0'
 end

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arel-helpers
 version: !ruby/object:Gem::Version
-  version: 2.10.0
+  version: 2.11.0
 platform: ruby
 authors:
 - Cameron Dutro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-31 00:00:00.000000000 Z
+date: 2019-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord