erratum 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5adebb18c185bba738d9ade01bb25b422874cec3
-  data.tar.gz: 0c44bfaeca6bc92ecaaa1cdf0683ccb2bc0a5d13
+  metadata.gz: bcdf88a3d21177e27a3d39502aef4a053a0df0a4
+  data.tar.gz: fe5e579cc5677ceaa659a4153be16bd933de5b52
 SHA512:
-  metadata.gz: 7111601d73851f7f06fa0afe8bbb7efeb83ffb3b1977aaf223200689d9074e772c7427ade962d6a42230adbaa6efa415a53d189adcdd63eaf602fec9c2227f92
-  data.tar.gz: ffac65174a222d3ed9d1e5feb7472103d65946845de5955115a53328e6ac943d574f0a0ca6ef048afa471ef7274333101cde3d6588abf3adaa036b58f79ce6a6
+  metadata.gz: 993a890335e84d5277add854ca7cd60824e1a828116de2970cf8b239eb5e31b6b07c90526bb92cf6907a538ad1867ae3d2c81584effade2296ad1094694224c4
+  data.tar.gz: 35c74a023b357c73d21f7930f931a8592e7b6aa4ccfb4f65883350866ae995b489f2e20a1ec09b40f1ae1531e57b4ccc959f9ff568414eec8747e2ca166ec8ac

data/lib/erratum/configurable.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'erratum/configuration'
+
+module  Erratum
+module  Configurable
+  module ClassMethods
+    def configure
+      yield configuration
+    end
+
+    def configuration
+      ::Erratum::Configuration.instance
+    end
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  def configuration
+    ::Erratum::Configuration.instance
+  end
+end
+end

data/lib/erratum/configuration.rb

@@ -2,7 +2,7 @@
 
 require 'singleton'
 
-class   Erratum
+module  Erratum
   class Configuration
     include Singleton
 
@@ -31,10 +31,6 @@ class   Erratum
     end
   end
 
-  def configuration
-    Configuration.instance
-  end
-
   def self.configure
     yield configuration
   end

data/lib/erratum/error.rb

@@ -1,15 +1,17 @@
 # frozen_string_literal: true
 
 require 'json'
-require 'erratum/configuration'
+require 'erratum/configurable'
 require 'erratum/utilities/string'
 
-class   Erratum
+module  Erratum
 module  Error
+  include Configurable
+
   module ClassMethods
     def wrap(other)
-      wrapped_error = new message: "#{other.class.name}: #{other.message}"
-      wrapped_error.set_backtrace other.backtrace
+      wrapped_error = new(message: "#{other.class.name}: #{other.message}")
+      wrapped_error.set_backtrace(other.backtrace)
       wrapped_error
     end
   end
@@ -97,11 +99,5 @@ module  Error
   def self.included(base)
     base.extend ClassMethods
   end
-
-  private
-
-  def configuration
-    Erratum.configuration
-  end
 end
 end

data/lib/erratum/errors/authentication_error.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-require 'erratum/error'
-
-class   Erratum
+module  Erratum
 module  Errors
 module  AuthenticationError
 end

data/lib/erratum/errors/authentication_errors/duplicate_authentication_error.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
+require 'erratum/error'
 require 'erratum/errors/authentication_error'
 
-class   Erratum
+module  Erratum
 module  Errors
 class   DuplicateAuthenticationError < RuntimeError
   include Error
@@ -21,9 +22,11 @@ class   DuplicateAuthenticationError < RuntimeError
   end
 
   def detail
-    'The authentication you attempted to register has already been registered by ' \
-    'another user. We do not currently support allowing multiple users to be connected ' \
-    'to the same authentication.'
+    <<~HEREDOC.chomp.tr("\n", ' ')
+      The authentication you attempted to register has already been registered
+      by another user. We do not currently support allowing multiple users to be
+      connected to the same authentication.
+    HEREDOC
   end
 
   def source

data/lib/erratum/errors/authentication_errors/invalid_token_error.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
+require 'erratum/error'
 require 'erratum/errors/authentication_error'
 
-class   Erratum
+module  Erratum
 module  Errors
 class   InvalidTokenError < RuntimeError
   include Error
@@ -19,8 +20,10 @@ class   InvalidTokenError < RuntimeError
   end
 
   def detail
-    'The token you attempted to use for this request is invalid for this resource.  ' \
-    'Please double-check and try again.'
+    <<~HEREDOC.chomp.tr("\n", ' ')
+      The token you attempted to use for this request is invalid for this resource.
+      Please double-check and try again.
+    HEREDOC
   end
 
   def source

data/lib/erratum/errors/authentication_errors/invalid_username_or_password_error.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
+require 'erratum/error'
 require 'erratum/errors/authentication_error'
 
-class   Erratum
+module  Erratum
 module  Errors
 class   InvalidUsernameOrPasswordError < RuntimeError
   include Error
@@ -19,8 +20,10 @@ class   InvalidUsernameOrPasswordError < RuntimeError
   end
 
   def detail
-    'Either the username or password passed in or this request is invalid.  Please ' \
-    'double-check and try again.'
+    <<~HEREDOC.chomp.tr("\n", ' ')
+      Either the username or password passed in or this request is invalid.
+      Please double-check and try again.
+    HEREDOC
   end
 
   def source

data/lib/erratum/errors/authorization_error.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-require 'erratum/error'
-
-class   Erratum
+module  Erratum
 module  Errors
 module  AuthorizationError
 end

data/lib/erratum/errors/authorization_errors/forbidden_error.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
+require 'erratum/error'
 require 'erratum/errors/authorization_error'
 
-class   Erratum
+module  Erratum
 module  Errors
 class   ForbiddenError < RuntimeError
   include Error
@@ -29,8 +30,10 @@ class   ForbiddenError < RuntimeError
                         "#{action} the #{resource_name} with ID #{resource_id}"
                       end
 
-    "You do not have access to #{detail_quantity}. Providing a different set of " \
-    "credentials may potentially allow you access to this resource."
+    <<~HEREDOC.chomp.tr("\n", ' ')
+      You do not have access to #{detail_quantity}. Providing a different set of
+      credentials may potentially allow you access to this resource.
+    HEREDOC
   end
 
   def source

data/lib/erratum/errors/crud_error.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
-class   Erratum
+module  Erratum
 module  Errors
 module  CrudError
-  attr_accessor :resource_name,
-                :action,
-                :resource_id
+  attr_accessor :action,
+                :resource_id,
+                :resource_name
 
-  def initialize(resource_name: nil, action: nil, resource_id: nil, **args)
-    self.resource_name = resource_name
-    self.action        = action || 'persist'
+  def initialize(action: 'persist', resource_id: nil, resource_name: nil, **args)
+    self.action        = action
     self.resource_id   = resource_id
+    self.resource_name = resource_name
 
     super(**args)
   end

data/lib/erratum/errors/crud_errors/association_error.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
+require 'erratum/error'
 require 'erratum/errors/crud_error'
 
-class   Erratum
+module  Erratum
 module  Errors
 class   AssociationError < RuntimeError
   include Error
@@ -40,8 +41,10 @@ class   AssociationError < RuntimeError
   end
 
   def detail
-    "The #{association_name} that you attempted to associate with " \
-    "the #{resource_name} was not valid."
+    <<~HEREDOC.chomp.tr("\n", ' ')
+      The #{association_name} that you attempted to associate with the
+      #{resource_name} was not valid.
+    HEREDOC
   end
 
   def source

data/lib/erratum/errors/crud_errors/resource_not_found_error.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
+require 'erratum/error'
 require 'erratum/errors/crud_error'
 
-class   Erratum
+module  Erratum
 module  Errors
 class   ResourceNotFoundError < RuntimeError
   include Error
@@ -37,8 +38,10 @@ class   ResourceNotFoundError < RuntimeError
   end
 
   def detail
-    "The #{resource_name} you attempted to #{action} for this request is either " \
-    "not authorized for the authenticated user or does not exist."
+    <<~HEREDOC.chomp.tr("\n", ' ')
+      The #{resource_name} you attempted to #{action} for this request is either
+      not authorized for the authenticated user or does not exist.
+    HEREDOC
   end
 
   def source

data/lib/erratum/errors/crud_errors/resource_persistence_error.rb

@@ -3,7 +3,7 @@
 require 'erratum/error'
 require 'erratum/errors/crud_error'
 
-class   Erratum
+module  Erratum
 module  Errors
 class   ResourcePersistenceError < RuntimeError
   include Error
@@ -40,8 +40,10 @@ class   ResourcePersistenceError < RuntimeError
   end
 
   def detail
-    @detail || "One or more of the attributes on the #{resource_name} you attempted " \
-               "to #{action} is invalid."
+    @detail || <<~HEREDOC.chomp.tr("\n", ' ')
+      One or more of the attributes on the #{resource_name} you attempted to
+      #{action} is invalid.
+    HEREDOC
   end
 
   def source

data/lib/erratum/errors/request_errors/parameter_missing_error.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
-class   Erratum
+require 'erratum/error'
+require 'erratum/errors/crud_error'
+
+module  Erratum
 module  Errors
 class   ParameterMissingError < RuntimeError
   include Error
@@ -30,8 +33,10 @@ class   ParameterMissingError < RuntimeError
   end
 
   def detail
-    "When attempting to #{action} a #{resource_name}, '#{parameter}' is a " \
-    "required parameter."
+    <<~HEREDOC.chomp.tr("\n", ' ')
+      When attempting to #{action} a #{resource_name}, '#{parameter}' is
+      a required parameter.
+    HEREDOC
   end
 
   def source

data/lib/erratum/errors/request_errors/unpermitted_parameters_error.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
-class   Erratum
+require 'erratum/error'
+require 'erratum/errors/crud_error'
+
+module  Erratum
 module  Errors
 class   UnpermittedParametersError < RuntimeError
   include Error

data/lib/erratum/rescuable_resource.rb

@@ -2,7 +2,7 @@
 
 require 'erratum/resource_naming'
 
-class   Erratum
+module  Erratum
 module  RescuableResource
   def self.included(base)
     base.include ResourceNaming
@@ -13,10 +13,12 @@ module  RescuableResource
                      'ActiveRecord::InvalidForeignKey',
                      'ActionController::ParameterMissing',
                      'ActionController::UnpermittedParameters' do |exception|
-      erratum = Erratum.convert(exception,
-                                resource_name: self.class.singular_resource_name,
-                                action:        action_name)
-      erratum = Array(erratum)
+
+      erratum = Array(
+                  Erratum.convert(exception,
+                                  resource_name: self.class.singular_resource_name,
+                                  action:        action_name),
+                )
 
       render json:   Hash['errors' => erratum.as_json],
              status: erratum.first.http_status

data/lib/erratum/resource_naming.rb

@@ -1,32 +1,42 @@
 # frozen_string_literal: true
 
-class   Erratum
+require 'erratum/utilities/string'
+
+module  Erratum
 module  ResourceNaming
   CONTROLLER_RESOURCE_NAME_PATTERN = /\A((.*?::)?.*?)(\w+)Controller\z/
 
-  module ClassMethods
-    def plural_resource_name
-      @plural_resource_name ||= name[CONTROLLER_RESOURCE_NAME_PATTERN, 3]
-                                  .underscore
-                                  .pluralize
-                                  .downcase
-    end
+  def plural_underscored_base_resource_name
+    @plural_underscored_base_resource_name ||= \
+      ::Erratum::Utilities::String.pluralize(
+        ::Erratum::Utilities::String.underscore(
+          plural_resource_base_class_name,
+        ),
+      )
+        .downcase
+  end
 
-    def singular_resource_name
-      @singular_resource_name ||= name[CONTROLLER_RESOURCE_NAME_PATTERN, 3]
-                                    .underscore
-                                    .singularize
-                                    .downcase
-    end
+  def singular_underscored_base_resource_name
+    @singular_underscored_base_resource_name ||= \
+      ::Erratum::Utilities::String.singularize(
+        ::Erratum::Utilities::String.underscore(
+          plural_resource_base_class_name,
+        ),
+      )
+        .downcase
+  end
 
-    def resource_class_name
-      @resource_class_name ||= singular_resource_name
-                                 .camelize
-    end
+  def singular_resource_base_class_name
+    @singular_resource_base_class_name ||= \
+      ::Erratum::Utilities::String
+        .singularize(plural_resource_base_class_name)
   end
 
-  def self.included(base)
-    base.extend ClassMethods
+  def plural_resource_base_class_name
+    @plural_resource_base_class_name ||= \
+      ::Erratum::Utilities::String.pluralize(
+        name[CONTROLLER_RESOURCE_NAME_PATTERN, 3],
+      )
   end
 end
 end

data/lib/erratum/utilities/string.rb

@@ -1,9 +1,137 @@
 # frozen_string_literal: true
 
-class   Erratum
+module  Erratum
 module  Utilities
 class   String
+  # rubocop:disable Style/PerlBackrefs
+  def self.camelize(other, uppercase_first_letter = true)
+    return unless other
+    return other.camelize if defined?(ActiveSupport::Inflector)
+
+    string = other.to_s
+
+    string = if uppercase_first_letter
+               string.sub(/^[a-z\d]*/, &:capitalize)
+             else
+               string.downcase
+             end
+
+    string.gsub!(%r{(?:_|(/))([a-z\d]*)}i) do
+      "#{$1}#{acronyms[$2] || $2.capitalize}"
+    end
+
+    string.gsub!('/', '::')
+
+    string
+  end
+  # rubocop:enable Style/PerlBackrefs
+
+  # rubocop:disable Metrics/MethodLength
+  def self.pluralize(other)
+    return unless other
+    return other.pluralize if defined?(ActiveSupport::Inflector)
+
+    result = other.to_s.dup
+
+    inflections = {
+      'person'                     => 'people',
+      'man'                        => 'men',
+      'child'                      => 'children',
+      'sex'                        => 'sexes',
+      'move'                       => 'moves',
+      'zombie'                     => 'zombies',
+      /(quiz)$/i                   => '\1zes',
+      /^(oxen)$/i                  => '\1',
+      /^(ox)$/i                    => '\1en',
+      /^(m|l)ice$/i                => '\1ice',
+      /^(m|l)ouse$/i               => '\1ice',
+      /(matr|vert|ind)(?:ix|ex)$/i => '\1ices',
+      /(x|ch|ss|sh)$/i             => '\1es',
+      /([^aeiouy]|qu)y$/i          => '\1ies',
+      /(hive)$/i                   => '\1s',
+      /(?:([^f])fe|([lr])f)$/i     => '\1\2ves',
+      /sis$/i                      => 'ses',
+      /([ti])a$/i                  => '\1a',
+      /([ti])um$/i                 => '\1a',
+      /(buffal|tomat)o$/i          => '\1oes',
+      /(bu)s$/i                    => '\1ses',
+      /(alias|status)$/i           => '\1es',
+      /(octop|vir)i$/i             => '\1i',
+      /(octop|vir)us$/i            => '\1i',
+      /^(ax|test)is$/i             => '\1es',
+      /s$/i                        => 's',
+      /$/                          => 's',
+    }
+
+    inflections.each do |(rule, replacement)|
+      break if result.sub!(rule, replacement)
+    end
+
+    result
+  end
+  # rubocop:enable Metrics/MethodLength
+
+  # rubocop:disable Metrics/MethodLength, Metrics/AlignHash
+  def self.singularize(other)
+    return unless other
+    return other.singularize if defined?(ActiveSupport::Inflector)
+
+    result = other.to_s.dup
+
+    inflections = {
+      /(database)s$/i         => '\1',
+      /(quiz)zes$/i           => '\1',
+      /(matr)ices$/i          => '\1ix',
+      /(vert|ind)ices$/i      => '\1ex',
+      /^(ox)en/i              => '\1',
+      /(alias|status)(es)?$/i => '\1',
+      /(octop|vir)(us|i)$/i   => '\1us',
+      /^(a)x[ie]s$/i          => '\1xis',
+      /(cris|test)(is|es)$/i  => '\1is',
+      /(shoe)s$/i             => '\1',
+      /(o)es$/i               => '\1',
+      /(bus)(es)?$/i          => '\1',
+      /^(m|l)ice$/i           => '\1ouse',
+      /(x|ch|ss|sh)es$/i      => '\1',
+      /(m)ovies$/i            => '\1ovie',
+      /(s)eries$/i            => '\1eries',
+      /([^aeiouy]|qu)ies$/i   => '\1y',
+      /([lr])ves$/i           => '\1f',
+      /(tive)s$/i             => '\1',
+      /(hive)s$/i             => '\1',
+      /([^f])ves$/i           => '\1fe',
+      /(^analy)(sis|ses)$/i   => '\1sis',
+      /
+        (
+          (a)naly     |
+          (b)a        |
+          (d)iagno    |
+          (p)arenthe  |
+          (p)rogno    |
+          (s)ynop     |
+          (t)he
+        )
+        (sis|ses)
+        $
+      /xi                     => '\1sis',
+      /([ti])a$/i             => '\1um',
+      /(n)ews$/i              => '\1ews',
+      /(ss)$/i                => '\1',
+      /s$/i                   => '',
+    }
+
+    inflections.each do |(rule, replacement)|
+      break if result.sub!(rule, replacement)
+    end
+
+    result
+  end
+  # rubocop:enable Metrics/MethodLength, Metrics/AlignHash
+
   def self.underscore(other)
+    return unless other
+    return other.underscore if defined?(ActiveSupport::Inflector)
+
     word = other.to_s.gsub('::', '/')
     word.gsub!(/(?:([A-Za-z\d])|^)(?=\b|[^a-z])/) do
       "#{Regexp.last_match(1)}#{Regexp.last_match(1) && ''}"

data/lib/erratum/verifiable_resource.rb

@@ -2,7 +2,7 @@
 
 require 'erratum/resource_naming'
 
-class   Erratum
+module  Erratum
 module  VerifiableResource
   def self.included(base)
     base.include ResourceNaming

data/lib/erratum/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-class Erratum
-  VERSION = '2.0.0'
+module Erratum
+  VERSION = '3.0.0'
 end

data/lib/erratum.rb

@@ -2,12 +2,12 @@
 
 require 'erratum/configuration'
 require 'erratum/error'
-require 'erratum/errors/authorization_error'
-require 'erratum/errors/authorization_errors/forbidden_error'
 require 'erratum/errors/authentication_error'
 require 'erratum/errors/authentication_errors/duplicate_authentication_error'
 require 'erratum/errors/authentication_errors/invalid_token_error'
 require 'erratum/errors/authentication_errors/invalid_username_or_password_error'
+require 'erratum/errors/authorization_error'
+require 'erratum/errors/authorization_errors/forbidden_error'
 require 'erratum/errors/crud_error'
 require 'erratum/errors/crud_errors/association_error'
 require 'erratum/errors/crud_errors/resource_not_found_error'
@@ -18,7 +18,7 @@ require 'erratum/rescuable_resource'
 require 'erratum/verifiable_resource'
 require 'erratum/version'
 
-class   Erratum
+module  Erratum
   def self.fetch(error_type)
     Object.const_get("Erratum::Errors::#{error_type}")
   end

data.tar.gz.sig

@@ -1,5 +1 @@
-o\)�[,��
v�`r��=d'����`x�:�)�OBRjj,������l��a8�R)R�X��k J�'hX��
-�0�&�<��"xߴn{�.D�ݫ �Le���&?��X�=M��УV��#oD1=�rJ
-�3#��vB�[3�)c�=��
�^�Z�|8�����MG{o�1��[�ՊV�����
-��]z��,5�Q���wu"00S&%���m6;��X�W�P	�IP:d:�>�HP��\�؀
-W���.��m
+i�����Q�i&τ��<�L��f����fpG�\�W�����b&�׍��y�h��i������U�.�-ֶP��"o�$��#��0��Y��#K�����5�!�]Z�|��B�x㐜�~_��n�!������w��9,%��`x�c��9E3L1]ѣ

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: erratum
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - thegranddesign
@@ -31,7 +31,7 @@ cert_chain:
   Y2GAoHKstmfIVhc4XHOPpmTd2o/C29O9oaRgjrkfQEhF/KvJ/PhoV5hvokzsCyI5
   iUeXPfvrGD/itYIBCgk+fnzyQQ4QtE5hTQaWQ3o2
   -----END CERTIFICATE-----
-date: 2018-01-24 00:00:00.000000000 Z
+date: 2018-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -111,6 +111,7 @@ files:
 - LICENSE.txt
 - README.md
 - lib/erratum.rb
+- lib/erratum/configurable.rb
 - lib/erratum/configuration.rb
 - lib/erratum/error.rb
 - lib/erratum/errors/authentication_error.rb