newellista-searchlogic 2.0.2 → 2.0.3

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 2
 :minor: 0
-:patch: 2
+:patch: 3

data/lib/searchlogic/named_scopes/alias_scope.rb

@@ -0,0 +1,63 @@
+module Searchlogic
+  module NamedScopes
+    # Adds the ability to create alias scopes that allow you to alias a named
+    # scope or create a named scope procedure, while at the same time letting
+    # Searchlogic know that this is a safe method.
+    module AliasScope
+      # The searchlogic Search class takes a hash and chains the values together as named scopes.
+      # For security reasons the only hash keys that are allowed must be mapped to named scopes.
+      # You can not pass the name of a class method and expect that to be called. In some instances
+      # you might create a class method that essentially aliases a named scope or represents a
+      # named scope procedure. Ex:
+      #
+      #   User.named_scope :teenager, :conditions => ["age >= ? AND age <= ?", 13, 19]
+      #
+      # This is obviously a very basic example, but there is logic that is duplicated here. For
+      # more complicated named scopes this might make more sense, but to make my point you could
+      # do something like this instead
+      #
+      #   class User
+      #     def teenager
+      #       age_gte(13).age_lte(19)
+      #     end
+      #   end
+      #
+      # As I stated above, you could not use this method with the Searchlogic::Search class because
+      # there is no way to tell that this is actually a named scope. Instead, Searchlogic lets you
+      # do something like this:
+      #
+      #   User.alias_scope :teenager, lambda { age_gte(13).age_lte(19) }
+      #
+      # It fits in better, at the same time Searchlogic will know this is an acceptable named scope.
+      def alias_scope(name, options = nil)
+        alias_scopes[name.to_sym] = options
+        (class << self; self end).instance_eval do
+          define_method name do |*args|
+            case options
+            when Symbol
+              send(options)
+            else
+              options.call(*args)
+            end
+          end
+        end
+      end
+      
+      def alias_scopes # :nodoc:
+        @alias_scopes ||= {}
+      end
+      
+      def alias_scope?(name) # :nodoc:
+        alias_scopes.key?(name.to_sym)
+      end
+      
+      def condition?(name) # :nodoc:
+        super || alias_scope?(name)
+      end
+      
+      def named_scope_options(name) # :nodoc:
+        super || alias_scopes[name.to_sym]
+      end
+    end
+  end
+end

data/searchlogic.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{searchlogic}
-  s.version = "2.0.2"
+  s.version = "2.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ben Johnson of Binary Logic"]
-  s.date = %q{2009-06-20}
+  s.date = %q{2009-06-23}
   s.email = %q{bjohnson@binarylogic.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
      "lib/searchlogic.rb",
      "lib/searchlogic/core_ext/object.rb",
      "lib/searchlogic/core_ext/proc.rb",
+     "lib/searchlogic/named_scopes/alias_scope.rb",
      "lib/searchlogic/named_scopes/associations.rb",
      "lib/searchlogic/named_scopes/conditions.rb",
      "lib/searchlogic/named_scopes/ordering.rb",
@@ -32,20 +33,23 @@ Gem::Specification.new do |s|
      "searchlogic.gemspec",
      "spec/core_ext/object_spec.rb",
      "spec/core_ext/proc_spec.rb",
+     "spec/named_scopes/alias_scope_spec.rb",
      "spec/named_scopes/associations_spec.rb",
      "spec/named_scopes/conditions_spec.rb",
      "spec/named_scopes/ordering_spec.rb",
      "spec/search_spec.rb",
      "spec/spec_helper.rb"
   ]
-  s.homepage = %q{http://github.com/newellista/searchlogic}
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/binarylogic/searchlogic}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.4}
+  s.rubygems_version = %q{1.3.1}
   s.summary = %q{Searchlogic provides common named scopes and object based searching for ActiveRecord.}
   s.test_files = [
     "spec/core_ext/object_spec.rb",
      "spec/core_ext/proc_spec.rb",
+     "spec/named_scopes/alias_scope_spec.rb",
      "spec/named_scopes/associations_spec.rb",
      "spec/named_scopes/conditions_spec.rb",
      "spec/named_scopes/ordering_spec.rb",
@@ -55,7 +59,7 @@ Gem::Specification.new do |s|
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+    s.specification_version = 2
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
     else

data/spec/named_scopes/alias_scope_spec.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe "AliasScope" do
+  it "should allow alias scopes" do
+    User.create(:username => "bjohnson")
+    User.create(:username => "thunt")
+    User.username_has("bjohnson").all.should == User.find_all_by_username("bjohnson")
+  end
+  
+  it "should allow alias scopes from the search object" do
+    search = User.search
+    search.username_has = "bjohnson"
+    search.username_has.should == "bjohnson"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: newellista-searchlogic
 version: !ruby/object:Gem::Version 
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors: 
 - Ben Johnson of Binary Logic
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-20 00:00:00 -07:00
+date: 2009-06-23 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -33,6 +33,7 @@ files:
 - lib/searchlogic.rb
 - lib/searchlogic/core_ext/object.rb
 - lib/searchlogic/core_ext/proc.rb
+- lib/searchlogic/named_scopes/alias_scope.rb
 - lib/searchlogic/named_scopes/associations.rb
 - lib/searchlogic/named_scopes/conditions.rb
 - lib/searchlogic/named_scopes/ordering.rb
@@ -42,13 +43,14 @@ files:
 - searchlogic.gemspec
 - spec/core_ext/object_spec.rb
 - spec/core_ext/proc_spec.rb
+- spec/named_scopes/alias_scope_spec.rb
 - spec/named_scopes/associations_spec.rb
 - spec/named_scopes/conditions_spec.rb
 - spec/named_scopes/ordering_spec.rb
 - spec/search_spec.rb
 - spec/spec_helper.rb
-has_rdoc: false
-homepage: http://github.com/newellista/searchlogic
+has_rdoc: true
+homepage: http://github.com/binarylogic/searchlogic
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -71,11 +73,12 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.2.0
 signing_key: 
-specification_version: 3
+specification_version: 2
 summary: Searchlogic provides common named scopes and object based searching for ActiveRecord.
 test_files: 
 - spec/core_ext/object_spec.rb
 - spec/core_ext/proc_spec.rb
+- spec/named_scopes/alias_scope_spec.rb
 - spec/named_scopes/associations_spec.rb
 - spec/named_scopes/conditions_spec.rb
 - spec/named_scopes/ordering_spec.rb