gli 2.0.0.rc5 → 2.0.0.rc6

data/lib/gli/commands/initconfig.rb

@@ -11,24 +11,26 @@ module GLI
       @filename = config_file_name
       super(:names => :initconfig,
             :description => "Initialize the config file using current global options",
-            :long_desc => 'Initializes a configuration file where you can set default options for command line flags, both globally and on a per-command basis.  These defaults override the built-in defaults and allow you to omit commonly-used command line flags when invoking this program')
+            :long_desc => 'Initializes a configuration file where you can set default options for command line flags, both globally and on a per-command basis.  These defaults override the built-in defaults and allow you to omit commonly-used command line flags when invoking this program',
+            :skips_pre => true,:skips_post => true, :skips_around => true)
+
+      @app_commands = commands
+      @app_flags = flags
+      @app_switches = switches
 
       self.desc 'force overwrite of existing config file'
       self.switch :force
 
-      @commands = commands
-      @flags = flags
-      @switches = switches
-    end
-
-    def execute(global_options,options,arguments)
-      if options[:force] || !File.exist?(@filename)
-        create_config(global_options,options,arguments)
-      else
-        raise "Not overwriting existing config file #{@filename}, use --force to override"
+      action do |global_options,options,arguments|
+        if options[:force] || !File.exist?(@filename)
+          create_config(global_options,options,arguments)
+        else
+          raise "Not overwriting existing config file #{@filename}, use --force to override"
+        end
       end
     end
 
+
   private
 
     def create_config(global_options,options,arguments)
@@ -40,10 +42,10 @@ module GLI
         end
       }]
       config[COMMANDS_KEY] = {}
-      @commands.each do |name,command|
+      @app_commands.each do |name,command|
         if (command != self) && (name != :rdoc) && (name != :help)
           if command != self
-            config[COMMANDS_KEY][name.to_sym] = config_for_command(@commands,name.to_sym)
+            config[COMMANDS_KEY][name.to_sym] = config_for_command(@app_commands,name.to_sym)
           end
         end
       end

data/lib/gli/commands/rdoc_document_listener.rb

@@ -0,0 +1,112 @@
+require 'stringio'
+module GLI
+  module Commands
+    class RdocDocumentListener
+
+      def initialize(global_options,options,arguments)
+        @io = File.new(File.basename($0) + ".rdoc",'w')
+        @nest = ''
+      end
+
+      def beginning
+      end
+
+      # Called when processing has completed
+      def ending
+        @io.close
+      end
+
+      # Gives you the program description
+      def program_desc(desc)
+        @io.puts "== #{File.basename($0)} - #{desc}"
+        @io.puts
+      end
+
+      # Gives you the program version
+      def version(version)
+        @io.puts "v#{version}"
+        @io.puts
+      end
+
+      def options
+        if @nest.size == 0
+          @io.puts "=== Global Options"
+        else
+          @io.puts "#{@nest}=== Options"
+        end
+      end
+
+      # Gives you a flag in the current context
+      def flag(name,aliases,desc,long_desc,default_value,arg_name,must_match,type)
+        usage = "#{add_dashes(name)} #{arg_name || 'arg'}"
+        @io.puts "#{@nest}=== #{usage}"
+        @io.puts
+        @io.puts String(desc).strip
+        @io.puts
+        @io.puts "[Aliases] #{aliases.map { |_| add_dashes(_) }.join(',')}" unless aliases.empty?
+        @io.puts "[Default Value] #{default_value || 'None'}"
+        @io.puts "[Must Match] #{must_match.to_s}" unless must_match.nil?
+        @io.puts String(long_desc).strip
+        @io.puts
+      end
+
+      # Gives you a switch in the current context
+      def switch(name,aliases,desc,long_desc,negetable)
+        if negetable
+          name = "[no-]#{name}" if name.length > 1
+          aliases = aliases.map { |_|  _.length > 1 ? "[no-]#{_}" : _ } 
+        end
+        @io.puts "#{@nest}=== #{add_dashes(name)}"
+        @io.puts String(desc).strip
+        @io.puts
+        @io.puts "[Aliases] #{aliases.map { |_| add_dashes(_) }.join(',')}\n" unless aliases.empty?
+        @io.puts
+        @io.puts String(long_desc).strip
+        @io.puts
+      end
+
+      def end_options
+      end
+
+      def commands
+        @io.puts "#{@nest}=== Commands"
+        @nest = "#{@nest}="
+      end
+
+      # Gives you a command in the current context and creates a new context of this command
+      def command(name,aliases,desc,long_desc,arg_name)
+        @io.puts "#{@nest}=== #{name} #{arg_name}"
+        @io.puts String(desc).strip
+        @io.puts 
+        @io.puts "[Aliases] #{aliases.join(',')}\n" unless aliases.empty?
+        @io.puts 
+        @io.puts String(long_desc).strip
+        @nest = "#{@nest}="
+      end
+
+      # Ends a command, and "pops" you back up one context
+      def end_command(name)
+        @nest.gsub!(/=$/,'')
+      end
+
+      # Gives you the name of the current command in the current context
+      def default_command(name)
+        @io.puts "[Default Command] #{name}" unless name.nil?
+      end
+
+      def end_commands
+        @nest.gsub!(/=$/,'')
+      end
+
+    private
+
+      def add_dashes(name)
+        name = "-#{name}"
+        name = "-#{name}" if name.length > 2
+        name
+      end
+
+
+    end
+  end
+end

data/lib/gli/commands/scaffold.rb

@@ -273,7 +273,6 @@ EOS
             file.chmod(0755)
             file.puts '#!/usr/bin/env ruby'
             file.puts <<EOS
-require 'rubygems'
 require 'gli'
 begin # XXX: Remove this begin/rescue before distributing your app
 require '#{project_name}'

data/lib/gli/options.rb

@@ -15,6 +15,9 @@ module GLI
       @table[k.to_sym] = v
     end
 
+    def map(&block)
+      @table.map(&block)
+    end
   end
 end
 

data/lib/gli/switch.rb

@@ -5,6 +5,7 @@ module GLI
   class Switch < CommandLineOption #:nodoc:
 
     attr_accessor :default_value
+    attr_reader :negatable
 
     # Creates a new switch
     #

data/lib/gli/version.rb

@@ -1,5 +1,5 @@
 module GLI
   unless const_defined? :VERSION
-    VERSION = '2.0.0.rc5' #:nodoc:
+    VERSION = '2.0.0.rc6' #:nodoc:
   end
 end

data/test/roodi.yaml

@@ -15,4 +15,4 @@ MethodNameCheck:
 ModuleNameCheck:                 
   pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/
 ParameterNumberCheck:
-  parameter_count: 5
+  parameter_count: 8

data/test/tc_doc.rb

@@ -0,0 +1,315 @@
+require 'test_helper'
+require 'pp'
+
+class String
+  def blank?
+    self.strip.length == 0
+  end
+end
+
+class NilClass
+  def blank?
+    true
+  end
+end
+
+class Object
+  def blank?
+    false
+  end
+end
+
+class TC_testDoc < Clean::Test::TestCase
+  include TestHelper
+
+  class TestApp
+    include GLI::App
+  end
+
+  class TestListener
+    @@last = nil
+    def self.last
+      @@last
+    end
+    def initialize(*ignored)
+      @stringio = StringIO.new
+      @indent = ''
+      @@last = self
+    end
+    def options
+    end
+    def end_options
+    end
+    def commands
+    end
+    def end_commands
+    end
+    def beginning
+      @stringio << 'BEGIN' << "\n"
+    end
+
+    def ending
+      @stringio << 'END' << "\n"
+    end
+
+    def program_desc(desc)
+      @stringio << desc << "\n"
+    end
+
+    def version(version)
+      @stringio << version << "\n"
+    end
+
+    def default_command(name)
+      @stringio << @indent << "default_command: " << name << "\n"
+    end
+
+    def flag(name,aliases,desc,long_desc,default_value,arg_name,must_match,type)
+      @stringio << @indent << "flag: " << name << "\n"
+      @indent += '  '
+      @stringio << @indent << "aliases: " << aliases.join(',') << "\n"   unless aliases.empty?
+      @stringio << @indent << "desc: " << desc << "\n"                   unless desc.blank?
+      @stringio << @indent << "long_desc: " << long_desc << "\n"         unless long_desc.blank?
+      @stringio << @indent << "default_value: " << default_value << "\n" unless default_value.blank?
+      @stringio << @indent << "arg_name: " << arg_name << "\n"           unless arg_name.blank?
+      @indent.gsub!(/  $/,'')
+    end
+
+    def switch(name,aliases,desc,long_desc,negatable)
+      @stringio << @indent << "switch: " << name << "\n"
+      @indent += '  '
+      @stringio << @indent << "aliases: " << aliases.join(',') << "\n"   unless aliases.empty?
+      @stringio << @indent << "desc: " << desc << "\n"                   unless desc.blank?
+      @stringio << @indent << "long_desc: " << long_desc << "\n"         unless long_desc.blank?
+      @stringio << @indent << "negatable: " << negatable << "\n"         unless negatable.blank?
+      @indent.gsub!(/  $/,'')
+    end
+
+    def command(name,aliases,desc,long_desc,arg_name)
+      @stringio << @indent << "command: " << name << "\n"
+      @indent += '  '
+      @stringio << @indent << "aliases: " << aliases.join(',') << "\n"   unless aliases.empty?
+      @stringio << @indent << "desc: " << desc << "\n"                   unless desc.blank?
+      @stringio << @indent << "long_desc: " << long_desc << "\n"         unless long_desc.blank?
+      @stringio << @indent << "arg_name: " << arg_name << "\n"           unless arg_name.blank?
+    end
+
+    def end_command(name)
+      @indent.gsub!(/  $/,'')
+      @stringio << @indent << "end #{name}" << "\n"
+    end
+
+    def to_s
+      @stringio.string
+    end
+  end
+
+  def setup
+    @@counter = -1 # we pre-increment so this makes 0 first
+  end
+
+  test_that "a GLI app with documentation gets the callbacks for each element" do
+    Given :the_test_app
+    And :the_expected_output
+    And {
+      @documenter = GLI::Commands::Doc.new(@app)
+      @listener = TestListener.new
+    }
+    When {
+      @documenter.document(@listener)
+    }
+    Then {
+      lines_expected = @string.split(/\n/)
+      lines_got = @listener.to_s.split(/\n/)
+      lines_expected.zip(lines_got).each_with_index do |(expected,got),index|
+        assert_equal expected,got,"At index #{index}"
+      end
+    }
+  end
+
+  test_that "the doc command works as a GLI command" do
+    Given :the_test_app
+    And :the_expected_output
+    And {
+      @documenter = GLI::Commands::Doc.new(@app)
+      @listener = TestListener.new
+    }
+    When {
+      @documenter.execute({},{:format => "TC_testDoc::TestListener"},[])
+    }
+    Then {
+      lines_expected = @string.split(/\n/)
+      lines_got = TestListener.last.to_s.split(/\n/)
+      lines_expected.zip(lines_got).each_with_index do |(expected,got),index|
+        assert_equal expected,got,"At index #{index}"
+      end
+    }
+  end
+
+private
+
+  @@counter = 1
+  def self.counter
+    @@counter += 1
+    @@counter
+  end
+
+  def the_test_app
+    @app = TestApp.new
+    @app.instance_eval do
+      program_desc "program desc"
+      version "1.3.4"
+
+      TC_testDoc.flag_with_everything_specified(self)
+      TC_testDoc.flag_with_everything_omitted(self)
+      TC_testDoc.switch_with_everything_specified(self)
+      TC_testDoc.switch_with_everything_omitted(self)
+
+      desc      "command desc"
+      long_desc "command long desc"
+      arg_name  "cmd_arg_name"
+      command [:command1,:com1] do |c|
+        TC_testDoc.flag_with_everything_specified(c)
+        TC_testDoc.flag_with_everything_omitted(c)
+        TC_testDoc.switch_with_everything_specified(c)
+        TC_testDoc.switch_with_everything_omitted(c)
+
+        c.desc      "subcommand desc"
+        c.long_desc "subcommand long desc"
+        c.arg_name  "subcmd_arg_name"
+        c.action { |g,o,a| }
+        c.command [:sub,:subcommand] do |sub|
+          TC_testDoc.flag_with_everything_specified(sub,:subflag)
+          TC_testDoc.flag_with_everything_omitted(sub,:subflag2)
+          TC_testDoc.switch_with_everything_specified(sub,:subswitch)
+          TC_testDoc.switch_with_everything_omitted(sub,:subswitch2)
+          sub.action { |g,o,a| }
+        end
+        c.command [:default] do |sub|
+          sub.action { |g,o,a| }
+        end
+        c.default_command :default
+      end
+
+      command [:command2,:com2] do |c|
+        c.action { |g,o,a| }
+        c.command [:sub2,:subcommand2] do |sub|
+          sub.action { |g,o,a| }
+        end
+      end
+    end
+  end
+
+  def self.flag_with_everything_specified(on,name=[:f,:flag])
+    on.flag name,:desc          => "flag desc #{counter}",
+                 :long_desc     => "flag long_desc #{counter}",
+                 :default_value => "flag default_value #{counter}",
+                 :arg_name      => "flag_arg_name_#{counter}",
+                 :must_match    => /foo.*bar/,
+                 :type          => Array
+  end
+
+  def self.flag_with_everything_omitted(on,name=[:F,:flag2])
+    on.flag name
+  end
+
+  def self.switch_with_everything_specified(on,name=[:s,:switch])
+    on.switch name, :desc      => "switch desc #{counter}",
+                    :long_desc => "switch long_desc #{counter}",
+                    :negatable => false
+  end
+
+  def self.switch_with_everything_omitted(on,name=[:S,:switch2])
+    on.switch name
+  end
+  def the_expected_output
+    # Oh yeah.  Creating a string representing the structure of the calls.
+    @string =<<EOS
+BEGIN
+program desc
+1.3.4
+flag: F
+  aliases: flag2
+  arg_name: arg
+flag: f
+  aliases: flag
+  desc: flag desc 0
+  long_desc: flag long_desc 1
+  default_value: flag default_value 2
+  arg_name: flag_arg_name_3
+switch: S
+  aliases: switch2
+  negatable: true
+switch: s
+  aliases: switch
+  desc: switch desc 4
+  long_desc: switch long_desc 5
+  negatable: false
+switch: version
+  negatable: false
+command: command1
+  aliases: com1
+  desc: command desc
+  long_desc: command long desc
+  arg_name: cmd_arg_name
+  flag: F
+    aliases: flag2
+    arg_name: arg
+  flag: f
+    aliases: flag
+    desc: flag desc 6
+    long_desc: flag long_desc 7
+    default_value: flag default_value 8
+    arg_name: flag_arg_name_9
+  switch: S
+    aliases: switch2
+    negatable: true
+  switch: s
+    aliases: switch
+    desc: switch desc 10
+    long_desc: switch long_desc 11
+    negatable: false
+  command: default
+    default_command: 
+  end default
+  command: sub
+    aliases: subcommand
+    desc: subcommand desc
+    long_desc: subcommand long desc
+    arg_name: subcmd_arg_name
+    flag: subflag
+      desc: flag desc 12
+      long_desc: flag long_desc 13
+      default_value: flag default_value 14
+      arg_name: flag_arg_name_15
+    flag: subflag2
+      arg_name: arg
+    switch: subswitch
+      desc: switch desc 16
+      long_desc: switch long_desc 17
+      negatable: false
+    switch: subswitch2
+      negatable: true
+    default_command: 
+  end sub
+  default_command: default
+end command1
+command: command2
+  aliases: com2
+  command: sub2
+    aliases: subcommand2
+    default_command: 
+  end sub2
+  default_command: 
+end command2
+command: help
+  desc: Shows a list of commands or help for one command
+  long_desc: Gets help for the application or its commands. Can also list the commands in a way helpful to creating a bash-style completion function
+  arg_name: command
+  default_command: 
+end help
+default_command: 
+END
+EOS
+  end
+end