clamp 1.2.1 → 1.3.0

data/lib/clamp/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Clamp
-  VERSION = "1.2.1".freeze
+  VERSION = "1.3.0".freeze
 end

data/spec/clamp/command_group_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe Clamp::Command do
@@ -122,8 +124,7 @@ describe Clamp::Command do
 
         subcommand "bar", "Baaaa!" do
 
-          def self.this_is_bar
-          end
+          def self.this_is_bar; end
 
           def execute
             puts "FUBAR"
@@ -274,12 +275,12 @@ describe Clamp::Command do
 
       speed_options = Module.new do
         extend Clamp::Option::Declaration
-        option "--speed", "SPEED", "how fast", :default => "slowly"
+        option "--speed", "SPEED", "how fast", default: "slowly"
       end
 
       Class.new(Clamp::Command) do
 
-        option "--direction", "DIR", "which way", :default => "home"
+        option "--direction", "DIR", "which way", default: "home"
 
         include speed_options
 
@@ -315,7 +316,7 @@ describe Clamp::Command do
     end
 
     it "has access to command context" do
-      command = command_class.new("go", :motion => "wandering")
+      command = command_class.new("go", motion: "wandering")
       command.run(["move"])
       expect(stdout).to match(/wandering home/)
     end
@@ -331,8 +332,7 @@ describe Clamp::Command do
       end
 
       subcommand "woohoohoo", "like weeheehee but with more o" do
-        def execute
-        end
+        def execute; end
       end
     end
 
@@ -370,8 +370,7 @@ describe Clamp::Command do
           end
         end
 
-        def execute
-        end
+        def execute; end
       end
     end
 
@@ -396,6 +395,25 @@ describe Clamp::Command do
       command.run(["foo"])
       expect(stdout).to match(/known subcommand/)
     end
+
+  end
+
+  context "with a subcommand and required options" do
+
+    given_command "movements" do
+      option "--direction", "N|S|E|W", "bearing", required: true
+      subcommand "hop", "Hop" do
+        def execute
+          puts "Hopping #{direction}"
+        end
+      end
+    end
+
+    it "allows options after the subcommand" do
+      command.run(%w[hop --direction south])
+      expect(stdout).to eql "Hopping south\n"
+    end
+
   end
 
 end

data/spec/clamp/command_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 require "spec_helper"
 
@@ -60,7 +61,7 @@ describe Clamp::Command do
     context "with explicit :attribute_name" do
 
       before do
-        command.class.option "--foo", "FOO", "A foo", :attribute_name => :bar
+        command.class.option "--foo", "FOO", "A foo", attribute_name: :bar
       end
 
       it "uses the specified attribute_name name to name accessors" do
@@ -95,7 +96,7 @@ describe Clamp::Command do
     context "with :default value" do
 
       before do
-        command.class.option "--port", "PORT", "port to listen on", :default => 4321
+        command.class.option "--port", "PORT", "port to listen on", default: 4321
       end
 
       it "declares default method" do
@@ -112,10 +113,22 @@ describe Clamp::Command do
 
     end
 
+    context "without :default value" do
+
+      before do
+        command.class.option "--port", "PORT", "port to listen on"
+      end
+
+      it "does not declare default method" do
+        expect(command).to_not respond_to(:default_port)
+      end
+
+    end
+
     context "with :multivalued" do
 
       before do
-        command.class.option "--flavour", "FLAVOUR", "flavour(s)", :multivalued => true, :attribute_name => :flavours
+        command.class.option "--flavour", "FLAVOUR", "flavour(s)", multivalued: true, attribute_name: :flavours
       end
 
       it "defaults to empty array" do
@@ -123,20 +136,20 @@ describe Clamp::Command do
       end
 
       it "supports multiple values" do
