duck_chain 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/CHANGELOG.rdoc

@@ -0,0 +1,2 @@
+Version 1.0.0
+* First release

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in duck_chain.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2011 Tony Drake
+
+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,85 @@
+= duck_chain
+
+== Intro
+This gem's purpose is to generate basic chainable search methods on models in Rails 3 similar to searchlogic's dynamic named scopes.
+
+duck_chain's original purpose is to help with the transition from Rails 2 to 3. A lot of projects use searchlogic, and while metasearch
+is a fine replacement, it doesn't provide the dynamic named scopes (ie Post.title_equals("foobar").content_like("I like pie"). To help with the
+transition, duck_chain extends ActiveRecord and creates extra chainable model methods for attributes you specifiy which act similar to the basic
+searchlogic named scopes. The methods simply return Arel where cluases so you can chain them with other methods.
+
+Only the basic single table methods are supported (eq, not_equal, gte, like, etc.). Meaning you can't do Post.post_comments_title_eq("This blog sux"). 
+Legacy code like that should be converted into an Arel where method, metasearch search method, or whatever you decide to go with for Rails 3. Again,
+the gem was built to help with the transition and provide some of the basic search methods people using searchlogic are used to in Rails 3. Plus, I personally like typing out
+Post.created_at_gte(Time.now).content_like("I like shorts. They're comfortable and easy to wear.") more than Post.where(['created_at >= ?', Time.now]).where("content LIKE '%I like shorts. They're comfortable and easy to wear.%'").
+Just seems a little clearer this way. :)
+
+== Setup
+Include the gem in your GemFile like any other gem.
+
+== Usage
+Consider the following model...
+  class Post < ActiveRecord::Base
+    # Fields:
+    #   id:integer
+    #   title:string
+    #   content:text
+    #   url:string
+    #   comment_counter:integer
+    #   created_at:datetime
+    #   updated_at:datetime
+  end
+
+==== Use all search methods for selected attributes
+To have duck_chain bind to the title, content, and url attributes of the model...
+  class Post < ActiveRecord::Base
+    duck_chain :content, 'title', :url
+    # Note you can use symbols or strings in your list of attributes
+  end
+
+Calling duck_chain creates a bunch of chainable methods for the Post model for the content, title, and url attributes...
+
+Example new methods related to the title attribute:
+
+<i>The following <b>'eq'</b> methods can accept a string, array, or range</i>
+* title_eq
+* title_equals
+* title_is
+* title_in
+* title_neq
+* title_not_equal
+* title_is_not
+* title_does_not_equal
+* title_not_in
+<i>The following <b>'like'</b> methods should only be passed a string</i>
+* title_like
+* title_begins_with
+* title_ends_with
+* title_not_like
+* title_not_begin_with
+* title_not_end_with
+<i>The following <b>'range'</b> methods should only be passed a string</i>
+* title_gt
+* title_greater_than
+* title_gte
+* title_greater_than_or_equal_to
+* title_lt
+* title_less_than
+* title_lte
+* title_less_than_or_equal_to
+
+Then, you can just use the methods in your code like you did with searchlogic...
+Post.title_eq("Foobar").where(...).content_like("Blah")
+
+==== Use only certain search methods for selected attributes
+There might be some cases where you'd rather just only bind the 'eq' methods to an attribute rather than all of them...
+  class Post < ActiveRecord::Base
+    # Will only create the _eq, _is, _neq, _in, etc. methods
+    duck_chain_eq :content, 'title', :url
+  end
+
+You can also create only the 'like' and 'range' methods in a similar fasion...
+  class Post < ActiveRecord::Base
+    duck_chain_like :content
+    duck_chain_range :created_at
+  end

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+
+require 'rake/rdoctask'
+desc 'Generate RDoc documentation for the will_paginate plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_files.include('README.rdoc', 'LICENSE', 'CHANGELOG.rdoc').include('lib/**/*.rb').exclude('lib/duck_chain/version.rb')
+  
+  rdoc.main = "README.rdoc" # page to start on
+  rdoc.title = "duck_chain documentation"
+  
+  rdoc.rdoc_dir = 'doc' # rdoc output folder
+  rdoc.options << '--inline-source' << '--charset=UTF-8'
+end

data/duck_chain.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "duck_chain/version"
+
+Gem::Specification.new do |s|
+  s.name        = "duck_chain"
+  s.version     = DuckChain::VERSION
+  
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+
+  s.authors     = ["Tony Drake"]
+  s.email       = ["t27duck@gmail.com"]
+  # s.homepage    = ""
+  s.summary     = %q{Because I like chaining easy to read search methods with ActiveRecord thankyouverymuch}
+  s.description = %q{A simple Rails 3 Gem that extends ActiveRecord. Let's you specify model attributes to dynamically create search methods similar to searchlogic's dynamic named scopes. It can be used to help Rails 2 projects with searchlogic migrate to Rails 3 with metasearch a little easier.}
+
+  s.rubyforge_project = "duck_chain"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency(%q<activerecord>, [">= 3.0.0"])
+end

data/lib/duck_chain/active_record_extensions.rb

@@ -0,0 +1,32 @@
+module DuckChain
+
+  # Methods that extend ActiveRecord and allows duck_chain to work
+  module ActiveRecordExtensions   
+
+    # The generic call which will generate all methods for the model
+    def duck_chain(*model_attributes)
+      Toolset.create_eq_methods(model_attributes)
+      Toolset.create_like_methods(model_attributes)
+      Toolset.create_range_methods(model_attributes)
+    end
+
+    # Takes the list of model attributes calls the create method from DuckChain::Toolset
+    # to generate the 'eq' methods 
+    def duck_chain_eq(*model_attributes)
+      Toolset.create_eq_methods(model_attributes)
+    end
+
+    # Takes the list of model attributes calls the create method from DuckChain::Toolset
+    # to generate the 'list' methods 
+    def duck_chain_like(*model_attributes)
+      Toolset.create_like_methods(model_attributes)
+    end
+
+    # Takes the list of model attributes calls the create method from DuckChain::Toolset
+    # to generate the 'range' methods 
+    def duck_chain_range(*model_attributes)
+      Toolset.create_range_methods(model_attributes)
+    end
+    
+  end
+end

data/lib/duck_chain/toolset.rb

