rprogram 0.1.1 → 0.1.2

data/History.txt

@@ -1,3 +1,10 @@
+== 0.1.2 / 2008-01-18
+
+* DRY'ed up lib/rprogram/task.
+  * Added Task.define_option.
+* Added OptionList so that Option may contain sub-options.
+* Touched up documenation.
+
 == 0.1.1 / 2008-01-18
 
 * Added support for the Option argument separators.
@@ -14,8 +21,8 @@
 == 0.1.0 / 2008-01-17
 
 * Removed redundent methods in Program:
- * +Program.find_by_name+
- * +Program.find_by_names+
+  * Program.find_by_name
+  * Program.find_by_names
 * Added Program#create.
 * Made Program Nameable by default.
 * Prevented arbitrary command-injection in Program#run.

data/Manifest.txt

@@ -9,7 +9,10 @@ lib/rprogram/exceptions/program_not_found.rb
 lib/rprogram/exceptions.rb
 lib/rprogram/extensions/meta/object.rb
 lib/rprogram/extensions/meta.rb
+lib/rprogram/extensions/array.rb
+lib/rprogram/extensions/hash.rb
 lib/rprogram/extensions.rb
+lib/rprogram/option_list.rb
 lib/rprogram/option.rb
 lib/rprogram/non_option.rb
 lib/rprogram/options.rb

data/lib/rprogram/extensions/array.rb

@@ -0,0 +1,7 @@
+class Array
+
+  def arguments
+    compact
+  end
+
+end

data/lib/rprogram/extensions/hash.rb

@@ -0,0 +1,15 @@
+class Hash
+
+  def arguments
+    map { |key,value|
+      if value
+        if value==true
+          key.to_s
+        else
+          "#{key}=#{value}"
+        end
+      end
+    }.compact
+  end
+
+end

data/lib/rprogram/extensions.rb

@@ -1 +1,3 @@
 require 'rprogram/extensions/meta'
+require 'rprogram/extensions/array'
+require 'rprogram/extensions/hash'

data/lib/rprogram/option.rb

@@ -1,3 +1,5 @@
+require 'rprogram/extensions'
+
 module RProgram
   class Option
 
@@ -13,21 +15,30 @@ module RProgram
     # Argument separator
     attr_reader :separator
 
+    # Does the option contain sub-options
+    attr_reader :sub_options
+
     #
     # Creates a new Option object with the specified _options_. If a _block_
     # is given it will be used for the custom formating of the option. If a
     # _block_ is not given, the option will use the default_format when
     # generating the arguments.
     #
-    # _options_ may contain the following keys:
+    # _options_ must contain the following key:
     # <tt>:flag</tt>:: The command-line flag to use.
-    # <tt>:equals</tt>:: Implies the option maybe formated as '--flag=value'.
-    #                    Defaults to +falue+, if not given.
-    # <tt>:multuple</tt>:: Implies the option maybe given an Array of
+    #
+    # _options_ may also contain the following keys:
+    # <tt>:equals</tt>:: Implies the option maybe formated as
+    #                    <tt>"--flag=value"</tt>. Defaults to +falue+, if
+    #                    not given.
+    # <tt>:multuple</tt>:: Specifies the option maybe given an Array of
     #                      values. Defaults to +false+, if not given.
     # <tt>:separator</tt>:: The separator to use for formating multiple
     #                       arguments into one +String+. Cannot be used
-    #                       with +:multiple+.
+    #                       with <tt>:multiple</tt>.
+    # <tt>:sub_options</tt>:: Specifies that the option contains
+    #                         sub-options. Defaults to false, if not given.
+    #
     #
     def initialize(options={},&block)
       @flag = options[:flag]
@@ -35,6 +46,7 @@ module RProgram
       @equals = options[:equals] || false
       @multiple = options[:multiple] || false
       @separator = options[:separator]
+      @sub_options = options[:sub_options] || false
 
       @formating = block
     end
@@ -47,24 +59,21 @@ module RProgram
       return [@flag] if value==true
       return [] if (value==nil || value==false)
 
-      if value.kind_of?(Hash)
-        value = value.map { |name,value| "#{name}=#{value}" }
-      elsif value.kind_of?(Array)
-        value = value.compact
+      if value.respond_to?(:arguments)
+        value = value.arguments
       end
 
       if @multiple
-        args = []
-
-        value.each { |arg| args += format(arg) }
-        return args
-      else
-        if (value.kind_of?(Array) && @separator)
-          value = value.join(@separator)
+        if value.respond_to?(:map)
+          return value.map { |arg| format(arg) }
         end
+      end
 
-        return format(value)
+      if (value.kind_of?(Array) && @separator)
+        value = value.join(@separator)
       end
+
+      return format(value)
     end
 
     protected

data/lib/rprogram/option_list.rb

