errorio 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 502cae76ac9417bc9e015ce437234a58a26474e97529d93382ec71f392d04239
+  data.tar.gz: 220e4104a31586d23be4ac26a778c0f528eea61642fddce1068319c314d9757c
+SHA512:
+  metadata.gz: a3d9bd34ac75ed7a812ae791e50b6c335f12a7afc58797fcd620bd24b54fc37dce0bb8d9aa8c29bad483d0f7948a6ec4f6f7a03f6baff7a760f670b2db94ae8f
+  data.tar.gz: 562ca8487183bffab92272d0e816b9e13228af3bc9a2a30c6d5c2ba278854703f7c79d8fe2eea31ba0694dfb89bdcb745f76dbe0e23a92f0b55e962d12a0de7c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea

data/.rubocop.yml

@@ -0,0 +1,28 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+
+Layout/ExtraSpacing:
+  AllowForAlignment: true
+  AllowBeforeTrailingComments: true
+
+#Layout/HashAlignment:
+#  Enabled: false
+
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 120
+
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: final_newline, final_blank_line
+Layout/TrailingEmptyLines:
+  EnforcedStyle: final_newline
+  Enabled: true

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 vadym lukavyi
+
+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,150 @@
+# Errorio
+
+Extend your models and classes with errors, warnings and other notices
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'errorio'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install errorio
+
+## Usage
+
+Extend ordinary AR model with special collection of +warnings+ and +notices+
+
+```ruby
+class Task < ApplicationRecord
+  include Errorio
+  errorionize :errors, :warnings, :notices # :errors is initialized by ActiveRecord, so it is redundant in this case
+
+  validates :name, presence: { code: :E0230 }
+  validate :special_characters_validation
+
+  private
+
+  def special_characters_validation
+    return if name =~ /^[a-z0-9]*$/i
+    exceptions = name.gsub(/[^a-z0-9]/i).map{ |a| "'#{a}'" }.join(','),
+    warnings.add(:name, :special_characters, code: :E0231,
+                                             chars: exceptions,
+                                             message: 'Special characters are not recommended for name')
+  end
+end
+```
+
+```ruby
+result = Task.create
+result.errors.to_e
+```
+
+returns
+
+```
+[
+  {
+    :code=>:E0230,
+    :key=>:name,
+    :type=>:blank,
+    :message=>"Task Name can't be blank"
+  }
+]
+```
+
+```ruby
+result = Task.create name: 'Do * now!'
+result.errors.to_e # => []
+```
+
+```ruby
+result.warnings.to_e
+```
+
+returns
+
+```
+[
+  {
+    :code=>:E0231,
+    :key=>:name,
+    :type=>:special_characters,
+    :message=>"Special characters ('*', '!') are not recommended for name"
+  }
+]
+```
+
+Message for code `E0231` should be described in en.yml file
+
+```yaml
+errorio:
+  messages:
+    E0231: "Special characters (%{chars}) are not recommended for name"
+```
+
+Implement errors and warnings to service class
+
+```ruby
+class Calculate
+  include Errorio
+  errorionize :errors, :warnings
+
+  def initialize(a, b)
+    @a = a
+    @b = b
+  end
+
+  def sum
+    return unless valid?
+    a + b
+  end
+
+  def valid?
+    return true if @a.is_a?(Numeric) && @b.is_a?(Numeric)
+    errors.add :base, :not_a_numeric, Errorio.by_code(:E1000A)
+  end
+end
+
+calc = Calculate.new(3, '1')
+if (result = calc.sum)
+  puts result
+else
+  puts calc.errors.to_e
+end
+```
+
+returns
+
+```
+[
+  {
+    :code=>:E1000A,
+    :key=>:base,
+    :type=>:not_a_numeric,
+    :message=>"Special characters are not recommended for name"
+  }
+]
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/p9436/errorio.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'errorio'
+
+# 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/errorio.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'errorio/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'errorio'
+  spec.version       = Errorio::VERSION
+  spec.authors       = ['Vadym Lukavyi']
+  spec.email         = ['vadym.lukavyi@gmail.com']
+
+  spec.summary       = 'Extend standart functionality of ActiveRecord errors'
+  spec.homepage      = 'https://github.com/p9436/errorio'
+  spec.license       = 'MIT'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/p9436/errorio'
+    # 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.'
+  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
+    `git ls-files -z`.split("\x0").reject { |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.17'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rubocop', '~> 12.0'
+end

data/lib/errorio.rb

@@ -0,0 +1,189 @@
+require 'errorio/version'
+require 'errorio/details'
+require 'errorio/errors'
+require 'errorio/error'
+
+# Errorio
+#
+# Extend your models and classes with errors, warnings and other notices
+#
+# Examples:
+#
+# Extend ordinary AR model with special collection of +warnings+ and +notices+
+#
+# class Task < ApplicationRecord
+#   include Errorio
+#   errorionize :errors, :warnings, :notices # :errors is initialized by ActiveRecord, so it is redundant in this case
+#
+#   validates :name, presence: { code: :E0230 }
+#   validate :special_characters_validation
+#
+#   private
+#
+#   def special_characters_validation
+#     return if name =~ /^[a-z0-9]*$/i
+#     exceptions = name.gsub(/[^a-z0-9]/i).map{ |a| "'#{a}'" }.join(','),
+#     warnings.add(:name, :special_characters, code: :E0231,
+#                                              chars: exceptions,
+#                                              message: 'Special characters are not recommended for name')
+#   end
+# end
+#
+# result = Task.create
+# result.errors.to_e
+# =>
+# [
+#   {
+#     :code=>:E0230,
+#     :key=>:name,
+#     :type=>:blank,
+#     :message=>"Task Name can't be blank"
+#   }
+# ]
+#
+# result = Task.create 'Do * now!'
+# result.errors.to_e
+# =>
+# []
+# result.warnings.to_e
+# =>
+# [
+#   {
+#     :code=>:E0231,
+#     :key=>:name,
+#     :type=>:special_characters,
+#     :message=>"Special characters ('*', '!') are not recommended for name"
+#   }
+# ]
+#
+# Message should be described in en.yml file
+#
+# errorio:
+#   messages:
+#     E0231: "Special characters (%{chars}) are not recommended for name"
+#
+# Implement errors and warnings to service class
+#
+# class Calculate
+#   include Errorio
+#   errorionize :errors, :warnings
+#
+#   def initialize(a, b)
+#     @a = a
+#     @b = b
+#   end
+#
+#   def sum
+#     return unless valid?
+#     a + b
+#   end
+#
+#   def valid?
+#     return true if @a.is_a?(Numeric) && @b.is_a?(Numeric)
+#     errors.add :base, :not_a_numeric, Errorio.by_code(:E1000A)
+#   end
+# end
+#
+# calc = Calculate.new(3, '1')
+# if (result = calc.sum)
+#   puts result
+# else
+#   puts calc.errors.to_e
+# end
+#
+# => # [
+#   {
+#     :code=>:E1000A,
+#     :key=>:base,
+#     :type=>:not_a_numeric,
+#     :message=>"Special characters are not recommended for name"
+#   }
+# ]
+#
+module Errorio
+  class << self
+    # Error details with code
+    #
+    # errors.add :base, :invalid, Errorio.by_code(:E0001, user_id: 129)
+    def by_code(*args)
+      Details.by_code(*args)
+    end
+  end
+
+  def self.included(base)
+    base.extend ClassMethods
+    base.send :prepend, InstanceMethods
+  end
+
+  # Class-level methods
+  module ClassMethods
+    def errorionize(*collection_types)
+      raise unless collection_types.is_a?(Array)
+      @errorio_collection_types = collection_types.map(&:to_sym)
+    end
+
+    def errorio_collection_types
+      @errorio_collection_types
+    end
+  end
+
+  # Methods for targeted objects
+  module InstanceMethods
+    def initialize(*args)
+      errorio_initializer
+      super(*args)
+    end
+
+    def errorio_initializer
+      @errorio_repo = {}
+      self.class.errorio_collection_types.each do |e|
+        init_errors_variable(e)
+        if send(e).nil?
+          # Initialize
+          init_errors(e)
+        else
+          # Already initialized for instance, import objects to errorio
+          @errorio_repo[e] = send(e)
+        end
+
+        # Extend existing message handler
+        @errorio_repo[e].class.send :include, ErrorObjectsMethods unless @errorio_repo[e].class.respond_to?(:to_e)
+      end
+    end
+
+    # Add accessor if collection wasn't initialized
+    def init_errors_variable(e)
+      self.class.attr_accessor e unless respond_to?(e)
+    end
+
+    # Init errors class for errorio repo
+    def init_errors(e)
+      errors = Errors.new(self)
+      @errorio_repo[e] = errors
+      instance_variable_set("@#{e}", errors)
+    end
+
+    def errorio
+      @errorio_repo
+    end
+  end
+
+  # Methods for Error object
+  module ErrorObjectsMethods
+    def to_e
+      result = []
+
+      @errors.each do |err|
+        err_obj = err.options.merge(key: err.attribute, type: err.type, message: err.message)
+        result << err_obj
+      end
+      result
+    end
+
+    private
+
+    def err_to_object(err)
+      err.is_a?(Hash) ? err : { message: err.to_s }
+    end
+  end
+end

data/lib/errorio/details.rb

@@ -0,0 +1,20 @@
+module Errorio
+  # Some helpers
+  class Details
+    # Error details by code:
+    #
+    # errors.add :base, :invalid, Errorio.by_code(:E0001, user_id: 129)
+    # => {
+    #      code: :E0001,
+    #      message: "Invitation from user with ID 1823 was expired"
+    #      invited_by: 1823
+    #    }
+    def self.by_code(code, args = {})
+      msg = I18n.t("errorio.messages.#{code}", args)
+      {
+        code: code,
+        message: msg
+      }.merge(args)
+    end
+  end
+end

data/lib/errorio/error.rb

@@ -0,0 +1,30 @@
+module Errorio
+  # Error object for errors collection
+  class Error
+    def initialize(base, attribute, type, options)
+      @base = base
+      @attribute = attribute
+      @type = type
+      @options = options.symbolize_keys
+    end
+
+    attr_reader :base
+    attr_reader :attribute
+    attr_reader :type
+    attr_reader :options
+
+    def message
+      options[:message]
+    end
+
+    # Returns a full message for a given attribute.
+    # person.errors.full_message(:name, 'is invalid') # => "Name is invalid"
+    def full_message(attribute, message)
+      attr_name = attribute.to_s.tr('.', '_').humanize
+      return "#{attr_name} #{message}" if @base.nil?
+
+      attr_name = @base.class.human_attribute_name(attribute, default: attr_name)
+      I18n.t(:"errors.format", default: '%{attribute} %{message}', attribute: attr_name, message: message)
+    end
+  end
+end

data/lib/errorio/errors.rb

@@ -0,0 +1,46 @@
+module Errorio
+  # Collection of error objects
+  class Errors
+    extend Forwardable
+    def_delegators :@errors, :size, :clear, :blank?, :empty?, :uniq!, :any?
+
+    attr_reader :errors
+    alias objects errors
+
+    def initialize(base = nil)
+      @base = base
+      @errors = []
+    end
+
+    def add(attribute, type = :invalid, **options)
+      error = Error.new(@base, attribute, type, **options)
+
+      @errors.append(error)
+
+      error
+    end
+
+    # Returns all error attribute names
+    #
+    #   person.errors.messages        # => {:name=>["cannot be nil", "must be specified"]}
+    #   person.errors.attribute_names # => [:name]
+    def attribute_names
+      @errors.map(&:attribute).uniq.freeze
+    end
+    alias keys attribute_names
+
+    # Returns a full message for a given attribute.
+    # person.errors.full_message(:name, 'is invalid') # => "Name is invalid"
+    def full_message(attribute, message)
+      attr_name = attribute.to_s.tr('.', '_').humanize
+      return "#{attr_name} #{message}" if @base.nil?
+
+      attr_name = @base.class.human_attribute_name(attribute, default: attr_name)
+      I18n.t(:"errors.format", default: '%{attribute} %{message}', attribute: attr_name, message: message)
+    end
+
+    def each(&block)
+      @errors.each(&block)
+    end
+  end
+end

data/lib/errorio/version.rb

@@ -0,0 +1,3 @@
+module Errorio
+  VERSION = '0.1.1'.freeze
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: errorio
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Vadym Lukavyi
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+description:
+email:
+- vadym.lukavyi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- errorio.gemspec
+- lib/errorio.rb
+- lib/errorio/details.rb
+- lib/errorio/error.rb
+- lib/errorio/errors.rb
+- lib/errorio/version.rb
+homepage: https://github.com/p9436/errorio
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/p9436/errorio
+  source_code_uri: https://github.com/p9436/errorio
+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: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: Extend standart functionality of ActiveRecord errors
+test_files: []