Merge pull request #16 from driggl/14-configure-rubocop

Refactor to meet rubocop expectations #14

Author: Sebastian Wilgosz

Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in jsonapi_errors_handler.gemspec
 gemspec

Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "jsonapi_errors_handler"
+require 'bundler/setup'
+require 'jsonapi_errors_handler'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "jsonapi_errors_handler"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

jsonapi_errors_handler.gemspec

@@ -1,41 +1,46 @@
-lib = File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "jsonapi_errors_handler/version"
+require 'jsonapi_errors_handler/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "jsonapi_errors_handler"
+  spec.name          = 'jsonapi_errors_handler'
   spec.version       = JsonapiErrorsHandler::VERSION
-  spec.authors       = ["Sebastian Wilgosz"]
-  spec.email         = ["[email protected]"]
+  spec.authors       = ['Sebastian Wilgosz']
+  spec.email         = ['[email protected]']
 
-  spec.summary       = %q{A JSON API error handler for ruby applications.}
-  spec.description   = %q{This gem is a convienient wrapper for your application errors. It allows you to map any error to a nicely formatted standard HTTP error response. }
-  spec.homepage      = "https://github.com/driggl/jsonapi_errors_handler"
-  spec.license       = "MIT"
+  spec.summary       = 'A JSON API error handler for ruby applications.'
+  spec.description   = <<~STRING
+    This gem is a convienient wrapper for your application errors.
+    It allows you to map any error to a nicely formatted standard HTTP error response.
+  STRING
+  spec.homepage      = 'https://github.com/driggl/jsonapi_errors_handler'
+  spec.license       = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
     # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
 
-    spec.metadata["homepage_uri"] = spec.homepage
-    spec.metadata["source_code_uri"] = "https://github.com/driggl/jsonapi_errors_handler"
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/driggl/jsonapi_errors_handler'
     # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
   end
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
 end

lib/jsonapi_errors_handler.rb

@@ -1,35 +1,38 @@
+# frozen_string_literal: true
+
 require 'irb'
-require "jsonapi_errors_handler/version"
-require "jsonapi_errors_handler/errors"
-require "jsonapi_errors_handler/error_mapper"
-require "jsonapi_errors_handler/error_serializer"
+require 'jsonapi_errors_handler/version'
+require 'jsonapi_errors_handler/errors'
+require 'jsonapi_errors_handler/error_mapper'
+require 'jsonapi_errors_handler/error_serializer'
 
 module JsonapiErrorsHandler
   def self.included(base)
     base.class_eval do
-      ErrorMapper.map_errors!({
+      ErrorMapper.map_errors!(
         'JsonapiErrorsHandler::Errors::Invalid' => 'JsonapiErrorsHandler::Errors::Invalid',
         'JsonapiErrorsHandler::Errors::Forbidden' => 'JsonapiErrorsHandler::Errors::Forbidden',
         'JsonapiErrorsHandler::Errors::NotFound' => 'JsonapiErrorsHandler::Errors::NotFound',
         'JsonapiErrorsHandler::Errors::Unauthorized' => 'JsonapiErrorsHandler::Errors::Unauthorized'
-      })
+      )
+    end
+  end
 
-      def handle_error(e)
-        mapped = map_error(e)
-        log_error(e) if respond_to?(:log_error) && !mapped
-        mapped ||= ::JsonapiErrorsHandler::Errors::StandardError.new
-        render_error(mapped)
-      end
+  def handle_error(error)
+    mapped = map_error(error)
+    log_error(error) if respond_to?(:log_error) && !mapped
+    mapped ||= ::JsonapiErrorsHandler::Errors::StandardError.new
+    render_error(mapped)
+  end
 
-      def map_error(e)
-        error_klass = e.class.name
-        return nil if !ErrorMapper.mapped_error?(error_klass)
-        Object.const_get(ErrorMapper.mapped_errors[error_klass]).new
-      end
+  def map_error(error)
+    error_klass = error.class.name
+    return nil unless ErrorMapper.mapped_error?(error_klass)
 
-      def render_error(error)
-        render json: ::JsonapiErrorsHandler::ErrorSerializer.new(error), status: error.status
-      end
-    end
+    Object.const_get(ErrorMapper.mapped_errors[error_klass]).new
+  end
+
+  def render_error(error)
+    render json: ::JsonapiErrorsHandler::ErrorSerializer.new(error), status: error.status
   end
 end

lib/jsonapi_errors_handler/error_mapper.rb

@@ -1,17 +1,18 @@
+# frozen_string_literal: true
+
 module JsonapiErrorsHandler
   class ErrorMapper
     @@mapped_errors = {}
     def self.mapped_errors
       @@mapped_errors
     end
 
-    def self.map_errors!(errors_hash={})
+    def self.map_errors!(errors_hash = {})
       @@mapped_errors.merge!(errors_hash)
     end
 
     def self.mapped_error?(error_klass)
-      mapped_errors.values.include?(error_klass)
+      mapped_errors.value?(error_klass)
     end
   end
 end
-

lib/jsonapi_errors_handler/error_serializer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 
 module JsonapiErrorsHandler
@@ -10,7 +12,7 @@ def to_h
       serializable_hash
     end
 
-    def to_json(_payload=nil)
+    def to_json(_payload = nil)
       to_h.to_json
     end
 
@@ -25,4 +27,3 @@ def serializable_hash
     attr_reader :error
   end
 end
-

lib/jsonapi_errors_handler/errors.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module JsonapiErrorsHandler
   module Errors
-
   end
 end
 

lib/jsonapi_errors_handler/errors/forbidden.rb

@@ -5,10 +5,10 @@ module Errors
     class Forbidden < ::JsonapiErrorsHandler::Errors::StandardError
       def initialize(message: nil)
         super(
-          title: "Forbidden request",
+          title: 'Forbidden request',
           status: 403,
-          detail: message || "You have no rights to access this resource",
-          source: { pointer: "/request/headers/authorization" }
+          detail: message || 'You have no rights to access this resource',
+          source: { pointer: '/request/headers/authorization' }
         )
       end
     end

lib/jsonapi_errors_handler/errors/invalid.rb

@@ -6,7 +6,7 @@ class Invalid < ::JsonapiErrorsHandler::Errors::StandardError
       def initialize(errors: {})
         @errors = errors
         @status = 422
-        @title = "Invalid request"
+        @title = 'Invalid request'
       end
 
       def serializable_hash