yfactorial-utility_scopes 0.1.0

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2008 Ryan Daigle
+ 
+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 @@
+http://ryandaigle.com/articles/2008/8/20/named-scope-it-s-not-just-for-conditions-ya-know

data/Rakefile

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'rake'
+require 'rake/rdoctask'
+
+# TODO add task to execute specs
+ 
+desc 'Generate RDoc documentation.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_files.include('README.rdoc', 'LICENSE', 'Rakefile').
+    include('lib/**/*.rb')
+  
+  rdoc.main = "README.rdoc"
+  rdoc.title = "utility_scopes documentation"
+  
+  rdoc.rdoc_dir = 'doc' # rdoc output folder
+  rdoc.options << '--inline-source' << '--charset=UTF-8'
+  rdoc.options << '--webcvs=http://github.com/yfactorial/utility_scopes/tree/master/'
+end

data/init.rb

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

data/lib/utility_scopes.rb

@@ -0,0 +1,15 @@
+require 'utility_scopes/limited'
+require 'utility_scopes/ordered'
+require 'utility_scopes/eager'
+require 'utility_scopes/except'
+  
+if defined?(ActiveRecord)
+
+  ActiveRecord::Base.class_eval do
+    include UtilityScopes::Limited
+    include UtilityScopes::Ordered
+    include UtilityScopes::Eager  
+    include UtilityScopes::Except  
+  end
+  
+end

data/lib/utility_scopes/eager.rb

@@ -0,0 +1,10 @@
+module UtilityScopes
+  module Eager
+    
+    def self.included(within)
+      within.class_eval do
+        named_scope :with, lambda { |*associations| { :include => associations } }
+      end
+    end
+  end
+end

data/lib/utility_scopes/except.rb

@@ -0,0 +1,21 @@
+module UtilityScopes
+  module Except
+    
+    def self.included(within)
+      
+      within.class_eval do
+      
+        # Allow easy rejection of items. 
+        # Can take an a single id or ActiveRecord object, or an array of them
+        # Example: 
+        #   before   Article.all.reject{|a| a == @bad_article }
+        #   after    Article.except(@bad_article)
+        named_scope :except, lambda { |item_or_list|
+          # nil or empty array causes issues here with mysql
+          item_or_list.blank? ? {} : {:conditions => ["#{quoted_table_name}.#{primary_key} NOT IN (?)", item_or_list]}
+        }
+        
+      end
+    end
+  end
+end

data/lib/utility_scopes/limited.rb

@@ -0,0 +1,26 @@
+module UtilityScopes
+  module Limited
+    
+    def self.included(within)
+      
+      within.class_eval do
+      
+        # Provide default limit scope (can be overridden
+        # if default_limit is called)
+        named_scope :limited, lambda { |*num|
+          { :limit => num.flatten.first || (defined?(per_page) ? per_page : 10) }
+        }
+        
+        extend ClassMethods
+      end
+    end
+    
+    module ClassMethods
+      
+      # Set the default limit to use for the limit scope
+      def default_limit(default)
+        named_scope :limited, lambda { |*num| { :limit => num.flatten.first || default } }
+      end      
+    end
+  end
+end

data/lib/utility_scopes/ordered.rb

@@ -0,0 +1,52 @@
+module UtilityScopes
+  module Ordered
+    
+    def self.included(within)
+      within.class_eval do
+        
+        # Provide an ordered scope
+        named_scope :ordered, lambda { |*order|
+          { :order => order.flatten.first || self.default_ordering }
+        }
+        
+        # Set the default order
+        class << self
+          define_method(:default_ordering) { 'created_at DESC' }
+        end
+        
+        extend ClassMethods
+      end
+    end
+    
+    module ClassMethods
+      
+      # Decorate this class with the ability to order itself in queries
+      # either from a given parameter or from its default ordering:
+      #
+      #   class Article < ActiveRecord::Base
+      #     ordered_by "published_at DESC"
+      #   end
+      #
+      #   Article.ordered #=> all items ordered by "published_at DESC"
+      #   Article.ordered('popularity ASC') #=> all items ordered by "popularity ASC"
+      #   Article.default_ordering #=> "published_at DESC"
+      #
+      def ordered_by(clause)
+        
+        # Override named scope on AR::Base so we can access default_ordering
+        # on subclass
+        named_scope :ordered, lambda { |*order|
+          { :order => order.flatten.first || self.default_ordering }
+        }
+        
+        metaclass.instance_eval do
+          define_method(:default_ordering) { clause }
+        end
+      end
+      
+      private
+      
+      def metaclass; class << self; self end; end
+    end
+  end
+end

data/spec/abstract_spec.rb

@@ -0,0 +1,10 @@
+require File.join(File.dirname(__FILE__), *%w[spec_helper])
+require 'activerecord'
+
+$:.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'utility_scopes'
+
+# Load a test class
+def uses_fixture(fixture_name)
+  require File.join(File.dirname(__FILE__), 'fixtures', fixture_name.to_s)
+end

data/spec/eager_spec.rb

@@ -0,0 +1,20 @@
+require File.join(File.dirname(__FILE__), *%w[abstract_spec])
+
+describe "Eager scope" do
+
+  before do
+    uses_fixture(:article)
+  end
+  
+  it "should provide eager loading of a single association" do
+    Article.with(:comments).proxy_options.should == {:include => [:comments] }
+  end
+
+  it "should provide eager loading of a multiple associations" do
+    Article.with(:comments, :contributors).proxy_options.should == {:include => [:comments, :contributors] }
+  end
+  
+  it "should provider eager loading of nested associations" do
+    Article.with(:comments => :author).proxy_options.should == {:include => [ {:comments => :author} ] }
+  end
+end

data/spec/except_spec.rb

@@ -0,0 +1,25 @@
+require File.join(File.dirname(__FILE__), *%w[abstract_spec])
+
+describe "except scope" do
+
+  before do
+    uses_fixture(:article)
+    # Stub these so it doesn't try to hit the (non-existant) database
+    ActiveRecord::Base.stub!(:quoted_table_name).and_return('articles')
+    ActiveRecord::Base.stub!(:primary_key).and_return('id')
+  end
+  
+  it "should not change the scope with nil" do
+    Article.except(nil).proxy_options.should == {}
+  end
+  
+  it "should return all items except the one specified" do
+    item = 123
+    Article.except(item).proxy_options.should == {:conditions => ['articles.id NOT IN (?)', item]}
+  end
+  
+  it "should return all items except ones in the list specified" do
+    list = [123, 456, 7]
+    Article.except(list).proxy_options.should == {:conditions => ['articles.id NOT IN (?)', list]}
+  end
+end

data/spec/fixtures/article.rb

@@ -0,0 +1,2 @@
+class Article < ActiveRecord::Base
+end

data/spec/limit_spec.rb

@@ -0,0 +1,36 @@
+require File.join(File.dirname(__FILE__), *%w[abstract_spec])
+
+describe "limited scope" do
+
+  before do
+    uses_fixture(:article)
+  end
+
+  it "should default to a limited of 10" do
+    Article.limited.proxy_options.should == {:limit => 10}
+  end
+  
+  it "should allow the limited to be specified at runtime" do
+    Article.limited(20).proxy_options.should == {:limit => 20}
+  end
+  
+  it "should find the per_page value from will_paginate" do
+    ActiveRecord::Base.instance_eval { def per_page; 50; end }
+    Article.limited.proxy_options.should == {:limit => 50}
+  end
+  
+  it "should use the runtime limited value over the per_page value from will_paginate" do
+    ActiveRecord::Base.instance_eval { def per_page; 50; end }
+    Article.limited(5).proxy_options.should == {:limit => 5}
+  end
+  
+  it "should allow override the default limited value with 'default_limited'" do
+    Article.default_limit 13
+    Article.limited.proxy_options.should == {:limit => 13}
+  end
+  
+  it "should use the runtime value over the default limited value set with 'default_limited'" do
+    Article.default_limit 13
+    Article.limited(25).proxy_options.should == {:limit => 25}
+  end
+end

data/spec/ordered_spec.rb

@@ -0,0 +1,28 @@
+require File.join(File.dirname(__FILE__), *%w[abstract_spec])
+
+describe "Ordered scope" do
+
+  before do
+    uses_fixture(:article)
+  end
+
+  it "should default to created_at DESC" do
+    Article.ordered.proxy_options.should == {:order => 'created_at DESC'}
+    Article.default_ordering.should == 'created_at DESC'
+  end
+  
+  it "should allow the order to be specified at runtime" do
+    Article.ordered('created_at ASC').proxy_options.should == {:order => 'created_at ASC'}
+  end
+  
+  it "should allow the default to be overidden by using ordered_by" do
+    Article.ordered_by 'published_at DESC'
+    Article.default_ordering.should == 'published_at DESC'
+    Article.ordered.proxy_options.should == {:order => 'published_at DESC'}
+  end
+  
+  it "should use the runtime sort value over the ordered_by value" do
+    Article.ordered_by 'published_at DESC'
+    Article.ordered('popularity ASC').proxy_options.should == {:order => 'popularity ASC'}
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'spec'
+ 
+Spec::Runner.configure do |config|
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: yfactorial-utility_scopes
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ryan Daigle
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-20 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+    version: 
+description: A collection of utilitarian named scopes providing common functionality for ActiveRecord models.
+email: ryan@yfactorial.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- Rakefile
+- LICENSE
+files: 
+- README.rdoc
+- Rakefile
+- LICENSE
+- init.rb
+- lib
+- lib/utility_scopes
+- lib/utility_scopes.rb
+- lib/utility_scopes/eager.rb
+- lib/utility_scopes/except.rb
+- lib/utility_scopes/limited.rb
+- lib/utility_scopes/ordered.rb
+- spec
+- spec/abstract_spec.rb
+- spec/eager_spec.rb
+- spec/except_spec.rb
+- spec/limit_spec.rb
+- spec/ordered_spec.rb
+- spec/spec_helper.rb
+- spec/fixtures
+- spec/fixtures/article.rb
+has_rdoc: true
+homepage: http://github.com/yfactorial/utility_scopes
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A collection of utilitarian named scopes providing common functionality for ActiveRecord models
+test_files: []
+