clive 0.6.2 → 0.7.0

data/spec/clive/exceptions_spec.rb

@@ -0,0 +1 @@
+require 'spec_helper'

data/spec/clive/ext_spec.rb

@@ -0,0 +1 @@
+require 'spec_helper'

data/spec/clive/flag_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe Clive::Flag do
+
+  subject { Clive::Flag.new([:S, :say], "Say something", ["WORD(S)"]) {|i| puts i } }
+
+  it_behaves_like "an option"
+  
+  describe "#args" do
+    it "returns a hash with argument(s)" do
+      subject.args.should == [{:name => "WORD(S)", :optional => false}]
+    end
+  end
+
+  describe "#run" do
+    it "calls the block with the argument" do
+      $stdout.should_receive(:puts).with("hey")
+      subject.run(["hey"])
+    end
+  end
+  
+  describe "#arg_num" do
+    it "returns the number of arguments" do
+      subject.arg_num(false).should == 1
+    end
+  end
+  
+  describe "#args_to_strings" do
+    it "converts the arguments to strings" do
+      subject.args_to_strings.should == ["WORD(S)"]
+    end
+  end
+  
+  describe "#arg_size" do
+    context "when choice is available" do
+      it "returns 1" do
+        subject.args = 1..5
+        subject.arg_size.should == 1
+      end
+    end
+    
+    context "when arguments are required" do
+      it "returns the number of arguments" do
+        subject.args = [{:name => "ARG", :optional => false}]
+        subject.arg_size.should == 1
+      end
+    end
+  end
+  
+  describe "#options_to_strings" do
+    context "when @args is a range" do
+      it "returns array with range as string" do
+        subject.args = 1..4
+        subject.options_to_strings.should == ["1..4"]
+      end
+    end
+    
+    context "when @args is a hash" do
+      it "converts the options to strings" do
+        subject.options_to_strings.should == [""]
+      end
+    end
+    
+    context "when @args is an array" do
+      it "returns the array" do
+        subject.args = %w(1 2 3 4)
+        subject.options_to_strings.should == %w(1 2 3 4)
+      end
+    end
+  end
+  
+  describe "#to_h" do
+    it "returns a hash" do
+      hsh = {
+        "names" => Clive::Array.new(%w(-S --say)),
+        "desc"  => "Say something",
+        "args"  => Clive::Array.new(["WORD(S)"]),
+        "options" => Clive::Array.new([""])
+      }
+      subject.to_h.should == hsh
+    end
+  end
+  
+end

data/spec/clive/formatter_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+
+describe Clive::Formatter do
+
+  describe Clive::Formatter::Obj do
+    subject { Clive::Formatter::Obj.new({:test => 5}) }
+    
+    describe "#initialize" do
+      it "defines methods given by hash" do
+        subject.test.should == 5
+      end
+    end
+    
+    describe "#evaluate" do
+      it "evaluates code within the object" do
+        $stdout.should_receive(:puts).with(5)
+        subject.evaluate("puts test")
+      end
+    end
+  end
+  
+  
+  subject { Clive::Formatter.new(30, 5) }
+  
+  
+  describe "#switch" do
+    it "sets format for switches" do
+      subject.switch("{desc}")
+      subject.instance_variable_get("@switch").should == "{desc}"
+    end
+  end
+  
+  describe "#bool" do
+    it "sets format for bools" do
+      subject.bool "{desc}"
+      subject.instance_variable_get("@bool").should == "{desc}"
+    end
+  end
+  
+  describe "#flag" do
+    it "sets format for flags" do
+      subject.flag "{desc}"
+      subject.instance_variable_get("@flag").should == "{desc}"
+    end
+  end
+  
+  describe "#command" do
+    it "sets format for commands" do
+      subject.command "{desc}"
+      subject.instance_variable_get("@command").should == "{desc}"
+    end
+  end
+  
+  
+  describe "#format" do
+    it "generates the help" do
+      formatter = Clive::Command.new(true).help_formatter(:white)
+      options = [
+        Clive::Switch.new([:t, :test], "A test switch"),
+        Clive::Bool.new([:boolean], "A bool", true),
+        Clive::Bool.new([:boolean], "A bool", false),
+        Clive::Flag.new([:args], "With args", ["ARG [OPT]"]),
+        Clive::Flag.new([:choose], "With options", [["a", "b", "c"]])
+      ]
+      command = Clive::Command.new(:command, "A command")
+      result = <<EOS
+head
+
+  Commands: 
+     command                  A command
+
+  Options: 
+     -t, --test               A test switch
+     --[no-]boolean           A bool
+     --args ARG [OPT]         With args \e[1m\e[0m
+     --choose                 With options \e[1m(a, b, c)\e[0m
+
+foot
+EOS
+      
+      formatter.format("head", "foot", [command], options).should == result
+    end
+  end
+  
+  
+  describe "#parse" do
+    it "parses before and after '{spaces}' separately" do
+      args = {"name" => "a", "desc" => "something"}
+      subject.should_receive(:parse_format).with("{name}", args).and_return("")
+      subject.should_receive(:parse_format).with("{desc}", args).and_return("")
+      subject.parse("{name}{spaces}{desc}", args)
+    end
+    
+    it "calculates the correct number of spaces" do
+      args = {"name" => "a long name", "desc" => "|a short desc"}
+      subject.parse("{name}{spaces}{desc}", args).split('|')[0].size.should == 30
+    end
+  end
+  
+  describe "#parse_format" do
+    it "inserts the arguments into the format" do
+      subject.parse_format(
+        "{desc}{name}", {'desc' => 'a', 'name' => 'b'}
+      ).should == "ab"
+    end
+  end
+
+end

data/spec/clive/option_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Clive::Option do
+  subject { Clive::Option.new([:n, :names], "A test option") { puts "hi" } }
+
+  it_behaves_like "an option"
+  
+  describe "#run" do
+    it "calls the block" do
+      $stdout.should_receive(:puts).with("hi")
+      subject.run
+    end
+  end
+  
+  describe "#sort_name" do
+    it "returns the name to sort by" do
+      subject.sort_name.should == 'n'
+    end
+  end
+  
+  describe "#<=>" do
+    it "sorts by #sort_name" do
+      other = Clive::Option.new([:z, :apple], "Another") {}
+      (subject <=> other).should == -1
+    end
+  end
+  
+  describe "#to_h" do
+    it "returns a hash for help" do
+      hsh = {"names" => subject.names_to_strings, "desc" => subject.desc}
+      subject.to_h.should == hsh
+    end
+  end
+end

data/spec/clive/output_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Clive::Output do
+
+end

data/spec/clive/parser_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+describe Clive::Parser do
+
+  subject {
+    class CLI
+      include Clive::Parser
+    end
+    CLI
+  }
+  
+  it "keeps track of its class" do
+    subject.instance_variable_get("@klass").should == CLI
+  end
+  
+  describe "#base" do
+    it "has a 'base' command" do
+      subject.base.should be_kind_of Clive::Command
+    end
+  end
+  
+  describe "#parse" do
+    it "should call #run on 'base'" do
+      subject.base.should_receive(:run).with([])
+      subject.parse([])
+    end
+  end
+  
+  describe "#flag" do
+    it "adds a new flag to 'base'" do
+      expect {
+        subject.flag(:t, :test, :arg => "NAME") {|i| puts i }
+      }.should change {subject.base.flags.size}.by(1)
+    end
+  end
+  
+  describe "#switch" do
+    it "adds a new switch to 'base'" do
+      expect {
+        subject.switch(:t, :test) {}
+      }.should change {subject.base.switches.size}.by(1)
+    end
+  end
+
+  describe "#command" do
+    it "adds a new command to 'base'" do
+      expect {
+        subject.command(:command) {}
+      }.should change {subject.base.commands.size}.by(1)
+    end
+  end
+  
+  describe "#bool" do
+    it "adds a new bool to 'base'" do
+      expect {
+        subject.bool(:boo) {}
+      }.should change {subject.base.bools.size}.by(2)
+    end
+  end
+  
+  describe "#desc" do
+    it "sets current desc for 'base'" do
+      subject.desc "test"
+      subject.base.instance_variable_get("@current_desc").should == "test"
+    end
+  end
+  
+  describe "#help_formatter" do
+    it "sets the help formatter for 'base'" do
+      subject.base.should_receive(:help_formatter).with(:white)
+      subject.help_formatter(:white)
+    end
+  end
+  
+  describe "#option_var" do
+    before { subject.option_var(:test, 1) }
+  
+    it "creates a getter" do
+      subject.should respond_to :test
+    end
+    
+    it "creates a setter" do
+      subject.should respond_to :test=
+      subject.test = 2
+    end
+    
+    it "sets a default value" do
+      subject.test.should == 1
+    end
+  end
+  
+  describe "#option_hash" do
+    it "uses #option_var with empty hash" do
+      subject.should_receive(:option_var).with(:test, {})
+      subject.option_hash(:test)
+    end
+  end
+  
+  describe "#option_array" do
+    it "uses #option_var with empty array" do
+      subject.should_receive(:option_var).with(:test, [])
+      subject.option_array(:test)
+    end
+  end
+
+end

data/spec/clive/switch_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Clive::Switch do
+  subject { Clive::Switch.new([:n, :names], "A description") { puts "hi" } }
+
+  it_behaves_like "an option"
+  
+  describe "#run" do
+    it "calls the block" do
+      $stdout.should_receive(:puts).with("hi")
+      subject.run
+    end
+  end
+end

data/spec/clive/tokens_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Clive::Tokens do
+
+  subject { Clive::Tokens.new %w(word --long -sa) }
+  
+  
+  describe "#array" do
+    it "returns array of strings" do
+      subject.array.should == ["word", "--long", "-s", "-a"]
+    end
+  end
+  
+  describe "#tokens" do
+    it "returns array of tokens" do
+      subject.tokens.should == [[:word, "word"], [:long, "long"], [:short, "s"], [:short, "a"]]
+    end
+  end
+  
+  describe "#<<" do
+    subject { Clive::Tokens.new }
+    
+    context "when adding token" do
+      it "adds as a string" do
+        subject << [:long, "test"]
+        subject.tokens.should == [[:long, "test"]]
+      end
+    end
+    
+    context "when adding string" do
+      it "adds normally" do
+        subject << "--test"
+        subject.tokens.should == [[:long, "test"]]
+      end
+    end
+  end
+  
+end

data/spec/shared_specs.rb

@@ -0,0 +1,16 @@
+shared_examples_for "an option" do
+
+  describe "#names" do
+    specify { subject.names.should be_kind_of(Array) }
+    specify { subject.names.each {|i| i.should be_kind_of(String) } }
+  end
+  
+  describe "#desc" do
+    specify { subject.desc.should be_kind_of(String) }
+  end
+
+  describe "#block" do
+    specify { subject.block.should be_kind_of(Proc) }
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+# $: << File.join(File.dirname(__FILE__), '..')
+# $: << File.dirname(__FILE__)
+require 'duvet'
+Duvet.start :filter => 'clive/lib'
+
+require 'rspec'
+require 'clive'
+require 'shared_specs'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 6
-  - 2
-  version: 0.6.2
+  - 7
+  - 0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Joshua Hawxwell
@@ -14,11 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-21 00:00:00 +00:00
+date: 2011-01-06 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
-description: "    Clive is a DSL for creating a command line interface. It is for people \n    who, like me, love OptionParser's syntax and love GLI's commands.\n"
+description: "    Clive provides a DSL for building command line interfaces. It allows \n    you to define commands, switches, flags (switches with options) and \n    boolean switches, it then parses the input and runs the correct blocks.\n"
 email: m@hawx.me
 executables: []
 
@@ -35,6 +35,7 @@ files:
 - lib/clive/exceptions.rb
 - lib/clive/ext.rb
 - lib/clive/flag.rb
+- lib/clive/formatter.rb
 - lib/clive/option.rb
 - lib/clive/output.rb
 - lib/clive/parser.rb
@@ -42,6 +43,19 @@ files:
 - lib/clive/tokens.rb
 - lib/clive/version.rb
 - lib/clive.rb
+- spec/clive/bool_spec.rb
+- spec/clive/command_spec.rb
+- spec/clive/exceptions_spec.rb
+- spec/clive/ext_spec.rb
+- spec/clive/flag_spec.rb
+- spec/clive/formatter_spec.rb
+- spec/clive/option_spec.rb
+- spec/clive/output_spec.rb
+- spec/clive/parser_spec.rb
+- spec/clive/switch_spec.rb
+- spec/clive/tokens_spec.rb
+- spec/shared_specs.rb
+- spec/spec_helper.rb
 has_rdoc: false
 homepage: http://github.com/hawx/clive
 licenses: []
@@ -73,6 +87,18 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Imagine if optparse and gli had a son called clive.
-test_files: []
-
+summary: A DSL for building command line interfaces.
+test_files: 
+- spec/clive/bool_spec.rb
+- spec/clive/command_spec.rb
+- spec/clive/exceptions_spec.rb
+- spec/clive/ext_spec.rb
+- spec/clive/flag_spec.rb
+- spec/clive/formatter_spec.rb
+- spec/clive/option_spec.rb
+- spec/clive/output_spec.rb
+- spec/clive/parser_spec.rb
+- spec/clive/switch_spec.rb
+- spec/clive/tokens_spec.rb
+- spec/shared_specs.rb
+- spec/spec_helper.rb