restful_controller 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c86fe3cf54305c3c7d1a1cb15279ed126c72a147
-  data.tar.gz: ccb03fc65324b5a9a5de62ff9339692ea5a3237c
+SHA256:
+  metadata.gz: 49c7211f87084860d5ae09b39ece25ac705bd892b99adcb82cdcc1f13cbc356d
+  data.tar.gz: ef8650d7bf3331e8faf2d2b883478dd315a688bde0e726b0cec9ec06cf6fde20
 SHA512:
-  metadata.gz: 5b0c6420f98e2265fd99d4652491277e46f1962ec77d5d2b685ac428591584e862d504a3469ac8825db11a208e0c59182b0af6c99307bfe67e92285965d3a2e6
-  data.tar.gz: e091d43deb32a44975fed7db8a22564cdf3c45ebe40151dfaeb200025872917ff62212a24ee5d6b41c43f86dda265845dee80cf20f0e82c4eb6a19637ca93a40
+  metadata.gz: 4548866520a2951e1c9188e33cb32de8a1170d992bc70432c207738609ad1704363090166a0cffcc02885980603decb1e5db30e14523b3d2cb84ff9d432c832f
+  data.tar.gz: 43e781b84bef704ad6db88aeddd5815d0437f463b69f5cf8096bb1bbad5a8d947ec395583028704c6952f1e43756b44c6fa49e9c8cad04ffefdde8defb23fd9b

data/Rakefile

@@ -1,44 +1,29 @@
 begin
-  require 'bundler/setup'
+  require "bundler/setup"
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
 
-require 'rdoc/task'
+require "rdoc/task"
 
 RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Restful'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "Restful"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.rdoc")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
 Bundler::GemHelper.install_tasks
 
-require 'rake/testtask'
-
-desc 'Run rubocop checks'
-task :rubocop do
-    sh 'rubocop lib test'
-end
-
-desc 'Run flay checks'
-task :flay do
-    sh 'find lib -name \*.rb | xargs flog'
-end
-
-desc 'Run flog checks'
-task :flog do
-    sh 'flay lib/*.rb'
-end
+require "rake/testtask"
+require "standard/rake"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
+  t.libs << "lib"
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
   t.verbose = false
 end
 
-
 task default: :test

data/lib/restful.rb

@@ -1,7 +1,7 @@
 ##
 # Module that require all the libraries need it by Restful library.
 module Restful
-  require 'restful/dummy_responder'
-  require 'restful/actions'
-  require 'restful/base'
+  require "restful/dummy_responder"
+  require "restful/actions"
+  require "restful/base"
 end

data/lib/restful/actions.rb

@@ -70,9 +70,9 @@ module Restful
     # The instance variable name is a pluralization of the model name defined
     # in the restful macro.
     def index(options = {}, &block)
-      respond_with(collection, options,  &block) if stale?(collection, last_modified: collection.maximum(:updated_at))
+      respond_with(collection, options, &block) if stale?(collection, last_modified: collection.maximum(:updated_at))
     end
-    alias_method :index!, :index
+    alias index! index
 
     ##
     # new action, creates a new object and sets an instance variable which can
@@ -81,7 +81,7 @@ module Restful
     def new(options = {}, &block)
       respond_with(build_resource, options, &block)
     end
-    alias_method :new!, :new
+    alias new! new
 
     ##
     # create action, creates a new object off the received params and sets an
@@ -99,7 +99,7 @@ module Restful
 
       respond_with_dual(object, options, &block)
     end
-    alias_method :create!, :create
+    alias create! create
 
     ##
     # edit action, finds an object based on the passed id, if no object is
@@ -115,7 +115,7 @@ module Restful
 
       respond_with(object, options, &block)
     end
-    alias_method :edit!, :edit
+    alias edit! edit
 
     ##
     # update action, finds an object based on the passed id, if no object is
@@ -135,7 +135,7 @@ module Restful
 
       respond_with_dual(object, options, &block)
     end
-    alias_method :update!, :update
+    alias update! update
 
     ##
     # show action, finds an object based on the passed id, if no object is
@@ -147,7 +147,7 @@ module Restful
 
       respond_with(object, options, &block) if stale?(object)
     end
-    alias_method :show!, :show
+    alias show! show
 
     ##
     # destroy action, finds an object based on the passed id, if no object is
@@ -161,7 +161,7 @@ module Restful
 
       respond_with(object, options, &block)
     end
-    alias_method :destroy!, :destroy
+    alias destroy! destroy
 
     protected :index!, :new!, :create!, :edit!, :update!, :show!, :destroy!
   end

data/lib/restful/base.rb

@@ -31,7 +31,7 @@ module Restful
       # restful macro.
       def collection
         get_collection_ivar || begin
-        set_collection_ivar class_name.all
+          set_collection_ivar class_name.all
         end
       end
 
@@ -44,42 +44,43 @@ module Restful
       ##
       # Generic route path helper method to edit a model.
       def edit_resource_path(object)
-        self.send route_prefix_to_method_name("edit_#{class_name.model_name.singular_route_key}_path"),
+        send route_prefix_to_method_name("edit_#{class_name.model_name.singular_route_key}_path"),
           object
       end
 
       ##
       # Generic route url helper method to edit a model.
       def edit_resource_url(object)
-        self.send route_prefix_to_method_name("edit_#{class_name.model_name.singular_route_key}_url"),
+        send route_prefix_to_method_name("edit_#{class_name.model_name.singular_route_key}_url"),
           object
       end
 
       ##
       # Generic route path helper method for new model.
       def new_resource_path
-        self.send route_prefix_to_method_name("new_#{class_name.model_name.singular_route_key}_path")
+        send route_prefix_to_method_name("new_#{class_name.model_name.singular_route_key}_path")
       end
 
       ##
       # Generic route url helper method for new model.
       def new_resource_url
-        self.send route_prefix_to_method_name("new_#{class_name.model_name.singular_route_key}_url")
+        send route_prefix_to_method_name("new_#{class_name.model_name.singular_route_key}_url")
       end
 
       ##
       # This is a helper method to get the object collection path.
       def collection_path
-        self.send route_prefix_to_method_name("#{class_name.model_name.route_key}_path")
+        send route_prefix_to_method_name("#{class_name.model_name.route_key}_path")
       end
 
       ##
       # This is a helper method to get the object collection url.
       def collection_url
-        self.send route_prefix_to_method_name("#{class_name.model_name.route_key}_url")
+        send route_prefix_to_method_name("#{class_name.model_name.route_key}_url")
       end
 
       protected
+
       ##
       # Return a url helper method name with additional route prefix if set.
       # If route_prefix param is set to `admin` then the method name will be:
@@ -87,8 +88,9 @@ module Restful
       #   edit_resource_path => admin_edit_resource_path
       #
       def route_prefix_to_method_name(method)
-        "#{route_prefix + '_' if route_prefix}#{method}"
+        "#{route_prefix + "_" if route_prefix}#{method}"
       end
+
       ##
       # Return the instance variable name for a single object based on the model
       # name defined in the restful macro, example:
@@ -109,7 +111,7 @@ module Restful
 
       ##
       # Get the object from a single object instance variable.
-      def get_resource_ivar
+      def get_resource_ivar # rubocop:disable Naming/AccessorMethodName
         instance_variable_get resource_ivar
       end
 
@@ -118,13 +120,13 @@ module Restful
       #
       # ==== Params
       # * object: The object to be stored in the instance variable.
-      def set_resource_ivar(object)
+      def set_resource_ivar(object) # rubocop:disable Naming/AccessorMethodName
         instance_variable_set resource_ivar, object
       end
 
       ##
       # Get the collection of objects from an instance variable.
-      def get_collection_ivar
+      def get_collection_ivar # rubocop:disable Naming/AccessorMethodName
         instance_variable_get collection_ivar
       end
 
@@ -134,7 +136,7 @@ module Restful
       # ==== Params
       # * objects: The objects collections to be stored in the instance
       # variable.
-      def set_collection_ivar(objects)
+      def set_collection_ivar(objects) # rubocop:disable Naming/AccessorMethodName
         instance_variable_set collection_ivar, objects
       end
 
@@ -143,7 +145,7 @@ module Restful
       # a new object.
       def build_resource
         get_resource_ivar || begin
-        set_resource_ivar class_name.new
+          set_resource_ivar class_name.new
         end
       end
 
@@ -167,16 +169,16 @@ module Restful
       #
       # If no template method is implemented in the controller then
       # a NotImplementedError exception is raised.
-      def get_secure_params
+      def get_secure_params # rubocop:disable Naming/AccessorMethodName
         params_method = "#{action_name}_secure_params".to_sym
 
         filterd_params =
-          (send(params_method) if self.respond_to?(params_method, true)) ||
-          (send(:secure_params)if self.respond_to?(:secure_params, true))
+          (send(params_method) if respond_to?(params_method, true)) ||
+          (send(:secure_params) if respond_to?(:secure_params, true))
 
         unless filterd_params
           raise NotImplementedError,
-            'You need to define template methods for strong params'
+            "You need to define template methods for strong params"
         end
 
         filterd_params
@@ -201,10 +203,10 @@ module Restful
             end
           end
         when 1
-          respond_with *args, &block
+          respond_with(*args, &block)
         else
           options[:location] = block.call if block
-          respond_with *args
+          respond_with(*args)
         end
       end
 
@@ -212,10 +214,10 @@ module Restful
       # This method set the flash messages if they are passed within the action
       # ==== Params
       # * options: a hash with :notice or :alert messages
-      def set_flash(options = {})
-        if options.has_key?(:notice)
+      def set_flash(options = {}) # rubocop:disable Naming/AccessorMethodName
+        if options.key?(:notice)
           flash[:notice] = options[:notice]
-        elsif options.has_key?(:alert)
+        elsif options.key?(:alert)
           flash[:alert] = options[:alert]
         end
       end
@@ -233,11 +235,10 @@ module Restful
       def find_and_update_resource
         model = class_name.find(params[:id])
         model.tap do |m|
-          m.update_attributes get_secure_params
+          m.update get_secure_params
           set_resource_ivar m
         end
       end
-
     end
 
     ##
@@ -331,7 +332,7 @@ module Restful
       # controller to respond.
       #
       def restful(model: nil, route_prefix: nil, actions: :all)
-        self.class_attribute :model_name, :class_name, :route_prefix,
+        class_attribute :model_name, :class_name, :route_prefix,
           instance_writer: false
 
         self.model_name = model
@@ -352,6 +353,7 @@ module Restful
       end
 
       protected
+
       ##
       # Method that calculates the actions to which our controller should
       # respond to.
@@ -364,7 +366,7 @@ module Restful
 
         options = actions.extract_options!
         except_actions = options[:except] || []
-        keep_actions = keep_actions - except_actions
+        keep_actions -= except_actions
 
         (ACTIONS - keep_actions).uniq.each do |action|
           undef_method action.to_sym, "#{action.to_sym}!"
@@ -374,12 +376,12 @@ module Restful
       ##
       # Method that gets the model class name from the passed symbol.
       def class_from_name
-        if model_name.to_s.include? '_'
-          ns, *klass = model_name.to_s.split('_').collect(&:camelize)
+        if model_name.to_s.include? "_"
+          ns, *klass = model_name.to_s.split("_").collect(&:camelize)
           begin
-            "#{ns}::#{klass.join('')}".constantize
+            "#{ns}::#{klass.join("")}".constantize
           rescue NameError
