scope-builder 0.1.2

data/CHANGELOG

@@ -0,0 +1,11 @@
+*0.1.2* (August 28th, 2008)
+
+* scope_builder can be called on association proxy
+
+*0.1.1* (June 26th, 2008)
+
+* scope_builder can be called on any Scope
+
+*0.1.0* (June 26th, 2008)
+
+* initial release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Ryan Bates
+
+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/Manifest

@@ -0,0 +1,14 @@
+CHANGELOG
+lib/scope_builder/builder.rb
+lib/scope_builder/model_additions.rb
+lib/scope_builder.rb
+LICENSE
+Manifest
+README
+scope-builder.gemspec
+spec/models/category.rb
+spec/models/product.rb
+spec/scope_builder/builder_spec.rb
+spec/spec_helper.rb
+tasks/deployment.rake
+tasks/spec.rake

data/README.rdoc

@@ -0,0 +1,56 @@
+= Scope Builder
+
+Build up named scopes conditionally.
+
+
+== Install
+
+First specify it in your Rails config.
+
+	config.gem 'ryanb-scope-builder', :lib => 'scope_builder', :source => 'http://gems.github.com'
+
+And then install it.
+
+  rake gems:install
+
+Rails 2.1 or later required.
+
+
+== Usage
+
+This gem adds the scope_builder method to all Active Record models. A 
+builder behaves exactly like any other named scope except that calling 
+other named scopes on it will alter the builder itself rather than 
+returning a new named scope.
+
+  builder = Product.scope_builder
+  builder.released.visible # call a couple named scopes to change builder
+  builder.cheap if only_show_cheap_products? # build scopes conditionally
+
+The scope_builder method can also take a block which will return the 
+builder. This is useful when you are using the builder in a model 
+search method.
+
+  # in product model
+  def self.search(options)
+    scope_builder do |builder|
+      builder.released.visible
+      builder.cheap if options[:cheap]
+    end
+  end
+
+The scope_builder method can also be called on an existing scope.
+
+  products = Product.released.visible
+  builder = products.scope_builder
+  builder.cheap if only_show_cheap_products?
+
+
+== Development
+
+This project can be found on github at the following URL.
+
+http://github.com/ryanb/scope-builder/
+
+If you would like to contribute to this project, please fork the 
+repository and send me a pull request.

data/lib/scope_builder.rb

@@ -0,0 +1,3 @@
+$:.unshift(File.dirname(__FILE__))
+require 'scope_builder/model_additions'
+require 'scope_builder/builder'

data/lib/scope_builder/builder.rb

@@ -0,0 +1,25 @@
+module ScopeBuilder
+  class Builder
+    def initialize(proxy_scope)
+      @proxy_scope = proxy_scope
+    end
+    
+    def method_missing(method, *args, &block)
+      result = @proxy_scope.send(method, *args, &block)
+      if result.class == ActiveRecord::NamedScope::Scope
+        @proxy_scope = result
+        self
+      else
+        result
+      end
+    end
+    
+    def respond_to?(method)
+      super || @proxy_scope.respond_to?(method)
+    end
+    
+    def inspect
+      sprintf("#<%s:%#0x>", self.class.to_s, self.object_id)
+    end
+  end
+end

data/lib/scope_builder/model_additions.rb

@@ -0,0 +1,21 @@
+module ScopeBuilder
+  module ModelAdditions
+    def scope_builder
+      builder = Builder.new(scoped({}))
+      yield(builder) if block_given?
+      builder
+    end
+  end
+end
+
+class ActiveRecord::Base
+  extend ScopeBuilder::ModelAdditions
+end
+
+class ActiveRecord::Associations::AssociationProxy
+  include ScopeBuilder::ModelAdditions
+end
+
+class ActiveRecord::NamedScope::Scope
+  include ScopeBuilder::ModelAdditions
+end

data/scope-builder.gemspec

