clamp 1.1.2 → 1.2.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b66f072d297e47ff393380b7507588265bfb147f
-  data.tar.gz: d4ab396390d9d8b850bcc74c39663bdd1f808a00
+  metadata.gz: aec7a5c34695b2517afb8215a0cbe8e9e4b2c8b9
+  data.tar.gz: f20e0d18b9e4be570fc7ae1f349d4d022f0f7644
 SHA512:
-  metadata.gz: b37599b12abd509ef7d8f59e6267d624622d15ce34c7abf19c5669fc4d181dd418123aa567cfde22aae521db1363ba0022ca2a3ff4c17ef58823745f38e1d38e
-  data.tar.gz: 3f9e439caa164fec96a18ccabe438b6cc2f0edda1f7c09c76181c4f56b47c02b084995d36185ab2f702ec9bc0c81a5d1975e3ece7fb6b6f00b9d71273325c64e
+  metadata.gz: 554f0e8fefe510adeacd74357333302d2f3ae9a4b98f87e0140956e4b35ff6f60b7b3031260b8cba2c2f96079b201ebc4c6256bed160d52038a079e7538defda
+  data.tar.gz: 85d29744e560feb6c06096739df752128bd1df915237da53b1c7ea7150ade1d3516016eb3014c7fc1f2958fdcf2074c35e00d6aa64057a8c8c56c9c82094f879

data/CHANGES.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## PENDING
+
+* Add option to `Clamp.allow_options_after_parameters`.
+
 ## 1.1.2 (2017-02-12)
 
 * Improve usage help for commands with both parameters and subcommands.

data/README.md

@@ -163,6 +163,16 @@ Declaring an option "`:hidden`" will cause it to be hidden from `--help` output.
 option "--some-option", "VALUE", "Just a little option", :hidden => true
 ```
 
+### Version option
+
+A common idiom is to have an option `--version` that outputs the command version and doesn't run any subcommands.  This can be acheived by:
+
+```ruby
+option "--version", :flag, "Show version" do
+  puts MyGem::VERSION
+  exit(0)
+end
+```
 
 Declaring parameters
 --------------------
@@ -286,6 +296,18 @@ parameter "[HOST]", "server address", :environment_variable => "MYAPP_HOST"
 
 Clamp will check the specified envariables in the absence of values supplied on the command line, before looking for a default value.
 
+### Allowing options after parameters
+
+Many option-parsing libraries - notably [GNU `getopt(3)`](https://www.gnu.org/software/libc/manual/html_node/Using-Getopt.html) - allow option and parameter arguments to appear in any order on the command-line, e.g.
+
+    foobar --foo=bar something --fnord=snuffle another-thing
+
+By default, Clamp does not allow options and parameters to be "interspersed" in this way. If you want that behaviour, set:
+
+```ruby
+Clamp.allow_options_after_parameters = true
+```
+
 Declaring Subcommands
 ---------------------
 

data/lib/clamp/option/parsing.rb

@@ -1,4 +1,9 @@
 module Clamp
+
+  class << self
+    attr_accessor :allow_options_after_parameters
+  end
+
   module Option
 
     module Parsing
@@ -14,7 +19,18 @@ module Clamp
       private
 
       def set_options_from_command_line
-        while remaining_arguments.first && remaining_arguments.first.start_with?("-")
+        argument_buffer = []
+        argument_buffer_limit = self.class.parameter_buffer_limit
+        until remaining_arguments.empty?
+
+          unless remaining_arguments.first.start_with?("-")
+            if argument_buffer.size < argument_buffer_limit
+              argument_buffer << remaining_arguments.shift
+              next
+            else
+              break
+            end
+          end
 
           switch = remaining_arguments.shift
           break if switch == "--"
@@ -42,6 +58,7 @@ module Clamp
           end
 
         end
+        remaining_arguments.unshift(*argument_buffer)
       end
 
       def default_options_from_environment
@@ -74,4 +91,5 @@ module Clamp
     end
 
   end
+
 end

data/lib/clamp/parameter/declaration.rb

@@ -27,6 +27,12 @@ module Clamp
         superclass_inheritable_parameters + parameters.select(&:inheritable?)
       end
 
+      def parameter_buffer_limit
+        return 0 unless Clamp.allow_options_after_parameters
+        return Float::INFINITY if inheritable_parameters.any?(&:multivalued?)
+        inheritable_parameters.size
+      end
+
       private
 
       def superclass_inheritable_parameters

data/lib/clamp/version.rb

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

data/spec/clamp/option_reordering_spec.rb

@@ -0,0 +1,56 @@
+require "spec_helper"
+
+describe Clamp::Command do
+
+  extend CommandFactory
+  include OutputCapture
+
+  context "with allow_options_after_parameters enabled" do
+
+    before do
+      Clamp.allow_options_after_parameters = true
+    end
+
+    after do
+      Clamp.allow_options_after_parameters = false
+    end
+
+    given_command("cmd") do
+
+      option ["-v", "--verbose"], :flag, "Be noisy"
+
+      subcommand "say", "Say something" do
+
+        option "--loud", :flag, "say it loud"
+
+        parameter "WORDS ...", "the thing to say", :attribute_name => :words
+
+        def execute
+          message = words.join(" ")
+          message = message.upcase if loud?
+          message *= 3 if verbose?
+          $stdout.puts message
+        end
+
+      end
+
+    end
+
+    it "still works" do
+      command.run(%w(say foo))
+      expect(stdout).to eql("foo\n")
+    end
+
+    it "honours options after positional arguments" do
+      command.run(%w(say blah --verbose))
+      expect(stdout).to eql("blahblahblah\n")
+    end
+
+    it "honours options declared on subcommands" do
+      command.run(%w(say --loud blah))
+      expect(stdout).to eql("BLAH\n")
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -6,6 +6,14 @@ RSpec.configure do |config|
 
   config.mock_with :rr
 
+  config.around(:each) do |example|
+    begin
+      example.run
+    rescue SystemExit => e
+      fail "Unexpected exit with status #{e.status}"
+    end
+  end
+
 end
 
 module OutputCapture

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clamp
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0.beta1
 platform: ruby
 authors:
 - Mike Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-12 00:00:00.000000000 Z
+date: 2017-11-08 00:00:00.000000000 Z
 dependencies: []
 description: |
   Clamp provides an object-model for command-line utilities.
@@ -64,6 +64,7 @@ files:
 - spec/clamp/messages_spec.rb
 - spec/clamp/option/definition_spec.rb
 - spec/clamp/option_module_spec.rb
+- spec/clamp/option_reordering_spec.rb
 - spec/clamp/parameter/definition_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/mdub/clamp
@@ -81,12 +82,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: a minimal framework for command-line utilities
@@ -96,5 +97,6 @@ test_files:
 - spec/clamp/messages_spec.rb
 - spec/clamp/option/definition_spec.rb
 - spec/clamp/option_module_spec.rb
+- spec/clamp/option_reordering_spec.rb
 - spec/clamp/parameter/definition_spec.rb
 - spec/spec_helper.rb