sexy_scopes 0.5.1 → 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ce33d394e7388e54629f64eb7ffb6db752337088
+  data.tar.gz: 08ed0052a528fba6aec3bdfc27ef53e36c881790
+SHA512:
+  metadata.gz: fcf5492bd6d3717504dcf30371796781cd46d13ef5b9fc2de143925b93b6488141f9cf705348b20c0f77fe4e60dfc3b05b7bed8ce4a415a57407ecd381104d33
+  data.tar.gz: 490a59156615aeef8e8e94bafb92877c20ebf30680bac27120e5883913ac34da5cf724c694e5d19ea758c17b6fe03ed5a4aa8678f0fa5f5d8edea2227e0a95b1

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+bundler_args: --without development --standalone
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode
+gemfile:
+  - ci/Gemfile.ar3.1
+  - ci/Gemfile.ar3.2
+  - ci/Gemfile.ar-edge
+matrix:
+  exclude:
+    - rvm: 1.9.2
+      gemfile: ci/Gemfile.ar-edge
+branches:
+  only:
+    - master

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+### 0.6.0
+
+- Drop support for Ruby < 1.9.2 and ActiveRecord < 3.1
+- Add support for JRuby and Rubinius
+- Integrate with Travis CI
+
+### 0.5.1
+
+- Initial stable release

data/Gemfile

@@ -1,2 +1,2 @@
-source :rubygems
+source 'https://rubygems.org'
 gemspec

data/README.md

@@ -1,62 +1,116 @@
 SexyScopes
 ==========
 
+[![Gem Version](https://badge.fury.io/rb/sexy_scopes.png)](https://rubygems.org/gems/sexy_scopes)
+[![Dependencies](https://gemnasium.com/samleb/sexy_scopes.png?travis)](https://gemnasium.com/samleb/sexy_scopes)
+[![Code Climate](https://codeclimate.com/github/samleb/sexy_scopes.png)](https://codeclimate.com/github/samleb/sexy_scopes)
+[![Build Status](https://api.travis-ci.org/samleb/sexy_scopes.png)](https://travis-ci.org/samleb/sexy_scopes)
+[![Coverage Status](https://coveralls.io/repos/samleb/sexy_scopes/badge.png)](https://coveralls.io/r/samleb/sexy_scopes)
+
 **Write beautiful and expressive ActiveRecord scopes without SQL**
 
+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.
+
 * [Source Code](https://github.com/samleb/sexy_scopes)
 * [Rubygem](http://rubygems.org/gems/sexy_scopes)
-
-SexyScopes is a gem that adds syntactic sugar for creating scopes in Rails 3.
+* [API Documentation](http://rubydoc.info/gems/sexy_scopes)
 
 Usage & Examples
 ----------------
 
+Let's define a `Product` model with this schema:
+
 ```ruby
+# price     :integer
+# category  :string
+# visible   :boolean
+# draft     :boolean
 class Product < ActiveRecord::Base
-  # `self.price` represents the `price` column
-  def self.cheaper_than(price)
-    where self.price < price
-  end
-  
-  scope :visible, (category != nil) & (draft == false)
-  
-  # can't use `name` directly here as `Product.name` method already exists (== "Product")
-  def self.search(term)
-    where attribute(:name) =~ "%#{term}%"
-  end
 end
 ```
 
-Classic `Arel::Attribute` methods (`lt`, `in`, `matches`, `not`, etc.) are still 
-available and predicates can be chained using special operators `&` (`and`),
-`|` (`or`), and `~` (`not`):
+Now take a look at the following scope:
 
 ```ruby
-class User < ActiveRecord::Base
-  scope :recently_signed_in, lambda {
-    where last_sign_in_at > 10.days.ago
-  }
-  
-  (score + 20 == 40).to_sql
-  # => ("users"."score" + 20) = 40
-  
-  ((username == "Bob") | (username != "Alice")).to_sql
-  # => ("users"."username" = 'Bob' OR "users"."username" != 'Alice')
+scope :visible, where("category IS NOT NULL AND draft = ? AND price > 0", false)
+```
+
+Hum, lots of *SQL*, not very *Ruby*-esque...
+
+**With SexyScopes**
+
+```ruby
+scope :visible, where((category != nil) & (draft == false) & (price > 0))
+```
+
+Much better! Looks like magic? *It's not*.
+
+`category`, `draft` and `price` in this context are methods representing your model's columns.
+They respond to Ruby operators (like `<`, `==`, etc.) and can be combined
+with logical operators (`&` and `|`) to express complex predicates.
+
+--------------------------
+
+Let's take a look at another example with these relations:
+
+```ruby
+# rating:  integer
+class Post < ActiveRecord::Base
+  has_many :comments
 end
 
-class Product < ActiveRecord::Base
-  predicate = (attribute(:name) == nil) & ~category.in(%w( shoes shirts ))
-  predicate.to_sql
-  # => "products"."name" IS NULL AND NOT ("products"."category" IN ('shoes', 'shirts'))
-  
-  # These predicates can be used as arguments to `where`
-  where(predicate).all
-  # => SELECT "products".* FROM "products" WHERE "products"."name" IS NULL AND 
-  #    NOT ("products"."category" IN ('shoes', 'shirts'))
+# post_id:  integer
+# rating:   integer
+class Comment < ActiveRecord::Base
+  belongs_to :post
 end
 ```
 
-Here is a complete list of Arel method aliases:
+Now let's find posts having comments with a rating > 3.
+
+**Without SexyScopes**
+
+```ruby
+Post.joins(:comments).merge Comment.where("rating > ?", 3)
+# ActiveRecord::StatementInvalid: ambiguous column name: rating
+```
+
+Because both `Post` and `Comment` have a `rating` column, you have to give the table name explicitly:
+
+```ruby
+Post.joins(:comments).merge Comment.where("comments.rating > ?", 3)
+```
+
+Not very DRY, isn't it ?
+
+**With SexyScopes**
+
+```ruby
+Post.joins(:comments).where Comment.rating > 3
+```
+
+Here you have it, clear as day.
+
+How does it work ?
+------------------
+
+SexyScopes is essentially a wrapper around [Arel](https://github.com/rails/arel#readme) attribute nodes.
+
+It introduces a `ActiveRecord::Base.attribute(name)` class method returning an `Arel::Attribute` object, which
+represent a table column with the given name, that is extended to support Ruby operators.
+
+For convenience, SexyScopes dynamically resolves methods whose name is an existing table column: i.e.
+`Product.price` is actually a shortcut for `Product.attribute(:price)`.
+
+Please note that this mechanism won't override any of the existing `ActiveRecord::Base` class methods,
+so if you have a column named `name` for instance, you'll have to use `Product.attribute(:name)` instead of
+`Product.name` (which is the class actual name, i.e. `"Product"`).
+
+Here is a complete list of operators, and their `Arel::Attribute` equivalents:
 
 * For predicates:
   - `==`: `eq`
@@ -68,12 +122,42 @@ Here is a complete list of Arel method aliases:
   - `<=`: `lteq`
   - `!=`: `not_eq`
 
-
 * For combination
   - `&`: `and`
   - `|`: `or`
   - `~`: `not` (unfortunately, unary prefix `!` doesn't work with ActiveRecord)
 
+Advanced Examples
+-----------------
+
+```ruby
+# radius:  integer
+class Circle < ActiveRecord::Base
+  # Attributes can be coerced in arithmetic operations
+  def self.perimeter
+    2 * Math::PI * radius
+  end
+  
+  def self.area
+    Math::PI * radius * radius
+  end
+end
+
+Circle.where Circle.perimeter > 42
+# SQL: SELECT `circles`.* FROM `circles`  WHERE (6.283185307179586 * `circles`.`radius` > 42)
+Circle.where Circle.area < 42
+# SQL: SELECT `circles`.* FROM `circles`  WHERE (3.141592653589793 * `circles`.`radius` * `circles`.`radius` < 42)
+
+class Product < ActiveRecord::Base
+  predicate = (attribute(:name) == nil) & ~category.in(%w( shoes shirts ))
+  puts predicate.to_sql
+  # `products`.`name` IS NULL AND NOT (`products`.`category` IN ('shoes', 'shirts'))
+  
+  where(predicate).all
+  # SQL: SELECT `products`.* FROM `products` WHERE `products`.`name` IS NULL AND 
+  #      NOT (`products`.`category` IN ('shoes', 'shirts'))
+end
+```
 
 Installation
 ------------
@@ -94,7 +178,6 @@ Then require it in your application code:
 
     require 'sexy_scopes'
 
-
 Contributing
 ------------
 
@@ -106,8 +189,15 @@ Report bugs or suggest features using [GitHub issues](https://github.com/samleb/
 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)` ?)
 
 Copyright
 ---------
 
-Copyright (c) 2010-2012 Samuel Lebeau. See LICENSE for details.
+SexyScopes is released under the [MIT License](http://www.opensource.org/licenses/MIT).
+
+Copyright (c) 2010-2013 Samuel Lebeau, See LICENSE for details.

data/Rakefile

@@ -5,15 +5,9 @@ desc "Run specifications"
 RSpec::Core::RakeTask.new(:spec)
 
 desc "Measure test coverage"
-if RUBY_VERSION >= '1.9'
-  task :cov do
-    ENV['COVERAGE'] = '1'
-    Rake::Task['spec'].invoke
-  end
-else
-  RSpec::Core::RakeTask.new(:cov) do |spec|
-    spec.rcov = true
-  end
+task :cov do
+  ENV['COVERAGE'] = '1'
+  Rake::Task['spec'].invoke
 end
 
 task :default => :spec

data/ci/Gemfile.ar-edge

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', :github => 'rails/rails', :branch => 'master'
+
+gem 'rake', '~> 0.9'
+gem 'rspec', '~> 2.0'
+gem 'sqlite3', '~> 1.0'
+gem 'coveralls', require: false

data/ci/Gemfile.ar3.1

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 3.1.0'
+
+gem 'rake', '~> 0.9'
+gem 'rspec', '~> 2.0'
+gem 'sqlite3', '~> 1.0'
+gem 'coveralls', require: false

data/ci/Gemfile.ar3.2

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 3.2.0'
+
+gem 'rake', '~> 0.9'
+gem 'rspec', '~> 2.0'
+gem 'sqlite3', '~> 1.0'
+gem 'coveralls', require: false

data/lib/sexy_scopes/active_record/dynamic_methods.rb

@@ -1,17 +1,14 @@
 module SexyScopes
   module ActiveRecord
     module DynamicMethods
-      # @!visibility private
-      def respond_to?(method_name, include_private = false) # :nodoc:
-        super || respond_to_missing?(method_name, include_private)
-      end
-
-      # # @!visibility private
-      def respond_to_missing?(method_name, include_private = false) # :nodoc:
-        Object.respond_to?(:respond_to_missing?) && super || sexy_scopes_has_attribute?(method_name)
-      end
-
       private
+        # # @!visibility private
+        def respond_to_missing?(method_name, include_private = false) # :nodoc:
+          # super currently resolve to Object#respond_to_missing? which return false,
+          # but future version of ActiveRecord::Base might implement respond_to_missing?
+          sexy_scopes_has_attribute?(method_name) || super
+        end
+        
         # Equivalent to calling {#attribute} with the missing method's <tt>name</tt> if the table
         # has a column with that name.
         #

data/lib/sexy_scopes/version.rb

@@ -1,8 +1,8 @@
 module SexyScopes
   module Version
     MAJOR = 0
-    MINOR = 5
-    TINY  = 1
+    MINOR = 6
+    TINY  = 0
     
     STRING = [MAJOR, MINOR, TINY].join('.')
     

data/sexy_scopes.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
   gem.version       = SexyScopes::VERSION
   
   gem.summary = %{Write beautiful and expressive ActiveRecord scopes without SQL.}
-  gem.description = %{Small DSL to create ActiveRecord (>= 3) attribute predicates without writing SQL.}
+  gem.description = %{Small DSL to create ActiveRecord (>= 3.1) attribute predicates without writing SQL.}
   
   gem.authors       = ['Samuel Lebeau']
   gem.email         = 'samuel.lebeau@gmail.com'
@@ -17,18 +17,16 @@ Gem::Specification.new do |gem|
   
   gem.licenses = ['MIT']
   
-  gem.add_dependency 'activerecord', '~> 3.0'
+  gem.required_ruby_version = '>= 1.9.2'
+  
+  gem.add_dependency 'activerecord', '>= 3.1'
   
   gem.add_development_dependency 'bundler', '~> 1.0'
-  gem.add_development_dependency 'rake', '~> 0.9'
+  gem.add_development_dependency 'rake', '>= 0.9'
   gem.add_development_dependency 'rails', '~> 3.0'
   gem.add_development_dependency 'rspec', '~> 2.0'
   gem.add_development_dependency 'sqlite3', '~> 1.0'
   gem.add_development_dependency 'redcarpet', '~> 2.2'
   gem.add_development_dependency 'yard', '~> 0.8'
-  if RUBY_VERSION >= '1.9'
-    gem.add_development_dependency 'simplecov'
-  else
-    gem.add_development_dependency 'rcov'
-  end
+  gem.add_development_dependency 'simplecov'
 end

data/spec/active_record_spec.rb

@@ -57,10 +57,8 @@ describe SexyScopes::ActiveRecord::DynamicMethods do
     TempUser.username
   end
   
-  ruby_19 do
-    it "should return a Method object for an existing column" do
-      expect { TempUser.method(:username) }.to_not raise_error
-    end
+  it "should return a Method object for an existing column" do
+    expect { TempUser.method(:username) }.to_not raise_error
   end
   
   it "should raise NoMethodError for a non-existing column" do

data/spec/predicate_methods_spec.rb

@@ -28,9 +28,11 @@ describe SexyScopes::Arel::PredicateMethods do
       
       it { should convert_to_sql %{"users"."score" #{sql_operator % 42.0}} }
       
-      it "is aliased as `#{operator}`" do
-        @attribute.method(operator).should == @attribute.method(method)
-      end if operator
+      if operator
+        it "is aliased as `#{operator}`" do
+          described_class.instance_method(operator).should == described_class.instance_method(method)
+        end
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,11 @@
+if ENV['TRAVIS']
+  require 'coveralls'
+  Coveralls.wear! do
+    # exclude gems bundled by Travis
+    add_filter 'ci/bundle'
+  end
+end
+
 if ENV['COVERAGE']
   require 'simplecov'
   SimpleCov.start
@@ -7,14 +15,6 @@ require 'rspec'
 require 'active_record'
 require 'sexy_scopes'
 
-RSpec.configure do |config|
-  config.extend Module.new {
-    def ruby_19
-      yield if RUBY_VERSION >= "1.9"
-    end
-  }
-end
-
 Dir.glob(File.join(File.dirname(__FILE__), '{fixtures,matchers}', '*')) do |file|
   require file
 end

metadata

@@ -1,36 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: sexy_scopes
 version: !ruby/object:Gem::Version
-  version: 0.5.1
-  prerelease: 
+  version: 0.6.0
 platform: ruby
 authors:
 - Samuel Lebeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-16 00:00:00.000000000 Z
+date: 2013-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,23 +41,20 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -94,7 +83,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -102,7 +90,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -110,7 +97,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -118,7 +104,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -126,7 +111,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -134,7 +118,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -142,20 +125,18 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Small DSL to create ActiveRecord (>= 3) attribute predicates without
+description: Small DSL to create ActiveRecord (>= 3.1) attribute predicates without
   writing SQL.
 email: samuel.lebeau@gmail.com
 executables: []
@@ -163,10 +144,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- ci/Gemfile.ar-edge
+- ci/Gemfile.ar3.1
+- ci/Gemfile.ar3.2
 - lib/sexy_scopes.rb
 - lib/sexy_scopes/active_record.rb
 - lib/sexy_scopes/active_record/class_methods.rb
@@ -193,27 +179,26 @@ files:
 homepage: https://github.com/samleb/sexy_scopes
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Write beautiful and expressive ActiveRecord scopes without SQL.
 test_files:
 - spec/active_record_spec.rb