extended_inherited_resources 0.1.0

data/lib/inherited_resources/url_helpers.rb

@@ -0,0 +1,182 @@
+module InheritedResources
+  # = URLHelpers
+  #
+  # When you use InheritedResources it creates some UrlHelpers for you.
+  # And they handle everything for you.
+  #
+  #  # /posts/1/comments
+  #  resource_url          # => /posts/1/comments/#{@comment.to_param}
+  #  resource_url(comment) # => /posts/1/comments/#{comment.to_param}
+  #  new_resource_url      # => /posts/1/comments/new
+  #  edit_resource_url     # => /posts/1/comments/#{@comment.to_param}/edit
+  #  collection_url        # => /posts/1/comments
+  #  parent_url            # => /posts/1
+  #
+  #  # /projects/1/tasks
+  #  resource_url          # => /projects/1/tasks/#{@task.to_param}
+  #  resource_url(task)    # => /projects/1/tasks/#{task.to_param}
+  #  new_resource_url      # => /projects/1/tasks/new
+  #  edit_resource_url     # => /projects/1/tasks/#{@task.to_param}/edit
+  #  collection_url        # => /projects/1/tasks
+  #  parent_url            # => /projects/1
+  #
+  #  # /users
+  #  resource_url          # => /users/#{@user.to_param}
+  #  resource_url(user)    # => /users/#{user.to_param}
+  #  new_resource_url      # => /users/new
+  #  edit_resource_url     # => /users/#{@user.to_param}/edit
+  #  collection_url        # => /users
+  #  parent_url            # => /
+  #
+  # The nice thing is that those urls are not guessed during runtime. They are
+  # all created when you inherit.
+  #
+  module UrlHelpers
+
+    # This method hard code url helpers in the class.
+    #
+    # We are doing this because is cheaper than guessing them when our action
+    # is being processed (and even more cheaper when we are using nested
+    # resources).
+    #
+    # When we are using polymorphic associations, those helpers rely on 
+    # polymorphic_url Rails helper.
+    #
+    def create_resources_url_helpers!
+      resource_segments, resource_ivars = [], []
+      resource_config = self.resources_configuration[:self]
+
+      singleton   = self.resources_configuration[:self][:singleton]
+      polymorphic = self.parents_symbols.include?(:polymorphic)
+
+      # Add route_prefix if any.
+      unless resource_config[:route_prefix].blank?
+        if polymorphic
+          resource_ivars << resource_config[:route_prefix].to_s.inspect
+        else
+          resource_segments << resource_config[:route_prefix]
+        end
+      end
+
+      # Deal with belongs_to associations and polymorphic associations.
+      # Remember that we don't have to build the segments in polymorphic cases,
+      # because the url will be polymorphic_url.
+      #
+      self.parents_symbols.each do |symbol|
+        if symbol == :polymorphic
+          resource_ivars << :parent
+        else
+          config = self.resources_configuration[symbol]
+          resource_segments << config[:route_name]
+          resource_ivars    << :"@#{config[:instance_name]}"
+        end
+      end
+
+      collection_ivars    = resource_ivars.dup
+      collection_segments = resource_segments.dup
+
+      # Generate parent url before we add resource instances.
+      unless parents_symbols.empty?
+        generate_url_and_path_helpers nil,   :parent, resource_segments, resource_ivars
+        generate_url_and_path_helpers :edit, :parent, resource_segments, resource_ivars
+      end
+
+      # This is the default route configuration, later we have to deal with
+      # exception from polymorphic and singleton cases.
+      #
+      collection_segments << resource_config[:route_collection_name]
+      resource_segments   << resource_config[:route_instance_name]
+      resource_ivars      << :"@#{resource_config[:instance_name]}"
+
+      # In singleton cases, we do not send the current element instance variable
+      # because the id is not in the URL. For example, we should call:
+      #
+      #   project_manager_url(@project)
+      #
+      # Instead of:
+      #
+      #   project_manager_url(@project, @manager)
+      #
+      # Another exception in singleton cases is that collection url does not
+      # exist. In such cases, we create the parent collection url. So in the
+      # manager case above, the collection url will be:
+      #
+      #    project_url(@project)
+      #
+      # If the singleton does not have a parent, it will default to root_url.
+      #
+      # Finally, polymorphic cases we have to give hints to the polymorphic url
+      # builder. This works by attaching new ivars as symbols or records.
+      #
+      if singleton
+        collection_segments.pop
+        resource_ivars.pop
+
+        if polymorphic
+          resource_ivars << resource_config[:instance_name].inspect
+          new_ivars       = resource_ivars
+        end
+      elsif polymorphic
+        collection_ivars << '(@_resource_class_new ||= resource_class.new)'
+      end
+
+      generate_url_and_path_helpers nil,   :collection, collection_segments, collection_ivars
+      generate_url_and_path_helpers :new,  :resource,   resource_segments,   new_ivars || collection_ivars
+      generate_url_and_path_helpers nil,   :resource,   resource_segments,   resource_ivars
+      generate_url_and_path_helpers :edit, :resource,   resource_segments,   resource_ivars
+    end
+
+    def generate_url_and_path_helpers(prefix, name, resource_segments, resource_ivars) #:nodoc:
+      ivars = resource_ivars.dup
+
+      singleton   = self.resources_configuration[:self][:singleton]
+      polymorphic = self.parents_symbols.include?(:polymorphic)
+
+      # If it's not a singleton, ivars are not empty, not a collection or
+      # not a "new" named route, we can pass a resource as argument.
+      #
+      unless (singleton && name != :parent) || ivars.empty? || name == :collection || prefix == :new
+        ivars.push "(given_args.first || #{ivars.pop})"
+      end
+
+      # In collection in polymorphic cases, allow an argument to be given as a
+      # replacemente for the parent.
+      #
+      if name == :collection && polymorphic
+        index = ivars.index(:parent)
+        ivars.insert index, "(given_args.first || parent)"
+        ivars.delete(:parent)
+      end
+
+      # When polymorphic is true, the segments must be replace by :polymorphic
+      # and ivars should be gathered into an array, which is compacted when
+      # optional.
+      #
+      if polymorphic
+        segments = :polymorphic
+        ivars    = "[#{ivars.join(', ')}]"
+        ivars   << '.compact' if self.resources_configuration[:polymorphic][:optional]
+      else
+        segments = resource_segments.empty? ? 'root' : resource_segments.join('_')
+        ivars    = ivars.join(', ')
+      end
+
+      prefix = prefix ? "#{prefix}_" : ''
+      ivars << (ivars.empty? ? 'given_options' : ', given_options')
+
+      class_eval <<-URL_HELPERS, __FILE__, __LINE__
+        protected
+          def #{prefix}#{name}_path(*given_args)
+            given_options = given_args.extract_options!
+            #{prefix}#{segments}_path(#{ivars})
+          end
+
+          def #{prefix}#{name}_url(*given_args)
+            given_options = given_args.extract_options!
+            #{prefix}#{segments}_url(#{ivars})
+          end
+      URL_HELPERS
+    end
+
+  end
+end

data/lib/inherited_resources/version.rb

@@ -0,0 +1,3 @@
+module InheritedResources
+  VERSION = '1.0.3'.freeze
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'extended_inherited_resources'
+
+class Test::Unit::TestCase
+end

data/test/test_extended_inherited_resources.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestExtendedInheritedResources < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: extended_inherited_resources
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- josevalim
+- stevo
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-22 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: ""
+email: b.kosmowski@selleo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- extended_inherited_resources.gemspec
+- init.rb
+- lib/inherited_resources.rb
+- lib/inherited_resources/actions.rb
+- lib/inherited_resources/base.rb
+- lib/inherited_resources/base_helpers.rb
+- lib/inherited_resources/belongs_to_helpers.rb
+- lib/inherited_resources/blank_slate.rb
+- lib/inherited_resources/class_methods.rb
+- lib/inherited_resources/dsl.rb
+- lib/inherited_resources/legacy/respond_to.rb
+- lib/inherited_resources/legacy/responder.rb
+- lib/inherited_resources/locales/en.yml
+- lib/inherited_resources/polymorphic_helpers.rb
+- lib/inherited_resources/responder.rb
+- lib/inherited_resources/singleton_helpers.rb
+- lib/inherited_resources/url_helpers.rb
+- lib/inherited_resources/version.rb
+- test/helper.rb
+- test/test_extended_inherited_resources.rb
+has_rdoc: true
+homepage: http://github.com/stevo/extended_inherited_resources
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Slightly extended version of josevalim inherited_resources - for rails 2.3
+test_files: 
+- test/helper.rb
+- test/test_extended_inherited_resources.rb