gli 1.6.0 → 2.0.0.rc3

data/lib/gli/options.rb

@@ -1,7 +1,8 @@
 require 'ostruct'
 
 module GLI
-  # Subclass of OpenStruct that provides hash-like methods for #[] and #[]=.  Note that is is *not* a Hash.
+  # Subclass of +OpenStruct+ that provides hash-like methods for #[] and #[]=.  Note that is is *not* a Hash.
+  # By using GLI::App#use_openstruct, your options will be coerced into one of these.
   class Options < OpenStruct
 
     # Return the value of an attribute

data/lib/gli/switch.rb

@@ -1,63 +1,31 @@
-require 'gli/command_line_token.rb'
+require 'gli/command_line_option.rb'
 
 module GLI
   # Defines a command line switch
-  class Switch < CommandLineToken #:nodoc:
+  class Switch < CommandLineOption #:nodoc:
 
-    def initialize(names,description,long_desc=nil)
-      super(names,description,long_desc)
-      @default_value = false
-    end
+    attr_accessor :default_value
 
-    # Given the argument list, scans it looking for this switch
-    # returning true if it's in the argumennt list (and removing it from the argument list)
-    def get_value!(args)
-      idx = -1
-      args.each_index do |index|
-        result = find_me(args[index])
-        if result[0]
-          if result[1]
-            args[index] = result[1]
-          else
-            args.delete_at index
-          end
-          return result[0]
-        end
-      end
-      @default_value
-    end
-
-    # Used only to configure what's returned if we do not detect this switch on the command line
-    # This allows the configuration file to set a switch as always on
-    def default_value=(default)
-      @default_value = default
+    # Creates a new switch
+    #
+    # names - Array of symbols or strings representing the names of this switch
+    # options - hash of options:
+    #           :desc - the short description
+    #           :long_desc - the long description
+    #           :negatable - true or false if this switch is negatable; defaults to true
+    #           :default_value - ignored, switches default to false
+    def initialize(names,options = {})
+      super(names,options)
+      @default_value = false
+      @negatable = options[:negatable].nil? ? true : options[:negatable]
     end
 
-    # Finds the switch in the given arg, returning the arg to keep.
-    # Returns an array of size 2:
-    # index 0:: true or false if the arg was found
-    # index 1:: the remaining arg to keep in the command line or nil to remove it
-    def find_me(arg)
-      if @names[arg]
-        return [true,nil]
-      end
-      @names.keys.each() do |name|
-        if name =~ /^-(\w)$/
-          match_string = "^\\-(\\w*)#{$1}(\\w*)$"
-          match_data = arg.match(match_string)
-          if match_data
-            # Note that if [1] and [2] were both empty 
-            # we'd have returned above
-            return [true, "-" + match_data[1] + match_data[2]]
-          end
-        end
-      end
-      [false]
+    def arguments_for_option_parser
+      all_forms_a
     end
 
-    def self.name_as_string(name)
-      string = name.to_s
-      string.length == 1 ? "-#{string}" : "--#{string}"
+    def negatable?
+      @negatable
     end
   end
 end

data/lib/gli/terminal.rb

@@ -3,7 +3,7 @@ module GLI
   # as a canonical means to get information about the user's current terminal configuraiton.
   # GLI uses this to determine the number of columns to use when printing to the screen.
   #
-  # To access it, use Terminal#instance.  This is a singleton mostly to facilitate testing, but
+  # To access it, use Terminal.instance.  This is a singleton mostly to facilitate testing, but
   # it seems reasonable enough, since there's only one terminal in effect
   #
   # Example:
@@ -35,31 +35,46 @@ module GLI
 
     # Call this to cause methods to throw exceptions rather than return a sane default.  You
     # probably don't want to call this unless you are writing tests
-    def make_unsafe!
+    def make_unsafe! #:nodoc:
       @unsafe = true
     end
 
     # Returns true if the given command exists on this system
     #
     # +command+:: The command, as a String, to check for, without any path information.
