gli 1.6.0 → 2.0.0.rc3

data/lib/gli/commands/help_modules/global_help_format.rb

@@ -0,0 +1,61 @@
+require 'erb'
+
+module GLI
+  module Commands
+    module HelpModules
+      class GlobalHelpFormat
+        def initialize(app)
+          @app = app
+        end
+
+        def format
+          program_desc = @app.program_desc
+
+          command_formatter = ListFormatter.new(@app.commands.values.sort.reject(&:nodoc).map { |command|
+            [[command.name,Array(command.aliases)].flatten.join(', '),command.description]
+          })
+          stringio = StringIO.new
+          command_formatter.output(stringio)
+          commands = stringio.string
+
+          global_option_descriptions = OptionsFormatter.new(global_flags_and_switches).format
+
+          GLOBAL_HELP.result(binding)
+        end
+
+      private
+
+        GLOBAL_HELP = ERB.new(%q(NAME
+    <%= File.basename($0) %> - <%= program_desc %>
+
+SYNOPSIS
+    <%= usage_string %>
+
+<% unless @app.version_string.nil? %>
+VERSION
+    <%= @app.version_string %>
+
+<% end %>
+<% unless global_flags_and_switches.empty? %>
+GLOBAL OPTIONS
+<%= global_option_descriptions %>
+
+<% end %>
+COMMANDS
+<%= commands %>),nil,'<>')
+
+        def global_flags_and_switches
+          @app.flags.merge(@app.switches)
+        end
+
+        def usage_string
+          "#{File.basename($0)} ".tap do |string|
+            string << "[global options] " unless global_flags_and_switches.empty?
+            string << "command "
+            string << "[command options] [arguments...]"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gli/commands/help_modules/list_formatter.rb

@@ -0,0 +1,22 @@
+module GLI
+  module Commands
+    module HelpModules
+      # Given a list of two-element lists, formats on the terminal 
+      class ListFormatter
+        def initialize(list)
+          @list = list
+        end
+
+        # Output the list to the output_device
+        def output(output_device)
+          return if @list.empty?
+          max_width = @list.map { |_| _[0].length }.max
+          wrapper = TextWrapper.new(Terminal.instance.size[0],4 + max_width + 3)
+          @list.each do |(name,description)|
+            output_device.printf("    %-#{max_width}s - %s\n",name,wrapper.wrap(String(description).strip))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gli/commands/help_modules/options_formatter.rb

@@ -0,0 +1,50 @@
+module GLI
+  module Commands
+    module HelpModules
+      class OptionsFormatter
+        def initialize(flags_and_switches)
+          @flags_and_switches = flags_and_switches
+        end
+
+        def format
+          list_formatter = ListFormatter.new(@flags_and_switches.values.sort { |a,b| 
+            a.name.to_s <=> b.name.to_s 
+          }.map { |option|
+            if option.respond_to? :argument_name
+              [option_names_for_help_string(option,option.argument_name),description_with_default(option)]
+            else
+              [option_names_for_help_string(option),description_with_default(option)]
+            end
+          })
+          stringio = StringIO.new
+          list_formatter.output(stringio)
+          stringio.string
+        end
+
+      private
+
+        def description_with_default(option)
+          if option.kind_of? Flag
+            String(option.description) + " (default: #{option.default_value || 'none'})"
+          else
+            String(option.description)
+          end
+        end
+
+        def option_names_for_help_string(option,arg_name=nil)
+          names = [option.name,Array(option.aliases)].flatten
+          names = names.map { |name| CommandLineOption.name_as_string(name,option.kind_of?(Switch) ? option.negatable? : false) }
+          if arg_name.nil?
+            names.join(', ')
+          else
+            if names[-1] =~ /^--/
+              names.join(', ') + "=#{arg_name}"
+            else
+              names.join(', ') + " #{arg_name}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gli/commands/help_modules/text_wrapper.rb

@@ -0,0 +1,53 @@
+module GLI
+  module Commands
+    module HelpModules
+      # Handles wrapping text
+      class TextWrapper
+        # Create a text_wrapper wrapping at the given width,
+        # and indent.
+        def initialize(width,indent)
+          @width = width
+          @indent = indent
+        end
+
+        # Return a wrapped version of text, assuming that the first line has already been
+        # indented by @indent characters.  Resulting text does NOT have a newline in it.
+        def wrap(text)
+          return text if text.nil?
+          wrapped_text = ''
+          current_graf = ''
+
+          paragraphs = text.split(/\n\n+/)
+          paragraphs.each do |graf|
+            current_line = ''
+            current_line_length = @indent
+
+            words = graf.split(/\s+/)
+            current_line = words.shift || ''
+            current_line_length += current_line.length
+
+            words.each do |word|
+              if current_line_length + word.length + 1 > @width
+                current_graf << current_line << "\n"
+                current_line = ''
+                current_line << ' ' * @indent << word
+                current_line_length = @indent + word.length
+              else
+                if current_line == ''
+                  current_line << word
+                else
+                  current_line << ' ' << word
+                end
+                current_line_length += (word.length + 1)
+              end
+            end
+            current_graf << current_line
+            wrapped_text << current_graf  << "\n\n" << ' ' * @indent
+            current_graf = ''
+          end
+          wrapped_text.gsub(/[\n\s]*\Z/,'')
+        end
+      end
+    end
+  end
+end

data/lib/gli/commands/initconfig.rb

@@ -0,0 +1,67 @@
+require 'gli'
+require 'gli/command'
+require 'yaml'
+
+module GLI
+  # Command that initializes the configuration file for apps that use it.
+  class InitConfig < Command # :nodoc:
+    COMMANDS_KEY = 'commands'
+
+    def initialize(config_file_name,commands,flags,switches)
+      @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')
+
+      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"
+      end
+    end
+
+  private
+
+    def create_config(global_options,options,arguments)
+      config = Hash[global_options.map { |option_name,option_value|
+        if option_value.kind_of?(String) && option_value.respond_to?(:force_encoding)
+          [option_name,option_value.force_encoding("utf-8")]
+        else
+          [option_name,option_value]
+        end
+      }]
+      config[COMMANDS_KEY] = {}
+      @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)
+          end
+        end
+      end
+      File.open(@filename,'w', 0600) do |file|
+        YAML.dump(config,file)
+      end
+    end
+
+    def config_for_command(commands,command_name)
+      {}.tap do |hash|
+        subcommands = commands[command_name].commands
+        subcommands.each do |name,subcommand|
+          next unless name.kind_of? Symbol
+          hash[COMMANDS_KEY] ||= {}
+          puts "#{command_name}:#{name}"
+          hash[COMMANDS_KEY][name.to_sym] = config_for_command(subcommands,name)
+        end
+      end
+    end
+  end
+end

data/lib/{support → gli/commands}/scaffold.rb

@@ -2,9 +2,17 @@ require 'gli'
 require 'fileutils'
 
 module GLI
+  module Commands
   class Scaffold #:nodoc:
 
-    def self.create_scaffold(root_dir,create_test_dir,create_ext_dir,project_name,commands,force=false,dry_run=false)
+    def self.create_scaffold(root_dir,
+                             create_test_dir,
+                             create_ext_dir,
+                             project_name,
+                             commands,
+                             force=false,
+                             dry_run=false,
+                             create_rvmrc=false)
       dirs = [File.join(root_dir,project_name,'lib')]
       dirs << File.join(root_dir,project_name,'bin')
       dirs << File.join(root_dir,project_name,'test') if create_test_dir
@@ -15,7 +23,14 @@ module GLI
         mk_readme(root_dir,dry_run,project_name)
         mk_gemspec(root_dir,dry_run,project_name)
         mk_rakefile(root_dir,dry_run,project_name,create_test_dir)
-        mk_version(root_dir,dry_run,project_name)
+        mk_lib_files(root_dir,dry_run,project_name)
+        if create_rvmrc
+          rvmrc = File.join(root_dir,project_name,".rvmrc")
+          File.open(rvmrc,'w') do |file|
+            file.puts "rvm use #{ENV['rvm_ruby_string']}@#{project_name} --create"
+          end
+          puts "Created #{rvmrc}"
+        end
       end
     end
 
@@ -39,7 +54,7 @@ module GLI
       File.open("#{root_dir}/#{project_name}/#{project_name}.gemspec",'w') do |file|
         file.puts <<EOS
 # Ensure we require the local version and not one we might have installed already
-require File.join([File.dirname(__FILE__),'lib','#{project_name}_version.rb'])
+require File.join([File.dirname(__FILE__),'lib','#{project_name}','version.rb'])
 spec = Gem::Specification.new do |s| 
   s.name = '#{project_name}'
   s.version = #{project_name_as_module_name(project_name)}::VERSION
@@ -51,7 +66,8 @@ spec = Gem::Specification.new do |s|
 # Add your other files here if you make them
   s.files = %w(
 bin/#{project_name}
-lib/#{project_name}_version.rb
+lib/#{project_name}/version.rb
+lib/#{project_name}.rb
   )
   s.require_paths << 'lib'
   s.has_rdoc = true
@@ -61,7 +77,8 @@ lib/#{project_name}_version.rb
   s.executables << '#{project_name}'
   s.add_development_dependency('rake')
   s.add_development_dependency('rdoc')
-  s.add_runtime_dependency('gli')
+  s.add_development_dependency('aruba')
+  s.add_runtime_dependency('gli','#{GLI::VERSION}')
 end
 EOS
       end
@@ -72,16 +89,26 @@ EOS
       project_name.split(/_/).map { |part| part[0..0].upcase + part[1..-1] }.join('')
     end
 
-    def self.mk_version(root_dir,dry_run,project_name)
+    def self.mk_lib_files(root_dir,dry_run,project_name)
       return if dry_run
-      File.open("#{root_dir}/#{project_name}/lib/#{project_name}_version.rb",'w') do |file|
+      FileUtils.mkdir("#{root_dir}/#{project_name}/lib/#{project_name}")
+      File.open("#{root_dir}/#{project_name}/lib/#{project_name}/version.rb",'w') do |file|
         file.puts <<EOS
 module #{project_name_as_module_name(project_name)}
   VERSION = '0.0.1'
 end
 EOS
       end
-      puts "Created #{root_dir}/#{project_name}/lib/#{project_name}_version.rb"
+      puts "Created #{root_dir}/#{project_name}/lib/#{project_name}/version.rb"
+      File.open("#{root_dir}/#{project_name}/lib/#{project_name}.rb",'w') do |file|
+        file.puts <<EOS
+require '#{project_name}/version.rb'
+
+# Add requires for other files you add to your project here, so
+# you just need to require this one file in your bin file
+EOS
+      end
+      puts "Created #{root_dir}/#{project_name}/lib/#{project_name}.rb"
     end
     def self.mk_rakefile(root_dir,dry_run,project_name,create_test_dir)
       return if dry_run
@@ -91,7 +118,14 @@ require 'rake/clean'
 require 'rubygems'
 require 'rubygems/package_task'
 require 'rdoc/task'
-
+EOS
+        if create_test_dir
+          file.puts <<EOS
+require 'cucumber'
+require 'cucumber/rake/task'
+EOS
+        end
+        file.puts <<EOS
 Rake::RDocTask.new do |rd|
   rd.main = "README.rdoc"
   rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
@@ -102,23 +136,47 @@ spec = eval(File.read('#{project_name}.gemspec'))
 
 Gem::PackageTask.new(spec) do |pkg|
 end
+EOS
+        if create_test_dir
+          file.puts <<EOS
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+desc 'Run features'
+Cucumber::Rake::Task.new(:features) do |t|
+  opts = "features --format html -o \#{CUKE_RESULTS} --format progress -x"
+  opts += " --tags \#{ENV['TAGS']}" if ENV['TAGS']
+  t.cucumber_opts =  opts
+  t.fork = false
+end
 
+desc 'Run features tagged as work-in-progress (@wip)'
+Cucumber::Rake::Task.new('features:wip') do |t|
+  tag_opts = ' --tags ~@pending'
+  tag_opts = ' --tags @wip'
+  t.cucumber_opts = "features --format html -o \#{CUKE_RESULTS} --format pretty -x -s\#{tag_opts}"
+  t.fork = false
+end
+
+task :cucumber => :features
+task 'cucumber:wip' => 'features:wip'
+task :wip => 'features:wip'
 EOS
+        end
         if create_test_dir
           file.puts <<EOS
 require 'rake/testtask'
 Rake::TestTask.new do |t|
   t.libs << "test"
-  t.test_files = FileList['test/tc_*.rb']
+  t.test_files = FileList['test/*_test.rb']
 end
 
-task :default => :test
+task :default => [:test,:features]
 EOS
-          File.open("#{root_dir}/#{project_name}/test/tc_nothing.rb",'w') do |test_file|
+          File.open("#{root_dir}/#{project_name}/test/default_test.rb",'w') do |test_file|
             test_file.puts <<EOS
-require 'test/unit'
+require 'test_helper'
 
-class TC_testNothing < Test::Unit::TestCase
+class DefaultTest < Test::Unit::TestCase
 
   def setup
   end
@@ -132,7 +190,21 @@ class TC_testNothing < Test::Unit::TestCase
 end
 EOS
           end
-          puts "Created #{root_dir}/#{project_name}/test/tc_nothing.rb"
+          puts "Created #{root_dir}/#{project_name}/test/default_test.rb"
+          File.open("#{root_dir}/#{project_name}/test/test_helper.rb",'w') do |test_file|
+            test_file.puts <<EOS
+require 'test/unit'
+
+# Add test libraries you want to use here, e.g. mocha
+
+class Test::Unit::TestCase
+
+  # Add global extensions to the test case class here
+  
+end
+EOS
+          end
+          puts "Created #{root_dir}/#{project_name}/test/test_helper.rb"
         else
           file.puts "task :default => :package\n"
         end
