command_line_boss 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 373be7eee0c1d18087389f4974b750d91f619a3148532a820b642a96a93d554f
-  data.tar.gz: a77b6ed4529989587eac6b0e46f293a509691366b6741cd776ddde85e605674b
+  metadata.gz: c18c2eeeebeba00361af947c2349049dcdb7d861358189e4b44be3f257a29d02
+  data.tar.gz: a52b032947e2aed16266af4374101236df602f9e2422d2aec2522a2dcee22d6f
 SHA512:
-  metadata.gz: daa1c02db1176dc01fa4aa447a82cf5b0b54e65434d88e28777686bf78b0451c50ccf0c58549618b1590c11b9741d16eca6efb19dc5cde9e54e64525d5229be5
-  data.tar.gz: bd779c0e865f70485e193bbe05c0a6d55095959227f88c958f971f63d2eb3754013570bc9daef2ff249bf62ba919da4d0e66ec14a2436cf32349a147e633fb08
+  metadata.gz: 0e57a7351d88aeac40f243fc3f7c595345562afca8a0a43ac989e8b166bed5113a6f38560a8267ee80941ec3a450395a3e0ebf8f30ab2534e7a7d4053fca1c2f
+  data.tar.gz: 3d4173cc96ce04aec95367795c36e2a3949e6ef2e542bb17f130c18d5912bfdd4ba5666a1a6ff5a77556a1d23077dbabd97546fd0856d69dcf953cfb078bd83f

data/.commitlintrc.yml

@@ -0,0 +1,16 @@
+---
+extends: '@commitlint/config-conventional'
+
+rules:
+  # See: https://commitlint.js.org/reference/rules.html
+  #
+  # Rules are made up by a name and a configuration array. The configuration array contains:
+  #
+  # * Severity [0..2]: 0 disable rule, 1 warning if violated, or 2 error if violated
+  # * Applicability [always|never]: never inverts the rule
+  # * Value: value to use for this rule
+  #
+  # Run `npx commitlint --print-config` to see the current setting for all rules.
+  #
+  body-leading-blank:    [2, 'always']
+  footer-leading-blank:  [2, 'always']

data/.husky/commit-msg

@@ -0,0 +1 @@
+npx --no-install commitlint --edit "$1"

data/.markdownlint.yml

@@ -0,0 +1,25 @@
+default: true
+
+# Unordered list indentation
+MD007: { indent: 2 }
+
+# Line length
+MD013: { line_length: 90, tables: false, code_blocks: false }
+
+# Heading duplication is allowed for non-sibling headings
+MD024: { siblings_only: true }
+
+# Do not allow the specified trailing punctuation in a header
+MD026: { punctuation: '.,;:' }
+
+# Order list items must have a prefix that increases in numerical order
+MD029: { style: 'ordered' }
+
+# Lists do not need to be surrounded by blank lines
+MD032: false
+
+# Allow raw HTML in Markdown
+MD033: false
+
+# Allow emphasis to be used instead of a heading
+MD036: false

data/.rubocop.yml

@@ -1,34 +1,7 @@
-AllCops:
-  NewCops: enable
-  SuggestExtensions: false
-  DefaultFormatter: fuubar
-
-  # Output extra information for each offense to make it easier to diagnose:
-  DisplayCopNames: true
-  DisplayStyleGuide: true
-  ExtraDetails: true
+inherit_gem:
+  main_branch_shared_rubocop_config: config/rubocop.yml
 
-  # RuboCop enforces rules depending on the oldest version of Ruby which
-  # your project supports:
+AllCops:
+  # Pin this project to Ruby 3.1 in case the shared config above is upgraded to 3.2
+  # or later.
   TargetRubyVersion: 3.1
-
-Gemspec/DevelopmentDependencies:
-  Enabled: false
-
-Layout/LineLength:
-  Max: 120
-
-# The DSL for RSpec and the gemspec file make it very hard to limit block length
-Metrics/BlockLength:
-  Exclude:
-    - '**/*_spec.rb'
-    - '*.gemspec'
-
-Metrics/ModuleLength:
-  CountAsOne: ['hash']
-
-Metrics/ClassLength:
-  CountAsOne: ['hash']
-
-Style/AsciiComments:
-  Enabled: false

data/.yardopts

