basic_named_scopes 0.1.0 → 0.1.1

data/README.rdoc

@@ -5,11 +5,14 @@ find-method as named scopes, for easy reusability and prettier code.
 
 Instead of writing:
 
-  Post.all(:conditions => { :published => true }, :select => :title, :includes => :author)
+  Post.all(:conditions => { :published => true }, :select => :title, :include => :author)
 
 You can now write:
 
-  Post.conditions(:published => true).select(:title).include(:author)
+  Post.conditions(:published => true).select(:title).with(:author)
+
+All named scopes are called the same, except for +include+, which is now
+called +with+, because +include+ is a reserved method.
 
 Reuse them by making class methods:
 
@@ -36,13 +39,15 @@ all, for greater flexibility.
 
 Arrays can be used as multple parameters too, sparing you some brackets.
 
-  Post.include(:author, :comments).conditions("name LIKE ?", query)
+  Post.with(:author, :comments).conditions("name LIKE ?", query)
 
 The +read_only+ and +lock+ scopes default to true, but can be adjusted.
 
   Post.readonly         # => same as Post.all(:readonly => true)
   Post.readonly(false)  # => same as Post.all(:readonly => false)
 
+
+
 == Why?
 
 NamedScopes are really handy and they should play a more central theme in ActiveRecord.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/basic_named_scopes.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{basic_named_scopes}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Iain Hecker"]
+  s.date = %q{2009-12-19}
+  s.description = %q{Make your queries prettier and more reusable by having a named scope for every find-parameter. As easy as Post.include(:author, :comments)}
+  s.email = %q{iain@iain.nl}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "basic_named_scopes.gemspec",
+     "lib/basic_named_scopes.rb",
+     "spec/basic_named_scopes_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/iain/basic_named_scopes}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Basic named scopes for ActiveRecord makes all find-parameters a named scope}
+  s.test_files = [
+    "spec/basic_named_scopes_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<temping>, [">= 1.1.0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<temping>, [">= 1.1.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<temping>, [">= 1.1.0"])
+  end
+end
+

data/lib/basic_named_scopes.rb

@@ -3,11 +3,14 @@
 #
 # Instead of writing:
 # 
-#   Post.all(:conditions => { :published => true }, :select => :title, :includes => :author)
+#   Post.all(:conditions => { :published => true }, :select => :title, :include => :author)
 #
 # You can now write:
 #
-#   Post.conditions(:published => true).select(:title).include(:author)
+#   Post.conditions(:published => true).select(:title).with(:author)
+#
+# All named scopes are called the same, except for +include+, which is now
+# called +with+, because +include+ is a reserved method.
 #
 # Reuse them by making class methods:
 #
@@ -34,7 +37,7 @@
 #
 # Arrays can be used as multple parameters too, sparing you some brackets.
 #
-#   Post.include(:author, :comments).conditions("name LIKE ?", query)
+#   Post.with(:author, :comments).conditions("name LIKE ?", query)
 #
 # The +read_only+ and +lock+ scopes default to true, but can be adjusted.
 #
@@ -43,21 +46,55 @@
 #
 module BasicNamedScopes
 
-  FIND_PARAMETERS       = [:conditions, :order, :group, :having, :limit, :offset, :joins, :include, :select, :from]
+  # These are the normal parameters that will be turned into named scopes.
+  FIND_PARAMETERS       = [:conditions, :order, :group, :having, :limit, :offset, :joins, :select, :from]
+
+  # These are the parameters that want a boolean.
   FIND_BOOLEAN_SWITCHES = [:readonly, :lock]
 
-  def self.extended(record)
-    FIND_PARAMETERS.each do |parameter|
-      record.named_scope(parameter, lambda { |*args| { parameter => args.size == 1 ? args.first : args } })
+  class << self
+
+    # When you extend an ActiveRecord model (or Base for that matter) it will
+    # add the named scopes. This will automatically be done when the gem is
+    # loaded.
+    def extended(model)
+      apply_basic_named_scopes(model)
     end
-    FIND_BOOLEAN_SWITCHES.each do |parameter|
-      record.named_scope(parameter, lambda { |*args| { parameter => args.size == 0 ? true : args[0] } })
+
+    def apply_basic_named_scopes(model)
+      model.named_scope(:with, expand_into_array(:include))
+      FIND_PARAMETERS.each do |parameter|
+        model.named_scope(parameter, expand_into_array(parameter))
+      end
+      FIND_BOOLEAN_SWITCHES.each do |parameter|
+        model.named_scope(parameter, default_to_true(parameter))
+      end
+      model.named_scope(:all, default_to_empty_hash)
+    end
+
+    private
+
+    # The lambda for normal parameters. Will return an array when passed
+    # multiple parameters, saving you the brackets.
+    def expand_into_array(parameter)
+      lambda { |*args| { parameter => args.size == 1 ? args[0] : args } }
     end
-    record.named_scope(:all, lambda { |*args| args[0] || {} })
+
+    # The lambda for boolean switches (readonly and lock). Will default
+    # to true when no argument has been given.
+    def default_to_true(parameter)
+      lambda { |*args| { parameter => args.size == 0 ? true : args[0] } }
+    end
+
+    # For the +all+-method, an empty hash will be the default when no
+    # parameters have been given. Otherwise, it just accepts just one
+    # parameter.
+    def default_to_empty_hash
+      lambda { |*args| args[0] || {} }
+    end
+
   end
 
 end
 
-if defined? ActiveRecord
-  ActiveRecord::Base.extend(BasicNamedScopes)
-end
+ActiveRecord::Base.extend(BasicNamedScopes) if defined?(ActiveRecord)

data/spec/basic_named_scopes_spec.rb

@@ -7,8 +7,15 @@ describe "BasicNamedScopes" do
       with_columns do |table|
         table.boolean :published
         table.boolean :visible
+        table.integer :author_id
       end
-      extend BasicNamedScopes
+      belongs_to :author
+    end
+    create_model :authors do
+      with_columns do |table|
+        table.string :name
+      end
+      has_many :posts
     end
   end
 
@@ -37,7 +44,13 @@ describe "BasicNamedScopes" do
     subject.should == [ @published ]
   end
 
-  [:conditions, :order, :group, :having, :limit, :offset, :joins, :include, :select, :from].each do |option|
+  it "should have a scope named 'with' but internally use 'include' as parameter" do
+    Post.create!(:author => Author.create!)
+    Author.should_receive(:find).and_return([])
+    Post.with(:author).to_a
+  end
+
+  [:conditions, :order, :group, :having, :limit, :offset, :joins, :with, :select, :from].each do |option|
     it "should known #{option} ActiveRecord::Base.find" do
       Post.send(option).class.should be_scope
     end

data/spec/spec_helper.rb

@@ -1,10 +1,10 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'basic_named_scopes'
 require 'spec'
 require 'spec/autorun'
 require 'active_record'
 require 'temping'
+require 'basic_named_scopes'
 
 Spec::Runner.configure do |config|
   config.include(Temping)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: basic_named_scopes
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Iain Hecker
@@ -46,6 +46,7 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- basic_named_scopes.gemspec
 - lib/basic_named_scopes.rb
 - spec/basic_named_scopes_spec.rb
 - spec/spec.opts