RubyGems - rescue-dog - Versions diffs - 0.0.2 → 0.0.3 - Mend

rescue-dog 0.0.2 → 0.0.3

Files changed (24) hide show

data/README.md +16 -6
data/app/views/errors/400.html.erb +2 -0
data/app/views/errors/401.html.erb +2 -0
data/app/views/errors/404.html.erb +2 -0
data/app/views/errors/500.html.erb +2 -0
data/app/views/layouts/application.html.erb +15 -0
data/deploy_gem.sh +4 -0
data/lib/rescue/controller/dynamic.rb +32 -0
data/lib/rescue/controller/static.rb +23 -0
data/lib/rescue/controller.rb +9 -24
data/lib/rescue/version.rb +1 -1
data/lib/rescue-dog.rb +9 -0
data/public/400.html +11 -0
data/public/400.json +1 -0
data/public/401.html +11 -0
data/public/401.json +1 -0
data/spec/rails_spec_app.rb +35 -8
data/spec/rescue/controller/dynamic_spec.rb +33 -0
data/spec/rescue/controller/static_spec.rb +32 -0
data/spec/rescue/controller_spec.rb +14 -0
data/spec/rescue_spec.rb +36 -0
data/spec/test_case.rb +1 -1
metadata +21 -4
data/spec/controller_spec.rb +0 -50

data/README.md CHANGED Viewed

@@ -18,17 +18,27 @@ Or install it yourself as:
 ## Usage
+### Render Static Files
     $ vim app/controllers/application_controller.rb
     class ApplicationController
-      include Rescue::Controller
+      include Rescue::Controller::Static
       define_errors ServerError: 500, NotFound: 404
+### Render Template
+    $ vim app/controllers/application_controller.rb
+    class ApplicationController
-      # Call the response method when raise an exception
-      #   for ActiveRecord
-      rescue_from ActiveRecord::RecordNotFound, with: respond_404
-      #   for Mongoid
-      rescue_from Mongoid::Errors::DocumentNotFound, BSON::InvalidObjectId, with: :respond_404
+      include Rescue::Controller::Dynamic
+      define_errors ServerError: 500, NotFound: 404
+### Associated with the exceptions
+Call the response method when raise an exception
+#### for ActiveRecord
+    rescue_from ActiveRecord::RecordNotFound, with: lambda {|e| respond_status 404 }
+#### for Mongoid
+    rescue_from Mongoid::Errors::DocumentNotFound, BSON::InvalidObjectId, with: lambda {|e| respond_status 404 }
 ## Contributing

data/app/views/errors/400.html.erb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ <h1>Bad Request</h1>
2	+ <p>Sorry, I can not understand it.</p>

data/app/views/errors/401.html.erb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ <h1>Unauthorized</h1>
2	+ <p>Sorry, I can not response to you.</p>

data/app/views/errors/404.html.erb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ <h1>Not Found</h1>
2	+ <p>Sorry, I can not found it.</p>

data/app/views/errors/500.html.erb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ <h1>Server Error</h1>
2	+ <p>Sorry, I can not do it.</p>

data/app/views/layouts/application.html.erb ADDED Viewed

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset='utf-8'>
+  <title>Error</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+<%= yield %>
+</body>
+</html>

data/deploy_gem.sh CHANGED Viewed

@@ -25,3 +25,7 @@ echo "[RUN] mv ${PKG_FILE} pkg/"
 mv ${PKG_FILE} ./pkg
 echo "[RUN] gem push pkg/${PKG_FILE}"
 gem push pkg/${PKG_FILE}
+echo "[RUN] git tag -a version-${$1}"
+git tag -a version-$1
+git push --tags

data/lib/rescue/controller/dynamic.rb ADDED Viewed

@@ -0,0 +1,32 @@
+# coding: UTF-8
+module Rescue
+  module Controller
+    module Dynamic
+      def self.included(base)
+        base.extend ClassMethods
+        base.extend Rescue::Controller::ClassMethods
+      end
+      module ClassMethods
+        def define_respond_method name
+          return if method_defined?(name)
+          define_method name do |code, exception = nil|
+            e = {}
+            e[:code]    = code
+            e[:status]  = Rack::Utils::HTTP_STATUS_CODES[code]
+            e[:message] = exception.message if exception
+            respond_to do |format|
+              format.html { render status: code, template: "/errors/#{code}" }
+              format.json { render status: code, json: { errors: [e] } }
+              format.xml  { render status: code, xml:  { errors: [e] } }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rescue/controller/static.rb ADDED Viewed

