choosy 0.2.5 → 0.3.0

data/lib/choosy/command.rb

@@ -7,6 +7,18 @@ require 'choosy/verifier'
 module Choosy
   class Command < BaseCommand
     attr_accessor :executor, :arguments
+    attr_reader :parent
+
+    def initialize(name, supercommand=nil)
+      super(name)
+      self.parent = supercommand
+    end
+
+    def parent=(value)
+      @parent = value
+      return if @parent.nil?
+      raise Choosy::ConfigurationError.new("Parent must be a super command") unless Choosy::SuperCommand
+    end
     
     def execute!(args)
       raise Choosy::ConfigurationError.new("No executor given for: #{name}") unless executor
@@ -18,13 +30,17 @@ module Choosy
       end
     end
 
+    def subcommand?
+      !@parent.nil?
+    end
+
     protected
     def create_builder
       Choosy::DSL::CommandBuilder.new(self)
     end
 
     def handle_help(hc)
-      puts printer.print!(self)
+      printer.print!(self)
     end
 
     def parse(args)

data/lib/choosy/converter.rb

@@ -36,6 +36,10 @@ module Choosy
     end
 
     def self.convert(ty, value)
+      if ty.nil?
+        raise ArgumentError.new("Can't convert nil to a type.")
+      end
+
       if CONVERSIONS.has_key?(ty)
         send(ty, value)
       else
@@ -72,7 +76,7 @@ module Choosy
     end
 
     def self.file(value)
-      if File.exist?(value)
+      if File.file?(value)
         File.new(value)
       else
         raise Choosy::ValidationError.new("Unable to locate file: '#{value}'")

data/lib/choosy/dsl/argument_builder.rb

@@ -1,34 +1,52 @@
 require 'choosy/errors'
 require 'choosy/argument'
 require 'choosy/converter'
+require 'choosy/dsl/base_builder'
 
 module Choosy::DSL
   class ArgumentBuilder
+    include BaseBuilder
+
     def initialize
       @count_called = false
     end
 
-    def argument
-      @argument ||= Choosy::Argument.new
+    def entity
+      @entity ||= Choosy::Argument.new
     end
-    
+
     def required(value=nil)
-      argument.required = if value.nil? || value == true
+      entity.required = if value.nil? || value == true
                           true
                         else 
                           false
                         end
     end
 
+    def only(*args)
+      if args.nil? || args.empty?
+        raise Choosy::ConfigurationError.new("'only' requires at least one argument")
+      end
+
+      entity.allowable_values = args
+      if args.length > 0 && entity.cast_to.nil?
+        if args[0].is_a?(Symbol) 
+          cast :symbol
+        else
+          cast :string
+        end
+      end
+    end
+
     def metaname(meta)
       return if meta.nil?
-      argument.metaname = meta
+      entity.metaname = meta
       return if @count_called
       
       if meta =~ /\+$/
-        argument.multiple!
+        entity.multiple!
       else
-        argument.single!
+        entity.single!
       end
     end
 
@@ -44,40 +62,34 @@ module Choosy::DSL
           raise Choosy::ConfigurationError.new("The upper bound (#{upper_bound}) is less than the lower bound (#{lower_bound}).")
         end
         
-        argument.arity = (lower_bound .. upper_bound)
+        entity.arity = (lower_bound .. upper_bound)
       elsif restriction.is_a?(Range)
-        argument.arity = restriction
+        entity.arity = restriction
       elsif restriction == :zero || restriction == :none
-        argument.boolean!
+        entity.boolean!
       elsif restriction == :once
-        argument.single!
+        entity.single!
       else
         check_count(restriction)
-        argument.arity = (restriction .. restriction)
+        entity.arity = (restriction .. restriction)
       end
     end
 
     def cast(ty)
-      argument.cast_to = Choosy::Converter.for(ty)
-      if argument.cast_to.nil?
+      entity.cast_to = Choosy::Converter.for(ty)
+      if entity.cast_to.nil?
         raise Choosy::ConfigurationError.new("Unknown conversion cast: #{ty}")
       end
     end
     
     def validate(&block)
