clamp 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: efb289661d6e7a03227fbd5f87f3b39458743caa
-  data.tar.gz: c8b16145accacae5bce4e23e5abec20b22f7379d
+  metadata.gz: b66f072d297e47ff393380b7507588265bfb147f
+  data.tar.gz: d4ab396390d9d8b850bcc74c39663bdd1f808a00
 SHA512:
-  metadata.gz: 7d7faa3f545002d42539c7cdaf058d1990bbfd13094e27ddfae2aa4f73b1e5ce7b7a4804f304b97f885854c5c7a293a5ff4bbe1b7782906efdb673e4ddd435ca
-  data.tar.gz: 3c51c2db6bcc0cd4a7797df94acc7cd24fe55845564a06a57843e1c8c3da9acb38ccb8171d0a21c1ff29c68faebcbfa8b453fa4b5abc33476d5be689e53ae253
+  metadata.gz: b37599b12abd509ef7d8f59e6267d624622d15ce34c7abf19c5669fc4d181dd418123aa567cfde22aae521db1363ba0022ca2a3ff4c17ef58823745f38e1d38e
+  data.tar.gz: 3f9e439caa164fec96a18ccabe438b6cc2f0edda1f7c09c76181c4f56b47c02b084995d36185ab2f702ec9bc0c81a5d1975e3ece7fb6b6f00b9d71273325c64e

data/CHANGES.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.1.2 (2017-02-12)
+
+* Improve usage help for commands with both parameters and subcommands.
+
 ## 1.1.1 (2016-10-19)
 
 * Rename `.declare_attribute` back to `.define_accessors_for`.

data/examples/admin

@@ -1,6 +1,6 @@
 #! /usr/bin/env ruby
 
-# An example of subcommands
+# An example of options and parameters
 
 require "clamp"
 

data/examples/flipflop

@@ -1,6 +1,6 @@
 #! /usr/bin/env ruby
 
-# An example of subcommands
+# An example of subcommands (including a default subcommand)
 
 require "clamp"
 require "clamp/version"

data/examples/fubar

@@ -1,6 +1,6 @@
 #! /usr/bin/env ruby
 
-# An example of subcommands
+# An example of nested subcommands
 
 require "clamp"
 

data/examples/subcommand_missing

@@ -1,5 +1,7 @@
 #! /usr/bin/env ruby
 
+# Demonstrate subcommand_missing
+
 require "clamp"
 
 Clamp do

data/examples/word

@@ -0,0 +1,27 @@
+#! /usr/bin/env ruby
+
+# Demonstrate "restful" style; parameters precede subcommands
+
+require "clamp"
+
+Clamp do
+
+  banner %(
+    Word ops.
+  )
+
+  parameter "WORD", "the word in question"
+
+  subcommand "say", "Say it" do
+    def execute
+      puts word
+    end
+  end
+
+  subcommand "shout", "Say it loud" do
+    def execute
+      puts word.upcase
+    end
+  end
+
+end

data/lib/clamp/parameter/declaration.rb

@@ -23,8 +23,6 @@ module Clamp
         end
       end
 
-      protected
-
       def inheritable_parameters
         superclass_inheritable_parameters + parameters.select(&:inheritable?)
       end

data/lib/clamp/subcommand/execution.rb

@@ -15,7 +15,7 @@ module Clamp
 
       def instantiate_subcommand(name)
         subcommand_class = find_subcommand_class(name)
-        subcommand = subcommand_class.new("#{invocation_path} #{name}", context)
+        subcommand = subcommand_class.new(invocation_path_for(name), context)
         self.class.inheritable_attributes.each do |attribute|
           next unless attribute.of(self).defined?
           attribute.of(subcommand).set(attribute.of(self).get)
@@ -23,6 +23,11 @@ module Clamp
         subcommand
       end
 
+      def invocation_path_for(name)
+        param_names = self.class.inheritable_parameters.map(&:name)
+        [invocation_path, *param_names, name].join(" ")
+      end
+
       def find_subcommand_class(name)
         subcommand_def = self.class.find_subcommand(name)
         return subcommand_def.subcommand_class if subcommand_def

data/lib/clamp/version.rb

@@ -1,3 +1,3 @@
 module Clamp
-  VERSION = "1.1.1".freeze
+  VERSION = "1.1.2".freeze
 end

data/spec/clamp/command_group_spec.rb

@@ -258,6 +258,14 @@ describe Clamp::Command do
       expect(stdout.strip).to eql "MONEY"
     end
 
+    it "shows parameter in usage help" do
+      begin
+        command.run(["stuff", "say", "--help"])
+      rescue Clamp::HelpWanted => e
+        expect(e.command.invocation_path).to eql("with THING say")
+      end
+    end
+
   end
 
   describe "each subcommand" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clamp
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Mike Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-19 00:00:00.000000000 Z
+date: 2017-02-12 00:00:00.000000000 Z
 dependencies: []
 description: |
   Clamp provides an object-model for command-line utilities.
@@ -38,6 +38,7 @@ files:
 - examples/scoop
 - examples/speak
 - examples/subcommand_missing
+- examples/word
 - lib/clamp.rb
 - lib/clamp/attribute/declaration.rb
 - lib/clamp/attribute/definition.rb
@@ -85,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: a minimal framework for command-line utilities