@@ -0,0 +1,23 @@
+# coding: UTF-8
+module Rescue
+  module Controller
+    module Static
+      def self.included(base)
+        base.extend ClassMethods
+        base.extend Rescue::Controller::ClassMethods
+      end
+      module ClassMethods
+        def define_respond_method name
+          return if method_defined?(name)
+          define_method name do |code, exception = nil|
+            render status: code, file: "#{Rails.root}/public/#{code}", layout: false and return
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rescue/controller.rb CHANGED Viewed

@@ -1,34 +1,19 @@
 # coding: UTF-8
+require File.join(File.dirname(__FILE__), "controller/static.rb")
+require File.join(File.dirname(__FILE__), "controller/dynamic.rb")
 module Rescue
   module Controller
-    def self.included(base)
-      base.extend ClassMethods
-    end
     module ClassMethods
-      def define_errors statuses, superclass = StandardError
-        statuses.each do |class_name, code|
-          respond = :"respond_#{code}"
-          define_error_class class_name, superclass
-          define_respond_method respond, code
-          # an error maps to respond method
-          rescue_from "#{class_name}".constantize, with: respond
-        end
-      end
-      def define_error_class class_name, superclass = StandardError
-        return if Object.const_defined?(class_name)
-        Object.const_set(class_name, Class.new(superclass))
-      end
+      def define_errors statuses, superclass = StandardError
+        respond = :respond_status
+        define_respond_method respond
-      # Define "respond_#{code}" method
-      def define_respond_method name, code
-        return if method_defined?(name)
-        define_method name do |e = nil|
-          render status: code, file: "#{Rails.root}/public/#{code}.#{request.format.to_sym}", layout: false and return
+        statuses.each do |class_name, code|
+          Rescue::Bind.define_error_class class_name, superclass
+          rescue_from "#{class_name}".constantize, with: lambda {|e| send(respond, code, e) }
         end
       end
     end

data/lib/rescue/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module Rescue
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/rescue-dog.rb CHANGED Viewed

@@ -2,4 +2,13 @@ require "rescue/version"
 require File.join(File.dirname(__FILE__),'rescue/controller.rb')
 module Rescue
+  class Bind
+    class << self
+      def define_error_class class_name, superclass = nil
+        return if Object.const_defined?(class_name)
+        Object.const_set(class_name, Class.new(superclass||StandardError))
+      end
+    end
+  end
 end

data/public/400.html ADDED Viewed

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset='utf-8'>
+<title>Error: 400 Bad Request</title>
+</head>
+<body>
+  <h1>Bad Request</h1>
+  <p>Sorry, I can not understand it.</p>
+</body>
+</html>

data/public/400.json ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"errors":[{"code":400,"status":"Bad Request"}]}

data/public/401.html ADDED Viewed

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset='utf-8'>
+<title>Error: 401 Unauthorized</title>
+</head>
+<body>
+  <h1>Unauthorized</h1>
+  <p>Sorry, I can not response to you.</p>
+</body>
+</html>

data/public/401.json ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"errors":[{"code":401,"status":"Unauthorized"}]}

data/spec/rails_spec_app.rb CHANGED Viewed

@@ -1,29 +1,56 @@
 require 'action_controller/railtie'
 require 'action_view/railtie'
+# const
+STATUSES = {
+  :bad_request  => 400,
+  :unauthorized => 401,
+  :not_found    => 404,
+  :server_error => 500,
+}
 # config
 app = Class.new Rails::Application
 app.config.active_support.deprecation = :log
 app.config.secret_token = 'ccedfce890492dd9fe2908a69a8732104ae133f1e2488bf6a1e96685b05a96d7e11aeaa3da5ade27604a50c3b2c7cc8323dd03ad11bb2e52e95256fb67ef9c8a'
+app.config.generators do |g|
+  g.template_engine :haml
+end
 app.initialize!
 # routing
 app.routes.draw do
