gcnovus-arns 0.0.1

data/README.rdoc

@@ -0,0 +1,48 @@
+= ARNS adds named_scopes to ActiveResource.
+
+== Usage
+
+	class Book < ActiveResource::Base
+	  self.site = 'http://library.alexandria.org/'
+	  named_scope :limit, lambda { |n| { :params => { :limit => n } } }
+	  named_scope :by_author, lambda { |author| { :params => { :author => author } } }
+		named_scope :out_of_print, lambda { { :from => :out_of_print } }
+	end
+	
+	# same as Book.find(:all, :params => { :author => 'Zinn' }):
+	Book.by_author('Zinn')
+	# => GET /books.xml?author=Zinn
+	
+	# same as Book.find(:all, :params => { :author => 'Scarry', :limit => 2 }):
+	Book.by_author('Scarry').limit(2) 
+	# => GET /books.xml?author=Scarry&limit=2
+	
+	# same as Book.find(:all, :from => :out_of_print, :params => { :limit => 10 }):
+	Book.out_of_print.limit(10)
+	# => GET /books/out_of_print.xml?limit=10
+
+== Installation
+
+=== As a gem, from the command line:
+
+	gem sources -a http://gems.github.com (you only have to do this once)
+	sudo gem install gcnovus-arns
+
+=== In your Rails app's <tt>config/environment.rb</tt>:
+
+	gem 'gcnovus-arns', :source => 'http://gems.github.com', :lib => 'arns'
+
+Then, from the command line in RAILS_APP_ROOT:
+
+	sudo rake gems:install
+
+== Duplication w.r.t. <tt>ActiveRecord::NamedScope</tt>
+
+Much of the code in this project could be replaced with that in <tt>ActiveRecord::Base</tt> and <tt>ActiveRecord::NamedScope</tt>.
+Unfortunately, that code is very tightly tied to +ActiveRecord+.  If the Rails team does want to move this into
+core, I would encourage them to try to merge those two implementation.  The nastiest bit is mostly that <tt>ActiveRecord</tt>'s
+version hardcodes the list of things that get merged instead of replaced when scopes are combined:
+<tt>[:conditions, :include, :joins, :find]</tt>. This version needs to only do <tt>merge</tt>s (or <tt>reverse_merge</tt>s)
+on <tt>:params</tt>.  The only other significant bit is that the support for scoping (the <tt>#with_scope</tt>, <tt>#default_scope</tt>,
+<tt>#scoped?</tt>, <tt>#scope</tt>, <tt>#scoped_methods</tt>, and <tt>#current_scoped_methods</tt> methods) for +ActiveRecord+ is in
+<tt>ActiveRecord::Base</tt>, not in the included <tt>ActiveRecord::NamedScope</tt> module and thus can't be re-used here.

data/Rakefile

@@ -0,0 +1,64 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rcov/rcovtask'
+require 'rake/gempackagetask'
+
+$LOAD_PATH.unshift("lib")
+require 'active_resource/named_scope'
+
+desc 'Run unit tests'
+task :default => :test
+
+test_files_pattern = 'test/**/*_test.rb'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.test_files = Dir.glob(test_files_pattern).sort
+  t.verbose = true
+end
+
+Rake::RDocTask.new { |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title = "ARNS -- named_scope for ActiveResource"
+  rdoc.main = "README.rdoc"
+  rdoc.options << '--line-numbers'
+  rdoc.template = "#{ENV['template']}.rb" if ENV['template']
+  rdoc.rdoc_files.include('README.rdoc', 'lib/**/*.rb')
+}
+
+desc 'Calculate test coverage of plugin.'
+Rcov::RcovTask.new(:coverage) do |rcov|
+  rcov.pattern    = test_files_pattern
+  rcov.output_dir = 'coverage'
+  rcov.verbose    = true
+  rcov.rcov_opts  = ['--sort coverage', '-x "(^/)|(/Gems/)"', '-Ilib']
+end
+
+spec = Gem::Specification.new do |s|
+  s.name = "arns"
+  s.version = ActiveResource::NamedScope::VERSION
+  s.summary = "named_scope for ActiveResource"
+  s.homepage = "http://github.com/gcnovus/arns"
+ 
+  s.files = FileList['[A-Z]*', '{lib,test}/**/*']
+ 
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README.rdoc"]
+  s.rdoc_options = ["--line-numbers", "--main", "README.rdoc"]
+ 
+  s.authors = ["Gaius Novus"]
+  s.email = "gaius.c.novus@gmail.com"
+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/active_resource/named_scope.rb

@@ -0,0 +1,167 @@
+module ActiveResource
+  
+  # To be included by ActiveResource::Base.  Provides +named_scope+ functionality
+  # similar to (but not quite as rich as) ActiveRecord's.
+  #
+  # The options supported in a scope are <tt>:from</tt> and <tt>:params</tt>.
+  # The <tt>:from</tt> value should be a +Symbol+ or +String+ and represents
+  # a subdirectory in the resource.  Later <tt>:from</tt> values will replace
+  # earlier ones.  The <tt>:params</tt> value should be a +Hash+ and represents
+  # additional query parameters.  Later <tt>:params</tt> values will be merged
+  # with earlier ones.
+  #
+  # == Example Usage:
+  #   
+  #   class Book < ActiveResource::Base
+	#     self.site = 'http://library.alexandria.org/'
+	#     named_scope :limit, lambda { |n| { :params => { :limit => n } } }
+	#     named_scope :by_author, lambda { |author| { :params => { :author => author } } }
+	#     named_scope :out_of_print, lambda { { :from => :out_of_print } }
+	#     named_scope :rare, lambda { { :from => :rare } }
+	#   end
+	#   
+	#   # same as Book.find(:all, :params => { :author => 'Zinn' }):
+	#   Book.by_author('Zinn')
+	#   # => GET /books.xml?author=Zinn
+	#   
+	#   # same as Book.find(:all, :params => { :author => 'Scarry', :limit => 2 }):
+	#   Book.by_author('Scarry').limit(2) 
+	#   # => GET /books.xml?author=Scarry&limit=2
+	#   
+	#   # same as Book.find(:all, :from => :out_of_print, :params => { :limit => 10 }):
+	#   Book.out_of_print.limit(10)
+	#   # => GET /books/out_of_print.xml?limit=10
+	#
+	#   # later :from values overwrite earlier ones:
+	#   Book.out_of_print.rare
+	#   # => GET /books/rare.xml
+	#
+	#   # later :params values are merged with earlier ones:
+	#   Book.author('Douglas Adams').limit(10).limit(2)
+	#   # => GET /books.xml?author=Douglas+Adams&limit=2
+  module NamedScope
+    
+    VERSION = "0.0.1"
+    
+    def self.included(base)
+      base.extend ClassMethods
+      base.send :include, InstanceMethods
+    end
+    
+    module InstanceMethods
+    end
+    
+    module ClassMethods
+      
+      # Define a new named scope.
+      #
+      # == Parameters
+      #
+      # +name+: the name of the Scope. A Symbol. Required.
+      #
+      # +options+: a Hash or Proc (lambda) to evaluate for the scope. Required.
+      def named_scope(name, options)
+        name = name.to_sym
+        named_scopes[name] = ActiveResource::NamedScope::ScopePrototype.new(name, options)
+        (class << self; self end).instance_eval do
+          define_method name do |*args|
+            named_scopes[name].call(self, *args)
+          end
+        end
+      end
+      
+      def named_scopes
+        read_inheritable_attribute(:scopes) || write_inheritable_attribute(:scopes, {})
+      end
+      
+    end
+    
+    class ScopePrototype
+      
+      attr_reader :name, :content
+      
+      def initialize(name, content)
+        @name, @content = name, content
+      end
+      
+      def call(base_scope, *args)
+        options = case @content
+        when Hash
+          @content.dup
+        when Proc
+          @content.call(*args)
+        end
+        Scope.new(base_scope, options)
+      end
+      
+    end
+    
+    class Scope
+      
+      def initialize(base_scope, options)
+        @base_scope = base_scope
+        @options = deep_merge(base_options, options)
+      end
+      
+      def proxy_options
+        @options
+      end
+      
+      # Object defines a default +to_a+ in Ruby 1.8, but it is deprecated.
+      def to_a
+        found
+      end
+      
+      def method_missing(method, *args, &block)
+        if (scope_prototype = resource_class.named_scopes[method])
+          return scope_prototype.call(self, *args)
+        elsif found.respond_to?(method)
+          return found.send(method, *args, &block)
+        end
+        super(method, *args)
+      end
+      
+      def respond_to?(method)
+        super(method) || resource_class.named_scopes[method] || found.respond_to?(method)
+      end
+      
+      protected
+      
+      def base_scope
+        @base_scope
+      end
+      
+      private
+      
+      # Merges Hash +b+ into Hash +a+, marging instead of replacing any included Hash stored under :params.
+      #
+      # Returns a new Hash.
+      def deep_merge(a, b)
+        params = {}.merge(a[:params] || {}).merge(b[:params] || {})
+        result = a.merge(b)
+        result.merge!({ :params => params }) unless params.empty?
+        result
+      end
+      
+      def base_options
+        @base_scope.respond_to?(:proxy_options) ? @base_scope.proxy_options : {}
+      end
+      
+      def found
+        @found ||= resource_class.find(:all, proxy_options).tap(&:freeze)
+      end
+      
+      def resource_class
+        @resource_class ||= begin
+          result = @base_scope
+          result = result.base_scope while result.kind_of?(Scope)
+          result
+        end
+      end
+      
+    end
+    
+    
+  end
+  
+end

data/test/named_scope_test.rb

@@ -0,0 +1,147 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+require 'active_resource/named_scope'
+
+class NamedScopeTest < Test::Unit::TestCase
+
+  context 'an ActiveResource class' do
+    
+    setup do
+      @class = Class.new do
+        def self.name; 'Book'; end
+        include ActiveResource::NamedScope
+      end
+    end
+    
+    context 'defining a new named scope' do
+      
+      context 'with a name and Hash' do
+       
+        setup do
+          @class.named_scope :rare, { :from => :rare }
+        end
+        
+        should "add the named scope to the class's list of named scopes" do
+          assert_not_nil @class.named_scopes[:rare]
+          assert @class.named_scopes[:rare].kind_of?(ActiveResource::NamedScope::ScopePrototype)
+        end
+        
+        should 'use the given Hash for the proxy options' do
+          assert_equal({ :from => :rare}, @class.rare.proxy_options)
+        end
+        
+      end
+      
+      context 'with a name and Proc' do
+        
+        setup do
+          @class.named_scope :with_author, lambda { |author| { :params => { :author => author } } }
+        end
+        
+        should "add the named scope to the class's list of named scopes" do
+          assert_not_nil @class.named_scopes[:with_author]
+        end
+        
+        should 'evaluate the Proc for the proxy options' do
+          assert_equal({ :params => { :author => 'Pirsig' } }, @class.with_author('Pirsig').proxy_options)
+        end
+        
+      end
+      
+    end
+    
+    context 'with some named scopes' do
+      
+      setup do
+        @class.named_scope :rare, { :from => :rare }
+        @class.named_scope :out_of_print, { :from => :out_of_print }
+        @class.named_scope :with_author, lambda { |author| { :params => { :author => author } } }
+        @class.named_scope :limit, lambda { |limit| { :params => { :limit => limit } } }
+      end
+      
+      should 'return the results of a find(:all) when a chain of named scopes is evaluated' do
+        result = []
+        @class.expects(:find).returns(result)
+        assert_equal result, @class.limit(20).to_a
+      end
+      
+      should 'not make a find call in the middle of chained named scopes' do
+        @class.expects(:find).once
+        @class.rare.out_of_print.with_author('Silverstein').limit(10).to_a
+      end
+      
+      should 'overwrite earlier :from values with later ones' do
+        @class.expects(:find).with(:all, { :from => :out_of_print })
+        @class.rare.out_of_print.to_a
+      end
+      
+      should 'merge :params values' do
+        @class.expects(:find).with(:all, { :params => { :author => 'Plato', :limit => 5 } })
+        @class.with_author('Plato').limit(5).to_a
+      end
+      
+      should 'overwrite earlier values in the :params hash with later ones' do
+        @class.expects(:find).with(:all, { :params => { :limit => 2 } })
+        @class.limit(4).limit(2).to_a
+      end
+      
+      should 'accept long chains of named scopes with all sorts of overwriting' do
+        @class.expects(:find).with(:all, { :from => :rare, :params => { :author => 'Wilkie Collins', :limit => 22 } })
+        @class.limit(9).rare.out_of_print.with_author('Wilkie Collins').limit(22).rare.to_a
+      end
+      
+    end
+    
+    context 'the result of a named scope evaluation' do
+      
+      setup do
+        @class.named_scope(:foo, {})
+        @x = Object.new
+        @y = Object.new
+        @class.stubs(:find).returns([@x, @y])
+      end
+      
+      should 'support :to_a' do
+        assert_equal [@x, @y], @class.foo.to_a
+      end
+      
+      should 'support :each with a block' do
+        @x.expects(:to_s)
+        @y.expects(:to_s)
+        @class.foo.each(&:to_s)
+      end
+      
+      should 'support :first' do
+        assert_equal @x, @class.foo.first
+      end
+      
+      should 'support :last' do
+        assert_equal @x, @class.foo.first
+      end
+      
+      should 'support :any? without a block' do
+        assert @class.foo.any?
+      end
+      
+      should 'support :any? with a block' do
+        assert  @class.foo.any? { |z| z == @y }
+        assert !@class.foo.any? { |z| z == 7  }
+      end
+      
+      should 'support :all? with a block' do
+        assert  @class.foo.all? { |z| !z.nil? }
+        assert !@class.foo.all? { |z| z == @y }
+      end
+      
+      should 'support :length' do
+        assert_equal 2, @class.foo.length
+      end
+      
+      should 'raise a NoMethodError for other methods' do
+        assert_raises(NoMethodError) { @class.foo.bar }
+      end
+      
+    end
+    
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+require 'active_support'
+
+$: << File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: gcnovus-arns
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Gaius Novus
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-17 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: gaius.c.novus@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- Rakefile
+- README.rdoc
+- lib/active_resource
+- lib/active_resource/named_scope.rb
+- test/named_scope_test.rb
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/gcnovus/arns
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --main
+- README.rdoc
+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: 3
+summary: named_scope for ActiveResource
+test_files: []
+