nileshtrivedi-lp_resource_builder 0.5.1

data/lib/resource_controller/helpers/nested.rb

@@ -0,0 +1,63 @@
+# Nested and Polymorphic Resource Helpers
+#
+module ResourceController::Helpers::Nested
+  protected    
+    # Returns the relevant association proxy of the parent. (i.e. /posts/1/comments # => @post.comments)
+    #
+    def parent_association
+      @parent_association ||= parent_object.send(model_name.to_s.pluralize.to_sym)
+    end
+    
+    # Returns the type of the current parent
+    #
+    def parent_type
+      @parent_type ||= parent_type_from_params || parent_type_from_request
+    end
+    
+    # Returns the type of the current parent extracted from params
+    #    
+    def parent_type_from_params
+      [*belongs_to].find { |parent| !params["#{parent}_id".to_sym].nil? }
+    end
+    
+    # Returns the type of the current parent extracted form a request path
+    #    
+    def parent_type_from_request
+      [*belongs_to].find { |parent| request.path.split('/').include? parent.to_s }
+    end
+    
+    # Returns true/false based on whether or not a parent is present.
+    #
+    def parent?
+      !parent_type.nil?
+    end
+    
+    # Returns true/false based on whether or not a parent is a singleton.
+    #    
+    def parent_singleton?
+      !parent_type_from_request.nil?
+    end
+    
+    # Returns the current parent param, if there is a parent. (i.e. params[:post_id])
+    def parent_param
+      params["#{parent_type}_id".to_sym]
+    end
+    
+    # Like the model method, but for a parent relationship.
+    # 
+    def parent_model
+      parent_type.to_s.camelize.constantize
+    end
+    
+    # Returns the current parent object if a parent object is present.
+    #
+    def parent_object
+      parent? && !parent_singleton? ? parent_model.find(parent_param) : nil
+    end
+    
+    # If there is a parent, returns the relevant association proxy.  Otherwise returns model.
+    #
+    def end_of_association_chain
+      parent? ? parent_association : model
+    end
+end

data/lib/resource_controller/helpers/singleton_customizations.rb

@@ -0,0 +1,60 @@
+# Singleton Resource Helpers
+# 
+# Used internally to transform a plural RESTful controller into a singleton
+#
+module ResourceController::Helpers::SingletonCustomizations
+  def self.included(subclass)
+    subclass.class_eval do  
+      methods_to_undefine = [:param, :index, :collection, :load_collection, :collection_url, 
+        :collection_path, :hash_for_collection_url, :hash_for_collection_path]
+      methods_to_undefine.each { |method| undef_method(method) if method_defined? method }
+      
+      class << self
+        def singleton?
+          true
+        end
+      end
+    end
+  end
+  
+  protected
+    # Used to fetch the current object in a singleton controller.
+    #
+    # By defult this method is able to fetch the current object for resources nested with the :has_one association only. (i.e. /users/1/image # => @user.image)
+    # In other cases you should override this method and provide your custom code to fetch a singleton resource object, like using a session hash.
+    #
+    # class AccountsController < ResourceController::Singleton
+    #   private
+    #     def object
+    #       @object ||= Account.find(session[:account_id])
+    #     end
+    #   end
+    #  
+    def object
+      @object ||= parent? ? end_of_association_chain : nil
+    end
+
+    # Returns the :has_one association proxy of the parent. (i.e. /users/1/image # => @user.image)
+    #  
+    def parent_association
+      @parent_association ||= parent_object.send(model_name.to_sym)
+    end
+  
+    # Used internally to provide the options to smart_url in a singleton controller.
+    #  
+    def object_url_options(action_prefix = nil, alternate_object = nil)
+      [action_prefix] + namespaces + [parent_url_options, route_name.to_sym]
+    end
+  
+    # Builds the object, but doesn't save it, during the new, and create action.
+    #
+    def build_object
+      @object ||= singleton_build_object_base.send parent? ? "build_#{model_name}".to_sym : :new, object_params
+    end
+    
+    # Singleton controllers don't build off of association proxy, so we can't use end_of_association_chain here
+    #
+    def singleton_build_object_base
+      parent? ? parent_object : model
+    end
+end

