command_line_boss 0.1.0

checksums.yaml

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

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--color
+--format Fuubar

data/.rubocop.yml

@@ -0,0 +1,34 @@
+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
+
+  # RuboCop enforces rules depending on the oldest version of Ruby which
+  # your project supports:
+  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

@@ -0,0 +1 @@
+--exclude examples/**

data/CHANGELOG.md

@@ -0,0 +1,34 @@
+# Change Log
+
+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.1.0 (2024-07-03)
+
+[Full Changelog](https://github.com/main-branch/command_line_boss/compare/6cafbd0..v0.1.0)
+
+Changes:
+
+* 8051772 Remove JRuby build
+* 6c60ac0 Integrate turnip for testing
+* 07a983d Update CodeClimate test reporter id
+* d605a91 Remove the JRuby windows build
+* da7b1d3 Use minimum supported Ruby (3.1) on Windows
+* bcbddef Define the CI build with Github Actions
+* 0c9be2b Add create_github_release to the project
+* ef55727 Define default rake task
+* 541f2f8 Integrate YARD
+* aa171ea Autocorrect all rubocop offenses
+* c151f47 Integrate Rubocop
+* ba8054e Integrate RSpec
+* 421ea2d Add gem build to Rakefile, exclude /Gemfile.lock, fix rubocop typo
+* d9a9cd6 Integrate Bundler Audit
+* b38761f Start with an empty Rakefile
+* 3972ad8 Define homepage, source, changelog, and doc links
+* 4c1fdf8 Allow the CommandLineBoss gem to be pushed to rubygems
+* 81ea3e2 Require Ruby 3.1.0 or later
+* 4b5fc63 Set gemspec summary and description
+* f5ed145 Move dev dependencies to the gemspec
+* 6cafbd0 Generated version

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# 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 jcouball@yahoo.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.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 James Couball
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,340 @@
+# CommandLineBoss
+
+[![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/)
+[![Change Log](https://img.shields.io/badge/CHANGELOG-Latest-green)](https://rubydoc.info/gems/command_line_boss/file/CHANGELOG.md)
+[![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)
+
+CommandLineBoss is built on top of `OptionParser` to make more complex uses of OptionParser easier to manage and test.
+
+You are expected to already know how to define options with `OptionParser` in order to use this gem.
+
+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.
+
+* [Installation](#installation)
+* [Usage](#usage)
+  * [Getting started](#getting-started)
+  * [Design your command line](#design-your-command-line)
+  * [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)
+  * [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)
+* [License](#license)
+* [Code of Conduct](#code-of-conduct)
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```shell
+bundle add command_line_boss
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```shell
+gem install command_line_boss
+```
+
+## Usage
+
+More detailed examples are given in the `examples` directory.
+
+* `examples/readme_example` - a super-simple example of using this gem. The
+  remainder of this section is a walkthrough of this example was constructed.
+* `examples/create_spreadsheet` - a more complicated example complete with
+  tests.
+
+This section provides a step-by-step guide to building a super simple command line
+using this gem. A parser this simple would probably be easier to implement with
+`OptionParser` directly without this gem. This example is meant to show how you
+can get started.
+
+This gem really starts to shine as your command-line interface grows beyond
+something this simple.
+
+### Getting started
+
+The end result of this guide can be found in this project in the file
+`examples/readme_example/create-spreadsheet`.
+
+Find a suitable directory to create your code in. For this example, all the code
+will live in ONE script file that you create and set its executable permission bit
+via `chmod`.
+
+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).
+
+Here is what a simple example might look like that creates a spreadsheet with named sheets:
+
+```Text
+Usage:
+create_spreadsheet SPREADSHEET_NAME --sheet=SHEET_NAME [--sheet=SHEET_NAME ...]
+```
+
+### Start your command line parser class
+
+The first step will be to create your own command line parsing class. This class
+must inherit from `CommandLineBoss`.
+
+Add the attributess representing the items you want to capture from the command
+line. Set default values for these attributes in a method called `set_defaults`.
+
+```Ruby
+#!/usr/bin/env ruby
+
+require 'command_line_boss'
+
+class CreateSpreadsheetCli < CommandLineBoss
+  attr_reader :spreadsheet_name, :sheet_names
+
+  private
+
+  def set_defaults
+      @spreadsheet_name = nil
+      @sheet_names = []
+  end
+end
+```
+
+### Define options
+
+Define private methods whose names follow the pattern `define_*_option`. Methods
+MUST be private or they won't be called.
+
+Report any errors by calling `add_error_message` with the text of the error
+message.
+
+The return value of these methods is ignored.
+
+Continuing the example, add the following code to the `CreateSpreadsheetCli` class:
+
+```Ruby
+class CreateSpreadsheetCli < CommandLineBoss
+  # ...
+
+  private
+
+  def define_sheet_option
+    parser.on('--sheet=SHEET_NAME', 'Name of a sheet to create') do |name|
+      add_error_message('Sheet names must be unique!') if sheet_names.include?(name)
+      sheet_names << name
+    end
+  end
+end
+```
+
+### Define additional validations
+
+Define private methods whose names follow the pattern `validate_*`. Methods MUST
+be private or they won't be called.
+
+Report any errors by calling `add_error_message` with the text of the error
+message.
+
+The return value of these methods is ignored.
+
+Continuing the example, add the following code to the `CreateSpreadsheetCli` class:
+
+```Ruby
+class CreateSpreadsheetCli < CommandLineBoss
+  # ...
+
+  private
+
+  def validate_spreadsheet_name_given
+    add_error_message('A spreadsheet name is required') if spreadsheet_name.nil?
+  end
+
+  def validate_at_least_one_sheet_name_given
+    add_error_message('At least one sheet name is required') if sheet_names.empty?
+  end
+end
+```
+
+### Process with 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
+non-option arguments.
+
+For example, in the command line `create-spreadsheet "Yearly Sales" --sheet Summary`,
+`args` would return an array `['Yearly Sales']`.
+
+Remove any values from `args` that will be used. By default, if `args` is not
+empty after `parse_arguments` returns, an error will result.
+
+Report any errors by calling `add_error_message` with the text of the error
+message.
+
+The return value of this method is ignored.
+
+Continuing the example, add the following code to the `CreateSpreadsheetCli` class:
+
+```Ruby
+class CreateSpreadsheetCli < CommandLineBoss
+  # ...
+
+  private
+
+  def parse_arguments
+    @spreadsheet_name = args.shift
+  end
+end
+```
+
+### Optional: define help output
+
+Include the `CommandLineBoss::HelpOption` module add a help option (`-h` and
+`--help`) and structure the help output.
+
+Help output is divided into sections that is output as follows:
+
+```text
+BANNER
+HEADER
+OPTIONS
+FOOTER
+```
+
+The OPTIONS section is generated by `OptionsParser`.
+
+You may provide the content for the other sections by implementing any or all of the
+methods: `banner`, `header`, and `footer`. These methods are expected to return a
+string with the content.
+
+If you do not provide content for the `banner` section, it is generated by
+`OptionsParser`. The default banner looks something like this:
+
+```text
+Usage: create-spreadsheet [options]
+```
+
+If you do not provide content for the `header` or `footer` sections, they are
+omitted from the help output.
+
+Continuing the example, add the following code to the `CreateSpreadsheetCli` class:
+
+```Ruby
+class CreateSpreadsheetCli < CommandLineBoss
+  include CommandLineBoss::HelpOption
+
+  # ...
+
+  private
+
+  include CommandLineBoss::HelpOption
+
+  def banner = <<~BANNER
+    Create a spreadsheet
+
+    Usage:
+      create_spreadsheet SPREADSHEET_NAME --sheet=SHEET_NAME [--sheet=SHEET_NAME ...]
+
+  BANNER
+end
+```
+
+The `CreateSpreadsheetCli` class is complete!
+
+### Use the parser
+
+Now that the command line parser is fully defined, you just need to use it,
+report errors, and (if successful) do something with the parsed values.
+
+Place the following code at the end of your script file, after the
+`CreateSpreadsheetCli` class:
+
+```Ruby
+# Parse the command line arguments
+
+options = CreateSpreadsheetCli.new.parse(ARGV)
+
+# Report errors
+
+if options.failed?
+  warn options.error_messages.join("\n")
+  exit 1
+end
+
+# Do something with the result
+# In this case just output the command line values
+
+require 'pp'
+
+puts \
+  "Creating spreadsheet #{options.spreadsheet_name.pretty_inspect.chomp} " \
+  "with sheets #{options.sheet_names.map(&:pretty_inspect).map(&:chomp).join(', ')}"
+```
+
+### Run the command line
+
+Should you have a problem running your script, you can compare your script against
+the expected result which can be found in this project in the file
+`examples/readme_example/create-spreadsheet`.
+
+Test your script by running it from the command line. Here are some examples:
+
+Show help output:
+
+```shell
+$ ./create-spreadsheet --help
+Create a spreadsheetasdf
+
+Usage:
+  create_spreadsheet SPREADSHEET_NAME --sheet=SHEET_NAME [--sheet=SHEET_NAME ...]
+
+Options:
+        --sheet=SHEET_NAME           Name of a sheet to create
+    -h, --help                       Show this message
+
+$
+```
+
+A happy-path example:
+
+```shell
+$ ./create-spreadsheet 'Yearly Sales' --sheet=Summary --sheet=Details
+Creating spreadsheet "Yearly Sales" with sheets "Summary", "Details"
+$
+```
+
+An example with errors:
+
+```shell
+$ ./create-spreadsheet
+ERROR: A spreadsheet name is required
+ERROR: At least one sheet name is required
+$
+```
+
+## 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`.
+
+## 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).
+
+## License
+
+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).

data/Rakefile

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+desc 'Run the same tasks that the CI build will run'
+if RUBY_PLATFORM == 'java'
+  task default: %w[spec rubocop bundle:audit build]
+else
+  task default: %w[spec rubocop yard bundle:audit build]
+end
+
+# Bundler Audit
+
+require 'bundler/audit/task'
+Bundler::Audit::Task.new
+
+# Bundler Gem Build
+
+require 'bundler'
+require 'bundler/gem_tasks'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+CLEAN << 'pkg'
+CLOBBER << 'Gemfile.lock'
+
+# RSpec
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*{_spec.rb,.feature}'
+end
+
+CLEAN << 'coverage'
+CLEAN << '.rspec_status'
+CLEAN << 'rspec-report.xml'
+
+# Rubocop
+
+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'
+
+unless RUBY_PLATFORM == 'java'
+  # yard:build
+
+  require 'yard'
+
+  YARD::Rake::YardocTask.new('yard:build') do |t|
+    t.files = %w[lib/**/*.rb examples/**/*]
+    t.stats_options = ['--list-undoc']
+  end
+
+  CLEAN << '.yardoc'
+  CLEAN << 'doc'
+
+  # yard:audit
+
+  desc 'Run yardstick to show missing YARD doc elements'
+  task :'yard:audit' do
+    sh "yardstick 'lib/**/*.rb'"
+  end
+
+  # yard:coverage
+
+  require 'yardstick/rake/verify'
+
+  Yardstick::Rake::Verify.new(:'yard:coverage') do |verify|
+    verify.threshold = 100
+  end
+
+  # yard
+
+  desc 'Run all YARD tasks'
+  task yard: %i[yard:build yard:audit yard:coverage]
+end

data/examples/create_spreadsheet/.gitignore

@@ -0,0 +1,21 @@
+Gemfile.lock/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/sig/
+
+# rspec failure tracking
+.rspec_status
+
+/Gemfile.lock
+
+/rspec-report.xml
+/.rspec_status
+
+/rubocop-report.json
+
+/.yarddoc

data/examples/create_spreadsheet/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--color
+--format Fuubar

data/examples/create_spreadsheet/.rubocop.yml

@@ -0,0 +1,34 @@
+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
+
+  # RuboCop enforces rules depending on the oldest version of Ruby which
+  # your project supports:
+  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