clive 0.1.0 → 0.1.1

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/clive.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{clive}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Joshua Hawxwell"]
+  s.date = %q{2010-08-14}
+  s.description = %q{Clive is a DSL for creating a command line interface. It is for people who, like me, love OptionParser's syntax and love GLI's commands.}
+  s.email = %q{m@hawx.me}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "clive.gemspec",
+     "lib/clive.rb",
+     "lib/clive/commands.rb",
+     "lib/clive/ext.rb",
+     "lib/clive/flags.rb",
+     "lib/clive/switches.rb",
+     "lib/clive/tokens.rb",
+     "test/bin_test",
+     "test/helper.rb",
+     "test/test_clive.rb"
+  ]
+  s.homepage = %q{http://github.com/hawx/clive}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Imagine if optparse and gli had a son called clive.}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_clive.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

data/lib/clive/commands.rb

@@ -9,6 +9,7 @@ class Clive
     attr_accessor :switches, :flags, :commands
     attr_accessor :name, :desc, :block, :argv
     attr_accessor :base
+    attr_accessor :banner
     
     # Create a new Command instance
     #
@@ -44,6 +45,12 @@ class Clive
         end
         @block = block
       end
+      
+      @banner = "Usage: #{File.basename($0, '.*')} "
+      @banner << (@base ? "[commands]" : @name)
+      @banner << " [options]"
+      
+      self.build_help
     end
     
     # Run the block that was passed to find switches, flags, etc.
@@ -62,7 +69,7 @@ class Clive
     # @param [Array] argv the command line input, usually just ARGV
     # @return [Array] any arguments that were present in the input but not used
     #
-    def run(argv)
+    def run(argv=[])
       tokens = argv
       tokens = tokenize(argv) if @base
       
@@ -220,5 +227,55 @@ class Clive
       @flags << Flag.new(short, long, desc, &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 
+    # creates a "help [command]" command.
+    def build_help
+      @switches << Switch.new("h", "help", "Display help") {puts self.help}
+    end
+    
+    # Set the banner
+    def banner(val)
+      @banner = val
+    end
+    
+    def summary(width=30, prepend=5)
+      a = @name
+      b = @desc
+      s, p = '', ''
+      (0..width-a.length).each {s << ' '}
+      (0..prepend).each {p << ' '}
+      "#{p}#{a}#{s}#{b}"
+    end
+    
+    # Generate the summary for help, show all flags and switches, but do not
+    # show the flags and switches within each command. Should also prepend the
+    # banner.
+    def help(width=30, prepend=5)
+      summary = "#{@banner}\n"
+      
+      if @switches.length > 0 || @flags.length > 0
+        summary << "\n Options:\n"
+        @switches.each do |i|
+          summary << i.summary(width, prepend) << "\n"
+        end
+        @flags.each do |i|
+          summary << i.summary(width, prepend) << "\n"
+        end
+      end
+      
+      if @commands.length > 0
+        summary << "\nCommands:\n"
+        @commands.each do |i|
+          summary << i.summary(width, prepend) << "\n"
+        end
+      end
+     
+      summary
+    end
+    
+    
   end
 end

data/lib/clive/switches.rb

@@ -19,6 +19,19 @@ class Clive
       @block.call
     end
     
+    # @return [String] summary for help
+    def summary(width=30, prepend=5)
+      a = ""
+      a << "-#{@short}" if @short
+      a << ", " if @short && @long
+      a << "--#{@long}" if @long
+      b = @desc
+      s, p = '', ''
+      (0..width-a.length).each {s << ' '}
+      (0..prepend).each {p << ' '}
+      "#{p}#{a}#{s}#{b}"
+    end
+    
   end
   
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: clive
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Joshua Hawxwell
@@ -62,6 +62,7 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- clive.gemspec
 - lib/clive.rb
 - lib/clive/commands.rb
 - lib/clive/ext.rb