risosu-san 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright © 2009 Fingertips, Eloy Duran <eloy.de.enige@gmail.com>
+
+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/README.rdoc

@@ -0,0 +1,19 @@
+= Risosu-san
+
+A lean mixin for <tt>ActionController::Base</tt> that assists in situations
+where a resource controller is nested under another resource. Eg:
+
+  /members/24/passwords/new
+
+In this example, retrieving the parent resource is as simple as:
+
+  class PasswordsController < ActionController::Base
+    find_parent_resource :only => :new
+    
+    def new
+      @parent_resource # => #<Member id: 24>
+      @member # => #<Member id: 24>
+    end
+  end
+
+See RisosuSan for a bit more in depth documentation.

data/Rakefile

@@ -0,0 +1,44 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the risosu-san plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the risosu-san plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Risosu-san'
+  rdoc.options << '--line-numbers' << '--inline-source' << '--charset=utf8'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('LICENSE')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name     = "risosu-san"
+    s.homepage = "http://github.com/Fingertips/risosu-san"
+    s.email    = "eloy.de.enige@gmail.com"
+    s.authors  = ["Eloy Duran"]
+    s.summary  = s.description = "RisosuSan is a Rails plugin that assists in situations where a resource controller is nested under another resource."
+  end
+rescue LoadError
+end
+
+begin
+  require 'jewelry_portfolio/tasks'
+  JewelryPortfolio::Tasks.new do |p|
+    p.account = 'Fingertips'
+  end
+rescue LoadError
+end

data/lib/risosu_san.rb

@@ -0,0 +1,58 @@
+module RisosuSan
+  def self.included(klass) #:nodoc:
+    klass.extend ClassMethods
+  end
+  
+  module ClassMethods
+    # Adds a before filter which will take care of finding the parent resource.
+    #
+    #   class PasswordsController < ActionController::Base
+    #     find_parent_resource :only => :new
+    #   end
+    def find_parent_resource(options = {})
+      before_filter :find_parent_resource, options
+    end
+  end
+  
+  protected
+  
+  # Returns whether or not the request for the current resource is nested under
+  # a parent resource, by reflecting on the params.
+  #
+  #   params # => { :id => 42 }
+  #   nested? # => false
+  #
+  #   params # => { :member_id => 24, :id => 42 }
+  #   nested? # => true
+  def nested?
+    !parent_resource_params.empty?
+  end
+  
+  # Returns a hash of params for the parent resource, if available.
+  #
+  #   params # => { :member_id => 24, :id => 42 }
+  #   parent_resource_params # => { :param => :member_id, :id => 24, :name => 'member', :class_name => 'Member', :class => Member }
+  def parent_resource_params
+    @parent_resource_params ||=
+      if key = params.keys.find { |k| k =~ /^(\w+)_id$/ }
+        { :param => key, :id => params[key], :name => $1, :class_name => $1.classify, :class => $1.classify.constantize }
+      else
+        {}
+      end
+  end
+  
+  # Finds the parent resource, if available, and assigns it to
+  # <tt>@parent_resource</tt> and an instance variable with the name of the
+  # resource.
+  #
+  #   params # => { :member_id => 24, :id => 42 }
+  #   find_parent_resource
+  #   @parent_resource # => #<Member id: 24>
+  #   @member # => #<Member id: 24>
+  def find_parent_resource
+    if @parent_resource.nil? && nested? && @parent_resource = parent_resource_params[:class].find(parent_resource_params[:id])
+      instance_variable_set("@#{parent_resource_params[:name]}", @parent_resource)
+    end
+    @parent_resource
+  end
+end

data/rails/init.rb

@@ -0,0 +1,2 @@
+require 'risosu_san'
+ActionController::Base.send :include, RisosuSan

data/test/risosu_san_test.rb

@@ -0,0 +1,90 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class TestController < ActionController::Base
+  public :nested?, :parent_resource_params, :find_parent_resource
+  
+  attr_reader :params
+  def params=(params)
+    @params = params.with_indifferent_access
+  end
+end
+
+class CamelCaseTest
+end
+
+describe "RisosuSan, at the class level" do
+  it "should define a before_filter which finds the parent resource" do
+    TestController.expects(:before_filter).with(:find_parent_resource, {})
+    TestController.find_parent_resource
+  end
+  
+  it "should forward options to the before_filter" do
+    TestController.expects(:before_filter).with(:find_parent_resource, :only => :index)
+    TestController.find_parent_resource :only => :index
+  end
+end
+
+describe "RisosuSan" do
+  attr_accessor :controller
+  
+  before do
+    RisosuSanTest::Initializer.setup_database
+    
+    @controller = TestController.new
+    @member = Member.create(:name => 'Eloy')
+  end
+  
+  after do
+    RisosuSanTest::Initializer.teardown_database
+  end
+  
+  it "should know if it's not a nested request" do
+    controller.params = {}
+    controller.should.not.be.nested
+  end
+  
+  it "should know if this is a nested request" do
+    controller.params = { :member_id => 12 }
+    controller.should.be.nested
+  end
+  
+  it "should know the parent resource params" do
+    controller.params = { :member_id => 12, :id => 34 }
+    controller.parent_resource_params.should == { :name => 'member', :class => Member, :param => 'member_id', :class_name => 'Member', :id => 12 }
+  end
+  
+  it "should know the parent resource params for camelcased classes" do
+    controller.params = { :camel_case_test_id => 12, :id => 34 }
+    controller.parent_resource_params.should == { :name => 'camel_case_test', :class => CamelCaseTest, :param => 'camel_case_test_id', :class_name => 'CamelCaseTest', :id => 12 }
+  end
+  
+  it "should have cached the parent_resource_params" do
+    controller.params = { :member_id => 12, :id => 34 }
+    params = controller.parent_resource_params
+    controller.parent_resource_params.should.be params
+  end
+  
+  it "should find the nested resource" do
+    controller.params = { :member_id => @member.to_param }
+    controller.find_parent_resource
+    assigns(:parent_resource).should == @member
+  end
+  
+  it "should also set an instance variable named after the parent resource" do
+    controller.params = { :member_id => @member.to_param }
+    controller.find_parent_resource.should == @member
+    assigns(:member).should == @member
+  end
+  
+  it "should return nil if the resource isn't nested" do
+    controller.params = {}
+    controller.find_parent_resource.should.be nil
+    assigns(:parent_resource).should.be nil
+  end
+  
+  private
+  
+  def assigns(name)
+    controller.instance_variable_get("@#{name}")
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,75 @@
+module RisosuSanTest
+  module Initializer
+    VENDOR_RAILS = File.expand_path('../../../../rails', __FILE__)
+    OTHER_RAILS = File.expand_path('../../../rails', __FILE__)
+    PLUGIN_ROOT = File.expand_path('../../', __FILE__)
+    
+    def self.rails_directory
+      if File.exist?(File.join(VENDOR_RAILS, 'railties'))
+        VENDOR_RAILS
+      elsif File.exist?(File.join(OTHER_RAILS, 'railties'))
+        OTHER_RAILS
+      end
+    end
+    
+    def self.load_dependencies
+      if rails_directory
+        $:.unshift(File.join(rails_directory, 'activesupport', 'lib'))
+        $:.unshift(File.join(rails_directory, 'activerecord', 'lib'))
+        $:.unshift(File.join(rails_directory, 'actionpack', 'lib'))
+      else
+        require 'rubygems' rescue LoadError
+      end
+      
+      require 'active_support'
+      require 'active_record'
+      require 'action_controller'
+      
+      require 'rubygems' rescue LoadError
+      
+      require 'test/spec'
+      require 'mocha'
+      
+      $:.unshift(File.join(PLUGIN_ROOT, 'lib'))
+      require File.join(PLUGIN_ROOT, 'rails', 'init')
+    end
+    
+    def self.configure_database
+      ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
+      ActiveRecord::Migration.verbose = false
+    end
+    
+    def self.setup_database
+      ActiveRecord::Schema.define(:version => 1) do
+        create_table :members do |t|
+          t.column :name, :string
+        end
+      end
+    end
+    
+    def self.teardown_database
+      ActiveRecord::Base.connection.tables.each do |table|
+        ActiveRecord::Base.connection.drop_table(table)
+      end
+    end
+    
+    def self.start
+      load_dependencies
+      configure_database
+    end
+  end
+end
+
+RisosuSanTest::Initializer.start
+
+# class RisosuSan::PageScope
+#   instance_methods.each { |method| alias_method method.sub(/^has_/, 'have_'), method if method =~ /^has_/ }
+#   
+#   # The delegation of all methods in NamedScope breaks #should.
+#   def should
+#     Test::Spec::Should.new(self)
+#   end
+# end
+
+class Member < ActiveRecord::Base
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: risosu-san
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Eloy Duran
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-26 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: RisosuSan is a Rails plugin that assists in situations where a resource controller is nested under another resource.
+email: eloy.de.enige@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/risosu_san.rb
+- rails/init.rb
+- test/risosu_san_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/Fingertips/risosu-san
+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: RisosuSan is a Rails plugin that assists in situations where a resource controller is nested under another resource.
+test_files: 
+- test/risosu_san_test.rb
+- test/test_helper.rb