restful_error 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9c9179f83c80510bc4d7a61c63f3bb73ec7767853a601063f3f407c07e8c12f
-  data.tar.gz: c3b69c8c5aeb55ebcff66c10825af68d4fec44f93af18e9588ae06edaff71542
+  metadata.gz: 4744dd451535b3d85e7ce8b47a76abee9fa33970a72d6748e553f89bb830e9e5
+  data.tar.gz: 6cfc09fbf86294c2453a3effeb1537f83a9c8fef8bed444f24916e3f45c2d470
 SHA512:
-  metadata.gz: 93c65efd5ece3f8dffc6760086b17ac682ec7577583023deeedcb45565593d8c31cc9cb465a0de9bbc2c5c8de640655793e6e194138e7ff5423d7055b6c3f561
-  data.tar.gz: '09e8c789c9d89598f66cb00d3b21e8a526e5908c006893f5e920d81be07fb32f7d61d2745a18c5611bd9071dde261884f26f5a4d875422a762d54079ec6c04f3'
+  metadata.gz: 6d339f3e39861bfdc9bf64fc983d9b03e15708f4323d3f9987da1ae70c7bc973b8cfecb7cc7568a1078957f7eef6ba9a8e1f5c533f50a734b2fcc0005f5c2170
+  data.tar.gz: cbbf4ee06b69b396f79cd351c2659458422090d927af7584f31eab4e8e4fe1bcc4019cb21b90f2695ddbfe2683199afd412a4f6bad11ddf61365cb182a26f55f

data/lib/restful_error/inflector.rb

@@ -12,6 +12,7 @@ module RestfulError
       word.gsub!(/(?<=[A-Z])(?=[A-Z][a-z])|(?<=[a-z\d])(?=[A-Z])/, "_")
       word.tr!("-", "_")
       word.downcase!
+      word
     end
 
     def camelize(word_)
@@ -21,6 +22,7 @@ module RestfulError
       word.sub!(/^[a-z\d]*/) { ::Regexp.last_match(0).capitalize }
       word.gsub!(%r{(?:_|(/))([a-z\d]*)}) { "#{Regexp.last_match(1)}#{Regexp.last_match(2).capitalize}" }
       word.gsub!("/", "::")
+      word
     end
   end
 end

data/lib/restful_error/railtie.rb

@@ -10,18 +10,14 @@ module RestfulError
 
     def show
       @exception = request.env["action_dispatch.exception"]
-      status = Status.new(request.path_info[1..].to_i)
+      code = request.path_info[1..].to_i
+      status = RestfulError.build_status_from_symbol_or_code(code)
       @status_code = status.code
       @reason_phrase = status.reason_phrase
-      @message = @exception.try(:response_message)
-      unless @message
-        class_name = @exception.class.name
-        class_key = RestfulError::Inflector.underscore(class_name)
-        @message = I18n.t class_key, default: [ status.symbol, @reason_phrase ], scope: :restful_error
-      end
+      @response_message = @exception.try(:response_message) || RestfulError.localized_phrase(@exception.class.name, status) || nil
 
       self.status = status.code
-      render "restful_error/show"
+      render "restful_error/show", formats: request.format.symbol
     end
   end
 

data/lib/restful_error/status.rb

@@ -4,34 +4,34 @@ require "restful_error/inflector"
 require "rack/utils"
 
 module RestfulError
+  Status = Data.define(:code, :reason_phrase, :symbol, :const_name)
+
   STATUS_CODE_TO_SYMBOL = Rack::Utils::SYMBOL_TO_STATUS_CODE.invert
-  def self.code_from(code_or_sym_or_const_name)
-    case code_or_sym_or_const_name
+
+  def self.build_status_from_const(const_sym)
+    const_name = const_sym.to_s
+    return unless /[A-Z]/.match?(const_name[0])
+    symbol = RestfulError::Inflector.underscore(const_name).to_sym
+    build_status_from_symbol_or_code(symbol)
+  end
+  def self.build_status_from_symbol_or_code(code_or_sym)
+    case code_or_sym
     when Integer
-      code_or_sym_or_const_name
+      code = code_or_sym
+      symbol = STATUS_CODE_TO_SYMBOL[code]
+      const_name = Inflector.camelize(symbol.to_s)
+      reason_phrase = Rack::Utils::HTTP_STATUS_CODES[code]
+      Status.new(code:, symbol:, const_name:, reason_phrase:)
     when Symbol
-      str = code_or_sym_or_const_name.to_s
-      sym = /[A-Z]/.match?(str[0]) ? RestfulError::Inflector.underscore(str).to_sym : code_or_sym_or_const_name
       begin
-        Rack::Utils.status_code(sym)
+        build_status_from_symbol_or_code Rack::Utils.status_code(code_or_sym)
       rescue ArgumentError
         nil
       end
     when /\A\d{3}\z/
-      code_from(code_or_sym_or_const_name.to_i)
+      build_status_from_symbol_or_code(code_or_sym.to_i)
     else
-      raise ArgumentError, "Invalid argument: #{code_or_sym_or_const_name.inspect}"
-    end
-  end
-
-  Status = Data.define(:code, :reason_phrase, :symbol, :const_name) do
-    def initialize(code:)
-      reason_phrase = Rack::Utils::HTTP_STATUS_CODES[code]
-      raise ArgumentError, "Invalid status code: #{code}" unless reason_phrase
-
-      symbol = STATUS_CODE_TO_SYMBOL[code]
-      const_name = Inflector.camelize(symbol.to_s)
-      super(code:, reason_phrase:, symbol:, const_name:)
+      raise ArgumentError, "Invalid argument: #{code_or_sym.inspect}"
     end
   end
 end

data/lib/restful_error/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RestfulError
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

data/lib/restful_error.rb

@@ -3,43 +3,62 @@
 require "rack/utils"
 require "restful_error/railtie" if defined? ActionController
 require "restful_error/status"
-
-I18n.load_path += Dir["#{File.expand_path("../config/locales")}/*.yml"] if defined? I18n
+require "restful_error/version"
 
 module RestfulError
-  class BaseError < StandardError; end
-
   module Helper
     def restful
-      raise NotImplementedError, "http_status must be implemented by including class" unless respond_to?(:http_status)
+      @restful ||= begin
+        raise NotImplementedError, "http_status must be implemented by including class" unless respond_to?(:http_status)
+        RestfulError.build_status_from_symbol_or_code(http_status)
+      end
+    end
+    def response_message
+      return @response_message unless @response_message.nil?
+      @response_message = RestfulError.localized_phrase(self.class.name, restful)
+    end
+  end
 
-      @restful ||= Status.new(RestfulError.code_from(http_status))
+  class BaseError < StandardError
+    include RestfulError::Helper
+    def initialize(message = nil)
+      @response_message = message
+      super
     end
   end
 
   @cache = {}
   class << self
     def [](code_like)
-      code = RestfulError.code_from(code_like)
-      @cache[code] ||= build_error_class_for(code)
+      status = RestfulError.build_status_from_symbol_or_code(code_like)
+      @cache[status.code] ||= build_error_class_for(status)
     end
 
     def const_missing(const_name)
-      code = RestfulError.code_from(const_name)
-      return super unless code
+      status = RestfulError.build_status_from_const(const_name)
+      return super unless status
+
+      @cache[status.code] ||= build_error_class_for(status)
+    end
 
-      @cache[code] ||= build_error_class_for(code)
+    def init_i18n
+      return if @init_i18n
+      I18n.load_path += Dir["#{File.expand_path("./config/locales")}/*.yml"]
+      @init_i18n = true
+    end
+    def localized_phrase(class_name, status)
+      return false unless defined?(I18n)
+      init_i18n
+      class_key = RestfulError::Inflector.underscore(class_name)
+      I18n.t class_key, default: [status.symbol, false], scope: :restful_error
     end
 
     private
 
-    def build_error_class_for(code)
-      status = Status.new(code)
-      message = defined?(I18n) ? I18n.t(status.symbol, default: status.reason_phrase, scope: :restful_error) : status.reason_phrase
+    def build_error_class_for(status)
       klass = Class.new(BaseError) do
         define_method(:http_status) { status.code }
         define_method(:restful) { status }
-        define_method(:message) { message }
       end
       const_set(status.const_name, klass)
       if defined? ActionDispatch::ExceptionWrapper

data/spec/with_rails/exceptions_app_spec.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "action_controller"
+require "i18n"
+require "spec_helper"
+require "restful_error/railtie" # require again for run after restful_error_spec
+
+RSpec.describe RestfulError::ExceptionsController do
+  include Rack::Test::Methods
+  def app = RestfulError.exceptions_app
+
+  shared_context "json" do
+    let(:request) { get "/#{status_code}", {}, 'HTTP_ACCEPT' => 'application/json' }
+    let(:json) { request; JSON.parse(last_response.body) }
+  end
+
+  before do
+    env "action_dispatch.exception", exception
+  end
+  describe RestfulError[404] do
+    let(:status_code) { 404 }
+    include_context "json" do
+      context 'default message' do
+        let(:exception) { described_class.new }
+        it do
+          expect(json).to eq({status_code: 404, reason_phrase: "Not Found", response_message: 'Page not found'}.stringify_keys)
+          expect(last_response.status).to eq status_code
+        end
+      end
+      context 'custom message' do
+        let(:exception) { described_class.new("custom message") }
+        it do
+          expect(json).to eq({status_code:, reason_phrase: "Not Found", response_message: "custom message"}.stringify_keys)
+        end
+      end
+    end
+  end
+  context ActionController::RoutingError do
+    let(:exception) { described_class.new("no route") }
+    let(:status_code) { 404 }
+    include_context "json" do
+      it do
+        expect(json).to eq({status_code:, reason_phrase: "Not Found", response_message: 'Requested resource is not found'}.stringify_keys)
+        expect(last_response.status).to eq status_code
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restful_error
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - kuboon
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-30 00:00:00.000000000 Z
+date: 2025-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -39,15 +39,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/restful_error.rb
-- lib/restful_error/engine.rb
 - lib/restful_error/inflector.rb
 - lib/restful_error/railtie.rb
 - lib/restful_error/status.rb
 - lib/restful_error/version.rb
-- spec/rack_spec.rb
-- spec/railtie_spec.rb
 - spec/restful_error_spec.rb
 - spec/spec_helper.rb
+- spec/with_rails/exceptions_app_spec.rb
 homepage: https://github.com/kuboon/restful_error
 licenses:
 - MIT

data/lib/restful_error/engine.rb

@@ -1,9 +0,0 @@
-begin
-  require 'rails'
-  module RestfulError #:nodoc:
-    class Engine < ::Rails::Engine #:nodoc:
-    end
-  end
-rescue LoadError
-  #do nothing
-end

data/spec/rack_spec.rb

@@ -1,20 +0,0 @@
-require 'action_controller'
-require 'spec_helper'
-
-describe 'RestfulError' do
-  describe RestfulError::ExceptionsController do
-    include Rack::Test::Methods
-    def app
-      RestfulError::ExceptionsController.action(:show)
-    end
-    describe '404' do
-      before do
-        env "action_dispatch.exception", RestfulError[404].new
-      end
-      it do
-        get '/404'
-        expect(last_response.status).to eq 404
-      end
-    end
-  end
-end

data/spec/railtie_spec.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require "action_controller"
-require "spec_helper"
-
-RSpec.describe "RestfulError.exceptions_app" do
-  let(:app) { RestfulError.exceptions_app }
-  let(:env) { {} }
-  let(:request) { Rack::MockRequest.new(app) }
-
-  it "renders 404" do
-    env["action_dispatch.exception"] = ActionController::RoutingError.new("Not Found")
-    env["PATH_INFO"] = "/404"
-    response = request.get("/404", env)
-    expect(response.status).to eq 404
-    expect(response.body).to include "Not Found"
-  end
-end