where_chain 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9056c05e208067983f91e1bcb9343cd8c1e43a924351cfcf0092efc012a806fa
-  data.tar.gz: 6f9b610d7b560e4d457e79d5448d5afd849924d6b0c1a71a3228e55d0ad62e54
+  metadata.gz: 581e86507fb7660511dc6a80f900fe2d5318550cede75a424d2191f807b674ac
+  data.tar.gz: 33949deb16c6b373690b51100894b03dd8cc508a931f58d31f3c0e5420103d0e
 SHA512:
-  metadata.gz: 5338073a0179b6084b87211d915542500b4064552c0f536c5f0f78ae39ce6abb18914c60d87bc5636215da77c822877d0004eb46076d5ecc362b1f099d874224
-  data.tar.gz: ba3d5820c1d7384918e1eb2744113fbef2d4f75f797d6316cdf27cea8ec316c86b88e0fa811a73bb70d075b9e5e062d2865e05df5c5df12d33ec049a7b596dec
+  metadata.gz: a05d9262e5fbcded7b9bf93d3caf49a71400a2c3cad10f638b8171e621efcebc7f69c7c506c34f2e98199cf9346fd0005b0ba76ba50d92fdb3b720f5463f9daf
+  data.tar.gz: 89d930e741ce21bdd79eaac8018af0124ae94457670db8b8191a526ae64da6a83abc5b0594fc7bae3b204b97957351b43d988a384005ae7d5de774c1d2bd5dc6

data/README.md

