hanami-utils 2.0.0.alpha1 → 2.0.0

data/lib/hanami/utils/string.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require "transproc"
+require "dry/transformer"
 require "concurrent/map"
 
 module Hanami
   module Utils
-    # String on steroids
+    # String utilities
     #
     # @since 0.1.0
-    class String # rubocop:disable Metrics/ClassLength
+    module String
       # Empty string for #classify
       #
       # @since 0.6.0
@@ -27,18 +27,6 @@ module Hanami
       # @api private
       CLASSIFY_SEPARATOR  = "_"
 
-      # Regexp for #tokenize
-      #
-      # @since 0.3.0
-      # @api private
-      TOKENIZE_REGEXP     = /\((.*)\)/.freeze
-
-      # Separator for #tokenize
-      #
-      # @since 0.3.0
-      # @api private
-      TOKENIZE_SEPARATOR  = "|"
-
       # Separator for #underscore
       #
       # @since 0.3.0
@@ -73,16 +61,16 @@ module Hanami
       #
       # @since 0.3.4
       # @api private
-      CLASSIFY_WORD_SEPARATOR = /#{CLASSIFY_SEPARATOR}|#{NAMESPACE_SEPARATOR}|#{UNDERSCORE_SEPARATOR}|#{DASHERIZE_SEPARATOR}/.freeze
+      CLASSIFY_WORD_SEPARATOR = /#{CLASSIFY_SEPARATOR}|#{NAMESPACE_SEPARATOR}|#{UNDERSCORE_SEPARATOR}|#{DASHERIZE_SEPARATOR}/ # rubocop:disable Layout/LineLength
 
       @__transformations__ = Concurrent::Map.new
 
-      extend Transproc::Registry
-      extend Transproc::Composer
+      extend Dry::Transformer::Registry
 
-      # Apply the given transformation(s) to `input`
+      # Applies 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`
@@ -130,42 +118,31 @@ 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|
-            transformations.each do |transformation, *args|
-              fns << if transformation.is_a?(Proc)
-                       transformation
-                     elsif contain?(transformation)
-                       self[transformation, *args]
-                     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}))
-                     end
-            end
+          fns = Dry::Transformer::Function.new(->(object) { object })
+
+          transformations.each do |transformation, *args|
+            fns = fns.compose(
+              if transformation.is_a?(Proc)
+                transformation
+              elsif contain?(transformation)
+                self[transformation, *args]
+              elsif input.respond_to?(transformation)
+                ->(i) { i.public_send(transformation, *args) }
+              else
+                raise NoMethodError.new(%(undefined method `#{transformation.inspect}' for #{input.inspect}:#{input.class})) # rubocop:disable Layout/LineLength
+              end
+            )
           end
+
+          fns
         end
 
         fn.call(input)
       end
-      # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Metrics/AbcSize
 
-      # Extracted from `transproc` source code
-      #
-      # `transproc` is Copyright 2014 by Piotr Solnica (piotr.solnica@gmail.com),
-      # released under the MIT License
-      #
-      # @since 1.1.0
-      # @api private
-      def self.bind(value, binding, fun)
-        binding.instance_exec(value, &fun)
-      end
-
-      # Return a titleized version of the string
+      # Returns a titleized version of the string
       #
       # @param input [::String] the input
       #
@@ -182,7 +159,7 @@ module Hanami
         underscore(string).split(CLASSIFY_SEPARATOR).map(&:capitalize).join(TITLEIZE_SEPARATOR)
       end
 
-      # Return a capitalized version of the string
+      # Returns a capitalized version of the string
       #
       # @param input [::String] the input
       #
@@ -209,7 +186,7 @@ module Hanami
         tail.unshift(head.capitalize).join(CAPITALIZE_SEPARATOR)
       end
 
-      # Return a CamelCase version of the string
+      # Returns a CamelCase version of the string
       #
       # @param input [::String] the input
       #
@@ -233,7 +210,7 @@ module Hanami
         words.zip(delimiters).join
       end
 
-      # Return a downcased and underscore separated version of the string
+      # Returns 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
@@ -254,11 +231,11 @@ module Hanami
         string.gsub!(NAMESPACE_SEPARATOR, UNDERSCORE_SEPARATOR)
         string.gsub!(/([A-Z\d]+)([A-Z][a-z])/, UNDERSCORE_DIVISION_TARGET)
         string.gsub!(/([a-z\d])([A-Z])/, UNDERSCORE_DIVISION_TARGET)
-        string.gsub!(/[[:space:]]|\-/, UNDERSCORE_DIVISION_TARGET)
+        string.gsub!(/[[:space:]]|-|\./, UNDERSCORE_DIVISION_TARGET)
         string.downcase
       end
 
-      # Return a downcased and dash separated version of the string
+      # Returns a downcased and dash separated version of the string
       #
       # @param input [::String] the input
       #
@@ -279,7 +256,7 @@ module Hanami
         underscore(string).split(CLASSIFY_SEPARATOR).join(DASHERIZE_SEPARATOR)
       end
 
-      # Return the string without the Ruby namespace of the class
+      # Returns the string without the Ruby namespace of the class
       #
       # @param input [::String] the input
       #
@@ -297,7 +274,7 @@ module Hanami
         ::String.new(input.to_s).split(NAMESPACE_SEPARATOR).last
       end
 
-      # Return the top level namespace name
+      # Returns the top level namespace name
       #
       # @param input [::String] the input
       #
@@ -336,7 +313,7 @@ module Hanami
       #     # => 'authors/books#index'
       def self.rsub(input, pattern, replacement)
         string = ::String.new(input.to_s)
-        if i = string.rindex(pattern) # rubocop:disable Lint/AssignmentInCondition
+        if i = string.rindex(pattern)
           s = string.dup
           s[i] = replacement
           s
@@ -344,344 +321,6 @@ module Hanami
           string
         end
       end
-
-      # Initialize the string
-      #
-      # @param string [::String, Symbol] the value we want to initialize
-      #
-      # @return [Hanami::Utils::String] self
-      #
-      # @since 0.1.0
-      # @deprecated
-      def initialize(string)
-        @string = string.to_s
-      end
-
-      # Return a titleized version of the string
-      #
-      # @return [Hanami::Utils::String] the transformed string
-      #
-      # @since 0.4.0
-      # @deprecated Use {Hanami::Utils::String.titleize}
-      #
-      # @example
-      #   require 'hanami/utils/string'
-      #
-      #   string = Hanami::Utils::String.new 'hanami utils'
-      #   string.titleize # => "Hanami Utils"
-      def titleize
-        self.class.new underscore.split(CLASSIFY_SEPARATOR).map(&:capitalize).join(TITLEIZE_SEPARATOR)
-      end
-
-      # Return a capitalized version of the string
-      #
-      # @return [Hanami::Utils::String] the transformed string
-      #
-      # @since 0.5.2
-      # @deprecated Use {Hanami::Utils::String.capitalize}
-      #
-      # @example
-      #   require 'hanami/utils/string'
-      #
-      #   string = Hanami::Utils::String.new 'hanami'
-      #   string.capitalize # => "Hanami"
-      #
-      #   string = Hanami::Utils::String.new 'hanami utils'
-      #   string.capitalize # => "Hanami utils"
-      #
-      #   string = Hanami::Utils::String.new 'Hanami Utils'
-      #   string.capitalize # => "Hanami utils"
-      #
-      #   string = Hanami::Utils::String.new 'hanami_utils'
-      #   string.capitalize # => "Hanami utils"
-      #
-      #   string = Hanami::Utils::String.new 'hanami-utils'
-      #   string.capitalize # => "Hanami utils"
-      def capitalize
-        head, *tail = underscore.split(CLASSIFY_SEPARATOR)
-
-        self.class.new(
-          tail.unshift(head.capitalize).join(CAPITALIZE_SEPARATOR)
-        )
-      end
-
-      # Return a CamelCase version of the string
-      #
-      # @return [Hanami::Utils::String] the transformed string
-      #
-      # @since 0.1.0
-      # @deprecated Use {Hanami::Utils::String.classify}
-      #
-      # @example
-      #   require 'hanami/utils/string'
-      #
-      #   string = Hanami::Utils::String.new 'hanami_utils'
-      #   string.classify # => 'HanamiUtils'
-      def classify
-        words = underscore.split(CLASSIFY_WORD_SEPARATOR).map!(&:capitalize)
-        delimiters = underscore.scan(CLASSIFY_WORD_SEPARATOR)
-
-        delimiters.map! do |delimiter|
-          delimiter == CLASSIFY_SEPARATOR ? EMPTY_STRING : NAMESPACE_SEPARATOR
-        end
-
-        self.class.new words.zip(delimiters).join
-      end
-
-      # 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
-      #
-      # @return [Hanami::Utils::String] the transformed string
-      # @deprecated Use {Hanami::Utils::String.underscore}
-      #
-      # @since 0.1.0
-      #
-      # @example
-      #   require 'hanami/utils/string'
-      #
-      #   string = Hanami::Utils::String.new 'HanamiUtils'
-      #   string.underscore # => 'hanami_utils'
-      def underscore
-        new_string = gsub(NAMESPACE_SEPARATOR, UNDERSCORE_SEPARATOR)
-        new_string.gsub!(/([A-Z\d]+)([A-Z][a-z])/, UNDERSCORE_DIVISION_TARGET)
-        new_string.gsub!(/([a-z\d])([A-Z])/, UNDERSCORE_DIVISION_TARGET)
-        new_string.gsub!(/[[:space:]]|\-/, UNDERSCORE_DIVISION_TARGET)
-        new_string.downcase!
-        self.class.new new_string
-      end
-
-      # Return a downcased and dash separated version of the string
-      #
-      # @return [Hanami::Utils::String] the transformed string
-      #
-      # @since 0.4.0
-      # @deprecated Use {Hanami::Utils::String.dasherize}
-      #
-      # @example
-      #   require 'hanami/utils/string'
-      #
-      #   string = Hanami::Utils::String.new 'Hanami Utils'
-      #   string.dasherize # => 'hanami-utils'
-      #
-      #   string = Hanami::Utils::String.new 'hanami_utils'
-      #   string.dasherize # => 'hanami-utils'
-      #
-      #   string = Hanami::Utils::String.new 'HanamiUtils'
-      #   string.dasherize # => "hanami-utils"
-      def dasherize
-        self.class.new underscore.split(CLASSIFY_SEPARATOR).join(DASHERIZE_SEPARATOR)
-      end
-
-      # Return the string without the Ruby namespace of the class
-      #
-      # @return [Hanami::Utils::String] the transformed string
-      #
-      # @since 0.1.0
-      # @deprecated Use {Hanami::Utils::String.demodulize}
-      #
-      # @example
-      #   require 'hanami/utils/string'
-      #
-      #   string = Hanami::Utils::String.new 'Hanami::Utils::String'
-      #   string.demodulize # => 'String'
-      #
-      #   string = Hanami::Utils::String.new 'String'
-      #   string.demodulize # => 'String'
-      def demodulize
-        self.class.new split(NAMESPACE_SEPARATOR).last
-      end
-
-      # Return the top level namespace name
-      #
-      # @return [Hanami::Utils::String] the transformed string
-      #
-      # @since 0.1.2
-      # @deprecated Use {Hanami::Utils::String.namespace}
-      #
-      # @example
-      #   require 'hanami/utils/string'
-      #
-      #   string = Hanami::Utils::String.new 'Hanami::Utils::String'
-      #   string.namespace # => 'Hanami'
-      #
-      #   string = Hanami::Utils::String.new 'String'
-      #   string.namespace # => 'String'
-      def namespace
-        self.class.new split(NAMESPACE_SEPARATOR).first
-      end
-
-      # It iterates through the tokens and calls the given block.
-      # A token is a substring wrapped by `()` and separated by `|`.
-      #
-      # @yield the block that is called for each token.
-      #
-      # @return [void]
-      #
-      # @since 0.1.0
-      # @deprecated
-      #
-      # @example
-      #   require 'hanami/utils/string'
-      #
-      #   string = Hanami::Utils::String.new 'Hanami::(Utils|App)'
-      #   string.tokenize do |token|
-      #     puts token
-      #   end
-      #
-      #   # =>
-      #     'Hanami::Utils'
-      #     'Hanami::App'
-      #
-      # rubocop:disable Metrics/MethodLength
-      def tokenize
-        if match = TOKENIZE_REGEXP.match(@string) # rubocop:disable Lint/AssignmentInCondition
-          pre  = match.pre_match
-          post = match.post_match
-          tokens = match[1].split(TOKENIZE_SEPARATOR)
-          tokens.each do |token|
-            yield(self.class.new("#{pre}#{token}#{post}"))
-          end
-        else
-          yield(self.class.new(@string))
-        end
-
-        nil
-      end
-      # rubocop:enable Metrics/MethodLength
-
-      # Returns the hash of the internal string
-      #
-      # @return [Integer]
-      #
-      # @since 0.3.0
-      # @deprecated
-      def hash
-        @string.hash
-      end
-
-      # Returns a string representation
-      #
-      # @return [::String]
-      #
-      # @since 0.3.0
-      # @deprecated
-      def to_s
-        @string
-      end
-
-      alias to_str to_s
-
-      # Equality
-      #
-      # @return [TrueClass,FalseClass]
-      #
-      # @since 0.3.0
-      # @deprecated
-      def ==(other)
-        to_s == other
-      end
-
-      alias eql? ==
-
-      # Split the string with the given pattern
-      #
-      # @return [Array<::String>]
-      #
-      # @see http://www.ruby-doc.org/core/String.html#method-i-split
-      #
-      # @since 0.3.0
-      # @deprecated
-      def split(pattern, limit = 0)
-        @string.split(pattern, limit)
-      end
-
-      # Replace the given pattern with the given replacement
-      #
-      # @return [::String]
-      #
-      # @see http://www.ruby-doc.org/core/String.html#method-i-gsub
-      #
-      # @since 0.3.0
-      # @deprecated
-      def gsub(pattern, replacement = nil, &blk)
-        if block_given?
-          @string.gsub(pattern, &blk)
-        else
-          @string.gsub(pattern, replacement)
-        end
-      end
-
-      # Iterate through the string, matching the pattern.
-      # Either return all those patterns, or pass them to the block.
-      #
-      # @return [Array<::String>]
-      #
-      # @see http://www.ruby-doc.org/core/String.html#method-i-scan
-      #
-      # @since 0.6.0
-      # @deprecated
-      def scan(pattern, &blk)
-        @string.scan(pattern, &blk)
-      end
-
-      # Replace the rightmost match of `pattern` with `replacement`
-      #
-      # If the pattern cannot be matched, it returns the original string.
-      #
-      # This method does NOT mutate the original string.
-      #
-      # @param pattern [Regexp, String] the pattern to find
-      # @param replacement [String, Hanami::Utils::String] the string to replace
-      #
-      # @return [Hanami::Utils::String] the replaced string
-      #
-      # @since 0.6.0
-      # @deprecated Use {Hanami::Utils::String.rsub}
-      #
-      # @example
-      #   require 'hanami/utils/string'
-      #
-      #   string = Hanami::Utils::String.new('authors/books/index')
-      #   result = string.rsub(/\//, '#')
-      #
-      #   puts string
-      #     # => #<Hanami::Utils::String:0x007fdb41233ad8 @string="authors/books/index">
-      #
-      #   puts result
-      #     # => #<Hanami::Utils::String:0x007fdb41232ed0 @string="authors/books#index">
-      def rsub(pattern, replacement)
-        if i = rindex(pattern) # rubocop:disable Lint/AssignmentInCondition
-          s    = @string.dup
-          s[i] = replacement
-          self.class.new s
-        else
-          self
-        end
-      end
-
-      # 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)
-        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
-
-      # Override Ruby's respond_to_missing? in order to support ::String interface
-      #
-      # @api private
-      # @since 0.3.0
-      def respond_to_missing?(method_name, include_private = false)
-        @string.respond_to?(method_name, include_private)
-      end
     end
   end
 end

data/lib/hanami/utils/version.rb

@@ -2,9 +2,10 @@
 
 module Hanami
   module Utils
-    # Defines the version
+    # The current hanami-utils version.
     #
     # @since 0.1.0
-    VERSION = "2.0.0.alpha1"
+    # @api public
+    VERSION = "2.0.0"
   end
 end

data/lib/hanami/utils.rb

@@ -23,7 +23,7 @@ module Hanami
 
     # Checks if the current VM is JRuby
     #
-    # @return [TrueClass,FalseClass] return if the VM is JRuby or not
+    # @return [TrueClass,FalseClass] info whether the VM is JRuby or not
     #
     # @since 0.3.1
     # @api private
@@ -33,7 +33,7 @@ module Hanami
 
     # Checks if the current VM is Rubinius
     #
-    # @return [TrueClass,FalseClass] return if the VM is Rubinius or not
+    # @return [TrueClass,FalseClass] info whether the VM is Rubinius or not
     #
     # @since 0.3.1
     # @api private
@@ -41,7 +41,7 @@ module Hanami
       RUBY_ENGINE == HANAMI_RUBINIUS
     end
 
-    # Recursively require Ruby files under the given directory.
+    # Recursively requires Ruby files under the given directory.
     #
     # If the directory is relative, it implies it's the path from current directory.
     # If the directory is absolute, it uses as it is.
@@ -71,7 +71,7 @@ module Hanami
     # @since 1.0.0
     # @api private
     def self.for_each_file_in(directory, &blk)
-      directory = directory.to_s.gsub(%r{(\/|\\)}, File::SEPARATOR)
+      directory = directory.to_s.gsub(%r{(/|\\)}, File::SEPARATOR)
       directory = Pathname.new(Dir.pwd).join(directory).to_s
       directory = File.join(directory, "**", "*.rb") unless directory =~ /(\*\*)/