clive 0.1.1 → 0.2.0

data/README.md

@@ -34,6 +34,26 @@ This creates a very simple interface which can have one switch, you can then use
 
 As we've seen above switches are created using #switch. You can provide as little information as you want. `switch(:v) {}` creates a switch that responds only to `-v`, or `switch(:verbose) {}` creates a switch that only responds to `--verbose`.
 
+### Boolean
+
+Boolean switches allow you to accept arguments like `--no-verbose` and `--verbose`, and deal with both situations in the same block.
+
+    c = Clive.new do
+      boolean(:v, :verbose) {|i| p i}
+    end
+    c.parse(ARGV)
+    
+    ####
+    
+    my_file --verbose
+    #=> true
+    my_file -v
+    #=> true
+    my_file --no-verbose
+    #=> false
+
+As you can see the true case can be triggered with the short or long form, the false case can be triggered by appending "no-" to the long form, and it can't be triggered with a short form.
+
 ### Flags
 
 Flags are like switches but also take an argument:

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/clive.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{clive}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Joshua Hawxwell"]
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
      "VERSION",
      "clive.gemspec",
      "lib/clive.rb",
+     "lib/clive/booleans.rb",
      "lib/clive/commands.rb",
      "lib/clive/ext.rb",
      "lib/clive/flags.rb",

data/lib/clive.rb

@@ -5,6 +5,7 @@ require 'clive/ext'
 require 'clive/switches'
 require 'clive/flags'
 require 'clive/commands'
+require 'clive/booleans'
 
 # Clive is a simple dsl for creating command line interfaces
 #
@@ -43,3 +44,4 @@ class Clive
   end
   
 end
+

data/lib/clive/booleans.rb

@@ -0,0 +1,35 @@
+class Clive
+  
+  # A switch which can be triggered with either --no-verbose or --verbose
+  # for example.
+  class Boolean < Switch
+    attr_accessor :truth
+    
+    def initialize(short, long, desc, truth, &block)
+      @short = short
+      @long = long
+      @desc = desc
+      @truth = truth
+      @block = block
+    end
+    
+    def run
+      @block.call(@truth)
+    end
+    
+    # @return [String] summary for help or nil if +@truth = false+
+    def summary(width=30, prepend=5)
+      return nil unless @truth
+      a = ""
+      a << "-#{@short}" if @short
+      a << ", " if @short && @long
+      a << "--[no-]#{@long}" if @long
+      b = @desc
+      s, p = '', ''
+      (0..width-a.length).each {s << ' '}
+      (0..prepend).each {p << ' '}
+      "#{p}#{a}#{s}#{b}"
+    end
+  
+  end
+end

data/lib/clive/commands.rb

@@ -156,7 +156,7 @@ class Clive
       tokens
     end
     
-    #### CREATION HELPERS #### 
+  #### CREATION HELPERS #### 
     
     # Add a new switch to +@switches+
     #
@@ -169,7 +169,7 @@ class Clive
     # @yield A block to run if the switch is triggered
     #
     def switch(*args, &block)
-      short, long, desc = nil, nil, nil
+      short, long, desc = nil
       args.each do |i|
         if i.is_a? String
           desc = i
@@ -193,7 +193,7 @@ class Clive
     #   and flags
     #
     def command(*args, &block)
-      name, desc = nil, nil
+      name, desc = nil
       args.each do |i|
         if i.is_a? String
           desc = i
@@ -214,7 +214,7 @@ class Clive
     #
     # @yield [String] A block to be run if switch is triggered
     def flag(*args, &block)
-      short, long, desc = nil, nil, nil
+      short, long, desc = nil
       args.each do |i|
         if i.is_a? String
           desc = i
@@ -227,7 +227,34 @@ class Clive
       @flags << Flag.new(short, long, desc, &block)
     end
     
-    #### HELP STUFF ####
+    # Creates a boolean switch. This is done by adding two switches of
+    # Boolean type to +@switches+, one is created normally the other has
+    # "no-" appended to the long name and has no short name.
+    #
+    # @overload boolean(short, long, desc, &block)
+    #   Creates a new boolean switch
+    #   @param [Symbol] short single character for short label
+    #   @param [Symbol] long longer name to be used
+    #   @param [String] desc the description of the boolean
+    #
+    # @yield [Boolean] A block to be run if switch is triggered
+    def boolean(*args, &block)
+      short, long, desc = nil
+      args.each do |i|
+        if i.is_a? String
+          desc = i
+        elsif i.length == 1
+          short = i.to_s
+        else
+          long = i.to_s
+        end
+      end
+      raise "Boolean switch must have long name" unless long
+      @switches << Boolean.new(short, long, desc, true, &block)
+      @switches << Boolean.new(nil, "no-#{long}", desc, false, &block)
+    end
+    
+  #### HELP STUFF ####
     
     # This actually creates a switch with "-h" and "--help" that control
     # the help on this command. If this is the base class it will also 
@@ -259,7 +286,7 @@ class Clive
       if @switches.length > 0 || @flags.length > 0
         summary << "\n Options:\n"
         @switches.each do |i|
-          summary << i.summary(width, prepend) << "\n"
+          summary << i.summary(width, prepend) << "\n" if i.summary
         end
         @flags.each do |i|
           summary << i.summary(width, prepend) << "\n"

data/test/test_clive.rb

@@ -14,7 +14,7 @@ class TestClive < Test::Unit::TestCase
     c = Clive.new do
       switch(:v) {}
     end
-    assert_equal 1, c.switches.length
+    assert_equal 2, c.switches.length # plus help
     assert_instance_of Clive::Switch, c.switches[0]
   end
   
@@ -26,6 +26,14 @@ class TestClive < Test::Unit::TestCase
     assert_instance_of Clive::Command, c.commands[0]
   end
   
+  should "create boolean" do
+    c = Clive.new do
+      boolean(:verbose) {}
+    end
+    assert_equal 3, c.switches.length # plus help
+    assert_instance_of Clive::Boolean, c.switches[0]
+  end
+  
   context "When parsing input" do
   
     should "recognise flags with equals" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: clive
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Joshua Hawxwell
@@ -64,6 +64,7 @@ files:
 - VERSION
 - clive.gemspec
 - lib/clive.rb
+- lib/clive/booleans.rb
 - lib/clive/commands.rb
 - lib/clive/ext.rb
 - lib/clive/flags.rb