mamertes 2.4.1

data/spec/mamertes/option_spec.rb

@@ -0,0 +1,274 @@
+# encoding: utf-8
+#
+# This file is part of the mamertes gem. Copyright (C) 2013 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+require "spec_helper"
+
+describe Mamertes::Option do
+  let(:application) {
+    ::Mamertes::Application.new {
+      action {}
+    }
+  }
+
+  let(:command) {
+    c = ::Mamertes::Command.new
+    c.application = application
+    c
+  }
+
+  let(:option) {
+    o = ::Mamertes::Option.new("NAME")
+    o.parent = command
+    o
+  }
+
+  describe "#initialize" do
+    it "should set good forms" do
+      option = ::Mamertes::Option.new("NAME")
+      expect(option.name).to eq("NAME")
+      expect(option.short).to eq("N")
+      expect(option.long).to eq("NAME")
+
+      option = ::Mamertes::Option.new("NAME", "O")
+      expect(option.name).to eq("NAME")
+      expect(option.short).to eq("O")
+      expect(option.long).to eq("NAME")
+
+      option = ::Mamertes::Option.new("NAME", ["O", "OPTION"])
+      expect(option.name).to eq("NAME")
+      expect(option.short).to eq("O")
+      expect(option.long).to eq("OPTION")
+
+    end
+
+    it "should set options" do
+      option = ::Mamertes::Option.new("NAME", ["O", "OPTION"], {required: true, help: "HELP", unused: "UNUSED"})
+      expect(option.help).to be_true
+      expect(option.help).to eq("HELP")
+    end
+  end
+
+  describe "#short=" do
+    it "should set good form" do
+      option.short = "a"
+      expect(option.short).to eq("a")
+
+      option.short = "-b"
+      expect(option.short).to eq("b")
+
+      option.short = "-c"
+      expect(option.short).to eq("c")
+
+      option.short = 1
+      expect(option.short).to eq("1")
+
+      option.short = true
+      expect(option.short).to eq("t")
+
+      option.short = nil
+      expect(option.short).to eq("N")
+    end
+  end
+
+  describe "#long=" do
+    it "should set good form" do
+      option.long = "a"
+      expect(option.long).to eq("a")
+
+      option.long = "abc"
+      expect(option.long).to eq("abc")
+
+      option.long = "-def"
+      expect(option.long).to eq("def")
+
+      option.long = "--ghi"
+      expect(option.long).to eq("ghi")
+
+      option.long = true
+      expect(option.long).to eq("true")
+
+      option.long = 1
+      expect(option.long).to eq("1")
+
+      option.long = nil
+      expect(option.long).to eq("NAME")
+    end
+  end
+
+  describe "#validator=" do
+    it "should set a good validator" do
+      option.validator = "VALUE"
+      expect(option.validator).to eq(["VALUE"])
+      option.validator = ["VALUE", "VALUE"]
+      expect(option.validator).to eq(["VALUE"])
+      option.validator = /VALUE/
+      expect(option.validator).to eq(/VALUE/)
+      option.validator = nil
+      expect(option.validator).to be_nil
+      option.validator = ""
+      expect(option.validator).to be_nil
+      option.validator = []
+      expect(option.validator).to be_nil
+      option.validator = //
+      expect(option.validator).to be_nil
+    end
+  end
+
+  describe "#complete_short" do
+    it "should return a good short form" do
+      expect(::Mamertes::Option.new("NAME").complete_short).to eq("-N")
+      expect(::Mamertes::Option.new("NAME", "A").complete_short).to eq("-A")
+      expect(::Mamertes::Option.new("NAME", ["A", "BC"]).complete_short).to eq("-A")
+      expect(::Mamertes::Option.new("NAME", [true, false]).complete_short).to eq("-t")
+    end
+  end
+
+  describe "#complete_long" do
+    it "should return a good short form" do
+      expect(::Mamertes::Option.new("NAME").complete_long).to eq("--NAME")
+      expect(::Mamertes::Option.new("NAME", "A").complete_long).to eq("--NAME")
+      expect(::Mamertes::Option.new("NAME", ["A", "BC"]).complete_long).to eq("--BC")
+      expect(::Mamertes::Option.new("NAME", [true, true]).complete_long).to eq("--true")
+    end
+  end
+
+  describe "#label" do
+    it "should return a good label" do
+      expect(::Mamertes::Option.new("NAME").label).to eq("-N/--NAME")
+      expect(::Mamertes::Option.new("NAME", "A").label).to eq("-A/--NAME")
+      expect(::Mamertes::Option.new("NAME", ["A", "BC"]).label).to eq("-A/--BC")
+      expect(::Mamertes::Option.new("NAME", [true, true]).label).to eq("-t/--true")
+    end
+
+  end
+
+  describe "#meta" do
+    it "should return the option meta" do
+      expect(::Mamertes::Option.new("NAME", []).meta).to be_nil
+      expect(::Mamertes::Option.new("NAME", [], {type: String}).meta).to eq("NAME")
+      expect(::Mamertes::Option.new("foo", [], {type: String}).meta).to eq("FOO")
+      expect(::Mamertes::Option.new("NAME", [], {type: String, meta: "STRING"}).meta).to eq("STRING")
+    end
+  end
+
+  describe "#set" do
+    it "should set the value" do
+      expect(option.set("VALUE")).to be_true
+      expect(option.value).to eq("VALUE")
+      expect(option.provided?).to be_true
+    end
+
+    it "should match against a regexp validator" do
+      option.validator = /^A|B$/
+
+      expect{ option.set("VALUE") }.to raise_error(::Mamertes::Error)
+      expect(option.value).to be_false
+      expect(option.provided?).to be_false
+
+      expect(option.set("VALUE", false)).to be_false
+      expect(option.value).to be_false
+      expect(option.provided?).to be_false
+
+      option.set("A")
+      expect(option.value).to eq("A")
+      expect(option.provided?).to be_true
+
+      option.set("B")
+      expect(option.value).to eq("B")
+      expect(option.provided?).to be_true
+    end
+
+    it "should match against an array validator" do
+      option.validator = ["A", "B"]
+
+      expect{ option.set("VALUE") }.to raise_error(::Mamertes::Error)
+      expect(option.value).to be_false
+      expect(option.provided?).to be_false
+
+      expect(option.set("VALUE", false)).to be_false
+      expect(option.value).to be_false
+      expect(option.provided?).to be_false
+
+      option.set("A")
+      expect(option.value).to eq("A")
+      expect(option.provided?).to be_true
+
+      option.set("B")
+      expect(option.value).to eq("B")
+      expect(option.provided?).to be_true
+    end
+  end
+
+  describe "#execute_action" do
+    it "should execute action if provided" do
+      check = false
+      option = ::Mamertes::Option.new("NAME") { |_, _| check = true }
+      option.execute_action
+
+      expect(check).to be_true
+      expect(option.provided?).to be_true
+    end
+
+    it "should result in a no-op if the action is missing or doesn't take enough arguments" do
+      option.execute_action
+      expect(option.provided?).to be_false
+
+      option = ::Mamertes::Option.new("NAME")
+      expect(option.provided?).to be_false
+    end
+  end
+
+  describe "#requires_argument?" do
+    it "should check if the option requires argument" do
+      expect(::Mamertes::Option.new("NAME", []).requires_argument?).to be_false
+      expect(::Mamertes::Option.new("NAME", [], {type: String}).requires_argument?).to be_true
+      expect(::Mamertes::Option.new("NAME", [], {type: Integer}).requires_argument?).to be_true
+      expect(::Mamertes::Option.new("NAME", [], {type: Float}).requires_argument?).to be_true
+      expect(::Mamertes::Option.new("NAME", [], {type: Array}).requires_argument?).to be_true
+      expect(::Mamertes::Option.new("NAME").requires_argument?).to be_false
+    end
+  end
+
+  describe "#provided?" do
+    it "should check if the option was provided" do
+      expect(::Mamertes::Option.new("NAME").provided?).to be_false
+      option.set(true)
+      expect(option.provided?).to be_true
+    end
+  end
+
+  describe "#has_help?" do
+    it "should check if the option has a help" do
+      expect(::Mamertes::Option.new("NAME").has_help?).to be_false
+      expect(::Mamertes::Option.new("NAME", [], help: "HELP").has_help?).to be_true
+    end
+  end
+
+  describe "#value" do
+    it "should return the set value" do
+      option.default = "DEFAULT VALUE"
+      expect(option.value).to eq("DEFAULT VALUE")
+
+      option.default = nil
+      expect(option.value).to be_false
+
+      option.set(true)
+      expect(option.value).to be_true
+
+      option.set("VALUE")
+      expect(option.value).to eq("VALUE")
+    end
+
+    it "should return good defaults" do
+      expect(::Mamertes::Option.new("NAME").value).to be_false
+      expect(::Mamertes::Option.new("NAME", [], {type: Regexp}).value).to be_false
+      expect(::Mamertes::Option.new("NAME", [], {type: String}).value).to eq("")
+      expect(::Mamertes::Option.new("NAME", [], {type: Integer}).value).to eq(0)
+      expect(::Mamertes::Option.new("NAME", [], {type: Float}).value).to eq(0.0)
+      expect(::Mamertes::Option.new("NAME", [], {type: Array}).value).to eq([])
+    end
+  end
+end

