optitron 0.0.8 → 0.0.9

data/README.rdoc

@@ -5,6 +5,7 @@
 You can specify lots of different commands with options
 
   @parser = Optitron.new {
+    help
     opt 'verbose', "Be very loud"
     cmd "install", "This installs things" do
       arg "file", "The file to install"
@@ -96,43 +97,59 @@ To use this in a file, create a parser, and tell it to dispatch to your favourit
 Now, try running it.
 
   crapbook-pro:optitron joshua$ ruby test.rb 
-  Commands
+  Unknown command
   
-  show [first] <second>          # This shows things
-  install [file]                 # This installs things
-  kill                           # This kills things
-    -p/--pids=[ARRAY]            # A list of pids to kill
-    -P/--pid=[NUMERIC]           # A pid to kill
-    -n/--names=[HASH]            # Some sort of hash
-  join [thing1 thing2 ...]       # This joins things
+  crapbook-pro:optitron joshua$ ruby test.rb install
+  File is required
   
-  Global options
+  crapbook-pro:optitron joshua$ ruby test.rb install file
+  installing file with {"verbose"=>false}!
+
+  crapbook-pro:optitron joshua$ ruby test.rb install file --verbose
+  installing file with {"verbose"=>true}!
+
+== Usage in a class
+
+  require 'optitron'
   
-  -v/--verbose                   # Be very loud
+  class Runner
+    include Optitron::ClassDsl
   
-  Errors:
-  Unknown command
+    class_opt 'verbose'
+    use_help
   
-  crapbook-pro:optitron joshua$ ruby test.rb install
+    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
+  end
+  
+  Runner.dispatch
+  
+Running this gives you
+
+  crapbook-pro:optitron joshua$ ruby ideal.rb --help
   Commands
   
-  show [first] <second>          # This shows things
-  install [file]                 # This installs things
-  kill                           # This kills things
-    -p/--pids=[ARRAY]            # A list of pids to kill
-    -P/--pid=[NUMERIC]           # A pid to kill
-    -n/--names=[HASH]            # Some sort of hash
-  join [thing1 thing2 ...]       # This joins things
+  install [file] <source>       # Install stuff
+    -f/--force                  
   
   Global options
   
-  -v/--verbose                   # Be very loud
-  
-  Errors:
+  -v/--verbose                  
+  -?/--help                     # Print help message
+
+  crapbook-pro:optitron joshua$ ruby ideal.rb install
   File is required
-  
-  crapbook-pro:optitron joshua$ ruby test.rb install file
-  installing file with {"verbose"=>false}!
 
-  crapbook-pro:optitron joshua$ ruby test.rb install file --verbose
-  installing file with {"verbose"=>true}!
+  crapbook-pro:optitron joshua$ ruby ideal.rb install file
+  installing file from yourmom with params: {"help"=>false, "force"=>false, "verbose"=>false}
+
+  crapbook-pro:optitron joshua$ ruby ideal.rb install file yourdad
+  installing file from yourdad with params: {"help"=>false, "force"=>false, "verbose"=>false}
+
+  crapbook-pro:optitron joshua$ ruby ideal.rb install file yourdad -v
+  installing file from yourdad with params: {"help"=>false, "force"=>false, "verbose"=>true}

data/lib/optitron.rb

@@ -1,5 +1,6 @@
 class Optitron
   autoload :Dsl,       'optitron/dsl'
+  autoload :ClassDsl,  'optitron/class_dsl'
   autoload :Tokenizer, 'optitron/tokenizer'
   autoload :Parser,    'optitron/parser'
   autoload :Response,  'optitron/response'

data/lib/optitron/class_dsl.rb

@@ -0,0 +1,82 @@
+class Optitron
+  module ClassDsl
+    
+    def self.included(o)
+      o.module_eval "
+      @@optitron_parser = Optitron::Parser.new
+      @@optitron_dsl = Optitron::Dsl.new(@@optitron_parser)
+      attr_accessor :params
+      class << self;
+        include ClassMethods
+      end"
+    end
+
+
+    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
+      end
+
+      def optitron_dsl
+        self.send(:class_variable_get, :@@optitron_dsl)
+      end
+      
+      def optitron_parser
+        self.send(:class_variable_get, :@@optitron_parser)
+      end
+      
+      def class_opt(name, desc = nil, opts = nil)
+        optitron_dsl.root.opt(name, desc, opts)
+      end
+
+      def use_help
+        optitron_dsl.root.help
+      end
+
+      def desc(desc)
+        @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 }
+          end
+        end
+        optitron_dsl.configure_options
+      end
+
+      def dispatch
+        build
+        optitron_parser.target = new
+        response = optitron_parser.parse(ARGV)
+        if response.valid?
+          optitron_parser.target.params = response.params
+          args = response.args
+          while (args.size < optitron_parser.commands[response.command].args.size)
+            args << optitron_parser.commands[response.command].args[args.size].default
+          end
+          optitron_parser.target.send(response.command.to_sym, *response.args)
+        else
+          puts response.error_messages.join("\n")
+        end
+      end
+    end
+  end
+end

data/lib/optitron/dsl.rb

@@ -1,23 +1,30 @@
 class Optitron
   class Dsl
+    attr_reader :root
 
     def initialize(parser, &blk)
-      root = RootParserDsl.new(parser)
-      root.configure_with(blk)
-      root.unclaimed_opts.each do |opt_option|
+      @root = RootParserDsl.new(parser)
+      if blk
+        @root.configure_with(&blk)
+        configure_options
+      end
+    end
+
+    def configure_options
+      @root.unclaimed_opts.each do |opt_option|
         name = opt_option.name
-        if !root.short_opts.key?(name[0].chr)
+        if !@root.short_opts.key?(name[0].chr)
           opt_option.short_name = name[0].chr
-          root.short_opts[name[0].chr] = opt_option
-        elsif !root.short_opts.key?(name.upcase[0].chr)
+          @root.short_opts[name[0].chr] = opt_option
+        elsif !@root.short_opts.key?(name.upcase[0].chr)
           opt_option.short_name = name.upcase[0].chr
-          root.short_opts[name.upcase[0].chr] = opt_option
+          @root.short_opts[name.upcase[0].chr] = opt_option
         end
       end
     end
-
+    
     class AbstractDsl
-      def configure_with(block)
+      def configure_with(&block)
         instance_eval(&block)
       end
       
@@ -63,13 +70,24 @@ class Optitron
         @unclaimed_opts = []
       end
 
+      def help(desc = "Print help message")
+        configure_with {
+          opt 'help', desc, :short_name => '?', :run => proc{ |value, response|
+            if value
+              puts @target.help
+              exit(0)
+            end
+          }
+        }
+      end
+
       def short_opts
         @target.short_opts
       end
 
       def cmd(name, description = nil, opts = nil, &blk)
         command_option = Option::Cmd.new(name, description, opts)
-        CmdParserDsl.new(self, command_option).configure_with(blk) if blk
+        CmdParserDsl.new(self, command_option).configure_with(&blk) if blk
         @target.commands[name] = command_option
       end
     end

data/lib/optitron/help.rb

@@ -7,7 +7,7 @@ class Optitron
     def help_line_for_opt(opt)
       opt_line = ''
       opt_line << [opt.short_name ? "-#{opt.short_name}" : nil, "--#{opt.name}"].compact.join('/')
-      opt_line << "=[#{opt.type.to_s.upcase}]" if opt.type != :boolean
+      opt_line << "=[#{opt.type.to_s.upcase}]" unless opt.boolean?
       [opt_line, opt.desc]
     end
 

data/lib/optitron/option.rb

@@ -35,6 +35,34 @@ class Optitron
       end
     end
 
+    def boolean?
+      @type == :boolean
+    end
+
+    def numeric?
+      @type == :numeric
+    end
+
+    def array?
+      @type == :array
+    end
+
+    def string?
+      @type == :string
+    end
+
+    def hash?
+      @type == :hash
+    end
+
+    def greedy?
+      @type == :greedy
+    end
+
+    def any?
+      @type.nil?
+    end
+
     def validate(val)
       validated_type = case @type
       when :boolean
@@ -61,7 +89,7 @@ class Optitron
     end
 
     class Opt < Option
-      attr_accessor :short_name
+      attr_accessor :short_name, :run
       def initialize(name, desc = nil, opts = nil)
         if desc.is_a?(Hash)
           desc, opts = nil, desc
@@ -69,6 +97,7 @@ class Optitron
         @name, @desc = name, desc
         @type = opts && opts[:type] || :boolean
         self.short_name = opts[:short_name] if opts && opts[:short_name]
+        self.run = opts[:run] if opts && opts[:run]
         self.inclusion_test = opts[:in] if opts && opts[:in]
         self.default = opts && opts.key?(:default) ? opts[:default] : (@type == :boolean ? false : nil)
       end
@@ -137,12 +166,13 @@ class Optitron
     end
     
     class Cmd < Option
-      attr_reader :options, :args
+      attr_reader :options, :args, :run
       def initialize(name, desc = nil, opts = nil)
         if desc.is_a?(Hash)
           desc, opts = nil, desc
         end
         @name, @desc = name, desc
+        @run = opts[:run] if opts && opts[:run]
         @options = []
         @args = []
       end
@@ -157,7 +187,8 @@ class Optitron
         end
         @name, @desc = name, desc
         self.inclusion_test = opts[:in] if opts && opts[:in]
-        @required = opts && opts.key?(:required) ? opts[:required] : true
+        @default = opts && opts[:default]
+        @required = opts && opts.key?(:required) ? opts[:required] : @default.nil?
         @type = opts && opts[:type]
       end
       

data/lib/optitron/parser.rb

@@ -20,7 +20,7 @@ class Optitron
       response = Response.new(self, tokens)
       options = @options 
       args = @args
-      if !@commands.empty?
+      unless @commands.empty?
         potential_cmd_toks = tokens.select { |t| t.respond_to?(:lit) }
         if cmd_tok = potential_cmd_toks.find { |t| @commands[t.lit] }
           tokens.delete(cmd_tok)

data/lib/optitron/response.rb

@@ -33,6 +33,7 @@ class Optitron
     
     def validate
       compile_params
+      @params_array.each { |(key, value)| key.run.call(params[key.name], self) if key.run }
       @args = @args_with_tokens.map { |(arg, tok)| 
         begin
           tok.is_a?(Array) ? tok.map{ |t| arg.validate(t.lit) } : arg.validate(tok.lit)
@@ -62,8 +63,6 @@ class Optitron
         dispatch_args = params.empty? ? args : args + [params]
         @parser.target.send(command.to_sym, *dispatch_args)
       else
-        puts @parser.help
-        puts "\nErrors:"
         puts error_messages.join("\n")
       end
     end

data/lib/optitron/tokenizer.rb

@@ -14,10 +14,10 @@ class Optitron
       unless @tokens
         @tokens = @opts.map {|t|
           case t
-          when /^--([^=]+)=([^=]+)$/ then NamedWithValue.new($1, $2)
-          when /^--([^=]+)$/         then NamedWithValue.new($1, nil)
-          when /^-(.*)/              then find_names_values($1)
-          else                            Value.new(t)
+          when /^--([^-][^=]+)=([^=]+)$/ then NamedWithValue.new($1, $2)
+          when /^--([^-][^=]+)$/         then NamedWithValue.new($1, nil)
+          when /^-(.*)/                  then find_names_values($1)
+          else                                Value.new(t)
           end
         }
         @tokens.flatten!
@@ -30,7 +30,7 @@ class Optitron
       while !letters.empty?
         let = letters.shift
         toks << Named.new(let)
-        if @parser.short_opts[let] && @parser.short_opts[let].type != :boolean && !letters.empty?
+        if @parser.short_opts[let] && !@parser.short_opts[let].boolean? && !letters.empty?
           toks << Value.new(letters.join)
           letters.clear
         end

data/lib/optitron/version.rb

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

data/spec/option_spec.rb

@@ -79,8 +79,8 @@ describe "Optitron::Parser options" do
       }
     end
     
-    it "should parse '-otest'" do
-      @parser.parse(%w(-otest)).params.should == {'option' => 'test', '1' => false, '2' => false, '3' => false}
+    it "should parse '-123otest'" do
+      @parser.parse(%w(-123otest)).params.should == {'option' => 'test', '1' => true, '2' => true, '3' => true}
     end
 
     it "should parse '-123o test'" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: optitron
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: false
   segments: 
   - 0
   - 0
-  - 8
-  version: 0.0.8
+  - 9
+  version: 0.0.9
 platform: ruby
 authors: 
 - Joshua Hull
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-17 00:00:00 -07:00
+date: 2010-08-18 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -51,6 +51,7 @@ files:
 - README.rdoc
 - Rakefile
 - lib/optitron.rb
+- lib/optitron/class_dsl.rb
 - lib/optitron/dsl.rb
 - lib/optitron/help.rb
 - lib/optitron/option.rb