@@ -1 +1,8 @@
---exclude examples/**
+--no-private
+--hide-void-return
+--markup-provider=redcarpet
+--markup markdown
+- CHANGELOG.md
+- CONTRIBUTING.md
+- RELEASING.md
+- LICENSE.txt

data/CHANGELOG.md

@@ -5,6 +5,28 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## v0.2.0 (2024-10-10)
+
+[Full Changelog](https://github.com/main-branch/command_line_boss/compare/v0.1.0..v0.2.0)
+
+Changes since v0.1.0:
+
+* 4a6ace7 build: remove semver pr label check
+* 05918a3 build: enforce conventional commit message formatting
+* e5f91d1 Clarify purpose of the gem in the README
+* ca16af0 Fix TargetRubyVersion Comment
+* 30eef5d Use shared Rubocop config
+* bbe9fe2 Update links in gemspec
+* c167adc Add Slack badge for this project in README
+* c442a80 Update yardopts with new standard options
+* f9be39f Standardize YARD and Markdown Lint configurations
+* bc7b9ae Update CODEOWNERS file
+* 3879f0a Set JRuby —debug option when running tests in GitHub Actions workflows
+* af10f27 Integrate simplecov-rspec into the project
+* 22b1364 Update continuous integration and experimental ruby builds
+* 2e2fa87 Enforce the use of semver tags on PRs
+* 4464e2c Fix CHANGELOG.md
+
 ## v0.1.0 (2024-07-03)
 
 [Full Changelog](https://github.com/main-branch/command_line_boss/compare/6cafbd0..v0.1.0)

data/README.md

@@ -1,4 +1,4 @@
-# CommandLineBoss
+# The `command_line_boss` gem
 
 [![Gem Version](https://badge.fury.io/rb/command_line_boss.svg)](https://badge.fury.io/rb/command_line_boss)
 [![Documentation](https://img.shields.io/badge/Documentation-Latest-green)](https://rubydoc.info/gems/command_line_boss/)
@@ -6,14 +6,21 @@
 [![Build Status](https://github.com/main-branch/command_line_boss/actions/workflows/continuous_integration.yml/badge.svg)](https://github.com/main-branch/command_line_boss/actions/workflows/continuous_integration.yml)
 [![Maintainability](https://api.codeclimate.com/v1/badges/513b4d8d95a5e3a77ec6/maintainability)](https://codeclimate.com/github/main-branch/command_line_boss/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/513b4d8d95a5e3a77ec6/test_coverage)](https://codeclimate.com/github/main-branch/command_line_boss/test_coverage)
+[![Conventional
+Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
+[![Slack](https://img.shields.io/badge/slack-main--branch/command__line__boss-yellow.svg?logo=slack)](https://main-branch.slack.com/archives/C07MQC0LNKF)
 
-CommandLineBoss is built on top of `OptionParser` to make more complex uses of OptionParser easier to manage and test.
+`command_line_boss` makes it easy to build, test, and maintain complex command line
+interfaces. It is built on top of Ruby's `OptionParser` class and works best for
+traditional options-based command-line interfaces that you would build with
+`OptionParser`.
 
-You are expected to already know how to define options with `OptionParser` in order to use this gem.
+To use `command_line_boss` you are expected to already know how to define options
+with `OptionParser`.
 
-This gem should be used for traditional options-based command-line interfaces that you would build with `OptionParser`.
-
-For defining complex command-line interfaces with multiple commands and subcommands (aka a git-like interface), we recommend using a gem like thor. Other good alternatives also exist.
+For defining command-line interfaces with multiple commands and subcommands (aka a
+git-like interface), we recommend using a gem like [thor](http://whatisthor.com).
+Other good alternatives also exist.
 
 * [Installation](#installation)
 * [Usage](#usage)
@@ -22,23 +29,36 @@ For defining complex command-line interfaces with multiple commands and subcomma
   * [Start your command line parser class](#start-your-command-line-parser-class)
   * [Define options](#define-options)
   * [Define additional validations](#define-additional-validations)
-  * [Process with any remaining non-option arguments](#process-with-any-remaining-non-option-arguments)
+  * [Process any remaining non-option arguments](#process-any-remaining-non-option-arguments)
   * [Optional: define help output](#optional-define-help-output)
   * [Use the parser](#use-the-parser)
   * [Run the command line](#run-the-command-line)
 * [Development](#development)
 * [Contributing](#contributing)
+  * [Commit message guidelines](#commit-message-guidelines)
+  * [Pull request guidelines](#pull-request-guidelines)
 * [License](#license)
 * [Code of Conduct](#code-of-conduct)
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
+To install this gem, add to the following line to your application's gemspec OR
+Gemfile:
 
-```shell
-bundle add command_line_boss
+gemspec:
+
+```ruby
+  spec.add_development_dependency "command_line_boss", '~> 0.1'
+```
+
+Gemfile:
+
+```ruby
+gem "command_line_boss", "~> 0.1", groups: [:development, :test]
 ```
 
+and then run `bundle install`.
+
 If bundler is not being used to manage dependencies, install the gem by executing:
 
 ```shell
@@ -75,10 +95,11 @@ Make sure you have the `command_line_boss` gem installed.
 
 ### Design your command line
 
-Design the command line following the
-[Google developer documentation style guide for command line syntax](https://developers.google.com/style/code-syntax).
+Design the command line following the [Google developer documentation style guide for
+command line syntax](https://developers.google.com/style/code-syntax).
 
-Here is what a simple example might look like that creates a spreadsheet with named sheets:
+Here is what a simple example might look like that creates a spreadsheet with named
+sheets:
 
 ```Text
 Usage:
@@ -165,7 +186,7 @@ class CreateSpreadsheetCli < CommandLineBoss
 end
 ```
 
-### Process with any remaining non-option arguments
+### Process any remaining non-option arguments
 
 Implement `parse_arguments` to deal the remaining non-option arguments from the
 command line. Within this method, the `args` method returns the remaining
@@ -323,18 +344,52 @@ $
 
 ## 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.
+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`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/main_branch/command_line_boss. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/main_branch/command_line_boss/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/main_branch/command_line_boss. This project is intended to be a
+safe, welcoming space for collaboration, and contributors are expected to adhere to
+the [code of
+conduct](https://github.com/main_branch/command_line_boss/blob/main/CODE_OF_CONDUCT.md).
+
+### Commit message guidelines
+
+All commit messages must follow the [Conventional Commits
+standard](https://www.conventionalcommits.org/en/v1.0.0/). This helps us maintain a
+clear and structured commit history, automate versioning, and generate changelogs
+effectively.
+
+To ensure compliance, this project includes:
+
+* A git commit-msg hook that validates your commit messages before they are accepted.
+
+  To activate the hook, you must have node installed and run `npm install`.
+
+* A GitHub Actions workflow that will enforce the Conventional Commit standard as
+  part of the continuous integration pipeline.
+
+  Any commit message that does not conform to the Conventional Commits standard will
+  cause the workflow to fail and not allow the PR to be merged.
+
+### Pull request guidelines
+
+All pull requests must be merged using rebase merges. This ensures that commit
+messages from the feature branch are preserved in the release branch, keeping the
+history clean and meaningful.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
-Everyone interacting in the CommandLineBoss project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/command_line_boss/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the CommandLineBoss project's codebases, issue trackers, chat
+rooms and mailing lists is expected to follow the [code of
+conduct](https://github.com/[USERNAME]/command_line_boss/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -44,16 +44,9 @@ CLEAN << 'rspec-report.xml'
 
 require 'rubocop/rake_task'
 
-RuboCop::RakeTask.new do |t|
-  t.options = %w[
-    --format fuubar
-    --format json --out rubocop-report.json
-    --display-cop-names
-    --config .rubocop.yml
-  ]
-end
+RuboCop::RakeTask.new
 
-CLEAN << 'rubocop-report.json'
+# YARD
 
 unless RUBY_PLATFORM == 'java'
   # yard:build

data/examples/create_spreadsheet/Rakefile

@@ -38,13 +38,4 @@ CLOBBER << 'Gemfile.lock'
 
 require 'rubocop/rake_task'
 
-RuboCop::RakeTask.new do |t|
-  t.options = %w[
-    --format fuubar
-    --format json --out rubocop-report.json
-    --display-cop-names
-    --config .rubocop.yml
-  ]
-end
-
-CLEAN << 'rubocop-report.json'
+RuboCop::RakeTask.new

data/lib/command_line_boss/version.rb

@@ -2,5 +2,5 @@
 
 class CommandLineBoss
   # Gem version
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/package.json

@@ -0,0 +1,11 @@
+{
+  "devDependencies": {
+    "@commitlint/cli": "^19.5.0",
+    "@commitlint/config-conventional": "^19.5.0",
+    "husky": "^9.1.0"
+  },
+  "scripts": {
+    "postinstall": "husky",
+    "prepare": "husky"
+  }
+}

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: command_line_boss
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - James Couball
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-03 00:00:00.000000000 Z
+date: 2024-10-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
@@ -30,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: csv
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: main_branch_shared_rubocop_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.64'
+        version: '1.66'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.64'
+        version: '1.66'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: turnip
   requirement: !ruby/object:Gem::Requirement
@@ -208,6 +250,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".commitlintrc.yml"
+- ".husky/commit-msg"
+- ".markdownlint.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".yardopts"
@@ -234,6 +279,7 @@ files:
 - lib/command_line_boss/help_option.rb
 - lib/command_line_boss/logger_options.rb
 - lib/command_line_boss/version.rb
+- package.json
 homepage: https://github.com/main-branch/command_line_boss
 licenses:
 - MIT
@@ -241,8 +287,8 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/main-branch/command_line_boss
   source_code_uri: https://github.com/main-branch/command_line_boss
-  changelog_uri: https://rubydoc.info/gems/command_line_boss/0.1.0/file/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/gems/command_line_boss/0.1.0
+  documentation_uri: https://rubydoc.info/gems/command_line_boss/0.2.0
+  changelog_uri: https://rubydoc.info/gems/command_line_boss/0.2.0/file/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -258,8 +304,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-requirements: []
-rubygems_version: 3.5.11
+requirements:
+- 'Platform: Mac, Linux, or Windows'
+- 'Ruby: MRI 3.1 or later, TruffleRuby 24 or later, or JRuby 9.4 or later'
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Command Line Boss is a convenience layer over OptionsParser