clamp 1.0.1 → 1.1.0

data/lib/clamp/subcommand/definition.rb

@@ -1,7 +1,7 @@
 module Clamp
   module Subcommand
 
-    class Definition < Struct.new(:name, :description, :subcommand_class)
+    Definition = Struct.new(:name, :description, :subcommand_class) do
 
       def initialize(names, description, subcommand_class)
         @names = Array(names)

data/lib/clamp/subcommand/execution.rb

@@ -15,18 +15,18 @@ module Clamp
 
       def instantiate_subcommand(name)
         subcommand_class = find_subcommand_class(name)
-        parent_attribute_values = {}
+        subcommand = subcommand_class.new("#{invocation_path} #{name}", context)
         self.class.inheritable_attributes.each do |attribute|
-          if attribute.of(self).defined?
-            parent_attribute_values[attribute] = attribute.of(self).get
-          end
+          next unless attribute.of(self).defined?
+          attribute.of(subcommand).set(attribute.of(self).get)
         end
-        subcommand_class.new("#{invocation_path} #{name}", context, parent_attribute_values)
+        subcommand
       end
 
       def find_subcommand_class(name)
-        subcommand_def = self.class.find_subcommand(name) || signal_usage_error(Clamp.message(:no_such_subcommand, :name => name))
-        subcommand_def.subcommand_class
+        subcommand_def = self.class.find_subcommand(name)
+        return subcommand_def.subcommand_class if subcommand_def
+        subcommand_missing(name)
       end
 
     end

data/lib/clamp/subcommand/parsing.rb

@@ -1,4 +1,4 @@
-require 'clamp/subcommand/execution'
+require "clamp/subcommand/execution"
 
 module Clamp
   module Subcommand
@@ -9,7 +9,7 @@ module Clamp
 
       def parse_subcommand
         return false unless self.class.has_subcommands?
-        self.extend(Subcommand::Execution)
+        extend(Subcommand::Execution)
       end
 
       private

data/lib/clamp/truthy.rb

@@ -1,6 +1,6 @@
 module Clamp
 
-  TRUTHY_VALUES = %w(1 yes enable on true)
+  TRUTHY_VALUES = %w(1 yes enable on true).freeze
 
   def self.truthy?(arg)
     TRUTHY_VALUES.include?(arg.to_s.downcase)

data/lib/clamp/version.rb

@@ -1,3 +1,3 @@
 module Clamp
-  VERSION = "1.0.1".freeze
+  VERSION = "1.1.0".freeze
 end

data/spec/clamp/command_group_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe Clamp::Command do
 
@@ -30,10 +30,10 @@ describe Clamp::Command do
     it "delegates to sub-commands" do
 
       command.run(["flip"])
-      expect(stdout).to match /FLIPPED/
+      expect(stdout).to match(/FLIPPED/)
 
       command.run(["flop"])
-      expect(stdout).to match /FLOPPED/
+      expect(stdout).to match(/FLOPPED/)
 
     end
 
@@ -55,13 +55,13 @@ describe Clamp::Command do
 
       it "lists subcommands" do
         help = command.help
-        expect(help).to match /Subcommands:/
-        expect(help).to match /flip +flip it/
-        expect(help).to match /flop +flop it/
+        expect(help).to match(/Subcommands:/)
+        expect(help).to match(/flip +flip it/)
+        expect(help).to match(/flop +flop it/)
       end
 
       it "handles new lines in subcommand descriptions" do
-        expect(command.help).to match /flop +flop it\n +for extra flop/
+        expect(command.help).to match(/flop +flop it\n +for extra flop/)
       end
 
     end
@@ -96,10 +96,10 @@ describe Clamp::Command do
     it "responds to both aliases" do
 
       command.run(["say", "boo"])
-      expect(stdout).to match /boo/
+      expect(stdout).to match(/boo/)
 
       command.run(["talk", "jive"])
-      expect(stdout).to match /jive/
+      expect(stdout).to match(/jive/)
 
     end
 
@@ -107,7 +107,7 @@ describe Clamp::Command do
 
       it "lists all aliases" do
         help = command.help
-        expect(help).to match /say, talk .* Say something/
+        expect(help).to match(/say, talk .* Say something/)
       end
 
     end
@@ -137,7 +137,7 @@ describe Clamp::Command do
 
     it "delegates multiple levels" do
       command.run(["foo", "bar"])
-      expect(stdout).to match /FUBAR/
+      expect(stdout).to match(/FUBAR/)
     end
 
     describe ".find_subcommand_class" do
@@ -170,7 +170,7 @@ describe Clamp::Command do
 
       it "invokes the default subcommand" do
         command.run([])
