optitron 0.0.9 → 0.0.10

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    optitron (0.0.9)
+      callsite (= 0.0.4)
+      ruby2ruby (= 1.2.4)
+      ruby_parser (>= 2.0)
+      sexp_processor (= 3.0.4)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    callsite (0.0.4)
+    rake (0.8.7)
+    rspec (1.3.0)
+    ruby2ruby (1.2.4)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    ruby_parser (2.0.4)
+      sexp_processor (~> 3.0)
+    sexp_processor (3.0.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0.rc.3)
+  callsite (= 0.0.4)
+  optitron!
+  rake
+  rspec
+  ruby2ruby (= 1.2.4)
+  ruby_parser (>= 2.0)
+  sexp_processor (= 3.0.4)

data/README.rdoc

@@ -112,16 +112,13 @@ Now, try running it.
 
   require 'optitron'
   
-  class Runner
-    include Optitron::ClassDsl
+  class Runner < Optitron::CLI
   
     class_opt 'verbose'
     use_help
   
     desc "Install stuff"
     opt 'force'
-    arg 'file'
-    arg 'source', :required => false
     def install(file, source)
       puts "install some things #{file} from #{source.inspect} #{params.inspect}"
     end

data/lib/optitron.rb

@@ -6,6 +6,7 @@ class Optitron
   autoload :Response,  'optitron/response'
   autoload :Option,    'optitron/option'
   autoload :Help,      'optitron/help'
+  autoload :CLI,       'optitron/cli'
 
   InvalidParser = Class.new(RuntimeError)
 

data/lib/optitron/class_dsl.rb

@@ -1,10 +1,66 @@
+require 'callsite'
+require 'ruby2ruby'
+require 'ruby_parser'
+require 'sexp_processor'
+
 class Optitron
+  
+  class MethodArgs < SexpProcessor
+    attr_reader :method_map
+    def initialize(cls)
+      @cls = cls
+      @method_map = {}
+      super()
+    end
+
+    def process_class(exp)
+      exp.shift
+      @current_class = exp.first.to_sym
+      process(exp)
+      exp.clear
+      exp
+    end
+
+    def process_defn(exp)
+      exp.shift
+      @current_method = exp.shift
+      @ruby2ruby = Ruby2Ruby.new
+      process_args(exp.shift)
+      scope = exp.shift
+      exp
+    end
+
+    def process_args(exp)
+      exp.shift
+      arg_list = []
+      while !exp.empty?
+        t = exp.shift
+        case t
+        when Symbol
+          arg_list << if t.to_s[0] == ?*
+            [t.to_s[1, t.to_s.size].to_sym, :greedy]
+          else
+            [t, :required]
+          end
+        when Sexp
+          case t.shift
+          when :block
+            lasgn = t.shift
+            lasgn.shift
+            arg_list[-1].shift
+            arg_list[-1] << :optional
+            arg_list[-1] << @ruby2ruby.process(lasgn.last)
+          end
+        end
+      end
+      @method_map[@current_method] = arg_list if @cls.name.to_sym == @current_class
+    end
+  end
+  
   module ClassDsl
     
     def self.included(o)
-      o.module_eval "
-      @@optitron_parser = Optitron::Parser.new
-      @@optitron_dsl = Optitron::Dsl.new(@@optitron_parser)
+      o.class_eval "
       attr_accessor :params
       class << self;
         include ClassMethods
@@ -14,58 +70,86 @@ class Optitron
 
     module ClassMethods
       def method_added(m)
-        last_opts = @opts
-        @cmds ||= []
-        @cmds << [m.to_s, @last_desc, @args.dup || [], @opts.dup || []]
-        @opts.clear if @opts
-        @args.clear if @args
+        if @last_desc
+          last_opts = @opts
+          @cmds ||= []
+          @cmds << [m.to_s, @last_desc, @opts ? @opts.dup : []]
+          @opts.clear if @opts
+          @args.clear if @args
+        end
       end
-
+      def optitron_parser
+        send(:class_variable_set, :@@optitron_parser, Optitron::Parser.new) unless send(:class_variable_defined?, :@@optitron_parser)
+        send(:class_variable_get, :@@optitron_parser)
+      end
+      
       def optitron_dsl
-        self.send(:class_variable_get, :@@optitron_dsl)
+        send(:class_variable_set, :@@optitron_dsl, Optitron::Dsl.new(optitron_parser)) unless send(:class_variable_defined?, :@@optitron_dsl)
+        send(:class_variable_get, :@@optitron_dsl)
       end
       
-      def optitron_parser
-        self.send(:class_variable_get, :@@optitron_parser)
+      def method_args
+        send(:class_variable_get, :@@method_args)
+      end
+
+      def build_method_args(file)
+        unless self.send(:class_variable_defined?, :@@method_args)
+          parser = RubyParser.new
+          sexp = parser.process(File.read(file))
+          method_args = MethodArgs.new(self)
+          method_args.process(sexp)
+          self.send(:class_variable_set, :@@method_args, method_args.method_map)
+        end
+        send(:class_variable_get, :@@method_args)
       end
       
       def class_opt(name, desc = nil, opts = nil)
         optitron_dsl.root.opt(name, desc, opts)
       end
 