@@ -0,0 +1,51 @@
+
+# Gem::Specification for Scope-builder-0.1.2
+# Originally generated by Echoe
+
+Gem::Specification.new do |s|
+  s.name = %q{scope-builder}
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ryan Bates"]
+  s.date = %q{2008-08-28}
+  s.description = %q{Build up named scopes conditionally.}
+  s.email = %q{ryan (at) railscasts (dot) com}
+  s.extra_rdoc_files = ["CHANGELOG", "lib/scope_builder/builder.rb", "lib/scope_builder/model_additions.rb", "lib/scope_builder.rb", "LICENSE", "README.rdoc", "tasks/deployment.rake", "tasks/spec.rake"]
+  s.files = ["CHANGELOG", "lib/scope_builder/builder.rb", "lib/scope_builder/model_additions.rb", "lib/scope_builder.rb", "LICENSE", "Manifest", "README.rdoc", "scope-builder.gemspec", "spec/models/category.rb", "spec/models/product.rb", "spec/scope_builder/builder_spec.rb", "spec/spec_helper.rb", "tasks/deployment.rake", "tasks/spec.rake"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/ryanb/scope-builder}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Scope-builder", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{scope-builder}
+  s.rubygems_version = %q{1.2.0}
+  s.summary = %q{Build up named scopes conditionally.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if current_version >= 3 then
+    else
+    end
+  else
+  end
+end
+
+
+# # Original Rakefile source (requires the Echoe gem):
+# 
+# require 'rubygems'
+# require 'rake'
+# require 'echoe' 
+# 
+# Echoe.new('scope-builder', '0.1.2') do |p|
+#   p.summary        = "Build up named scopes conditionally."
+#   p.description    = "Build up named scopes conditionally."
+#   p.url            = "http://github.com/ryanb/scope-builder"
+#   p.author         = 'Ryan Bates'
+#   p.email          = "ryan (at) railscasts (dot) com"
+#   p.ignore_pattern = ["script/*", "**/*.sqlite3"]
+# end
+# 
+# Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/spec/models/category.rb

@@ -0,0 +1,15 @@
+class Category < ActiveRecord::Base
+  has_many :products
+end
+
+class CreateCategories < ActiveRecord::Migration
+  def self.up
+    create_table :categories do |t|
+      t.string :name
+    end
+  end
+  
+  def self.down
+    drop_table :categories
+  end
+end

data/spec/models/product.rb

@@ -0,0 +1,18 @@
+class Product < ActiveRecord::Base
+  named_scope :released, :conditions => ['released=?', true]
+  belongs_to :category
+end
+
+class CreateProducts < ActiveRecord::Migration
+  def self.up
+    create_table :products do |t|
+      t.string :name
+      t.boolean :released
+      t.integer :category_id
+    end
+  end
+  
+  def self.down
+    drop_table :products
+  end
+end

data/spec/scope_builder/builder_spec.rb

@@ -0,0 +1,73 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe ScopeBuilder::Builder do
+  before(:each) do
+    Product.delete_all
+    Product.create!(:name => 'a', :released => true)
+    Product.create!(:name => 'b', :released => false)
+    Product.create!(:name => 'c', :released => true)
+    
+    @builder = Product.scope_builder
+  end
+  
+  it "should start with empty proxy options" do
+    @builder.proxy_options.should == {}
+  end
+  
+  it "should allow named scopes to be called through it" do
+    @builder.released.proxy_options.should == Product.released.proxy_options
+  end
+  
+  it "should remember scope calls" do
+    @builder.released
+    @builder.proxy_options.should == Product.released.proxy_options
+  end
+  
+  it "should build up scopes" do
+    @builder.released.scoped(:limit => 1)
+    @builder.scoped(:offset => 1)
+    @builder.all.should == Product.released.scoped(:limit => 1, :offset => 1).all
+  end
+  
+  it "should enumerate like an array" do
+    products = Product.find(:all)
+    @builder.each_with_index do |product, index|
+      product.should == products[index]
+    end
+  end
+  
+  it "should not include instance variables on inspect so it doesn't load proxy" do
+    @builder.inspect.should_not include('proxy_scope')
+  end
+  
+  it "should respond to enumerable methods like each_with_index" do
+    @builder.should respond_to(:each_with_index)
+  end
+  
+  it "should be able to build up scope in block" do
+    Product.scope_builder { |b| b.released }.all.should == Product.released.all
+  end
+  
+  it "should be able to call scope builder on an existing scope" do
+    builder = Product.released.scope_builder
+    builder.all.should == Product.released.all
+  end
+  
+  describe "products in category" do
+    before(:each) do
+      Category.delete_all
+      @category = Category.create!(:products => Product.find_all_by_name(['a', 'b']))
+    end
+    
+    it "should work on named scope through association" do
+      builder = @category.products.released.scope_builder
+      builder.all.should == @category.products.released.all
+    end
+    
+    it "should work directly on assocation" do
+      builder = @category.products.scope_builder
+      builder.released
+      builder.all.should == @category.products.released.all
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'spec'
+require 'active_support'
+require 'active_record'
+require File.dirname(__FILE__) + '/../lib/scope_builder.rb'
+
+# setup database adapter
+ActiveRecord::Base.establish_connection({
+  :adapter => "sqlite3",
+  :dbfile => File.dirname(__FILE__) + "/test.sqlite3"
+})
+
+# load models
+# there's probably a better way to handle this
+require File.dirname(__FILE__) + '/models/category.rb'
+require File.dirname(__FILE__) + '/models/product.rb'
+CreateCategories.migrate(:up) unless Category.table_exists?
+CreateProducts.migrate(:up) unless Product.table_exists?
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end

data/tasks/deployment.rake

@@ -0,0 +1,2 @@
+desc "Build the manifest and gemspec files."
+task :build => [:build_manifest, :build_gemspec]

data/tasks/spec.rake

@@ -0,0 +1,9 @@
+require 'spec/rake/spectask'
+
+spec_files = Rake::FileList["spec/**/*_spec.rb"]
+
+desc "Run specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = spec_files
+  t.spec_opts = ["-c"]
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: scope-builder
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
+platform: ruby
+authors: 
+- Ryan Bates
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-28 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Build up named scopes conditionally.
+email: ryan (at) railscasts (dot) com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- lib/scope_builder/builder.rb
+- lib/scope_builder/model_additions.rb
+- lib/scope_builder.rb
+- LICENSE
+- README.rdoc
+- tasks/deployment.rake
+- tasks/spec.rake
+files: 
+- CHANGELOG
+- lib/scope_builder/builder.rb
+- lib/scope_builder/model_additions.rb
+- lib/scope_builder.rb
+- LICENSE
+- Manifest
+- README.rdoc
+- scope-builder.gemspec
+- spec/models/category.rb
+- spec/models/product.rb
+- spec/scope_builder/builder_spec.rb
+- spec/spec_helper.rb
+- tasks/deployment.rake
+- tasks/spec.rake
+has_rdoc: true
+homepage: http://github.com/ryanb/scope-builder
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Scope-builder
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: scope-builder
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 2
+summary: Build up named scopes conditionally.
+test_files: []
+