rescue-dog 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e2a7f7faf7befcd8fb279f982baa669fcf66964
-  data.tar.gz: 21ea12236b212cc34badb3351fe6892bff346f42
+  metadata.gz: 94b0003e3a52320379af227d77392979bc89d0da
+  data.tar.gz: 9a998aedbc2b68dd06211713b6b4306d32d40ab8
 SHA512:
-  metadata.gz: cbfc2e1db3316d00f46c99ebf4a79c2e5b24e0e4cfc16512e2ce095da21b3c2927de1d0caa3ce556e590b3a16845a402782b44ab6be160729c3452654bcbbd89
-  data.tar.gz: b43644434d7c85cc0e5c1835b8a92c3769443a5f4bcafc610640a77b894f2e149ac09efde1d77c5ed32a93a86e27cf160cada1104be73239dc47f26258ad285c
+  metadata.gz: 5430d1c18141a9f6cff373f5b98efcf6c1cd4dbb7aa6cd877c963c57f6fee11b93e2ff49a6f0eae3ae096e6533b6b49af1432a31f1cba4e860332c686cda67e4
+  data.tar.gz: 178688de7e29b2fdbfd99e191a4681b69e3a2bca222635e251284f7215ec6afeed236a43f517fc1527c72ddffad87430e78f51048a8ec31e5e97c4c82330870a

data/.travis.yml

@@ -5,6 +5,7 @@ rvm:
   - 2.0.0
   - ruby-head
   - jruby-19mode
+  - jruby-20mode
   - jruby-head
   - rbx-19mode
 matrix:

data/README.md

@@ -26,19 +26,73 @@ Or install it yourself as:
 $ gem install rescue-dog
 ```
 
-## Simple CRUD Actions
+## Declare CRUD Actions
 
 1. Include `Rescue::Controller` (Rescue::Controller::Static` or `Rescue::Controller::Dynamic`).
 2. Call `rescue_controller` method.
+3. Declare `xxx_params` method. (cf. Rails 4 / Strong Parameters)
 
-### Define Actions
+### Simple CRUD Actions
 
 ```ruby
 class UsersController < ApplicationController
   rescue_controller User, :new, :edit, :show,
     create: { render: lambda { redirect_to edit_user_path(@user) } ,rescue: lambda { render :new  } },
     update: { render: lambda { redirect_to edit_user_path(@user) } ,rescue: lambda { render :edit } },
-    delete: { render: lambda { redirect_to root_path }             ,rescue: lambda { render :edit } }
+    destroy: { render: lambda { redirect_to root_path }             ,rescue: lambda { render :edit } }
+
+  ...
+
+  private
+  def create_params
+    params.require(:user).permit(
+      :name, :email, :password
+    )
+  end
+
+  def update_params
+    params.require(:user).permit(
+      :email, :password
+    )
+  end
+
+  # Destroyed condition variable object
+  def destroy_params
+    { id: params[:id] }
+  end
+end
+```
+
+### Customized Actions
+
+```ruby
+class UsersController < ApplicationController
+  rescue_controller User, :new, :edit, :show
+
+  def create
+    rescue_respond(:customized_create_call, create_params,
+      render: lambda { redirect_to edit_user_path(@user) },
+      rescue: lambda { render :new  } }
+    )
+  end
+
+  private
+  def create_params
+    params.require(:user).permit(
+      :name, :email, :password
+    )
+  end
+
+  def customized_create_call params
+    if User.exists?(params)
+      raise UserDuplicationError, "your email is duplicated!"
+    else
+      @user = User.new(params)
+      @user.save!
+    end
+  end
+
+end
 ```
  
 ## Render Errors

data/lib/rescue/controller.rb

@@ -4,6 +4,7 @@ module Rescue
 
     def self.included(base)
       base.extend Rescue::Controller::ClassMethods
+      base.send(:private, :rescue_respond)
     end
 
     def rescue_respond call, params, options = {}

data/lib/rescue/controllers/action.rb

@@ -31,7 +31,7 @@ module Rescue
         names.each do |name|
           options = args[name]||{}
           type    = options[:type]||name
-          raise RuntimeError "`name` is already defined." if object.private_method_defined?(name)
+          raise RuntimeError, "`#{name}` is already defined." if object.method_defined?(name)
           case type
           when :show, :edit
             object.send(:define_method, name) do
@@ -46,11 +46,15 @@ module Rescue
             end
           when :create, :update, :destroy
             object.send(:define_method, name) do
-              params = send(options[:params]||:"#{name}_params")
-              rescue_respond(:"#{type}_call", params, options)
+              begin 
+                params = send(options[:params]||:"#{name}_params")
+                rescue_respond(:"#{type}_call", params, options)
+              rescue NoMethodError => e
+                raise NoParameterMethodError.new(self.class, e.name)
+              end
             end
           else