-      def use_help
+      def dont_use_help
         optitron_dsl.root.help
       end
 
       def desc(desc)
+        build_method_args(Callsite.parse(caller.first).filename)
         @last_desc = desc
       end
 
-      def arg(name, desc = nil, opts = nil)
-        @args ||= []
-        @args << [name, desc, opts]
-      end
-
       def opt(name, desc = nil, opts = nil)
         @opts ||= []
         @opts << [name, desc, opts]
       end
 
       def build
-        @cmds.each do |(cmd_name, cmd_desc, args, opts)|
-          arity = instance_method(cmd_name).arity
-          optitron_dsl.root.cmd(cmd_name, cmd_desc) do
-            opts.each { |o| opt *o }
-            args.each { |a| arg *a }
+        unless @built
+          optitron_dsl.root.help
+          @cmds.each do |(cmd_name, cmd_desc, opts)|
+            args = method_args[cmd_name.to_sym]
+            arity = instance_method(cmd_name).arity
+            optitron_dsl.root.cmd(cmd_name, cmd_desc) do
+              opts.each { |o| opt *o }
+              args.each do |(arg_name, arg_type, arg_default)|
+                case arg_type
+                when :required
+                  arg arg_name.to_s, :default => arg_default && eval(arg_default)
+                when :optional
+                  arg arg_name.to_s, :default => arg_default && eval(arg_default), :required => false
+                when :greedy
+                  arg arg_name.to_s, :default => arg_default && eval(arg_default), :type => :greedy
+                end
+              end
+            end
           end
+          optitron_dsl.configure_options
+          @built = true
         end
-        optitron_dsl.configure_options
       end
 
-      def dispatch
+      def dispatch(args = ARGV, &blk)
         build
-        optitron_parser.target = new
-        response = optitron_parser.parse(ARGV)
+        optitron_parser.target = blk ? blk.call : new
+        response = optitron_parser.parse(args)
         if response.valid?
           optitron_parser.target.params = response.params
           args = response.args

data/lib/optitron/cli.rb

@@ -0,0 +1,6 @@
+class Optitron
+  class CLI
+    include ClassDsl
+  end
+end
+    

data/lib/optitron/dsl.rb

@@ -35,8 +35,8 @@ class Optitron
         else
           unclaimed_opts << opt_option
         end
-        
         @target.options << opt_option
+        opt_option
       end
       
       def arg(name, description = nil, opts = nil)
@@ -61,6 +61,18 @@ class Optitron
         @root_dsl = root_dsl
         @target = command
       end
+      
+      def opt(name, description = nil, opts = nil)
+        o = super
+        o.parent_cmd = @target
+        o
+      end
+
+      def arg(name, description = nil, opts = nil)
+        a = super
+        a.parent_cmd = @target
+        a
+      end
     end
     
     class RootParserDsl < AbstractDsl

data/lib/optitron/help.rb

@@ -19,6 +19,9 @@ class Optitron
       else
         arg_line << arg.name
       end
+      if arg.default
+        arg_line << "=#{arg.default.inspect}"
+      end
       arg_line << (arg.required? ? ']' : '>')
       arg_line
     end

data/lib/optitron/option.rb

@@ -89,7 +89,7 @@ class Optitron
     end
 
     class Opt < Option
-      attr_accessor :short_name, :run
+      attr_accessor :short_name, :run, :parent_cmd
       def initialize(name, desc = nil, opts = nil)
         if desc.is_a?(Hash)
           desc, opts = nil, desc
@@ -179,7 +179,7 @@ class Optitron
     end
     
     class Arg < Option
-      attr_accessor :greedy, :inclusion_test
+      attr_accessor :greedy, :inclusion_test, :parent_cmd
       alias_method :greedy?, :greedy
       def initialize(name = nil, desc = nil, opts = nil)
         if desc.is_a?(Hash)

data/lib/optitron/version.rb

@@ -1,3 +1,3 @@
 class Optitron
-  VERSION = "0.0.9"
+  VERSION = "0.0.10"
 end

data/optitron.gemspec

@@ -15,7 +15,13 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = ">= 1.3.6"
   s.rubyforge_project         = "optitron"
 
+  s.add_dependency "ruby_parser", ">= 2.0"
+  s.add_dependency "callsite", "= 0.0.4"
+  s.add_dependency "ruby2ruby", "= 1.2.4"
+  s.add_dependency "sexp_processor", "= 3.0.4"
   s.add_development_dependency "bundler", ">= 1.0.0.rc.3"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
 
   s.files        = `git ls-files`.split("\n")
   s.require_path = 'lib'

data/spec/cli_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+class CLIExample < Optitron::CLI
+
+  def a_method_we_didnt_describe
+  end
+
+  class_opt 'verbose'
+
+  desc "Use this"
+  opt 'use_opt'
+  def use
+    puts "using this"
+  end
+
+  desc "Use this too"
+  opt 'another_opt'
+  def use_too(one, two = 'three')
+  end
+
+  desc "Use this three"
+  opt 'another_opt_as_well', :default => 123
+  def use_greedy(one, *two)
+  end
+end
+
+class AnotherCLIExample < Optitron::CLI
+
+  def initialize(env)
+    @env = env
+  end
+
+  class_opt 'verbose'
+
+  desc "Use this too"
+  opt 'another_opt'
+  def use_too(one, two = 'three')
+    puts "using this too #{one} #{two} #{params['another_opt']} #{@env}"
+  end
+end
+
+
+describe "Optitron::Parser defaults" do
+  it "should generate the correct help" do
+    CLIExample.build
+    CLIExample.optitron_parser.help.strip.should == "Commands\n\nuse_greedy [one] [two1 two2 ...]       # Use this three\n  -A/--another_opt_as_well=[NUMERIC]   \nuse_too [one] <required=\"three\">       # Use this too\n  -a/--another_opt                     \nuse                                    # Use this\n  -u/--use_opt                         \n\nGlobal options\n\n-v/--verbose                           \n-?/--help                              # Print help message"
+  end
+
+  it "should dispatch" do
+    capture(:stdout) { CLIExample.dispatch(%w(use))}.should == "using this\n"
+  end
+
+  it "should generate the correct help" do
+    AnotherCLIExample.build
+    AnotherCLIExample.optitron_parser.help.strip.should == "Commands\n\nuse_too [one] <required=\"three\">       # Use this too\n  -a/--another_opt                     \n\nGlobal options\n\n-v/--verbose                           \n-?/--help                              # Print help message"
+  end
+
+  it "should dispatch with a custom initer" do
+    capture(:stdout) { AnotherCLIExample.dispatch(%w(use_too three four --another_opt)) { AnotherCLIExample.new("test") }  }.should == "using this too three four true test\n"
+  end
+end

data/spec/option_spec.rb

@@ -65,7 +65,32 @@ describe "Optitron::Parser options" do
     it "should parse '-Vv --vicious=what'" do
       response = @parser.parse(%w(-Vv --vicious=what))
       response.valid?.should be_true
-      response.params
+      response.params.should == {"vicious"=>"what", "vendetta"=>true, "verbose"=>true}
+    end
+  end
+
+  context "auto assingment of short names in cmd parsers" do
+    before(:each) do
+      @parser = Optitron.new {
+        cmd "one" do
+          opt "verbose"
+        end
+        cmd "two" do
+          opt "verbose"
+        end
+      }
+    end
+    
+    it "should parse 'one -v'" do
+      response = @parser.parse(%w(one -v))
+      response.valid?.should be_true
+      response.params.should == {'verbose' => true}
+    end
+
+    it "should parse 'two -V'" do
+      response = @parser.parse(%w(two -V))
+      response.valid?.should be_true
+      response.params.should == {'verbose' => true}
     end
   end
 

data/spec/spec_helper.rb

@@ -1,2 +1,16 @@
 $LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
-require 'optitron'
+require 'optitron'
+
+class Object
+  def capture(stream)
+    begin
+      stream = stream.to_s
+      eval "$#{stream} = StringIO.new"
+      yield
+      result = eval("$#{stream}").string
+    ensure
+      eval("$#{stream} = #{stream.upcase}")
+    end
+    result
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: optitron
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 11
   prerelease: false
   segments: 
   - 0
   - 0
-  - 9
-  version: 0.0.9
+  - 10
+  version: 0.0.10
 platform: ruby
 authors: 
 - Joshua Hull
@@ -15,13 +15,76 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-18 00:00:00 -07:00
+date: 2010-08-19 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: bundler
+  name: ruby_parser
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: callsite
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 0
+        - 4
+        version: 0.0.4
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: ruby2ruby
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 2
+        - 4
+        version: 1.2.4
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sexp_processor
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 3
+        - 0
+        - 4
+        version: 3.0.4
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -35,7 +98,35 @@ dependencies:
         - 3
         version: 1.0.0.rc.3
   type: :development
-  version_requirements: *id001
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
 description: Sensible options parsing
 email: 
 - joshbuddy@gmail.com
@@ -48,10 +139,12 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- Gemfile.lock
 - README.rdoc
 - Rakefile
 - lib/optitron.rb
 - lib/optitron/class_dsl.rb
+- lib/optitron/cli.rb
 - lib/optitron/dsl.rb
 - lib/optitron/help.rb
 - lib/optitron/option.rb
@@ -61,6 +154,7 @@ files:
 - lib/optitron/version.rb
 - optitron.gemspec
 - spec/arg_spec.rb
+- spec/cli_spec.rb
 - spec/default_spec.rb
 - spec/dispatch_spec.rb
 - spec/errors_spec.rb