data/lib/resource_controller/helpers/urls.rb

@@ -0,0 +1,128 @@
+# Thanks to Urligence, you get some free url helpers.
+# 
+# No matter what your controller looks like...
+# 
+#   [edit_|new_]object_url # is the equivalent of saying [edit_|new_]post_url(@post)
+#   [edit_|new_]object_url(some_other_object) # allows you to specify an object, but still maintain any paths or namespaces that are present
+# 
+#   collection_url # is like saying posts_url
+# 
+# Url helpers are especially useful when working with polymorphic controllers.
+# 
+#   # /posts/1/comments
+#   object_url #=> /posts/1/comments/#{@comment.to_param}
+#   object_url(comment) #=> /posts/1/comments/#{comment.to_param}
+#   edit_object_url #=> /posts/1/comments/#{@comment.to_param}/edit
+#   collection_url #=> /posts/1/comments
+# 
+#   # /products/1/comments
+#   object_url #=> /products/1/comments/#{@comment.to_param}
+#   object_url(comment) #=> /products/1/comments/#{comment.to_param}
+#   edit_object_url #=> /products/1/comments/#{@comment.to_param}/edit
+#   collection_url #=> /products/1/comments
+# 
+#   # /comments
+#   object_url #=> /comments/#{@comment.to_param}
+#   object_url(comment) #=> /comments/#{comment.to_param}
+#   edit_object_url #=> /comments/#{@comment.to_param}/edit
+#   collection_url #=> /comments
+# 
+# Or with namespaced, nested controllers...
+# 
+#   # /admin/products/1/options
+#   object_url #=> /admin/products/1/options/#{@option.to_param}
+#   object_url(option) #=> /admin/products/1/options/#{option.to_param}
+#   edit_object_url #=> /admin/products/1/options/#{@option.to_param}/edit
+#   collection_url #=> /admin/products/1/options
+# 
+# You get the idea.  Everything is automagical!  All parameters are inferred.
+#
+module ResourceController::Helpers::Urls
+  protected
+    ['', 'edit_'].each do |type|
+      symbol = type.blank? ? nil : type.gsub(/_/, '').to_sym
+      
+      define_method("#{type}object_url") do |*alternate_object|
+        smart_url *object_url_options(symbol, alternate_object.first)
+      end
+      
+      define_method("#{type}object_path") do |*alternate_object|
+        smart_path *object_url_options(symbol, alternate_object.first)
+      end
+      
+      define_method("hash_for_#{type}object_url") do |*alternate_object|
+        hash_for_smart_url *object_url_options(symbol, alternate_object.first)
+      end
+      
+      define_method("hash_for_#{type}object_path") do |*alternate_object|
+        hash_for_smart_path *object_url_options(symbol, alternate_object.first)
+      end
+    end
+    
+    def new_object_url
+      smart_url *new_object_url_options
+    end
+    
+    def new_object_path
+      smart_path *new_object_url_options
+    end
+    
+    def hash_for_new_object_url
+      hash_for_smart_url *new_object_url_options
+    end
+    
+    def hash_for_new_object_path
+      hash_for_smart_path *new_object_url_options
+    end
+    
+    def collection_url
+      smart_url *collection_url_options
+    end
+    
+    def collection_path
+      smart_path *collection_url_options
+    end
+    
+    def hash_for_collection_url
+      hash_for_smart_url *collection_url_options
+    end
+    
+    def hash_for_collection_path
+      hash_for_smart_path *collection_url_options
+    end
+    
+    # Used internally to provide the options to smart_url from Urligence.
+    #
+    def collection_url_options
+      namespaces + [parent_url_options, route_name.to_s.pluralize.to_sym]
+    end
+    
+    # Used internally to provide the options to smart_url from Urligence.
+    #
+    def object_url_options(action_prefix = nil, alternate_object = nil)
+      [action_prefix] + namespaces + [parent_url_options, [route_name.to_sym, alternate_object || object]]
+    end
+    
+    # Used internally to provide the options to smart_url from Urligence.
+    #
+    def new_object_url_options
+      [:new] + namespaces + [parent_url_options, route_name.to_sym]
+    end
+    
+    def parent_url_options
+      if parent?
+        parent_singleton? ? parent_type.to_sym : [parent_type.to_sym, parent_object]
+      else
+        nil
+      end
+    end
+    
+    # Returns all of the current namespaces of the current controller, symbolized, in array form.
+    #
+    def namespaces
+      names = self.class.name.split("::")
+      names.pop
+      
+      names.map(&:underscore).map(&:to_sym)
+    end
+end

data/lib/resource_controller/helpers.rb

@@ -0,0 +1,28 @@
+module ResourceController
+  # == ResourceController::Helpers
+  #
+  # Included in Base.
+  # 
+  # These helpers are used internally to manage objects, generate urls, and manage parent resource associations.
+  #
+  # If you want to customize certain controller behaviour, like member-object, and collection fetching, overriding these methods is all it takes.
+  #
+  # See the docs below, and the README for examples
+  #
+  # *Please Note: many of these helpers build on top of each other, and require that behaviour to be maintained, in order for other functionality to work properly.*
+  # 
+  # e.g. All fetching must be done on top of the method end_of_association_chain, or else parent resources (including polymorphic ones) won't function correctly.
+  #   
+  #   class PostsController < ResourceController::Base
+  #   private
+  #     def object
+  #       @object ||= end_of_association_chain.find_by_permalink(param)
+  #     end
+  #   end
+  module Helpers
+    include ResourceController::Helpers::Urls
+    include ResourceController::Helpers::Internal
+    include ResourceController::Helpers::Nested
+    include ResourceController::Helpers::CurrentObjects
+  end
+end

data/lib/resource_controller/response_collector.rb

@@ -0,0 +1,27 @@
+module ResourceController
+  class ResponseCollector
+    
+    attr_reader :responses
+    
+    delegate :clear, :to => :responses
+    
+    def initialize
+      @responses = []
+    end
+    
+    def method_missing(method_name, &block)
+      @responses.delete self[method_name]
+      @responses << [method_name, block || nil]
+    end
+    
+    def [](symbol)
+      @responses.find { |method, block| method == symbol }
+    end
+    
+    def dup
+      returning ResponseCollector.new do |duplicate|
+        duplicate.instance_variable_set(:@responses, responses.dup)
+      end
+    end
+  end
+end

data/lib/resource_controller/singleton.rb

@@ -0,0 +1,15 @@
+module ResourceController
+  
+  # == ResourceController::Singleton
+  # 
+  # Inherit from this class to create your RESTful singleton controller.  See the README for usage.
+  # 
+  class Singleton < ApplicationController
+    unloadable
+    
+    def self.inherited(subclass)
+      super
+      subclass.class_eval { resource_controller :singleton }
+    end
+  end
+end

data/lib/resource_controller/version.rb

@@ -0,0 +1,9 @@
+module ResourceController
+  module VERSION
+    MAJOR    = 0
+    MINOR    = 5
+    TINY     = 1
+    
+    STRING   = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/resource_controller.rb

@@ -0,0 +1,20 @@
+module ResourceController
+  ACTIONS           = [:index, :show, :new_action, :create, :edit, :update, :destroy].freeze
+  SINGLETON_ACTIONS = (ACTIONS - [:index]).freeze
+  FAILABLE_ACTIONS  = ACTIONS - [:index, :new_action, :edit].freeze
+  NAME_ACCESSORS    = [:model_name, :route_name, :object_name]  
+  
+  module ActionControllerExtension
+    unloadable
+    
+    def resource_controller(*args)
+      include ResourceController::Controller
+      
+      if args.include?(:singleton)
+        include ResourceController::Helpers::SingletonCustomizations
+      end
+    end  
+  end
+end
+
+require File.dirname(__FILE__)+'/../rails/init.rb' unless ActionController::Base.include?(Urligence)

data/lib/urligence.rb

@@ -0,0 +1,50 @@
+module Urligence
+  def smart_url(*objects)
+    urligence(*objects.push(:url))
+  end
+  
+  def smart_path(*objects)
+    urligence(*objects.push(:path))
+  end
+  
+  def hash_for_smart_url(*objects)
+    urligence(*objects.unshift(:hash_for).push(:url).push({:type => :hash}))
+  end
+  
+  def hash_for_smart_path(*objects)
+    urligence(*objects.unshift(:hash_for).push(:path).push({:type => :hash}))
+  end
+  
+  def urligence(*objects)
+    config = {}
+    config.merge!(objects.pop) if objects.last.is_a?(Hash)
+    
+    objects.reject! { |object| object.nil? }
+    
+    url_fragments = objects.collect do |obj|
+      if obj.is_a? Symbol
+        obj
+      elsif obj.is_a? Array
+        obj.first
+      else
+        obj.class.name.underscore.to_sym
+      end
+    end
+    
+    unless config[:type] == :hash
+      send url_fragments.join("_"), *objects.flatten.select { |obj| !obj.is_a? Symbol }
+    else
+      params = {}
+      unparsed_params = objects.select { |obj| !obj.is_a? Symbol }
+      unparsed_params.each_with_index do |obj, i|
+        unless i == (unparsed_params.length-1)
+          params.merge!((obj.is_a? Array) ? {"#{obj.first}_id".to_sym => obj[1].to_param} : {"#{obj.class.name.underscore}_id".to_sym => obj.to_param})
+        else
+          params.merge!((obj.is_a? Array) ? {:id => obj[1].to_param} : {:id => obj.to_param})
+        end
+      end
+      
+      send url_fragments.join("_"), params
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,6 @@
+ActionController::Base.class_eval do
+  include Urligence
+  helper_method :smart_url
+  
+  extend ResourceController::ActionControllerExtension
+end

data/test/Rakefile

@@ -0,0 +1,10 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require(File.join(File.dirname(__FILE__), 'config', 'boot'))
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+require 'tasks/rails'

data/test/app/controllers/accounts_controller.rb

@@ -0,0 +1,6 @@
+class AccountsController < ResourceController::Singleton
+  protected
+    def object
+      Account.find(:first)
+    end
+end

data/test/app/controllers/application.rb

@@ -0,0 +1,7 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  # Pick a unique cookie name to distinguish our session data from others'
+  session :session_key => '_myapp_session'
+end

data/test/app/controllers/cms/options_controller.rb

@@ -0,0 +1,3 @@
+class Cms::OptionsController < ResourceController::Base
+  belongs_to :product
+end

data/test/app/controllers/cms/products_controller.rb

@@ -0,0 +1,3 @@
+class Cms::ProductsController < ResourceController::Base
+  create.flash 'something'
+end

data/test/app/controllers/comments_controller.rb

@@ -0,0 +1,3 @@
+class CommentsController < ResourceController::Base
+  belongs_to :post
+end

data/test/app/controllers/images_controller.rb

@@ -0,0 +1,4 @@
+class ImagesController < ResourceController::Singleton
+  belongs_to :user
+  actions :create
+end

data/test/app/controllers/options_controller.rb

@@ -0,0 +1,8 @@
+class OptionsController < ResourceController::Base
+  belongs_to :account
+  
+  protected
+    def parent_object
+      Account.find(:first)
+    end
+end

data/test/app/controllers/people_controller.rb

@@ -0,0 +1,9 @@
+class PeopleController < ResourceController::Base
+  create.before :name_person
+  model_name    :account
+  
+  private
+    def name_person
+      @person.name = "Bob Loblaw"
+    end
+end

data/test/app/controllers/photos_controller.rb

@@ -0,0 +1,11 @@
+class PhotosController < ResourceController::Base
+  actions :all, :except => :update
+  
+  belongs_to :user
+  create.flash { "#{@photo.title} was created!" }
+  
+  private
+    def parent_model
+      Account
+    end
+end

data/test/app/controllers/posts_controller.rb

@@ -0,0 +1,10 @@
+class PostsController < ResourceController::Base
+  actions :all
+  
+  create.before(:name_post) { @post.body = '...' }
+  
+  private
+    def name_post
+      @post.title = 'a great post'
+    end
+end