-    def command_exists?(command)
+    def self.command_exists?(command)
       ENV['PATH'].split(File::PATH_SEPARATOR).any? {|dir| File.exists? File.join(dir, command) }
     end
 
+    def command_exists?(command)
+      self.class.command_exists?(command)
+    end
+
+    SIZE_DETERMINERS = [
+      [
+        lambda { (ENV['COLUMNS'] =~ /^\d+$/) && (ENV['LINES'] =~ /^\d+$/) },
+        lambda { [ENV['COLUMNS'].to_i, ENV['LINES'].to_i] }
+      ],
+      [
+        lambda { (jruby? || (!STDIN.tty? && ENV['TERM'])) && command_exists?('tput') },
+        lambda { [run_command('tput cols').to_i, run_command('tput lines').to_i] }
+      ],
+      [ 
+        lambda { STDIN.tty? && command_exists?('stty') },
+        lambda { run_command('stty size').scan(/\d+/).map { |size_element| size_element.to_i }.reverse }
+      ],
+      [
+        lambda { true },
+        lambda { Terminal.default_size },
+      ],
+    ]
+
     # Get the size of the current terminal.
     # Ripped from hirb[https://github.com/cldwalker/hirb/blob/master/lib/hirb/util.rb]
     #
     # Returns an Array of size two Ints representing the terminal width and height
     def size
-      if (ENV['COLUMNS'] =~ /^\d+$/) && (ENV['LINES'] =~ /^\d+$/)
-        [ENV['COLUMNS'].to_i, ENV['LINES'].to_i]
-      elsif (jruby? || (!STDIN.tty? && ENV['TERM'])) && command_exists?('tput')
-        [run_command('tput cols').to_i, run_command('tput lines').to_i]
-      elsif STDIN.tty? && command_exists?('stty')
-        run_command('stty size').scan(/\d+/).map { |size_element| size_element.to_i }.reverse
-      else
-        Terminal.default_size
-      end
+      SIZE_DETERMINERS.select { |predicate,ignore| predicate.call }.first[1].call
     rescue Exception => ex
       raise ex if @unsafe
       Terminal.default_size
@@ -68,17 +83,12 @@ module GLI
     private
 
     # Runs a command using backticks.  Extracted to allow for testing
-    def run_command(command)
+    def self.run_command(command)
       `#{command}`
     end
 
     # True if we are JRuby; exposed to allow for testing
-    def jruby?
-      if RUBY_PLATFORM =~ /java/
-        true
-      else
-        false
-      end
-    end
+    def self.jruby?; RUBY_PLATFORM =~ /java/; end
+
   end
 end

data/lib/gli/version.rb

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

data/test/apps/README.md

@@ -0,0 +1,2 @@
+Special-built applications for use in tests that will hopefully reveal
+various features and edge cases

data/test/apps/todo/Gemfile

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

data/test/apps/todo/README.rdoc

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

data/test/apps/todo/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/bin/todo

@@ -0,0 +1,52 @@
+#!/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'
+
+
+include GLI::App
+
+program_desc 'Manages tasks'
+
+config_file "gli_test_todo.rc"
+
+flag :flag
+switch :switch
+switch :otherswitch, :negatable => true
+
+version Todo::VERSION
+
+commands_from 'todo/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 abourt 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/lib/todo/commands/create.rb

@@ -0,0 +1,22 @@
+desc "Create a new task or context"
+command [:create,:new] do |c|
+  c.desc "Make a new task"
+  c.command :tasks do |tasks|
+    tasks.action do |global,options,args|
+      puts "#{args}"
+    end
+  end
+
+  c.desc "Make a new context"
+  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/lib/todo/commands/list.rb

@@ -0,0 +1,53 @@
+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]
+
+    tasks.flag :flag
+
+    tasks.action do |global,options,args|
+      puts "list 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.flag :otherflag
+
+    contexts.action do |global,options,args|
+      puts "list contexts: #{args.join(',')}"
+    end
+  end
+end
+

data/test/apps/todo/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/lib/todo/version.rb

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

data/test/apps/todo/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/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