data/spec/mamertes/parser_spec.rb

@@ -0,0 +1,126 @@
+# encoding: utf-8
+#
+# This file is part of the mamertes gem. Copyright (C) 2013 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+require "spec_helper"
+
+describe Mamertes::Parser do
+  let(:application) {
+    ::Mamertes::Application.new do
+      command :abc do
+        action do
+        end
+
+        command :def do
+          action do |command|
+          end
+        end
+      end
+
+      option :boolean, ["b", "boolean"], help: "BOOLEAN"
+      option :string, [nil, "string"], type: String, meta: "STRING", help: "STRING"
+      option :integer, ["i", nil], type: Integer, help: "INTEGER"
+      option :float, [nil, nil], type: Float, help: "FLOAT"
+      option :array, ["a", "array"], type: Array, help: "ARRAY"
+      option :choice, ["c", "choice"], type: String, help: "ARRAY", validator: ["yes", "no"]
+      option :regexp, ["r", "regexp"], type: String, help: "REGEXP", validator: /yes|no/i
+      option :action, ["A"] do |_, command|
+        p "[OPTION] BLOCK"
+      end
+    end
+  }
+
+  let(:command) {
+    c = ::Mamertes::Command.new
+    c.application = application
+    c
+  }
+
+  describe ".smart_join" do
+    it "should correctly join arrays" do
+      expect(::Mamertes::Parser.smart_join([])).to eq("")
+      expect(::Mamertes::Parser.smart_join(["A"], ", ", " and ", nil)).to eq("A")
+      expect(::Mamertes::Parser.smart_join(1, ", ", " and ", nil)).to eq("1")
+      expect(::Mamertes::Parser.smart_join(["A", 1], ", ", " and ", nil)).to eq("A and 1")
+      expect(::Mamertes::Parser.smart_join(["A", 1, true], ", ", " and ", nil)).to eq("A, 1 and true")
+      expect(::Mamertes::Parser.smart_join(["A", "B", "C"], "-", " and ", nil)).to eq("A-B and C")
+      expect(::Mamertes::Parser.smart_join(["A", "B", "C"], "-", "@", nil)).to eq("A-B@C")
+      expect(::Mamertes::Parser.smart_join(["A", "B", "C"], ", ", " and ", "@")).to eq("@A@, @B@ and @C@")
+    end
+  end
+
+  describe ".find_command" do
+    it "should find commands" do
+      args = ["A", "B", "C"]
+      s1 = command.command("abc")
+      s2 = command.command("abd")
+      s1.command("def")
+
+      expect(::Mamertes::Parser.find_command("abc", command, args)).to eq({name: "abc", args: args})
+      expect(::Mamertes::Parser.find_command("abc:def", command, args)).to eq({name: "abc", args: ["def"] + args})
+      expect(::Mamertes::Parser.find_command("abc def", command, args, " ")).to eq({name: "abc", args: ["def"] + args})
+      expect(::Mamertes::Parser.find_command("d", s1, args)).to eq({name: "def", args: args})
+      expect{ ::Mamertes::Parser.find_command("ab", command, args) }.to raise_error(::Mamertes::Error)
+      expect(::Mamertes::Parser.find_command("abc", s2, args)).to be_nil
+    end
+  end
+
+  describe ".parse" do
+    it "should instantiate a parser and then parse" do
+      expect(::Mamertes::Parser).to receive(:new).and_call_original
+      expect_any_instance_of(::Mamertes::Parser).to receive(:parse).with("COMMAND", "ARGS")
+      ::Mamertes::Parser.parse("COMMAND", "ARGS")
+    end
+  end
+
+  describe "#parse" do
+    it "should iterate options" do
+      expect(application.options).to receive(:each_pair).exactly(2)
+      ::Mamertes::Parser.parse(application, [])
+    end
+
+    it "should set good values" do
+      expect(application.options["boolean"]).to receive("set").with(true)
+      expect(application.options["string"]).to receive("set").with("A")
+      expect(application.options["integer"]).to receive("set").with(1)
+      expect(application.options["float"]).to receive("set").with(2.0)
+      expect(application.options["array"]).to receive("set").with(["B", "C"])
+      expect(application.options["choice"]).to receive("set").with("yes")
+      expect(application.options["regexp"]).to receive("set").with("no")
+      expect(application.options["action"]).to receive("execute_action")
+      ::Mamertes::Parser.parse(application, ["-b", "-s", "A", "-i", "1", "-f", "2.0", "-a", "B,C", "-c", "yes", "-r", "no", "-A"])
+    end
+
+    it "should complain about invalid or additional values" do
+      expect { ::Mamertes::Parser.parse(application, ["-b=f"]) }.to raise_error(::Mamertes::Error)
+      expect { ::Mamertes::Parser.parse(application, ["-s"]) }.to raise_error(::Mamertes::Error)
+      expect { ::Mamertes::Parser.parse(application, ["-i", "A"]) }.to raise_error(::Mamertes::Error)
+      expect { ::Mamertes::Parser.parse(application, ["-f", "A"]) }.to raise_error(::Mamertes::Error)
+      expect { ::Mamertes::Parser.parse(application, ["-c", "B"]) }.to raise_error(::Mamertes::Error)
+      expect { ::Mamertes::Parser.parse(application, ["-r", "C"]) }.to raise_error(::Mamertes::Error)
+      expect { ::Mamertes::Parser.parse(application, ["-R", "C"]) }.to raise_error(::Mamertes::Error)
+      application.option("R", [], {required: true})
+      expect { ::Mamertes::Parser.parse(application, ["-b"]) }.to raise_error(::Mamertes::Error) # Because we're missing a required option
+    end
+
+    it "should complain about duplicate options" do
+      application.option(:boolean2)
+      expect { ::Mamertes::Parser.parse(application, ["-b"]) }.to raise_error(::Mamertes::Error)
+    end
+
+    it "should return the command to execute" do
+      expect(::Mamertes::Parser.parse(application, ["a", "OTHER"])).to eq({name: "abc", args: ["OTHER"]})
+      expect(::Mamertes::Parser.parse(application, ["ab:d", "OTHER"])).to eq({name: "abc", args: ["d", "OTHER"]})
+      expect(::Mamertes::Parser.parse(application, ["abc", "d", "OTHER"])).to eq({name: "abc", args: ["d", "OTHER"]})
+      expect(::Mamertes::Parser.parse(application, ["d", "OTHER"])).to eq(nil)
+
+      application.clear_options
+      expect(::Mamertes::Parser.parse(application, ["a", "OTHER"])).to eq({name: "abc", args: ["OTHER"]})
+      expect(::Mamertes::Parser.parse(application, ["d:d", "OTHER"])).to eq(nil)
+      expect(::Mamertes::Parser.parse(application, ["d d", "OTHER"])).to eq(nil)
+      expect(::Mamertes::Parser.parse(application, ["d", "d", "OTHER"])).to eq(nil)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+#
+# This file is part of the mamertes gem. Copyright (C) 2013 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+require "rubygems"
+require "bundler/setup"
+require "mamertes"
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: mamertes
+version: !ruby/object:Gem::Version
+  version: 2.4.1
+platform: ruby
+authors:
+- Shogun
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bovem
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+description: Yet another command line manager.
+email:
+- shogun_panda@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .DS_Store
+- .gitignore
+- .travis-gemfile
+- .travis.yml
+- .yardopts
+- Gemfile
+- README.md
+- Rakefile
+- doc/Mamertes.html
+- doc/Mamertes/Application.html
+- doc/Mamertes/Command.html
+- doc/Mamertes/CommandMethods.html
+- doc/Mamertes/CommandMethods/Children.html
+- doc/Mamertes/CommandMethods/Help.html
+- doc/Mamertes/Error.html
+- doc/Mamertes/Localizer.html
+- doc/Mamertes/Option.html
+- doc/Mamertes/Parser.html
+- doc/Mamertes/ParserMethods.html
+- doc/Mamertes/ParserMethods/General.html
+- doc/Mamertes/ParserMethods/General/ClassMethods.html
+- doc/Mamertes/Version.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
+- lib/mamertes.rb
+- lib/mamertes/application.rb
+- lib/mamertes/command.rb
+- lib/mamertes/option.rb
+- lib/mamertes/parser.rb
+- lib/mamertes/version.rb
+- locales/en.yml
+- locales/it.yml
+- mamertes.gemspec
+- spec/coverage_helper.rb
+- spec/mamertes/application_spec.rb
+- spec/mamertes/command_spec.rb
+- spec/mamertes/option_spec.rb
+- spec/mamertes/parser_spec.rb
+- spec/spec_helper.rb
+homepage: http://sw.cow.tc/mamertes
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: mamertes
+rubygems_version: 2.0.5
+signing_key: 
+specification_version: 4
+summary: Yet another command line manager.
+test_files:
+- spec/coverage_helper.rb
+- spec/mamertes/application_spec.rb
+- spec/mamertes/command_spec.rb
+- spec/mamertes/option_spec.rb
+- spec/mamertes/parser_spec.rb
+- spec/spec_helper.rb
+has_rdoc: