business_error 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 53723454814f8dbe82e668cae8fa2c2eb22bf5f4
+  data.tar.gz: a4d9f799ade0725f769c291c035ac9d5e67bf434
+SHA512:
+  metadata.gz: e614af109c9ee257592d23d2f56c04fccf332aef695d3ba0571f7e8462ee5a7b55fd1a6050471dc647c83aa90d590408f503eef9473fcf9d20c789fb82f8bbb6
+  data.tar.gz: 51316491a4169abe2fb52402812e00eb1df0b971882d4144555c28bb9e00fcd83a981bcba30eb4d5fcc290c775efbd7f150d5d44d26bdf4e60cf96a1540b19af

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.idea/*
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

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 xy@xiayouwang.net. 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 business_error.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    business_error (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  business_error!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 zhandao
+
+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,233 @@
+# BusinessError
+
+Business Error Management by using OOP
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'business_error'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### 1. Config file
+
+initializer `business_error.rb`
+
+```ruby
+BusinessError::Config.tap do |config|
+  config.default_http_status = 200
+end
+```
+
+### 2. About `BusinessError::Error`
+
+```ruby
+# new an error
+e = BusinessError::Error.new(
+  name = :invalid_token,
+  msg = 'your token is invalid',
+  code = 1001,
+  http_status = 400 # it is optional
+)
+
+e.info # => { code: 1001, msg: '...', http: 400 }
+e.message # => "{ code: 1001, msg: '...', http: 400 }"
+```
+
+### 3. Define Error
+
+#### 3.a Recommended Practice
+
+1. Create new directories `_docs/error` in the `/app` directory.
+
+2. Add `config.eager_load_paths << "#{Rails.root}/app/_docs"` to your `application.rb`.
+
+3. Create a base error class, like `api.rb`:
+    ```ruby
+    # app/_docs/error/api.rb
+    class Error::Api
+      extend BusinessError
+   
+      define :invalid_token, 'Your token is invalid', 1001
+    end
+    ```
+    The class method `define` will define an `BusinessError::Error` by the given
+    name, msg and code.
+    
+4. Now you can create more error class inherited from `Error::Api`:
+    ```ruby
+    class Error::Foo < Error::Api
+      define :bar, 'bar', 2002
+    end
+    ```
+    
+And then, try it in your console!
+
+```ruby
+Error::Api.invalid_token # => an instance of BusinessError::Error initialized by the given params
+Error::Foo.invalid_token # Yes, this error comes from inheritance!
+Error::Foo.bar           # This error is defined by itself
+
+# How to raise an error? -- Bang with the same name
+Error::Api.invalid_token! # => will raise an BusinessError::Error with defined message
+
+# Methods for getting all of error definitions
+#   Get the error class's error definitions
+Error::Api.print # It will print a YAML for showing it's groups and their error definitions
+#   Get this error class AND it's ancestors and descendants' error definition
+Error::Api.tree  # YAML also
+```
+
+#### 3.b Preventing error definition inheritance via grouping them
+
+```ruby
+# Error::Api
+group :group_name do 
+  define :foo, 'foo', 1
+  define :bar, 'bar', 2
+end
+# Then
+Error::Api.foo # ok
+Error::Foo.foo # NoMethodError!
+
+# method signature
+group group_name = :private, code_start_at = nil, http: 200, &block
+```
+
+#### 3.c Using the same name to define?
+
+NOT supported currently. It leads to method override,
+the last definition will leave.
+
+#### 3.x Skills
+
+1. Use `mattr_reader` instead of `define` (alias) IF you're using Rubymine.
+
+    It makes Rubymine auto completion more perfect.
+    
+2. Use `define_px` (define an error and group it into the group named that the prefix of error name)
+
+    ```ruby
+    define_px :create_failed, '', -1
+    # the same as below:
+    group :create do
+      define :create_failed, '', -1
+    end
+    # or
+    define :create_failed, '', -1, group: :create # or call `mattr_reader`
+    ```
+    
+3. Passing blank message:
+
+    ```ruby
+    define :create_failed, '', -1
+    # then, the message of this error will be:
+    :create_failed.to_s.humanize
+    ```
+    
+4. `code_start_at`
+
+    ```
+    code_start_at 0
+    define ... # code is 0
+    define ... # code is 1
+    define ... # code is 2
+ 
+    code_start_at -1
+    define ... # code is -1
+    define ... # code is -2
+    define ... # code is -3
+    ```
+    
+5. `http`
+    
+    ```
+    http 500
+    define ... # http is 500
+    define ... # http is 500
+    
+    http :forbidden
+    define ... # http is :forbidden (403)
+    ```
+
+### 4. Raise Error
+
+Just: error_name + bang!
+
+```ruby
+Error::Api.invalid_token! # => BusinessError::Error! with invalid_token's message
+```
+
+#### 4.a `with!` for error info customization
+
+```ruby
+Error::Api.invalid_token.with!(hello: 'world')
+# it will raise an invalid_token error with info:
+#   { code: 1001, msg: '...', http: 400, hello: 'world' }
+```
+
+#### 4.b `format!` in order to be compatible with different info format requirements
+
+error.info have a hash format defaults to:  
+`{ code: @code, msg: @msg, http: @http_status }`
+
+```ruby
+# Suppose we need a format called "old"
+# initializer
+config.formats[:old] = %i[ status message http ]
+
+# If:
+Error::Api.invalid_token.format!(:old)
+# it will raise an invalid_token error with info:
+#   { only: { status: 1001, message: '...', http: 400 } }
+
+Error::Api.invalid_token.format!(:old, hello: 'world') # it's ok
+```
+
+the key `only` is for [`output`]()
+
+More complex formatting is to be done:
+```ruby
+config.formats[:old] = { format: {
+  status: 0,
+  foo: {
+    bar: 'default value',
+    msg: 'success'
+  },
+  http: 200
+}, code: [:status], msg: [:foo, :msg], http: :http }
+```
+
+`format!` has an alias `render!`
+
+### 5. Rescue Error and render response by [`OutPut`]()
+
+Just do:
+```ruby
+output Error::Api.invalid_token
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/business_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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the BusinessError project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/business_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
+
+require "bundler/setup"
+require "business_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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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/business_error.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "business_error/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "business_error"
+  spec.version       = BusinessError::VERSION
+  spec.authors       = ["zhandao"]
+  spec.email         = ["x@skippingcat.com"]
+
+  spec.summary       = 'Business Error Management by using OOP'
+  spec.description   = 'Business Error Management by using OOP'
+  spec.homepage      = "http://github.com"
+  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 "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/business_error/config.rb

@@ -0,0 +1,11 @@
+module BusinessError
+  class Config
+    cattr_accessor :formats do
+      { }
+    end
+
+    cattr_accessor :default_http_status do
+      200
+    end
+  end
+end

data/lib/business_error/error.rb

@@ -0,0 +1,31 @@
+require 'business_error/config'
+
+module BusinessError
+  class Error < StandardError
+    attr_accessor :name, :msg, :code, :http_status
+
+    def initialize(name, msg, code, http_status = 200)
+      msg = name.to_s.humanize if msg.blank?
+      @name, @msg, @code, @http_status = name, msg, code, http_status
+    end
+
+    def info
+      @info ||= { code: @code, msg: @msg, http: @http_status }
+    end
+
+    def format!(template, **addition_content)
+      content = Config.formats[template].each_with_index.map { |k, i| [k, info.values[i]] }.to_h
+      @info = { only: content.merge(addition_content) }
+      raise self
+    end
+
+    alias render! format!
+
+    def with!(**addition_content)
+      info.merge!(addition_content)
+      raise self
+    end
+
+    def message; info.to_s end
+  end
+end

data/lib/business_error/version.rb

@@ -0,0 +1,3 @@
+module BusinessError
+  VERSION = '1.0.0'
+end

data/lib/business_error.rb

@@ -0,0 +1,83 @@
+require 'business_error/version'
+require 'business_error/error'
+require 'business_error/config'
+
+module BusinessError
+  cattr_accessor :defs_tree do
+    { }
+  end
+
+  attr_accessor :defs
+
+  def mattr_reader name, message = '', code = _get_code, http: _get_http, group: _get_group
+    message = name.to_s.humanize if message.blank?
+
+    define_singleton_method(name) { Error.new(name, message, code, http) }
+    # TODO raise Error, name, message, code
+    define_singleton_method("#{name}!") { raise Error.new(name, message, code, http) }
+
+    info = { name: name, msg: message, code: code, http: http }
+    if group == :public
+      (defs_tree[:public] ||= [ ]) << info
+    else
+      ((defs_tree[self.name] ||= { })[group] ||= [ ]) << info
+      ((@defs ||= { })[group] ||= []) << name
+    end
+  end
+
+  alias_method :define, :mattr_reader
+
+  def group group_name = :private, code_start_at = nil, http: 200, &block
+    @group_name, @code, @http, group_name, code_start_at, http = group_name, code_start_at, http, @group_name, @code, @http
+    instance_eval(&block)
+    @group_name, @code, @http, group_name, code_start_at, http = group_name, code_start_at, http, @group_name, @code, @http
+  end
+
+  def _get_group
+    @group_name || :public
+  end
+
+  def _get_code
+    code = @code
+    raise ArgumentError, 'Should give a code to define your business error' if code.nil?
+    @code = @code < 0 ? (code - 1) : (code + 1)
+    code
+  end
+
+  def code_start_at code
+    @code = code
+  end
+
+  def http status_code
+    @http_status = status_code
+  end
+
+  def _get_http
+    @http_status || Config.default_http_status
+  end
+
+  def define_px name, message = '', code = _get_code, http: _get_http
+    group_name = name.to_s.split('_').first.to_sym
+    group group_name do
+      mattr_reader name, message, code, http: http, group: group_name
+    end
+  end
+
+  def inherited(subclass)
+    defs_tree[self.name]&.keys&.each do |group|
+      defs_tree[self.name][group].each do |name:, **_|
+        # TODO: how to undef class method?
+        subclass.define_singleton_method(name) { raise NoMethodError }
+        subclass.define_singleton_method(name.to_s + '!') { raise NoMethodError }
+      end
+    end
+  end
+
+  def print
+    puts defs_tree[self.name].stringify_keys.to_yaml.gsub(' :', ' ')
+  end
+
+  def all
+    puts defs_tree.stringify_keys.to_yaml.gsub(' :', ' ')
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: business_error
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- zhandao
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-14 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: 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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Business Error Management by using OOP
+email:
+- x@skippingcat.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- business_error.gemspec
+- lib/business_error.rb
+- lib/business_error/config.rb
+- lib/business_error/error.rb
+- lib/business_error/version.rb
+homepage: http://github.com
+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.12
+signing_key: 
+specification_version: 4
+summary: Business Error Management by using OOP
+test_files: []