sexy_scopes 0.8.0 → 1.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a8538efe07dea982f302925e0e126c6dd04680d
-  data.tar.gz: 5d5de790bf16294721550ab1166938b3ad01047a
+  metadata.gz: 9b42939a28bfedb23b35b8d097662a57daecfb10
+  data.tar.gz: b68a65eba99c7816b27ac9ea56d8af4db8af33f2
 SHA512:
-  metadata.gz: 95337a57c0814a748d3053174028c0d735798694cc1ca3af048c33d97f79997fa819d7876a44299ba23fabada0601c7a674a93ca0ec8f88ce2d216b472adfc97
-  data.tar.gz: 5a65f9b79859ced79a5bf51f4181464e6402e8e0d2fa1f20f96bda160ebfc2917a2d574d38ca205a564200ddd018891aca0339514ac7e89bad4b390019e5e43c
+  metadata.gz: 21c6566a6ee33cfcda27e03555b219c60de5eb70de9ec688a71f5ca1618c4cae154c185f3c9fcf50518ed7d8bc9174d26b7170aefff1d181e9f2a315d45e8a3f
+  data.tar.gz: 713d10f8ab03c8a7b600c2f1d96c19fcc29ce89d8eea7188dd62b3cc60e3b956fd676c68d2f045b610a7a720b9a99cbf0b0d88479d07d3635b78c6ffee0e8339

data/CHANGELOG.md

@@ -1,6 +1,19 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## 1.0.0.beta1 - 2017-09-17
+
+### Added
+- Support for ActiveRecord 5
+- Support for Ruby >= 2.2
+- Support for Rubinius 3
+- Alternative `where` syntax not implemented using `instance_exec` (relation is passed when block takes an argument)
+- Support for block syntax with `where.not`
+
+### Removed
+- Support for ActiveRecord < 4.2
+- Support for Ruby 1.9.3
+
 ## 0.8.0 - 2015-01-18
 
 ### Added

data/CONTRIBUTING.md