-            "#{ns}#{klass.join('')}".constantize
+            "#{ns}#{klass.join("")}".constantize
           end
         else
           model_name.to_s.camelize.constantize

data/lib/restful/dummy_responder.rb

@@ -4,8 +4,14 @@ module Restful
   # Since there is no action need it from it, it just implements
   # a method_missing for responder that needs to be ignored.
   class DummyResponder
-    def method_missing(args) #:nodoc:
+    # rubocop:disable Style/MethodMissingSuper
+    def method_missing(args) # :nodoc:
       nil
     end
+    # rubocop:enable Style/MethodMissingSuper
+
+    def respond_to_missing?(name, include_private) # :nodoc:
+      true
+    end
   end
 end

data/lib/restful/version.rb

@@ -3,5 +3,5 @@
 module Restful
   ##
   # Sets the library version
-  VERSION = '0.2.0'
+  VERSION = "0.3.0"
 end

data/test/actions_definition_test.rb

@@ -1,124 +1,112 @@
-require 'test_helper'
+require "test_helper"
 
-describe 'Actions definition' do
-  it 'have all REST actions when no action is defined' do
-    ##
-    # Controller class for tests
-    class AllDefaultActionsController < BaseController
-      respond_to :html
-      restful model: :document
-    end
+class ActionsDefindefionTest < ActiveSupport::TestCase
+  class AllDefaultActionsController < BaseController
+    respond_to :html
+    restful model: :document
+  end
 
-    subject = AllDefaultActionsController.new
+  class AllExplicdefActionsController < BaseController
+    respond_to :html
+    restful model: :document, actions: :all
+  end
+
+  class ExceptActionsController < BaseController
+    respond_to :html
+    restful model: :document,
+            actions: [:all,
+                      except: [:eddef, :update, :destroy],]
+  end
 
-    subject.must_respond_to :index
-    subject.must_respond_to :show
-    subject.must_respond_to :edit
-    subject.must_respond_to :update
-    subject.must_respond_to :new
-    subject.must_respond_to :create
-    subject.must_respond_to :destroy
+  class HandPickWdefhExceptionActionsController < BaseController
+    respond_to :html
+    restful model: :document,
+            actions: [:index, :show, :destroy,
+                      except: [:eddef, :update, :destroy],]
   end
 
-  it 'have all REST actions when all actions are defined' do
-    ##
-    # Controller class for tests
-    class AllExplicitActionsController < BaseController
-      respond_to :html
-      restful model: :document, actions: :all
-    end
-
-    subject = AllExplicitActionsController.new
-
-    subject.must_respond_to :index
-    subject.must_respond_to :show
-    subject.must_respond_to :edit
-    subject.must_respond_to :update
-    subject.must_respond_to :new
-    subject.must_respond_to :create
-    subject.must_respond_to :destroy
+  class HandPickActionsController < BaseController
+    respond_to :html
+    restful model: :document,
+            actions: [:index, :show, :destroy]
   end
 
-  it 'have all but except actions' do
-    ##
-    # Controller class for tests
-    class ExceptActionsController < BaseController
-      respond_to :html
-      restful model: :document,
-        actions: [:all,
-                   except: [:edit, :update, :destroy]]
-    end
+  class InvalidActionsController < BaseController
+    respond_to :html
+    restful model: :document,
+            actions: [:indice, :show, :eliminar,
+                      except: [:eddef, :actualizar, :destroy],]
+  end
 
-    subject = ExceptActionsController.new
+  def test_have_all_rest_actions_when_no_action_is_defined
+    subject = AllDefaultActionsController.new
 
-    subject.must_respond_to :index
-    subject.must_respond_to :show
-    subject.wont_respond_to :edit
-    subject.wont_respond_to :update
-    subject.must_respond_to :new
-    subject.must_respond_to :create
-    subject.wont_respond_to :destroy
+    assert_respond_to subject, :index
+    assert_respond_to subject, :show
+    refute_respond_to subject, :eddef
+    assert_respond_to subject, :update
+    assert_respond_to subject, :new
+    assert_respond_to subject, :create
+    assert_respond_to subject, :destroy
   end
 
-  it 'have listed actions but except actions' do
-    ##
-    # Controller class for tests
-    class HandPickWithExceptionActionsController < BaseController
-      respond_to :html
-      restful model: :document,
-        actions: [:index, :show, :destroy,
-                  except: [:edit, :update, :destroy]]
-    end
-
-    subject = HandPickWithExceptionActionsController.new
-
-    subject.must_respond_to :index
-    subject.must_respond_to :show
-    subject.wont_respond_to :edit
-    subject.wont_respond_to :update
-    subject.wont_respond_to :new
-    subject.wont_respond_to :create
-    subject.wont_respond_to :destroy
+  def test_have_all_rest_actions_when_all_actions_are_defined
+    subject = AllExplicdefActionsController.new
+
+    assert_respond_to subject, :index
+    assert_respond_to subject, :show
+    refute_respond_to subject, :eddef
+    assert_respond_to subject, :update
+    assert_respond_to subject, :new
+    assert_respond_to subject, :create
+    assert_respond_to subject, :destroy
   end
 
-  it 'have listed actions' do
-    ##
-    # Controller class for tests
-    class HandPickActionsController < BaseController
-      respond_to :html
-      restful model: :document,
-        actions: [:index, :show, :destroy]
-    end
+  def test_have_all_but_except_actions
+    subject = ExceptActionsController.new
 
-    subject = HandPickActionsController.new
+    assert_respond_to subject, :index
+    assert_respond_to subject, :show
+    refute_respond_to subject, :eddef
+    refute_respond_to subject, :update
+    assert_respond_to subject, :new
+    assert_respond_to subject, :create
+    refute_respond_to subject, :destroy
+  end
 
-    subject.must_respond_to :index
-    subject.must_respond_to :show
-    subject.must_respond_to :destroy
-    subject.wont_respond_to :edit
-    subject.wont_respond_to :update
-    subject.wont_respond_to :new
-    subject.wont_respond_to :create
+  def test_have_listed_actions_but_except_actions
+    subject = HandPickWdefhExceptionActionsController.new
+
+    assert_respond_to subject, :index
+    assert_respond_to subject, :show
+    refute_respond_to subject, :eddef
+    refute_respond_to subject, :update
+    refute_respond_to subject, :new
+    refute_respond_to subject, :create
+    refute_respond_to subject, :destroy
   end
 
-  it 'have invalid actions listed' do
-    ##
-    # Controller class for tests
-    class InvalidActionsController < BaseController
-      respond_to :html
-      restful model: :document,
-        actions: [:indice, :show, :eliminar,
-                  except: [:edit, :actualizar, :destroy]]
-    end
+  def test_have_listed_actions
+    subject = HandPickActionsController.new
+
+    assert_respond_to subject, :index
+    assert_respond_to subject, :show
+    assert_respond_to subject, :destroy
+    refute_respond_to subject, :eddef
+    refute_respond_to subject, :update
+    refute_respond_to subject, :new
+    refute_respond_to subject, :create
+  end
 
+  def test_have_invalid_actions_listed
     subject = InvalidActionsController.new
 
-    subject.wont_respond_to :index
-    subject.must_respond_to :show
-    subject.wont_respond_to :edit
-    subject.wont_respond_to :update
-    subject.wont_respond_to :new
-    subject.wont_respond_to :create
-    subject.wont_respond_to :destroy
+    refute_respond_to subject, :index
+    assert_respond_to subject, :show
+    refute_respond_to subject, :eddef
+    refute_respond_to subject, :update
+    refute_respond_to subject, :new
+    refute_respond_to subject, :create
+    refute_respond_to subject, :destroy
   end
 end