inherited_resources 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df31765cf3b996812936adaeb26f33e4e387b55a
-  data.tar.gz: b4da9990905f738c3d77c277e3581b2e8d0d142e
+  metadata.gz: e6392aaded1e0d085dc72577ecbc0793327b6a00
+  data.tar.gz: d4891c303bae5e1255a5a74b580a1cfb0162f5d9
 SHA512:
-  metadata.gz: 6a67fcd38ac5d44035110616ef92a76b5c96eff5c0ed70c218ccba2198d95490c2f4ec89635424edbbd3b53057e0bffc6e0b3a47a4997fd9d3ac079182bcaed0
-  data.tar.gz: 571dff6d8493a3a5596d9eb5020a8da9e3e303d903ac4a5de2763e876e4816e7c97144ec241ace3b3c90ca48f27863b17d5b2b479836cb77292e2051dbec6139
+  metadata.gz: 034f81e33b0c640c9f4ca86499b7a9869fced0a34d278ce89b73e146c96ed2a0dece341bbe398de25b68c54add3142395f71224c15ecc01dd039cf435726669d
+  data.tar.gz: 606ca852e3a8b8a548e1edb65500dd7491dd692498298aaf12b555b036778334f442d98cbf04b030641abc7f033fe7d2f99105e3822c92c55b83aacb1b1b2a50

data/CHANGELOG

@@ -1,3 +1,8 @@
+# 1.5.0
+
+* Supports nested modules (namespaced models and controllers).
+* Supports Rails 4 Strong Parameters notation.
+
 # Version 1.4.1
 
 * Supports Rails 4

data/Gemfile

@@ -5,3 +5,7 @@ gemspec
 gem 'rails', '>= 3.2', '< 5'
 gem 'mocha'
 gem 'turn'
+
+group :test do
+  gem 'strong_parameters'
+end

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    inherited_resources (1.4.0)
+    inherited_resources (1.5.0)
       has_scope (~> 0.6.0.rc)
-      responders (~> 1.0.0.rc)
+      responders (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -69,7 +69,7 @@ GEM
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
     rake (10.1.0)
-    responders (1.0.0.rc)
+    responders (1.1.0)
       railties (>= 3.2, < 5)
     sprockets (2.10.0)
       hike (~> 1.2)
@@ -80,6 +80,10 @@ GEM
       actionpack (>= 3.0)
       activesupport (>= 3.0)
       sprockets (~> 2.8)
+    strong_parameters (0.1.4)
+      actionpack (>= 3.2.0)
+      activemodel (>= 3.2.0)
+      railties (>= 3.2.0)
     thor (0.18.1)
     thread_safe (0.1.2)
       atomic
@@ -98,4 +102,5 @@ DEPENDENCIES
   inherited_resources!
   mocha
   rails (>= 3.2, < 5)
+  strong_parameters
   turn

data/README.md

@@ -52,9 +52,7 @@ http://github.com/josevalim/inherited_resources/tree/v1.0
 Since Inherited Resources 1.0, has_scope is not part of its core anymore but
 a gem dependency. Be sure to check the documentation to see how you can use it:
 
-```
-http://github.com/plataformatec/has_scope
-```
+- <http://github.com/plataformatec/has_scope>
 
 And it can be installed as:
 
@@ -69,9 +67,7 @@ but is set as Inherited Resources dependency and it's used by default by
 InheritedResources controllers. Be sure to check the documentation to see
 how it will change your application:
 
-```
-http://github.com/plataformatec/responders
-```
+- <http://github.com/plataformatec/responders>
 
 And it can be installed with:
 
@@ -166,7 +162,7 @@ One reason to use the `inherit_resources` macro would be to ensure that your con
 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:
+you will have to write it this way:
 
 ```ruby
 class AccountsController < ApplicationController
@@ -266,7 +262,7 @@ end
 ```
 
 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
+action you do so because you want to change its redirect url, a shortcut is
 provided. So you can do:
 
 ```ruby
@@ -315,6 +311,18 @@ end
 Yes, it's that simple! The nice part is since you already set the instance variable
 `@project`, it will not build a project again.
 
+Same goes for updating the project:
+
+```ruby
+class ProjectsController < InheritedResources::Base
+  def update
+    @project = Project.find(params[:id])
+    @project.something_special!
+    update!
+  end
+end
+```
+
 Before we finish this topic, we should talk about one more thing: "success/failure
 blocks". Let's suppose that when we update our project, in case of failure, we
 want to redirect to the project url instead of re-rendering the edit template.
@@ -638,9 +646,8 @@ index actions accordingly). Also, it will produce `delete_resource_{path,url}` a
 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
-```
+
 
 Notice that Rails 3.1 ships with view inheritance built-in.
 
@@ -678,6 +685,8 @@ def permitted_params
 end
 ```
 
+Remember that if your field is sent by client to server as an array, you have to write `:permitted_field => []`, not just `:permitted_field`.
+
 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
@@ -687,7 +696,7 @@ If you need `params.require` you can do it like this:
 
 ```ruby
 def permitted_params
-  {:widget => params.require(:widget => [:permitted_field, :other_permitted_field])}
+  {:widget => params.fetch(:widget, {}).permit(:permitted_field, :other_permitted_field)}
 end
 ```
 
@@ -695,10 +704,22 @@ Or better yet just override `#build_resource_params` directly:
 
 ```ruby
 def build_resource_params
-  [params.require(:widget => [:permitted_field, :other_permitted_field])]
+  [params.fetch(:widget, {}).permit(:permitted_field, :other_permitted_field)]
+end
+```
+
+
+Instead you can stick to a standard Rails 4 notation (as rails scaffold generates) and write:
+
+```ruby
+def widget_params
+  params.require(:widget).permit(:permitted_field, :other_permitted_field)
 end
 ```
 
+In such case you should remove #permitted_params method because it has greater priority.
+
+
 ## Bugs and Feedback
 
 If you discover any bugs, please describe it in the issues tracker, including Rails and InheritedResources versions.

data/inherited_resources.gemspec

@@ -7,10 +7,9 @@ Gem::Specification.new do |s|
   s.version     = InheritedResources::VERSION.dup
   s.platform    = Gem::Platform::RUBY
   s.summary     = "Inherited Resources speeds up development by making your controllers inherit all restful actions so you just have to focus on what is important."
-  s.email       = "developers@plataformatec.com.br"
   s.homepage    = "http://github.com/josevalim/inherited_resources"
   s.description = "Inherited Resources speeds up development by making your controllers inherit all restful actions so you just have to focus on what is important."
-  s.authors     = ['José Valim']
+  s.authors     = ['José Valim', 'Joel Moss']
   s.license     = "MIT"
 
   s.rubyforge_project = "inherited_resources"
@@ -19,6 +18,6 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.require_paths = ["lib"]
 
-  s.add_dependency("responders", "~> 1.0.0.rc")
+  s.add_dependency("responders", "~> 1.0")
   s.add_dependency("has_scope",  "~> 0.6.0.rc")
 end

data/lib/inherited_resources/base_helpers.rb

@@ -51,7 +51,7 @@ module InheritedResources
         get_resource_ivar || set_resource_ivar(end_of_association_chain.send(method_for_find, params[:id]))
       end
 
-      # This method is responsable for building the object on :new and :create
+      # This method is responsible for building the object on :new and :create
       # methods. If you overwrite it, don't forget to cache the result in an
       # instance variable.
       #
@@ -316,9 +316,44 @@ module InheritedResources
         @resource_params ||= build_resource_params
       end
 
+      def resource_params_method_name
+        "#{resource_instance_name}_params"
+      end
+
+      # Returns hash of sanitized params in a form like
+      # `{:project => {:project_attribute => 'value'}}`
+      #
+      # This method makes use of `project_params` (or `smth_else_params`) which
+      # is a default Rails controller method for strong parameters definition.
+      #
+      # `permitted_params` is usually fired by method :new, :create, :update
+      # actions. Action :new usually has no parameters so strong parameters
+      # `require` directive raises a +ActionController::ParameterMissing+
+      # exception. `#permitted_params` rescues such exceptions in :new and
+      # returns an empty hash of parameters (which is reasonable default).
+      # If for any reasons you need something more specific, you can redefine
+      # this method in a way previous `inherited_resources` versions did:
+      #
+      #    # Unnecessary redefinition
+      #    def permitted_params
+      #      params.permit(:project => [:project_attribute])
+      #    end
+      #
+      def permitted_params
+        return nil  unless respond_to?(resource_params_method_name, true)
+        {resource_request_name => send(resource_params_method_name)}
+      rescue ActionController::ParameterMissing
+        # typically :new action
+        if params[:action].to_s == 'new'
+          {resource_request_name => {}}
+        else
+          raise
+        end
+      end
+
       # extract attributes from params
       def build_resource_params
-        parameters = respond_to?(:permitted_params, true) ? permitted_params : params
+        parameters = permitted_params || params
         rparams = [parameters[resource_request_name] || parameters[resource_instance_name] || {}]
         if without_protection_given?
           rparams << without_protection

data/lib/inherited_resources/class_methods.rb

@@ -171,13 +171,34 @@ module InheritedResources
 
           config = self.resources_configuration[symbol] = {}
 
-          config[:parent_class] = options.delete(:parent_class) || begin
-            class_name = (options.delete(:class_name) || symbol).to_s.pluralize.classify
-            class_name.constantize
-          rescue NameError => e
-            raise unless e.message.include?(class_name)
-            nil
-          end
+          class_name = ''
+          config[:parent_class] = options.delete(:parent_class) ||
+            begin
+              class_name = if options[:class_name]
+                options.delete(:class_name).to_s.pluralize.classify
+              else
+                namespace = self.name.deconstantize
+                model_name = symbol.to_s.pluralize.classify
+
+                klass = model_name
+                while namespace != ''
+                  klass = "#{namespace}::#{model_name}"
+                  if klass.safe_constantize
+                    break
+                  else
+                    namespace = namespace.deconstantize
+                  end
+                end
+
+                klass = model_name if klass.start_with?('::')
+
+                klass
+              end
+              class_name.constantize
+            rescue NameError => e
+              raise unless e.message.include?(class_name)
+              nil
+            end
 
           config[:singleton]       = options.delete(:singleton) || false
           config[:collection_name] = options.delete(:collection_name) || symbol.to_s.pluralize.to_sym
@@ -229,13 +250,13 @@ module InheritedResources
       # * <tt>:resource</tt> -  Allows you to specify resource actions.
       #     custom_actions :resource => :delete
       #                         This macro creates 'delete' method in controller and defines
-      #                         delete_reource_{path,url} helpers. The body of generated 'delete'
+      #                         delete_resource_{path,url} helpers. The body of generated 'delete'
       #                         method is same as 'show' method. So you can override it if need
       #
       # * <tt>:collection</tt> - Allows you to specify collection actions.
       #     custom_actions :collection => :search
       #                         This macro creates 'search' method in controller and defines
-      #                         search_reources_{path,url} helpers. The body of generated 'search'
+      #                         search_resources_{path,url} helpers. The body of generated 'search'
       #                         method is same as 'index' method. So you can override it if need
       #
       def custom_actions(options)

data/lib/inherited_resources/version.rb

@@ -1,3 +1,3 @@
 module InheritedResources
-  VERSION = '1.4.1'.freeze
+  VERSION = '1.5.0'.freeze
 end

data/test/class_methods_test.rb

@@ -23,6 +23,17 @@ class DeansController < InheritedResources::Base
   belongs_to :school
 end
 
+module Library
+  class Category
+  end
+
+  class Subcategory
+  end
+
+  class SubcategoriesController < InheritedResources::Base
+  end
+end
+
 class ActionsClassMethodTest < ActionController::TestCase
   tests BooksController
 
@@ -108,7 +119,7 @@ class BelongsToErrorsTest < ActiveSupport::TestCase
 
   def test_belongs_to_raises_an_error_when_multiple_associations_are_given_with_options
     assert_raise ArgumentError do
-      DeansController.send(:belongs_to, :arguments, :with_options, :parent_class => Professor)
+      DeansController.send(:belongs_to, :arguments, :with_options, :parent_class => Book)
     end
   end
 
@@ -131,4 +142,14 @@ class BelongsToErrorsTest < ActiveSupport::TestCase
   ensure
     DeansController.send(:parents_symbols=, [:school])
   end
+
+  def test_belongs_to_for_namespaced_controller_and_namespaced_model_fetches_model_in_the_namespace_firstly
+    Library::SubcategoriesController.send(:belongs_to, :category)
+    assert_equal Library::Category, Library::SubcategoriesController.resources_configuration[:category][:parent_class]
+  end
+
+  def test_belongs_to_without_namespace_sets_parent_class_properly
+    FoldersController.send(:belongs_to, :book)
+    assert_equal Book, FoldersController.resources_configuration[:book][:parent_class]
+  end
 end

data/test/strong_parameters_test.rb

@@ -1,5 +1,9 @@
 require File.expand_path('test_helper', File.dirname(__FILE__))
 
+if ActionPack::VERSION::MAJOR == 3
+  require 'strong_parameters'
+end
+
 class Widget
   extend ActiveModel::Naming
 end
@@ -7,6 +11,7 @@ end
 class WidgetsController < InheritedResources::Base
 end
 
+# test usage of `permitted_params`
 class StrongParametersTest < ActionController::TestCase
   def setup
     @controller = WidgetsController.new
@@ -34,4 +39,82 @@ class StrongParametersTest < ActionController::TestCase
     Widget.expects(:find).with('42').returns(mock_widget)
     put :update, :id => '42', :widget => {:permitted => 'param', :prohibited => 'param'}
   end
-end
+
+  # `permitted_params` has greater priority than `widget_params`
+  def test_with_permitted_and_resource_methods
+      @controller.stubs(:widget_params).returns(:permitted => 'another_param')
+      class << @controller
+        private :widget_params
+      end
+      Widget.expects(:new).with(:permitted => 'param')
+      get :new, :widget => { :permitted => 'param', :prohibited => 'param' }
+  end
+end
+
+# test usage of `widget_params`
+class StrongParametersWithoutPermittedParamsTest < ActionController::TestCase
+  def setup
+    @controller = WidgetsController.new
+    @controller.stubs(:widget_url).returns("/")
+    @controller.stubs(:widget_params).returns(:permitted => 'param')
+    class << @controller
+      private :widget_params
+    end
+  end
+
+  def test_permitted_params_from_new
+    Widget.expects(:new).with(:permitted => 'param')
+    get :new, :widget => { :permitted => 'param', :prohibited => 'param' }
+  end
+
+  def test_permitted_params_from_create
+    Widget.expects(:new).with(:permitted => 'param').returns(mock(:save => true))
+    post :create, :widget => { :permitted => 'param', :prohibited => 'param' }
+  end
+
+  def test_permitted_params_from_update
+    mock_widget = mock
+    mock_widget.stubs(:class).returns(Widget)
+    mock_widget.expects(:update_attributes).with(:permitted => 'param')
+    Widget.expects(:find).with('42').returns(mock_widget)
+    put :update, :id => '42', :widget => {:permitted => 'param', :prohibited => 'param'}
+  end
+end
+
+# test usage of `widget_params` integrated with strong parameters (not using stubs)
+class StrongParametersIntegrationTest < ActionController::TestCase
+  def setup
+    @controller = WidgetsController.new
+    @controller.stubs(:widget_url).returns("/")
+
+    class << @controller
+      define_method :widget_params do
+        params.require(:widget).permit(:permitted)
+      end
+      private :widget_params
+    end
+  end
+
+  def test_permitted_empty_params_from_new
+    Widget.expects(:new).with({})
+    get :new, {}
+  end
+
+  def test_permitted_params_from_new
+    Widget.expects(:new).with('permitted' => 'param')
+    get :new, :widget => { :permitted => 'param', :prohibited => 'param' }
+  end
+
+  def test_permitted_params_from_create
+    Widget.expects(:new).with('permitted' => 'param').returns(mock(:save => true))
+    post :create, :widget => { :permitted => 'param', :prohibited => 'param' }
+  end
+
+  def test_permitted_params_from_update
+    mock_widget = mock
+    mock_widget.stubs(:class).returns(Widget)
+    mock_widget.expects(:update_attributes).with('permitted' => 'param')
+    Widget.expects(:find).with('42').returns(mock_widget)
+    put :update, :id => '42', :widget => {:permitted => 'param', :prohibited => 'param'}
+  end
+end

metadata

@@ -1,51 +1,52 @@
 --- !ruby/object:Gem::Specification
 name: inherited_resources
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - José Valim
+- Joel Moss
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-31 00:00:00.000000000 Z
+date: 2014-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: responders
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: has_scope
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.6.0.rc
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.6.0.rc
 description: Inherited Resources speeds up development by making your controllers
   inherit all restful actions so you just have to focus on what is important.
-email: developers@plataformatec.com.br
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - CHANGELOG
 - Gemfile
 - Gemfile.lock
@@ -179,17 +180,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: inherited_resources
-rubygems_version: 2.0.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Inherited Resources speeds up development by making your controllers inherit
@@ -294,4 +295,3 @@ test_files:
 - test/views/users/update.js.erb
 - test/views/venue/show.html.erb
 - test/views/widgets/new.html.erb
-has_rdoc: