command_kit 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a218265a42b8b11c95888d07a3dcc3817d534adf830f8e7b1f1790bae73f05d6
-  data.tar.gz: c11cf5b2179d0701d5164b5ffcc07f2040cf8c813ea68caafdd7602e8603b754
+  metadata.gz: d04119403fa9585e0258d2b20bb7c307d124aafb70c88e03749395c7b4eedb97
+  data.tar.gz: 3ec992adf12bbc98313bb6ff8f3038091b50b31abbf8950765a71edd771378fb
 SHA512:
-  metadata.gz: 7bd20d0e6b33b1d84933ea246c51b552c8652e3f59c8ec3fe32bf1944148377799b20b8177f0025114689ff5f73a88d08fe14171bdbd48189ab4123ba9129113
-  data.tar.gz: 617efce051bc51bbb88ada26a83ded0e158b8e0af28ab2bad8af1478aac05a156833aa3bfd95b59e7b07daf1075c08e60f7f6165cc28b76908cb13eb694c4f4b
+  metadata.gz: faeeaa08921ab315a825d4b1ff69f6b254c53b6675dd4278478b77200d6d2afb688d110757685ed33d74b90a6b1e9394c12135c3ab5f08e2ca3ca5834ead248d
+  data.tar.gz: 6b4ba3da0434c9fbd93d92a4c9d91e8eb53f1185df15edb21283c09b2ddf9ec4dc9fcb3708bdf83a1158cef92c988ccb5133ec5664ac9dcb213bdcde45aacf3d

data/.github/workflows/ruby.yml

@@ -10,13 +10,12 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-          # - 2.4
-          # - 2.5
-          # - 2.6
           - 2.7
           - 3.0
           # 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

data/ChangeLog.md

@@ -1,3 +1,11 @@
+### 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.

data/lib/command_kit/arguments.rb

@@ -124,8 +124,8 @@ module CommandKit
       #     argument :bar, desc: "Bar argument"
       #
       # @example With a custom usage string:
-      #     option :bar, usage: 'BAR',
-      #                  desc: "Bar argument"
+      #     argument :bar, usage: 'BAR',
+      #                    desc: "Bar argument"
       #
       # @example With a custom type:
       #     argument :bar, desc: "Bar argument"

data/lib/command_kit/help/man.rb

@@ -110,11 +110,15 @@ module CommandKit
       #   Returns `nil` when the `man` command is not installed.
       #
       # @raise [NotImplementedError]
-      #   {ClassMethods#man_dir .man_dir} does not have a value.
+      #   {ClassMethods#man_dir .man_dir} was not set in the class.
       #
       # @api semipublic
       #
       def help_man(man_page=self.class.man_page)
+        unless self.class.man_dir
+          raise(NotImplementedError,"man_dir was not set in #{self.class}")
+        end
+
         man_path = File.join(self.class.man_dir,man_page)
 
         man(man_path)
@@ -124,9 +128,6 @@ module CommandKit
       # Displays the {ClassMethods#man_page .man_page} in
       # {ClassMethods#man_dir .man_dir} instead of the usual `--help` output.
       #
-      # @raise [NotImplementedError]
-      #   {ClassMethods#man_dir .man_dir} does not have a value.
-      #
       # @note
       #   if `TERM` is `dumb` or `$stdout` is not a TTY, will fall back to
       #   printing the usual `--help` output.

data/lib/command_kit/version.rb

@@ -1,4 +1,4 @@
 module CommandKit
   # command_kit version
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/spec/arguments_spec.rb

@@ -203,7 +203,7 @@ describe CommandKit::Arguments do
       end
     end
 
-    context "when #arguments returns an Array" do
+    context "when #arguments returns a Hash" do
       module TestArguments
         class MultipleArguments
           include CommandKit::Arguments

data/spec/commands_spec.rb

@@ -19,7 +19,6 @@ describe CommandKit::Commands do
       class Test2 < CommandKit::Command
       end
 
-      p method(:command).source_location
       command Test1
       command Test2
 
@@ -147,7 +146,6 @@ describe CommandKit::Commands do
                         desc: 'Argument 2'
       end
 
-      p method(:command).source_location
       command Test1
       command Test2
 

data/spec/help/man_spec.rb

@@ -271,6 +271,16 @@ describe CommandKit::Help::Man do
         subject.help_man(man_page)
       end
     end
+
+    context "but the man_dir is not set" do
+      let(:command_class) { TestHelpMan::TestCommandWithManDirNotSet }
+
+      it "must call the super help() mehtod" do
+        expect {
+          subject.help_man
+        }.to raise_error(NotImplementedError,"man_dir was not set in #{command_class}")
+      end
+    end
   end
 
   describe "#help" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: command_kit
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-17 00:00:00.000000000 Z
+date: 2021-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler