smart_error 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 48e245a0dd140bdf5277d1c53407be8a84fdd4e6
+  data.tar.gz: ac2b5878659fbbe4536b8ba8aca1d32f03b3a622
+SHA512:
+  metadata.gz: da8ddf2c97ec03590b249d040faefad187ee599dd96e46e61e2d7c71a04932263fbc7991835a562a3a0fb5375ee47173403e162a469a8455d9d8f501032b0b5f
+  data.tar.gz: f4b45188d111b8d06338731f74239ab6951e297fd6d5b15c4288446ef0aa7d1bbe71cfb2e4f99dfe59389706d048eb8bc2ac488d5468d92ba9eeffb3e809d818

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+smart_error

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ali.alsheiba@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ali Al-Sheiba
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# SmartError
+
+[![Build Status](https://travis-ci.org/ali-sheiba/smart_error.svg?branch=master)](https://travis-ci.org/ali-sheiba/smart_error)
+
+WIP
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'smart_error'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install smart_error
+```
+
+## Usage
+
+WIP
+
+## 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SmartError project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ali-sheiba/smart_error/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'smart_error'
+
+# 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.
+
+I18n.load_path << $LOAD_PATH[0] + '/../spec/en.yml'
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/smart_error.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'i18n'
+require 'active_support'
+require 'active_support/core_ext'
+require 'smart_error/version'
+
+I18n.config.available_locales = :en
+
+module SmartError
+  mattr_accessor :base_url
+  @@base_url = nil
+
+  mattr_accessor :excption_error_code
+  @@excption_error_code = 1000
+
+  mattr_accessor :model_error_code
+  @@model_error_code = 1010
+
+  # It accept [:first, :last, :sentence]
+  mattr_accessor :model_error_message
+  @@model_error_message = :first
+
+  def self.handle(error, options = nil)
+    if error.is_a?(Integer)
+      SmartError::CustomError.new(error, options)
+    elsif error.is_a?(Exception)
+      SmartError::ExceptionError.new(error, options)
+    elsif error.is_a?(ApplicationRecord) || error.is_a?(ActiveRecord)
+      SmartError::ModelError.new(error, options)
+    else
+      SmartError::CustomeError.new(1000, options)
+    end
+  end
+
+  def self.config
+    yield self
+  end
+end
+
+require 'smart_error/base_error'
+require 'smart_error/model_error'
+require 'smart_error/custom_error'
+require 'smart_error/exception_error'

data/lib/smart_error/base_error.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module SmartError
+  # THe Base Class of Errors
+  class BaseError
+    def initialize(error, options = {})
+      @error   = error
+      @options = options&.symbolize_keys! || {}
+    end
+
+    def message
+      raise NotImplementedError
+    end
+
+    def error_code
+      raise NotImplementedError
+    end
+
+    def details
+      {}
+    end
+
+    def error_url
+      SmartError.base_url.to_s + (error_code || 1000).to_s
+    end
+
+    def full_message
+      [
+        @options[:message].present? ? @options[:message] : message,
+        extra_message
+      ].compact.join(': ')
+    end
+
+    def extra_message
+      if @options[:extra].is_a?(Array)
+        @options[:extra].map(&:to_s).to_sentence
+      elsif @options[:extra].is_a?(String)
+        @options[:extra]
+      end
+    end
+
+    def to_h
+      {
+        message:    full_message,
+        details:    details,
+        error_url:  error_url,
+        error_code: error_code
+      }
+    end
+
+    def to_json
+      to_h.to_json
+    end
+
+    def as_json
+      to_h.as_json
+    end
+  end
+end

data/lib/smart_error/custom_error.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module SmartError
+  class CustomError < SmartError::BaseError
+    def error_code
+      @error.to_i
+    end
+
+    def message
+      I18n.t("errors.#{error_code}")
+    end
+  end
+end

data/lib/smart_error/exception_error.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module SmartError
+  class ExceptionError < SmartError::BaseError
+    def error_code
+      SmartError.excption_error_code
+    end
+
+    def message
+      @error.message
+    end
+  end
+end

data/lib/smart_error/model_error.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module SmartError
+  class ModelError < SmartError::BaseError
+    def error_code
+      SmartError.model_error_code
+    end
+
+    def message
+      case SmartError.model_error_message
+      when :first then @error.errors.full_messages.first
+      when :sentence then @error.errors.full_messages.to_sentence
+      when :last then @error.errors.full_messages.last
+      else @error.errors.full_messages.first
+      end
+    end
+
+    def details
+      @error.errors.details
+    end
+  end
+end

data/lib/smart_error/version.rb

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

data/smart_error.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$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.summary       = 'Simple way to handle custom error codes and messages'
+  spec.description   = 'Simple way to maintain custom error codes and there messages with I18n.'
+  spec.homepage      = 'https://github.com/ali-sheiba/smart_error'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry', '~> 0.11.3'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.6'
+  spec.add_dependency 'activesupport', '~> 5.1'
+  spec.add_dependency 'i18n', '~> 0.9.1'
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: smart_error
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ali Al-Sheiba
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+description: Simple way to maintain custom error codes and there messages with I18n.
+email:
+- ali.alsheiba@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/smart_error.rb
+- lib/smart_error/base_error.rb
+- lib/smart_error/custom_error.rb
+- lib/smart_error/exception_error.rb
+- lib/smart_error/model_error.rb
+- lib/smart_error/version.rb
+- smart_error.gemspec
+homepage: https://github.com/ali-sheiba/smart_error
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Simple way to handle custom error codes and messages
+test_files: []