smart_error 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2436ad75624ac387e6826270dba88d46c94ea938
-  data.tar.gz: 0631c737389e4f733e917cbd3ad5dac8e41d890f
+SHA256:
+  metadata.gz: 59d9a3f3b7d1095811041c456d368bc58d7eb72b686e25772f221923aaa7fc99
+  data.tar.gz: 537090f991ece72696eb0d13f6ed9158c8e4c4e6601557567d6e1aa29be7b163
 SHA512:
-  metadata.gz: 6e7e05b1d4a7e19d55280d806dc0fd4d18eb1117e97364695c702badb0feafc39735dccb7187a268e24f20f3f88931fee0042fa06b0be20ad847404248abca64
-  data.tar.gz: ac9a8e57269683ce1723be864b8cf7934de2df00770fe665de7a3e9362440c8f3654e98452afa421d86d032729af63cd0e18432a26c8740c3d4cd9c832785b9d
+  metadata.gz: eb6052bfe1dae0cbbd5b381207e1efdece8ec963b7b64eb9d88f4418505a3e78f81767beac2d4040a227fb7263b56bd521af53beb4721bc83ebbe45b9765cb49
+  data.tar.gz: '08731b218c5eabe0739eeeae5bde9c8fc69c7b4977a50ebf7608aafe79688b3d63141d8d5a77985137785b078c88411bf71d3a9845c625afaf468451fd2a6a2e'

data/.rubocop.yml

@@ -0,0 +1,120 @@
+# Usage: rubocop -a app/controllers/run/on/specific/file
+require:
+  - rubocop-performance
+
+AllCops:
+  TargetRubyVersion: 2.7.1
+  Exclude:
+    - 'bin/**/*'
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/LineLength:
+  Max: 120
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Layout/SpaceInLambdaLiteral:
+  Enabled: true
+
+Layout/DotPosition:
+  Description: 'Checks the position of the dot in multi-line method calls.'
+  StyleGuide: '#consistent-multi-line-chains'
+  Enabled: true
+  EnforcedStyle: trailing
+
+Lint/Void:
+  Enabled: false
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: false
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/CaseLikeIf:
+  Description: 'This cop identifies places where `if-elsif` constructions can be replaced with `case-when`.'
+  StyleGuide: '#case-vs-if-else'
+  Enabled: true
+
+Style/EmptyCaseCondition:
+  Description: 'Avoid empty condition in case statements.'
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/Documentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Style/HashSyntax:
+  Enabled: true
+
+Style/RedundantSelf:
+  Description: "Don't use self where it's not needed."
+  StyleGuide: '#no-self-unless-required'
+  Enabled: false
+
+Style/MethodCallWithArgsParentheses:
+  Description: 'Use parentheses for method calls with arguments.'
+  StyleGuide: '#method-invocation-parens'
+  EnforcedStyle: require_parentheses
+  Enabled: false
+  Exclude:
+    - '**/*.gemfile'
+    - '**/Gemfile'
+    - '**/presenters/*.rb'
+    - '**/spec/*'
+
+
+Style:
+  BlockDelimiters:
+    EnforcedStyle: semantic
+
+  Style/Documentation:
+    Description: 'Document classes and non-namespace modules.'
+    Enabled: false
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/ClassLength:
+  Max: 1500
+
+Metrics/MethodLength:
+  Max: 25
+
+Metrics/BlockLength:
+  Max: 70

data/.ruby-version

@@ -1 +1 @@
-2.4.1
+2.7.2

data/.travis.yml

@@ -2,4 +2,4 @@ sudo: false
 language: ruby
 rvm:
   - 2.4.1
-before_install: gem install bundler -v 1.16.0
+before_install: gem install bundler -v 1.17.3

data/Gemfile

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

data/README.md

@@ -5,6 +5,29 @@
 
 Simple gem that can handle Exceptions, ActiveRecord Errors and Custom Errors and return readable message and error number/code as usable Hash.
 
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [SmartError](#smarterror)
+  - [Installation](#installation)
+  - [Usage](#usage)
+    - [Handle integer as CustomError](#handle-integer-as-customerror)
+    - [Handle ApplicationRecord as ModelError](#handle-applicationrecord-as-modelerror)
+    - [Handle ActiveRecord child as ModelError](#handle-activerecord-child-as-modelerror)
+    - [handle Exception as ExceptionError](#handle-exception-as-exceptionerror)
+    - [Override the message with the provided message](#override-the-message-with-the-provided-message)
+    - [Merge `extra` array to message](#merge-extra-array-to-message)
+    - [Merge `extra` string to message](#merge-extra-string-to-message)
+    - [Merge `extra` with custom message](#merge-extra-with-custom-message)
+    - [Show First Model Errors by default](#show-first-model-errors-by-default)
+    - [Show Model Error details by invalid keys and messages and convert messages to sentence](#show-model-error-details-by-invalid-keys-and-messages-and-convert-messages-to-sentence)
+  - [Contributing](#contributing)
+  - [License](#license)
+  - [Code of Conduct](#code-of-conduct)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 ## Installation
 
 Add this line to your application’s Gemfile:
@@ -26,9 +49,81 @@ $ gem install smart_error
 ```
 
 ## Usage
+First of all will need to have predefined list of error messages Like: [errors](https://github.com/ali-sheiba/smart_error/blob/master/spec/en.yml)
+
+
+### Handle integer as CustomError
+
+```ruby
+SmartError.handle(1001).to_h
+# {:message=>"Unauthorized", :details=>{}, :error_url=>"1001", :error_code=>1001}
+
+SmartError.handle(1001).to_json
+# "{\"message\":\"Unauthorized\",\"details\":{},\"error_url\":\"1001\",\"error_code\":1001}"
+
+SmartError.handle(1001, options).as_json
+# {"message"=>"Unauthorized", "details"=>{}, "error_url"=>"1001", "error_code"=>1001}
+```
+
+### Handle ApplicationRecord as ModelError
+```ruby
+SmartError.handle(Employee.new).to_h
+# {:message=>"", :details=>{}, :error_url=>"1010", :error_code=>1010}
+```
+
+### Handle ActiveRecord child as ModelError
+```ruby
+SmartError.handle(ApplicationRecord.new).to_h
+```
+
+### handle Exception as ExceptionError
+```ruby
+SmartError.handle(NoMethodError.new).to_h
+# {:message=>"NoMethodError", :details=>{}, :error_url=>"1000", :error_code=>1000}
+```
+
+### Override the message with the provided message
+```ruby
+message = 'Custom Message'
+SmartError.handle(1001, message: message).to_h
+# {:message=>"Custom Message", :details=>{}, :error_url=>"1001", :error_code=>1001}
+```
+
+### Merge `extra` array to message
+```ruby
+extra = %i[username password country]
+error = SmartError.handle(1002, extra: extra)
+error.to_h
+# {:message=>"Not Found: username, password, and country", :details=>{}, :error_url=>"1002", :error_code=>1002}
+```
+
+### Merge `extra` string to message
+```ruby
+extra = 'you are noy authorized for this action'
+error = SmartError.handle(1001, extra: extra)
+error.to_h
+# {:message=>"Unauthorized: you are noy authorized for this action", :details=>{}, :error_url=>"1001", :error_code=>1001}
+```
 
-WIP
+### Merge `extra` with custom message
+```ruby
+extra = %i[username password country]
+message = 'Missing Parameters'
+error = SmartError.handle(1001, message: message, extra: extra)
+error.to_h
+# {:message=>"Missing Parameters: username, password, and country", :details=>{}, :error_url=>"1001", :error_code=>1001}
+```
 
+### Show First Model Errors by default
+```ruby
+SmartError.handle(ExampleModel.new).to_h
+```
+### Show Model Error details by invalid keys and messages and convert messages to sentence
+```ruby
+error = SmartError.handle(ExampleModel.new)
+error.to_h[:details] # 'can\'t be blank'
+error.to_h[:details] # 'can\'t be blank and is invalid'
+```
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at <https://github.com/ali-sheiba/smart_error>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/Rakefile

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

data/bin/rubocop

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+
+def last_commit_id_of_base_branch
+  `git log | sed -n 1p`.split(' ').last
+end
+
+puts "== Running rubocop with safe auto correct on modified files after #{last_commit_id_of_base_branch} commit =="
+system("git diff #{last_commit_id_of_base_branch} --name-only | xargs bundle exec rubocop -A")

data/lib/smart_error.rb

@@ -22,14 +22,15 @@ module SmartError
   @@model_error_message = :first
 
   def self.handle(error, options = nil)
-    if error.is_a?(Integer)
+    case error
+    when Integer
       SmartError::CustomError.new(error, options)
-    elsif error.is_a?(Exception)
+    when Exception
       SmartError::ExceptionError.new(error, options)
-    elsif error.is_a?(ApplicationRecord) || error.is_a?(ActiveRecord)
+    when ApplicationRecord, ActiveRecord
       SmartError::ModelError.new(error, options)
     else
-      SmartError::CustomeError.new(1000, options)
+      SmartError::CustomError.new(1000, options)
     end
   end
 

data/lib/smart_error/base_error.rb

@@ -1,20 +1,21 @@
 # frozen_string_literal: true
 
 module SmartError
-  # THe Base Class of Errors
+  # The Base Class of Errors
   class BaseError
     def initialize(error, options = {})
       @error   = error
       @options = options&.symbolize_keys! || {}
     end
 
-    def message
+    # :nocov:
+    def not_implemented
       raise NotImplementedError
     end
 
-    def error_code
-      raise NotImplementedError
-    end
+    alias message not_implemented
+    alias error_code not_implemented
+    # :nocov:
 
     def details
       {}

data/lib/smart_error/model_error.rb

@@ -7,18 +7,24 @@ module SmartError
     end
 
     def message
-      action = case SmartError.model_error_message
-               when :first then :first
-               when :sentence then :to_sentence
-               when :last then :last
-               else :first
-               end
-
-      @error.errors.full_messages.send(action)
+      @error.
+        errors.
+        full_messages.
+        send(
+          action[SmartError.model_error_message] || :first
+        )
     end
 
     def details
       @error.errors.messages.transform_values(&:to_sentence)
     end
+
+    def action
+      {
+        first: :first,
+        last: :last,
+        sentence: :to_sentence
+      }
+    end
   end
 end

data/lib/smart_error/version.rb

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

data/smart_error.gemspec

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'smart_error/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'smart_error'
   spec.version       = SmartError::VERSION
-  spec.authors       = ['Ali Al-Sheiba']
-  spec.email         = ['ali.alsheiba@gmail.com']
+  spec.authors       = ['Ali Al-Sheiba', 'MajedBojan']
+  spec.email         = ['ali.alsheiba@gmail.com', 'bojanmajed@gmail.com']
 
   spec.summary       = 'Simple way to handle custom error codes and messages'
   spec.description   = 'Simple way to maintain custom error codes and there messages with I18n.'
@@ -23,10 +23,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_dependency 'i18n', '~> 1.8', '>= 1.8.5'
+  spec.add_dependency 'activesupport', '>= 5.0'
+  spec.add_development_dependency 'bundler', '~> 2.1'
   spec.add_development_dependency 'pry', '~> 0.11.3'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rspec', '~> 3.6'
-  spec.add_dependency 'activesupport', '>= 5.0'
-  spec.add_dependency 'i18n', '>= 0.8'
+  spec.add_development_dependency 'rubocop', '~> 0.93.1'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.8', '>= 1.8.1'
 end

metadata

@@ -1,29 +1,64 @@
 --- !ruby/object:Gem::Specification
 name: smart_error
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Ali Al-Sheiba
+- MajedBojan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-18 00:00:00.000000000 Z
+date: 2020-10-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.5
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +79,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -67,42 +102,50 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.6'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :runtime
+        version: 0.93.1
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 0.93.1
 - !ruby/object:Gem::Dependency
-  name: i18n
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :runtime
+        version: 1.8.1
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 1.8.1
 description: Simple way to maintain custom error codes and there messages with I18n.
 email:
 - ali.alsheiba@gmail.com
+- bojanmajed@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
@@ -113,6 +156,7 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/rubocop
 - bin/setup
 - lib/smart_error.rb
 - lib/smart_error/base_error.rb
@@ -120,7 +164,6 @@ files:
 - lib/smart_error/exception_error.rb
 - lib/smart_error/model_error.rb
 - lib/smart_error/version.rb
-- smart_error-1.0.1.gem
 - smart_error.gemspec
 homepage: https://github.com/ali-sheiba/smart_error
 licenses:
@@ -141,8 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Simple way to handle custom error codes and messages