clamp 1.4.0 → 1.5.1

data/spec/clamp/help/builder_spec.rb

@@ -1,81 +0,0 @@
-# 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
-
-    before do
-
-      builder.row("foo", "bar")
-      builder.row("flibble", "blurk")
-      builder.row("x", "y")
-
-    end
-
-    let(:expected_output) do
-      [
-        "    foo        bar\n",
-        "    flibble    blurk\n",
-        "    x          y\n"
-      ]
-    end
-
-    it "arranges them in two columns" do
-      expect(output.lines).to eq expected_output
-    end
-
-  end
-
-  context "with a mixture of lines and rows" do
-
-    before do
-
-      builder.line("ABCDEFGHIJKLMNOP")
-      builder.row("flibble", "blurk")
-      builder.line("Another section heading")
-      builder.row("x", "y")
-
-    end
-
-    let(:expected_output) do
-      [
-        "ABCDEFGHIJKLMNOP\n",
-        "    flibble    blurk\n",
-        "Another section heading\n",
-        "    x          y\n"
-      ]
-    end
-
-    it "still arranges them in two columns" do
-      expect(output.lines).to eq expected_output
-    end
-
-  end
-
-end

data/spec/clamp/messages_spec.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-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"
-      }
-    end
-
-    after do
-      Clamp.clear_messages!
-    end
-
-    it "allows setting custom messages" do
-      expect(Clamp.message(:too_many_arguments)).to eq "Way too many!"
-    end
-
-    it "fallbacks to a default message" do
-      expect(Clamp.message(:no_value_provided)).to eq "no value provided"
-    end
-
-    it "formats the message" do
-      expect(Clamp.message(:custom_message, what: "hello", whom: "Clamp")).to eq "Say hello to Clamp"
-    end
-  end
-
-  describe "clear_messages!" do
-    let!(:default_msg) { Clamp.message(:too_many_arguments).clone }
-
-    before do
-
-      Clamp.messages = {
-        too_many_arguments: "Way too many!"
-      }
-
-      Clamp.clear_messages!
-
-    end
-
-    it "clears messages to the defualt state" do
-      expect(Clamp.message(:too_many_arguments)).to eq default_msg
-    end
-  end
-
-end

data/spec/clamp/option/definition_spec.rb

@@ -1,343 +0,0 @@
-# frozen_string_literal: true
-
-require "spec_helper"
-
-describe Clamp::Option::Definition do
-
-  context "with String argument" do
-
-    let(:option) do
-      described_class.new("--key-file", "FILE", "SSH identity")
-    end
-
-    it "has a long_switch" do
-      expect(option.long_switch).to eq "--key-file"
-    end
-
-    it "has a type" do
-      expect(option.type).to eq "FILE"
-    end
-
-    it "has a description" do
-      expect(option.description).to eq "SSH identity"
-    end
-
-    describe "#attribute_name" do
-
-      it "is derived from the (long) switch" do
-        expect(option.attribute_name).to eq "key_file"
-      end
-
-      it "can be overridden" do
-        option = described_class.new("--key-file", "FILE", "SSH identity", attribute_name: "ssh_identity")
-        expect(option.attribute_name).to eq "ssh_identity"
-      end
-
-    end
-
-    describe "#write_method" do
-
-      it "is derived from the attribute_name" do
-        expect(option.write_method).to eq "key_file="
-      end
-
-    end
-
-    describe "#default_value" do
-
-      it "defaults to nil" do
-        option = described_class.new("-n", "N", "iterations")
-        expect(option.default_value).to be_nil
-      end
-
-      it "can be overridden" do
-        option = described_class.new("-n", "N", "iterations", default: 1)
-        expect(option.default_value).to eq 1
-      end
-
-    end
-
-    describe "#help" do
-
-      it "combines switch, type and description" do
-        expect(option.help).to eq ["--key-file FILE", "SSH identity"]
-      end
-
-    end
-
-  end
-
-  context "when flag" do
-
-    let(:option) do
-      described_class.new("--verbose", :flag, "Blah blah blah")
-    end
-
-    describe "#default_conversion_block" do
-
-      context "with 'true' value" do
-        it "converts to true" do
-          expect(option.default_conversion_block.call("true")).to be true
-        end
-      end
-
-      context "with 'yes' value" do
-        it "converts to true" do
-          expect(option.default_conversion_block.call("yes")).to be true
-        end
-      end
-
-      context "with 'false' value" do
-        it "converts to false" do
-          expect(option.default_conversion_block.call("false")).to be false
-        end
-      end
-
-      context "with 'no' value" do
-        it "converts to false" do
-          expect(option.default_conversion_block.call("no")).to be false
-        end
-      end
-
-    end
-
-    describe "#help" do
-
-      it "excludes option argument" do
-        expect(option.help).to eq ["--verbose", "Blah blah blah"]
-      end
-
-    end
-
-  end
-
-  context "when negatable flag" do
-
-    let(:option) do
-      described_class.new("--[no-]force", :flag, "Force installation")
-    end
-
-    describe "positive form" do
-      it "handles this" do
-        expect(option.handles?("--force")).to be true
-      end
-    end
-
-    describe "negative form" do
-      it "handles this" do
-        expect(option.handles?("--no-force")).to be true
-      end
-    end
-
-    describe "#flag_set?" do
-
-      describe "positive variant" do
-        it "returns true" do
-          expect(option.flag_set?("--force")).to be true
-        end
-      end
-
-      describe "negative variant" do
-        it "returns false" do
-          expect(option.flag_set?("--no-force")).to be false
-        end
-      end
-
-    end
-
-    describe "#attribute_name" do
-
-      it "is derived from the (long) switch" do
-        expect(option.attribute_name).to eq "force"
-      end
-
-    end
-
-  end
-
-  context "with both short and long switches" do
-
-    let(:option) do
-      described_class.new(["-k", "--key-file"], "FILE", "SSH identity")
-    end
-
-    describe "long switch" do
-      it "handles this" do
-        expect(option.handles?("--key-file")).to be true
-      end
-    end
-
-    describe "short switch" do
-      it "handles this" do
-        expect(option.handles?("-k")).to be true
-      end
-    end
-
-    describe "#help" do
-
-      it "includes both switches" do
-        expect(option.help).to eq ["-k, --key-file FILE", "SSH identity"]
-      end
-
-    end
-
-  end
-
-  context "with an associated environment variable" do
-
-    let(:option) do
-      described_class.new("-x", "X", "mystery option", environment_variable: "APP_X")
-    end
-
-    describe "#help" do
-
-      it "describes environment variable" do
-        expect(option.help).to eq ["-x X", "mystery option (default: $APP_X)"]
-      end
-
-    end
-
-    context "with a default value" do
-
-      let(:option) do
-        described_class.new("-x", "X", "mystery option", environment_variable: "APP_X", default: "xyz")
-      end
-
-      describe "#help" do
-
-        it "describes both environment variable and default" do
-          expect(option.help).to eq ["-x X", %{mystery option (default: $APP_X, or "xyz")}]
-        end
-
-      end
-
-    end
-
-    context "when it is required" do
-
-      let(:option) do
-        described_class.new("-x", "X", "mystery option", environment_variable: "APP_X", required: true)
-      end
-
-      describe "#help" do
-
-        it "describes the environment variable as the default" do
-          expect(option.help).to eql ["-x X", %{mystery option (required, default: $APP_X)}]
-        end
-
-      end
-
-    end
-
-  end
-
-  context "when multivalued" do
-
-    let(:option) do
-      described_class.new(["-H", "--header"], "HEADER", "extra header", multivalued: true)
-    end
-
-    it "is multivalued" do
-      expect(option).to be_multivalued
-    end
-
-    describe "#default_value" do
-
-      it "defaults to an empty Array" do
-        expect(option.default_value).to be_empty
-      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 eq [1, 2, 3]
-      end
-
-    end
-
-    describe "#attribute_name" do
-
-      it "gets a _list suffix" do
-        expect(option.attribute_name).to eq "header_list"
-      end
-
-    end
-
-    describe "#append_method" do
-
-      it "is derived from the attribute_name" do
-        expect(option.append_method).to eq "append_to_header_list"
-      end
-
-    end
-
-  end
-
-  describe "in subcommand" do
-
-    let(:command_class) do
-
-      Class.new(Clamp::Command) do
-        subcommand "foo", "FOO!" do
-          option "--bar", "BAR", "Bars foo."
-        end
-      end
-
-    end
-
-    describe "Command#help" do
-
-      it "includes help for each option exactly once" do
-        subcommand = command_class.send(:find_subcommand, "foo")
-        subcommand_help = subcommand.subcommand_class.help("")
-        expect(subcommand_help.lines.grep(/--bar BAR/).count).to eq 1
-      end
-
-    end
-
-  end
-
-  describe "a required option" do
-    it "rejects :default" do
-      expect do
-        described_class.new("--key-file", "FILE", "SSH identity",
-                            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)
-      end.to raise_error(ArgumentError)
-    end
-  end
-
-  describe "a hidden option" do
-    let(:option) { described_class.new("--unseen", :flag, "Something", hidden: true) }
-
-    it "is hidden" do
-      expect(option).to be_hidden
-    end
-  end
-
-  describe "a hidden option in a command" do
-    let(:command_class) do
-      Class.new(Clamp::Command) do
-        option "--unseen", :flag, "Something", hidden: true
-
-        def execute
-          # this space intentionally left blank
-        end
-      end
-    end
-
-    it "is not shown in the help" do
-      expect(command_class.help("foo")).not_to match(/^ +--unseen +Something$/)
-    end
-
-    it "sets the expected accessor" do
-      command = command_class.new("foo")
-      command.run(["--unseen"])
-      expect(command).to be_unseen
-    end
-  end
-end