ruby-pwsh 0.1.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45a4e8fcc1b0bf5eba64fc3798038898f082e1f2306523e197de6c801f61c872
-  data.tar.gz: 31817197b1a07056dd1f4e6d9296eec1ceb4a39380244a9d00aa937a4ac76aa6
+  metadata.gz: 83a03013a6f1fd8f72b90d29d76f211cf1fbba6f32a8e5275bc7b9ce29d7a52a
+  data.tar.gz: 8ce907ddb3d833eec4a193ce994e05a990ccc2f20e46518674896efa14bd6328
 SHA512:
-  metadata.gz: 5fd66bd52888d7a52bc262d2f977f6100b723531ee283aff31aec7e95ab9b0605e3fce7dcb94e34d13de4b01d0236a56b49ca60e55148e7df4a7dfee63cd8f2d
-  data.tar.gz: 98668a759b733ddc17651011709c1070ae0b407afb84f4de356ec2b181d8353db0d5b57f1cdc64cf67039c994fb6811c679140a3177ba9e489ba72a3874032d0
+  metadata.gz: 71abf1b0cc94d5f742ae6240d08fff15f86e588157a4a482501f2383ac11e5f3644fb43702af5071720193303fa803debeed362bb20f2efec205b0137acb115e
+  data.tar.gz: b9c9ce3518e6cbc27c6b0f8126519a1c1ea53158424f72162b75e23ecd28415e80cf5df4e9dc762aadd93a99e30e16a5a91dc405cd9d8571a53184bbe04e4373

data/.gitignore

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

data/.pmtignore

@@ -0,0 +1,21 @@
+.bundle
+.yardoc
+doc
+.git
+spec
+.gitattributes
+.gitignore
+.rspec
+.rspec_status
+.rubocop.yml
+.travis.yml
+CODEOWNERS
+CONTRIBUTING.md
+design-comms.png
+DESIGN.md
+pwshlib.md
+Gemfile
+Gemfile.lock
+Rakefile
+ruby-pwsh.gemspec
+*.gem

data/.rubocop.yml

@@ -1,3 +1,5 @@
+Gemspec/RequiredRubyVersion:
+  Enabled: false
 Layout/EndOfLine:
   Description: Don't enforce CRLF on Windows.
   Enabled: false
@@ -19,7 +21,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:
@@ -28,4 +30,12 @@ Naming/FileName:
 Style/RescueStandardError:
   Enabled: false
 Style/ExpandPathArguments:
-  Enabled: false
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Exclude:
+    - lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb
+Style/ClassVars:
+  Exclude:
+    - lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb

data/.travis.yml

@@ -19,6 +19,7 @@ script:
   - 'bundle exec rake $CHECK'
 rvm:
   - 2.5.1
+  - 2.7
 matrix:
   include:
   - env: CHECK="rubocop"

data/CHANGELOG.md

@@ -0,0 +1,52 @@
+# Change log
+
+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.5.0](https://github.com/puppetlabs/ruby-pwsh/tree/0.5.0) (2020-08-20)
+
+[Full Changelog](https://github.com/puppetlabs/ruby-pwsh/compare/0.4.1...0.5.0)
+
+### Added
+
+- \(IAC-1045\) Add the DSC base Puppet provider to pwshlib [\#39](https://github.com/puppetlabs/ruby-pwsh/pull/39) ([michaeltlombardi](https://github.com/michaeltlombardi))
+
+## [0.4.1](https://github.com/puppetlabs/ruby-pwsh/tree/0.4.1) (2020-02-13)
+
+[Full Changelog](https://github.com/puppetlabs/ruby-pwsh/compare/0.4.0...0.4.1)
+
+### Fixed
+
+- Ensure ruby versions older than 2.3 function correctly [\#30](https://github.com/puppetlabs/ruby-pwsh/pull/30) ([binford2k](https://github.com/binford2k))
+
+## [0.4.0](https://github.com/puppetlabs/ruby-pwsh/tree/0.4.0) (2020-01-14)
+
+[Full Changelog](https://github.com/puppetlabs/ruby-pwsh/compare/0.3.0...0.4.0)
+
+### Added
+
+- \(MODULES-10389\) Add puppet feature for dependent modules to leverage [\#20](https://github.com/puppetlabs/ruby-pwsh/pull/20) ([sanfrancrisko](https://github.com/sanfrancrisko))
+
+## [0.3.0](https://github.com/puppetlabs/ruby-pwsh/tree/0.3.0) (2019-12-04)
+
+[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)
+
+### Added
+
+- \(FEAT\) Add quality of life utilities [\#11](https://github.com/puppetlabs/ruby-pwsh/pull/11) ([michaeltlombardi](https://github.com/michaeltlombardi))
+- \(FM-8422\) Make library releasable as a Puppet module [\#8](https://github.com/puppetlabs/ruby-pwsh/pull/8) ([michaeltlombardi](https://github.com/michaeltlombardi))
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/CONTRIBUTING.md

@@ -0,0 +1,155 @@
+# Contributing to ruby-pwsh
+
+So you want to contribute to the ruby-pwsh gem: Great! Below are some instructions to get you started doing
+that very thing while setting expectations around code quality as well as a few tips for making the
+process as easy as possible.
+
+## Table of Contents
+
+1. [Getting Started](#getting-started)
+1. [Commit Checklist](#commit-checklist)
+1. [Submission](#submission)
+1. [More about commits](#more-about-commits)
+1. [Testing](#testing)
+    - [Running Tests](#running-tests)
+    - [Writing Tests](#writing-tests)
+1. [Get Help](#get-help)
+
+## Getting Started
+
+- Fork the module repository on GitHub and clone to your workspace
+- Make your changes!
+
+## Commit Checklist
+
+### The Basics
+
+- [x] my commit is a single logical unit of work
+- [x] I have checked for unnecessary whitespace with "git diff --check"
+- [x] my commit does not include commented out code or unneeded files
+
+### The Content
+
+- [x] my commit includes tests for the bug I fixed or feature I added
+- [x] my commit includes appropriate documentation changes if it is introducing a new feature or changing existing functionality
+- [x] my code passes existing test suites
+
+### The Commit Message
+
+- [x] the first line of my commit message includes:
+  - [x] an issue number (if applicable), e.g. "(GH-xxxx) This is the first line"
+  - [x] a short description (50 characters is the soft limit, excluding issue number(s))
+- [x] the body of my commit message:
+  - [x] is meaningful
+  - [x] uses the imperative, present tense: "change", not "changed" or "changes"
+  - [x] includes motivation for the change, and contrasts its implementation with the previous behavior
+
+## Submission
+
+### Pre-requisites
+
+- Make sure you have a [GitHub account](https://github.com/join)
+- [Create an issue](https://github.com/puppetlabs/ruby-pwsh/issues/new/choose), or [watch the issue](https://github.com/puppetlabs/ruby-pwsh/issues) you are patching for.
+
+### Push and PR
+
+- Push your changes to your fork
+- [Open a Pull Request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) against the repository in the puppetlabs organization
+
+## More about commits
+
+1.  Make separate commits for logically separate changes.
+
+    Please break your commits down into logically consistent units which include new or changed tests relevant to the rest of the change.
+    The goal of doing this is to make the diff easier to read for whoever is reviewing your code.
+    In general, the easier your diff is to read, the more likely someone will be happy to review it and get it into the code base.
+
+    If you are going to refactor a piece of code, please do so as a separate commit from your feature or bug fix changes.
+
+    We also really appreciate changes that include tests to make sure the bug is not re-introduced, and that the feature is not accidentally broken.
+
+    Describe the technical detail of the change(s).
+    If your description starts to get too long, that is a good sign that you probably need to split up your commit into more finely grained pieces.
+
+    Commits which plainly describe the things which help reviewers check the patch and future developers understand the code are much more likely to be merged in with a minimum of bike-shedding or requested changes.
+    Ideally, the commit message would include information, and be in a form suitable for inclusion in the release notes for the version of Puppet that includes them.
+
+    Please also check that you are not introducing any trailing whitespace or other "whitespace errors".
+    You can do this by running `git diff --check` on your changes before you commit.
+
+2.  Sending your patches
+
+    To submit your changes via a GitHub pull request, we _highly_ recommend that you have them on a topic branch, instead of directly on "master".
+    It makes things much easier to keep track of, especially if you decide to work on another thing before your first change is merged in.
+
+    GitHub has some pretty good [general documentation](http://help.github.com/) on using their site.
+    They also have documentation on [creating pull requests](https://help.github.com/articles/creating-a-pull-request-from-a-fork/).
+
+    In general, after pushing your topic branch up to your repository on GitHub, you can switch to the branch in the GitHub UI and click "Pull Request" towards the top of the page in order to open a pull request.
+
+3.  Update the related GitHub issue.
+
+    If there is a GitHub issue associated with the change you submitted, then you should update the issue to include the location of your branch, along with any other commentary you may wish to make.
+
+# Testing
+
+## Getting Started
+
+Our Puppet modules provide [`Gemfile`](./Gemfile)s, which can tell a Ruby package manager such as [bundler](http://bundler.io/) what Ruby packages,
+or Gems, are required to build, develop, and test this software.
+
+Please make sure you have [bundler installed](http://bundler.io/#getting-started) on your system, and then use it to
+install all dependencies needed for this project in the project root by running
+
+```shell
+# Unless you're doing a release, you don't need the puppet gem group
+% bundle install --path .bundle/gems --without puppet
+Fetching gem metadata from https://rubygems.org/........
+Fetching gem metadata from https://rubygems.org/..
+Using rake (10.1.0)
+Using builder (3.2.2)
+-- 8><-- many more --><8 --
+Your bundle is complete!
+Use `bundle show [gemname]` to see where a bundled gem is installed.
+```
+
+NOTE: some systems may require you to run this command with sudo.
+
+If you already have those gems installed, make sure they are up-to-date:
+
+```shell
+% bundle update
+```
+
+## Running Tests
+
+With all dependencies in place and up-to-date, run the tests:
+
+### Unit Tests
+
+```shell
+% bundle exec rake spec
+```
+
+This executes all the [rspec tests](https://rspec.info/) in the `spec` directory.
+
+## If you have commit access to the repository
+
+Even if you have commit access to the repository, you still need to go through the process above, and have someone else review and merge
+in your changes.
+The rule is that **all changes must be reviewed by a project developer that did not write the code to ensure that all changes go through a code review process.**
+
+The record of someone performing the merge is the record that they performed the code review.
+Again, this should be someone other than the author of the topic branch.
+
+## Get Help
+
+### On the web
+
+- [General GitHub documentation](http://help.github.com/)
+- [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
+
+### On chat
+
+- Slack (slack.puppet.com) #forge-modules, #puppet-dev, #windows, #voxpupuli
+- IRC (freenode) #puppet-dev, #voxpupuli

data/Gemfile

@@ -11,27 +11,26 @@ 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
 
 group :development do
-  # TODO: Use gem instead of git. Section mapping is merged into master, but not yet released
-  gem 'github_changelog_generator', git: 'https://github.com/skywinder/github-changelog-generator.git', ref: '20ee04ba1234e9e83eb2ffb5056e23d641c7a018'
+  gem 'github_changelog_generator', '~> 1.15' if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.3.0')
   gem 'yard'
 end
 
+group :puppet do
+  gem 'pdk', '~> 1.0'
+  gem 'puppet'
+end
+
 group :pry do
   gem 'fuubar'
 
-  if RUBY_VERSION == '1.8.7'
-    gem 'debugger'
-  elsif RUBY_VERSION =~ /^2\.[01]/
-    gem 'byebug', '~> 9.0.0'
+  if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.4.0')
     gem 'pry-byebug'
-  elsif RUBY_VERSION =~ /^2\.[23456789]/
-    gem 'pry-byebug' # rubocop:disable Bundler/DuplicatedGem
   else
     gem 'pry-debugger'
   end

data/README.md

@@ -60,10 +60,60 @@ 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.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). -->
 
+## Releasing the Gem and Puppet Module
+
+Steps to release an update to the gem and module include:
+
+1. Ensure that the release branch is up to date with the master:
+   ```bash
+   git push upstream upstream/master:release --force
+   ```
+1. Checkout a new working branch for the release prep (where xyz is the appropriate version, sans periods):
+   ```bash
+   git checkout -b maint/release/prep-xyz upstream/release
+   ```
+1. Update the version in `lib/pwsh/version.rb` and `metadata.json` to the appropriate version for the new release.
+1. Run the changelog update task (make sure to verify the changelog, correctly tagging PRs as needed):
+   ```bash
+   bundle exec rake changelog
+   ```
+1. Commit your changes with a short, sensible commit message, like:
+   ```text
+   git add lib/pwsh/version.rb
+   git add metadata.json
+   git add CHANGELOG.md
+   git commit -m '(MAINT) Prep for x.y.z release'
+   ```
+1. Push your changes and submit a pull request for review _against the **release** branch_:
+   ```bash
+   git push -u origin maint/release-prep-xyz
+   ```
+1. Ensure tests pass and the code is merged to `release`.
+1. Grab the commit hash from the merge commit on release, use that as the tag for the version (replacing `x.y.z` with the appropriate version and  `commithash` with the relevant one), then push the tags to upstream:
+   ```bash
+   bundle exec rake tag['x.y.z', 'commithash']
+   ```
+1. Build the Ruby gem and publish:
+   ```bash
+   bundle exec rake build
+   bundle exec rake push['ruby-pwsh-x.y.z.gem']
+   ```
+1. Verify that the correct version now exists on [RubyGems](https://rubygems.org/search?query=ruby-pwsh)
+1. Build the Puppet module:
+   ```bash
+   bundle exec rake build_module
+   ```
+1. Publish the updated module version (found in the `pkg` folder) to [the Forge](https://forge.puppet.com/puppetlabs/pwshlib).
+1. Submit the [mergeback PR from the release branch to master](https://github.com/puppetlabs/ruby-pwsh/compare/master...release).
+
 ## Known Issues

data/Rakefile

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 require 'rubocop/rake_task'
+require 'fileutils'
 require 'github_changelog_generator/task'
+require 'open3'
 require 'pwsh/version'
 require 'rspec/core/rake_task'
 require 'yard'
@@ -10,8 +12,8 @@ GitHubChangelogGenerator::RakeTask.new :changelog do |config|
   config.user = 'puppetlabs'
   config.project = 'ruby-pwsh'
   config.future_release = Pwsh::VERSION
-  config.since_tag = '0.0.1'
-  config.exclude_labels = ['maintenance']
+  config.since_tag = '0.1.0'
+  config.exclude_labels = ['maint']
   config.header = "# Change log\n\nAll 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).'
   config.add_pr_wo_labels = true
@@ -42,3 +44,57 @@ task default: :spec
 
 YARD::Rake::YardocTask.new do |t|
 end
+
+# Executes a command locally.
+#
+# @param command [String] command to execute.
+# @return [Object] the standard out stream.
+def run_local_command(command)
+  stdout, stderr, status = Open3.capture3(command)
+  error_message = "Attempted to run\ncommand:'#{command}'\nstdout:#{stdout}\nstderr:#{stderr}"
+  raise error_message unless status.to_i.zero?
+
+  stdout
+end
+
+# Build the gem
+desc 'Build the gem'
+task :build do
+  gemspec_path = File.join(Dir.pwd, 'ruby-pwsh.gemspec')
+  run_local_command("bundle exec gem build '#{gemspec_path}'")
+end
+
+# Tag the repo with a version in preparation for the release
+#
+# @param :version [String] a semantic version to tag the code with
+# @param :sha [String] the sha at which to apply the version tag
+desc 'Tag the repo with a version in preparation for release'
+task :tag, [:version, :sha] do |_task, args|
+  raise "Invalid version #{args[:version]} - must be like '1.2.3'" unless args[:version] =~ /^\d+\.\d+\.\d+$/
+
+  run_local_command('git fetch upstream')
+  run_local_command("git tag -a #{args[:version]} -m #{args[:version]} #{args[:sha]}")
+  run_local_command('git push upstream --tags')
+end
+
+# Push the built gem to RubyGems
+#
+# @param :path [String] optional, the full or relative path to the built gem to be pushed
+desc 'Push to RubyGems'
+task :push, [:path] do |_task, args|
+  raise 'No discoverable gem for pushing' if Dir.glob("ruby-pwsh*\.gem").empty? && args[:path].nil?
+  raise "No file found at specified path: '#{args[:path]}'" unless File.exist?(args[:path])
+
+  path = args[:path] || File.join(Dir.pwd, Dir.glob("ruby-pwsh*\.gem")[0])
+  run_local_command("bundle exec gem push #{path}")
+end
+
+desc 'Build for Puppet'
+task :build_module do
+  actual_readme_content = File.read('README.md')
+  FileUtils.copy_file('pwshlib.md', 'README.md')
+  # Build
+  run_local_command('pdk build --force')
+  # Cleanup
+  File.open('README.md', 'wb') { |file| file.write(actual_readme_content) }
+end