@@ -0,0 +1,99 @@
+module DuckChain
+  module Toolset
+    # Generic helper method that ensures whatever is passed into it is an array.
+    # If it's not, make it one.
+    def self.set_as_array(value)
+      value.is_a?(Array) ? value : [value]
+    end
+
+    # Creates 'eq' class methods for the model
+    # Ex:: Post.title_eq("Why do my feet smell?")
+    # Methods created include...
+    # * eq
+    # * equals
+    # * is
+    # * in
+    # * neq
+    # * not_equal
+    # * is_not
+    # * does_not_equal
+    # * not_in
+    # A string, array, or a range may be passed into these created methods.
+    # Passing an array or range will result in a IN clause in the resulting SQL.
+    def self.create_eq_methods(model_attributes)
+      Toolset.set_as_array(model_attributes).each do |m|
+        ['eq','equals','is','in'].each do |suffix|
+          self.class.send(:define_method, "#{m}_#{suffix}", Proc.new{ |search_term| 
+              if search_term.is_a?(Array) || search_term.is_a?(Range)
+                where(["#{m} IN (?)", search_term])               
+              else
+                where(["#{m} = ?", search_term])
+              end
+            } 
+          )
+        end
+
+        ['neq','not_equal','is_not','does_not_equal','not_in'].each do |suffix|
+          self.class.send(:define_method, "#{m}_#{suffix}", Proc.new{ |search_term| 
+              if search_term.is_a?(Array) || search_term.is_a?(Range)
+                where(["? NOT IN (?)", m, search_term])               
+              else
+                where(["? != ?", m, search_term])
+              end
+            } 
+          )
+        end
+      end
+    end
+    
+    # Creates 'like' class methods for the model
+    # Ex:: Post.title_like("Foo")
+    # Methods created include...
+    # * like
+    # * begins_with
+    # * ends_with
+    # * not_like
+    # * not_begin_with
+    # * not_end_with
+    def self.create_like_methods(model_attributes)
+      Toolset.set_as_array(model_attributes).each do |m|
+        self.class.send(:define_method, "#{m}_like", Proc.new{ |search_term| where(["? LIKE (?)", m, "%#{search_term}%"])} )
+        self.class.send(:define_method, "#{m}_begins_with", Proc.new{ |search_term| where(["? LIKE (?)", m, "#{search_term}%"])} )
+        self.class.send(:define_method, "#{m}_ends_with", Proc.new{ |search_term| where(["? LIKE (?)", m, "%#{search_term}"])} )
+
+        self.class.send(:define_method, "#{m}_not_like", Proc.new{ |search_term| where(["? NOT LIKE (?)", m, "%#{search_term}%"])} )
+        self.class.send(:define_method, "#{m}_not_begin_with", Proc.new{ |search_term| where(["? NOT LIKE (?)", m, "#{search_term}%"])} )
+        self.class.send(:define_method, "#{m}_not_end_with", Proc.new{ |search_term| where(["? NOT LIKE (?)", m, "%#{search_term}"])} )
+      end
+    end
+
+    # Creates 'range' class methods for the model
+    # Ex:: Post.comment_counter_gt(5)
+    # Methods created include...
+    # * gt
+    # * greater_than
+    # * gte
+    # * greater_than_or_equal_to
+    # * lt
+    # * less_then
+    # * lte
+    # * less_than_or_equal_to
+    def self.create_range_methods(model_attributes)
+      Toolset.set_as_array(model_attributes).each do |m|
+        ['gt','greater_than'].each do |suffix|
+          self.class.send(:define_method, "#{m}_#{suffix}", Proc.new{ |search_term| where(['? > ?', m, search_term])} )
+        end
+        ['gte','greater_than_or_equal_to'].each do |suffix|
+          self.class.send(:define_method, "#{m}_#{suffix}", Proc.new{ |search_term| where(['? >= ?', m, search_term])} )
+        end
+        ['lt','less_than'].each do |suffix|
+          self.class.send(:define_method, "#{m}_#{suffix}", Proc.new{ |search_term| where(['? < ?', m, search_term])} )
+        end
+        ['lte','less_than_or_equal_to'].each do |suffix|
+          self.class.send(:define_method, "#{m}_#{suffix}", Proc.new{ |search_term| where(['? <= ?', m, search_term])} )
+        end
+      end
+    end
+
+  end
+end

data/lib/duck_chain/version.rb

@@ -0,0 +1,3 @@
+module DuckChain
+  VERSION = "1.0.0"
+end

data/lib/duck_chain.rb

@@ -0,0 +1,6 @@
+require "duck_chain/version"
+require "duck_chain/toolset"
+require "duck_chain/active_record_extensions"
+
+ActiveRecord::Base.extend DuckChain::ActiveRecordExtensions
+

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: duck_chain
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Tony Drake
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-14 00:00:00 -04: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: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+description: A simple Rails 3 Gem that extends ActiveRecord. Let's you specify model attributes to dynamically create search methods similar to searchlogic's dynamic named scopes. It can be used to help Rails 2 projects with searchlogic migrate to Rails 3 with metasearch a little easier.
+email: 
+- t27duck@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- CHANGELOG.rdoc
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- duck_chain.gemspec
+- lib/duck_chain.rb
+- lib/duck_chain/active_record_extensions.rb
+- lib/duck_chain/toolset.rb
+- lib/duck_chain/version.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: 25
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: duck_chain
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Because I like chaining easy to read search methods with ActiveRecord thankyouverymuch
+test_files: []
+