hanami-utils 1.3.8 → 2.0.0.alpha1

data/lib/hanami/utils/json.rb

@@ -43,7 +43,7 @@ module Hanami
       end
       # rubocop:enable Style/ClassVars
 
-      # Parses the given JSON paylod
+      # Parse the given JSON paylod
       #
       # @param payload [String] a JSON payload
       #

data/lib/hanami/utils/kernel.rb

@@ -9,7 +9,7 @@ require "hanami/utils"
 require "hanami/utils/string"
 
 unless defined?(Boolean)
-  # Defines top level constant Boolean, so it can be easily used by other libraries
+  # Define top level constant Boolean, so it can be easily used by other libraries
   # in coercions DSLs
   #
   # @since 0.3.0
@@ -327,7 +327,7 @@ module Hanami
       #   # big complex represented as a string
       #   input = Complex(2, 3)
       #   Hanami::Utils::Kernel.Integer(input) # => TypeError
-      def self.Integer(arg)
+      def self.Integer(arg) # rubocop:disable Metrics/MethodLength
         super(arg)
       rescue ArgumentError, TypeError, NoMethodError
         begin
@@ -418,6 +418,7 @@ module Hanami
       #   input = BasicObject.new
       #   Hanami::Utils::Kernel.BigDecimal(input) # => TypeError
       #
+      # rubocop:disable Metrics/MethodLength
       def self.BigDecimal(arg, precision = ::Float::DIG)
         case arg
         when NilClass # This is only needed by Ruby 2.6
@@ -434,6 +435,7 @@ module Hanami
       rescue NoMethodError
         raise TypeError.new "can't convert #{inspect_type_error(arg)}into BigDecimal"
       end
+      # rubocop:enable Metrics/MethodLength
 
       # Coerces the argument to be a Float.
       #
@@ -547,7 +549,7 @@ module Hanami
       #   # big complex represented as a string
       #   input = Complex(2, 3)
       #   Hanami::Utils::Kernel.Float(input) # => TypeError
-      def self.Float(arg)
+      def self.Float(arg) # rubocop:disable Metrics/MethodLength
         super(arg)
       rescue ArgumentError, TypeError
         begin
@@ -736,8 +738,7 @@ module Hanami
       #   require 'hanami/utils/kernel'
       #
       #   Hanami::Utils::Kernel.DateTime(3483943)
-      #     # => Time.at(3483943).to_datetime
-      #     # #<DateTime: 1970-02-10T08:45:43+01:00 ((2440628j,27943s,0n),+3600s,2299161j)>
+      #     # => Time.at(3483943).to_datetime #<DateTime: 1970-02-10T08:45:43+01:00 ((2440628j,27943s,0n),+3600s,2299161j)>
       #
       #   Hanami::Utils::Kernel.DateTime(DateTime.now)
       #     # => #<DateTime: 2014-04-18T09:33:49+02:00 ((2456766j,27229s,690849000n),+7200s,2299161j)>
@@ -897,7 +898,7 @@ module Hanami
       #   # Missing #respond_to?
       #   input = BasicObject.new
       #   Hanami::Utils::Kernel.Boolean(input) # => TypeError
-      def self.Boolean(arg)
+      def self.Boolean(arg) # rubocop:disable Metrics/MethodLength
         case arg
         when Numeric
           arg.to_i == BOOLEAN_TRUE_INTEGER
@@ -1022,7 +1023,7 @@ module Hanami
         raise TypeError.new "can't convert #{inspect_type_error(arg)}into Symbol"
       end
 
-      # Checks if the given argument is a string representation of a number
+      # Check if the given argument is a string representation of a number
       #
       # @param arg [Object] the input
       #
@@ -1043,11 +1044,11 @@ module Hanami
       # @since 0.4.3
       # @api private
       def self.inspect_type_error(arg)
-        (arg.respond_to?(:inspect) ? arg.inspect : arg.to_s) + " "
-      rescue NoMethodError
+        (arg.respond_to?(:inspect) ? arg.inspect : arg.to_s) << " "
+      rescue NoMethodError => _
         # missing the #respond_to? method, fall back to returning the class' name
         begin
-          arg.class.name + " instance "
+          arg.class.name << " instance "
         rescue NoMethodError
           # missing the #class method, can't fall back to anything better than nothing
           # Callers will have to guess from their code
@@ -1056,7 +1057,7 @@ module Hanami
       end
 
       class << self
-        private :inspect_type_error
+        private :inspect_type_error # rubocop:disable Style/AccessModifierDeclarations
       end
     end
   end

data/lib/hanami/utils/load_paths.rb

@@ -50,7 +50,7 @@ module Hanami
         @paths = original.instance_variable_get(:@paths).dup
       end
 
-      # Iterates through the collection and yields the given block.
+      # Iterates thru the collection and yields the given block.
       # It skips duplications and raises an error in case one of the paths
       # doesn't exist.
       #
@@ -117,7 +117,7 @@ module Hanami
         self
       end
 
-      alias_method :<<, :push
+      alias << push
 
       # It freezes the object by preventing further modifications.
       #
@@ -158,7 +158,7 @@ module Hanami
 
       private
 
-      # Allows subclasses to define their own policy to discover the realpath
+      # Allow subclasses to define their own policy to discover the realpath
       # of the given path.
       #
       # @since 0.2.0

data/lib/hanami/utils/query_string.rb

@@ -12,7 +12,7 @@ module Hanami
       # @api private
       HASH_SEPARATOR = ","
 
-      # Serializes input into a query string
+      # Serialize input into a query string
       #
       # @param input [Object] the input
       #

data/lib/hanami/utils/shell_color.rb

@@ -18,22 +18,22 @@ module Hanami
         end
       end
 
-      # Escapes codes for terminals to output strings in colors
+      # Escape codes for terminals to output strings in colors
       #
       # @since 1.2.0
       # @api private
       COLORS = ::Hash[
-        black: 30,
-        red: 31,
-        green: 32,
-        yellow: 33,
-        blue: 34,
+        black:   30,
+        red:     31,
+        green:   32,
+        yellow:  33,
+        blue:    34,
         magenta: 35,
-        cyan: 36,
-        gray: 37,
+        cyan:    36,
+        gray:    37,
       ].freeze
 
-      # Colorizes output
+      # Colorize output
       # 8 colors available: black, red, green, yellow, blue, magenta, cyan, and gray
       #
       # @param input [#to_s] the string to colorize

data/lib/hanami/utils/string.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "hanami/utils/inflector"
 require "transproc"
 require "concurrent/map"
 
@@ -9,7 +8,7 @@ module Hanami
     # String on steroids
     #
     # @since 0.1.0
-    class String
+    class String # rubocop:disable Metrics/ClassLength
       # Empty string for #classify
       #
       # @since 0.6.0
@@ -74,17 +73,16 @@ module Hanami
       #
       # @since 0.3.4
       # @api private
-      CLASSIFY_WORD_SEPARATOR = /#{CLASSIFY_SEPARATOR}|#{NAMESPACE_SEPARATOR}|#{UNDERSCORE_SEPARATOR}|#{DASHERIZE_SEPARATOR}/.freeze # rubocop:disable Layout/LineLength
+      CLASSIFY_WORD_SEPARATOR = /#{CLASSIFY_SEPARATOR}|#{NAMESPACE_SEPARATOR}|#{UNDERSCORE_SEPARATOR}|#{DASHERIZE_SEPARATOR}/.freeze
 
       @__transformations__ = Concurrent::Map.new
 
       extend Transproc::Registry
       extend Transproc::Composer
 
-      # Applies the given transformation(s) to `input`
+      # Apply the given transformation(s) to `input`
       #
-      # It performs a pipeline of transformations, by applying the given
-      # functions from `Hanami::Utils::String` and `::String`.
+      # It performs a pipeline of transformations, by applying the given functions from `Hanami::Utils::String` and `::String`.
       # The transformations are applied in the given order.
       #
       # It doesn't mutate the input, unless you use destructive methods from `::String`
@@ -132,6 +130,8 @@ module Hanami
       #   Hanami::Utils::String.transform("Cherry", -> { "blossom" }))
       #     # => ArgumentError: wrong number of arguments (given 1, expected 0)
       #
+      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/MethodLength
       def self.transform(input, *transformations)
         fn = @__transformations__.fetch_or_store(transformations.hash) do
           compose do |fns|
@@ -143,7 +143,7 @@ module Hanami
                      elsif input.respond_to?(transformation)
                        t(:bind, input, ->(i) { i.public_send(transformation, *args) })
                      else
-                       raise NoMethodError.new(%(undefined method `#{transformation.inspect}' for #{input.inspect}:#{input.class})) # rubocop:disable Layout/LineLength
+                       raise NoMethodError.new(%(undefined method `#{transformation.inspect}' for #{input.inspect}:#{input.class}))
                      end
             end
           end
@@ -151,6 +151,8 @@ module Hanami
 
         fn.call(input)
       end
+      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/AbcSize
 
       # Extracted from `transproc` source code
       #
@@ -163,7 +165,7 @@ module Hanami
         binding.instance_exec(value, &fun)
       end
 
-      # Returns a titleized version of the string
+      # Return a titleized version of the string
       #
       # @param input [::String] the input
       #
@@ -180,7 +182,7 @@ module Hanami
         underscore(string).split(CLASSIFY_SEPARATOR).map(&:capitalize).join(TITLEIZE_SEPARATOR)
       end
 
-      # Returns a capitalized version of the string
+      # Return a capitalized version of the string
       #
       # @param input [::String] the input
       #
@@ -207,7 +209,7 @@ module Hanami
         tail.unshift(head.capitalize).join(CAPITALIZE_SEPARATOR)
       end
 
-      # Returns a CamelCase version of the string
+      # Return a CamelCase version of the string
       #
       # @param input [::String] the input
       #
@@ -231,7 +233,7 @@ module Hanami
         words.zip(delimiters).join
       end
 
-      # Returns a downcased and underscore separated version of the string
+      # Return a downcased and underscore separated version of the string
       #
       # Revised version of `ActiveSupport::Inflector.underscore` implementation
       # @see https://github.com/rails/rails/blob/feaa6e2048fe86bcf07e967d6e47b865e42e055b/activesupport/lib/active_support/inflector/methods.rb#L90
@@ -256,7 +258,7 @@ module Hanami
         string.downcase
       end
 
-      # Returns a downcased and dash separated version of the string
+      # Return a downcased and dash separated version of the string
       #
       # @param input [::String] the input
       #
@@ -277,7 +279,7 @@ module Hanami
         underscore(string).split(CLASSIFY_SEPARATOR).join(DASHERIZE_SEPARATOR)
       end
 
-      # Returns the string without the Ruby namespace of the class
+      # Return the string without the Ruby namespace of the class
       #
       # @param input [::String] the input
       #
@@ -295,7 +297,7 @@ module Hanami
         ::String.new(input.to_s).split(NAMESPACE_SEPARATOR).last
       end
 
-      # Returns the top level namespace name
+      # Return the top level namespace name
       #
       # @param input [::String] the input
       #
@@ -313,47 +315,7 @@ module Hanami
         ::String.new(input.to_s).split(NAMESPACE_SEPARATOR).first
       end
 
-      # Returns a pluralized version of self.
-      #
-      # @param input [::String] the input
-      #
-      # @return [::String] the pluralized string.
-      #
-      # @since 1.1.0
-      #
-      # @see Hanami::Utils::Inflector
-      # @deprecated
-      #
-      # @example
-      #   require 'hanami/utils/string'
-      #
-      #   Hanami::Utils::String.pluralize('book') # => 'books'
-      def self.pluralize(input)
-        string = ::String.new(input.to_s)
-        Inflector.pluralize(string)
-      end
-
-      # Returns a singularized version of self.
-      #
-      # @param input [::String] the input
-      #
-      # @return [::String] the singularized string.
-      #
-      # @since 1.1.0
-      # @deprecated
-      #
-      # @see Hanami::Utils::Inflector
-      #
-      # @example
-      #   require 'hanami/utils/string'
-      #
-      #   Hanami::Utils::String.singularize('books') # => 'book'
-      def self.singularize(input)
-        string = ::String.new(input.to_s)
-        Inflector.singularize(string)
-      end
-
-      # Replaces the rightmost match of `pattern` with `replacement`
+      # Replace the rightmost match of `pattern` with `replacement`
       #
       # If the pattern cannot be matched, it returns the original string.
       #
@@ -374,7 +336,7 @@ module Hanami
       #     # => 'authors/books#index'
       def self.rsub(input, pattern, replacement)
         string = ::String.new(input.to_s)
-        if i = string.rindex(pattern)
+        if i = string.rindex(pattern) # rubocop:disable Lint/AssignmentInCondition
           s = string.dup
           s[i] = replacement
           s
@@ -395,7 +357,7 @@ module Hanami
         @string = string.to_s
       end
 
-      # Returns a titleized version of the string
+      # Return a titleized version of the string
       #
       # @return [Hanami::Utils::String] the transformed string
       #
@@ -411,7 +373,7 @@ module Hanami
         self.class.new underscore.split(CLASSIFY_SEPARATOR).map(&:capitalize).join(TITLEIZE_SEPARATOR)
       end
 
-      # Returns a capitalized version of the string
+      # Return a capitalized version of the string
       #
       # @return [Hanami::Utils::String] the transformed string
       #
@@ -443,7 +405,7 @@ module Hanami
         )
       end
 
-      # Returns a CamelCase version of the string
+      # Return a CamelCase version of the string
       #
       # @return [Hanami::Utils::String] the transformed string
       #
@@ -466,7 +428,7 @@ module Hanami
         self.class.new words.zip(delimiters).join
       end
 
-      # Returns a downcased and underscore separated version of the string
+      # Return a downcased and underscore separated version of the string
       #
       # Revised version of `ActiveSupport::Inflector.underscore` implementation
       # @see https://github.com/rails/rails/blob/feaa6e2048fe86bcf07e967d6e47b865e42e055b/activesupport/lib/active_support/inflector/methods.rb#L90
@@ -490,7 +452,7 @@ module Hanami
         self.class.new new_string
       end
 
-      # Returns a downcased and dash separated version of the string
+      # Return a downcased and dash separated version of the string
       #
       # @return [Hanami::Utils::String] the transformed string
       #
@@ -512,7 +474,7 @@ module Hanami
         self.class.new underscore.split(CLASSIFY_SEPARATOR).join(DASHERIZE_SEPARATOR)
       end
 
-      # Returns the string without the Ruby namespace of the class
+      # Return the string without the Ruby namespace of the class
       #
       # @return [Hanami::Utils::String] the transformed string
       #
@@ -531,7 +493,7 @@ module Hanami
         self.class.new split(NAMESPACE_SEPARATOR).last
       end
 
-      # Returns the top level namespace name
+      # Return the top level namespace name
       #
       # @return [Hanami::Utils::String] the transformed string
       #
@@ -572,8 +534,9 @@ module Hanami
       #     'Hanami::Utils'
       #     'Hanami::App'
       #
+      # rubocop:disable Metrics/MethodLength
       def tokenize
-        if match = TOKENIZE_REGEXP.match(@string)
+        if match = TOKENIZE_REGEXP.match(@string) # rubocop:disable Lint/AssignmentInCondition
           pre  = match.pre_match
           post = match.post_match
           tokens = match[1].split(TOKENIZE_SEPARATOR)
@@ -586,32 +549,7 @@ module Hanami
 
         nil
       end
-
-      # Returns a pluralized version of self.
-      #
-      # @return [Hanami::Utils::String] the pluralized string.
-      #
-      # @api private
-      # @since 0.4.1
-      # @deprecated
-      #
-      # @see Hanami::Utils::Inflector
-      def pluralize
-        self.class.new Inflector.pluralize(self)
-      end
-
-      # Returns a singularized version of self.
-      #
-      # @return [Hanami::Utils::String] the singularized string.
-      #
-      # @api private
-      # @since 0.4.1
-      # @deprecated
-      #
-      # @see Hanami::Utils::Inflector
-      def singularize
-        self.class.new Inflector.singularize(self)
-      end
+      # rubocop:enable Metrics/MethodLength
 
       # Returns the hash of the internal string
       #
@@ -633,7 +571,7 @@ module Hanami
         @string
       end
 
-      alias_method :to_str, :to_s
+      alias to_str to_s
 
       # Equality
       #
@@ -645,9 +583,9 @@ module Hanami
         to_s == other
       end
 
-      alias_method :eql?, :==
+      alias eql? ==
 
-      # Splits the string with the given pattern
+      # Split the string with the given pattern
       #
       # @return [Array<::String>]
       #
@@ -659,7 +597,7 @@ module Hanami
         @string.split(pattern, limit)
       end
 
-      # Replaces the given pattern with the given replacement
+      # Replace the given pattern with the given replacement
       #
       # @return [::String]
       #
@@ -675,7 +613,7 @@ module Hanami
         end
       end
 
-      # Iterates through the string, matching the pattern.
+      # Iterate through the string, matching the pattern.
       # Either return all those patterns, or pass them to the block.
       #
       # @return [Array<::String>]
@@ -688,7 +626,7 @@ module Hanami
         @string.scan(pattern, &blk)
       end
 
-      # Replaces the rightmost match of `pattern` with `replacement`
+      # Replace the rightmost match of `pattern` with `replacement`
       #
       # If the pattern cannot be matched, it returns the original string.
       #
@@ -714,7 +652,7 @@ module Hanami
       #   puts result
       #     # => #<Hanami::Utils::String:0x007fdb41232ed0 @string="authors/books#index">
       def rsub(pattern, replacement)
-        if i = rindex(pattern)
+        if i = rindex(pattern) # rubocop:disable Lint/AssignmentInCondition
           s    = @string.dup
           s[i] = replacement
           self.class.new s
@@ -723,23 +661,21 @@ module Hanami
         end
       end
 
-      # Overrides Ruby's method_missing in order to provide ::String interface
+      # Override Ruby's method_missing in order to provide ::String interface
       #
       # @api private
       # @since 0.3.0
       #
       # @raise [NoMethodError] If doesn't respond to the given method
       def method_missing(method_name, *args, &blk)
-        unless respond_to?(method_name)
-          raise NoMethodError.new(%(undefined method `#{method_name}' for "#{@string}":#{self.class}))
-        end
+        raise NoMethodError.new(%(undefined method `#{method_name}' for "#{@string}":#{self.class})) unless respond_to?(method_name)
 
         s = @string.__send__(method_name, *args, &blk)
         s = self.class.new(s) if s.is_a?(::String)
         s
       end
 
-      # Overrides Ruby's respond_to_missing? in order to support ::String interface
+      # Override Ruby's respond_to_missing? in order to support ::String interface
       #
       # @api private
       # @since 0.3.0