sleeping_king_studios-tools 0.8.0 → 1.0.0.rc.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec480f3a22706bc58097d0d85632d800ea2ec49994a6f1f0694e2f33ff0b3809
-  data.tar.gz: b4422c9ec69b876a987e78f84d13c89701704ab0ed7a61737812287595a72759
+  metadata.gz: '08f7da019bd99db3f4ca55c4fc1011c7673418e770fc71c6703b3bfc180d68ad'
+  data.tar.gz: fdbac29f13f7ac6f31cb3c2bc5b6ab6cd067f89a9d781dadac0c93162cb4fc7e
 SHA512:
-  metadata.gz: 054a259336cde5f020e7fa67e2370c3ecef621f1ca2ebdd4c0e28703887e23dbcc8178844b2b415e0fdde0ad2e60ed72040a436f009eadb4d059a5f27fafac35
-  data.tar.gz: 4b093d9a4c59900422d0b3851b04bccefc2aa5ee2b6dbed68a083aa8b511b47e84957c6d4dc71c997b24ede623584d07293161cfa5588fbe20e27ee6897aebd7
+  metadata.gz: 58b8f9dd88f40cf021c5d894203a785d4397a63837bdd64a4cc635e24f551b9504f7794117a06d0f5bb62d9d43b538bd02bffb4bb4bdbd3295b6b66ca6af236b
+  data.tar.gz: bdd4ed20447de1a9b3d8d1db3d73f9dd230abd3cc447d23b62935267e4fe79c254b792898bbcaa38ce02044770ae1fac0d14450f817ebce16bf75ac9f61131a0

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+### 1.0.0
+
+- Removed all deprecated code from pre-1.0 releases.
+
 ### 0.8.0
 
 Last minor release before 1.0.0.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+merlin@sleepingkingstudios.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/DEVELOPMENT.md

@@ -1,24 +1,17 @@
 # Development Notes
 
-## 1.0.0
-
-- Remove sleeping_king_studios/tools/all
-- Remove all deprecated methods and references.
-- Documentation pass.
-
 ## Future Tasks
 
-### Features
-
-- HashTools::slice, ::bisect_keys
-- ObjectTools::apply_with_arity
-- ObjectTools::method_arity
-- Delegator#delegate, :prefix => prefix_name
-
-#### Tools
+### Tools
 
+- HashTools#bisect_keys
+- HashTools#slice
+- ObjectTools#apply_with_arity
+- ObjectTools#method_arity
 - ObjectTools#pretty - returns user-friendly string representation. :multiline option? Delegates to specific toolset implementations.
 - RegexpTools#matching_string - generates a string that matches the regular expression. Does not support advanced Regexp features.
 - RegexpTools#nonmatching_strings - generates a set of strings that do not match the regular expression.
-- Identity Methods
-  - RegexpTools#regexp? - true if object is regular expression, otherwise false.
+
+#### Identity Methods
+
+- RegexpTools#regexp? - true if object is regular expression, otherwise false.

data/LICENSE

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2013-2016 Rob Smith
+Copyright (c) 2013 Rob Smith
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -2,13 +2,27 @@
 
 A library of utility services and concerns to expand the functionality of core classes without polluting the global namespace.
 
-## Contribute
+## About
 
-- https://github.com/sleepingkingstudios/sleeping_king_studios-tools
+SleepingKingStudios::Tools is tested against MRI Ruby 2.5 through 3.0.
 
-### A Note From The Developer
+### Documentation
 
-Hi, I'm Rob Smith, a Ruby Engineer and the developer of this library. I use these tools every day, but they're not just written for me. If you find this project helpful in your own work, or if you have any questions, suggestions or critiques, please feel free to get in touch! I can be reached on GitHub (see above, and feel encouraged to submit bug reports or merge requests there) or via email at `merlin@sleepingkingstudios.com`. I look forward to hearing from you!
+Method and class documentation is available courtesy of RubyDoc.
+
+Documentation is generated using [YARD](https://yardoc.org/), and can be generated locally using the `yard` gem.
+
+### License
+
+SleepingKingStudios::Tools is released under the [MIT License](https://opensource.org/licenses/MIT).
+
+### Contribute
+
+The canonical repository for this gem is on [GitHub](https://github.com/sleepingkingstudios/sleeping_king_studios-tasks). Community contributions are welcome - please feel free to fork or submit issues, bug reports or pull requests.
+
+### Code of Conduct
+
+Please note that the `SleepingKingStudios::Tools` project is released with a [Contributor Code of Conduct](https://github.com/sleepingkingstudios/sleeping_king_studios-tools/blob/master/CODE_OF_CONDUCT.md). By contributing to this project, you agree to abide by its terms.
 
 ## Tools
 
@@ -418,19 +432,19 @@ Creates a deep copy of the object. If the object is an Array, returns a new Arra
           :name   => 'Welcome to the Jungle',
           :artist => "Guns N' Roses",
           :album  => 'Appetite for Destruction'
-        }, # end hash
+        },
         {
           :name   => 'Hells Bells',
           :artist => 'AC/DC',
           :album  => 'Back in Black'
-        }, # end hash
+        },
         {
           :name   => "Knockin' on Heaven's Door",
           :artist => 'Bob Dylan',
           :album  => 'Pat Garrett & Billy The Kid'
-        } # end hash
-      ] # end array
-    } # end hash
+        }
+      ]
+    }
 
     copy = ObjectTools.deep_dup data
 
@@ -452,19 +466,19 @@ Performs a deep freeze of the object. If the object is an Array, freezes the arr
           :name   => 'Welcome to the Jungle',
           :artist => "Guns N' Roses",
           :album  => 'Appetite for Destruction'
-        }, # end hash
+        },
         {
           :name   => 'Hells Bells',
           :artist => 'AC/DC',
           :album  => 'Back in Black'
-        }, # end hash
+        },
         {
           :name   => "Knockin' on Heaven's Door",
           :artist => 'Bob Dylan',
           :album  => 'Pat Garrett & Billy The Kid'
-        } # end hash
-      ] # end array
-    } # end hash
+        }
+      ]
+    }
     ObjectTools.deep_freeze(data)
 
     data.frozen?
@@ -577,7 +591,7 @@ Adds the specified number of spaces to the start of each line of the string. Def
       "The Fellowship of the Ring",
       "The Two Towers",
       "The Return of the King"
-    ] # end titles
+    ]
     string = titles.join "\n"
     StringTools.indent(string, 4)
     #=> "    The Fellowship of the Ring\n"\
@@ -596,7 +610,7 @@ Yields each line of the string to the provided block and combines the results in
       "The Fellowship of the Ring",
       "The Two Towers",
       "The Return of the King"
-    ] # end titles
+    ]
     string = titles.join "\n"
     StringTools.map_lines(string) { |line, index| "#{index}. #{line}" }
     #=> "0. The Fellowship of the Ring\n"\
@@ -691,75 +705,6 @@ Converts a mixed-case string expression to a lowercase, underscore separated str
 
 Common objects or patterns that are useful across projects but are larger than or do not fit the functional paradigm of the tools.* pattern.
 
-### Configuration
-
-    require 'sleeping_king_studios/tools/toolbox/configuration'
-
-This module is now deprecated. Use a struct instead.
-
-Provides a simple DSL for defining configuration objects, which can be populated via hashes or data objects (such as a Rails configuration object).
-
-    class MyGemConfig < SleepingKingStudios::Tools::Toolbox::Configuration
-      option :template_dir
-
-      namespace :serialization do
-        option :format, :default => :json, :enum => [:json, :xml, :yaml]
-      end # namespace
-    end # class
-
-    # Initialize with a hash.
-    hsh    = YAML.load(File.read 'path/to/config.yml')
-    config = MyGemConfig.new(hsh)
-
-    # Initialize with a data object.
-    klass  = Struct.new(:template_dir)
-    data   = klass.new('path/to/templates')
-    config = MyGemConfig.new(data)
-
-    # Retrieve data by calling methods or using hash syntax. All of the
-    # following will return the configured value:
-    config.serialization.format
-    config[:serialization][:format]
-    config['serialization']['format']
-    config.dig(:serialization, :format)
-    config.fetch(:serialization', {}).fetch(:format, :json)
-
-#### `::namespace`
-
-Defines an inner namespace for the configuration, which will itself be an instance of Configuration. Can be nested to any depth:
-
-    class MyGemConfig < SleepingKingStudios::Tools::Toolbox::Configuration
-      namespace :weapons do
-        namespace :swords do
-          namespace :upgrades do
-            option :hilts
-
-            option :tangs
-          end # namespace
-        end # namespace
-      end # namespace
-    end # class
-
-    config.weapons.swords.upgrades
-    #=> a Configuration instance, with options #hilts and #tangs.
-
-#### `::option`
-
-Defines an option, which creates an accessor and mutator method for the property. Can configure a :default (can be a value, a Proc, or the name of a
-method) and/or allowable values via the :enum option.
-
-    class MyGemConfig < SleepingKingStudios::Tools::Toolbox::Configuration
-      option :max_level, :default => 20
-
-      option :class, :enum => %(warrior ranger elementalist monk)
-    end # class
-
-    config.max_level
-    # Returns 20 if no configured value is set.
-
-    config.class = 'necromancer'
-    # Raises an error.
-
 ### ConstantMap
 
     require 'sleeping_king_studios/tools/toolbox/constant_map'
@@ -767,10 +712,12 @@ method) and/or allowable values via the :enum option.
 Provides an enumerable interface for defining a group of constants.
 
     UserRoles = ConstantMap.new(
-      :GUEST => 'guest',
-      :USER  => 'user',
-      :ADMIN => 'admin'
-    ) # end constants
+      {
+        GUEST: 'guest',
+        USER:  'user',
+        ADMIN: 'admin'
+      }'
+    )
 
     UserRoles::GUEST
     #=> 'guest'
@@ -781,11 +728,27 @@ Provides an enumerable interface for defining a group of constants.
     UserRoles.all
     #=> { :GUEST => 'guest', :USER => 'user', :ADMIN => 'admin' }
 
-### Delegator
+ConstantMap includes `Enumerable`, with `#each` yielding the name and value of each defined constant. It also defines the following additional methods:
+
+#### `#each_key`
+
+Yields each defined constant name, similar to `Hash#each_key`.
+
+#### `#each_value`
+
+Yields each defined constant value, similar to `Hash#each_value`.
+
+#### `#keys`
+
+Returns an array containing the names of the defined constants, similar to `Hash#keys`.
+
+#### `#to_h`
+
+Also `#all`. Returns a Hash representation of the constants.
 
-    require 'sleeping_king_studios/tools/toolbox/delegator'
+#### `#values`
 
-This module is now deprecated. Use the stdlib `Forwardable` module instead.
+Returns an array containing the values of the defined constants, similar to `Hash#values`.
 
 ### Mixin
 

data/lib/sleeping_king_studios/tools/array_tools.rb

@@ -5,7 +5,10 @@ require 'sleeping_king_studios/tools'
 module SleepingKingStudios::Tools
   # Tools for working with array-like enumerable objects.
   class ArrayTools < SleepingKingStudios::Tools::Base
+    # Expected methods that an Array-like object should implement.
     ARRAY_METHODS = %i[[] count each].freeze
+
+    # Methods that an Array-like object should *not* implement.
     OTHER_METHODS = %i[each_key each_pair].freeze
 
     class << self
@@ -182,7 +185,7 @@ module SleepingKingStudios::Tools
     # @raise ArgumentError If the first argument is not an Array-like object.
     #
     # @return [String] The formatted string.
-    def humanize_list(ary, **options, &block) # rubocop:disable Metrics/AbcSize
+    def humanize_list(ary, **options, &block)
       require_array! ary
 
       return '' if ary.empty?
@@ -280,9 +283,9 @@ module SleepingKingStudios::Tools
     private
 
     def options_for_humanize_list(
+      size:,
       last_separator: ' and ',
-      separator: ', ',
-      size:
+      separator: ', '
     )
       return [separator, last_separator] if size < 3