clamp 1.2.0.beta1 → 1.3.2

data/spec/clamp/help_spec.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe Clamp::Help::Builder do
+
+  subject(:builder) { described_class.new }
+
+  def output
+    builder.string
+  end
+
+  describe "#line" do
+
+    it "adds a line of text" do
+      builder.line("blah")
+      expect(output).to eq("blah\n")
+    end
+
+  end
+
+  describe "#row" do
+
+    it "adds two strings separated by spaces" do
+      builder.row("LHS", "RHS")
+      expect(output).to eq("    LHS    RHS\n")
+    end
+
+  end
+
+  context "with multiple rows" do
+
+    it "arranges them in two columns" do
+      builder.row("foo", "bar")
+      builder.row("flibble", "blurk")
+      builder.row("x", "y")
+      expect(output.lines).to eq [
+        "    foo        bar\n",
+        "    flibble    blurk\n",
+        "    x          y\n"
+      ]
+    end
+
+  end
+
+  context "with a mixture of lines and rows" do
+
+    it "still arranges them in two columns" do
+      builder.line("ABCDEFGHIJKLMNOP")
+      builder.row("flibble", "blurk")
+      builder.line("Another section heading")
+      builder.row("x", "y")
+      expect(output.lines).to eq [
+        "ABCDEFGHIJKLMNOP\n",
+        "    flibble    blurk\n",
+        "Another section heading\n",
+        "    x          y\n"
+      ]
+    end
+
+  end
+
+end

data/spec/clamp/messages_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 require "spec_helper"
 
@@ -6,8 +7,8 @@ describe Clamp::Messages do
   describe "message" do
     before do
       Clamp.messages = {
-        :too_many_arguments => "Way too many!",
-        :custom_message => "Say %<what>s to %<whom>s"
+        too_many_arguments: "Way too many!",
+        custom_message: "Say %<what>s to %<whom>s"
       }
     end
 
@@ -24,7 +25,7 @@ describe Clamp::Messages do
     end
 
     it "formats the message" do
-      expect(Clamp.message(:custom_message, :what => "hello", :whom => "Clamp")).to eql "Say hello to Clamp"
+      expect(Clamp.message(:custom_message, what: "hello", whom: "Clamp")).to eql "Say hello to Clamp"
     end
   end
 
@@ -33,7 +34,7 @@ describe Clamp::Messages do
       default_msg = Clamp.message(:too_many_arguments).clone
 
       Clamp.messages = {
-        :too_many_arguments => "Way too many!"
+        too_many_arguments: "Way too many!"
       }
       Clamp.clear_messages!
 

data/spec/clamp/option/definition_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe Clamp::Option::Definition do
@@ -27,7 +29,7 @@ describe Clamp::Option::Definition do
       end
 
       it "can be overridden" do
-        option = described_class.new("--key-file", "FILE", "SSH identity", :attribute_name => "ssh_identity")
+        option = described_class.new("--key-file", "FILE", "SSH identity", attribute_name: "ssh_identity")
         expect(option.attribute_name).to eql "ssh_identity"
       end
 
@@ -49,7 +51,7 @@ describe Clamp::Option::Definition do
       end
 
       it "can be overridden" do
-        option = described_class.new("-n", "N", "iterations", :default => 1)
+        option = described_class.new("-n", "N", "iterations", default: 1)
         expect(option.default_value).to eql 1
       end
 
@@ -149,7 +151,7 @@ describe Clamp::Option::Definition do
   context "with an associated environment variable" do
 
     let(:option) do
-      described_class.new("-x", "X", "mystery option", :environment_variable => "APP_X")
+      described_class.new("-x", "X", "mystery option", environment_variable: "APP_X")
     end
 
     describe "#help" do
@@ -163,7 +165,7 @@ describe Clamp::Option::Definition do
     context "and a default value" do
 
       let(:option) do
-        described_class.new("-x", "X", "mystery option", :environment_variable => "APP_X", :default => "xyz")
+        described_class.new("-x", "X", "mystery option", environment_variable: "APP_X", default: "xyz")
       end
 
       describe "#help" do
@@ -181,7 +183,7 @@ describe Clamp::Option::Definition do
   context "multivalued" do
 
     let(:option) do
-      described_class.new(["-H", "--header"], "HEADER", "extra header", :multivalued => true)
+      described_class.new(["-H", "--header"], "HEADER", "extra header", multivalued: true)
     end
 
     it "is multivalued" do
@@ -195,7 +197,7 @@ 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])
+        option = described_class.new("-H", "HEADER", "extra header", multivalued: true, default: [1, 2, 3])
         expect(option.default_value).to eql [1, 2, 3]
       end
 
@@ -247,19 +249,19 @@ 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
 
     it "rejects :flag options" do
       expect do
-        described_class.new("--awesome", :flag, "Be awesome?", :required => true)
+        described_class.new("--awesome", :flag, "Be awesome?", required: true)
       end.to raise_error(ArgumentError)
     end
   end
 
   describe "a hidden option" do
-    let(:option) { described_class.new("--unseen", :flag, "Something", :hidden => true) }
+    let(:option) { described_class.new("--unseen", :flag, "Something", hidden: true) }
     it "is hidden" do
       expect(option).to be_hidden
     end
@@ -268,7 +270,7 @@ describe Clamp::Option::Definition do
   describe "a hidden option in a command" do
     let(:command_class) do
       Class.new(Clamp::Command) do
-        option "--unseen", :flag, "Something", :hidden => true
+        option "--unseen", :flag, "Something", hidden: true
 
         def execute
           # this space intentionally left blank
@@ -277,7 +279,7 @@ describe Clamp::Option::Definition do
     end
 
     it "is not shown in the help" do
-      expect(command_class.help("foo")).not_to match /^ +--unseen +Something$/
+      expect(command_class.help("foo")).not_to match(/^ +--unseen +Something$/)
     end
 
     it "sets the expected accessor" do

data/spec/clamp/option_module_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe Clamp::Command do
@@ -10,7 +12,7 @@ describe Clamp::Command do
 
       shared_options = Module.new do
         extend Clamp::Option::Declaration
-        option "--size", "SIZE", :default => 4
+        option "--size", "SIZE", default: 4
       end
 
       command_class = Class.new(Clamp::Command) do

data/spec/clamp/option_reordering_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe Clamp::Command do
@@ -23,7 +25,7 @@ describe Clamp::Command do
 
         option "--loud", :flag, "say it loud"
 
-        parameter "WORDS ...", "the thing to say", :attribute_name => :words
+        parameter "WORDS ...", "the thing to say", attribute_name: :words
 
         def execute
           message = words.join(" ")
@@ -37,17 +39,17 @@ describe Clamp::Command do
     end
 
     it "still works" do
-      command.run(%w(say foo))
+      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))
+      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))
+      command.run(%w[say --loud blah])
       expect(stdout).to eql("BLAH\n")
     end
 

data/spec/clamp/parameter/definition_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe Clamp::Parameter::Definition do
@@ -27,7 +29,7 @@ describe Clamp::Parameter::Definition do
       end
 
       it "can be overridden" do
-        parameter = described_class.new("COLOR", "hue of choice", :attribute_name => "hue")
+        parameter = described_class.new("COLOR", "hue of choice", attribute_name: "hue")
         expect(parameter.attribute_name).to eql "hue"
       end
 
@@ -36,9 +38,9 @@ describe Clamp::Parameter::Definition do
     describe "#consume" do
 
       it "consumes one argument" do
-        arguments = %w(a b c)
+        arguments = %w[a b c]
         expect(parameter.consume(arguments)).to eql ["a"]
-        expect(arguments).to eql %w(b c)
+        expect(arguments).to eql %w[b c]
       end
 
       describe "with no arguments" do
@@ -77,9 +79,9 @@ describe Clamp::Parameter::Definition do
     describe "#consume" do
 
       it "consumes one argument" do
-        arguments = %w(a b c)
+        arguments = %w[a b c]
         expect(parameter.consume(arguments)).to eql ["a"]
-        expect(arguments).to eql %w(b c)
+        expect(arguments).to eql %w[b c]
       end
 
       describe "with no arguments" do
@@ -124,8 +126,8 @@ describe Clamp::Parameter::Definition do
     describe "#consume" do
 
       it "consumes all the remaining arguments" do
-        arguments = %w(a b c)
-        expect(parameter.consume(arguments)).to eql %w(a b c)
+        arguments = %w[a b c]
+        expect(parameter.consume(arguments)).to eql %w[a b c]
         expect(arguments).to eql []
       end
 
@@ -145,7 +147,7 @@ describe Clamp::Parameter::Definition do
     context "with a weird parameter name, and an explicit attribute_name" do
 
       let(:parameter) do
-        described_class.new("KEY=VALUE ...", "config-settings", :attribute_name => :config_settings)
+        described_class.new("KEY=VALUE ...", "config-settings", attribute_name: :config_settings)
       end
 
       describe "#attribute_name" do
@@ -197,13 +199,13 @@ describe Clamp::Parameter::Definition do
     context "with specified default value" do
 
       let(:parameter) do
-        described_class.new("[FILES] ...", "files to process", :default => %w(a b c))
+        described_class.new("[FILES] ...", "files to process", default: %w[a b c])
       end
 
       describe "#default_value" do
 
         it "is that specified" do
-          expect(parameter.default_value).to eql %w(a b c)
+          expect(parameter.default_value).to eql %w[a b c]
         end
 
       end
@@ -219,8 +221,8 @@ describe Clamp::Parameter::Definition do
       describe "#consume" do
 
         it "consumes all the remaining arguments" do
-          arguments = %w(a b c)
-          expect(parameter.consume(arguments)).to eql %w(a b c)
+          arguments = %w[a b c]
+          expect(parameter.consume(arguments)).to eql %w[a b c]
           expect(arguments).to eql []
         end
 

data/spec/spec_helper.rb

@@ -1,16 +1,16 @@
+# frozen_string_literal: true
+
 require "rspec"
 require "clamp"
 require "stringio"
 
 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}"
+      raise "Unexpected exit with status #{e.status}"
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clamp
 version: !ruby/object:Gem::Version
-  version: 1.2.0.beta1
+  version: 1.3.2
 platform: ruby
 authors:
 - Mike Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-08 00:00:00.000000000 Z
+date: 2020-08-20 00:00:00.000000000 Z
 dependencies: []
 description: |
   Clamp provides an object-model for command-line utilities.
@@ -19,6 +19,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".autotest"
+- ".editorconfig"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -61,13 +62,14 @@ files:
 - lib/clamp/version.rb
 - spec/clamp/command_group_spec.rb
 - spec/clamp/command_spec.rb
+- spec/clamp/help_spec.rb
 - 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
+homepage: https://github.com/mdub/clamp
 licenses:
 - MIT
 metadata: {}
@@ -82,18 +84,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: a minimal framework for command-line utilities
 test_files:
 - spec/clamp/command_group_spec.rb
 - spec/clamp/command_spec.rb
+- spec/clamp/help_spec.rb
 - spec/clamp/messages_spec.rb
 - spec/clamp/option/definition_spec.rb
 - spec/clamp/option_module_spec.rb