-        expect(stdout).to match /All good/
+        expect(stdout).to match(/All good/)
       end
 
     end
@@ -195,7 +195,7 @@ describe Clamp::Command do
 
       it "invokes the default subcommand" do
         command.run([])
-        expect(stdout).to match /All good/
+        expect(stdout).to match(/All good/)
       end
 
     end
@@ -238,13 +238,24 @@ describe Clamp::Command do
         end
       end
 
+      subcommand "say", "say it" do
+        subcommand "loud", "yell it" do
+          def execute
+            puts thing.upcase
+          end
+        end
+      end
+
     end
 
     it "allows the parameter to be specified first" do
-
       command.run(["dummy", "spit"])
       expect(stdout.strip).to eql "spat the dummy"
+    end
 
+    it "passes the parameter down the stack" do
+      command.run(["money", "say", "loud"])
+      expect(stdout.strip).to eql "MONEY"
     end
 
   end
@@ -282,46 +293,101 @@ describe Clamp::Command do
 
     it "accepts options defined in superclass (specified after the subcommand)" do
       command.run(["move", "--direction", "north"])
-      expect(stdout).to match /walking north/
+      expect(stdout).to match(/walking north/)
     end
 
     it "accepts options defined in superclass (specified before the subcommand)" do
       command.run(["--direction", "north", "move"])
-      expect(stdout).to match /walking north/
+      expect(stdout).to match(/walking north/)
     end
 
     it "accepts options defined in included modules" do
       command.run(["move", "--speed", "very quickly"])
-      expect(stdout).to match /walking home very quickly/
+      expect(stdout).to match(/walking home very quickly/)
     end
 
     it "has access to command context" do
       command = command_class.new("go", :motion => "wandering")
       command.run(["move"])
-      expect(stdout).to match /wandering home/
+      expect(stdout).to match(/wandering home/)
     end
 
   end
 
   context "with a subcommand, with options" do
 
-    given_command 'weeheehee' do
-      option '--json', 'JSON', 'a json blob' do |option|
+    given_command "weeheehee" do
+      option "--json", "JSON", "a json blob" do |option|
         print "parsing!"
         option
       end
 
-      subcommand 'woohoohoo', 'like weeheehee but with more o' do
+      subcommand "woohoohoo", "like weeheehee but with more o" do
         def execute
         end
       end
     end
 
     it "only parses options once" do
-      command.run(['--json', '{"a":"b"}', 'woohoohoo'])
-      expect(stdout).to eql 'parsing!'
+      command.run(["--json", '{"a":"b"}', "woohoohoo"])
+      expect(stdout).to eql "parsing!"
+    end
+
+  end
+
+  context "with an unknown subcommand" do
+
+    let(:subcommand_missing) do
+      Module.new do
+        def subcommand_missing(_name)
+          abort "there is no such thing"
+        end
+      end
+    end
+
+    let(:subcommand_missing_with_return) do
+      Module.new do
+        def subcommand_missing(_name)
+          self.class.recognised_subcommands.first.subcommand_class
+        end
+      end
     end
 
+    let(:command_class) do
+
+      Class.new(Clamp::Command) do
+        subcommand "test", "test subcommand" do
+          def execute
+            puts "known subcommand"
+          end
+        end
+
+        def execute
+        end
+      end
+    end
+
+    let(:command) do
+      command_class.new("foo")
+    end
+
+    it "should signal no such subcommand usage error" do
+      expect { command.run(["foo"]) }.to raise_error(Clamp::UsageError) do |exception|
+        expect(exception.message).to eq "No such sub-command 'foo'"
+      end
+    end
+
+    it "should execute the subcommand missing method" do
+      command.extend subcommand_missing
+      expect { command.run(["foo"]) }.to raise_error(SystemExit)
+      expect(stderr).to match(/there is no such thing/)
+    end
+
+    it "should use the subcommand class returned from subcommand_missing" do
+      command.extend subcommand_missing_with_return
+      command.run(["foo"])
+      expect(stdout).to match(/known subcommand/)
+    end
   end
 
 end

data/spec/clamp/command_spec.rb

@@ -1,5 +1,5 @@
 
-require 'spec_helper'
+require "spec_helper"
 
 describe Clamp::Command do
 
@@ -18,7 +18,7 @@ describe Clamp::Command do
   describe "#help" do
 
     it "describes usage" do
-      expect(command.help).to match /^Usage:\n    cmd.*\n/
+      expect(command.help).to match(/^Usage:\n    cmd.*\n/)
     end
 
   end
@@ -147,9 +147,10 @@ describe Clamp::Command do
       let(:args) { [] }
 
       before do
-        command.class.option "--port", "PORT", "port to listen on", :default => 4321, :environment_variable => "PORT" do |value|
-          value.to_i
-        end
+        command.class.option "--port", "PORT", "port to listen on",
+                             :default => 4321,
+                             :environment_variable => "PORT",
+                             &:to_i
         set_env("PORT", environment_value)
         command.parse(args)
       end
@@ -167,7 +168,7 @@ describe Clamp::Command do
         let(:environment_value) { "12345" }
 
         it "uses the environment variable" do
-          expect(command.port).to eql 12345
+          expect(command.port).to eql 12_345
         end
 
         context "and a value is specified on the command-line" do
@@ -294,8 +295,8 @@ 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"
@@ -486,12 +487,12 @@ describe Clamp::Command do
       end
 
       it "includes option details" do
-        expect(command.help).to match %r(--flavour FLAVOUR +Flavour of the month)
-        expect(command.help).to match %r(--color COLOR +Preferred hue)
+        expect(command.help).to match(/--flavour FLAVOUR +Flavour of the month/)
+        expect(command.help).to match(/--color COLOR +Preferred hue/)
       end
 
       it "handles new lines in option descriptions" do
-        expect(command.help).to match %r(--\[no-\]nuts +Nuts \(or not\)\n +May include nuts)
+        expect(command.help).to match(/--\[no-\]nuts +Nuts \(or not\)\n +May include nuts/)
       end
 
     end
@@ -528,7 +529,7 @@ describe Clamp::Command do
     end
 
     it "does not map -h to help" do
-      expect(command.help).to_not match %r( -h[, ].*help)
+      expect(command.help).to_not match(/-h[, ].*help/)
     end
 
     it "still recognises --help" do
@@ -636,13 +637,12 @@ describe Clamp::Command do
 
       before do
         command.class.parameter "[FILE]", "a file", :environment_variable => "FILE",
-          :default => "/dev/null"
+                                                    :default => "/dev/null"
       end
 
       let(:args) { [] }
       let(:environment_value) { nil }
 
-
       before do
         set_env("FILE", environment_value)
         command.parse(args)
@@ -785,18 +785,17 @@ describe Clamp::Command do
       end
 
       it "includes parameter details" do
-        expect(command.help).to match %r(X +x)
-        expect(command.help).to match %r(Y +y)
-        expect(command.help).to match %r(\[Z\] +z \(default: "ZZZ"\))
+        expect(command.help).to match(/X +x/)
+        expect(command.help).to match(/Y +y/)
+        expect(command.help).to match(/\[Z\] +z \(default: "ZZZ"\)/)
       end
 
       it "handles new lines in option descriptions" do
-        expect(command.help).to match %r(X +x\n +xx)
+        expect(command.help).to match(/X +x\n +xx/)
       end
 
     end
 
-
   end
 
   context "with explicit usage" do
@@ -853,8 +852,8 @@ describe Clamp::Command do
     describe "#help" do
 
       it "includes the banner" do
-        expect(command.help).to match /^  Punt is an example command/
-        expect(command.help).to match /^  The prefix/
+        expect(command.help).to match(/^  Punt is an example command/)
+        expect(command.help).to match(/^  The prefix/)
       end
 
     end

data/spec/clamp/messages_spec.rb

@@ -1,5 +1,5 @@
 
-require 'spec_helper'
+require "spec_helper"
 
 describe Clamp::Messages do
 

data/spec/clamp/option/definition_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe Clamp::Option::Definition do
 
@@ -195,8 +195,8 @@ describe Clamp::Option::Definition do
       end
 
       it "can be overridden" do
-        option = described_class.new("-H", "HEADER", "extra header", :multivalued => true, :default => [1,2,3])
-        expect(option.default_value).to eql [1,2,3]
+        option = described_class.new("-H", "HEADER", "extra header", :multivalued => true, :default => [1, 2, 3])
+        expect(option.default_value).to eql [1, 2, 3]
       end
 
     end
@@ -234,7 +234,7 @@ describe Clamp::Option::Definition do
     describe "Command#help" do
 
       it "includes help for each option exactly once" do
-        subcommand = command_class.send(:find_subcommand, 'foo')
+        subcommand = command_class.send(:find_subcommand, "foo")
         subcommand_help = subcommand.subcommand_class.help("")
         expect(subcommand_help.lines.grep(/--bar BAR/).count).to eql 1
       end
@@ -247,7 +247,7 @@ describe Clamp::Option::Definition do
     it "rejects :default" do
       expect do
         described_class.new("--key-file", "FILE", "SSH identity",
-                          :required => true, :default => "hello")
+                            :required => true, :default => "hello")
       end.to raise_error(ArgumentError)
     end