command_kit 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acf8c9763694ffe7ac298e158863a3165c5d8f1a2209d1cac5b01e9c60d9dd85
-  data.tar.gz: 98669568909de27878be028ae8b0251ddc6e8a4740af23037bd234d06778b2ce
+  metadata.gz: 306f055fa898d4d82c14ba8e79b397ae413280bb7144ce69e1787081620827e9
+  data.tar.gz: e79e640f7d4ae566401e7543d3ba98aa42b1e2396657734e29ab3cd3b383b41c
 SHA512:
-  metadata.gz: b04269a04b5d474f2a17724e04fa015fe5c1eefdbba9f53cf06c49c727c369ae3ba9a77e336c09f69fc3e7c8b6e5f77fa98abe7912c022213489d5b04191f5bb
-  data.tar.gz: 01c43327289df1e30970e618b2d133e26bc5e6cdd3d65cc6fad7cbc369e44085fd164cb0b93a241df6508e3019fbfed658f83191e958457ec6f7ecfed86b88b3
+  metadata.gz: ee4268377db8c2398b5157feda9fa106a0b156537c6085b71fcfd8c7710f898c3bc0ef5d4408d9c6cbcae932e4f4ee4dd49070003e6c5734da06da33fbbace9a
+  data.tar.gz: 03b6a48369bea030002f9432d0d8645d8c0f5cdefba81778922e73a54f267611419bdb63e5033e98b09aa1c6ae97af1e8c3b8135cb7ed4b807fce666c6c379b8

data/.github/workflows/ruby.yml

@@ -3,19 +3,20 @@ name: CI
 on: [ push, pull_request ]
 
 jobs:
+  # run tests
   tests:
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
         ruby:
-          # - 2.4
-          # - 2.5
-          # - 2.6
           - 2.7
           - 3.0
+          - 3.1
           # TODO: uncomment when jruby supports ruby >= 2.7
           # - jruby
+          # TODO: uncomment when truffleruby supports splatting empty kwargs
+          # - truffleruby
     name: Ruby ${{ matrix.ruby }}
     steps:
       - uses: actions/checkout@v2
@@ -27,3 +28,17 @@ jobs:
         run: bundle install --jobs 4 --retry 3
       - name: Run tests
         run: bundle exec rake test
+
+  # rubocop linting
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+      - name: Run rubocop
+        run: bundle exec rubocop --parallel

data/.rubocop.yml

