resourceful_parenting 0.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in acts_as_list-rails3.gemspec
+gemspec
+
+gem 'rake'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mina Naguib
+
+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

@@ -0,0 +1,66 @@
+ResourcefulParenting
+====================
+
+A rails plugin that makes working with nested resources easier.
+
+It provides the following methods to your RESTful controllers:
+
+ * parent : Returns the most immediate parent resource
+   * parent(-1)       : Same as parent
+   * parent(-2)       : Returns the parent resource's parent
+   * parent(N)        : Returns the Nth parent resource
+   * parent(0)        : Returns the top level parent
+ * parents            : Returns an array of all the parent resources
+ * polymorphic_p_url  : Same as calling polymorphic_url but adding parents to the list
+ * polymorphic_p_path : Same as calling polymorphic_path but adding parents to the list
+
+polymotphic_p_url and polymorphic_p_path are automatically exposed as helper methods for usage in the views.  Feel free to expose the others via helper_method in your ApplicationController
+
+
+Installation
+============
+
+Add to your Gemfile:
+
+  gem 'resourceful_parenting'
+
+
+Example
+=======
+
+Assuming the classical problem of a comments resource nested under several different parent resources:
+
+  class CommentsController < ApplicationController
+
+    def create
+      # regular create work, then:
+
+      redirect_to parent # Back to the parent's show page
+      # OR
+      redirect_to polymorphic_p_url(@comment) # Back to /parents/ID/comments/ID
+      # OR
+      redirect_to polymorphic_p_url(:comments) # Back to /parents/ID/comments
+
+    end
+
+  end
+
+
+Todo
+====
+
+A respectable test suite.   This plugin was just a bunch of ApplicationController methods I decided to extract.
+
+
+Notes
+=====
+
+There is similar functionality in other plugins, however they often do lots more which I didn't need.
+
+This plugin was inspired after watching Ryan Bates hand-roll a custom method for doing this for the Nth time.
+
+
+Copyright
+=========
+
+Copyright (c) 2009 Mina Naguib, released under the MIT license

data/Rakefile

@@ -0,0 +1,25 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+#require 'rake'
+require 'rake/testtask'
+
+# Run the test with 'rake' or 'rake test'
+desc 'Default: run resourceful_parenting unit tests.'
+task :default => :test
+
+desc 'Test the resourceful_parenting plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/**/test_*.rb'
+  t.verbose = false
+end
+
+# Run the rdoc task to generate rdocs for this gem
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "resourceful_parenting"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1,3 @@
+$:.unshift "#{File.dirname(__FILE__)}/lib"
+
+require "resourceful_parenting" unless defined?(ResourcefulParenting)

data/lib/resourceful_parenting.rb

@@ -0,0 +1,110 @@
+module ResourcefulParenting; module ActionController; module Base;
+
+  def self.included(klass)
+    klass.class_eval do
+      include InstanceMethods
+      helper_method :polymorphic_p_url, :polymorphic_p_path
+    end
+    super
+  end
+
+  module InstanceMethods
+
+    #
+    # Analogous to Rails' polymorphic_url, but add all parents to call
+    #
+    def polymorphic_p_url(record_or_hash_or_array, options = {})
+      record_or_hash_or_array = [record_or_hash_or_array] unless record_or_hash_or_array.is_a?(Array)
+      record_or_hash_or_array = parents + record_or_hash_or_array
+      polymorphic_url(record_or_hash_or_array, options)
+    end
+
+    #
+    # Analogous to Rails' polymorphic_path, but add all parents to call
+    #
+    def polymorphic_p_path(record_or_hash_or_array, options = {})
+      polymorphic_p_url(record_or_hash_or_array, options.merge(:routing_type => :path))
+    end
+
+    #
+    # Returns an array of parent objects
+    #
+    def parents
+      parse_parents.map do |info|
+        instance_from_parent_info(info)
+      end
+    end
+
+    #
+    # Returns a parent object extracted from a nested URL
+    # Takes an array index of depth (how far up parents to get) - defaults to -1 (most immediate)
+    # Returns nil if no such parent exists
+    #
+    def parent(level = -1)
+      info = parse_parents[level]
+      instance_from_parent_info(info)
+    end
+
+    private
+
+    #
+    # Returns an array of hashes
+    # Each hash is an info block (opaque as far as you're concerned) about a single parent in the lineage
+    #
+    def parse_parents
+
+      if !@_parents_info
+
+        #
+        # Populate @_parents_info
+        #
+        @_parents_info = []
+        request.path_parameters.each do |key, value|
+          next unless key.to_s.match(/^(.+)_id$/)
+          singular = $1.singularize
+          @_parents_info << {
+            :order    =>  nil,
+            :singular =>  singular,
+            :class    =>  singular.classify.constantize,
+            :id       =>  value,
+            :instance =>  nil
+          }
+        end
+
+        #
+        # Properly sort it
+        #
+        path_parts = request.path.split("/")
+        path_parts.each_with_index do |part, i|
+          next unless part =~ /^[a-z_]+$/
+          singular = part.singularize or next
+          info = @_parents_info.detect{|p| p[:singular] == singular}
+          info[:order] = i if info
+        end
+        @_parents_info = @_parents_info.sort_by{|i| i[:order]}
+
+      end
+
+      return @_parents_info
+
+    end
+
+    def instance_from_parent_info(info)
+      return nil unless info
+      if !info[:instance]
+        if info[:class].respond_to?(:from_param)
+          info[:instance] = info[:class].from_param(info[:id])
+        else
+          info[:instance] = info[:class].find(info[:id])
+        end
+      end
+      info[:instance]
+    end
+
+  end # module InstanceMethods
+
+end;end;end
+
+ActionController::Base.class_eval do
+  include ResourcefulParenting::ActionController::Base unless include?(ResourcefulParenting::ActionController::Base)
+end

data/resourceful_parenting.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+
+  # Description Meta...
+  s.name        = 'resourceful_parenting'
+  s.version     = 0.1
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Mina Naguib']
+  s.email       = ['mina.gems@naguib.ca']
+  s.homepage    = 'http://github.com/minaguib/resourceful_parenting'
+  s.summary     = %q{A rails plugin that makes working with nested resources easier.}
+  s.description = %q{A rails plugin that makes working with nested resources easier.}
+  s.rubyforge_project = 'resourceful_parenting'
+
+
+  # Load Paths...
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+
+  # Dependencies (installed via 'bundle install')...
+  s.add_development_dependency("bundler", [">= 1.0.0"])
+  s.add_development_dependency("actionpack", [">= 3.0.0"])
+  s.add_development_dependency("rdoc")
+end

data/test/resourceful_parenting_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class ResourcefulParentingTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification 
+name: resourceful_parenting
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Mina Naguib
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-25 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: A rails plugin that makes working with nested resources easier.
+email: 
+- mina.gems@naguib.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- MIT-LICENSE
+- README
+- Rakefile
+- init.rb
+- lib/resourceful_parenting.rb
+- resourceful_parenting.gemspec
+- test/resourceful_parenting_test.rb
+- test/test_helper.rb
+homepage: http://github.com/minaguib/resourceful_parenting
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: resourceful_parenting
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A rails plugin that makes working with nested resources easier.
+test_files: 
+- test/resourceful_parenting_test.rb
+- test/test_helper.rb