ruby-pwsh 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 461a867f01c932c2baaaee8211f32cec09921d1e1b8f706fc7abe9dba7489d7b
-  data.tar.gz: 9086a7408096976b332b8b1fe97771de8d86788d3ac2a87421493b89b9215311
+  metadata.gz: b9ff0bf2c8d109926cd0161323e4d49e6b697410883d5c6da7e8beda5cf8de6d
+  data.tar.gz: da85cd63a46c1d75b0b1178d9841f3d3e134ad20dead8847eb724d52bec3a847
 SHA512:
-  metadata.gz: ed6bff68ed27bcb1db20103cf7105bea51776456073f457177c029251aa0c2c0b9d7aec1085f86141b1c88ce0c06da4e7cf5ac6a3375b7aca5684c06c575b2fb
-  data.tar.gz: 29a9c33098583b09e10ed5c18f706da954e5ce1d1b1f5fdf24ba086128da851d1e24e954ae9b0735abc3cd95d9bc4faaec61d327c78595fac04c50c9123b4d5c
+  metadata.gz: '09007c0add66995ff0a978129c9b3da760d4d5a9a95bad6bf77226afdcbdeab2508ad68ac39c2217bd5bd57be41904b18333dcba14365441c98582291224782a'
+  data.tar.gz: 2157ae9772fefc54271500a3d7d84502d1737e45fc54986405e45da962fb40fd855d482b4e31aa33febb61756f9d6944f9db82a4fb1f6dcea696ec7f6b81beea

data/.gitignore

@@ -13,3 +13,6 @@
 
 Gemfile.local
 Gemfile.lock
+
+# build output
+/ruby-pwsh-*.gem

data/.pmtignore

@@ -13,7 +13,9 @@ CODEOWNERS
 CONTRIBUTING.md
 design-comms.png
 DESIGN.md
+pwshlib.md
 Gemfile
 Gemfile.lock
 Rakefile
 ruby-pwsh.gemspec
+*.gem

data/.rubocop.yml

@@ -19,7 +19,7 @@ Metrics/AbcSize:
 
 # requires 2.3's squiggly HEREDOC support, which we can't use, yet
 # see http://www.virtuouscode.com/2016/01/06/about-the-ruby-squiggly-heredoc-syntax/
-Layout/IndentHeredoc:
+Layout/HeredocIndentation:
   Enabled: false
 # Need to ignore rubocop complaining about the name of the library.
 Naming/FileName:

data/CHANGELOG.md

@@ -2,7 +2,19 @@
 
 All notable changes to this project will be documented in this file.The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org).
 