-  [:not_found, :server_error].each do |e|
-    get "/#{e}"=>"errors##{e}" ,as: e
+  STATUSES.each do |name, code|
+    get "/static/#{name}"  =>"static##{name}"  ,as: name
+    get "/dynamic/#{name}" =>"dynamic##{name}" ,as: name
   end
 end
 # controllers
-class ApplicationController < ActionController::Base;
-  include Rescue::Controller
-  define_errors ServerError: 500, NotFound: 404
+class ApplicationController < ActionController::Base ; end
+class StaticController < ApplicationController
+  include Rescue::Controller::Static
+  define_errors BadRequest: 400, Unauthorized: 401, NotFound: 404, ServerError: 500
+  STATUSES.each do |name, code|
+    class_name = "#{name}".classify
+    define_method name do
+      raise class_name.constantize
+    end
+  end
 end
-class ErrorsController < ApplicationController
-  def not_found    ; raise NotFound    ; end
-  def server_error ; raise ServerError ; end
+class DynamicController < ApplicationController
+  include Rescue::Controller::Dynamic
+  define_errors BadRequest: 400, Unauthorized: 401, NotFound: 404, ServerError: 500
+  STATUSES.each do |name, code|
+    class_name = "#{name}".classify
+    define_method name do
+      raise class_name.constantize.new "This is an explanation of what caused the error."
+    end
+  end
 end
 Object.const_set(:ApplicationHelper,Module.new)

data/spec/rescue/controller/dynamic_spec.rb ADDED Viewed

@@ -0,0 +1,33 @@
+# coding: UTF-8
+require 'spec_helper'
+describe Rescue::Controller::Dynamic do
+  let(:object) { DynamicController.new }
+  describe "respond method" do
+    subject { object.methods.include?(:respond_status) }
+    it "should be called in a subclass of ApplicationController" do
+      should be_true
+    end
+  end
+  TestCase::Controller::ERRORS.each do |name, code|
+    describe "response when raise #{name}" do
+      TestCase::Controller::FORMATS.each do |format|
+        context "request format => #{format}" do
+          before do
+            visit "/dynamic/#{name.to_s.underscore}.#{format.to_sym}"
+          end
+          subject { page }
+          it { should have_content name.to_s.gsub(/([A-Z]+)([A-Z][a-z])/,'\1 \2').gsub(/([a-z\d])([A-Z])/,'\1 \2') }
+          it { should have_content "This is an explanation of what caused the error." } unless format.to_sym == :html
+          it { response_headers["Content-Type"].should include(format.to_s) }
+        end
+      end
+    end
+  end ## end each
+end

data/spec/rescue/controller/static_spec.rb ADDED Viewed

@@ -0,0 +1,32 @@
+# coding: UTF-8
+require 'spec_helper'
+describe Rescue::Controller::Static do
+  let(:object) { StaticController.new }
+  describe "respond method" do
+    subject { object.methods.include?(:respond_status) }
+    it "should be called in a subclass of ApplicationController" do
+      should be_true
+    end
+  end
+  TestCase::Controller::ERRORS.each do |name, code|
+    describe "response when raise #{name}" do
+      TestCase::Controller::FORMATS.each do |format|
+        context "request format => #{format}" do
+          before do
+            visit "/static/#{name.to_s.underscore}.#{format.to_sym}"
+          end
+          subject { page }
+          it { should have_content name.to_s.gsub(/([A-Z]+)([A-Z][a-z])/,'\1 \2').gsub(/([a-z\d])([A-Z])/,'\1 \2') }
+          it { response_headers["Content-Type"].should include(format.to_s) }
+        end
+      end
+    end
+  end ## end each
+end

data/spec/rescue/controller_spec.rb ADDED Viewed

@@ -0,0 +1,14 @@
+# coding: UTF-8
+require 'spec_helper'
+describe Rescue::Controller do
+  let(:dynamic) do
+    clazz = Class.new ApplicatoinController do
+      include Rescue::Controller
+      define_errors :dynamic, BadRequest: 400, Unauthorized: 401, NotFound: 404, ServerError: 500
+    end
+    clazz.new
+  end
+end

data/spec/rescue_spec.rb ADDED Viewed

@@ -0,0 +1,36 @@
+# coding: UTF-8
+require 'spec_helper'
+describe Rescue do
+  describe "define_error_class :RescueStandardError" do
+    let(:name) { :RescueStandardError }
+    before     { Rescue::Bind.define_error_class name }
+    subject { Object.const_defined? name }
+    it "should define an exception class" do
+      should be_true
+    end
+    subject { Object.const_get(name).new }
+    it "should define an exception class that is a kind of StandardError" do
+      should be_a_kind_of StandardError
+    end
+  end
+  describe "define_error_class :RescueScriptError, ScriptError" do
+    let(:name) { :RescueScriptError }
+    before     { Rescue::Bind.define_error_class name, ScriptError }
+    subject { Object.const_defined? name }
+    it "should define an exception class" do
+      should be_true
+    end
+    subject { Object.const_get(name).new }
+    it "should define an exception class that is a kind of StandardError" do
+      should be_a_kind_of ScriptError
+    end
+  end
+end

data/spec/test_case.rb CHANGED Viewed

@@ -1,7 +1,7 @@
 class TestCase
   class Controller
-    ERRORS = { NotFound: 404, ServerError: 500 }
+    ERRORS = { BadRequest: 400, Unauthorized: 401, NotFound: 404, ServerError: 500 }
     FORMATS = [Mime::Type.new("text/html", :html), Mime::Type.new("application/json", :json)]
   end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rescue-dog
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease:
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-03-12 00:00:00.000000000 Z
+date: 2013-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -40,17 +40,31 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/views/errors/400.html.erb
+- app/views/errors/401.html.erb
+- app/views/errors/404.html.erb
+- app/views/errors/500.html.erb
+- app/views/layouts/application.html.erb
 - deploy_gem.sh
 - lib/rescue-dog.rb
 - lib/rescue/controller.rb
+- lib/rescue/controller/dynamic.rb
+- lib/rescue/controller/static.rb
 - lib/rescue/version.rb
+- public/400.html
+- public/400.json
+- public/401.html
+- public/401.json
 - public/404.html
 - public/404.json
 - public/500.html
 - public/500.json
 - rescue-dog.gemspec
-- spec/controller_spec.rb
 - spec/rails_spec_app.rb
+- spec/rescue/controller/dynamic_spec.rb
+- spec/rescue/controller/static_spec.rb
+- spec/rescue/controller_spec.rb
+- spec/rescue_spec.rb
 - spec/spec_helper.rb
 - spec/test_case.rb
 homepage: https://github.com/yulii/rescue-dog
@@ -78,7 +92,10 @@ signing_key:
 specification_version: 3
 summary: define respond methods
 test_files:
-- spec/controller_spec.rb
 - spec/rails_spec_app.rb
+- spec/rescue/controller/dynamic_spec.rb
+- spec/rescue/controller/static_spec.rb
+- spec/rescue/controller_spec.rb
+- spec/rescue_spec.rb
 - spec/spec_helper.rb
 - spec/test_case.rb

data/spec/controller_spec.rb DELETED Viewed

@@ -1,50 +0,0 @@
-# coding: UTF-8
-require 'spec_helper'
-describe Rescue::Controller do
-  before do
-    @r = ErrorsController.new
-  end
-  TestCase::Controller::ERRORS.each do |name, code|
-    describe "#{name} exception class" do
-      subject { Object.const_defined? name }
-      it "should define '#{name}' class" do
-        should be_true
-      end
-      subject { Object.const_get(name).new }
-      it "should be a kind of StandardError" do
-        should be_a_kind_of StandardError
-      end
-    end
-    describe "respond_#{code} method" do
-      subject { ApplicationController.method_defined? :"respond_#{code}" }
-      it "should be defined in ApplicationController" do
-        should be_true
-      end
-      subject { @r.methods.include?(:"respond_#{code}") }
-      it "should be called in a subclass of ApplicationController" do
-        should be_true
-      end
-    end
-    describe "raise #{name}" do
-      TestCase::Controller::FORMATS.each do |format|
-        context "request format => #{format}" do
-          before do
-            visit "/#{name.to_s.underscore}.#{format.to_sym}"
-          end
-          subject { page }
-          it { should have_content name.to_s.gsub(/([A-Z]+)([A-Z][a-z])/,'\1 \2').gsub(/([a-z\d])([A-Z])/,'\1 \2') }
-          it { response_headers["Content-Type"].should include(format.to_s) }
-        end
-      end
-    end
-  end ## end each
-end