-            raise RuntimeError "Undefined action type `#{type}`."
+            raise Rescue::NoActionError.new(type)
           end
         end
       end

data/lib/rescue/errors.rb

@@ -0,0 +1,16 @@
+module Rescue
+  
+
+  class NoActionError < ArgumentError
+    def initialize type
+      super "Undefined `#{type}` type. Please specify :show, :edit, :new, :create, :update, or :destory on the :type argument."
+    end
+  end
+
+  class NoParameterMethodError < NoMethodError
+    def initialize clazz, name
+      super "Undefined method `#{name}` for #{clazz.name}. Please define private method `#{name}` to return the permissible parameters."
+    end
+  end
+
+end

data/lib/rescue/version.rb

@@ -1,3 +1,3 @@
 module Rescue
-  VERSION = "0.3.4"
+  VERSION = "0.3.5"
 end

data/lib/rescue-dog.rb

@@ -6,6 +6,7 @@ require "rescue/controllers/action.rb"
 require "rescue/controllers/flash.rb"
 require 'rescue/exceptions/application_error.rb'
 require 'rescue/exceptions/respond_error.rb'
+require 'rescue/errors.rb'
 
 module Rescue
   class Bind

data/rescue-dog.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   gem.version       = Rescue::VERSION
   gem.authors       = ["yulii"]
   gem.email         = ["yuliinfo@gmail.com"]
-  gem.description   = %q{respond to an exception raised in Rails}
-  gem.summary       = %q{define respond methods}
+  gem.description   = %q{Responds status and error handling for Rails}
+  gem.summary       = %q{Declare simple CRUD and respond error methods}
   gem.homepage      = "https://github.com/yulii/rescue-dog"
   gem.license       = 'MIT'
 

data/spec/rescue/controller_spec.rb

@@ -3,19 +3,19 @@ require 'spec_helper'
 
 describe Rescue::Controller do
 
-  let(:object) do
+  let(:controller) do
     Class.new ApplicationController do
       include Rescue::Controller
       rescue_controller RescueModel,
         show: [:show_action],
         edit: [:edit_action],
         new:  [:new_action],
-        create:  { render: lambda { } ,rescue: lambda { } },
-        update:  { render: lambda { } ,rescue: lambda { } },
-        destroy: { render: lambda { } ,rescue: lambda { } },
-        create_action:  { type: :create  ,render: lambda { } ,rescue: lambda { } },
-        update_action:  { type: :update  ,render: lambda { } ,rescue: lambda { } },
-        destroy_action: { type: :destroy ,render: lambda { } ,rescue: lambda { } }
+        create:  { render: lambda { } ,rescue: lambda { raise $! } },
+        update:  { render: lambda { } ,rescue: lambda { raise $! } },
+        destroy: { render: lambda { } ,rescue: lambda { raise $! } },
+        create_action:  { type: :create  ,render: lambda { } ,rescue: lambda { raise $! } ,params: :customized_params },
+        update_action:  { type: :update  ,render: lambda { } ,rescue: lambda { raise $! } ,params: :customized_params },
+        destroy_action: { type: :destroy ,render: lambda { } ,rescue: lambda { raise $! } ,params: :customized_params }
 
       def customized_create_action
         rescue_respond(:create_call, create_params,
@@ -26,7 +26,7 @@ describe Rescue::Controller do
 
       def customized_update_action
         rescue_respond(:update_call, update_params,
-          render: lambda { return true },
+          render: lambda { },
           rescue: lambda { }
         )
       end
@@ -37,76 +37,129 @@ describe Rescue::Controller do
           rescue: lambda { }
         )
       end
+
+      def execute
+        rescue_respond(:execute_call, execute_params,
+          render: lambda { },
+          rescue: lambda { }
+        )
+      end
     end
   end
 
-  it "should be defined `rescue_respond`" do
-    expect(object.method_defined? :rescue_respond).to be_true
+  # Stub: flash object
+  let(:flash) do
+    flash = Hash.new
+    flash.stub(:now).and_return({})
+    flash
   end
 
   [:rescue_associate, :rescue_controller].each do |name|
-    it "should be able to call method `#{name}`" do
-      expect(object.public_methods.include? name).to be_true
+    it "should declare `#{name}` method" do
+      expect(controller.public_methods.include? name).to be_true
+    end
+  end
+
+  [ :rescue_respond,
+    :find_call, :new_call, :create_call, :update_call, :destroy_call].each do |name|
+    it "should declare `#{name}` method as private" do
+      expect(controller.private_instance_methods.include? name).to be_true
+    end
+  end
+
+  [ :new, :edit, :show, :create, :update, :destroy,
+    :show_action, :edit_action, :new_action,
+    :create_action, :update_action, :destroy_action ].each do |name|
+    it "should declare `#{name}` method as public" do
+      expect(controller.public_instance_methods.include? name).to be_true
     end
   end
 
+  context "when action is executed" do
+    let(:object) do
+      object = controller.new
+      # Stub: flash message
+      object.stub(:flash).and_return(flash)
+      # Stub: controller/action name for flash messages
+      object.stub(:controller_path).and_return('')
+      object.stub(:controller_name).and_return('')
+      object.stub(:action_name).and_return('')
+  
+      # Stub: parameter methods
+      object.stub(:create_params).and_return({})
+      object.stub(:update_params).and_return({})
+      object.stub(:destroy_params).and_return({})
+      object.stub(:execute_params).and_return({})
+      object.stub(:customized_params).and_return({})
+  
+      # Stub: call methods
+      object.stub(:find_call).with(any_args()).and_raise('find_call execute')
+      object.stub(:new_call).and_raise('new_call execute')
+      object.stub(:create_call).and_raise('create_call execute')
+      object.stub(:update_call).and_raise('update_call execute')
+      object.stub(:destroy_call).and_raise('destroy_call execute')
+      object.stub(:execute_call).and_raise()
+      object
+    end
+
+    # Action Type Relation
+    { find:    [:show, :edit, :show_action, :edit_action],
+      new:     [:new, :new_action],
+      create:  [:create, :create_action],
+      update:  [:update, :update_action],
+      destroy: [:destroy, :destroy_action] 
+      }.each do |type, names|
+      names.each do |name|
+        it "should run `#{type}_call` when `#{name}` is executed" do
+          expect { object.send(name) }.to raise_error(RuntimeError, "#{type}_call execute")
+        end
+      end
+    end
+
+    #it "should be performed within 500 microseconds" do
+    #  n = 10000
+    #  measure = Benchmark.measure do
+    #    n.times { object.execute }
+    #  end
+    #  expect(measure.total).to be < (500 * 1.0e-06 * n)
+    #end
+  end
 
   describe "#rescue_respond" do
     let(:object) do
       clazz = Class.new ApplicationController do
         include Rescue::Controller
+
+        # Subjects
+        def render_execute
+          rescue_respond(:stub_call, {},
+            render: lambda { 'render' },
+            rescue: lambda { 'rescue' }
+          )
+        end
+
+        def rescue_execute
+          rescue_respond(:stub_call, {},
+            render: lambda { raise RuntimeError },
+            rescue: lambda { 'rescue' }
+          )
+        end
       end
+
       object = clazz.new
-      object.stub(:flash).and_return({})
+      object.stub(:flash).and_return(flash)
       object.stub(:controller_path).and_return('rescue')
       object.stub(:action_name).and_return('action')
       object.stub(:stub_call).with({}).and_return(nil)
       object
     end
 
-    it "should be able to render" do
-      expect(
-        object.send(:rescue_respond, :stub_call, {},
-          render: lambda { return 'render' },
-          rescue: lambda { return 'rescue' })
-      ).to eq('render')
+    it "should render with no error" do
+      expect(object.render_execute).to eq('render')
     end
 
-  end
-
-  describe Rescue::Controller::ClassMethods do
-    describe "#rescue_controller" do
-
-      let(:object) do
-        Class.new ApplicationController do
-          extend Rescue::Controller::ClassMethods
-          rescue_controller RescueModel,
-            show: [:show_action],
-            edit: [:edit_action],
-            new:  [:new_action],
-            create:  { render: lambda { } ,rescue: lambda { } },
-            update:  { render: lambda { } ,rescue: lambda { } },
-            destroy: { render: lambda { } ,rescue: lambda { } },
-            create_action:  { type: :create  ,render: lambda { } ,rescue: lambda { } },
-            update_action:  { type: :update  ,render: lambda { } ,rescue: lambda { } },
-            destroy_action: { type: :destroy ,render: lambda { } ,rescue: lambda { } }
-        end
-      end
-
-      [:find_call, :new_call, :create_call, :update_call, :destroy_call].each do |name|
-        it "should be defined private method `#{name}`" do
-          expect(object.private_instance_methods.include? name).to be_true
-        end
-      end
-  
-      [ :new, :edit, :show, :create, :update, :destroy,
-        :show_action, :edit_action, :new_action,
-        :create_action, :update_action, :destroy_action ].each do |name|
-        it "should be defined public method `#{name}`" do
-          expect(object.public_instance_methods.include? name).to be_true
-        end
-      end
-
+    it "should render by the rescue block" do
+      expect(object.rescue_execute).to eq('rescue')
     end
   end
 

data/spec/rescue/controllers/action_spec.rb

@@ -17,7 +17,7 @@ describe Rescue::Controller::Action do
     clazz
   end
 
-  describe "#define" do
+  describe "#define_call" do
     let(:controller) do # Fake Controller
       clazz = model
       Class.new do