@@ -0,0 +1,141 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.7
+
+#
+# our rules
+#
+
+Layout/FirstArrayElementIndentation: { Exclude: ['spec/**/*'] }
+Layout/LineLength: { Enabled: false }
+Layout/SpaceAroundEqualsInParameterDefault: { EnforcedStyle: no_space }
+Lint/ConstantDefinitionInBlock: { Exclude: ['spec/**/*'] }
+Metrics: { Enabled: false }
+Style/SymbolArray: { EnforcedStyle: brackets }
+Style/IfInsideElse: { Enabled: false } # Offense count: 1
+Style/PercentLiteralDelimiters:
+  Enabled: true
+  PreferredDelimiters:
+    default: '{}'
+    '%i': '[]'
+    '%I': '[]'
+    '%w': '[]'
+    '%W': '[]'
+
+#
+# rules that are in flux
+#
+
+# consider enabling these and autocorrecting?
+# Layout/SpaceAfterComma
+# Layout/SpaceAroundKeyword
+# Layout/SpaceBeforeComma
+# Layout/SpaceInsideHashLiteralBraces
+# Layout/SpaceInsideParens
+# Layout/TrailingWhitespace
+# Lint/UnreachableLoop
+# Lint/UnusedBlockArgument
+# Style/ClassCheck
+# Style/Documentation
+# Style/ExpandPathArguments
+# Style/GlobalStdStream
+# Style/HashSyntax
+# Style/KeywordParametersOrder
+# Style/MethodCallWithoutArgsParentheses
+# Style/MutableConstant
+# Style/QuotedSymbols: { EnforcedStyle: double_quotes }
+# Style/RedundantReturn
+# Style/SafeNavigation
+# Style/SpecialGlobalVars
+# Style/StringLiterals: { EnforcedStyle: double_quotes }
+# Style/WordArray
+
+# these have been fixed
+# Gemspec/DuplicatedAssignment: { Enabled: false } # Offense count: 1
+# Layout/ElseAlignment: { Enabled: false } # Offense count: 1
+# Layout/EndAlignment: { Enabled: false } # Offense count: 1
+# Lint/DuplicateMethods: { Enabled: false } # Offense count: 1
+# Lint/UselessAssignment: { Enabled: false } # Offense count: 1
+# Style/Encoding: { Enabled: false } # Offense count: 2
+# Style/RedundantBegin: { Enabled: false } # Offense count: 2
+# Style/RedundantInterpolation: { Enabled: false } # Offense count: 1
+# Style/TrailingCommaInArrayLiteral: { Enabled: false } # Offense count: 1
+
+#
+# This list was generated with:
+# bundle exec rubocop --auto-gen-config --exclude-limit 1
+#
+
+# > 10 violations
+Layout/AssignmentIndentation: { Enabled: false } # Offense count: 11
+Layout/EmptyLinesAroundClassBody: { Enabled: false } # Offense count: 76
+Layout/HashAlignment: { Enabled: false } # Offense count: 28
+Layout/SpaceAfterComma: { Enabled: false } # Offense count: 141
+Layout/SpaceInsideHashLiteralBraces: { Enabled: false } # Offense count: 57
+Layout/TrailingWhitespace: { Enabled: false } # Offense count: 50
+Naming/RescuedExceptionsVariableName: { Enabled: false } # Offense count: 11
+Style/BlockDelimiters: { Enabled: false } # Offense count: 17
+Style/ClassCheck: { Enabled: false } # Offense count: 10
+Style/ClassEqualityComparison: { Enabled: false } # Offense count: 16
+Style/FrozenStringLiteralComment: { Enabled: false } # Offense count: 77
+Style/GlobalStdStream: { Enabled: false } # Offense count: 13
+Style/GuardClause: { Enabled: false } # Offense count: 10
+Style/IfUnlessModifier: { Enabled: false } # Offense count: 13
+Style/MethodCallWithoutArgsParentheses: { Enabled: false } # Offense count: 10
+Style/SpecialGlobalVars: { Enabled: false } # Offense count: 28
+Style/StringLiterals: { Enabled: false } # Offense count: 774
+Lint/ElseLayout: { Enabled: false } # Offense count: 22
+
+# < 10 violations
+Layout/EmptyLinesAroundModuleBody: { Enabled: false } # Offense count: 5
+Layout/ExtraSpacing: { Enabled: false } # Offense count: 6
+Layout/FirstHashElementIndentation: { Enabled: false } # Offense count: 4
+Layout/ParameterAlignment: { Enabled: false } # Offense count: 9
+Layout/SpaceAroundKeyword: { Enabled: false } # Offense count: 7
+Layout/SpaceBeforeComma: { Enabled: false } # Offense count: 4
+Layout/SpaceInsideParens: { Enabled: false } # Offense count: 4
+Lint/EmptyClass: { Enabled: false } # Offense count: 3
+Lint/SuppressedException: { Enabled: false } # Offense count: 4
+Lint/UnusedMethodArgument: { Enabled: false } # Offense count: 5
+Style/AccessorGrouping: { Enabled: false } # Offense count: 7
+Style/Documentation: { Enabled: false } # Offense count: 3
+Style/ExpandPathArguments: { Enabled: false } # Offense count: 8
+Style/HashSyntax: { Exclude: ['Rakefile'] } # Offense count: 3
+Style/KeywordParametersOrder: { Enabled: false } # Offense count: 8
+Style/Lambda: { Enabled: false } # Offense count: 3
+Style/MutableConstant: { Enabled: false } # Offense count: 4
+Style/RaiseArgs: { Enabled: false } # Offense count: 4
+Style/RedundantReturn: { Enabled: false } # Offense count: 7
+Style/SafeNavigation: { Enabled: false } # Offense count: 5
+Style/StringConcatenation: { Enabled: false } # Offense count: 8
+Style/WordArray: { Enabled: false } # Offense count: 4
+
+# 1 or 2 violations
+Layout/ArgumentAlignment: { Enabled: false } # Offense count: 1
+Layout/BlockAlignment: { Enabled: false } # Offense count: 1
+Layout/IndentationWidth: { Enabled: false } # Offense count: 2
+Layout/SpaceAroundOperators: { Enabled: false } # Offense count: 1
+Layout/SpaceBeforeBlockBraces: { Enabled: false } # Offense count: 1
+Lint/MissingSuper: { Enabled: false } # Offense count: 2
+Lint/RescueException: { Enabled: false } # Offense count: 1
+Lint/UnreachableLoop: { Enabled: false } # Offense count: 1
+Lint/UnusedBlockArgument: { Enabled: false } # Offense count: 1
+Naming/MethodParameterName: { Enabled: false } # Offense count: 1
+Style/EmptyMethod: { Enabled: false } # Offense count: 2
+Style/HashConversion: { Enabled: false } # Offense count: 1
+Style/MultilineMemoization: { Enabled: false } # Offense count: 1
+Style/NumericPredicate: { Enabled: false } # Offense count: 1
+Style/OptionalArguments: { Enabled: false } # Offense count: 1
+Style/ParenthesesAroundCondition: { Enabled: false } # Offense count: 1
+Style/PreferredHashMethods: { Enabled: false } # Offense count: 1
+Style/QuotedSymbols: { Enabled: false } # Offense count: 1
+Style/RedundantException: { Enabled: false } # Offense count: 1
+Style/RedundantRegexpEscape: { Enabled: false } # Offense count: 1
+Style/RegexpLiteral: { Enabled: false } # Offense count: 1
+Style/RescueStandardError: { Enabled: false } # Offense count: 1
+Style/SoleNestedConditional: { Enabled: false } # Offense count: 1
+Style/TrailingCommaInHashLiteral: { Enabled: false } # Offense count: 2
+
+# rubocop cannot tell that rubygems_mfa_required is enabled in gemspec.yml
+Gemspec/RequireMFA: { Enabled: false }

data/ChangeLog.md

@@ -1,3 +1,167 @@
+### 0.3.0 / 2021-12-26
+
+* Added {CommandKit::FileUtils}.
+
+#### CommandKit::FileUtils
+
+* Added {CommandKit::FileUtils#erb #erb}.
+
+#### CommandKit::Colors
+
+* Added {CommandKit::Colors::ANSI::RESET_FG RESET_FG}.
+* Added {CommandKit::Colors::ANSI.bright_black bright_black}.
+* Added {CommandKit::Colors::ANSI.gray gray}.
+* Added {CommandKit::Colors::ANSI.bright_red bright_red}.
+* Added {CommandKit::Colors::ANSI.bright_green bright_green}.
+* Added {CommandKit::Colors::ANSI.bright_yellow bright_yellow}.
+* Added {CommandKit::Colors::ANSI.bright_blue bright_blue}.
+* Added {CommandKit::Colors::ANSI.bright_magenta bright_magenta}.
+* Added {CommandKit::Colors::ANSI.bright_cyan bright_cyan}.
+* Added {CommandKit::Colors::ANSI.bright_white bright_white}.
+* Added {CommandKit::Colors::ANSI.on_bright_black on_bright_black}.
+* Added {CommandKit::Colors::ANSI.on_gray on_gray}.
+* Added {CommandKit::Colors::ANSI.on_bright_red on_bright_red}.
+* Added {CommandKit::Colors::ANSI.on_bright_green on_bright_green}.
+* Added {CommandKit::Colors::ANSI.on_bright_yellow on_bright_yellow}.
+* Added {CommandKit::Colors::ANSI.on_bright_blue on_bright_blue}.
+* Added {CommandKit::Colors::ANSI.on_bright_magenta on_bright_magenta}.
+* Added {CommandKit::Colors::ANSI.on_bright_cyan on_bright_cyan}.
+* Added {CommandKit::Colors::ANSI.on_bright_white on_bright_white}.
+
+#### ComandKit::Options
+
+* Allow grouping options into categories:
+
+      option :opt1, category: 'Foo Options',
+                    desc: 'Option 1'
+
+      option :opt2, category: 'Foo Options',
+                    desc: 'Option 1'
+
+* Allow options to have multi-line descriptions:
+
+      option :opt1, short: '-o',
+                    desc: [
+                            'line1',
+                            'line2',
+                            '...'
+                          ]
+
+#### CommandKit::Arguments
+
+* Allow arguments to have multi-line descriptions:
+
+      argument :arg1, desc: [
+                              'line1',
+                              'line2',
+                              '...'
+                            ]
+
+
+#### CommandKit::ProgramName
+
+* Added {CommandKit::ProgramName#command_name}.
+
+### 0.2.2 / 2021-12-26
+
+#### CommandKit::Help::Man
+
+* Raise a `NotImplementedError` exception in {CommandKit::Help::Man#help_man
+  #help_man} if {CommandKit::Help::Man::ClassMethods#man_dir .man_dir} was not
+  set.
+
+### 0.2.1 / 2021-11-16
+
+* Ensure that all error messages end with a period.
+* Documentation fixes.
+* Opt-in to [rubygem.org MFA requirement](https://guides.rubygems.org/mfa-requirement-opt-in/).
+
+#### CommandKit::Printing
+
+* Auto-detect whether {CommandKit::CommandName#command_name #command_name} is
+  available, and if so, prepend the command name to all error messages.
+
+#### CommandKit::Help::Man
+
+* Expand the path given to
+  {CommandKit::Help::Man::ClassMethods#man_dir man_dir}.
+* If {CommandKit::Help::Man::ClassMethods#man_dir man_dir} is not set, fallback
+  to regular `--help` output.
+
+#### CommandKit::Arguments
+
+* Include {CommandKit::Usage} and {CommandKit::Printing} into
+  {CommandKit::Arguments}.
+
+#### CommandKit::Options
+
+* Include {CommandKit::Arguments} into {CommandKit::Options}.
+* Ensure that {CommandKit::Options::Parser#main} runs before
+  {CommandKit::Arguments#main}.
+* Ensure that {CommandKit::Options#help} also calls
+  {CommandKit::Arguments#help_arguments}.
+* Always prepopulate {CommandKit::Options#options #options} with option's
+  default values.
+  * Note: if an option has a default value but the option's value is not
+    required (ex: `value: {required: false, default: "foo"}`), and the option's
+    flag is given but no value is given (ex: `--option-flag --some-other-flag`),
+    the option's value in {CommandKit::Options#options #options} will be `nil`
+    _not_ the option's default value (`"foo"`). This helps indicate that the
+    option's flag was given but no value was given with it.
+
+#### CommandKit::Options::OptionValue
+
+* When a `Class` is passed to {CommandKit::Options::OptionValue.default_usage},
+  demodularize the class name before converting it to underscored/uppercase.
+
+#### CommandKit::Command
+
+* Fixed the inclusion order of {CommandKit::Options} and
+  {CommandKit::Arguments}.
+
+#### CommandKit::Commands
+
+* Define the `COMMAND` and `ARGS` arguments.
+* Correctly duplicate the {CommandKit::Env#env env} (which can be either `ENV`
+  or a `Hash`) to work on ruby-3.1.0-preview1.
+* Print command aliases that were set explicitly
+  (ex: `command_aliases['rm'] = 'remove'`) in {CommandKit::Commands#help}.
+* Print help and exit with status `1` if no command is given. This matches the
+  behavior of the `git` command.
+
+#### CommandKit::Commands::AutoLoad
+
+* Ensure that any explicit command aliases are added to the command's
+  {CommandKit::Commands::ClassMethods#command_aliases command_aliases}.
+
+### 0.2.0 / 2021-08-31
+
+* Added {CommandKit::Colors::ANSI#on_black}.
+* Added {CommandKit::Colors::ANSI#on_red}.
+* Added {CommandKit::Colors::ANSI#on_green}.
+* Added {CommandKit::Colors::ANSI#on_yellow}.
+* Added {CommandKit::Colors::ANSI#on_blue}.
+* Added {CommandKit::Colors::ANSI#on_magenta}.
+* Added {CommandKit::Colors::ANSI#on_cyan}.
+* Added {CommandKit::Colors::ANSI#on_white}.
+* Added {CommandKit::Man}.
+* Added {CommandKit::OS#bsd?}.
+* Added {CommandKit::OS#freebsd?}.
+* Added {CommandKit::OS#netbsd?}.
+* Added {CommandKit::OS#openbsd?}.
+* Added {CommandKit::OS#os}.
+* Added {CommandKit::OS#unix?}.
+* Added {CommandKit::OS::Linux}.
+* Added {CommandKit::OpenApp}.
+* Added {CommandKit::PackageManager}.
+* Added {CommandKit::Pager#pipe_to_pager}.
+* Added {CommandKit::Sudo}.
+* Added {CommandKit::Terminal#tty?}.
+* Refactor {CommandKit::Inflector.camelize} and
+  {CommandKit::Inflector.underscore} to use StringScanner.
+* Allow {CommandKit::OS#initialize} to accept an `os:` keyword to override the
+  detected OS.
+
 ### 0.1.0 / 2021-07-16
 
 * Initial release:
@@ -21,6 +185,7 @@
   * {CommandKit::Options}
     * {CommandKit::Options::Quiet}
     * {CommandKit::Options::Verbose}
+  * {CommandKit::OS}
   * {CommandKit::Pager}
   * {CommandKit::Printing}
     * {CommandKit::Printing::Indent}

data/Gemfile

@@ -6,9 +6,12 @@ group :development do
   gem 'rake'
   gem 'rubygems-tasks', '~> 0.2'
 
+  gem 'rubocop', '~> 1.18'
+
   gem 'rspec', '~> 3.0'
   gem 'simplecov', '~> 0.20', require: false
 
   gem 'kramdown'
   gem 'yard', '~> 0.9'
+  gem 'yard-spellcheck', require: false
 end