bovem 2.4.1 → 3.0.0

data/spec/bovem/parser_spec.rb

@@ -0,0 +1,126 @@
+# encoding: utf-8
+#
+# This file is part of the bovem 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 Bovem::Parser do
+  let(:application) {
+    Bovem::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 = Bovem::Command.new
+    c.application = application
+    c
+  }
+
+  describe ".smart_join" do
+    it "should correctly join arrays" do
+      expect(Bovem::Parser.smart_join([])).to eq("")
+      expect(Bovem::Parser.smart_join(["A"], ", ", " and ", nil)).to eq("A")
+      expect(Bovem::Parser.smart_join(1, ", ", " and ", nil)).to eq("1")
+      expect(Bovem::Parser.smart_join(["A", 1], ", ", " and ", nil)).to eq("A and 1")
+      expect(Bovem::Parser.smart_join(["A", 1, true], ", ", " and ", nil)).to eq("A, 1 and true")
+      expect(Bovem::Parser.smart_join(["A", "B", "C"], "-", " and ", nil)).to eq("A-B and C")
+      expect(Bovem::Parser.smart_join(["A", "B", "C"], "-", "@", nil)).to eq("A-B@C")
+      expect(Bovem::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(Bovem::Parser.find_command("abc", command, args)).to eq({name: "abc", args: args})
+      expect(Bovem::Parser.find_command("abc:def", command, args)).to eq({name: "abc", args: ["def"] + args})
+      expect(Bovem::Parser.find_command("abc def", command, args, " ")).to eq({name: "abc", args: ["def"] + args})
+      expect(Bovem::Parser.find_command("d", s1, args)).to eq({name: "def", args: args})
+      expect{ Bovem::Parser.find_command("ab", command, args) }.to raise_error(Bovem::Errors::Error)
+      expect(Bovem::Parser.find_command("abc", s2, args)).to be_nil
+    end
+  end
+
+  describe ".parse" do
+    it "should instantiate a parser and then parse" do
+      expect(Bovem::Parser).to receive(:new).and_call_original
+      expect_any_instance_of(Bovem::Parser).to receive(:parse).with("COMMAND", "ARGS")
+      Bovem::Parser.parse("COMMAND", "ARGS")
+    end
+  end
+
+  describe "#parse" do
+    it "should iterate options" do
+      expect(application.options).to receive(:each_pair).exactly(2)
+      Bovem::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")
+      Bovem::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 { Bovem::Parser.parse(application, ["-b=f"]) }.to raise_error(Bovem::Errors::Error)
+      expect { Bovem::Parser.parse(application, ["-s"]) }.to raise_error(Bovem::Errors::Error)
+      expect { Bovem::Parser.parse(application, ["-i", "A"]) }.to raise_error(Bovem::Errors::Error)
+      expect { Bovem::Parser.parse(application, ["-f", "A"]) }.to raise_error(Bovem::Errors::Error)
+      expect { Bovem::Parser.parse(application, ["-c", "B"]) }.to raise_error(Bovem::Errors::Error)
+      expect { Bovem::Parser.parse(application, ["-r", "C"]) }.to raise_error(Bovem::Errors::Error)
+      expect { Bovem::Parser.parse(application, ["-R", "C"]) }.to raise_error(Bovem::Errors::Error)
+      application.option("R", [], {required: true})
+      expect { Bovem::Parser.parse(application, ["-b"]) }.to raise_error(Bovem::Errors::Error) # Because we're missing a required option
+    end
+
+    it "should complain about duplicate options" do
+      application.option(:boolean2)
+      expect { Bovem::Parser.parse(application, ["-b"]) }.to raise_error(Bovem::Errors::Error)
+    end
+
+    it "should return the command to execute" do
+      expect(Bovem::Parser.parse(application, ["a", "OTHER"])).to eq({name: "abc", args: ["OTHER"]})
+      expect(Bovem::Parser.parse(application, ["ab:d", "OTHER"])).to eq({name: "abc", args: ["d", "OTHER"]})
+      expect(Bovem::Parser.parse(application, ["abc", "d", "OTHER"])).to eq({name: "abc", args: ["d", "OTHER"]})
+      expect(Bovem::Parser.parse(application, ["d", "OTHER"])).to eq(nil)
+
+      application.clear_options
+      expect(Bovem::Parser.parse(application, ["a", "OTHER"])).to eq({name: "abc", args: ["OTHER"]})
+      expect(Bovem::Parser.parse(application, ["d:d", "OTHER"])).to eq(nil)
+      expect(Bovem::Parser.parse(application, ["d d", "OTHER"])).to eq(nil)
+      expect(Bovem::Parser.parse(application, ["d", "d", "OTHER"])).to eq(nil)
+    end
+  end
+end

data/spec/bovem/shell_spec.rb

@@ -8,7 +8,7 @@ require "spec_helper"
 
 describe Bovem::Shell do
   let(:shell) {
-    s = ::Bovem::Shell.new
+    s = Bovem::Shell.new
     s.i18n = :en
     s
   }
@@ -24,14 +24,14 @@ describe Bovem::Shell do
 
   describe ".instance" do
     it "should always return the same instance" do
-      instance = ::Bovem::Shell.instance
-      expect(::Bovem::Shell.instance).to be(instance)
+      instance = Bovem::Shell.instance
+      expect(Bovem::Shell.instance).to be(instance)
     end
   end
 
   describe "#initialize" do
     it "should correctly set defaults" do
-      expect(shell.console).to eq(::Bovem::Console.instance)
+      expect(shell.console).to eq(Bovem::Console.instance)
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bovem
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Shogun
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.3.1
+        version: 3.3.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.3.1
+        version: 3.3.5
 - !ruby/object:Gem::Dependency
   name: open4
   requirement: !ruby/object:Gem::Requirement
@@ -38,7 +38,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.3.0
-description: A collection of utilities for developers.
+description: A command line manager and a collection of utilities for developers.
 email:
 - shogun_panda@me.com
 executables: []
@@ -54,6 +54,11 @@ files:
 - Rakefile
 - bovem.gemspec
 - doc/Bovem.html
+- doc/Bovem/Application.html
+- doc/Bovem/Command.html
+- doc/Bovem/CommandMethods.html
+- doc/Bovem/CommandMethods/Children.html
+- doc/Bovem/CommandMethods/Help.html
 - doc/Bovem/Configuration.html
 - doc/Bovem/Console.html
 - doc/Bovem/ConsoleMethods.html
@@ -65,9 +70,16 @@ files:
 - doc/Bovem/ConsoleMethods/StyleHandling.html
 - doc/Bovem/ConsoleMethods/StyleHandling/ClassMethods.html
 - doc/Bovem/Errors.html
+- doc/Bovem/Errors/Error.html
 - doc/Bovem/Errors/InvalidConfiguration.html
 - doc/Bovem/Errors/InvalidLogger.html
+- doc/Bovem/Localizer.html
 - doc/Bovem/Logger.html
+- doc/Bovem/Option.html
+- doc/Bovem/Parser.html
+- doc/Bovem/ParserMethods.html
+- doc/Bovem/ParserMethods/General.html
+- doc/Bovem/ParserMethods/General/ClassMethods.html
 - doc/Bovem/Shell.html
 - doc/Bovem/ShellMethods.html
 - doc/Bovem/ShellMethods/Directories.html
@@ -91,17 +103,27 @@ files:
 - doc/method_list.html
 - doc/top-level-namespace.html
 - lib/bovem.rb
+- lib/bovem/application.rb
+- lib/bovem/command.rb
 - lib/bovem/configuration.rb
 - lib/bovem/console.rb
 - lib/bovem/errors.rb
+- lib/bovem/localizer.rb
 - lib/bovem/logger.rb
+- lib/bovem/option.rb
+- lib/bovem/parser.rb
 - lib/bovem/shell.rb
 - lib/bovem/version.rb
 - locales/en.yml
 - locales/it.yml
+- spec/bovem/application_spec.rb
+- spec/bovem/command_spec.rb
 - spec/bovem/configuration_spec.rb
 - spec/bovem/console_spec.rb
+- spec/bovem/errors_spec.rb
 - spec/bovem/logger_spec.rb
+- spec/bovem/option_spec.rb
+- spec/bovem/parser_spec.rb
 - spec/bovem/shell_spec.rb
 - spec/coverage_helper.rb
 - spec/spec_helper.rb
@@ -127,11 +149,16 @@ rubyforge_project: bovem
 rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
-summary: A collection of utilities for developers.
+summary: A command line manager and a collection of utilities for developers.
 test_files:
+- spec/bovem/application_spec.rb
+- spec/bovem/command_spec.rb
 - spec/bovem/configuration_spec.rb
 - spec/bovem/console_spec.rb
+- spec/bovem/errors_spec.rb
 - spec/bovem/logger_spec.rb
+- spec/bovem/option_spec.rb
+- spec/bovem/parser_spec.rb
 - spec/bovem/shell_spec.rb
 - spec/coverage_helper.rb
 - spec/spec_helper.rb