strings-case 0.3.0 → 0.4.0

data/lib/strings/case/acronyms.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module Strings
+  class Case
+    # A collection of acronyms
+    #
+    # @api private
+    class Acronyms
+      # Create instance from an array of acronyms
+      #
+      # @example
+      #   acronyms = Strings::Case::Acronyms.new(%w[HTTP XML])
+      #
+      # @param [Array<String>, Strings::Case::Acronyms] acronyms
+      #   the acronyms to add
+      #
+      # @return [Strings::Case::Acronyms]
+      #
+      # @api public
+      def self.from(acronyms = [])
+        return acronyms if acronyms.is_a?(self)
+
+        new(acronyms)
+      end
+
+      # Mappings of downcased string to an acronym
+      #
+      # @example
+      #   acronyms.entries
+      #   # => {"http" => "HTTP"}
+      #
+      # @return [Hash{String => String}]
+      #
+      # @api private
+      attr_reader :entries
+
+      # A pattern
+      #
+      # @example
+      #   acronyms.pattern
+      #
+      # @return [Regexp]
+      #
+      # @api public
+      attr_reader :pattern
+
+      # Create an Acronyms instance
+      #
+      # @example
+      #   acronyms = Strings::Case::Acronyms.new(%w[HTTP XML])
+      #
+      # @param [Array<String>] acronyms
+      #   an array of acronyms
+      #
+      # @api public
+      def initialize(acronyms = [])
+        @entries = {}
+        @pattern = /(?!)/ # match nothing
+
+        acronyms.each { |acronym| add(acronym) }
+      end
+
+      # Add an acronym
+      #
+      # @example
+      #   acronyms.add("HTTP")
+      #
+      # @example
+      #   acronyms << "HTTP"
+      #
+      # @param [String] string
+      #   the string name to add to the acronyms
+      #
+      # @return [void]
+      #
+      # @api public
+      def add(string)
+        @entries[string.downcase] = string
+        @pattern = /#{Regexp.union(to_a)}(?=\b|[^\p{Ll}])/
+      end
+      alias << add
+
+      # Find an acronym
+      #
+      # @example
+      #   acronyms.fetch("http")
+      #
+      # @param [String] string
+      #   the string to search for an acronym
+      #
+      # @return [String]
+      #
+      # @api public
+      def fetch(string)
+        @entries[string.downcase]
+      end
+
+      # Convert to an array of all acronyms
+      #
+      # @example
+      #   acronyms.to_a
+      #
+      # @return [Array<String>]
+      #
+      # @api public
+      def to_a
+        @entries.values
+      end
+    end # Acronyms
+  end # Case
+end # Strings

data/lib/strings/case/configuration.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative "acronyms"
+
+module Strings
+  class Case
+    # Responsible for storing acronyms configuration
+    #
+    # @api private
+    class Configuration
+      # All the registered acronyms
+      #
+      # @example
+      #   configuration.acronyms
+      #
+      # @return [Strings::Case::Acronyms]
+      #
+      # @api public
+      attr_reader :acronyms
+
+      # Create a Configuration instance
+      #
+      # @example
+      #   configuration = Strings::Case::Cofiguration.new
+      #
+      # @api public
+      def initialize
+        @acronyms = Acronyms.new
+      end
+
+      # Add an acronym
+      #
+      # @example
+      #   strings = Strings::Case.new
+      #   strings.configure do |config|
+      #     config.acronym "HTTP"
+      #   end
+      #   strings.pascalcase("http_response")    # => "HTTPResponse"
+      #   strings.camelcase("http_response")     # => "HTTPResponse"
+      #   strings.snakecase("HTTPResponse")      # => "http_response"
+      #   strings.titlecase("http_response")     # => "HTTP Response"
+      #   strings.sentencecase("http_response")  # => "HTTP response"
+      #
+      # @param [Array<String>] names
+      #   the names to add to the acronyms list
+      #
+      # @return [void]
+      #
+      # @api public
+      def acronym(*names)
+        names.each { |name| @acronyms << name }
+      end
+    end # Configuration
+  end # Case
+end # Strings

data/lib/strings/case/extensions.rb

@@ -1,46 +1,96 @@
 # frozen_string_literal: true
 
+require_relative "../case"
+
 module Strings
-  module Case
+  class Case
+    # Responsible for refining the String class with case conversions
+    #
+    # @api public
     module Extensions
       refine String do
+        # Convert string to camel case
+        #
+        # @see Strings::Case#camelcase
+        #
+        # @api public
         def camelcase(*args, **options)
           Strings::Case.camelcase(self, *args, **options)
         end
-        alias lower_camelcase camelcase
+        alias_method :lower_camelcase, :camelcase
 
+        # Convert string to constant case
+        #
+        # @see Strings::Case#constcase
+        #
+        # @api public
         def constcase(*args, **options)
           Strings::Case.constcase(self, *args, **options)
         end
-        alias constantcase constcase
+        alias_method :constantcase, :constcase
 
+        # Convert string to an HTTP header
+        #
+        # @see Strings::Case#headercase
+        #
+        # @api public
         def headercase(*args, **options)
           Strings::Case.headercase(self, *args, **options)
         end
 
+        # Convert string to lowercase words linked by hyphens
+        #
+        # @see Strings::Case#kebabcase
+        #
+        # @api public
         def kebabcase(*args, **options)
           Strings::Case.kebabcase(self, *args, **options)
         end
-        alias dashcase kebabcase
+        alias_method :dashcase, :kebabcase
 
+        # Convert string to pascal case
+        #
+        # @see Strings::Case#pascalcase
+        #
+        # @api public
         def pascalcase(*args, **options)
           Strings::Case.pascalcase(self, *args, **options)
         end
-        alias upper_camelcase pascalcase
+        alias_method :upper_camelcase, :pascalcase
 
+        # Convert string to file path case
+        #
+        # @see Strings::Case#pathcase
+        #
+        # @api public
         def pathcase(*args, **options)
           Strings::Case.pathcase(self, *args, **options)
         end
 
+        # Convert string to sentence case
+        #
+        # @see Strings::Case#sentencecase
+        #
+        # @api public
         def sentencecase(*args, **options)
           Strings::Case.sentencecase(self, *args, **options)
         end
 
+        # Convert string to snake case
+        #
+        # @see Strings::Case#snakecase
+        #
+        # @api public
         def snakecase(*args, **options)
           Strings::Case.snakecase(self, *args, **options)
         end
-        alias underscore snakecase
+        alias_method :underscore, :snakecase
 
+        # Convert string to title case
+        #
+        # @see Strings::Case#titlecase
+        #
+        # @api public
         def titlecase(*args, **options)
           Strings::Case.titlecase(self, *args, **options)
         end

data/lib/strings/case/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Strings
-  module Case
-    VERSION = "0.3.0"
-  end
-end
+  class Case
+    VERSION = "0.4.0"
+  end # Case
+end # Strings