inherited_resources 1.3.0 → 1.4.0

data/CHANGELOG

@@ -1,3 +1,17 @@
+# Version 1.4.0
+
+* Supports Ruby 2.0.0
+* Added support for the strong_parameters gem. See the README for more
+* Added the ability to pass without_protection when creating/updating
+* Fixed multi-level nested singletons
+* Correct paths now generated for uncountable shallow resources
+
+# Version 1.3.1
+
+* Fix polymorphic_belongs_to to get the parent
+* Added support for Rails 3.2
+* Added support to responders >= 0.6.0
+
 # Version 1.3.0
 
 * Added support for multiple polymorphic optional nesting
@@ -35,7 +49,7 @@
   To install it, please do:
 
     sudo gem install has_scope
-  
+
 # Version 0.9
 
 * Allow dual blocks in destroy;

data/Gemfile

@@ -1,12 +1,7 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 
-gem "rails", "3.1.0.rc4"
-gem "responders", "~> 0.6.0"
-gem "has_scope", "~> 0.5.0"
-gem "mocha"
+gemspec
 
-if RUBY_VERSION < "1.9"
-  gem "ruby-debug"
-else
-  gem "test-unit"
-end
+gem 'rails', '~> 3.2'
+gem 'mocha'
+gem 'turn'

data/Gemfile.lock

@@ -1,104 +1,105 @@
+PATH
+  remote: .
+  specs:
+    inherited_resources (1.3.1)
+      has_scope (~> 0.5.0)
+      responders (~> 0.9)
+
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    actionmailer (3.1.0.rc4)
-      actionpack (= 3.1.0.rc4)
-      mail (~> 2.3.0)
-    actionpack (3.1.0.rc4)
-      activemodel (= 3.1.0.rc4)
-      activesupport (= 3.1.0.rc4)
+    actionmailer (3.2.13)
+      actionpack (= 3.2.13)
+      mail (~> 2.5.3)
+    actionpack (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
       builder (~> 3.0.0)
       erubis (~> 2.7.0)
-      i18n (~> 0.6)
-      rack (~> 1.3.0)
-      rack-cache (~> 1.0.1)
-      rack-mount (~> 0.8.1)
-      rack-test (~> 0.6.0)
-      sprockets (~> 2.0.0.beta.10)
-      tzinfo (~> 0.3.27)
-    activemodel (3.1.0.rc4)
-      activesupport (= 3.1.0.rc4)
-      bcrypt-ruby (~> 2.1.4)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
       builder (~> 3.0.0)
-      i18n (~> 0.6)
-    activerecord (3.1.0.rc4)
-      activemodel (= 3.1.0.rc4)
-      activesupport (= 3.1.0.rc4)
-      arel (~> 2.1.1)
-      tzinfo (~> 0.3.27)
-    activeresource (3.1.0.rc4)
-      activemodel (= 3.1.0.rc4)
-      activesupport (= 3.1.0.rc4)
-    activesupport (3.1.0.rc4)
+    activerecord (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
       multi_json (~> 1.0)
-    arel (2.1.1)
-    bcrypt-ruby (2.1.4)
-    builder (3.0.0)
-    columnize (0.3.4)
+    ansi (1.4.3)
+    arel (3.0.2)
+    builder (3.0.4)
     erubis (2.7.0)
-    has_scope (0.5.0)
-    hike (1.1.0)
-    i18n (0.6.0)
-    linecache (0.46)
-      rbx-require-relative (> 0.0.4)
-    mail (2.3.0)
+    has_scope (0.5.1)
+    hike (1.2.1)
+    i18n (0.6.1)
+    journey (1.0.4)
+    json (1.7.7)
+    mail (2.5.3)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    mime-types (1.16)
-    mocha (0.9.8)
-      rake
-    multi_json (1.0.3)
-    polyglot (0.3.1)
-    rack (1.3.0)
-    rack-cache (1.0.2)
+    metaclass (0.0.1)
+    mime-types (1.21)
+    mocha (0.13.3)
+      metaclass (~> 0.0.1)
+    multi_json (1.7.2)
+    polyglot (0.3.3)
+    rack (1.4.5)
+    rack-cache (1.2)
       rack (>= 0.4)
-    rack-mount (0.8.1)
-      rack (>= 1.0.0)
-    rack-ssl (1.3.2)
+    rack-ssl (1.3.3)
       rack
-    rack-test (0.6.0)
+    rack-test (0.6.2)
       rack (>= 1.0)
-    rails (3.1.0.rc4)
-      actionmailer (= 3.1.0.rc4)
-      actionpack (= 3.1.0.rc4)
-      activerecord (= 3.1.0.rc4)
-      activeresource (= 3.1.0.rc4)
-      activesupport (= 3.1.0.rc4)
+    rails (3.2.13)
+      actionmailer (= 3.2.13)
+      actionpack (= 3.2.13)
+      activerecord (= 3.2.13)
+      activeresource (= 3.2.13)
+      activesupport (= 3.2.13)
       bundler (~> 1.0)
-      railties (= 3.1.0.rc4)
-    railties (3.1.0.rc4)
-      actionpack (= 3.1.0.rc4)
-      activesupport (= 3.1.0.rc4)
+      railties (= 3.2.13)
+    railties (3.2.13)
+      actionpack (= 3.2.13)
+      activesupport (= 3.2.13)
       rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
       rdoc (~> 3.4)
-      thor (~> 0.14.6)
-    rake (0.8.7)
-    rbx-require-relative (0.0.5)
-    rdoc (3.6.1)
-    responders (0.6.4)
-    ruby-debug (0.10.4)
-      columnize (>= 0.1)
-      ruby-debug-base (~> 0.10.4.0)
-    ruby-debug-base (0.10.4)
-      linecache (>= 0.3)
-    sprockets (2.0.0.beta.10)
-      hike (~> 1.0)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.0.4)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    responders (0.9.3)
+      railties (~> 3.1)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
-    thor (0.14.6)
-    tilt (1.3.2)
-    treetop (1.4.9)
+    thor (0.17.0)
+    tilt (1.3.6)
+    treetop (1.4.12)
+      polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.28)
+    turn (0.9.6)
+      ansi
+    tzinfo (0.3.37)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  has_scope (~> 0.5.0)
+  inherited_resources!
   mocha
-  rails (= 3.1.0.rc4)
-  responders (~> 0.6.0)
-  ruby-debug
+  rails (~> 3.2)
+  turn

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 José Valim http://blog.plataformatec.com.br
+Copyright (c) 2009-2012 José Valim http://blog.plataformatec.com.br
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -4,7 +4,7 @@ Inherited Resources speeds up development by making your controllers inherit
 all restful actions so you just have to focus on what is important. It makes
 your controllers more powerful and cleaner at the same time.
 
-Plus, making your controllers follow a pattern, it helps you to write better
+In addition to making your controllers follow a pattern, it helps you to write better
 code by following fat models and skinny controllers convention. There are
 two screencasts available besides this README:
 
@@ -23,7 +23,7 @@ And then execute:
 
   bundle install 
 
-Or install it yourself as:
+Or install it yourself with:
 
   gem install inherited_resources
 
@@ -57,7 +57,7 @@ how it will change your application:
 
   http://github.com/plataformatec/responders
 
-And it can be installed as:
+And it can be installed with:
 
   gem install responders
 
@@ -85,7 +85,7 @@ The next step is to define which mime types this controller provides:
       respond_to :html, :xml, :json
     end
 
-You can also specify them based per action:
+You can also specify them per action:
 
     class ProjectsController < InheritedResources::Base
       respond_to :html, :xml, :json
@@ -93,7 +93,7 @@ You can also specify them based per action:
       respond_to :iphone, :except => [ :edit, :update ]
     end
 
-For each request, it first checkes if the "controller/action.format" file is
+For each request, it first checks if the "controller/action.format" file is
 available (for example "projects/create.xml") and if it's not, it checks if
 the resource respond to :to_format (in this case, :to_xml). Otherwise returns 404.
 
@@ -126,11 +126,19 @@ call inherit_resources in your controller class scope:
       inherit_resources
     end
 
