hanami-utils 0.7.2 → 0.8.0

data/lib/hanami/utils/basic_object.rb

@@ -10,7 +10,7 @@ module Hanami
       #
       # @see http://ruby-doc.org/core/Object.html#method-i-class
       def class
-        (class << self; self end).superclass
+        (class << self; self; end).superclass
       end
 
       # Bare minimum inspect for debugging purposes.
@@ -21,7 +21,7 @@ module Hanami
       #
       # @see http://ruby-doc.org/core/Object.html#method-i-inspect
       def inspect
-        "#<#{ self.class }:#{'%x' % (__id__ << 1)}#{ __inspect }>"
+        "#<#{self.class}:#{'%x' % (__id__ << 1)}#{__inspect}>" # rubocop:disable Style/FormatString
       end
 
       # Returns true if responds to the given method.
@@ -36,11 +36,12 @@ module Hanami
       end
 
       private
+
       # Must be overridden by descendants
       #
       # @since 0.3.5
       # @api private
-      def respond_to_missing?(method_name, include_all)
+      def respond_to_missing?(_method_name, _include_all)
         ::Kernel.raise ::NotImplementedError
       end
 

data/lib/hanami/utils/blank.rb

@@ -0,0 +1,45 @@
+module Hanami
+  module Utils
+    # Checks for blank
+    # @since 0.8.0
+    class Blank
+      # Matcher for blank strings
+      #
+      # @since 0.8.0
+      # @api private
+      STRING_MATCHER = /\A[[:space:]]*\z/
+
+      # Checks object is blank
+      #
+      # @example Basic Usage
+      #   require 'hanami/utils/blank'
+      #
+      #   Hanami::Utils::Blank.blank?(Hanami::Utils::String.new('')) # => true
+      #   Hanami::Utils::Blank.blank?('  ')                          # => true
+      #   Hanami::Utils::Blank.blank?(nil)                           # => true
+      #   Hanami::Utils::Blank.blank?(Hanami::Utils::Hash.new({}))   # => true
+      #   Hanami::Utils::Blank.blank?(true)                          # => false
+      #   Hanami::Utils::Blank.blank?(1)                             # => false
+      #
+      # @param object the argument
+      #
+      # @return [TrueClass,FalseClass]
+      #
+      # @since 0.8.0
+      def self.blank?(object) # rubocop:disable Metrics/MethodLength
+        case object
+        when String, ::String
+          STRING_MATCHER === object # rubocop:disable Style/CaseEquality
+        when Hash, ::Hash, ::Array
+          object.empty?
+        when TrueClass, Numeric
+          false
+        when FalseClass, NilClass
+          true
+        else
+          object.respond_to?(:empty?) ? !!object.empty? : !self
+        end
+      end
+    end
+  end
+end

data/lib/hanami/utils/callbacks.rb

@@ -16,7 +16,7 @@ module Hanami
         #
         # @since 0.2.0
         def initialize
-          @chain = Array.new
+          @chain = []
         end
 
         # Appends the given callbacks to the end of the chain.
@@ -168,14 +168,12 @@ module Hanami
           @chain.freeze
         end
 
-
         private
 
         def callables(callbacks, block)
           callbacks.push(block) if block
           callbacks.map { |c| Factory.fabricate(c) }
         end
-
       end
 
       # Callback factory

data/lib/hanami/utils/class.rb

@@ -41,6 +41,37 @@ module Hanami
         namespace.const_get(name.to_s)
       end
 
+      # Loads a class for the given name, only if it's defined.
+      #
+      # @param name [String, Class] the specific class name
+      # @param namespace [Class, Module] the Ruby namespace where we want to perform the lookup.
+      # @return [Class, Module, NilClass] the Ruby constant, or nil if not found.
+      #
+      # @since 0.8.0
+      #
+      # @example
+      #   require 'hanami/utils/class'
+      #
+      #   module App
+      #     module Service
+      #       class Endpoint
+      #       end
+      #     end
+      #
+      #     class ServiceEndpoint
+      #     end
+      #   end
+      #
+      #   # basic usage
+      #   Hanami::Utils::Class.load('App::Service') # => App::Service
+      #   Hanami::Utils::Class.load(App::Service)   # => App::Service
+      #
+      #   # with explicit namespace
+      #   Hanami::Utils::Class.load('Service', App) # => App::Service
+      def self.load(name, namespace = Object)
+        load!(name, namespace) if namespace.const_defined?(name.to_s)
+      end
+
       # Loads a class from the given pattern name and namespace
       #
       # @param pattern [String] the class name pattern
@@ -82,12 +113,12 @@ module Hanami
         String.new(pattern).tokenize do |token|
           begin
             return namespace.const_get(token)
-          rescue NameError
+          rescue NameError # rubocop:disable Lint/HandleExceptions
           end
         end
 
-        full_name = [ (namespace == Object ? nil : namespace), pattern ].compact.join('::')
-        raise NameError.new("uninitialized constant #{ full_name }")
+        full_name = [(namespace == Object ? nil : namespace), pattern].compact.join('::')
+        raise NameError.new("uninitialized constant #{full_name}")
       end
     end
   end

data/lib/hanami/utils/class_attribute.rb

@@ -12,6 +12,8 @@ module Hanami
         base.extend ClassMethods
       end
 
+      # @since 0.1.0
+      # @api private
       module ClassMethods
         # Defines a class level accessor for the given attribute(s).
         #
@@ -64,13 +66,14 @@ module Hanami
         #   SmallAirplane.wheels  # => 8
         def class_attribute(*attributes)
           singleton_class.class_eval do
-            attr_accessor *attributes
+            attr_accessor(*attributes)
           end
 
           class_attributes.merge(attributes)
         end
 
         protected
+
         # @see Class#inherited
         def inherited(subclass)
           class_attributes.each do |attr|
@@ -84,6 +87,7 @@ module Hanami
         end
 
         private
+
         # Class accessor for class attributes.
         # @private
         def class_attributes

data/lib/hanami/utils/deprecation.rb

@@ -58,10 +58,11 @@ module Hanami
       #     # => old_method is deprecated, please use new_method - called from: test.rb:20:in `start'.
       #     # => started
       def initialize(message)
-        ::Kernel.warn("#{ message } - called from: #{ caller[caller_index] }.")
+        ::Kernel.warn("#{message} - called from: #{caller[caller_index]}.")
       end
 
       private
+
       def caller_index
         Utils.jruby? || Utils.rubinius? ? 1 : 2
       end

data/lib/hanami/utils/duplicable.rb

@@ -45,7 +45,7 @@ module Hanami
       #   result = Hanami::Utils::Duplicable.dup(object)
       #
       #   puts result           # => "hello"
-      #   puts result.object_id # => 70172671467020 – Different object
+      #   puts result.object_id # => 70172671467020 - Different object
       #
       # @example Custom Logic
       #   require 'hanami/utils/duplicable'
@@ -64,7 +64,7 @@ module Hanami
       #   end
       #
       #   puts result           # => "{:a=>1}"
-      #   puts result.object_id # => 70207105185500 – Different object
+      #   puts result.object_id # => 70207105185500 - Different object
       def self.dup(value, &blk)
         case value
         when NilClass, FalseClass, TrueClass, Symbol, Numeric

data/lib/hanami/utils/escape.rb

@@ -11,7 +11,7 @@ module Hanami
     # @see https://www.owasp.org/index.php/XSS_(Cross_Site_Scripting)_Prevention_Cheat_Sheet
     # @see https://www.owasp.org/index.php/ESAPI
     # @see https://github.com/ESAPI/esapi-java-legacy
-    module Escape
+    module Escape # rubocop:disable Metrics/ModuleLength
       # Hex base for base 10 integer conversion
       #
       # @since 0.4.0
@@ -30,14 +30,14 @@ module Hanami
       #
       # @since 0.4.0
       # @api private
-      REPLACEMENT_HEX  = "fffd".freeze
+      REPLACEMENT_HEX = 'fffd'.freeze
 
       # Low hex codes lookup table
       #
       # @since 0.4.0
       # @api private
       HEX_CODES = (0..255).each_with_object({}) do |c, codes|
-        if (c >= 0x30 && c <= 0x39) || (c >= 0x41 && c <= 0x5A) || (c >= 0x61 && c <= 0x7A)
+        if (c >= 0x30 && c <= 0x39) || (c >= 0x41 && c <= 0x5A) || (c >= 0x61 && c <= 0x7A) # rubocop:disable Style/ConditionalAssignment
           codes[c] = nil
         else
           codes[c] = c.to_s(HEX_BASE)
@@ -362,7 +362,7 @@ module Hanami
       # @api private
       #
       # @see Hanami::Utils::Escape.url
-      DEFAULT_URL_SCHEMES = ['http', 'https', 'mailto'].freeze
+      DEFAULT_URL_SCHEMES = %w(http https mailto).freeze
 
       # The output of an escape.
       #
@@ -511,65 +511,66 @@ module Hanami
         return input if input.is_a?(SafeString)
 
         SafeString.new(
-          URI.extract(
-            URI.decode(input),
+          URI::Parser.new.extract(
+            URI.decode_www_form_component(input),
             schemes
           ).first.to_s
         )
       end
 
-      private
-      # Encode the given string into UTF-8
-      #
-      # @param input [String] the input
-      #
-      # @return [String] an UTF-8 encoded string
-      #
-      # @since 0.4.0
-      # @api private
-      def self.encode(input)
-        return '' if input.nil?
-        input.to_s.encode(Encoding::UTF_8)
-      rescue Encoding::UndefinedConversionError
-        input.dup.force_encoding(Encoding::UTF_8)
-      end
+      class << self
+        private
 
-      # Encode the given UTF-8 char.
-      #
-      # @param char [String] an UTF-8 char
-      # @param safe_chars [Hash] a table of safe chars
-      #
-      # @return [String] an HTML encoded string
-      #
-      # @since 0.4.0
-      # @api private
-      def self.encode_char(char, safe_chars = {})
-        return char if safe_chars[char]
+        # Encode the given string into UTF-8
+        #
+        # @param input [String] the input
+        #
+        # @return [String] an UTF-8 encoded string
+        #
+        # @since 0.4.0
+        # @api private
+        def encode(input)
+          return '' if input.nil?
+          input.to_s.encode(Encoding::UTF_8)
+        rescue Encoding::UndefinedConversionError
+          input.dup.force_encoding(Encoding::UTF_8)
+        end
 
-        code = char.ord
-        hex  = hex_for_non_alphanumeric_code(code)
-        return char if hex.nil?
+        # Encode the given UTF-8 char.
+        #
+        # @param char [String] an UTF-8 char
+        # @param safe_chars [Hash] a table of safe chars
+        #
+        # @return [String] an HTML encoded string
+        #
+        # @since 0.4.0
+        # @api private
+        def encode_char(char, safe_chars = {})
+          return char if safe_chars[char]
 
-        if NON_PRINTABLE_CHARS[code]
-          hex = REPLACEMENT_HEX
-        end
+          code = char.ord
+          hex  = hex_for_non_alphanumeric_code(code)
+          return char if hex.nil?
 
-        if entity = HTML_ENTITIES[code]
-          "&#{ entity };"
-        else
-          "&#x#{ hex };"
+          hex = REPLACEMENT_HEX if NON_PRINTABLE_CHARS[code]
+
+          if entity = HTML_ENTITIES[code] # rubocop:disable Lint/AssignmentInCondition
+            "&#{entity};"
+          else
+            "&#x#{hex};"
+          end
         end
-      end
 
-      # Transforms the given char code
-      #
-      # @since 0.4.0
-      # @api private
-      def self.hex_for_non_alphanumeric_code(input)
-        if input < LOW_HEX_CODE_LIMIT
-          HEX_CODES[input]
-        else
-          input.to_s(HEX_BASE)
+        # Transforms the given char code
+        #
+        # @since 0.4.0
+        # @api private
+        def hex_for_non_alphanumeric_code(input)
+          if input < LOW_HEX_CODE_LIMIT
+            HEX_CODES[input]
+          else
+            input.to_s(HEX_BASE)
+          end
         end
       end
     end

data/lib/hanami/utils/hash.rb

@@ -10,7 +10,7 @@ module Hanami
       #
       # @see Hanami::Utils::Hash#deep_dup
       # @see Hanami::Utils::Duplicable
-      DUPLICATE_LOGIC = Proc.new do |value|
+      DUPLICATE_LOGIC = proc do |value|
         case value
         when Hash
           value.deep_dup
@@ -65,7 +65,7 @@ module Hanami
       def symbolize!
         keys.each do |k|
           v = delete(k)
-          v = Hash.new(v).symbolize! if v.is_a?(::Hash)
+          v = self.class.new(v).symbolize! if v.is_a?(::Hash) || v.is_a?(self.class)
 
           self[k.to_sym] = v
         end
@@ -90,7 +90,7 @@ module Hanami
       def stringify!
         keys.each do |k|
           v = delete(k)
-          v = Hash.new(v).stringify! if v.is_a?(::Hash)
+          v = self.class.new(v).stringify! if v.is_a?(::Hash) || v.is_a?(self.class)
 
           self[k.to_s] = v
         end
@@ -160,8 +160,8 @@ module Hanami
       #   # it deeply duplicates Hanami::Utils::Hash, by preserving the class
       #   duped['u_hash'].class # => Hanami::Utils::Hash
       def deep_dup
-        Hash.new.tap do |result|
-          @hash.each {|k, v| result[k] = Duplicable.dup(v, &DUPLICATE_LOGIC) }
+        self.class.new.tap do |result|
+          @hash.each { |k, v| result[k] = Duplicable.dup(v, &DUPLICATE_LOGIC) }
         end
       end
 
@@ -229,7 +229,7 @@ module Hanami
         end
       end
 
-      alias_method :to_hash, :to_h
+      alias to_hash to_h
 
       # Converts into a nested array of [ key, value ] arrays.
       #
@@ -251,7 +251,7 @@ module Hanami
         @hash == other.to_h
       end
 
-      alias_method :eql?, :==
+      alias eql? ==
 
       # Returns the hash of the internal @hash
       #
@@ -283,7 +283,7 @@ module Hanami
           h = self.class.new(h) if h.is_a?(::Hash)
           h
         else
-          raise NoMethodError.new(%(undefined method `#{ m }' for #{ @hash }:#{ self.class }))
+          raise NoMethodError.new(%(undefined method `#{m}' for #{@hash}:#{self.class}))
         end
       end
 
@@ -291,7 +291,7 @@ module Hanami
       #
       # @api private
       # @since 0.3.0
-      def respond_to_missing?(m, include_private=false)
+      def respond_to_missing?(m, include_private = false)
         @hash.respond_to?(m, include_private)
       end
     end

data/lib/hanami/utils/inflector.rb

@@ -1,11 +1,14 @@
 require 'hanami/utils/class_attribute'
+require 'hanami/utils/blank'
 
 module Hanami
   module Utils
     # String inflector
     #
     # @since 0.4.1
-    module Inflector
+    #
+    # rubocop:disable Style/PerlBackrefs
+    module Inflector # rubocop:disable Metrics/ModuleLength
       # Rules for irregular plurals
       #
       # @since 0.6.0
@@ -40,12 +43,6 @@ module Hanami
         end
       end
 
-      # Matcher for blank strings
-      #
-      # @since 0.4.1
-      # @api private
-      BLANK_STRING_MATCHER = /\A[[:space:]]*\z/.freeze
-
       # @since 0.4.1
       # @api private
       A    = 'a'.freeze
@@ -142,6 +139,14 @@ module Hanami
       # @api private
       OUSE = 'ouse'.freeze
 
+      # @since 0.4.1
+      # @api private
+      RSE = 'rse'.freeze
+
+      # @since 0.4.1
+      # @api private
+      RSES = 'rses'.freeze
+
       # @since 0.4.1
       # @api private
       S    = 's'.freeze
@@ -193,61 +198,66 @@ module Hanami
       # @since 0.6.0
       # @api private
       class_attribute :plurals
-      self.plurals = IrregularRules.new({
+      self.plurals = IrregularRules.new(
         # irregular
-        'cactus'       => 'cacti',
-        'child'        => 'children',
-        'corpus'       => 'corpora',
-        'foot'         => 'feet',
-        'genus'        => 'genera',
-        'goose'        => 'geese',
-        'man'          => 'men',
-        'ox'           => 'oxen',
-        'person'       => 'people',
-        'quiz'         => 'quizzes',
-        'sex'          => 'sexes',
-        'testis'       => 'testes',
-        'tooth'        => 'teeth',
-        'woman'        => 'women',
+        'cactus'      => 'cacti',
+        'child'       => 'children',
+        'corpus'      => 'corpora',
+        'foot'        => 'feet',
+        'genus'       => 'genera',
+        'goose'       => 'geese',
+        'louse'       => 'lice',
+        'man'         => 'men',
+        'mouse'       => 'mice',
+        'ox'          => 'oxen',
+        'person'      => 'people',
+        'quiz'        => 'quizzes',
+        'sex'         => 'sexes',
+        'testis'      => 'testes',
+        'tooth'       => 'teeth',
+        'woman'       => 'women',
         # uncountable
-        'deer'         => 'deer',
-        'equipment'    => 'equipment',
-        'fish'         => 'fish',
-        'information'  => 'information',
-        'means'        => 'means',
-        'money'        => 'money',
-        'news'         => 'news',
-        'offspring'    => 'offspring',
-        'rice'         => 'rice',
-        'series'       => 'series',
-        'sheep'        => 'sheep',
-        'species'      => 'species',
+        'deer'        => 'deer',
+        'equipment'   => 'equipment',
+        'fish'        => 'fish',
+        'information' => 'information',
+        'means'       => 'means',
+        'money'       => 'money',
+        'news'        => 'news',
+        'offspring'   => 'offspring',
+        'rice'        => 'rice',
+        'series'      => 'series',
+        'sheep'       => 'sheep',
+        'species'     => 'species',
+        'police'      => 'police',
         # regressions
         # https://github.com/hanami/utils/issues/106
-        'album'        => 'albums',
-      })
+        'album'       => 'albums'
+      )
 
       # Irregular rules for singulars
       #
       # @since 0.6.0
       # @api private
       class_attribute :singulars
-      self.singulars = IrregularRules.new({
+      self.singulars = IrregularRules.new(
         # irregular
-        'cacti'   => 'cactus',
-        'children'=> 'child',
-        'corpora' => 'corpus',
-        'feet'    => 'foot',
-        'genera'  => 'genus',
-        'geese'   => 'goose',
-        'men'     => 'man',
-        'oxen'    => 'ox',
-        'people'  => 'person',
-        'quizzes' => 'quiz',
-        'sexes'   => 'sex',
-        'testes'  => 'testis',
-        'teeth'   => 'tooth',
-        'women'   => 'woman',
+        'cacti'    => 'cactus',
+        'children' => 'child',
+        'corpora'  => 'corpus',
+        'feet'     => 'foot',
+        'genera'   => 'genus',
+        'geese'    => 'goose',
+        'lice'     => 'louse',
+        'men'      => 'man',
+        'mice'     => 'mouse',
+        'oxen'     => 'ox',
+        'people'   => 'person',
+        'quizzes'  => 'quiz',
+        'sexes'    => 'sex',
+        'testes'   => 'testis',
+        'teeth'    => 'tooth',
+        'women'    => 'woman',
         # uncountable
         'deer'        => 'deer',
         'equipment'   => 'equipment',
@@ -263,9 +273,8 @@ module Hanami
         'species'     => 'species',
         'police'      => 'police',
         # fallback
-        'hives'       => 'hive',
-        'horses'      => 'horse',
-      })
+        'hives'       => 'hive'
+      )
 
       # Block for custom inflection rules.
       #
@@ -338,8 +347,12 @@ module Hanami
       #
       # @api private
       # @since 0.4.1
+      #
+      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/MethodLength
       def self.pluralize(string)
-        return string if string.nil? || string.match(BLANK_STRING_MATCHER)
+        return string if string.nil? || string =~ Utils::Blank::STRING_MATCHER
 
         case string
         when plurals
@@ -358,8 +371,6 @@ module Hanami
           string + TA
         when /\A(.*)(um|#{ A })\z/
           $1 + A
-        when /\A(.*)(ouse|#{ ICE })\z/
-          $1 + ICE
         when /\A(buffal|domin|ech|embarg|her|mosquit|potat|tomat)#{ O }\z/i
           $1 + OES
         when /\A(.*)(en|#{ INA })\z/
@@ -380,6 +391,9 @@ module Hanami
           string + S
         end
       end
+      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/MethodLength
 
       # Singularize the given string
       #
@@ -389,8 +403,13 @@ module Hanami
       #
       # @api private
       # @since 0.4.1
+      #
+      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/PerceivedComplexity
       def self.singularize(string)
-        return string if string.nil? || string.match(BLANK_STRING_MATCHER)
+        return string if string.nil? || string =~ Utils::Blank::STRING_MATCHER
 
         case string
         when singulars
@@ -399,18 +418,16 @@ module Hanami
           string.sub(CHES, CH)
         when /\A.*[^aeiou]#{IES}\z/
           string.sub(IES, Y)
-        when /\A(.*)#{ICE}\z/
-          $1 + OUSE
         when /\A.*#{EAUX}\z/
           string.chop
         when /\A(.*)#{IDES}\z/
           $1 + IS
         when /\A(.*)#{US}\z/
           $1 + I
+        when /\A(.*)#{RSES}\z/
+          $1 + RSE
         when /\A(.*)#{SES}\z/
           $1 + S
-        when /\A(.*)#{OUSE}\z/
-          $1 + ICE
         when /\A(.*)#{MATA}\z/
           $1 + MA
         when /\A(.*)#{OES}\z/
@@ -437,6 +454,11 @@ module Hanami
           string.chop
         end
       end
+      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/PerceivedComplexity
     end
+    # rubocop:enable Style/PerlBackrefs
   end
 end