dry-inflector 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c399013c00255e60a1adc6c44984238b5b331a9d8432489a189131ac0e7545b3
-  data.tar.gz: a59e33a3ca433c23bd0248413374b21da91a43d2ac666b1e30033f1e04d144de
+  metadata.gz: 7cccc4cd092473c4c5dfefd8830e97c987fbb6cd6039b6253fd973a0b4d5b8ac
+  data.tar.gz: 6aca715e9ab5497c0f325691783e92a10035b27a3e6fdf483df38b7fb306d6ad
 SHA512:
-  metadata.gz: 9e6ef7a7de2938808c7f01344335d370793a6d0cfa64d0afa42a6481f60cf84bc66ae8080f32706908421d3c13bb5650ab8368fe881bd5c268a3eaafcd9f1da6
-  data.tar.gz: 30cf65fc5594d8352b1d43b113f98b37b0e01b88e20301c4d02e11116030fcc16acb174c730953876c7337ada68c57b882c3f061a36788511a2763041374585e
+  metadata.gz: 2c9c21e1611fe3bafd8cf7e303b5030c1ba3f777fd397a58f2dfba77f8be05b49fdece384e49d82d43043e388ca3fc1f1c6c84508fdfdac02ce9851edfee1dba
+  data.tar.gz: c83c9d597c611194642fe6aed04b3c5f6e37ec9fa212b3501a13c93010305f9c339875a09ba123b8a97fa89f567e90c110af9ac76317f4c16749a5e91601b57e

data/CHANGELOG.md

@@ -2,10 +2,20 @@
 
 Inflector for Ruby
 
+## v0.1.2 - to be released
+
+### Added
+
+- [Gustavo Caso & Nikita Shilnikov] Added support for acronyms
+
+[Compare v0.1.1...master](https://github.com/dry-rb/dry-inflector/compare/v0.1.1...master)
+
 ## v0.1.1 - 2017-11-18
 ### Fixed
 - [Luca Guidi & Abinoam P. Marques Jr.] Ensure `Dry::Inflector#ordinalize` to work for all the numbers from 0 to 100
 
+[Compare v0.1.0...v0.1.1](https://github.com/dry-rb/dry-inflector/compare/v0.1.0...v0.1.1)
+
 ## v0.1.0 - 2017-11-17
 ### Added
 - [Luca Guidi] Introduced `Dry::Inflector#pluralize`

data/lib/dry/inflector.rb

@@ -47,7 +47,15 @@ module Dry
     #   inflector = Dry::Inflector.new
     #   inflector.camelize("dry/inflector") # => "Dry::Inflector"
     def camelize(input)
-      input.to_s.gsub(/\/(.?)/) { "::#{Regexp.last_match(1).upcase}" }.gsub(/(?:\A|_)(.)/) { Regexp.last_match(1).upcase }
+      input = input.to_s.dup
+      input.sub!(/^[a-z\d]*/) { |match| inflections.acronyms.apply_to(match) }
+      input.gsub!(%r{(?:_|(/))([a-z\d]*)}i) do
+        m1 = Regexp.last_match(1)
+        m2 = Regexp.last_match(2)
+        "#{m1}#{inflections.acronyms.apply_to(m2)}"
+      end
+      input.gsub!("/", "::")
+      input
     end
 
     # Find a constant with the name specified in the argument string
@@ -134,10 +142,13 @@ module Dry
     def humanize(input)
       input = input.to_s
       result = inflections.humans.apply_to(input)
-      result.gsub!(/_id\z/, "")
+      result.chomp!("_id")
       result.tr!("_", " ")
-      result.capitalize!
-      result
+      match = /(?<separator>\W)/.match(result)
+      separator = match ? match[:separator] : DEFAULT_SEPARATOR
+      result.split(separator).map.with_index { |word, index|
+        inflections.acronyms.apply_to(word, index.zero?)
+      }.join(separator)
     end
 
     # Creates a foreign key name
@@ -151,7 +162,7 @@ module Dry
     #   inflector = Dry::Inflector.new
     #   inflector.foreign_key("Message") => "message_id"
     def foreign_key(input)
-      "#{underscorize(demodulize(input))}_id"
+      "#{underscore(demodulize(input))}_id"
     end
 
     # Ordinalize a number
@@ -237,7 +248,7 @@ module Dry
     #   inflector.tableize("Book") # => "books"
     def tableize(input)
       input = input.to_s.gsub(/::/, "_")
-      pluralize(underscorize(input))
+      pluralize(underscore(input))
     end
 
     # Underscore a string
@@ -253,8 +264,17 @@ module Dry
     #   inflector = Dry::Inflector.new
     #   inflector.underscore("dry-inflector") # => "dry_inflector"
     def underscore(input)
-      input = input.to_s.gsub(/::/, "/")
-      underscorize(input)
+      input = input.to_s.gsub("::", "/")
+      input.gsub!(inflections.acronyms.regex) do
+        m1 = Regexp.last_match(1)
+        m2 = Regexp.last_match(2)
+        "#{m1 ? '_' : '' }#{m2.downcase}"
+      end
+      input.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+      input.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+      input.tr!("-", "_")
+      input.downcase!
+      input
     end
 
     # Check if the input is an uncountable word
@@ -274,18 +294,12 @@ module Dry
     # @api private
     ORDINALIZE_TH = (11..13).each_with_object({}) { |n, ret| ret[n] = true }.freeze
 
-    # @since 0.1.0
+    # @since 0.1.2
     # @api private
-    attr_reader :inflections
+    DEFAULT_SEPARATOR = " "
 
     # @since 0.1.0
     # @api private
-    def underscorize(input)
-      input.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-      input.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
-      input.tr!("-", "_")
-      input.downcase!
-      input
-    end
+    attr_reader :inflections
   end
 end

data/lib/dry/inflector/acronyms.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Dry
+  class Inflector
+    # A set of acronyms
+    #
+    # @since 0.1.2
+    # @api private
+    class Acronyms
+      attr_reader :regex
+
+      # @since 0.1.2
+      # @api private
+      def initialize
+        @rules = {}
+        define_regex_patterns
+      end
+
+      # @since 0.1.2
+      # @api private
+      def apply_to(word, capitalize = true)
+        @rules[word.downcase] || (capitalize ? word.capitalize : word)
+      end
+
+      # @since 0.1.2
+      # @api private
+      def add(rule, replacement)
+        @rules[rule] = replacement
+        define_regex_patterns
+      end
+
+      private
+
+      # @since 0.1.2
+      # @api private
+      def define_regex_patterns
+        regex = @rules.empty? ? /(?=a)b/ : /#{@rules.values.join("|")}/
+        @regex = /(?:(?<=([A-Za-z\d]))|\b)(#{regex})(?=\b|[^a-z])/
+      end
+    end
+  end
+end

data/lib/dry/inflector/inflections.rb

@@ -2,6 +2,7 @@
 
 require "set"
 require "dry/inflector/rules"
+require "dry/inflector/acronyms"
 
 module Dry
   class Inflector
@@ -57,6 +58,14 @@ module Dry
       # @api private
       attr_reader :humans
 
+      # Acronyms
+      #
+      # @return [Dry::Inflector::Acronyms]
+      #
+      # @since 0.1.2
+      # @api private
+      attr_reader :acronyms
+
       # Instantiate the rules
       #
       # @return [Dry::Inflector::Inflections]
@@ -69,6 +78,7 @@ module Dry
         @singulars    = Rules.new
         @humans       = Rules.new
         @uncountables = Set[]
+        @acronyms     = Acronyms.new
 
         yield(self) if block_given?
       end
@@ -160,6 +170,28 @@ module Dry
         uncountables.merge(words.flatten)
       end
 
+      # Add one or more acronyms
+      #
+      # Acronyms affect how basic operations are performed, such
+      # as camelize/underscore.
+      #
+      # @param words [Array<String>] a list of acronyms
+      #
+      # @since 0.1.2
+      #
+      # @example
+      #   require "dry/inflector"
+      #
+      #   inflector = Dry::Inflector.new do |inflections|
+      #     inflections.acronym "HTML"
+      #   end
+      #
+      #   inflector.camelize("html")        # => "HTML"
+      #   inflector.underscore("HTMLIsFun") # => "html_is_fun"
+      def acronym(*words)
+        words.each { |word| @acronyms.add(word.downcase, word) }
+      end
+
       # Add a custom humanize rule
       #
       # Specifies a humanized form of a string by a regular expression rule or by a string mapping.

data/lib/dry/inflector/inflections/defaults.rb

@@ -18,6 +18,7 @@ module Dry
           singular(inflect)
           irregular(inflect)
           uncountable(inflect)
+          acronyms(inflect)
         end
 
         # @since 0.1.0
@@ -101,7 +102,13 @@ module Dry
           inflect.uncountable(%w[hovercraft moose deer milk rain Swiss grass equipment information rice money species series fish sheep jeans])
         end
 
-        private_class_method :plural, :singular, :irregular, :uncountable
+        # @since 0.1.2
+        # @api private
+        def self.acronyms(inflect)
+          inflect.acronym(*%w[JSON HTTP OpenSSL HMAC])
+        end
+
+        private_class_method :plural, :singular, :irregular, :uncountable, :acronyms
       end
       # rubocop:enable Metrics/MethodLength
       # rubocop:enable Metrics/AbcSize

data/lib/dry/inflector/version.rb

@@ -3,6 +3,6 @@
 module Dry
   class Inflector
     # @since 0.1.0
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dry-inflector
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Luca Guidi
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-18 00:00:00.000000000 Z
+date: 2018-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -82,6 +82,7 @@ files:
 - README.md
 - dry-inflector.gemspec
 - lib/dry/inflector.rb
+- lib/dry/inflector/acronyms.rb
 - lib/dry/inflector/inflections.rb
 - lib/dry/inflector/inflections/defaults.rb
 - lib/dry/inflector/rules.rb
@@ -107,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: DRY Inflector