gli 1.2.0 → 1.2.1

data/CHANGELOG.rdoc

@@ -1,4 +1,7 @@
 == Changelog
+=== 1.2.1 - 11/26/2010
+
+* Changed default data structure of options *back* to a <tt>Hash</tt>.  If you want to use the <tt>OpenStruct</tt> subclass <tt>Options</tt>, simply put <tt>use_openstruct true</tt> in your command line definition.
 
 === 1.2.0 - 11/26/2010
 

data/README.rdoc

@@ -26,6 +26,7 @@ This will create a basic scaffold project in <tt>./my_proj</tt> with:
 * a gemspec shell
 * a README shell
 * Rakefile that can generate RDoc, package your Gem and run tests
+* A <tt>Gemfile</tt> suitable for use with Bundler to manage development-time dependencies
 
 == Supported Platforms
 
@@ -211,8 +212,6 @@ be included when you generate and publish your rdoc (note that it will *not* sho
 
 == Bash Completion
 
-<i>Not available in current release yet</i>
-
 The +help+ command takes an optional switch, +-c+, that will list all the commands (including aliases) in sorted order suitable for use in a bash completion script.  When +-c+ is specified, the argument can be a partial command, and +help+ will only list the commands matching.  Put this in your +.bashrc+:
 
     complete -F get_myapp_targets myapp

data/lib/gli.rb

@@ -20,6 +20,8 @@ module GLI
   @@pre_block = nil
   @@error_block = nil
   @@config_file = nil
+  @@use_openstruct = false
+  @@version = nil
 
   # Reset the GLI module internal data structures; mostly for testing
   def reset
@@ -28,6 +30,7 @@ module GLI
     commands.clear
     @@version = nil
     @@config_file = nil
+    @@use_openstruct = false
     clear_nexts
   end
 
@@ -113,6 +116,14 @@ module GLI
     @@version = version
   end
 
+  # Call this with "true" will cause the <tt>global_options</tt> and
+  # <tt>options</tt> passed to your code to be wrapped in
+  # GLI::Option, which is a subclass of OpenStruct that adds
+  # <tt>[]</tt> and <tt>[]=</tt> methods.
+  def use_openstruct(use_openstruct)
+    @@use_openstruct = use_openstruct
+  end
+
   # Runs whatever command is needed based on the arguments.
   def run(args)
     rdoc = RDocCommand.new
@@ -123,6 +134,8 @@ module GLI
       global_options,command,options,arguments = parse_options(args,config)
       copy_options_to_aliased_versions(global_options,command,options)
       proceed = true
+      global_options = convert_to_option?(global_options)
+      options = convert_to_option?(options)
       proceed = @@pre_block.call(global_options,command,options,arguments) if @@pre_block 
       if proceed
         command = commands[:help] if !command
@@ -139,6 +152,13 @@ module GLI
     end
   end
 
+  # Possibly returns a copy of the passed-in Hash as an instance of GLI::Option.
+  # By default, it will *not*, however by putting <tt>use_openstruct true</tt>
+  # in your CLI definition, it will
+  def convert_to_option?(options)
+    @@use_openstruct ? Options.new(options) : options
+  end
+
   # Copies all options in both global_options and options to keys for the aliases of those flags.
   # For example, if a flag works with either -f or --flag, this will copy the value from [:f] to [:flag]
   # to allow the user to access the options by any alias
@@ -197,7 +217,7 @@ module GLI
     else
       command_configs = config.delete(GLI::InitConfig::COMMANDS_KEY) if !config.nil?
     end
-    global_options,command,options,arguments = parse_options_helper(args.clone,config,nil,Options.new,Array.new,command_configs)
+    global_options,command,options,arguments = parse_options_helper(args.clone,config,nil,Hash.new,Array.new,command_configs)
     flags.each { |name,flag| global_options[name] = flag.default_value if !global_options[name] }
     command.flags.each { |name,flag| options[name] = flag.default_value if !options[name] }
     return [global_options,command,options,arguments]

data/lib/gli/options.rb

@@ -1,14 +1,16 @@
 require 'ostruct'
 
-class Options < OpenStruct
+module GLI
+  class Options < OpenStruct
 
-  def[](k)
-    @table[k.to_sym]
-  end
+    def[](k)
+      @table[k.to_sym]
+    end
 
-  def[]=(k, v)
-    @table[k.to_sym] = v
-  end
+    def[]=(k, v)
+      @table[k.to_sym] = v
+    end
 
+  end
 end
 

data/lib/gli_version.rb

@@ -1,3 +1,3 @@
 module GLI
-  VERSION = '1.2.0'
+  VERSION = '1.2.1'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gli
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: false
   segments: 
   - 1
   - 2
-  - 0
-  version: 1.2.0
+  - 1
+  version: 1.2.1
 platform: ruby
 authors: 
 - David Copeland