@@ -143,6 +215,54 @@ EOS
         bundler_file.puts "gemspec"
       end
       puts "Created #{root_dir}/#{project_name}/Gemfile"
+      if create_test_dir
+        features_dir = File.join(root_dir,project_name,'features')
+        FileUtils.mkdir features_dir
+        FileUtils.mkdir File.join(features_dir,"step_definitions")
+        FileUtils.mkdir File.join(features_dir,"support")
+        File.open(File.join(features_dir,"#{project_name}.feature"),'w') do |file|
+          file.puts <<EOS
+Feature: My bootstrapped app kinda works
+  In order to get going on coding my awesome app
+  I want to have aruba and cucumber setup
+  So I don't have to do it myself
+
+  Scenario: App just runs
+    When I get help for "#{project_name}"
+    Then the exit status should be 0
+EOS
+        end
+        File.open(File.join(features_dir,"step_definitions","#{project_name}_steps.rb"),'w') do |file|
+          file.puts <<EOS
+When /^I get help for "([^"]*)"$/ do |app_name|
+  @app_name = app_name
+  step %(I run `\#{app_name} help`)
+end
+
+# Add more step definitions here
+EOS
+        end
+        File.open(File.join(features_dir,"support","env.rb"),'w') do |file|
+          file.puts <<EOS
+require 'aruba/cucumber'
+
+ENV['PATH'] = "\#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}\#{File::PATH_SEPARATOR}\#{ENV['PATH']}"
+LIB_DIR = File.join(File.expand_path(File.dirname(__FILE__)),'..','..','lib')
+
+Before do
+  # Using "announce" causes massive warnings on 1.9.2
+  @puts = true
+  @original_rubylib = ENV['RUBYLIB']
+  ENV['RUBYLIB'] = LIB_DIR + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s
+end
+
+After do
+  ENV['RUBYLIB'] = @original_rubylib
+end
+EOS
+        end
+        puts "Created #{features_dir}"
+      end
     end
 
     def self.mk_binfile(root_dir,create_ext_dir,force,dry_run,project_name,commands)
@@ -153,26 +273,18 @@ EOS
             file.chmod(0755)
             file.puts '#!/usr/bin/env ruby'
             file.puts <<EOS
-# 1.9 adds realpath to resolve symlinks; 1.8 doesn't
-# have this method, so we add it so we get resolved symlinks
-# and compatibility
-unless File.respond_to? :realpath
-  class File #:nodoc:
-    def self.realpath path
-      return realpath(File.readlink(path)) if symlink?(path)
-      path
-    end
-  end
-end
-EOS
-            file.puts '$: << File.expand_path(File.dirname(File.realpath(__FILE__)) + \'/../lib\')'
-            file.puts '$: << File.expand_path(File.dirname(File.realpath(__FILE__)) + \'/../ext\')' if create_ext_dir
-            file.puts <<EOS
 require 'rubygems'
 require 'gli'
-require '#{project_name}_version'
+begin # XXX: Remove this begin/rescue before distributing your app
+require '#{project_name}'
+rescue LoadError
+  STDERR.puts "In development, you need to use `bundle exec bin/todo` to run your app"
+  STDERR.puts "At install-time, RubyGems will make sure lib, etc. are in the load path"
+  STDERR.puts "Feel free to remove this message from bin/todo now"
+  exit 64
+end
 
-include GLI
+include GLI::App
 
 program_desc 'Describe your application here'
 
@@ -208,6 +320,8 @@ command :#{command} do |c|
      
     # If you have any errors, just raise them
     # raise "that command made no sense"
+
+    puts "#{command} command ran"
   end
 end
 EOS
@@ -215,6 +329,7 @@ EOS
                 file.puts <<EOS
 command :#{command} do |c|
   c.action do |global_options,options,args|
+    puts "#{command} command ran"
   end
 end
 EOS
@@ -225,7 +340,7 @@ EOS
 
 pre do |global,command,options,args|
   # Pre logic here
-  # Return true to proceed; false to abort and not call the
+  # Return true to proceed; false to abourt and not call the
   # chosen command
   # Use skips_pre before a command to skip this block
   # on that command only
@@ -244,7 +359,7 @@ on_error do |exception|
   true
 end
 
-exit GLI.run(ARGV)
+exit run(ARGV)
 EOS
             puts "Created #{bin_file}"
           end
@@ -284,3 +399,4 @@ EOS
 
   end
 end
+end