+One reason to use the "inherit_resources" macro would be to ensure that your controller never responds with the html mime-type.  InheritedResources::Base already responds_to :html, and the respond_to macro is strictly additive.  Therefore, if you want to create a controller that, for example, responds ONLY via :js, you will have write it this way:
+
+    class AccountsController < ApplicationController
+      respond_to :js
+      inherit_resources
+    end
+
+
 == Overwriting defaults
 
 Whenever you inherit from InheritedResources, several defaults are assumed.
-For example you can have an AccountsController to account management while the
-resource is an User:
+For example you can have an AccountsController for account management while the
+resource is a User:
 
     class AccountsController < InheritedResources::Base
       defaults :resource_class => User, :collection_name => 'users', :instance_name => 'user'
@@ -141,7 +149,7 @@ the routes used will still be accounts_url and account_url. If you plan also to
 change the routes, you can use :route_collection_name and :route_instance_name.
 
 Namespaced controllers work out of the box, but if you need to specify a
-different route prefix, you can do the following:
+different route prefix you can do the following:
 
     class Administrators::PeopleController < InheritedResources::Base
       defaults :route_prefix => 'admin'
@@ -167,10 +175,10 @@ and scopes (more about this below).
 
 InheritedResources also introduces another method called begin_of_association_chain.
 It's mostly used when you want to create resources based on the @current_user and
-you have urls like "account/projects". In such cases, you have to do
+you have urls like "account/projects". In such cases you have to do
 @current_user.projects.find or @current_user.projects.build in your actions.
 
-You can deal with it just doing:
+You can deal with it just by doing:
 
     class ProjectsController < InheritedResources::Base
       protected
@@ -204,13 +212,13 @@ why all methods have aliases. So this is equivalent:
       end
     end
 
-Even more, since most of the times when you change a create, update or destroy
-action is because you want to to change to where it redirects, a shortcut is
+Since most of the time when you change a create, update or destroy
+action you do so because you want to to change its redirect url, a shortcut is 
 provided. So you can do:
 
     class ProjectsController < InheritedResources::Base
       def destroy
-        destroy!{ root_url }
+        destroy! { root_url }
       end
     end
 
@@ -243,7 +251,7 @@ but you don't want to create a before filter for it:
       end
     end
 
-Yes, that simple! The nice part is since you already set the instance variable
+Yes, it's that simple! The nice part is since you already set the instance variable
 @project, it will not build a project again.
 
 Before we finish this topic, we should talk about one more thing: "success/failure
@@ -262,7 +270,7 @@ Our first attempt to do this would be:
      end
     end
 
-Looks to verbose, right? We can actually do:
+Looks too verbose, right? We can actually do:
 
     class ProjectsController < InheritedResources::Base
       def update
@@ -273,7 +281,7 @@ Looks to verbose, right? We can actually do:
     end
 
 Much better! So explaining everything: when you give a block which expects one
-argument it will be executed in both scenarios: success and failure. But If you
+argument it will be executed in both scenarios: success and failure. But if you
 give a block that expects two arguments, the first will be executed only in
 success scenarios and the second in failure scenarios. You keep everything
 clean and organized inside the same action.
@@ -284,13 +292,13 @@ Although the syntax above is a nice shortcut, you won't need to do it frequently
 because (since version 1.2) Inherited Resources has smart redirects. Redirects
 in actions calculates depending on the existent controller methods.
 
-Redirects in create and update actions calculates in following order resource_url,
-collection_url, parent_url (which we are going to see later), root_url. Redirect
+Redirects in create and update actions calculates in the following order resource_url,
+collection_url, parent_url (which we are going to see later), and root_url. Redirect
 in destroy action calculate in following order collection_url, parent_url, root_url.
 
 Example:
 
-    class ButtonsConntroller < InheritedResources::Base
+    class ButtonsController < InheritedResources::Base
       belongs_to :window
       actions :all, :except => [:show, :index]
     end
@@ -352,7 +360,7 @@ If you need to configure any of these belongs to, you can nest them using blocks
 
 Warning: calling several belongs_to is the same as nesting them:
 