@@ -0,0 +1,27 @@
+require 'rprogram/extensions/hash'
+
+module RProgram
+  class OptionList < Hash
+
+    def initialize(options={})
+      super(options)
+    end
+
+    protected
+
+    def method_missing(sym,*args,&block)
+      name = sym.to_s
+
+      unless block
+        if (name =~ /=$/ && args.length==1)
+          return self[name.chop.to_sym] = args[0]
+        elsif args.length==0
+          return self[sym]
+        end
+      end
+
+      super(sym,*args,&block)
+    end
+
+  end
+end

data/lib/rprogram/task.rb

@@ -1,4 +1,5 @@
 require 'rprogram/options'
+require 'rprogram/option_list'
 
 module RProgram
   class Task
@@ -163,43 +164,71 @@ module RProgram
     end
 
     #
-    # Defines a long-option with the given _opts_.
+    # Defines a long-option with the specified _opts_.
+    #
+    # _opts_ must contain the following keys:
+    # <tt>:flag</tt>:: The flag to use for the option.
+    #
+    # _opts_ may also contain the following keys:
+    # <tt>:name</tt>:: The name of the option. Defaults to the
+    #                  flag_namify'ed form of <tt>opts[:flag]</tt>, if not
+    #                  given.
+    # <tt>:multiply</tt>:: Specifies that the option may appear multiple
+    #                      times in the arguments.
+    # <tt>:sub_options</tt>:: Specifies that the option contains multiple
+    #                  sub-options.
     #
     #   long_option :flag => '--output'
     #
     #   long_option :flag => '-f', :name => :file
     #
     def self.long_option(opts={},&block)
-      flag = opts[:flag].to_s
-      method_name = (opts[:name] || Task.flag_namify(flag)).to_sym
-
-      self.options[method_name] = Option.new(opts,&block)
+      opts[:name] ||= Task.flag_namify(opts[:flag])
 
-      class_def(method_name) do
-        if opts[:multiple]
-          @options[method_name] ||= []
-        else
-          @options[method_name]
-        end
-      end
-
-      class_def("#{method_name}=") do |value|
-        @options[method_name] = value
-      end
+      define_option(opts,&block)
     end
 
     #
-    # Defines a short_option with the given _opts_.
+    # Defines a short_option with the specified _opts_.
+    #
+    # _opts_ must contain the following keys:
+    # <tt>:name</tt>:: The name of the option.
+    # <tt>:flag</tt>:: The flag to use for the option.
+    #
+    # _opts_ may also contain the following keys:
+    # <tt>:multiply</tt>:: Specifies that the option may appear multiple
+    #                      times in the arguments.
+    # <tt>:sub_options</tt>:: Specifies that the option contains multiple
+    #                  sub-options.
     #
     #   short_option :flag => '-c', :name => :count
     #
-    def self.short_option(opts={},&block)
+    def self.short_option(opts,&block)
+      define_option(opts,&block)
+    end
+
+    #
+    # Defines an option with the specified _opts_ and the given _block_.
+    #
+    # _opts_ must contain the following keys:
+    # <tt>:name</tt>:: The name of the option.
+    # <tt>:flag</tt>:: The flag to use for the option.
+    #
+    # _opts_ may also contain the following keys:
+    # <tt>:multiply</tt>:: Specifies that the option may appear multiple
+    #                      times in the arguments.
+    # <tt>:sub_options</tt>:: Specifies that the option contains multiple
+    #                  sub-options.
+    #
+    def self.define_option(opts,&block)
       method_name = opts[:name].to_sym
 
       self.options[method_name] = Option.new(opts,&block)
 
       class_def(method_name) do
-        if opts[:multiple]
+        if opts[:sub_options]
+          @options[method_name] ||= OptionList.new
+        elsif opts[:multiple]
           @options[method_name] ||= []
         else
           @options[method_name]
@@ -207,7 +236,11 @@ module RProgram
       end
 
       class_def("#{method_name}=") do |value|
-        @options[method_name] = value
+        if opts[:sub_options]
+          @options[method_name] = OptionList.new(value)
+        else
+          @options[method_name] = value
+        end
       end
     end
 

data/lib/rprogram/version.rb

@@ -1,3 +1,3 @@
 module RProgram
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rprogram
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Postmodern Modulus III
@@ -43,7 +43,10 @@ files:
 - lib/rprogram/exceptions.rb
 - lib/rprogram/extensions/meta/object.rb
 - lib/rprogram/extensions/meta.rb
+- lib/rprogram/extensions/array.rb
+- lib/rprogram/extensions/hash.rb
 - lib/rprogram/extensions.rb
+- lib/rprogram/option_list.rb
 - lib/rprogram/option.rb
 - lib/rprogram/non_option.rb
 - lib/rprogram/options.rb