internuity-quick_scopes 0.1

data/README.rdoc

@@ -0,0 +1,25 @@
+A Rails plugin to automatically add some quick named_scopes to your models.
+
+These are especially useful for quick modifications to a query on an association.
+
+==The named_scopes
+The named scopes added are:
+* <tt>order</tt>
+* <tt>limit</tt>
+* <tt>with</tt>
+
+==Examples
+With a User model having many Posts
+  # Standard association method to retrieve all posts
+  user.posts
+  
+  # Order the posts
+  user.posts.order('created_at')
+
+  # Limit the results to a specific number
+  user.posts.limit(5)
+   
+  # Include other associated models
+  user.posts.with(:comments)
+  user.posts.with(:comments, :author)
+  user.posts.with({:comments => :author}, :author)

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+desc 'Default: run unit tests.'
+task :default => [:clean, :test]
+
+desc 'Run tests'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/test_*.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = 'Quick Scopes'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Clean up files.'
+task :clean do |t|
+  FileUtils.rm_rf "doc"
+  FileUtils.rm_rf "tmp"
+  FileUtils.rm_rf "pkg"
+end
+
+spec = Gem::Specification.new do |s| 
+  s.name              = "quick_scopes"
+  s.version           = "0.1"
+  s.author            = "Andrew Timberlake"
+  s.email             = "andrew@andrewtimberlake.com"
+  s.homepage          = "http://www.internuity.net/projects/quick_scopes"
+  s.platform          = Gem::Platform::RUBY
+  s.summary           = "Rails plugin to add some useful named_scopes to your models"
+  s.files             = FileList["README*",
+                                 "LICENSE",
+                                 "Rakefile",
+                                 "{lib,test}/**/*"].to_a
+  s.require_path      = "lib"
+  s.test_files        = FileList["test/**/test_*.rb"].to_a
+  s.has_rdoc          = true
+  s.extra_rdoc_files  = FileList["README*"].to_a
+  s.rdoc_options << '--line-numbers' << '--inline-source'
+  s.add_development_dependency 'thoughtbot-shoulda'
+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/quick_scopes.rb

@@ -0,0 +1,17 @@
+class ActiveRecord::Base
+  named_scope :order, lambda { |order|       
+    { :order => order }
+  }
+
+  named_scope :limit, lambda { |limit|       
+    { :limit => limit }
+  }
+
+  named_scope :with,  lambda { |*include|    
+    { :include => include.size == 1 ? include[0] : include }
+  }
+
+  named_scope :where, lambda { |*conditions| 
+    { :conditions => conditions.size == 1 ? conditions[0] : conditions }
+  }
+end

data/test/helper.rb

