basic_named_scopes 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/README.rdoc

@@ -0,0 +1,81 @@
+= BasicNamedScopes
+
+Basic named scopes for ActiveRecord. Propagates the parameters of the
+find-method as named scopes, for easy reusability and prettier code.
+
+Instead of writing:
+
+  Post.all(:conditions => { :published => true }, :select => :title, :includes => :author)
+
+You can now write:
+
+  Post.conditions(:published => true).select(:title).include(:author)
+
+Reuse them by making class methods:
+
+  class Post < ActiveRecord::Base
+
+    def self.published
+      conditions(:published => true)
+    end
+
+    def self.visible
+      conditions(:visible => true)
+    end
+
+    def self.index
+      published.visible
+    end
+
+  end
+
+Also, the +all+-method is a named scope now, so you can chain after callling
+all, for greater flexibility.
+
+  Post.all.published
+
+Arrays can be used as multple parameters too, sparing you some brackets.
+
+  Post.include(: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.
+While I heard that ActiveRecord 3 will support similar syntax, there is no reason to wait
+any longer.
+
+I find defining named scopes very ugly, especially when dealing with parameters.
+Just compare the amount of curly braces!
+
+  # Using normal named scope:
+  named_scope :name_like, lambda { |query| { :conditions => ["name LIKE ?", query] } }
+
+  # Using BasicNamedScopes
+  def self.name_like(query)
+    conditions("name LIKE ?", query)
+  end
+
+Also, regular named scopes don't support using other named scopes at all!
+
+I found myself implementing (mostly conditions, but others too) so often, that
+a little gem like this would be the obvious choice. Use it if a gem like
+searchlogic is overkill for your needs.
+
+== Installing
+
+The gem is called "basic_named_scopes". You know how to install it.
+
+  gem install basic_named_scopes
+
+Use it in Rails:
+
+  config.gem "basic_named_scopes"
+
+== Copyright
+
+Copyright (c) 2009 Iain Hecker. Released under the MIT License.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "basic_named_scopes"
+    gem.summary = %Q{Basic named scopes for ActiveRecord makes all find-parameters a named scope}
+    gem.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)}
+    gem.email = "iain@iain.nl"
+    gem.homepage = "http://github.com/iain/basic_named_scopes"
+    gem.authors = ["Iain Hecker"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "temping", ">= 1.1.0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "basic_named_scopes #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/basic_named_scopes.rb

@@ -0,0 +1,63 @@
+# Basic named scopes for ActiveRecord. Propagates the parameters of the
+# find-method as named scopes, for easy reusability and prettier code.
+#
+# Instead of writing:
+# 
+#   Post.all(:conditions => { :published => true }, :select => :title, :includes => :author)
+#
+# You can now write:
+#
+#   Post.conditions(:published => true).select(:title).include(:author)
+#
+# Reuse them by making class methods:
+#
+#   class Post < ActiveRecord::Base
+# 
+#     def self.published
+#       conditions(:published => true)
+#     end
+#
+#     def self.visible
+#       conditions(:visible => true)
+#     end
+#
+#     def self.index
+#       published.visible
+#     end
+#
+#   end
+#
+# Also, the +all+-method is a named scope now, so you can chain after callling
+# all, for greater flexibility.
+#
+#   Post.all.published
+#
+# Arrays can be used as multple parameters too, sparing you some brackets.
+#
+#   Post.include(: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)
+#
+module BasicNamedScopes
+
+  FIND_PARAMETERS       = [:conditions, :order, :group, :having, :limit, :offset, :joins, :include, :select, :from]
+  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 } })
+    end
+    FIND_BOOLEAN_SWITCHES.each do |parameter|
+      record.named_scope(parameter, lambda { |*args| { parameter => args.size == 0 ? true : args[0] } })
+    end
+    record.named_scope(:all, lambda { |*args| args[0] || {} })
+  end
+
+end
+
+if defined? ActiveRecord
+  ActiveRecord::Base.extend(BasicNamedScopes)
+end

data/spec/basic_named_scopes_spec.rb

@@ -0,0 +1,58 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "BasicNamedScopes" do
+
+  before :all do
+    create_model :posts do
+      with_columns do |table|
+        table.boolean :published
+        table.boolean :visible
+      end
+      extend BasicNamedScopes
+    end
+  end
+
+  before :each do
+    Post.delete_all
+    @published   = Post.create!(:published => true)
+    @unpublished = Post.create!(:published => false)
+  end
+
+  it "should make .all a named scope" do
+    # Without parameters
+    Post.all.class.should be_scope
+    # With parameters
+    Post.all(:conditions => {:published => true}).class.should be_scope
+  end
+
+  it "should make find parameters a named scope" do
+    subject = Post.conditions(:published => true)
+    subject.class.should be_scope
+    subject.should == [ @published ]
+  end
+
+  it "should expand into array when using multiple parameters" do
+    subject = Post.conditions("published = ?", true)
+    subject.class.should be_scope
+    subject.should == [ @published ]
+  end
+
+  [:conditions, :order, :group, :having, :limit, :offset, :joins, :include, :select, :from].each do |option|
+    it "should known #{option} ActiveRecord::Base.find" do
+      Post.send(option).class.should be_scope
+    end
+  end
+
+  it "should default to true for readonly" do
+    subject = Post.readonly
+    subject.class.should be_scope
+    lambda { subject.first.save }.should raise_error(ActiveRecord::ReadOnlyRecord)
+  end
+
+  it "should accept a value for readonly" do
+    subject = Post.readonly(false)
+    subject.class.should be_scope
+    lambda { subject.first.save }.should_not raise_error(ActiveRecord::ReadOnlyRecord)
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$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'
+
+Spec::Runner.configure do |config|
+  config.include(Temping)
+end
+
+def be_scope
+  eql(ActiveRecord::NamedScope::Scope)
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: basic_named_scopes
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Iain Hecker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-19 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: temping
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.0
+    version: 
+description: Make your queries prettier and more reusable by having a named scope for every find-parameter. As easy as Post.include(:author, :comments)
+email: iain@iain.nl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/basic_named_scopes.rb
+- spec/basic_named_scopes_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/iain/basic_named_scopes
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --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.3.5
+signing_key: 
+specification_version: 3
+summary: Basic named scopes for ActiveRecord makes all find-parameters a named scope
+test_files: 
+- spec/basic_named_scopes_spec.rb
+- spec/spec_helper.rb