@@ -27,7 +27,6 @@ describe Rescue::Controller::Action do
   
     let(:object) do
       object = controller.new
-      object.stub(:rescuemodel_params).and_return({})
       object.stub(:params).and_return({})
       object
     end
@@ -35,15 +34,96 @@ describe Rescue::Controller::Action do
     let(:params) { {} }
   
     [:find_call, :new_call, :create_call, :update_call, :destroy_call].each do |name|
-      it "should be defined private method `#{name}`" do
+      it "should declare `#{name}` method as private" do
         expect(controller.private_instance_methods.include? name).to be_true
       end
       it "should not raise error" do
         expect { object.send(name, params) }.not_to raise_error
       end
     end
-
   end
 
+  describe "#define" do
+    let(:controller) do # Fake Controller
+      clazz = model
+      Class.new do
+        Rescue::Controller::Action.define_call self, clazz, :@rescue
+        Rescue::Controller::Action.define self,
+          [:show, :edit, :new, :create, :update, :destroy],
+          show: { render: lambda { 'show' } },
+          edit: { render: lambda { 'edit' } },
+          new:  { render: lambda { 'new' } },
+          create:  { render: lambda { 'create' } },
+          update:  { render: lambda { 'update' } },
+          destroy: { render: lambda { 'destroy' } }
+      end
+    end
+
+    let(:object) do
+      object = controller.new
+      object.stub(:params).and_return({})
+      object.stub(:create_params).and_return({})
+      object.stub(:update_params).and_return({})
+      object.stub(:destroy_params).and_return({})
+
+      # Stub: rescue_respond
+      object.stub(:rescue_respond) do |call, params, options|
+        options[:render].call
+      end
+      object
+    end
+
+    [:show, :edit, :new, :create, :update, :destroy].each do |name|
+      it "should declare `#{name}` method" do
+        expect(controller.public_instance_methods.include? name).to be_true
+      end
+      it "should render" do
+        expect(object.send(name)).to eq(name.to_s)
+      end
+    end
+
+    context "when unknown types are specified" do
+      it do
+        expect {
+          Class.new do
+            Rescue::Controller::Action.define self, [:action],
+              action: { type: :undefined ,render: lambda { 'render' } ,rescue: lambda { 'rescue' } }
+          end
+        }.to raise_error(Rescue::NoActionError, Rescue::NoActionError.new(:undefined).message)
+      end
+    end
+
+    context "when an action name is duplicated" do
+      it "should not raise error for the first time" do
+        expect {
+          Class.new do
+            Rescue::Controller::Action.define self, [:action],
+              action: { type: :show ,render: lambda { 'render' } ,rescue: lambda { 'rescue' } }
+          end
+        }.not_to raise_error
+      end
+      it "should raise RuntimeError with \"`action` is already defined.\"" do
+        expect {
+          Class.new do
+            def action ; end
+            Rescue::Controller::Action.define self, [:action],
+              action: { type: :show ,render: lambda { 'render' } ,rescue: lambda { 'rescue' } }
+          end
+        }.to raise_error(RuntimeError, "`action` is already defined.")
+      end
+    end
+
+    context "when an parameter method is undefined" do
+      { create:  :create_params,
+        update:  :update_params,
+        destroy: :destroy_params }.each do |name, params|
+        it do
+          expect {
+            controller.new.send(name)
+          }.to raise_error(Rescue::NoParameterMethodError, Rescue::NoParameterMethodError.new(controller, params).message)
+        end
+      end
+    end  
+  end
 end
 

data/spec/spec_helper.rb

@@ -7,6 +7,8 @@ require File.join(File.dirname(__FILE__), 'fake_rails')
 require File.join(File.dirname(__FILE__), 'test_case')
 require 'capybara/rails'
 
+#require 'benchmark'
+
 Coveralls.wear!('rails')
 RSpec.configure do |config|
   config.mock_with :rspec

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rescue-dog
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - yulii
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-18 00:00:00.000000000 Z
+date: 2013-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,7 +24,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 4.0.0
-description: respond to an exception raised in Rails
+description: Responds status and error handling for Rails
 email:
 - yuliinfo@gmail.com
 executables: []
@@ -52,6 +52,7 @@ files:
 - lib/rescue/controllers/dynamic.rb
 - lib/rescue/controllers/flash.rb
 - lib/rescue/controllers/static.rb
+- lib/rescue/errors.rb
 - lib/rescue/exceptions/application_error.rb
 - lib/rescue/exceptions/respond_error.rb
 - lib/rescue/version.rb
@@ -97,7 +98,7 @@ rubyforge_project:
 rubygems_version: 2.0.7
 signing_key: 
 specification_version: 4
-summary: define respond methods
+summary: Declare simple CRUD and respond error methods
 test_files:
 - spec/fake_rails.rb
 - spec/rescue/controller_spec.rb