-## [0.2.0](https://github.com/puppetlabs/ruby-pwsh/tree/0.2.0) (2019-11-25)
+## [0.3.0](https://github.com/puppetlabs/ruby-pwsh/tree/0.3.0) (2019-12-03)
+
+[Full Changelog](https://github.com/puppetlabs/ruby-pwsh/compare/0.2.0...0.3.0)
+
+### Added
+
+- \(FEAT\) Add method for symbolizing hash keys [\#16](https://github.com/puppetlabs/ruby-pwsh/pull/16) ([michaeltlombardi](https://github.com/michaeltlombardi))
+
+### Fixed
+
+- \(FEAT\) Ensure hash key casing methods work on arrays [\#15](https://github.com/puppetlabs/ruby-pwsh/pull/15) ([michaeltlombardi](https://github.com/michaeltlombardi))
+
+## [0.2.0](https://github.com/puppetlabs/ruby-pwsh/tree/0.2.0) (2019-11-26)
 
 [Full Changelog](https://github.com/puppetlabs/ruby-pwsh/compare/0.1.0...0.2.0)
 

data/Gemfile

@@ -11,7 +11,7 @@ group :test do
   gem 'rspec', '~> 3.0'
   gem 'rspec-collection_matchers', '~> 1.0'
   gem 'rspec-its', '~> 1.0'
-  gem 'rubocop'
+  gem 'rubocop', '>= 0.77'
   gem 'rubocop-rspec'
   gem 'simplecov'
 end

data/README.md

@@ -60,6 +60,10 @@ ps_version = posh.execute('[String]$PSVersionTable.PSVersion')[:stdout].strip
 pp("The PowerShell version of the currently running Manager is #{ps_version}")
 ```
 
+## Reference
+
+You can find the full reference documentation online, [here](https://rubydoc.info/gems/ruby-pwsh).
+
 <!-- ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/pwsh/util.rb

@@ -31,50 +31,51 @@ module Pwsh
       invalid_paths
     end
 
-    # Return a string converted to snake_case
+    # Return a string or symbol converted to snake_case
     #
     # @return [String] snake_cased string
-    def snake_case(string)
+    def snake_case(object)
       # Implementation copied from: https://github.com/rubyworks/facets/blob/master/lib/core/facets/string/snakecase.rb
       # gsub(/::/, '/').
-      string.gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-            .gsub(/([a-z\d])([A-Z])/, '\1_\2')
-            .tr('-', '_')
-            .gsub(/\s/, '_')
-            .gsub(/__+/, '_')
-            .downcase
+      should_symbolize = object.is_a?(Symbol)
+      raise "snake_case method only handles strings and symbols, passed a #{object.class}: #{object}" unless should_symbolize || object.is_a?(String)
+
+      text = object.to_s
+                   .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+                   .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+                   .tr('-', '_')
+                   .gsub(/\s/, '_')
+                   .gsub(/__+/, '_')
+                   .downcase
+      should_symbolize ? text.to_sym : text
     end
 
     # Iterate through a hashes keys, snake_casing them
     #
     # @return [Hash] Hash with all keys snake_cased
-    def snake_case_hash_keys(hash)
-      modified_hash = {}
-      hash.each do |key, value|
-        value = snake_case_hash_keys(value) if value.is_a?(Hash)
-        modified_hash[snake_case(key.to_s).to_sym] = value
-      end
-      modified_hash
+    def snake_case_hash_keys(object)
+      snake_case_proc = proc { |key| snake_case(key) }
+      apply_key_mutator(object, snake_case_proc)
     end
 
-    # Return a string converted to PascalCase
+    # Return a string or symbol converted to PascalCase
     #
     # @return [String] PascalCased string
-    def pascal_case(string)
+    def pascal_case(object)
+      should_symbolize = object.is_a?(Symbol)
+      raise "snake_case method only handles strings and symbols, passed a #{object.class}: #{object}" unless should_symbolize || object.is_a?(String)
+
       # Break word boundaries to snake case first
-      snake_case(string).split('_').collect(&:capitalize).join
+      text = snake_case(object.to_s).split('_').collect(&:capitalize).join
+      should_symbolize ? text.to_sym : text
     end
 
     # Iterate through a hashes keys, PascalCasing them
     #
     # @return [Hash] Hash with all keys PascalCased
-    def pascal_case_hash_keys(hash)
-      modified_hash = {}
-      hash.each do |key, value|
-        value = pascal_case_hash_keys(value) if value.is_a?(Hash)
-        modified_hash[pascal_case(key.to_s).to_sym] = value
-      end
-      modified_hash
+    def pascal_case_hash_keys(object)
+      pascal_case_proc = proc { |key| pascal_case(key) }
+      apply_key_mutator(object, pascal_case_proc)
     end
 
     # Ensure that quotes inside a passed string will continue to be passed
@@ -84,6 +85,27 @@ module Pwsh
       text.gsub("'", "''")
     end
 
+    # Ensure that all keys in a hash are symbols, not strings.
+    #
+    # @return [Hash] a hash whose keys have been converted to symbols.
+    def symbolize_hash_keys(object)
+      symbolize_proc = proc(&:to_sym)
+      apply_key_mutator(object, symbolize_proc)
+    end
+
+    def apply_key_mutator(object, proc)
+      return object.map { |item| apply_key_mutator(item, proc) } if object.is_a?(Array)
+      return object unless object.is_a?(Hash)
+
+      modified_hash = {}
+      object.each do |key, value|
+        modified_hash[proc.call(key)] = apply_key_mutator(value, proc)
+      end
+      modified_hash
+    end
+
+    private_class_method :apply_key_mutator
+
     # Convert a ruby value into a string to be passed along to PowerShell for interpolation in a command
     # Handles:
     # - Strings

data/lib/pwsh/version.rb

@@ -2,5 +2,5 @@
 
 module Pwsh
   # The version of the ruby-pwsh gem
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/metadata.json

@@ -1,6 +1,6 @@
 {
   "name": "puppetlabs-pwshlib",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "author": "puppetlabs",
   "summary": "Provide library code for interoperating with PowerShell.",
   "license": "MIT",

data/pwshlib.md

@@ -88,3 +88,5 @@ Puppet.debug(posh.execute('[String]$PSVersionTable.PSVersion'))
 ps_version = posh.execute('[String]$PSVersionTable.PSVersion')[:stdout].strip
 Puppet.debug("The PowerShell version of the currently running Manager is #{ps_version}")
 ```
+
+For more information, please review the [online reference documentation for the gem](https://rubydoc.info/gems/ruby-pwsh).

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-pwsh
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Puppet, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-26 00:00:00.000000000 Z
+date: 2019-12-04 00:00:00.000000000 Z
 dependencies: []
 description: PowerShell code manager for ruby.
 email: