gli 2.5.6 → 2.6.0.rc1

data/lib/gli/option_parser_factory.rb

@@ -1,27 +1,47 @@
 module GLI
   # Factory for creating an OptionParser based on app configuration and DSL calls
   class OptionParserFactory
+
+    # Create an option parser factory for a command.  This has the added
+    # feature of setting up -h and --help on the command if those
+    # options aren't otherwise configured, e.g. to allow todo add --help as an
+    # alternate to todo help add
+    def self.for_command(command,accepts)
+      self.new(command.flags,command.switches,accepts).tap { |factory|
+        add_help_switches_to_command(factory.option_parser,command)
+      }
+    end
+
     # Create an OptionParserFactory for the given
     # flags, switches, and accepts
     def initialize(flags,switches,accepts)
       @flags = flags
       @switches = switches
-      @accepts = accepts
+      @options_hash = {}
+      @option_parser = OptionParser.new do |opts|
+        self.class.setup_accepts(opts,accepts)
+        self.class.setup_options(opts,@switches,@options_hash)
+        self.class.setup_options(opts,@flags,@options_hash)
+      end
     end
 
-    # Return an option parser to parse the given flags, switches and accepts
-    def option_parser
-      options = {}
-      option_parser = OptionParser.new do |opts|
-        self.class.setup_accepts(opts,@accepts)
-        self.class.setup_options(opts,@switches,options)
-        self.class.setup_options(opts,@flags,options)
-      end
-      [option_parser,options]
+    attr_reader :option_parser
+    attr_reader :options_hash
+
+    def options_hash_with_defaults_set!
+      set_defaults(@flags,@options_hash)
+      set_defaults(@switches,@options_hash)
+      @options_hash
     end
 
   private
 
+    def set_defaults(options_by_name,options_hash)
+      options_by_name.each do |name,option|
+        options_hash[name] = option.default_value if options_hash[name].nil?
+      end
+    end
+
     def self.setup_accepts(opts,accepts)
       accepts.each do |object,block|
         opts.accept(object) do |arg_as_string|
@@ -41,5 +61,17 @@ module GLI
       end
     end
 
+    def self.add_help_switches_to_command(option_parser,command)
+      help_args = %w(-h --help).reject { |_| command.has_option?(_) }
+
+      unless help_args.empty?
+        help_args << "Get help for #{command.name}"
+        option_parser.on(*help_args) do
+          raise CommandException.new(nil,command,0)
+        end
+      end
+    end
+
+
   end
 end

data/lib/gli/option_parsing_result.rb

@@ -0,0 +1,19 @@
+module GLI
+  class OptionParsingResult
+    attr_accessor :global_options
+    attr_accessor :command
+    attr_accessor :command_options
+    attr_accessor :arguments
+
+    def convert_to_openstruct!
+      @global_options  = Options.new(@global_options)
+      @command_options = Options.new(@command_options)
+      self
+    end
+
+    # Allows us to splat this object into blocks and methods expecting parameters in this order
+    def to_a
+      [@global_options,@command,@command_options,@arguments]
+    end
+  end
+end

data/lib/gli/version.rb

@@ -1,5 +1,5 @@
 module GLI
   unless const_defined? :VERSION
-    VERSION = '2.5.6' #:nodoc:
+    VERSION = '2.6.0.rc1'
   end
 end

data/test/apps/todo/bin/todo

@@ -17,6 +17,8 @@ end
 sort_help (ENV['TODO_SORT_HELP'] || 'alpha').to_sym
 wrap_help_text (ENV['TODO_WRAP_HELP_TEXT'] || 'to_terminal').to_sym
 
+subcommand_option_handling :normal
+
 program_desc 'Manages tasks'
 program_long_desc "A test program that has a sophisticated UI that can be used to exercise a lot of GLI's power"
 

data/test/apps/todo/lib/todo/commands/make.rb

@@ -0,0 +1,52 @@
+command [:make] do |c|
+  c.desc "Show long form"
+  c.flag [:l,:long]
+
+  c.desc 'make a new task'
+  c.command :task do |task|
+    task.desc 'make the task a long task'
+    task.flag [:l,:long]
+
+    task.action do |g,o,a|
+      puts 'new task'
+      puts a.join(',')
+      puts o[:long]
+    end
+
+    desc 'make a bug'
+    task.command :bug do |bug|
+      bug.desc 'make this bug in the legacy system'
+      bug.flag [:l,:legacy]
+
+      bug.action do |g,o,a|
+        puts 'new task bug'
+        puts a.join(',')
+        # All this .to_s is to make sure 1.8.7/REE don't convert nil to the string "nil"
+        puts o[:legacy].to_s
+        puts o[:long].to_s
+        puts o[:l].to_s
+        puts o[GLI::Command::PARENT][:l].to_s
+        puts o[GLI::Command::PARENT][:long].to_s
+        puts o[GLI::Command::PARENT][:legacy].to_s
+        puts o[GLI::Command::PARENT][GLI::Command::PARENT][:l].to_s
+        puts o[GLI::Command::PARENT][GLI::Command::PARENT][:long].to_s
+        puts o[GLI::Command::PARENT][GLI::Command::PARENT][:legacy].to_s
+      end
+    end
+  end
+
+  c.desc 'make a new context'
+  c.command :context do |context|
+    context.desc 'make the context a local context'
+    context.flag [:l,:local]
+
+    context.action do |g,o,a|
+      puts 'new context'
+      puts a.join(',')
+      puts o[:local].to_s
+      puts o[:long].to_s
+      puts o[:l].to_s
+    end
+  end
+
+end

data/test/apps/todo_legacy/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/test/apps/todo_legacy/README.rdoc

@@ -0,0 +1,6 @@
+= todo
+
+Describe your project here
+
+:include:todo.rdoc
+

data/test/apps/todo_legacy/Rakefile

@@ -0,0 +1,23 @@
+require 'rake/clean'
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+  rd.title = 'Your application title'
+end
+
+spec = eval(File.read('todo.gemspec'))
+
+Rake::GemPackageTask.new(spec) do |pkg|
+end
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/tc_*.rb']
+end
+
+task :default => :test

data/test/apps/todo_legacy/bin/todo

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+
+# These would not be in a real GLI app; we do this so we can easily run this on the command line
+$: << File.expand_path(File.join(File.dirname(__FILE__),'..','..','..','lib'))
+$: << File.expand_path(File.join(File.dirname(__FILE__),'..','lib'))
+
+require 'gli'
+require 'todo/version'
+
+
+if ENV['GLI1_COMPATIBILITY']
+include GLI
+else
+include GLI::App
+end
+
+sort_help (ENV['TODO_SORT_HELP'] || 'alpha').to_sym
+wrap_help_text (ENV['TODO_WRAP_HELP_TEXT'] || 'to_terminal').to_sym
+
+program_desc 'Manages tasks'
+program_long_desc "A test program that has a sophisticated UI that can be used to exercise a lot of GLI's power"
+
+config_file "gli_test_todo.rc"
+
+flag :flag
+switch :switch
+switch :otherswitch, :negatable => true
+
+version Todo::VERSION
+
+commands_from 'todo/commands'
+commands_from File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'todo_plugins', 'commands'))
+
+command :first  do |c| c.action { |g,o,a| puts "first: #{a.join(',')}" } end
+command :second do |c| c.action { |g,o,a| puts "second: #{a.join(',')}" } end
+
+command :chained         => [ :first, :second ]
+command [:chained2,:ch2] => [ :second, :first ]
+
+pre do |global,command,options,args|
+  # Pre logic here
+  # Return true to proceed; false to abort and not call the
+  # chosen command
+  # Use skips_pre before a command to skip this block
+  # on that command only
+  true
+end
+
+post do |global,command,options,args|
+  # Post logic here
+  # Use skips_post before a command to skip this
+  # block on that command only
+end
+
+on_error do |exception|
+  # Error logic here
+  # return false to skip default error handling
+  true
+end
+
+exit run(ARGV)

data/test/apps/todo_legacy/lib/todo/commands/create.rb

@@ -0,0 +1,24 @@
+desc "Create a new task or context"
+command [:create,:new] do |c|
+  c.desc "Make a new task"
+  c.arg_name 'task_name', :multiple
+  c.command :tasks do |tasks|
+    tasks.action do |global,options,args|
+      puts "#{args}"
+    end
+  end
+
+  c.desc "Make a new context"
+  c.arg_name 'context_name', :optional
+  c.command :contexts do |contexts|
+    contexts.action do |global,options,args|
+      puts "#{args}"
+    end
+  end
+
+  c.default_desc "Makes a new task"
+  c.action do
+    puts "default action"
+  end
+end
+

data/test/apps/todo_legacy/lib/todo/commands/list.rb