@@ -0,0 +1,73 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'
+require 'active_record'
+require 'test/unit'
+require 'shoulda'
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'quick_scopes')
+require File.join(File.dirname(__FILE__), 'models')
+
+TEST_DB = File.join(File.dirname(__FILE__), 'test.sqlite3')
+
+def setup_database
+  File.unlink(TEST_DB) if File.exist?(TEST_DB)
+  ActiveRecord::Base.establish_connection(
+    'adapter' => 'sqlite3', 'timeout' => 5000, 'database' => TEST_DB
+  )
+  create_tables
+  load_fixtures
+end
+
+def create_tables
+  c = ActiveRecord::Base.connection
+
+  c.create_table :authors, :force => true do |t|
+    t.string :name
+    t.timestamps
+  end
+
+  c.create_table :posts, :force => true do |t|
+    t.string :title
+    t.integer :author_id
+    t.timestamps
+  end
+
+  c.create_table :comments, :force => true do |t|
+    t.string :comment
+    t.integer :author_id
+    t.integer :post_id
+    t.timestamps
+  end
+end
+
+def load_fixtures
+  john = Author.create(:name => 'John')
+  jane = Author.create(:name => 'Jane')
+  bruce = Author.create(:name => 'Bruce')
+  shiela = Author.create(:name => 'Shiela')
+
+  john_post1 = Post.create(:title => 'Post 1', :author => john, :created_at => Time.now - 3.days)
+  john_post2 = Post.create(:title => 'Post 2', :author => john, :created_at => Time.now - 1.day)
+
+  jane_post1 = Post.create(:title => 'Post 3', :author => jane, :created_at => Time.now - 3.days)
+  jane_post2 = Post.create(:title => 'Post 4', :author => jane, :created_at => Time.now - 1.day)
+
+  comment1 = john_post1.comments.create(:comment => 'A comment on post 1 by jane', :author => jane)
+  comment2 = john_post1.comments.create(:comment => 'A comment on post 1 by bruce', :author => bruce)
+  comment3 = john_post1.comments.create(:comment => 'A comment on post 1 by shiela', :author => shiela)
+
+  comment4 = john_post2.comments.create(:comment => 'A comment on post 2 by jane', :author => jane)
+  comment5 = john_post2.comments.create(:comment => 'A comment on post 2 by bruce', :author => bruce)
+  comment6 = john_post2.comments.create(:comment => 'A comment on post 2 by shiela', :author => shiela)
+
+  comment7 = jane_post1.comments.create(:comment => 'A comment on post 3 by john', :author => john)
+  comment8 = jane_post1.comments.create(:comment => 'A comment on post 3 by bruce', :author => bruce)
+  comment9 = jane_post1.comments.create(:comment => 'A comment on post 3 by shiela', :author => shiela)
+
+  comment10 = jane_post2.comments.create(:comment => 'A comment on post 4 by john', :author => john)
+  comment11 = jane_post2.comments.create(:comment => 'A comment on post 4 by bruce', :author => bruce)
+  comment12 = jane_post2.comments.create(:comment => 'A comment on post 4 by shiela', :author => shiela)
+end
+
+setup_database

data/test/models.rb

@@ -0,0 +1,14 @@
+class Author < ActiveRecord::Base
+  has_many :posts
+  has_many :comments
+end
+
+class Post < ActiveRecord::Base
+  has_many :comments
+  belongs_to :author
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :post
+  belongs_to :author
+end

data/test/test_quick_scopes.rb

@@ -0,0 +1,58 @@
+require File.join(File.dirname(__FILE__), 'helper.rb')
+
+class QuickScopesTest < Test::Unit::TestCase
+  def setup
+  end
+
+  [Post, Author, Comment].each do |model|
+    context "The #{model} model" do
+      should "have an order scope" do
+        assert Post.scopes.include?(:order)
+      end
+
+      should "have a limit scope" do
+        assert Post.scopes.include?(:limit)
+      end
+
+      should "have a with scope" do
+        assert Post.scopes.include?(:with)
+      end
+    end
+  end
+
+  context "using the order named_scope" do
+    setup {
+      john = Author.find_by_name('John')
+      @posts = john.posts.order('created_at desc')
+    }
+
+    should "return results in the correct order" do
+      assert_equal 'Post 2', @posts[0].title
+    end
+  end
+
+  context "using the limit named_scope" do
+    setup {
+      @post = Post.first
+    }
+
+    should "return 3 comments when unlimited" do
+      assert_equal 3, @post.comments.size
+    end
+
+    should "return 2 comments when limited to 2" do
+      #Not sure why I have to add to_a?
+      assert_equal 2, @post.comments.limit(2).to_a.size
+    end
+  end
+
+  context "using the where named_scope" do
+    setup {
+      @post = Post.first
+    }
+
+    should "restrict the results" do
+      assert_equal 1, @post.comments.where(:author_id => Author.find_by_name('Jane').id).to_a.size
+    end
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: internuity-quick_scopes
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Andrew Timberlake
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-27 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: andrew@andrewtimberlake.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- LICENSE
+- Rakefile
+- lib/quick_scopes.rb
+- test/helper.rb
+- test/models.rb
+- test/test.sqlite3
+- test/test_quick_scopes.rb
+has_rdoc: true
+homepage: http://www.internuity.net/projects/quick_scopes
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+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: Rails plugin to add some useful named_scopes to your models
+test_files: 
+- test/test_quick_scopes.rb