@@ -1,4 +1,4 @@
-[![CircleCI](https://circleci.com/gh/marcinruszkiewicz/where_chain.svg?style=svg)](https://circleci.com/gh/marcinruszkiewicz/where_chain)
+[![Gem Version](https://badge.fury.io/rb/where_chain.svg)](https://badge.fury.io/rb/where_chain) [![CircleCI](https://circleci.com/gh/marcinruszkiewicz/where_chain.svg?style=shield)](https://circleci.com/gh/marcinruszkiewicz/where_chain)
 
 # WhereChain
 

data/lib/active_record/where_chain_extensions_rails4.rb

@@ -3,7 +3,18 @@ module ActiveRecord
     class WhereChain
       include WhereChainSharedMethods
 
-      # if passed nothing, default to chaining further
+      # Returns a new relation expressing WHERE + NOT condition
+      # according to the conditions in the arguments.
+      #
+      #    User.where.not(name: nil)
+      #    # SELECT * FROM users WHERE users.name IS NOT NULL
+      #
+      # If there is no argument, chain further.
+      #
+      #    User.where.not.gt(login_count: 3)
+      #    # SELECT * FROM users WHERE NOT(users.login_count > 3)
+      #
+      # Note: This is the Active Record 4 version.
       def not(opts = :chain, *rest)
         where_value = @scope.send(:build_where, opts, rest).map do |rel|
           case rel
@@ -26,10 +37,14 @@ module ActiveRecord
         @scope.references!(PredicateBuilder.references(opts)) if Hash === opts
         @scope.where_values += where_value
         @scope
-      end 
+      end
 
       private
 
+      # Prepare the WHERE clause by inserting a proper Arel node and inverting
+      # it if necessary.
+      #
+      # Note: This is the Active Record 4 version.
       def prepare_where(node_type, infix, opts, *rest)
         where_value = @scope.send(:build_where, opts, rest).map do |rel|
           if @invert

data/lib/active_record/where_chain_extensions_rails5.rb

@@ -1,4 +1,5 @@
 module ActiveRecord
+  # Ruby complains about missing the class if we try to patch it without it
   class Relation
     class QueryMethods; end
   end
@@ -7,6 +8,18 @@ module ActiveRecord
     class WhereChain
       include WhereChainSharedMethods
 
+      # Returns a new relation expressing WHERE + NOT condition
+      # according to the conditions in the arguments.
+      #
+      #    User.where.not(name: nil)
+      #    # SELECT * FROM users WHERE users.name IS NOT NULL
+      #
+      # If there is no argument, chain further.
+      #
+      #    User.where.not.gt(login_count: 3)
+      #    # SELECT * FROM users WHERE NOT(users.login_count > 3)
+      #
+      # Note: This is the Active Record 5 version.
       def not(opts = :chain, *rest)
         if :chain == opts
           @invert = true
@@ -22,8 +35,12 @@ module ActiveRecord
         @scope
       end
 
-      private 
+      private
 
+      # Prepare the WHERE clause by inserting a proper Arel node and inverting
+      # it if necessary.
+      #
+      # Note: This is the Active Record 5 version.
       def prepare_where(node_type, infix, opts, rest)
         @scope.tap do |s|
           opts.each_pair do |key, value|
@@ -41,13 +58,15 @@ module ActiveRecord
         end
       end
 
+      # Active Record 5.2 changed the API and removed binds method so we need to pass
+      # proper arguments to build a WHERE clause
       def build_where_clause(new_predicate, old_where_clause)
         if old_where_clause.respond_to?(:binds)
           Relation::WhereClause.new([new_predicate], old_where_clause.binds)
         else
           Relation::WhereClause.new([new_predicate])
         end
-      end   
+      end
     end
   end
-end
+end

data/lib/active_record/where_chain_shared_methods.rb

@@ -3,16 +3,18 @@ module ActiveRecord
     extend ActiveSupport::Concern
 
     included do
+      # Initialize the chain with a scope and a toggle to invert the generated
+      # where statement
       def initialize(scope, invert=false)
         @scope = scope
         @invert = invert
       end
-            
+
       # Returns a new relation expressing WHERE + LIKE condition
       # according to the conditions provided as a hash in the arguments.
       #
       #    Book.where.like(title: "Rails%")
-      #    # SELECT * FROM books WHERE title LIKE 'Rails%'
+      #    # SELECT * FROM books WHERE books.title LIKE 'Rails%'
       def like(opts, *rest)
         prepare_where(Arel::Nodes::Matches, nil, opts, rest)
       end
@@ -21,51 +23,77 @@ module ActiveRecord
       # according to the conditions provided as a hash in the arguments.
       #
       #    Conference.where.not_like(name: "%Kaigi")
-      #    # SELECT * FROM conferences WHERE name NOT LIKE '%Kaigi'
+      #    # SELECT * FROM conferences WHERE conferences.name NOT LIKE '%Kaigi'
+      #
+      # Also aliased as .not_like to maintain compatibility with the
+      # activerecord-like gem
       def unlike(opts, *rest)
         prepare_where(Arel::Nodes::DoesNotMatch, nil, opts, rest)
       end
-      alias not_like unlike # maintain compatibility with activerecord-like gem
+      alias not_like unlike
 
+      # Returns a new relation expressing a greater than condition in WHERE
+      # according to the conditions in an argument hash
+      #
+      #    Conference.where.gt(speakers: 10)
+      #    # SELECT * FROM conferences WHERE conferences.speakers > 10
       def gt(opts, *rest)
         ensure_proper_attributes(opts)
         prepare_where(Arel::Nodes::InfixOperation, '>', opts, rest)
       end
 
+      # Returns a new relation expressing a greater than or equal condition in WHERE
+      # according to the conditions in an argument hash
+      #
+      #    Conference.where.gte(speakers: 10)
+      #    # SELECT * FROM conferences WHERE conferences.speakers >= 10
       def gte(opts, *rest)
         ensure_proper_attributes(opts)
         prepare_where(Arel::Nodes::InfixOperation, '>=', opts, rest)
       end
 
+      # Returns a new relation expressing a less than condition in WHERE
+      # according to the conditions in an argument hash
+      #
+      #    Conference.where.lt(date: DateTime.new(2018, 3, 18))
+      #    # SELECT * FROM conferences WHERE conferences.date < '2018-03-18 00:00:00'
       def lt(opts, *rest)
         ensure_proper_attributes(opts)
         prepare_where(Arel::Nodes::InfixOperation, '<', opts, rest)
       end
 
+      # Returns a new relation expressing a less than or equal condition in WHERE
+      # according to the conditions in an argument hash
+      #
+      #    Conference.where.lt(date: DateTime.new(2018, 3, 18))
+      #    # SELECT * FROM conferences WHERE conferences.date <= '2018-03-18 00:00:00'
       def lte(opts, *rest)
         ensure_proper_attributes(opts)
         prepare_where(Arel::Nodes::InfixOperation, '<=', opts, rest)
       end
 
-      private 
+      private
 
+      # Ensures that the arguments passed to methods are a Hash and that the value in the argument
+      # hash is not another Hash or Array.
       def ensure_proper_attributes(opts)
         raise ArgumentError, 'This method requires a Hash as an argument.' unless opts.is_a?(Hash)
 
         opts.each_pair do |key, value|
           if value.is_a?(Hash) || value.is_a?(Array)
-            raise ArgumentError, 'The value passed to this method should be a valid type.' 
+            raise ArgumentError, 'The value passed to this method should be a valid type.'
           end
         end
       end
 
+      # Arel::Nodes::InfixOperation.new expects more arguments than other Arel nodes
       def arel_node(node_type, infix, rel)
         if infix.present?
           node_type.new(infix, rel.left, rel.right)
         else
           node_type.new(rel.left, rel.right)
         end
-      end      
+      end
     end
   end
-end
+end

data/lib/where_chain.rb

@@ -1,7 +1,8 @@
 require 'active_record/where_chain_shared_methods'
 
+# Active Record changed a lot in Rails 5 and 4 is still supported
 if ActiveRecord::VERSION::MAJOR == 4
   require 'active_record/where_chain_extensions_rails4'
 elsif ActiveRecord::VERSION::MAJOR == 5
   require 'active_record/where_chain_extensions_rails5'
-end
+end

data/lib/where_chain/version.rb

@@ -1,3 +1,3 @@
 module WhereChain
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: where_chain
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Marcin Ruszkiewicz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-18 00:00:00.000000000 Z
+date: 2018-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord