sexy_scopes 0.2.0

data/.gitignore

@@ -0,0 +1,3 @@
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Samuel Lebeau
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,34 @@
+sexy_scopes
+===========
+
+sexy_scope is a small wrapper around `Arel::Attribute` that adds a little syntactic
+sugar when creating scopes in ActiveRecord.
+It adds an `attribute` class method which takes an attribute name and returns an 
+`Arel::Attribute` wrapper, which responds to common operators to return predicates
+objects that can be used as arguments to `ActiveRecord::Base.where`.
+
+Examples
+--------
+
+    class Product < ActiveRecord::Base
+      scope :untitled, where(attribute(:name) == nil)
+      
+      def self.cheaper_than(price)
+        where attribute(:price) < price
+      end
+      
+      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 `and` and `or`:
+
+    (Product.attribute(:name) == nil).and(Product.attribute(:category).in(["foo", "bar"])).to_sql
+    # => ("products"."name" IS NULL AND "products"."category" IN ('foo', 'bar'))
+
+Copyright
+---------
+
+Copyright (c) 2010 Samuel Lebeau. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,36 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sexy_scopes"
+    gem.summary = %Q{Small DSL to create ActiveRecord attribute predicates without writing SQL.}
+    gem.description = %Q{Small DSL to create ActiveRecord attribute predicates without writing SQL.}
+    gem.email = "samuel.lebeau@gmail.com"
+    gem.homepage = "http://github.com/samleb/sexy_scopes"
+    gem.authors = ["Samuel Lebeau"]
+    gem.add_dependency "activerecord", ">= 3.0.0.beta"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/sexy_scopes.rb

@@ -0,0 +1,22 @@
+require 'delegate'
+require 'active_record'
+require 'arel'
+
+module SexyScopes
+  module ClassMethods
+    def attribute(name)
+      Attribute.new(arel_table[name])
+    end
+  end
+  
+  class Attribute < DelegateClass(Arel::Attribute)
+    alias_method :<,  :lt
+    alias_method :<=, :lteq
+    alias_method :==, :eq
+    alias_method :>=, :gteq
+    alias_method :>,  :gt
+    alias_method :=~, :matches
+  end
+  
+  ActiveRecord::Base.extend ClassMethods
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'sexy_scopes'

data/sexy_scopes.gemspec

@@ -0,0 +1,61 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sexy_scopes}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Samuel Lebeau"]
+  s.date = %q{2010-05-28}
+  s.description = %q{Small DSL to create ActiveRecord attribute predicates without writing SQL.}
+  s.email = %q{samuel.lebeau@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "lib/sexy_scopes.rb",
+     "rails/init.rb",
+     "sexy_scopes.gemspec",
+     "spec/sexy_scopes_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/samleb/sexy_scopes}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Small DSL to create ActiveRecord attribute predicates without writing SQL.}
+  s.test_files = [
+    "spec/sexy_scopes_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 3.0.0.beta"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 3.0.0.beta"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 3.0.0.beta"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

data/spec/sexy_scopes_spec.rb

@@ -0,0 +1,46 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe SexyScopes do
+  it "extends `ActiveRecord::Base` with `SexyScopes::ClassMethods`" do
+    ActiveRecord::Base.singleton_class.included_modules.should include(SexyScopes::ClassMethods)
+  end
+  
+  describe "the `attribute` class method" do
+    before do
+      @attribute = User.attribute(:username)
+    end
+    
+    it "returns a `SexyScopes::Attribute` instance for the given attribute" do
+      @attribute.should be_a(SexyScopes::Attribute)
+      @attribute.name.should == :username
+    end
+  end
+  
+  describe SexyScopes::Attribute do
+    before do
+      @attribute = User.attribute(:username)
+      @arel_attribute = User.arel_table[:username]
+    end
+    
+    AREL_ALIASES = {
+      :<  => :lt,
+      :<= => :lteq,
+      :== => :eq,
+      :>= => :gteq,
+      :>  => :gt,
+      :=~ => :matches
+    }
+    
+    AREL_ALIASES.each do |method, arel_method|
+      it "aliases `Arel::Attribute##{arel_method}` with operator `#{method}`" do
+        @attribute.send(method, :any_value).should == @arel_attribute.send(arel_method, :any_value)
+      end
+    end
+    
+    (AREL_ALIASES.values + ['in']).each do |arel_method|
+      it "behaves like an `Arel::Attribute` when sent `#{arel_method}`" do
+        @attribute.send(arel_method, :any_value).should == @arel_attribute.send(arel_method, :any_value)
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'active_record'
+require 'sexy_scopes'
+require 'spec'
+require 'spec/autorun'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+ActiveRecord::Schema.verbose = false
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :users do |t|
+    t.string :username
+  end
+end
+
+class User < ActiveRecord::Base
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification 
+name: sexy_scopes
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Samuel Lebeau
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-28 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 31098225
+        segments: 
+        - 3
+        - 0
+        - 0
+        - beta
+        version: 3.0.0.beta
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Small DSL to create ActiveRecord attribute predicates without writing SQL.
+email: samuel.lebeau@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/sexy_scopes.rb
+- rails/init.rb
+- sexy_scopes.gemspec
+- spec/sexy_scopes_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/samleb/sexy_scopes
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Small DSL to create ActiveRecord attribute predicates without writing SQL.
+test_files: 
+- spec/sexy_scopes_spec.rb
+- spec/spec_helper.rb