data/test/app/controllers/projects_controller.rb

@@ -0,0 +1,3 @@
+class ProjectsController < ApplicationController
+  resource_controller
+end

data/test/app/controllers/somethings_controller.rb

@@ -0,0 +1,3 @@
+class SomethingsController < ResourceController::Base
+  actions :index, :show
+end

data/test/app/controllers/tags_controller.rb

@@ -0,0 +1,13 @@
+class TagsController < ResourceController::Base
+  belongs_to :photo
+  
+  index.wants.js
+  
+  index do
+    before { @products = Product.find :all }
+  end
+  
+  create.after do
+    @photo.tags << @tag if parent_type == :photo
+  end
+end

data/test/app/controllers/users_controller.rb

@@ -0,0 +1,12 @@
+class UsersController < ResourceController::Base
+  object_name :dude
+  route_name :dude
+  private    
+    def route_name
+      'dude'
+    end
+    
+    def model_name
+      'account'
+    end
+end

data/test/app/helpers/accounts_helper.rb

@@ -0,0 +1,2 @@
+module AccountsHelper
+end

data/test/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+end

data/test/app/helpers/cms/products_helper.rb

@@ -0,0 +1,2 @@
+module Cms::ProductsHelper
+end

data/test/app/helpers/comments_helper.rb

@@ -0,0 +1,2 @@
+module CommentsHelper
+end

data/test/app/helpers/images_helper.rb

@@ -0,0 +1,2 @@
+module ImagesHelper
+end

data/test/app/helpers/options_helper.rb

@@ -0,0 +1,2 @@
+module OptionsHelper
+end

data/test/app/helpers/people_helper.rb

@@ -0,0 +1,2 @@
+module PeopleHelper
+end

data/test/app/helpers/photos_helper.rb

@@ -0,0 +1,2 @@
+module PhotosHelper
+end

data/test/app/helpers/posts_helper.rb

@@ -0,0 +1,2 @@
+module PostsHelper
+end

data/test/app/helpers/projects_helper.rb

@@ -0,0 +1,2 @@
+module ProjectsHelper
+end

data/test/app/helpers/somethings_helper.rb

@@ -0,0 +1,2 @@
+module SomethingsHelper
+end

data/test/app/helpers/tags_helper.rb

@@ -0,0 +1,2 @@
+module TagsHelper
+end

data/test/app/helpers/users_helper.rb

@@ -0,0 +1,2 @@
+module UsersHelper
+end

data/test/app/models/account.rb

@@ -0,0 +1,4 @@
+class Account < ActiveRecord::Base
+  has_many :photos
+  has_many :options
+end

data/test/app/models/comment.rb

@@ -0,0 +1,3 @@
+class Comment < ActiveRecord::Base
+  belongs_to :post
+end

data/test/app/models/image.rb

@@ -0,0 +1,3 @@
+class Image < ActiveRecord::Base
+  belongs_to :user
+end

data/test/app/models/option.rb

@@ -0,0 +1,3 @@
+class Option < ActiveRecord::Base
+  belongs_to :product
+end

data/test/app/models/photo.rb

@@ -0,0 +1,4 @@
+class Photo < ActiveRecord::Base
+  has_and_belongs_to_many :tags
+  belongs_to :user, :class_name => "Account", :foreign_key => "account_id"
+end

data/test/app/models/post.rb

@@ -0,0 +1,3 @@
+class Post < ActiveRecord::Base
+  has_many :comments
+end

data/test/app/models/product.rb

@@ -0,0 +1,3 @@
+class Product < ActiveRecord::Base
+  has_many :options
+end

data/test/app/models/project.rb

@@ -0,0 +1,2 @@
+class Project < ActiveRecord::Base
+end

data/test/app/models/something.rb

@@ -0,0 +1,2 @@
+class Something < ActiveRecord::Base
+end

data/test/app/models/tag.rb

@@ -0,0 +1,3 @@
+class Tag < ActiveRecord::Base
+  has_and_belongs_to_many :photos
+end

data/test/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  has_one :image
+end