@@ -0,0 +1,47 @@
+Contributing
+------------
+
+### Setup a development environment
+
+- Create the database config file from the sample:
+
+      cp spec/config.example.yml spec/config.yml
+
+- Install the required gems:
+
+      bundle install
+      bundle exec appraisal install
+
+- Edit `spec/config.yml` to reflect the configuration of all your database adapters (similar to `database.yml`)
+
+- To run the test suite, do:
+
+      bundle exec rake
+
+- By default, this will only run the tests with the latest version of ActiveRecord and using an in-memory SQLite3 database.
+  This is the simplest way to ensure you've not broken anything.
+
+- If you want to run the test suite using a particular database, do:
+
+      bundle exec rake spec:mysql
+      bundle exec rake spec:postgresql
+
+- Before committing your changes, ensure they're compatible with all adapters, *and* all ActiveRecord versions by running:
+
+      bundle exec appraisal rake spec:all
+
+### Working with GitHub
+
+Report bugs or suggest features using [GitHub issues](https://github.com/samleb/sexy_scopes).
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+TODO
+----
+
+- Document the `sql_literal` method and how it can be used to create complex subqueries
+- Handle associations (i.e. `Post.comments == Comment.joins(:posts)` ?)

data/README.md

@@ -13,7 +13,7 @@ SexyScopes is a gem that adds syntactic sugar for creating ActiveRecord scopes
 in Ruby instead of SQL.
 This allows for more expressive, less error-prone and database independent conditions.
 
-**WARNING**: This gem requires Ruby >= 1.9.2 and ActiveRecord >= 3.1.
+**WARNING**: This gem requires Ruby >= 2.0.0 and ActiveRecord >= 4.2
 
 * [Source Code](https://github.com/samleb/sexy_scopes)
 * [Rubygem](http://rubygems.org/gems/sexy_scopes)
@@ -58,12 +58,14 @@ Let's take a look at another example with these relations:
 
 ```ruby
 # rating:  integer
+# body: text
 class Post < ActiveRecord::Base
   has_many :comments
 end
 
 # post_id:  integer
 # rating:   integer
+# body: text
 class Comment < ActiveRecord::Base
   belongs_to :post
 end
@@ -75,7 +77,12 @@ Now let's find posts having comments with a rating greater than a given rating i
 
 ```ruby
 @posts = Post.joins(:comments).where('rating > ?', params[:rating])
-# ActiveRecord::StatementInvalid: ambiguous column name: rating
+```
+
+This expression, while syntactically valid, raises the following exception:
+
+```
+ActiveRecord::StatementInvalid: ambiguous column name: rating
 ```
 
 Because both `Post` and `Comment` have a `rating` column, you have to give the table name explicitly:
@@ -84,12 +91,12 @@ Because both `Post` and `Comment` have a `rating` column, you have to give the t
 @posts = Post.joins(:comments).where('comments.rating > ?', params[:rating])
 ```
 
-Not very DRY, is it?
-
 **With SexyScopes**
 
+Since `Comment.rating` represents the `rating` column of the `Comment` model, the above can be rewritten as such:
+
 ```ruby
-@posts = Post.joins(:comments).where Comment.rating > params[:rating]
+@posts = Post.joins(:comments).where { rating > params[:rating] }
 ```
 
 Here you have it, clear as day, still protected from SQL injection.
@@ -145,6 +152,42 @@ Here is a complete list of operators, and their `Arel::Attribute` equivalents:
   - `|`: `or`
   - `~`: `not`
 
+Block syntax
+------------
+
+SexyScopes introduces a new block syntax for the `where` clause, which can be used in 2 different forms:
+
+* With no argument, the block is evaluated in the context of the relation
+
+```ruby
+# `price` is `Product.price`
+Product.where { price < 500 }
+
+# `body` is `post.comments.body`
+post.comments.where { body =~ "%ruby%" }
+```
+
+* With an argument, block is called with the relation as argument
+
+```ruby
+# `p` is the `Product` relation
+Product.where { |p| p.price < 500 }
+
+# `c` is the `post.comments` relation
+post.comments.where { |c| c.body =~ "%ruby%" }
+```
+
+These 2 forms are functionally equivalent.
+The former, while being more concise, is internally implemented using `instance_eval`, which will prevent you from calling method on the receiver (`self`).
+
+*Tip*: Try switching to the later form if you encounter `NoMethodError` exceptions.
+
+Note that you can also use this syntax with `where.not`:
+
+```ruby
+Product.where.not { price > 200 }
+```
+
 Regular Expressions
 -------------------
 
@@ -176,7 +219,8 @@ you could do it:
 ```ruby
 class Admin::UsersController
   def index
-    @users = User.where(User.username =~ Regexp.compile(params[:query]))
+    query = Regexp.compile(params[:query])
+    @users = User.where { username =~ query }
     respond_with @users
   end
 end
@@ -210,9 +254,9 @@ class Circle < ActiveRecord::Base
   end
 end
 
-Circle.where Circle.perimeter > 42
+Circle.where { perimeter > 42 }
 # SQL: SELECT `circles`.* FROM `circles`  WHERE (6.283185307179586 * `circles`.`radius` > 42)
-Circle.where Circle.area < 42
+Circle.where { area < 42 }
 # SQL: SELECT `circles`.* FROM `circles`  WHERE (3.141592653589793 * `circles`.`radius` * `circles`.`radius` < 42)
 
 class Product < ActiveRecord::Base
@@ -229,23 +273,13 @@ end
 Contributing
 ------------
 
-Report bugs or suggest features using [GitHub issues](https://github.com/samleb/sexy_scopes).
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
-TODO
-----
+All suggestions, ideas and contributions are very welcome.
 
-- Document the `sql_literal` method and how it can be used to create complex subqueries
-- Handle associations (i.e. `Post.comments == Comment.joins(:posts)` ?)
+If you want to contribute, please follow the steps described in [CONTRIBUTING.md](CONTRIBUTING.md)
 
 Copyright
 ---------
 
 SexyScopes is released under the [MIT License](http://www.opensource.org/licenses/MIT).
 
-Copyright (c) 2010-2014 Samuel Lebeau, See LICENSE for details.
+Copyright (c) 2010-2017 Samuel Lebeau, See LICENSE for details.

data/lib/arel/visitors_extensions.rb

@@ -2,87 +2,56 @@ require 'arel/visitors'
 
 module Arel
   module Visitors
+    # TODO: Extract these methods into modules
     class ToSql
       private
 
-      def visit_Regexp(regexp, arg = nil)
+      def visit_Regexp(regexp, collector)
         source = SexyScopes.quote(regexp.source)
-        sexy_scopes_visit source, arg
-      end
-
-      # Arel >= 4.0
-      if instance_method(:visit).arity > 1
-        alias_method :sexy_scopes_visit, :visit
-      else
-        def sexy_scopes_visit(node, arg = nil)
-          visit(node)
-        end
-      end
-
-      # Arel >= 6.0
-      if instance_method(:accept).arity > 1
-        def reduce_visitor?
-          true
-        end
-      else
-        def reduce_visitor?
-          false
-        end
+        visit source, collector
       end
     end
 
     class MySQL
       private
 
-      def visit_SexyScopes_Arel_Nodes_RegexpMatches(o, arg = nil)
+      def visit_SexyScopes_Arel_Nodes_RegexpMatches(o, collector)
         regexp = o.right
         right = SexyScopes.quote(regexp.source)
         right = Arel::Nodes::Bin.new(right) unless regexp.casefold?
-        if reduce_visitor?
-          visit o.left, arg
-          arg << ' REGEXP '
-          visit right, arg
-        else
-          "#{sexy_scopes_visit o.left, arg} REGEXP #{visit right}"
-        end
+        visit o.left, collector
+        collector << ' REGEXP '
+        visit right, collector
       end
     end
 
     class PostgreSQL
       private
 
-      def visit_SexyScopes_Arel_Nodes_RegexpMatches(o, arg = nil)
+      def visit_SexyScopes_Arel_Nodes_RegexpMatches(o, collector)
         regexp = o.right
         operator = regexp.casefold? ? '~*' : '~'
         right = SexyScopes.quote(regexp.source)
-        if reduce_visitor?
-          visit o.left, arg
-          arg << SPACE << operator << SPACE
-          visit right, arg
-        else
-          "#{sexy_scopes_visit o.left, arg} #{operator} #{visit right}"
-        end
+        visit o.left, collector
+        collector << SPACE << operator << SPACE
+        visit right, collector
       end
     end
 
     class Oracle
       private
 
-      def visit_SexyScopes_Arel_Nodes_RegexpMatches(o, arg = nil)
+      def visit_SexyScopes_Arel_Nodes_RegexpMatches(o, collector)
         regexp = o.right
         flags = regexp.casefold? ? 'i' : 'c'
         flags << 'm' if regexp.options & Regexp::MULTILINE == Regexp::MULTILINE
-        if reduce_visitor?
-          arg << 'REGEXP_LIKE('
-          visit o.left, arg
-          arg << COMMA
-          visit regexp.source, arg
-          arg << COMMA
-          visit flags, arg
-          arg << ')'
-        else
-          "REGEXP_LIKE(#{sexy_scopes_visit o.left, arg}, #{visit regexp.source}, #{visit flags})"
-        end
+        collector << 'REGEXP_LIKE('
+        visit o.left, collector
+        collector << COMMA
+        visit regexp.source, collector
+        collector << COMMA
+        visit flags, collector
+        collector << ')'
       end
     end
   end

data/lib/sexy_scopes.rb

@@ -13,16 +13,12 @@ module SexyScopes
       predicate.extend(Arel::PredicateMethods)
     end
 
-    def arel_6?
-      @arel_6 ||= ::Arel::VERSION >= '6.0.0'
+    def arel_9?
+      @arel_9 ||= ::Arel::VERSION >= '9.0.0'
     end
 
     def quote(node, attribute = nil)
-      if arel_6?
-        ::Arel::Nodes.build_quoted(node, attribute)
-      else
-        node
-      end
+      ::Arel::Nodes.build_quoted(node, attribute)
     end
 
     alias_method :type_cast, :quote

data/lib/sexy_scopes/active_record.rb

@@ -4,4 +4,7 @@ require 'sexy_scopes/active_record/query_methods'
 
 ActiveRecord::Base.extend SexyScopes::ActiveRecord::ClassMethods
 ActiveRecord::Base.extend SexyScopes::ActiveRecord::DynamicMethods
+
 ActiveRecord::Relation.send(:include, SexyScopes::ActiveRecord::QueryMethods)
+
+ActiveRecord::QueryMethods::WhereChain.send(:prepend, SexyScopes::ActiveRecord::QueryMethods::WhereChainMethods)

data/lib/sexy_scopes/active_record/query_methods.rb

@@ -4,9 +4,9 @@ module SexyScopes
       # Adds support for blocks to ActiveRecord `where`.
       #
       # @example
-      #   User.where { username == 'bob' }
+      #   User.where { username =~ 'bob%' }
       #   # is equivalent to:
-      #   User.where(User.username == 'bob')
+      #   User.where(User.username =~ 'bob%')
       #
       # The block is evaluated in the context of the current relation, and the resulting expression
       # is used as an argument to `where`, thus allowing a cleaner syntax where you don't have to write
@@ -21,15 +21,46 @@ module SexyScopes
       #
       # @raise [ArgumentError] if both arguments and a block are passed
       #
+      # @see WhereChainMethods#not
+      #
       def where(*args, &block)
         if block
-          raise ArgumentError, "You can't use both arguments and a block" if args.any?
-          conditions = instance_exec(&block)
-          super(conditions)
+          super(sexy_scopes_build_conditions_from_block(args, block))
         else
           super
         end
       end
+
+      protected
+
+      def sexy_scopes_build_conditions_from_block(args, block)
+        raise ArgumentError, "You can't use both arguments and a block" if args.any?
+        if block.arity.zero?
+          instance_eval(&block)
+        else
+          block.call(self)
+        end
+      end
+
+      module WhereChainMethods
+        # Adds support for blocks to ActiveRecord `where.not`.
+        #
+        # @example
+        #   User.where.not { username =~ 'bob%' }
+        #
+        # @raise [ArgumentError] if both arguments and a block are passed
+        #
+        # @see QueryMethods#where
+        #
+        def not(*args, &block)
+          if block
+            conditions = @scope.send(:sexy_scopes_build_conditions_from_block, args, block)
+            @scope.where(conditions.not)
+          else
+            super
+          end
+        end
+      end
     end
   end
 end

data/lib/sexy_scopes/arel/math.rb

@@ -1,7 +1,7 @@
 module SexyScopes
   module Arel
     module Math
-      include Typecasting if SexyScopes.arel_6?
+      include Typecasting
 
       def *(other)
         SexyScopes.extend_expression(super)

data/lib/sexy_scopes/version.rb

@@ -1,10 +1,11 @@
 module SexyScopes
   module Version
-    MAJOR = 0
-    MINOR = 8
+    MAJOR = 1
+    MINOR = 0
     TINY  = 0
+    PRE = 'beta1'
 
-    STRING = [MAJOR, MINOR, TINY].join('.')
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
 
     class << self
       # Allows {Version} to display ({to_s}) and behave ({to_str}) as a string

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sexy_scopes
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 1.0.0.beta1
 platform: ruby
 authors:
 - Samuel Lebeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-18 00:00:00.000000000 Z
+date: 2017-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,34 +16,34 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -106,14 +106,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 0.4.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 0.4.9
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +178,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
+- CONTRIBUTING.md
 - LICENSE
 - README.md
 - lib/arel/visitors_extensions.rb
@@ -207,17 +208,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Write beautiful and expressive ActiveRecord scopes without SQL.
 test_files: []
-has_rdoc: