hanami-utils 1.3.2 → 1.3.7

data/lib/hanami/utils/file_list.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Hanami
   module Utils
     # Ordered file list, consistent across operating systems
     #
     # @since 0.9.0
     module FileList
-      # Return an ordered list of files, consistent across operating systems
+      # Returns an ordered list of files, consistent across operating systems
       #
       # It has the same signature of <tt>Dir.glob</tt>, it just guarantees to
       # order the results before to return them.

data/lib/hanami/utils/files.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "pathname"
 require "fileutils"
 require "hanami/utils/deprecation"
@@ -163,6 +165,7 @@ module Hanami
         mkdir_p(path)
 
         content = ::File.readlines(path)
+        content << "\n" if _append_newline?(content)
         content << "#{contents}\n"
 
         write(path, content)
@@ -323,12 +326,12 @@ module Hanami
       #
       #   # class App
       #   # end
-      def self.remove_block(path, target) # rubocop:disable Metrics/AbcSize
+      def self.remove_block(path, target)
         content  = ::File.readlines(path)
         starting = index(content, path, target)
         line     = content[starting]
         size     = line[/\A[[:space:]]*/].bytesize
-        closing  = (" " * size) + (target =~ /{/ ? '}' : 'end')
+        closing  = (" " * size) + (target =~ /{/ ? "}" : "end")
         ending   = starting + index(content[starting..-1], path, closing)
 
         content.slice!(starting..ending)
@@ -451,6 +454,16 @@ module Hanami
       end
 
       private_class_method :line_number
+
+      # @since 1.3.6
+      # @api private
+      def self._append_newline?(content)
+        return false if content.empty?
+
+        !content.last.end_with?("\n")
+      end
+
+      private_class_method :_append_newline?
     end
   end
 end

data/lib/hanami/utils/hash.rb

@@ -1,12 +1,13 @@
-require 'hanami/utils/duplicable'
-require 'transproc'
+# frozen_string_literal: true
+
+require "hanami/utils/duplicable"
+require "transproc"
 
 module Hanami
   module Utils
     # Hash on steroids
     # @since 0.1.0
     #
-    # rubocop:disable ClassLength
     class Hash
       # @since 0.6.0
       # @api private
@@ -47,7 +48,7 @@ module Hanami
         self[:symbolize_keys].call(input)
       end
 
-      # Deep symbolize the given hash
+      # Performs deep symbolize on the given hash
       #
       # @param input [::Hash] the input
       #
@@ -69,7 +70,7 @@ module Hanami
         self[:deep_symbolize_keys].call(input)
       end
 
-      # Stringify the given hash
+      # Stringifies the given hash
       #
       # @param input [::Hash] the input
       #
@@ -89,7 +90,7 @@ module Hanami
         self[:stringify_keys].call(input)
       end
 
-      # Deeply stringify the given hash
+      # Deeply stringifies the given hash
       #
       # @param input [::Hash] the input
       #
@@ -105,7 +106,7 @@ module Hanami
       #
       #   hash.class
       #     # => Hash
-      def self.deep_stringify(input) # rubocop:disable Metrics/MethodLength
+      def self.deep_stringify(input)
         input.each_with_object({}) do |(key, value), output|
           output[key.to_s] =
             case value
@@ -121,15 +122,15 @@ module Hanami
         end
       end
 
-      # Deep duplicate hash values
+      # Deep duplicates hash values
       #
-      # The output of this function is a shallow duplicate of the input.
+      # The output of this function is a deep duplicate of the input.
       # Any further modification on the input, won't be reflected on the output
       # and viceversa.
       #
       # @param input [::Hash] the input
       #
-      # @return [::Hash] the shallow duplicate of input
+      # @return [::Hash] the deep duplicate of input
       #
       # @since 1.0.1
       #
@@ -169,7 +170,7 @@ module Hanami
         end
       end
 
-      # Deep serialize given object into a `Hash`
+      # Deep serializes given object into a `Hash`
       #
       # Please note that the returning `Hash` will use symbols as keys.
       #
@@ -193,7 +194,7 @@ module Hanami
       #
       #   Hanami::Utils::Hash.deep_serialize(input)
       #     # => {:foo=>"bar", :baz=>[{:hello=>"world"}]}
-      def self.deep_serialize(input) # rubocop:disable Metrics/MethodLength
+      def self.deep_serialize(input)
         input.to_hash.each_with_object({}) do |(key, value), output|
           output[key.to_sym] =
             case value
@@ -239,7 +240,7 @@ module Hanami
         @hash.default_proc = blk if blk
       end
 
-      # Convert in-place all the keys to Symbol instances.
+      # Converts in-place all the keys to Symbol instances.
       #
       # @return [Hash] self
       #
@@ -263,7 +264,7 @@ module Hanami
         self
       end
 
-      # Convert in-place all the keys to Symbol instances, nested hashes are converted too.
+      # Converts in-place all the keys to Symbol instances, nested hashes are converted too.
       #
       # @return [Hash] self
       #
@@ -289,7 +290,7 @@ module Hanami
         self
       end
 
-      # Convert in-place all the keys to Symbol instances, nested hashes are converted too.
+      # Converts in-place all the keys to Symbol instances, nested hashes are converted too.
       #
       # @return [Hash] self
       #
@@ -315,7 +316,7 @@ module Hanami
         self
       end
 
-      # Return a deep copy of the current Hanami::Utils::Hash
+      # Returns a deep copy of the current Hanami::Utils::Hash
       #
       # @return [Hash] a deep duplicated self
       #
@@ -452,7 +453,7 @@ module Hanami
         end
       end
 
-      alias to_hash to_h
+      alias_method :to_hash, :to_h
 
       # Converts into a nested array of [ key, value ] arrays.
       #
@@ -476,7 +477,7 @@ module Hanami
         @hash == other.to_h
       end
 
-      alias eql? ==
+      alias_method :eql?, :==
 
       # Returns the hash of the internal @hash
       #
@@ -498,21 +499,23 @@ module Hanami
         @hash.inspect
       end
 
-      # Override Ruby's method_missing in order to provide ::Hash interface
+      # Overrides Ruby's method_missing in order to provide ::Hash interface
       #
       # @api private
       # @since 0.3.0
       #
       # @raise [NoMethodError] If doesn't respond to the given method
       def method_missing(method_name, *args, &blk)
-        raise NoMethodError.new(%(undefined method `#{method_name}' for #{@hash}:#{self.class})) unless respond_to?(method_name)
+        unless respond_to?(method_name)
+          raise NoMethodError.new(%(undefined method `#{method_name}' for #{@hash}:#{self.class}))
+        end
 
         h = @hash.__send__(method_name, *args, &blk)
         h = self.class.new(h) if h.is_a?(::Hash)
         h
       end
 
-      # Override Ruby's respond_to_missing? in order to support ::Hash interface
+      # Overrides Ruby's respond_to_missing? in order to support ::Hash interface
       #
       # @api private
       # @since 0.3.0
@@ -520,6 +523,5 @@ module Hanami
         @hash.respond_to?(method_name, include_private)
       end
     end
-    # rubocop:enable ClassLength
   end
 end

data/lib/hanami/utils/inflector.rb

@@ -1,5 +1,7 @@
-require 'hanami/utils/class_attribute'
-require 'hanami/utils/blank'
+# frozen_string_literal: true
+
+require "hanami/utils/class_attribute"
+require "hanami/utils/blank"
 
 module Hanami
   module Utils
@@ -27,163 +29,181 @@ module Hanami
         # @since 0.6.0
         # @api private
         def ===(other)
-          key = other.downcase
+          key = extract_last_alphanumeric_token(other)
           @rules.key?(key) || @rules.value?(key)
         end
 
         # @since 0.6.0
         # @api private
         def apply(string)
-          key    = string.downcase
+          key = extract_last_alphanumeric_token(string)
           result = @rules[key] || @rules.rassoc(key).last
 
-          string[0] + result[1..-1]
+          prefix = if key == string.downcase
+                     string[0]
+                   else
+                     string[0..string.index(key)]
+                   end
+
+          prefix + result[1..-1]
+        end
+
+        private
+
+        # @since 1.3.3
+        # @api private
+        def extract_last_alphanumeric_token(string)
+          if string.downcase =~ /_([[:alpha:]]*)\z/
+            Regexp.last_match(1)
+          else
+            string.downcase
+          end
         end
       end
 
       # @since 0.4.1
       # @api private
-      A    = 'a'.freeze
+      A    = "a"
 
       # @since 0.4.1
       # @api private
-      CH   = 'ch'.freeze
+      CH   = "ch"
 
       # @since 0.4.1
       # @api private
-      CHES = 'ches'.freeze
+      CHES = "ches"
 
       # @since 0.4.1
       # @api private
-      EAUX = 'eaux'.freeze
+      EAUX = "eaux"
 
       # @since 0.6.0
       # @api private
-      ES   = 'es'.freeze
+      ES   = "es"
 
       # @since 0.4.1
       # @api private
-      F    = 'f'.freeze
+      F    = "f"
 
       # @since 0.4.1
       # @api private
-      I    = 'i'.freeze
+      I    = "i"
 
       # @since 0.4.1
       # @api private
-      ICE  = 'ice'.freeze
+      ICE  = "ice"
 
       # @since 0.4.1
       # @api private
-      ICES = 'ices'.freeze
+      ICES = "ices"
 
       # @since 0.4.1
       # @api private
-      IDES = 'ides'.freeze
+      IDES = "ides"
 
       # @since 0.4.1
       # @api private
-      IES  = 'ies'.freeze
+      IES  = "ies"
 
       # @since 0.4.1
       # @api private
-      IFE  = 'ife'.freeze
+      IFE  = "ife"
 
       # @since 0.4.1
       # @api private
-      IS   = 'is'.freeze
+      IS   = "is"
 
       # @since 0.4.1
       # @api private
-      IVES = 'ives'.freeze
+      IVES = "ives"
 
       # @since 0.4.1
       # @api private
-      MA   = 'ma'.freeze
+      MA   = "ma"
 
       # @since 0.4.1
       # @api private
-      MATA = 'mata'.freeze
+      MATA = "mata"
 
       # @since 0.4.1
       # @api private
-      MEN  = 'men'.freeze
+      MEN  = "men"
 
       # @since 0.4.1
       # @api private
-      MINA = 'mina'.freeze
+      MINA = "mina"
 
       # @since 0.6.0
       # @api private
-      NA   = 'na'.freeze
+      NA   = "na"
 
       # @since 0.6.0
       # @api private
-      NON  = 'non'.freeze
+      NON  = "non"
 
       # @since 0.4.1
       # @api private
-      O    = 'o'.freeze
+      O    = "o"
 
       # @since 0.4.1
       # @api private
-      OES  = 'oes'.freeze
+      OES  = "oes"
 
       # @since 0.4.1
       # @api private
-      OUSE = 'ouse'.freeze
+      OUSE = "ouse"
 
       # @since 0.4.1
       # @api private
-      RSE = 'rse'.freeze
+      RSE = "rse"
 
       # @since 0.4.1
       # @api private
-      RSES = 'rses'.freeze
+      RSES = "rses"
 
       # @since 0.4.1
       # @api private
-      S    = 's'.freeze
+      S    = "s"
 
       # @since 0.4.1
       # @api private
-      SES  = 'ses'.freeze
+      SES  = "ses"
 
       # @since 0.4.1
       # @api private
-      SSES = 'sses'.freeze
+      SSES = "sses"
 
       # @since 0.6.0
       # @api private
-      TA   = 'ta'.freeze
+      TA   = "ta"
 
       # @since 0.4.1
       # @api private
-      UM   = 'um'.freeze
+      UM   = "um"
 
       # @since 0.4.1
       # @api private
-      US   = 'us'.freeze
+      US   = "us"
 
       # @since 0.4.1
       # @api private
-      USES = 'uses'.freeze
+      USES = "uses"
 
       # @since 0.4.1
       # @api private
-      VES  = 'ves'.freeze
+      VES  = "ves"
 
       # @since 0.4.1
       # @api private
-      X    = 'x'.freeze
+      X    = "x"
 
       # @since 0.4.1
       # @api private
-      XES  = 'xes'.freeze
+      XES  = "xes"
 
       # @since 0.4.1
       # @api private
-      Y    = 'y'.freeze
+      Y    = "y"
 
       include Utils::ClassAttribute
 
@@ -194,40 +214,40 @@ module Hanami
       class_attribute :plurals
       self.plurals = IrregularRules.new(
         # irregular
-        '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',
+        "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',
-        'police'      => 'police',
+        "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',
-        'area'        => 'areas'
+        "album" => "albums",
+        "area" => "areas"
       )
 
       # Irregular rules for singulars
@@ -237,42 +257,42 @@ module Hanami
       class_attribute :singulars
       self.singulars = IrregularRules.new(
         # irregular
-        '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',
+        "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',
-        'fish'        => 'fish',
-        'information' => 'information',
-        'means'       => 'means',
-        'money'       => 'money',
-        'news'        => 'news',
-        'offspring'   => 'offspring',
-        'rice'        => 'rice',
-        'series'      => 'series',
-        'sheep'       => 'sheep',
-        'species'     => 'species',
-        'police'      => 'police',
+        "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",
         # fallback
-        'areas'       => 'area',
-        'hives'       => 'hive',
-        'phases'      => 'phase',
-        'exercises'   => 'exercise',
-        'releases'    => 'release'
+        "areas" => "area",
+        "hives" => "hive",
+        "phases" => "phase",
+        "exercises" => "exercise",
+        "releases" => "release"
       )
 
       # Block for custom inflection rules.
@@ -296,7 +316,7 @@ module Hanami
         class_eval(&blk)
       end
 
-      # Add a custom inflection exception
+      # Adds a custom inflection exception
       #
       # @param [String] singular form
       # @param [String] plural form
@@ -327,7 +347,7 @@ module Hanami
         Inflecto.inflections.irregular(singular, plural)
       end
 
-      # Add an uncountable word
+      # Adds an uncountable word
       #
       # @param [Array<String>] words
       #
@@ -348,7 +368,7 @@ module Hanami
         end
       end
 
-      # Pluralize the given string
+      # Pluralizes the given string
       #
       # @param string [String] a string to pluralize
       #
@@ -359,7 +379,6 @@ module Hanami
       #
       # rubocop:disable Metrics/AbcSize
       # rubocop:disable Metrics/CyclomaticComplexity
-      # rubocop:disable Metrics/MethodLength
       # rubocop:disable Style/PerlBackrefs
       def self.pluralize(string)
         return string if string.nil? || string =~ Utils::Blank::STRING_MATCHER
@@ -373,15 +392,15 @@ module Hanami
           $1 + IES
         when /\A(.*)(ex|ix)\z/
           $1 + ICES
-        when /\A(.*)(eau|#{ EAUX })\z/
+        when /\A(.*)(eau|#{EAUX})\z/
           $1 + EAUX
         when /\A(.*)x\z/
           $1 + XES
         when /\A(.*)ma\z/
           string + TA
-        when /\A(.*)(um|#{ A })\z/
+        when /\A(.*)(um|#{A})\z/
           $1 + A
-        when /\A(buffal|domin|ech|embarg|her|mosquit|potat|tomat)#{ O }\z/i
+        when /\A(buffal|domin|ech|embarg|her|mosquit|potat|tomat)#{O}\z/i
           $1 + OES
         when /\A(.*)(fee)\z/
           $1 + $2 + S
@@ -404,9 +423,8 @@ module Hanami
       # rubocop:enable Style/PerlBackrefs
       # rubocop:enable Metrics/AbcSize
       # rubocop:enable Metrics/CyclomaticComplexity
-      # rubocop:enable Metrics/MethodLength
 
-      # Singularize the given string
+      # Singularizes the given string
       #
       # @param string [String] a string to singularize
       #
@@ -417,7 +435,6 @@ module Hanami
       #
       # rubocop:disable Metrics/AbcSize
       # rubocop:disable Metrics/CyclomaticComplexity
-      # rubocop:disable Metrics/MethodLength
       # rubocop:disable Metrics/PerceivedComplexity
       # rubocop:disable Style/PerlBackrefs
       def self.singularize(string)
@@ -469,7 +486,7 @@ module Hanami
       # rubocop:enable Style/PerlBackrefs
       # rubocop:enable Metrics/AbcSize
       # rubocop:enable Metrics/CyclomaticComplexity
-      # rubocop:enable Metrics/MethodLength
+
       # rubocop:enable Metrics/PerceivedComplexity
     end
   end