-        command.parse(%w(--flavour chocolate --flavour vanilla))
-        expect(command.flavours).to eql %w(chocolate vanilla)
+        command.parse(%w[--flavour chocolate --flavour vanilla])
+        expect(command.flavours).to eql %w[chocolate vanilla]
       end
 
       it "generates a single-value appender method" do
         command.append_to_flavours("mud")
         command.append_to_flavours("pie")
-        expect(command.flavours).to eql %w(mud pie)
+        expect(command.flavours).to eql %w[mud pie]
       end
 
       it "generates a multi-value setter method" do
         command.append_to_flavours("replaceme")
-        command.flavours = %w(mud pie)
-        expect(command.flavours).to eql %w(mud pie)
+        command.flavours = %w[mud pie]
+        expect(command.flavours).to eql %w[mud pie]
       end
 
       it "does not require a value" do
@@ -154,8 +167,8 @@ describe Clamp::Command do
 
       before do
         command.class.option "--port", "PORT", "port to listen on",
-                             :default => 4321,
-                             :environment_variable => "PORT",
+                             default: 4321,
+                             environment_variable: "PORT",
                              &:to_i
         set_env("PORT", environment_value)
         command.parse(args)
@@ -179,7 +192,7 @@ describe Clamp::Command do
 
         context "and a value is specified on the command-line" do
 
-          let(:args) { %w(--port 1500) }
+          let(:args) { %w[--port 1500] }
 
           it "uses command-line value" do
             expect(command.port).to eql 1500
@@ -204,7 +217,7 @@ describe Clamp::Command do
       let(:environment_value) { nil }
 
       before do
-        command.class.option "--[no-]enable", :flag, "enable?", :default => false, :environment_variable => "ENABLE"
+        command.class.option "--[no-]enable", :flag, "enable?", default: false, environment_variable: "ENABLE"
         set_env("ENABLE", environment_value)
         command.parse([])
       end
@@ -217,7 +230,7 @@ describe Clamp::Command do
 
       end
 
-      %w(1 yes enable on true).each do |truthy_value|
+      %w[1 yes enable on true].each do |truthy_value|
 
         context "when environment variable is #{truthy_value.inspect}" do
 
@@ -231,7 +244,7 @@ describe Clamp::Command do
 
       end
 
-      %w(0 no disable off false).each do |falsey_value|
+      %w[0 no disable off false].each do |falsey_value|
 
         context "when environment variable is #{falsey_value.inspect}" do
 
@@ -250,7 +263,15 @@ describe Clamp::Command do
     context "with :required" do
 
       before do
-        command.class.option "--port", "PORT", "port to listen on", :required => true
+        command.class.option "--port", "PORT", "port to listen on", required: true
+      end
+
+      describe "#help" do
+
+        it "marks it as required" do
+          expect(command.help).to include("port to listen on (required)")
+        end
+
       end
 
       context "when no value is provided" do
@@ -278,7 +299,7 @@ describe Clamp::Command do
     context "with :required and :multivalued" do
 
       before do
-        command.class.option "--port", "PORT", "port to listen on", :required => true, :multivalued => true
+        command.class.option "--port", "PORT", "port to listen on", required: true, multivalued: true
       end
 
       context "when no value is provided" do
@@ -329,12 +350,12 @@ describe Clamp::Command do
       command.class.option ["-f", "--flavour"], "FLAVOUR", "Flavour of the month"
       command.class.option ["-c", "--color"], "COLOR", "Preferred hue"
       command.class.option ["--scoops"], "N", "Number of scoops",
-                           :default => 1,
-                           :environment_variable => "DEFAULT_SCOOPS" do |arg|
+                           default: 1,
+                           environment_variable: "DEFAULT_SCOOPS" do |arg|
         Integer(arg)
       end
       command.class.option ["-n", "--[no-]nuts"], :flag, "Nuts (or not)\nMay include nuts"
-      command.class.parameter "[ARG] ...", "extra arguments", :attribute_name => :arguments
+      command.class.parameter "[ARG] ...", "extra arguments", attribute_name: :arguments
     end
 
     describe "#parse" do
