sleeping_king_studios-tools 0.6.0 → 0.7.0.alpha.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83685650ea80f1fa0a03b22981978defb5d3386b
-  data.tar.gz: cb05c84a361bca80fe33ca5f9a75bc30cb6694d8
+  metadata.gz: 5f27a979de124657efcdfa2d4b8293b2c8d71458
+  data.tar.gz: c7a28bce980002ba427a38e491130a29fb29672e
 SHA512:
-  metadata.gz: 8309254a1b32fc7338f82309c5df516c2b3b3f88d7c79460c46504488c84a8abd8469bfecca3fb3407c863c2c03005d32fa082cf4a7f00c1c58a1bcc68aea019
-  data.tar.gz: f7bc789290f287c3142a9b638ef1592fbef1235facd727c86b429a64b351bd6930563c503e09a0ba9de7b80fab76835407dc3ad19da99774f8012f7a92613e9f
+  metadata.gz: 6b229bf6aa673e10662fc71cbeb5b55b0f4c3eaf3d9959dcff67895595b5074e03a61238c35c36f779e545672bb5669d7f08805b46b0360f77d2824741ad5db8
+  data.tar.gz: 7c0546a0349e2d556976f5356abfc77bb710b6d477f2d4e23d05b422a50d8f6c32fe1a9105bd15e77a98c2895696c0f5dccca6556fe2d0657bdd301a4b0f0664

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## Upcoming Release
+
+### 0.7.0
+
+#### Tools
+
+- Support symbol arguments to StringTools methods.
+- Implement StringTools#chain.
+- Implement StringTools#indent.
+- Implement StringTools#map_lines.
+
+#### Misc.
+
+- SleepingKingStudios::Tools::Toolbelt is now autoloaded from SleepingKingStudios::Tools.
+
 ## Current Release
 
 ### 0.6.0

data/DEVELOPMENT.md

@@ -2,12 +2,6 @@
 
 ## 0.7.0
 
-- StringTools - support symbolic arguments
-- StringTools#chain |
-
-  tools.chain(str, :underscore, :pluralize)
-  #=> shorthand for tools.pluralize(tools.underscore str)
-
 - IntegerTools#pluralize - have third (plural string) parameter be optional and defer to StringTools#pluralize.
 
 - Toolbelt should be autoloaded via Tools.
@@ -21,10 +15,6 @@
 - HashTools::slice, ::bisect_keys
 - ObjectTools::apply_with_arity
 - ObjectTools::method_arity
-- StringTools#map_lines |
-
-  tools.map_lines("10\n20 GOTO 10") { |str| "  #{str}" }
-  #=> "  10\n  20 GOTO 10"
 - Delegator#delegate, :prefix => prefix_name
 
 #### Tools

data/README.md

@@ -16,7 +16,7 @@ Hi, I'm Rob Smith, a Ruby Engineer and the developer of this library. I use thes
 
 The tools can be accessed in a convenient form using the Toolbelt class.
 
-    require 'sleeping_king_studios/tools/toolbelt'
+    require 'sleeping_king_studios/tools'
 
     tools = ::SleepingKingStudios::Tools::Toolbelt.instance
 
@@ -532,6 +532,50 @@ Converts a lowercase, underscore separated string to a mixed-case string express
     StringTools#camelize 'muspelheimr_and_niflheimr'
     #=> 'MuspelheimrAndNiflheimr'
 
+#### `#chain`
+
+Performs multiple string tools operations in sequence, starting with the given string and passing the result of each operation to the next.
+
+    # Equivalent to `StringTools.underscore(StringTools.pluralize str)`.
+    StringTools#chain 'ArchivedPeriodical', :underscore, :pluralize
+    # => 'archived_periodicals'
+
+Adds the specified number of spaces to the start of each line of the string. Defaults to 2 spaces.
+
+    string = 'The Hobbit'
+    StringTools.indent(string)
+    #=> '  The Hobbit'
+
+    titles = [
+      "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"\
+        "    The Two Towers\n"\
+        "    The Return of the King"
+
+#### `#map_lines`
+
+Yields each line of the string to the provided block and combines the results into a new multiline string.
+
+    string = 'The Hobbit'
+    StringTools.map_lines(string) { |line| "  #{line}" }
+    #=> '- The Hobbit'
+
+    titles = [
+      "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"\
+        "1. The Two Towers\n"\
+        "2. The Return of the King"
+
 #### `#plural?`
 
 Returns true if the word is in plural form, and returns false otherwise. A word is in plural form if and only if calling `#pluralize` (see below) on the word returns the word without modification.

data/lib/sleeping_king_studios/tools/string_tools.rb

@@ -18,13 +18,26 @@ module SleepingKingStudios::Tools
     #
     # @see ActiveSupport::Inflector#camelize.
     def camelize str
-      require_string! str
+      str = require_string! str
 
       str = str.dup
       str.gsub!(/(\b|[_-])([a-z])/) { |match| $2.upcase }
       str
     end # method camelize
 
+    # Performs multiple string tools operations in sequence, starting with the
+    # given string and passing the result of each operation to the next.
+    #
+    # @param str [String] The string to process.
+    # @param commands [Array<String, Symbol>] The string operations to apply.
+    #
+    # @return [String] The processed string.
+    def chain str, *commands
+      str = require_string! str
+
+      commands.reduce(str) { |memo, command| send(command, memo) }
+    end # method chain
+
     # (see PluralInflector#define_irregular_word)
     def define_irregular_word singular, plural
       plural_inflector.define_irregular_word singular, plural
@@ -45,11 +58,44 @@ module SleepingKingStudios::Tools
       plural_inflector.define_uncountable_word word
     end # method define_uncountable_word
 
+    # Adds the specified number of spaces to the start of each line of the
+    # string. Defaults to 2 spaces.
+    #
+    # @param str [String] The string to indent.
+    # @param count [Integer] The number of spaces to add.
+    #
+    # @return [String] The indented string.
+    def indent str, count = 2
+      str = require_string! str
+      pre = " " * count
+
+      map_lines(str) { |line| "#{pre}#{line}" }
+    end # method indent
+
+    # Yields each line of the string to the provided block and combines the
+    # results into a new multiline string.
+    #
+    # @param str [String] The string to map.
+    #
+    # @yieldparam line [String] The current line.
+    # @yieldparam index [Integer] The index of the current line.
+    #
+    # @return [String] The mapped string.
+    def map_lines str
+      str = require_string! str
+
+      str.each_line.with_index.reduce('') do |memo, (line, index)|
+        memo << yield(line, index)
+      end # each_line
+    end # method map_lines
+
     # Determines whether or not the given word is in plural form. If calling
     # #pluralize(word) is equal to word, the word is considered plural.
     #
     # @return [Boolean] True if the word is in plural form, otherwise false.
     def plural? word
+      word = require_string!(word)
+
       word == pluralize(word)
     end # method plural?
 
@@ -87,9 +133,9 @@ module SleepingKingStudios::Tools
         return IntegerTools.pluralize(*args)
       end # if
 
-      require_string! args.first
+      str = require_string! args.first
 
-      plural_inflector.pluralize args.first
+      plural_inflector.pluralize str
     end # method pluralize
 
     # Determines whether or not the given word is in singular form. If calling
@@ -97,6 +143,8 @@ module SleepingKingStudios::Tools
     #
     # @return [Boolean] True if the word is in singular form, otherwise false.
     def singular? word
+      word = require_string!(word)
+
       word == singularize(word)
     end # method singular?
 
@@ -125,7 +173,7 @@ module SleepingKingStudios::Tools
     #
     # @see ActiveSupport::Inflector#underscore.
     def underscore str
-      require_string! str
+      str = require_string! str
 
       str = str.dup
       str.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
@@ -142,7 +190,9 @@ module SleepingKingStudios::Tools
     end # method plural_inflector
 
     def require_string! value
-      return if string?(value)
+      return value if string?(value)
+
+      return value.to_s if value.is_a?(Symbol)
 
       raise ArgumentError, 'argument must be a string', caller[1..-1]
     end # method require_array

data/lib/sleeping_king_studios/tools/version.rb

@@ -13,10 +13,10 @@ module SleepingKingStudios
       private
 
       MAJOR      = 0
-      MINOR      = 6
+      MINOR      = 7
       PATCH      = 0
-      PRERELEASE = nil
-      BUILD      = nil
+      PRERELEASE = :alpha
+      BUILD      = 0
     end # module
 
     VERSION = Version.to_gem_version

data/lib/sleeping_king_studios/tools.rb

@@ -4,7 +4,9 @@
 module SleepingKingStudios
   # A library of utility services and concerns to expand the functionality of
   # core classes without polluting the global namespace.
-  module Tools; end
+  module Tools
+    autoload :Toolbelt, 'sleeping_king_studios/tools/toolbelt'
+  end # module
 end # module
 
 require 'sleeping_king_studios/tools/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sleeping_king_studios-tools
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0.alpha.0
 platform: ruby
 authors:
 - Rob "Merlin" Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-27 00:00:00.000000000 Z
+date: 2017-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -124,12 +124,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: A library of utility services and concerns.