convenient_scopes 0.4.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ivan Schneider
+
+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.rdoc

@@ -0,0 +1,19 @@
+= convenient_scopes
+
+Dynamic scopes by convention for ActiveRecord 3.
+
+Pretty much the same API as searchlogic except it's compatible with ActiveRecord 3, unlike searchlogic as of now. The whole feature set of searchlogic isn't implemented yet in convenient_scopes though.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Ivan Schneider. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "convenient_scopes"
+    gem.summary = %Q{Dynamic scopes by convention for ActiveRecord 3}
+    gem.description = %Q{Dynamic scopes by convention for ActiveRecord 3}
+    gem.email = "isc@massivebraingames.com"
+    gem.homepage = "http://github.com/isc/convenient_scopes"
+    gem.authors = ["Ivan Schneider"]
+    gem.add_runtime_dependency "activerecord", ">= 3.0.0.beta4"
+    gem.add_development_dependency "shoulda", ">= 0"
+    gem.add_development_dependency "sqlite3-ruby"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "convenient_scopes #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.4.0

data/convenient_scopes.gemspec

@@ -0,0 +1,65 @@
+# 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{convenient_scopes}
+  s.version = "0.4.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ivan Schneider"]
+  s.date = %q{2010-07-25}
+  s.description = %q{Dynamic scopes by convention for ActiveRecord 3}
+  s.email = %q{isc@massivebraingames.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "convenient_scopes.gemspec",
+     "lib/convenient_scopes.rb",
+     "test/helper.rb",
+     "test/test_associations.rb",
+     "test/test_conditions.rb",
+     "test/test_ordering.rb"
+  ]
+  s.homepage = %q{http://github.com/isc/convenient_scopes}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Dynamic scopes by convention for ActiveRecord 3}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_all_and_any_conditions.rb",
+     "test/test_associations.rb",
+     "test/test_conditions.rb",
+     "test/test_ordering.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 3.0.0.beta4"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 3.0.0.beta4"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 3.0.0.beta4"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+  end
+end
+

data/lib/convenient_scopes.rb

@@ -0,0 +1,182 @@
+module ConvenientScopes
+
+  def method_missing(name, *args, &block)
+    if scope_data = (define_scope name)
+      scope name, convert_to_scope_arg(scope_data)
+      return send name, *args, &block
+    else
+      super
+    end
+  end
+
+  module Conditions
+
+    def equals_scope name
+      return unless (column = match_suffix_and_column_name name, %w(equals eq is))
+      lambda {|value| where(column => value)}
+    end
+
+    def does_not_equal_scope name
+      match_and_define_scope name, %w(does_not_equal doesnt_equal ne is_not), "%s != ?"
+    end
+
+    def less_than_scope name
+      match_and_define_scope name, %w(less_than lt before), "%s < ?"
+    end
+
+    def less_than_or_equal_scope name
+      match_and_define_scope name, %w(less_than_or_equal lte), "%s <= ?"
+    end
+
+    def greater_than_scope name
+      match_and_define_scope name, %w(greater_than gt after), "%s > ?"
+    end
+
+    def greater_than_or_equal_scope name
+      match_and_define_scope name, %w(greater_than_or_equal gte), "%s >= ?"
+    end
+
+    def like_scope name
+      match_and_define_scope name, %w(like matches contains includes), "%s like ?", "%%%s%%"
+    end
+
+    def not_like_scope name
+      suffixes = %w(not_like does_not_match doesnt_match does_not_contain doesnt_contain does_not_include doesnt_include)
+      match_and_define_scope name, suffixes, "%s not like ?", "%%%s%%"
+    end
+
+    def begins_with_scope name
+      match_and_define_scope name, %w(begins_with bw starts_with sw), "%s like ?", "%s%%"
+    end
+
+    def not_begin_with_scope name
+      suffixes = %w(not_begin_with does_not_begin_with doesnt_begin_with does_not_start_with doesnt_start_with)
+      match_and_define_scope name, suffixes, "%s not like ?", "%s%%"
+    end
+
+    def ends_with_scope name
+      match_and_define_scope name, %w(ends_with ew), "%s like ?", "%%%s"
+    end
+
+    def not_end_with_scope name
+      match_and_define_scope name, %w(not_end_with does_not_end_with doesnt_end_with), "%s not like ?", "%%%s"
+    end
+
+    def null_scope name
+      match_and_define_scope_without_value name, %w(null nil missing), "%s is null"
+    end
+
+    def not_null_scope name
+      match_and_define_scope_without_value name, %w(not_null not_nil not_missing), "%s is not null"
+    end
+
+    def boolean_column_scope name
+      return unless column_names.include? name.to_s
+      return unless boolean_column? name
+      where(name => true)
+    end
+
+    def negative_boolean_column_scope name
+      str_name = name.to_s
+      return unless str_name.gsub!(/^not_/, '')
+      return unless column_names.include? str_name
+      return unless boolean_column? str_name
+      where(str_name => false)
+    end
+
+  end
+
+  include Conditions
+
+  module Ordering
+    
+    def ascend_by_scope name
+      ordering_scope name, /^ascend_by_/, 'asc'
+    end
+    
+    def descend_by_scope name
+      ordering_scope name, /^descend_by_/, 'desc'
+    end
+    
+  end
+  
+  def ordering_scope name, prefix, direction
+    str_name = name.to_s
+    return unless str_name.gsub!(prefix, '')
+    determine_order_scope_data str_name, direction
+  end
+  
+  def determine_order_scope_data name, direction
+    if column_names.include? name.to_s
+      order("#{quoted_table_name}.#{name} #{direction}")
+    elsif assoc = (possible_association_for_scope name)
+      next_scope = name.to_s.split("#{assoc.name}_").last.to_sym # age
+      scope_arg = assoc.klass.determine_order_scope_data next_scope, direction
+      scope_arg.is_a?(Array) ? [assoc.name] + scope_arg : [assoc.name, scope_arg] if scope_arg
+    end    
+  end
+  
+  include Ordering
+
+  def association_scope name
+    return unless assoc = (possible_association_for_scope name)
+    next_scope = name.to_s.split("#{assoc.name}_").last.to_sym
+    scope_arg = (assoc.klass.define_scope next_scope) || assoc.klass.scopes[next_scope]
+    scope_arg.is_a?(Array) ? [assoc.name] + scope_arg : [assoc.name, scope_arg] if scope_arg
+  end
+
+  def possible_association_for_scope name
+    reflect_on_all_associations.detect {|assoc| name.to_s.starts_with? assoc.name.to_s}
+  end
+  
+  def define_scope name
+    [Conditions, Ordering].map(&:instance_methods).flatten.each do |scope_type|
+      if scope_arg = (send scope_type.to_sym, name)
+        return scope_arg unless scope_arg.nil?
+      end
+    end
+    association_scope name
+  end
+
+  def match_and_define_scope name, suffixes, sql_format, value_format = nil
+    return unless (column = match_suffix_and_column_name name, suffixes)
+    sql = formatted_sql column, sql_format
+    lambda {|value| where([sql, value_format ? (value_format % value) : value])}
+  end
+
+  def match_and_define_scope_without_value name, suffixes, sql_format
+    return unless (column = match_suffix_and_column_name name, suffixes)
+    where(formatted_sql column, sql_format)
+  end
+
+  def formatted_sql column, sql_format
+    sql = sql_format % "#{quoted_table_name}.#{column}"
+  end
+
+  def match_suffix_and_column_name name, suffixes
+    str_name = name.to_s
+    regexp_str = suffixes.map {|suffix| "(_#{suffix})"}.join('|') + '$'
+    return unless str_name.gsub!(Regexp.new(regexp_str), '')
+    return unless column_names.include? str_name
+    str_name
+  end
+
+  def boolean_column? name
+    columns.detect {|c|c.name == name.to_s}.type == :boolean
+  end
+
+  def convert_to_scope_arg scope_data
+    return scope_data unless scope_data.is_a? Array
+    relation_or_proc = scope_data.pop
+    joins_arg = (scope_data.size == 1) ? scope_data.first : {scope_data.first => scope_data.last}
+    if relation_or_proc.is_a? ActiveRecord::Relation
+      relation_or_proc.joins joins_arg
+    else
+      lambda {|*value| relation_or_proc.call(*value).joins joins_arg }
+    end
+  end
+  
+end
+
+ActiveRecord::Base.extend ConvenientScopes
+ActiveRecord::Relation.send :include, ConvenientScopes

data/test/helper.rb

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'active_record'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'convenient_scopes'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+class User < ActiveRecord::Base
+  has_many :comments
+  belongs_to :group
+end
+class Group < ActiveRecord::Base
+  has_many :users
+end
+class Comment < ActiveRecord::Base
+  belongs_to :user
+end
+
+class Test::Unit::TestCase
+  def teardown
+    User.delete_all
+  end
+end
+
+ActiveRecord::Base.configurations = true
+ActiveRecord::Schema.verbose = false
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :users do |t|
+    t.string :pseudo, :first_name, :last_name
+    t.integer :group_id, :age
+    t.datetime :activated_at
+    t.boolean :admin
+    t.timestamps
+  end
+  create_table :groups do |t|
+    t.string :name
+    t.timestamps
+  end
+  create_table :comments do |t|
+    t.string :body
+    t.integer :user_id
+    t.boolean :published
+    t.timestamps
+  end
+end

data/test/test_all_and_any_conditions.rb

@@ -0,0 +1,19 @@
+require 'helper'
+
+class TestAllAndAnyConditions < Test::Unit::TestCase
+  
+  context "convenient_scopes" do
+    
+    setup do
+      @bob = User.create :pseudo => 'Bob Larchi'
+      @slim = User.create :pseudo => 'Slim Babine'
+    end
+    
+    should "handle conditions scopes suffixed by any" do
+      flunk "not implemented yet"
+      assert_equal [@bob, @slim], User.pseudo_like_any('Bob', 'Slim')
+    end
+    
+  end
+  
+end

data/test/test_associations.rb

@@ -0,0 +1,53 @@
+require 'helper'
+
+class TestAssociations < Test::Unit::TestCase
+  
+  context "convenient_scopes" do
+    setup do
+      @manager_group = Group.create :name => 'Managers'
+      @bob = User.create :comments => [(Comment.new :body => 'Yo', :published => false, :created_at => 1.week.ago)], :group => @manager_group
+      @dev_group = Group.create :name => 'Developers'
+      @slim = User.create :comments => [(Comment.new :body => 'Bye', :published => false, :created_at => 10.minutes.ago),
+        (Comment.new :body => 'Hello', :published => true, :created_at => 2.days.ago)],
+        :group => @dev_group
+    end
+
+    should "not catch everything" do
+      assert_raise NoMethodError do
+        User.comment_body_is('Yo')
+      end
+      assert_raise NoMethodError do
+        User.comments_synopsis_eq('Yo')
+      end
+    end
+    
+    should "handle has_many association + attribute conditions" do
+      assert_equal [@bob], User.comments_body_equals('Yo')
+      assert_equal [@slim], User.comments_body_starts_with('He')
+      assert_equal [@bob], User.comments_id_is(@bob.comments.first.id)
+      assert_equal [@slim], User.comments_id_is(@slim.comments.last.id)
+      assert_equal [@bob], User.comments_created_at_before(3.days.ago)
+    end
+    
+    should "handle has many association + boolean column" do
+      assert_equal [@slim], User.comments_published
+    end
+    
+    should "handle belongs_to association" do
+      assert_equal [@bob], User.group_name_is('Managers')
+      assert_equal [@slim], User.group_name_matches('velo')
+    end
+    
+    should "handle two levels of association" do
+      assert_equal [@dev_group], Group.users_comments_published
+    end
+    
+    should "be able to leverage a named scope on an association" do
+      Comment.scope :recent, Comment.created_at_after(1.hour.ago).created_at_not_nil
+      assert_equal [@slim], User.comments_recent
+      assert_equal [@dev_group], Group.users_comments_recent
+    end
+    
+  end
+  
+end

data/test/test_conditions.rb

@@ -0,0 +1,70 @@
+require 'helper'
+
+class TestConditions < Test::Unit::TestCase
+  context "Given two users" do
+    setup do
+      @bob = User.create :pseudo => 'Bob', :first_name => 'Robert', :age => 37,
+        :activated_at => 37.hours.ago, :admin => true
+      @slim = User.create :pseudo => 'Slim', :first_name => 'Angelo', :age => 12,
+        :activated_at => nil, :admin => false
+    end
+    
+    should "equals scope" do
+      assert_raise NoMethodError do
+        User.blabla_eq('Bob')
+      end
+      assert_equal [@bob], User.pseudo_eq('Bob')
+      assert_equal [@slim], User.pseudo_is('Slim')
+      assert_equal [@bob], User.first_name_is('Robert')
+    end
+    
+    should "equals scope on a relation" do
+      assert_equal [@bob], User.order('age').pseudo_eq('Bob')
+    end
+    
+    should "not equals scope" do
+      assert_equal [@bob], User.pseudo_is_not('Slim')
+      assert_equal [@bob], User.first_name_does_not_equal('Angelo')
+    end
+    
+    should "less than (or equal)? scope" do
+      assert_equal [@slim], User.age_lt(37)
+      assert_equal [@slim], User.age_less_than_or_equal(12)
+    end
+    
+    should "greater than (or equal)? scope" do
+      assert_equal [@bob], User.age_greater_than(12)
+      assert_equal [@bob], User.age_gte(37)
+      assert_equal [@bob], User.activated_at_after(40.hours.ago)
+    end
+    
+    should "like scope" do
+      assert_equal [@slim], User.first_name_matches('nge')
+    end
+    
+    should "not like scope" do
+      assert_equal [@slim], User.pseudo_not_like('o')
+    end
+    
+    should "begins / ends with scope" do
+      assert_equal [@bob], User.first_name_starts_with('Rob')
+      assert_equal [@slim], User.first_name_ends_with('o')
+    end
+    
+    should "not begins / ends with scope" do
+      assert_equal [@slim], User.first_name_does_not_start_with('Rob')
+      assert_equal [@bob], User.first_name_doesnt_end_with('o')      
+    end
+    
+    should "(not)? null scope" do
+      assert_equal [@slim], User.activated_at_null
+      assert_equal [@bob], User.activated_at_not_nil
+    end
+    
+    should "boolean columns" do
+      assert_equal [@bob], User.admin
+      assert_equal [@slim], User.not_admin
+    end
+    
+  end
+end

data/test/test_ordering.rb

@@ -0,0 +1,27 @@
+require 'helper'
+
+class TestOrdering < Test::Unit::TestCase
+  
+  context "convenient_scopes" do
+    
+    setup do
+      @bob = User.create :age => 43
+      @slim = User.create :age => 27
+      @avon = User.create :age => 37
+      @managers = Group.create :users => [@bob, @avon]
+      @developers = Group.create :users => [@slim]
+    end
+    
+    should "allow ordering by attributes" do
+      assert_equal [@slim, @avon, @bob], User.ascend_by_age
+      assert_equal [@bob, @avon, @slim], User.descend_by_age
+    end
+    
+    should "allow ordering by attributes of an association" do
+      assert_equal [@developers, @managers], Group.ascend_by_users_age.uniq
+      assert_equal [@managers, @developers], Group.descend_by_users_age.uniq
+    end
+    
+  end
+  
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: convenient_scopes
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 0
+  version: 0.4.0
+platform: ruby
+authors: 
+- Ivan Schneider
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-25 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        - beta4
+        version: 3.0.0.beta4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Dynamic scopes by convention for ActiveRecord 3
+email: isc@massivebraingames.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- convenient_scopes.gemspec
+- lib/convenient_scopes.rb
+- test/helper.rb
+- test/test_associations.rb
+- test/test_conditions.rb
+- test/test_ordering.rb
+has_rdoc: true
+homepage: http://github.com/isc/convenient_scopes
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Dynamic scopes by convention for ActiveRecord 3
+test_files: 
+- test/helper.rb
+- test/test_all_and_any_conditions.rb
+- test/test_associations.rb
+- test/test_conditions.rb
+- test/test_ordering.rb