@@ -343,7 +364,7 @@ describe Clamp::Command do
 
         it "raises a UsageError" do
           expect do
-            command.parse(%w(--foo bar))
+            command.parse(%w[--foo bar])
           end.to raise_error(Clamp::UsageError)
         end
 
@@ -352,7 +373,7 @@ describe Clamp::Command do
       context "with options" do
 
         before do
-          command.parse(%w(--flavour strawberry --nuts --color blue))
+          command.parse(%w[--flavour strawberry --nuts --color blue])
         end
 
         it "maps the option values onto the command object" do
@@ -366,7 +387,7 @@ describe Clamp::Command do
       context "with short options" do
 
         before do
-          command.parse(%w(-f strawberry -c blue))
+          command.parse(%w[-f strawberry -c blue])
         end
 
         it "recognises short options as aliases" do
@@ -379,7 +400,7 @@ describe Clamp::Command do
       context "with a value appended to a short option" do
 
         before do
-          command.parse(%w(-fstrawberry))
+          command.parse(%w[-fstrawberry])
         end
 
         it "works as though the value were separated" do
@@ -391,7 +412,7 @@ describe Clamp::Command do
       context "with combined short options" do
 
         before do
-          command.parse(%w(-nf strawberry))
+          command.parse(%w[-nf strawberry])
         end
 
         it "works as though the options were separate" do
@@ -404,7 +425,7 @@ describe Clamp::Command do
       context "with option arguments attached using equals sign" do
 
         before do
-          command.parse(%w(--flavour=strawberry --color=blue))
+          command.parse(%w[--flavour=strawberry --color=blue])
         end
 
         it "works as though the option arguments were separate" do
@@ -417,8 +438,8 @@ describe Clamp::Command do
       context "with option-like things beyond the arguments" do
 
         it "treats them as positional arguments" do
-          command.parse(%w(a b c --flavour strawberry))
-          expect(command.arguments).to eql %w(a b c --flavour strawberry)
+          command.parse(%w[a b c --flavour strawberry])
+          expect(command.arguments).to eql %w[a b c --flavour strawberry]
         end
 
       end
@@ -440,8 +461,8 @@ describe Clamp::Command do
       context "with an option terminator" do
 
         it "considers everything after the terminator to be an argument" do
-          command.parse(%w(--color blue -- --flavour strawberry))
-          expect(command.arguments).to eql %w(--flavour strawberry)
+          command.parse(%w[--color blue -- --flavour strawberry])
+          expect(command.arguments).to eql %w[--flavour strawberry]
         end
 
       end
@@ -449,7 +470,7 @@ describe Clamp::Command do
       context "with --flag" do
 
         before do
-          command.parse(%w(--nuts))
+          command.parse(%w[--nuts])
         end
 
         it "sets the flag" do
@@ -462,7 +483,7 @@ describe Clamp::Command do
 
         before do
           command.nuts = true
-          command.parse(%w(--no-nuts))
+          command.parse(%w[--no-nuts])
         end
 
         it "clears the flag" do
@@ -475,7 +496,7 @@ describe Clamp::Command do
 
         it "requests help" do
           expect do
-            command.parse(%w(--help))
+            command.parse(%w[--help])
           end.to raise_error(Clamp::HelpWanted)
         end
 
@@ -485,7 +506,7 @@ describe Clamp::Command do
 
         it "requests help" do
           expect do
-            command.parse(%w(-h))
+            command.parse(%w[-h])
           end.to raise_error(Clamp::HelpWanted)
         end
 
@@ -495,7 +516,7 @@ describe Clamp::Command do
 
         it "signals a UsageError" do
           expect do
-            command.parse(%w(--scoops reginald))
+            command.parse(%w[--scoops reginald])
           end.to raise_error(Clamp::UsageError, /^option '--scoops': invalid value for Integer/)
         end
 
@@ -541,14 +562,14 @@ describe Clamp::Command do
 
     it "does not generate implicit help option" do
       expect do
-        command.parse(%w(--help))
+        command.parse(%w[--help])
       end.to_not raise_error
       expect(command.help?).to be true
     end
 
     it "does not recognise -h" do
       expect do
-        command.parse(%w(-h))
+        command.parse(%w[-h])
       end.to raise_error(Clamp::UsageError)
     end
 
@@ -568,7 +589,7 @@ describe Clamp::Command do
 
     it "still recognises --help" do
       expect do
-        command.parse(%w(--help))
+        command.parse(%w[--help])
       end.to raise_error(Clamp::HelpWanted)
     end
 
@@ -586,7 +607,7 @@ describe Clamp::Command do
     context "with explicit :attribute_name" do
 
       before do
-        command.class.parameter "FOO", "a foo", :attribute_name => :bar
+        command.class.parameter "FOO", "a foo", attribute_name: :bar
       end
 
       it "uses the specified attribute_name name to name accessors" do
@@ -599,7 +620,7 @@ describe Clamp::Command do
     context "with :default value" do
 
       before do
-        command.class.parameter "[ORIENTATION]", "direction", :default => "west"
+        command.class.parameter "[ORIENTATION]", "direction", default: "west"
       end
 
       it "sets the specified default value" do
@@ -641,8 +662,8 @@ describe Clamp::Command do
       end
 
       it "accepts multiple arguments" do
-        command.parse(%w(X Y Z))
-        expect(command.file_list).to eql %w(X Y Z)
+        command.parse(%w[X Y Z])
+        expect(command.file_list).to eql %w[X Y Z]
       end
 
     end
@@ -670,8 +691,8 @@ describe Clamp::Command do
     context "with :environment_variable" do
 
       before do
-        command.class.parameter "[FILE]", "a file", :environment_variable => "FILE",
-                                                    :default => "/dev/null"
+        command.class.parameter "[FILE]", "a file", environment_variable: "FILE",
+                                                    default: "/dev/null"
       end
 
       let(:args) { [] }
@@ -749,7 +770,7 @@ describe Clamp::Command do
     before do
       command.class.parameter "X", "x\nxx"
       command.class.parameter "Y", "y"
-      command.class.parameter "[Z]", "z", :default => "ZZZ"
+      command.class.parameter "[Z]", "z", default: "ZZZ"
     end
 
     describe "#parse" do
@@ -832,6 +853,20 @@ describe Clamp::Command do
 
   end
 
+  describe ".execute" do
+
+    it "provides an alternative way to declare execute method" do
+      command_class.class_eval do
+        execute do
+          puts "using execute DSL"
+        end
+      end
+      command.run([])
+      expect(stdout).to eq("using execute DSL\n")
+    end
+
+  end
+
   context "with explicit usage" do
 
     given_command("blah") do
@@ -874,12 +909,12 @@ describe Clamp::Command do
 
     given_command("punt") do
 
-      banner <<-EOF
+      banner <<-TEXT
         Punt is an example command.  It doesn't do much, really.
 
         The prefix at the beginning of this description should be normalised
         to two spaces.
-      EOF
+      TEXT
 
     end
 
@@ -903,7 +938,7 @@ describe Clamp::Command do
           print word_list.inspect
         end
       end
-      @xyz = %w(x y z)
+      @xyz = %w[x y z]
       command.class.run("cmd", @xyz)
       expect(stdout).to eql @xyz.inspect
     end
@@ -916,7 +951,7 @@ describe Clamp::Command do
             print context[:foo]
           end
         end
-        command.class.run("xyz", [], :foo => "bar")
+        command.class.run("xyz", [], foo: "bar")
         expect(stdout).to eql "bar"
       end
 
@@ -928,7 +963,7 @@ describe Clamp::Command do
 
         command.class.class_eval do
           def execute
-            signal_error "Oh crap!", :status => 456
+            signal_error "Oh crap!", status: 456
           end
         end