-      argument.validation_step = block
+      entity.validation_step = block
     end
     
     def die(msg)
       raise Choosy::ValidationError.new("argument error: #{msg}")
     end
 
-    def finalize!
-      if argument.arity.nil?
-        argument.boolean!
-      end
-    end
-
     protected
     def check_count(count)
       if !count.is_a?(Integer)

data/lib/choosy/dsl/base_builder.rb

@@ -0,0 +1,26 @@
+require 'choosy/errors'
+
+module Choosy::DSL
+  # Must have entity attribute
+  module BaseBuilder
+    # Adapted from: http://www.dcmanges.com/blog/ruby-dsls-instance-eval-with-delegation
+    def evaluate!(&block)
+      if block_given?
+        @self_before_instance_eval = eval "self", block.binding
+        instance_eval(&block)
+      end
+      @self_before_instance_eval = nil
+
+      entity.finalize!
+      entity
+    end
+    
+    def method_missing(method, *args, &block)
+      if @self_before_instance_eval
+        @self_before_instance_eval.send(method, *args, &block)
+      else
+        raise NoMethodError.new("undefined method '#{method}' for #{self.class.name}")
+      end
+    end
+  end
+end

data/lib/choosy/dsl/base_command_builder.rb

@@ -1,27 +1,33 @@
 require 'choosy/errors'
 require 'choosy/dsl/option_builder'
+require 'choosy/dsl/base_builder'
+require 'choosy/printing/manpage_printer'
 require 'choosy/printing/erb_printer'
 require 'choosy/printing/formatting_element'
 
 module Choosy::DSL
   class BaseCommandBuilder
-    attr_reader :command
+    include BaseBuilder
+
+    attr_reader :entity
 
     def initialize(command)
-      @command = command
+      @entity = command
     end
 
     # Generic setup
 
     def summary(msg)
-      @command.summary = msg
+      @entity.summary = msg
     end
 
     def printer(kind, options={})
-      @command.printer =  if kind == :standard
+      @entity.printer =  if kind == :standard
                             Choosy::Printing::HelpPrinter.new(options)
                           elsif kind == :erb
                             Choosy::Printing::ERBPrinter.new(options)
+                          elsif kind == :manpage
+                            Choosy::Printing::ManpagePrinter.new(options)
                           elsif kind.respond_to?(:print!)
                             kind
                           else
@@ -32,11 +38,11 @@ module Choosy::DSL
     # Formatting
 
     def header(msg, *styles)
-      @command.listing << Choosy::Printing::FormattingElement.new(:header, msg, styles)
+      @entity.listing << Choosy::Printing::FormattingElement.new(:header, msg, styles)
     end
 
     def para(msg=nil, *styles)
-      @command.listing << Choosy::Printing::FormattingElement.new(:para, msg, styles)
+      @entity.listing << Choosy::Printing::FormattingElement.new(:para, msg, styles)
     end
 
     # Options
@@ -64,10 +70,7 @@ module Choosy::DSL
         raise Choosy::ConfigurationError.new("No configuration block was given") if !block_given?
       end
 
-      if block_given?
-        builder.instance_eval(&block)
-      end
-      finalize_option_builder builder
+      evaluate_option_builder!(builder, &block)
     end
 
     def self.create_conversions
@@ -123,30 +126,23 @@ module Choosy::DSL
       v = OptionBuilder.new(OptionBuilder::VERSION)
       v.long '--version'
       v.desc "The version number"
+      # TODO: research how this should be refactored, used with manpage
+      # v.default msg
+      v.cast :boolean
 
       v.validate do
         raise Choosy::VersionCalled.new(msg)
       end
 
-      if block_given?
-        v.instance_eval(&block)
-      end
-      finalize_option_builder v
-    end
-
-    def finalize!
-      if @command.printer.nil?
-        printer :standard
-      end
+      evaluate_option_builder!(v, &block)
     end
 
     protected
-    def finalize_option_builder(option_builder)
-      option_builder.finalize!
-      @command.option_builders[option_builder.option.name] = option_builder
-      @command.listing << option_builder.option
-
-      option_builder.option
+    def evaluate_option_builder!(builder, &block)
+      builder.evaluate!(&block)
+      @entity.listing << builder.entity
+      @entity.option_builders[builder.entity.name] = builder
+      builder.entity
     end
 
     private
@@ -170,10 +166,7 @@ module Choosy::DSL
       end
       builder.from_hash config if config
 
-      if block_given?
-        builder.instance_eval(&block)
-      end
-      finalize_option_builder builder
+      evaluate_option_builder!(builder, &block)
     end
 
     def format_meta(name, count)

data/lib/choosy/dsl/command_builder.rb

@@ -9,7 +9,7 @@ module Choosy::DSL
     def executor(exec=nil, &block)
       if exec.nil? 
         if block_given?
-          @command.executor = block
+          @entity.executor = block
         else
           raise Choosy::ConfigurationError.new("The executor was nil")
         end
@@ -17,11 +17,11 @@ module Choosy::DSL
         if !exec.respond_to?(:execute!)
           raise Choosy::ConfigurationError.new("Execution class doesn't implement 'execute!'")
         end
-        @command.executor = exec
+        @entity.executor = exec
       end
     end
 
-    def help(msg=nil)
+    def help(msg=nil, &block)
       h = OptionBuilder.new(OptionBuilder::HELP)
       h.short '-h'
       h.long '--help'
@@ -32,24 +32,20 @@ module Choosy::DSL
         raise Choosy::HelpCalled.new(@name)
       end 
 
-      finalize_option_builder h
+      evaluate_option_builder!(h, &block)
     end
 
     def arguments(&block)
       builder = ArgumentBuilder.new
       # Set multiple by default
-      builder.argument.multiple!
-
-      if block_given?
-        builder.instance_eval(&block)
-      end
+      builder.entity.multiple!
+      builder.evaluate!(&block)
       
-      builder.finalize!
-      if builder.argument.metaname.nil?
+      if builder.entity.metaname.nil?
         builder.metaname 'ARGS+'
       end
 
-      command.arguments = builder.argument
+      entity.arguments = builder.entity
     end
   end
 end

data/lib/choosy/dsl/option_builder.rb

@@ -13,19 +13,17 @@ module Choosy::DSL
       @name = name
     end
 
-    def option
-      @argument ||= Choosy::Option.new(@name)
+    def entity
+      @entity ||= Choosy::Option.new(@name)
     end
 
-    alias :argument :option
-
     def short(flag, meta=nil)
-      option.short_flag = flag
+      entity.short_flag = flag
       metaname(meta)
     end
 
     def long(flag, meta=nil)
-      option.long_flag = flag
+      entity.long_flag = flag
       metaname(meta)
     end
 
@@ -36,37 +34,33 @@ module Choosy::DSL
     end
 
     def desc(description)
-      option.description = description
+      entity.description = description
     end
 
     def default(value)
-      option.default_value = value
+      entity.default_value = value
     end
 
     def depends_on(*args)
       if args.length == 1 && args[0].is_a?(Array)
-        option.dependent_options = args[0]
+        entity.dependent_options = args[0]
       else
-        option.dependent_options = args
+        entity.dependent_options = args
       end
     end
 
-    def only(*args)
-      option.allowable_values = args
-    end
-
     def negate(prefix=nil)
       prefix ||= 'no'
-      option.negation = prefix
+      entity.negation = prefix
     end
 
     def die(msg)
-      flag_fmt = if option.short_flag && option.long_flag
-                   "#{option.short_flag}/#{option.long_flag}"
+      flag_fmt = if entity.short_flag && entity.long_flag
+                   "#{entity.short_flag}/#{entity.long_flag}"
                  end
-      flag_fmt ||= option.short_flag || option.long_flag
-      flag_meta = if option.metaname
-                     " #{option.metaname}"
+      flag_fmt ||= entity.short_flag || entity.long_flag
+      flag_meta = if entity.metaname
+                     " #{entity.metaname}"
                    end
       raise Choosy::ValidationError.new("#{flag_fmt}#{flag_meta}: #{msg}")
     end
@@ -86,30 +80,5 @@ module Choosy::DSL
         end
       end
     end
-    
-    def finalize!
-      super
-
-      if option.cast_to.nil?
-        if option.boolean?
-          option.cast_to = :boolean
-        else
-          option.cast_to = :string
-        end
-      end
-
-      if option.boolean?
-        if option.restricted?
-          raise Choosy::ConfigurationError.new("Options cannot be both boolean and restricted to certain arguments: #{option.name}")
-        elsif option.negated? && option.long_flag.nil?
-          raise Choosy::ConfigurationError.new("The long flag is required for negation: #{option.name}")
-        end
-        option.default_value ||= false
-      else
-        if option.negated?
-          raise Choosy::ConfigurationError.new("Unable to negate a non-boolean option: #{option.name}")
-        end
-      end
-    end
   end
 end

data/lib/choosy/dsl/super_command_builder.rb

@@ -9,26 +9,28 @@ module Choosy::DSL
 
     def command(cmd, &block)
       subcommand = if cmd.is_a?(Choosy::Command)
+                     cmd.parent = entity
                      cmd
                    else
-                     Choosy::Command.new(cmd)
+                     Choosy::Command.new(cmd, entity)
                    end
 
-      if block_given?
-        subcommand.builder.instance_eval(&block)
-      end
-      finalize_subcommand(subcommand)
+      evaluate_command_builder!(subcommand.builder, &block)
     end
 
     def parsimonious
-      @command.parsimonious = true
+      @entity.parsimonious = true
     end
 
     def metaname(meta)
-      @command.metaname = meta
+      @entity.metaname = meta
+    end
+
+    def default(cmd)
+      @entity.default_command = cmd
     end
 
-    def help(msg=nil)
+    def help(msg=nil, &block)
       msg ||= "Show the info for a command, or this message"
       help_command = Choosy::Command.new HELP do |help|
         help.summary msg
@@ -50,20 +52,15 @@ module Choosy::DSL
           end
         end
       end
-      finalize_subcommand(help_command)
-    end
-
-    def finalize!
-      super
-      @command.metaname ||= 'COMMAND'
+      evaluate_command_builder!(help_command.builder, &block)
     end
 
-    private
-    def finalize_subcommand(subcommand)
-      subcommand.builder.finalize!
-      @command.command_builders[subcommand.name] = subcommand.builder
-      @command.listing << subcommand
-      subcommand
+    protected
+    def evaluate_command_builder!(builder, &block)
+      builder.evaluate!(&block)
+      @entity.listing << builder.entity
+      @entity.command_builders[builder.entity.name] = builder
+      builder.entity
     end
   end
 end

data/lib/choosy/errors.rb

@@ -8,4 +8,5 @@ module Choosy
   ConversionError    = Class.new(Choosy::Error)
   ParseError         = Class.new(Choosy::Error)
   SuperParseError    = Class.new(Choosy::Error)
+  VersionError       = Class.new(Choosy::Error)
 end

data/lib/choosy/option.rb

@@ -1,3 +1,4 @@
+require 'choosy/errors'
 require 'choosy/argument'
 
 module Choosy
@@ -20,5 +21,23 @@ module Choosy
     def negated
       @negated ||= long_flag.gsub(/^--/, "--#{negation}-")
     end
+
+    def finalize!
+      @arity ||= ZERO_ARITY
+      @cast_to ||= boolean? ? :boolean : :string
+
+      if boolean?
+        if restricted?
+          raise Choosy::ConfigurationError.new("Options cannot be both boolean and restricted to certain arguments: #{@name}")
+        elsif negated? && @long_flag.nil?
+          raise Choosy::ConfigurationError.new("The long flag is required for negation: #{@name}")
+        end
+        @default_value ||= false
+      else
+        if negated?
+          raise Choosy::ConfigurationError.new("Unable to negate a non-boolean option: #{@name}")
+        end
+      end
+    end
   end
 end