sleeping_king_studios-tools 0.7.0.rc.0 → 1.0.0

data/lib/sleeping_king_studios/tools/toolbox/mixin.rb

@@ -1,4 +1,4 @@
-# lib/sleeping_king_studios/tools/toolbox/mixin.rb
+# frozen_string_literal: true
 
 require 'sleeping_king_studios/tools/toolbox'
 
@@ -6,27 +6,27 @@ module SleepingKingStudios::Tools::Toolbox
   # Implements recursive inheritance of both class and instance methods.
   module Mixin
     # @api private
-    def self.mixin? mod
+    def self.mixin?(mod)
       return false unless mod.is_a?(Module)
 
       mod.singleton_class.include?(self)
-    end # class method mixin?
+    end
 
-    # @api private
-    def included other
+    # @private
+    def included(other)
       return super unless defined?(self::ClassMethods)
 
       if SleepingKingStudios::Tools::Toolbox::Mixin.mixin?(other)
         unless other.constants(false).include?(:ClassMethods)
           other.const_set(:ClassMethods, Module.new)
-        end # unless
+        end
 
-        other::ClassMethods.send :include, self::ClassMethods
+        other::ClassMethods.include(self::ClassMethods)
       else
         other.extend self::ClassMethods
-      end # if-else
+      end
 
       super
-    end # method included
-  end # module
-end # module
+    end
+  end
+end

data/lib/sleeping_king_studios/tools/toolbox/semantic_version.rb

@@ -1,4 +1,4 @@
-# lib/sleeping_king_studios/tools/toolbox/semantic_version.rb
+# frozen_string_literal: true
 
 require 'sleeping_king_studios/tools/toolbox'
 
@@ -47,7 +47,7 @@ module SleepingKingStudios::Tools::Toolbox
     #
     # @raise InvalidVersionError If MAJOR, MINOR, or PATCH is undefined.
     def to_gem_version
-      str = "#{const_fetch :MAJOR}.#{const_fetch :MINOR}.#{const_fetch :PATCH}"
+      str = +"#{const_fetch :MAJOR}.#{const_fetch :MINOR}.#{const_fetch :PATCH}"
 
       prerelease = const_fetch(:PRERELEASE, nil)
       str << ".#{prerelease}" unless prerelease.nil? || prerelease.empty?
@@ -56,7 +56,7 @@ module SleepingKingStudios::Tools::Toolbox
       str << ".#{build}" unless build.nil? || build.empty?
 
       str
-    end # method to_version
+    end
 
     # Concatenates the MAJOR, MINOR, and PATCH constant values with PRERELEASE
     # and BUILD (if available) to generate a semantic version string. The
@@ -82,7 +82,7 @@ module SleepingKingStudios::Tools::Toolbox
     #
     # @raise InvalidVersionError If MAJOR, MINOR, or PATCH is undefined.
     def to_version
-      str = "#{const_fetch :MAJOR}.#{const_fetch :MINOR}.#{const_fetch :PATCH}"
+      str = +"#{const_fetch :MAJOR}.#{const_fetch :MINOR}.#{const_fetch :PATCH}"
 
       prerelease = const_fetch(:PRERELEASE, nil)
       str << "-#{prerelease}" unless prerelease.nil? || prerelease.empty?
@@ -91,18 +91,19 @@ module SleepingKingStudios::Tools::Toolbox
       str << "+#{build}" unless build.nil? || build.empty?
 
       str
-    end # method to_version
+    end
 
     private
 
     FETCH_DEFAULT = Object.new.freeze
 
-    def const_fetch name, default = FETCH_DEFAULT
-      if self.const_defined?(name)
-        return self.const_get(name).to_s
-      elsif default == FETCH_DEFAULT
-        raise InvalidVersionError.new "undefined constant for #{name.downcase} version"
-      end # if-else
-    end # method const_fetch
-  end # module
-end # module
+    def const_fetch(name, default = FETCH_DEFAULT)
+      return const_get(name).to_s if const_defined?(name)
+
+      return nil unless default == FETCH_DEFAULT
+
+      raise InvalidVersionError,
+        "undefined constant for #{name.downcase} version"
+    end
+  end
+end

data/lib/sleeping_king_studios/tools/version.rb

@@ -1,4 +1,4 @@
-# lib/sleeping_king_studios/tools/version.rb
+# frozen_string_literal: true
 
 require 'sleeping_king_studios/tools/toolbox/semantic_version'
 
@@ -10,15 +10,19 @@ module SleepingKingStudios
     module Version
       extend SleepingKingStudios::Tools::Toolbox::SemanticVersion
 
-      private
-
-      MAJOR      = 0
-      MINOR      = 7
-      PATCH      = 0
-      PRERELEASE = :rc
-      BUILD      = 0
-    end # module
+      # Major version.
+      MAJOR = 1
+      # Minor version.
+      MINOR = 0
+      # Patch version.
+      PATCH = 0
+      # Prerelease version.
+      PRERELEASE = nil
+      # Build metadata.
+      BUILD = nil
+    end
 
+    # The current version of the gem.
     VERSION = Version.to_gem_version
-  end # module
-end # module
+  end
+end

metadata

@@ -1,73 +1,92 @@
 --- !ruby/object:Gem::Specification
 name: sleeping_king_studios-tools
 version: !ruby/object:Gem::Version
-  version: 0.7.0.rc.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Rob "Merlin" Smith
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-05-02 00:00:00.000000000 Z
+date: 2021-01-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 8.2.2
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.2'
-    - - ">="
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 8.2.2
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
-  name: rspec-sleeping_king_studios
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -75,12 +94,65 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
-    - - ">="
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: 0.18.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-sleeping_king_studios
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: sleeping_king_studios-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 description: |
-  A library of utility services and concerns to expand the functionality of core
-  classes without polluting the global namespace.
+  A library of utility services and concerns to expand the functionality of
+  core classes without polluting the global namespace.
 email:
 - merlin@sleepingkingstudios.com
 executables: []
@@ -88,25 +160,23 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - DEVELOPMENT.md
 - LICENSE
 - README.md
 - lib/sleeping_king_studios/tools.rb
-- lib/sleeping_king_studios/tools/all.rb
 - lib/sleeping_king_studios/tools/array_tools.rb
+- lib/sleeping_king_studios/tools/base.rb
 - lib/sleeping_king_studios/tools/core_tools.rb
-- lib/sleeping_king_studios/tools/enumerable_tools.rb
 - lib/sleeping_king_studios/tools/hash_tools.rb
 - lib/sleeping_king_studios/tools/integer_tools.rb
 - lib/sleeping_king_studios/tools/object_tools.rb
-- lib/sleeping_king_studios/tools/semantic_version.rb
 - lib/sleeping_king_studios/tools/string_tools.rb
-- lib/sleeping_king_studios/tools/string_tools/plural_inflector.rb
 - lib/sleeping_king_studios/tools/toolbelt.rb
 - lib/sleeping_king_studios/tools/toolbox.rb
-- lib/sleeping_king_studios/tools/toolbox/configuration.rb
 - lib/sleeping_king_studios/tools/toolbox/constant_map.rb
-- lib/sleeping_king_studios/tools/toolbox/delegator.rb
+- lib/sleeping_king_studios/tools/toolbox/inflector.rb
+- lib/sleeping_king_studios/tools/toolbox/inflector/rules.rb
 - lib/sleeping_king_studios/tools/toolbox/mixin.rb
 - lib/sleeping_king_studios/tools/toolbox/semantic_version.rb
 - lib/sleeping_king_studios/tools/version.rb
@@ -114,7 +184,7 @@ homepage: http://sleepingkingstudios.com
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -122,16 +192,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: A library of utility services and concerns.
 test_files: []

data/lib/sleeping_king_studios/tools/all.rb

@@ -1,5 +0,0 @@
-# lib/sleeping_king_studios/tools/all.rb
-
-Dir[File.join File.dirname(__FILE__), '*_tools.rb'].each do |file|
-  require file
-end # end each

data/lib/sleeping_king_studios/tools/enumerable_tools.rb

@@ -1,8 +0,0 @@
-# lib/sleeping_king_studios/tools/enumerable_tools.rb
-
-require 'sleeping_king_studios/tools/array_tools'
-
-module SleepingKingStudios::Tools
-  # Alias for ArrayTools to ensure backward compatibility.
-  EnumerableTools = ArrayTools
-end # module

data/lib/sleeping_king_studios/tools/semantic_version.rb

@@ -1,15 +0,0 @@
-# lib/sleeping_king_studios/tools/semantic_version.rb
-
-require 'sleeping_king_studios/tools/core_tools'
-
-SleepingKingStudios::Tools::CoreTools.deprecate(
-  'SleepingKingStudios::Tools::SemanticVersion',
-  :message => 'Use SleepingKingStudios::Tools::Toolbox::SemanticVersion instead.'
-) # end deprecate
-
-require 'sleeping_king_studios/tools/toolbox/semantic_version'
-
-module SleepingKingStudios::Tools
-  # (see SleepingKingStudios::Tools::Toolbox::SemanticVersion)
-  SemanticVersion = Toolbox::SemanticVersion
-end # module

data/lib/sleeping_king_studios/tools/string_tools/plural_inflector.rb

@@ -1,185 +0,0 @@
-# lib/sleeping_king_studios/tools/string_tools/plural_inflector.rb
-
-require 'sleeping_king_studios/tools/string_tools'
-
-module SleepingKingStudios::Tools::StringTools
-  # Inflector class to handle word pluralization using a set of defined rules
-  # and irregular/uncountable words.
-  class PluralInflector
-    # Defines an irregular word, which is a singular and plural word pair that
-    # do not obey any defined rule, such as "goose" and "geese".
-    #
-    # @param singular [String] The singular form of the word.
-    # @param plural [String] The plural form of the word.
-    def define_irregular_word singular, plural
-      irregular_words[singular]       = plural
-      inverse_irregular_words[plural] = singular
-    end # method define_irregular_word
-
-    # Defines a rule for pluralization. The rule will be applied to any words
-    # that match the first parameter, performing a replace on the word using
-    # the second parameter.
-    #
-    # Rules are applied in reverse order of definition, meaning that rules
-    # defined later will take precedence over previously defined rules.
-    #
-    # @param match [Regexp] The matching rule.
-    # @param replace [String] The replacement string.
-    def define_plural_rule match, replace
-      plural_rules.unshift [match, replace]
-    end # method define_plural_rule
-
-    # Defines a rule for singularization. The rule will be applied to any words
-    # that match the first parameter, performing a replace on the word using
-    # the second parameter.
-    #
-    # Rules are applied in reverse order of definition, meaning that rules
-    # defined later will take precedence over previously defined rules.
-    #
-    # @param match [Regexp] The matching rule.
-    # @param replace [String] The replacement string.
-    def define_singular_rule match, replace
-      singular_rules.unshift [match, replace]
-    end # method define_singular_rule
-
-    # Defines an uncountable word, such as "data". If #pluralize or #singularize
-    # is called with an uncountable word as its parameter, it will return the
-    # unmodified word.
-    #
-    # @param word [String] The uncountable word.
-    def define_uncountable_word word
-      uncountable_words << word
-    end # method define_uncountable_word
-
-    # Takes a word in singular form and returns the plural form, based on the
-    # defined rules and known irregular/uncountable words.
-    #
-    # First, checks if the word is known to be uncountable (see
-    # #define_uncountable_word). Then, checks if the word is known to be
-    # irregular (see #define_irregular_word). Finally, iterates through the
-    # defined plural rules from most recently defined to first defined (see
-    # #define_plural_rule).
-    #
-    # @note The defined rules and exceptions are deliberately basic. Each
-    #   application is responsible for defining its own pluralization rules
-    #   using this framework.
-    #
-    # @param str [String] The word to pluralize.
-    #
-    # @return [String] The pluralized word.
-    #
-    # @see #singularize
-    def pluralize str
-      str        = str.to_s.strip
-      normalized = str.downcase
-
-      uncountable_words.each do |word|
-        return str if word == normalized
-      end # each
-
-      return str if inverse_irregular_words.key?(normalized)
-
-      return irregular_words[normalized] if irregular_words.key?(normalized)
-
-      plural_rules.each do |match, replace|
-        next unless str =~ match
-
-        return str.sub(match, replace)
-      end # each
-
-      str
-    end # method pluralize
-
-    # Takes a word in plural form and returns the singular form, based on the
-    # defined rules and known irregular/uncountable words.
-    #
-    # @param str [String] The word to singularize.
-    #
-    # @return [String] The singularized word.
-    #
-    # @see #pluralize
-    def singularize str
-      str        = str.to_s.strip
-      normalized = str.downcase
-
-      uncountable_words.each do |word|
-        return str if word == normalized
-      end # each
-
-      return inverse_irregular_words[normalized] if inverse_irregular_words.key?(normalized)
-
-      singular_rules.each do |match, replace|
-        next unless str =~ match
-
-        return str.sub(match, replace)
-      end # each
-
-      str
-    end # method singularize
-
-    private
-
-    def define_irregular_words
-      define_irregular_word 'child', 'children'
-      define_irregular_word 'person', 'people'
-    end # method define_irregular_words
-
-    def inverse_irregular_words
-      return @inverse_irregular_words if @inverse_irregular_words
-
-      @inverse_irregular_words = {}
-
-      define_irregular_words
-
-      @inverse_irregular_words
-    end # method inverse_irregular_words
-
-    def irregular_words
-      return @irregular_words if @irregular_words
-
-      @irregular_words = {}
-
-      define_irregular_words
-
-      @irregular_words
-    end # method irregular_words
-
-    def plural_rules
-      return @plural_rules if @plural_rules
-
-      @plural_rules = []
-
-      define_plural_rule(/$/, 's')
-      define_plural_rule(/s$/, 's')
-      define_plural_rule(/(ss|[xz]|[cs]h)$/i, '\1es')
-      define_plural_rule(/([^aeiouy]o)$/i, '\1es')
-      define_plural_rule(/([^aeiouy])y$/i, '\1ies')
-
-      @plural_rules
-    end # method plural_rules
-
-    def singular_rules
-      return @singular_rules if @singular_rules
-
-      @singular_rules = []
-
-      define_singular_rule(/s$/i, '')
-      define_singular_rule(/ss$/i, 'ss')
-      define_singular_rule(/(ss|[sxz]|[cs]h)es$/, '\1')
-      define_singular_rule(/([^aeiouy]o)es$/, '\1')
-      define_singular_rule(/([^aeiouy])ies$/i, '\1y')
-
-      @singular_rules
-    end # method singular_rules
-
-    def uncountable_words
-      return @uncountable_words if @uncountable_words
-
-      @uncountable_words = []
-
-      @uncountable_words << 'data'
-
-      @uncountable_words
-    end # method uncountable_words
-  end # class
-end # module