@@ -0,0 +1,63 @@
+desc "List things, such as tasks or contexts"
+long_desc %(
+  List a whole lot of things that you might be keeping track of 
+  in your overall todo list.
+
+  This is your go-to place or finding all of the things that you
+  might have 
+  stored in 
+  your todo databases.
+)
+command [:list] do |c|
+  c.default_command :tasks
+
+  c.desc "Show long form"
+  c.switch [:l,:long]
+
+  c.desc "List tasks"
+  c.long_desc %(
+    Lists all of your tasks that you have, in varying orders, and
+    all that stuff.  Yes, this is long, but I need a long description.
+  )
+  c.command :tasks do |tasks|
+    tasks.desc "blah blah crud x whatever"
+    tasks.flag [:x], :must_match => Array
+
+    tasks.flag :flag
+
+    tasks.action do |global,options,args|
+      puts options[:x].inspect
+      puts "list tasks: #{args.join(',')}"
+    end
+
+    tasks.desc 'list open tasks'
+    tasks.command :open do |open|
+      open.action do |global,options,args|
+        puts "tasks open"
+      end
+    end
+
+    tasks.default_desc 'list all tasks'
+  end
+
+  c.desc "List contexts"
+  c.long_desc %(
+    Lists all of your contexts, which are places you might be 
+    where you can do stuff and all that.
+  )
+  c.command :contexts do |contexts|
+
+    contexts.desc "Foobar"
+    contexts.switch [:f,'foobar']
+
+    contexts.desc "Blah"
+    contexts.switch [:b]
+
+    contexts.flag :otherflag
+
+    contexts.action do |global,options,args|
+      puts "list contexts: #{args.join(',')}"
+    end
+  end
+end
+

data/test/apps/todo_legacy/lib/todo/commands/ls.rb

@@ -0,0 +1,47 @@
+# This is copied so I can have two slightly different versions of the same thing
+desc "LS things, such as tasks or contexts"
+long_desc %(
+  List a whole lot of things that you might be keeping track of 
+  in your overall todo list.
+
+  This is your go-to place or finding all of the things that you
+  might have 
+  stored in 
+  your todo databases.
+)
+command [:ls] do |c|
+  c.desc "Show long form"
+  c.switch [:l,:long]
+
+  c.desc "List tasks"
+  c.long_desc %(
+    Lists all of your tasks that you have, in varying orders, and
+    all that stuff.  Yes, this is long, but I need a long description.
+  )
+  c.command :tasks do |tasks|
+    tasks.desc "blah blah crud x whatever"
+    tasks.flag [:x]
+    tasks.action do |global,options,args|
+      puts "ls tasks: #{args.join(',')}"
+    end
+  end
+
+  c.desc "List contexts"
+  c.long_desc %(
+    Lists all of your contexts, which are places you might be 
+    where you can do stuff and all that.
+  )
+  c.command :contexts do |contexts|
+
+    contexts.desc "Foobar"
+    contexts.switch [:f,'foobar']
+
+    contexts.desc "Blah"
+    contexts.switch [:b]
+
+    contexts.action do |global,options,args|
+      puts "ls contexts: #{args.join(',')}"
+    end
+  end
+end
+

data/test/apps/todo_legacy/lib/todo/version.rb

@@ -0,0 +1,3 @@
+module Todo
+  VERSION = '0.0.1'
+end

data/test/apps/todo_legacy/test/tc_nothing.rb

@@ -0,0 +1,14 @@
+require 'test/unit'
+
+class TC_testNothing < Test::Unit::TestCase
+
+  def setup
+  end
+
+  def teardown
+  end
+
+  def test_the_truth
+    assert true
+  end
+end

data/test/apps/todo_legacy/todo.gemspec

@@ -0,0 +1,23 @@
+# Ensure we require the local version and not one we might have installed already
+require File.join([File.dirname(__FILE__),'lib','todo','version.rb'])
+spec = Gem::Specification.new do |s| 
+  s.name = 'todo'
+  s.version = Todo::VERSION
+  s.author = 'Your Name Here'
+  s.email = 'your@email.address.com'
+  s.homepage = 'http://your.website.com'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'A description of your project'
+# Add your other files here if you make them
+  s.files = %w(
+bin/todo
+  )
+  s.require_paths << 'lib'
+  s.has_rdoc = true
+  s.extra_rdoc_files = ['README.rdoc','todo.rdoc']
+  s.rdoc_options << '--title' << 'todo' << '--main' << 'README.rdoc' << '-ri'
+  s.bindir = 'bin'
+  s.executables << 'todo'
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rdoc')
+end