mintdigital-minty_scopes 0.9.0

data/README.mkdn

@@ -0,0 +1,69 @@
+What
+====
+
+A collection of handy `named_scope`s that you should be able to use in just about any model.
+
+Why
+===
+
+Named scopes turn ugly finders into pretty ones.
+
+Howto
+=====
+
+Specify the gem dependency in your `environment.rb`:
+
+    config.gem 'mintdigital-minty_scopes',
+                :lib => 'minty_scopes',
+                :source => "http://gems.github.com"
+
+Then install and unpack the gem:
+
+    rake gems:install
+    rake gems:unpack
+
+In any model, you can get the scopes by extending the module:
+
+    class Post < ActiveRecord::Base
+      extend MintyScopes
+    end
+
+Scopes
+======
+
+Scopes are grouped into modules by functionality. If you only want some scopes, feel free to extend only the modules you want: `extend MintyScopes::Timestamps`
+
+### Associations ###
+
+    with(:comments)       #=> :joins => :comments, :group => 'posts.id' (only posts with comments)
+    without(:comments)    #=> :joins => 'LEFT JOIN comments ON posts.id = comments.post_id', 
+                          #   :conditions => {'comments.id' => nil}
+    including(:comments)  #=> :include => [:comments]
+
+### Except ###
+
+    except(post)              #=> [ 'posts.id NOT IN (?)', post ]
+    except(post, post)        #=> [ 'posts.id NOT IN (?)', [post, post] ]
+    except(post_collection)   #=> [ 'posts.id NOT IN (?)', post_collection ]
+
+### Order ###
+
+    newest      #=> { :order => 'created_at DESC', :limit => per_page || limit }
+    newest(20)  #=> { :order => 'created_at DESC', :limit => 20 }
+    oldest      #=> { :order => 'created_at ASC',  :limit => per_page || limit }
+    oldest(20)  #=> { :order => 'created_at ASC',  :limit => 20 }
+
+### Timestamps ###
+
+    created_on(date)  #=> :created_at => (date.beginning_of_day..date.end_of_day)
+    modified_on(date) #=> :modified_at => (date.beginning_of_day..date.end_of_day)
+
+Thanks
+======
+
+Big thanks to Ryan Daigle for his [utility_scopes](http://github.com/yfactorial/utility_scope)  plugin, the inspiration for this project.
+
+License
+=======
+
+© 2008 Dean Strelau, Mint Digital. All Rights Reserved.

data/Rakefile

@@ -0,0 +1,39 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/gempackagetask'
+require 'lib/minty_scopes/version'
+
+desc 'Default: Run Tests'
+task :default => ['test']
+
+spec = Gem::Specification.new do |s|
+  s.name             = "minty_scopes"
+  s.version          = MintyScopes::VERSION
+  s.summary          = "Useful, reusable named_scopes for ActiveRecord."
+  s.homepage         = "https://github.com/mintdigital/minty_scopes"
+
+  s.files            = FileList["[A-Z]*", "{lib,test}/**/*"]
+
+  s.has_rdoc         = false
+  s.extra_rdoc_files = ["README.mkdn", 'Rakefile']
+  s.rdoc_options     = ["--line-numbers", "--inline-source",
+                        "--main", "README.txt"]
+
+  s.authors          = ["Dean Strelau"]
+  s.email            = "dean@mintdigital.com"
+
+  s.add_dependency "activerecord", ">= 2.1.0"
+  s.add_dependency "activesupport", ">= 2.1.0"
+end
+
+Rake::GemPackageTask.new spec do |pkg|
+  pkg.need_tar = true
+  pkg.need_zip = true
+end
+
+desc "Generate a gemspec file for GitHub"
+task :gemspec do
+  File.open("#{spec.name}.gemspec", 'w') do |f|
+    f.write spec.to_ruby
+  end
+end

data/lib/minty_scopes.rb

@@ -0,0 +1,15 @@
+require 'minty_scopes/version'
+
+require 'minty_scopes/associations'
+require 'minty_scopes/except'
+require 'minty_scopes/order'
+require 'minty_scopes/timestamps'
+
+module MintyScopes
+  def self.extended(within)
+    within.extend MintyScopes::Associations
+    within.extend MintyScopes::Except
+    within.extend MintyScopes::Order
+    within.extend MintyScopes::Timestamps
+  end
+end

data/lib/minty_scopes/associations.rb

@@ -0,0 +1,28 @@
+module MintyScopes
+  module Associations
+  
+    def self.extended(within)
+      within.class_eval do
+        # Only show items that have at least one of the associated items
+        # Meant for has_many associations
+        # Post.with(:comments)
+        named_scope :with, lambda { |assoc|
+          raise "The 'with' named_scope expects a non-nil argument." if assoc.nil?
+          { :joins => assoc.to_sym, :group => "#{quoted_table_name}.id" }
+        }
+        
+        named_scope :without, lambda {|assoc|
+          raise "The 'without' named_scope expects a non-nil argument." if assoc.nil?
+          { :joins => "LEFT JOIN #{assoc.to_s} "+
+              "ON #{quoted_table_name}.id = #{assoc.to_s}.#{quoted_table_name.singularize}_id",
+            :conditions => {"#{assoc}.id" => nil} }
+        }
+        named_scope :including, lambda {|*assocs|
+          { :include => assocs.flatten }
+        }
+        
+      end
+    end
+  
+  end
+end

data/lib/minty_scopes/except.rb

@@ -0,0 +1,17 @@
+module MintyScopes
+  module Except
+    
+    def self.extended(within)
+      within.class_eval do
+        # Allow easy rejection of items.
+        # Can take an a single id or ActiveRecord object, or an array of them
+        named_scope :except, lambda { |*args|
+          args.flatten!
+          raise "The 'except' named_scope expects no nil values." unless args.all?
+          { :conditions => ["#{quoted_table_name}.#{primary_key} NOT IN (?)", args] }
+        }
+      end
+    end
+    
+  end
+end

data/lib/minty_scopes/order.rb

@@ -0,0 +1,23 @@
+module MintyScopes
+  module Order
+    
+    def self.extended(within)
+      within.class_eval do
+        # Get only the newest items. Limit by given parameter.
+        # Default to per_page if will_paginate is installed or 10
+        named_scope :newest, lambda { |*limit| {
+          :order => "#{quoted_table_name}.created_at DESC",
+          :limit => limit.empty? ? (per_page rescue 10) : limit.first
+        } }
+
+        # Get only the oldest items. Limit by given parameter.
+        # Default to per_page if will_paginate is installed or 10
+        named_scope :oldest, lambda { |*limit| {
+          :order => "#{quoted_table_name}.created_at ASC",
+          :limit => limit.empty? ? (per_page rescue 10) : limit.first
+        } }
+      end
+    end
+    
+  end
+end

data/lib/minty_scopes/timestamps.rb

@@ -0,0 +1,23 @@
+module MintyScopes
+  module Timestamps
+    
+    def self.extended(within)
+      within.class_eval do
+        # Allow filtering by day of created_on
+        # Argument must be a Date, Time, or DateTime
+        named_scope :created_on, lambda { |date|
+          raise "The 'created_on' named_scope expects a Date, Time or DateTime object" unless date.respond_to? :end_of_day
+          { :conditions => {:created_at => (date.beginning_of_day..date.end_of_day)} }
+        }
+        
+        # Allow filtering by day of modified_on
+        # Argument must be a Date, Time, or DateTime
+        named_scope :modified_on, lambda { |date|
+          raise "The 'modified_on' named_scope expects a Date, Time or DateTime object" unless date.respond_to? :end_of_day
+          { :conditions => {:modified_on => (date.beginning_of_day..date.end_of_day)} }
+        }
+      end
+    end
+    
+  end
+end

data/lib/minty_scopes/version.rb

@@ -0,0 +1,3 @@
+module MintyScopes
+  VERSION = '0.9.0'
+end

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'minty_scopes'
+
+require 'test/unit'
+require 'rubygems'
+require 'shoulda'
+require 'activerecord'
+require 'activesupport'
+
+class Post < ActiveRecord::Base
+  def self.quoted_table_name; 'posts'; end
+  def self.primary_key; 'id'; end
+  extend MintyScopes
+end
+
+class PaginatedPost < Post
+  def self.per_page; 30; end
+  extend MintyScopes
+end

data/test/units/associations_test.rb

@@ -0,0 +1,39 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper')
+
+class AssociationsTest < Test::Unit::TestCase # :nodoc:
+  
+  context "with" do
+    should "complain if passed nil" do
+      assert_raise(RuntimeError) { Post.with(nil).proxy_options }
+    end
+    
+    should "return all objects with associated items" do
+      assert_equal( { :joins => :comments, :group => 'posts.id' },
+                    Post.with(:comments).proxy_options )
+    end
+  end
+  
+  context "without" do
+    should "complain if passed nil" do
+      assert_raise(RuntimeError) { Post.with(nil).proxy_options }
+    end
+    
+    should "return all objects without associated items" do
+      assert_equal( { :joins => "LEFT JOIN comments ON posts.id = comments.post_id", 
+                      :conditions => {"comments.id" => nil} },
+                    Post.without(:comments).proxy_options )
+    end
+  end
+  
+  context "including" do
+    should "return objects with given include" do
+      assert_equal( { :include => [:comments] },
+                    Post.including(:comments).proxy_options )
+    end
+    
+    should "return objects with all of given includes" do
+      assert_equal( { :include => [:comments, {:author => :avator}] },
+                    Post.including(:comments, {:author => :avator}).proxy_options )
+    end
+  end
+end

data/test/units/except_test.rb

@@ -0,0 +1,33 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper')
+
+class ExceptTest < Test::Unit::TestCase # :nodoc:
+  
+  context "except" do
+    should "complain if passed nil" do
+      assert_raise(RuntimeError){ Post.except(nil).proxy_options }
+    end
+    
+    should "complain if passed an array with nil" do
+      assert_raise(RuntimeError) { Post.except([99,nil,101]).proxy_options }
+    end
+    
+    should "return all but the given object" do
+      item = 123
+      assert_equal( { :conditions => ["posts.id NOT IN (?)", [item]] },
+                    Post.except(item).proxy_options )
+    end
+    
+    should "return all but the items in the given list" do
+      list = [123, 456, 7]
+      assert_equal( { :conditions => ["posts.id NOT IN (?)", list] },
+                    Post.except(list).proxy_options )
+    end
+    
+    should "return all but the given items" do
+      maple, oak = 42, 24
+      assert_equal( { :conditions => ["posts.id NOT IN (?)", [maple, oak]] },
+                    Post.except(maple, oak).proxy_options )
+    end
+  end
+  
+end

data/test/units/order_test.rb

@@ -0,0 +1,49 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper')
+
+class OrderTest < Test::Unit::TestCase # :nodoc:
+  
+  context "newest" do
+    should "return most recent items" do
+      assert Post.newest.proxy_options[:order] = 'posts.created_at DESC'
+    end
+    
+    should "default to 10 items" do
+      assert_equal 10, Post.newest.proxy_options[:limit]
+    end
+    
+    should "use the given limit" do
+      assert_equal 20, Post.newest(20).proxy_options[:limit]
+    end
+    
+    should "default to per_page if it exists" do
+      assert_equal 30, PaginatedPost.newest.proxy_options[:limit]
+    end
+    
+    should "use the given limit over per_page" do
+      assert_equal 15, PaginatedPost.newest(15).proxy_options[:limit]
+    end
+  end
+  
+  context "oldest" do
+    should "return oldest items" do
+      assert Post.oldest.proxy_options[:order] = 'posts.created_at ASC'
+    end
+    
+    should "default to 10 items" do
+      assert_equal 10, Post.oldest.proxy_options[:limit]
+    end
+    
+    should "use the given limit" do
+      assert_equal 20, Post.oldest(20).proxy_options[:limit]
+    end
+    
+    should "default to per_page if it exists" do
+      assert_equal 30, PaginatedPost.oldest.proxy_options[:limit]
+    end
+  
+    should "use the given limit over per_page" do
+      assert_equal 15, PaginatedPost.oldest(15).proxy_options[:limit]
+    end
+  end
+  
+end

data/test/units/timestamps_test.rb

@@ -0,0 +1,32 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper')
+
+class TimestampsTest < Test::Unit::TestCase # :nodoc:
+  def setup
+    @today = Date.today
+  end
+  
+  context "created_on" do
+    should "complain if passed a non date or time" do
+      assert_raise(RuntimeError){ Post.created_on(nil).proxy_options }
+    end
+  
+    should "return all objects created on the given date" do
+      assert_equal({:conditions =>
+                        { :created_at => (@today.beginning_of_day..@today.end_of_day) }
+                   }, Post.created_on(@today).proxy_options)
+    end
+  end
+  
+  context "modified_on" do
+    should "complain if passed a non date or time" do
+      assert_raise(RuntimeError){ Post.modified_on(nil).proxy_options }
+    end
+  
+    should "return all objects modified on the given date" do
+      assert_equal({:conditions =>
+                      { :modified_on => (@today.beginning_of_day..@today.end_of_day) }
+                   }, Post.modified_on(@today).proxy_options)
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: mintdigital-minty_scopes
+version: !ruby/object:Gem::Version 
+  version: 0.9.0
+platform: ruby
+authors: 
+- Dean Strelau
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-16 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+    version: 
+description: 
+email: dean@mintdigital.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.mkdn
+- Rakefile
+files: 
+- Rakefile
+- README.mkdn
+- lib/minty_scopes
+- lib/minty_scopes/associations.rb
+- lib/minty_scopes/except.rb
+- lib/minty_scopes/order.rb
+- lib/minty_scopes/timestamps.rb
+- lib/minty_scopes/version.rb
+- lib/minty_scopes.rb
+- test/test_helper.rb
+- test/units
+- test/units/associations_test.rb
+- test/units/except_test.rb
+- test/units/order_test.rb
+- test/units/timestamps_test.rb
+has_rdoc: false
+homepage: https://github.com/mintdigital/minty_scopes
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --main
+- README.txt
+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: Useful, reusable named_scopes for ActiveRecord.
+test_files: []
+