-    class CommentsConroller < InheritedResources::Base
+    class CommentsController < InheritedResources::Base
       belongs_to :project
       belongs_to :task
     end
@@ -459,7 +467,7 @@ And they handle everything for you. :)
     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
-    edit_resource_url(comment) #=>  /posts/1/comments/#{comment.to_param}/edit
+    edit_resource_url(comment) # => /posts/1/comments/#{comment.to_param}/edit
     collection_url             # => /posts/1/comments
     parent_url                 # => /posts/1
 
@@ -506,7 +514,7 @@ search_resources_{path,url} url helpers.
 
 == What about views?
 
-Sometimes just DRY the controllers is not enough, if you need to DRY up your views,
+Sometimes just DRYing up the controllers is not enough. If you need to DRY up your views,
 check this Wiki page:
 
 https://github.com/josevalim/inherited_resources/wiki/Views-Inheritance
@@ -531,11 +539,21 @@ And then you can rewrite the last example as:
       end
     end
 
+== Strong Parameters
+
+If your controller defines a method named permitted_params, Inherited Resources will call it where it would normally call params. This allows for easy integration with the strong_parameters gem:
+
+    def permitted_params
+      params.permit(:widget => [:permitted_field, :other_permitted_field])
+    end
+
+Note that this doesn't work if you use strong_parameters' require method instead of permit, because whereas permit returns the entire sanitized parameter hash, require returns only the sanitized params below the parameter you required.
+
 == Bugs and Feedback
 
 If you discover any bugs, please describe it in the issues tracker, including Rails and Inherited Resources versions.
 
 Questions are better handled on StackOverflow.
 
-Copyright (c) 2011 José Valim http://blog.plataformatec.com.br
+Copyright (c) 2009-2012 José Valim http://blog.plataformatec.com.br
 See the attached MIT License.

data/Rakefile

@@ -1,8 +1,8 @@
 # encoding: UTF-8
 
-require 'rake'
+require 'bundler/gem_tasks'
 require 'rake/testtask'
-require 'rake/rdoctask'
+require 'rdoc/task'
 
 desc 'Run tests for InheritedResources.'
 Rake::TestTask.new(:test) do |t|
@@ -19,3 +19,6 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('MIT-LICENSE')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+# Make test the default task.
+task :default => :test

data/inherited_resources.gemspec

@@ -16,9 +16,8 @@ Gem::Specification.new do |s|
 
   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"]
 
-  s.add_dependency("responders", "~> 0.6.0")
+  s.add_dependency("responders", "~> 0.9")
   s.add_dependency("has_scope",  "~> 0.5.0")
-end
+end

data/lib/inherited_resources/base_helpers.rb

@@ -67,7 +67,7 @@ module InheritedResources
       end
 
       # Responsible for updating the resource in :update method. This allow you
-      # to handle how the resource is gona be updated, let's say in a different
+      # to handle how the resource is going to be updated, let's say in a different
       # way then the usual :update_attributes:
       #
       #   def update_resource(object, attributes)
@@ -126,8 +126,16 @@ module InheritedResources
       # current resource).
       #
       def association_chain
-        @association_chain ||=
-          symbols_for_association_chain.inject([begin_of_association_chain]) do |chain, symbol|
+        return @association_chain if @association_chain
+
+        symbol_chain = if resources_configuration[:self][:singleton]
+          symbols_for_association_chain.reverse
+        else
+          symbols_for_association_chain
+        end
+
+        @association_chain =
+          symbol_chain.inject([begin_of_association_chain]) do |chain, symbol|
             chain << evaluate_parent(symbol, resources_configuration[symbol], chain.last)
           end.compact.freeze
       end
@@ -164,7 +172,6 @@ module InheritedResources
 
       # This methods gets your begin_of_association_chain, join it with your
       # parents chain and returns the scoped association.
-      #
       def end_of_association_chain #:nodoc:
         if chain = association_chain.last
           if method_for_association_chain
@@ -267,7 +274,7 @@ module InheritedResources
       # It's extend by HasScopeHelpers.
       #
       def apply_scopes_if_available(target_object) #:nodoc:
