optitron 0.1.0 → 0.1.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    optitron (0.0.11)
+    optitron (0.1.0)
       callsite (= 0.0.4)
       ruby2ruby (= 1.2.4)
       ruby_parser (>= 2.0)

data/README.rdoc

@@ -2,11 +2,11 @@
 
 == Sensible options parsing
 
-Optitron strives to be simple, minimal and to do the "right thing" most of the time. The structure is simple, you have global options, a list of commands, and each of those commands takes a number of arguments and options.
+Optitron strives to be simple, minimal and to do the "right thing" most of the time. The structure is easy: you have global options, a list of commands, and each of those commands takes a number of arguments and options.
 
 == Usage
 
-To create an Optitron CLI, start with a class you want to wire up as a CLI. In our example, we'll use the class Runner, which we want to work as a CLI.
+To create an Optitron command line interface (CLI), start with a class you want to wire up as a CLI. In our example, we'll use the class Runner, which we want to work as a CLI.
 
   class Runner
     def start
@@ -41,7 +41,48 @@ To make this class suitable for use as a CLI, either extend <tt>Optitron::CLI</t
     end
   end
 
-Only methods described will be available to the CLI. If you have a method that needs arguments, simply include them as method arguments. It will respect splats and defaults. Options are specified with the +opt+ method in your class, as follows:
+=== Help command
+
+Help is added by default, but, if you don't want to use this, include the command +dont_use_help+ in your class. Help is available from either <tt>--help</tt> or <tt>-?</tt>.
+
+=== Arguments
+
+Only methods described will be available to the CLI. If you have a method that needs arguments, simply include them as method arguments. It will respect splats and defaults. For instance
+
+  desc "Starts the process"
+  def start(mode)
+    # ... starts
+  end
+
+Will generate
+
+  start [mode]       # Starts the process
+  
+In your help file.
+
+  desc "Starts the process"
+  def start(mode = 'production')
+    # ... starts
+  end
+
+Will generate
+
+  start <mode="production">       # Starts the process
+
+And
+
+  desc "Starts the process"
+  def start(*modes)
+    # ... starts
+  end
+
+Will generate
+
+  start <modes1 modes2 ...>       # Starts the process
+
+=== Options
+
+Options are specified with the +opt+ method in your class, as follows:
 
   class Runner < Optitron::CLI
     desc "Starts the process"
@@ -70,10 +111,6 @@ The last line in your runner has to be the class name and dispatch. This will pa
     # ... your methods
   end
   Runner.dispatch
-  
-As well, help is added by default, but, if you don't want to use this, include the command +dont_use_help+ in your class.
-  
-== How to configure options
 
 Options can have defaults, types and inclusion checks. Here are all the options available on an opt:
 

data/examples/cli.rb

@@ -0,0 +1,15 @@
+require 'optitron'
+
+class Runner < Optitron::CLI
+  class_opt 'verbose'
+  class_opt 'environment', :in => %w(production stage development test), :default => 'development'
+  class_opt 'volume', :in => 1..10
+
+  desc "Install stuff"
+  opt 'force'
+  def install(file, source = ".")
+    puts "Installing #{file} from #{source.inspect} with params: #{params.inspect}"
+  end
+end
+
+Runner.dispatch

data/lib/optitron/class_dsl.rb

@@ -126,7 +126,7 @@ class Optitron
 
       def build
         unless @built
-          optitron_dsl.root.help# if send(:class_variable_defined?, :@@suppress_help)
+          optitron_dsl.root.help unless send(:class_variable_defined?, :@@suppress_help)
           @cmds.each do |(cmd_name, cmd_desc, opts)|
             args = method_args[cmd_name.to_sym]
             arity = instance_method(cmd_name).arity

data/lib/optitron/version.rb

@@ -1,3 +1,3 @@
 class Optitron
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/option_spec.rb

@@ -133,4 +133,20 @@ describe "Optitron::Parser options" do
     end
   end
 
+  context "array options with a comment" do
+    before(:each) do
+      @parser = Optitron.new {
+        cmd "install" do
+          opt "things", :type => :array
+        end
+      }
+    end
+    
+    it "should parse '--things=one two three install'" do
+      response = @parser.parse(%w(--things=one two three install))
+      response.valid?.should be_true
+      response.params.should == {'things' => ['one', 'two', 'three']}
+    end
+  end
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: optitron
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Joshua Hull
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-20 00:00:00 -07:00
+date: 2010-08-21 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -142,6 +142,7 @@ files:
 - Gemfile.lock
 - README.rdoc
 - Rakefile
+- examples/cli.rb
 - lib/optitron.rb
 - lib/optitron/class_dsl.rb
 - lib/optitron/cli.rb