-        respond_to?(:apply_scopes) ? apply_scopes(target_object) : target_object
+        respond_to?(:apply_scopes, true) ? apply_scopes(target_object) : target_object
       end
 
       # Symbols chain in base helpers return nothing. This is later overwriten
@@ -292,27 +299,46 @@ module InheritedResources
         if respond_to? :index
           url ||= collection_url rescue nil
         end
-        if respond_to? :parent
+        if respond_to? :parent, true
           url ||= parent_url rescue nil
         end
         url ||= root_url rescue nil
       end
 
-      # extract attributes from params
+      # memoize the extraction of attributes from params
       def resource_params
-        rparams = [params[resource_request_name] || params[resource_instance_name] || {}]
-        rparams << as_role if role_given?
+        @resource_params ||= build_resource_params
+      end
+
+      # extract attributes from params
+      def build_resource_params
+        parameters = respond_to?(:permitted_params) ? permitted_params : params
+        rparams = [parameters[resource_request_name] || parameters[resource_instance_name] || {}]
+        if without_protection_given?
+          rparams << without_protection
+        else
+          rparams << as_role if role_given?
+        end
+
         rparams
       end
-      
+
       # checking if role given
       def role_given?
         self.resources_configuration[:self][:role].present?
       end
-      
+
       # getting role for mass-asignment
       def as_role
-         { :as => self.resources_configuration[:self][:role] }
+        { :as => self.resources_configuration[:self][:role] }
+      end
+
+      def without_protection_given?
+        self.resources_configuration[:self][:without_protection].present?
+      end
+
+      def without_protection
+        { :without_protection => self.resources_configuration[:self][:without_protection] }
       end
   end
 end

data/lib/inherited_resources/belongs_to_helpers.rb

@@ -74,13 +74,21 @@ module InheritedResources
         instantiated_object = instance_variable_get("@#{parent_config[:instance_name]}")
         return instantiated_object if instantiated_object
 
-        parent = if chain
-          chain.send(parent_config[:collection_name])
+        if parent_config[:singleton]
+          parent = if chain
+            chain.send(parent_config[:instance_name])
+          else
+            nil
+          end
         else
-          parent_config[:parent_class]
-        end
+          parent = if chain
+            chain.send(parent_config[:collection_name])
+          else
+            parent_config[:parent_class]
+          end
 
-        parent = parent.send(parent_config[:finder], params[parent_config[:param]])
+          parent = parent.send(parent_config[:finder], params[parent_config[:param]])
+        end
 
         instance_variable_set("@#{parent_config[:instance_name]}", parent)
       end

data/lib/inherited_resources/class_methods.rb

@@ -62,7 +62,7 @@ module InheritedResources
         create_resources_url_helpers!
       end
 
-      # Defines wich actions to keep from the inherited controller.
+      # Defines wich actions will be inherited from the inherited controller.
       # Syntax is borrowed from resource_controller.
       #
       #   actions :index, :show, :edit
@@ -145,13 +145,11 @@ module InheritedResources
 
         optional    = options.delete(:optional)
         shallow     = options.delete(:shallow)
-        singleton   = options.delete(:singleton)
         polymorphic = options.delete(:polymorphic)
         finder      = options.delete(:finder)
 
         include BelongsToHelpers if self.parents_symbols.empty?
 
-        acts_as_singleton!   if singleton
         acts_as_polymorphic! if polymorphic || optional
         acts_as_shallow!     if shallow
 
@@ -181,6 +179,7 @@ module InheritedResources
             nil
           end
 
+          config[:singleton]       = options.delete(:singleton) || false
           config[:collection_name] = options.delete(:collection_name) || symbol.to_s.pluralize.to_sym
           config[:instance_name]   = options.delete(:instance_name) || symbol
           config[:param]           = options.delete(:param) || :"#{symbol}_id"
@@ -259,7 +258,11 @@ module InheritedResources
       # Makes sense when using rails 3.1 mass assignment conventions
       def with_role(role)
         self.resources_configuration[:self][:role] = role.try(:to_sym)
-      end 
+      end
+
+      def without_protection(flag)
+        self.resources_configuration[:self][:without_protection] = flag
+      end
 
     private