acclaim 0.0.1 → 0.0.2

data/lib/acclaim/command.rb

@@ -1,6 +1,6 @@
 require 'acclaim/option'
 require 'acclaim/option/parser'
-require 'acclaim/options'
+require 'acclaim/option/values'
 
 module Acclaim
 
@@ -61,9 +61,8 @@ module Acclaim
       end
 
       # Adds an option to this command.
-      def option(key, args = {})
-        args.merge!(key: key)
-        options << Option.new(args)
+      def option(*args)
+        options << Option.new(*args)
       end
 
       alias :opt :option
@@ -84,7 +83,7 @@ module Acclaim
 
       # Invokes this command with a fresh set of options.
       def run(*args)
-        invoke Options.new, args
+        invoke Option::Values.new, args
         rescue Option::Parser::Error => e
           puts e.message
       end
@@ -101,7 +100,7 @@ module Acclaim
           index = args.index subcommand.line
           # If we have the subcommand AND the separator, then we have it if the
           # subcommand is before the separator.
-          index and not separator_index or index < separator_index
+          index and (not separator_index or index < separator_index)
         end.tap do |subcommand|
           if subcommand
             args.delete subcommand.line

data/lib/acclaim/option.rb

@@ -1,16 +1,24 @@
+require 'acclaim/option/arity'
+require 'acclaim/option/parser'
+
 module Acclaim
 
   # Represents a command-line option.
   class Option
 
-    attributes = %w(key names description arity default).map!(&:to_sym).freeze
+    attributes = %w().map!(&:to_sym).freeze
 
-    attr_accessor *attributes
+    attr_accessor :key, :names, :description, :type, :default
 
-    def initialize(args = {})
-      args.each do |attribute, value|
-        instance_variable_set :"@#{attribute}", value
-      end
+    def initialize(key, *args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      self.key         = key
+      self.names       = args.find_all { |arg| arg =~ Parser::SWITCH }
+      self.description = args.find     { |arg| arg !~ Parser::SWITCH }
+      self.type        = args.find     { |arg| arg.is_a? Class }
+      self.arity       = options[:arity]
+      self.default     = options[:default]
+      self.required    = options[:required]
       yield self if block_given?
     end
 
@@ -18,6 +26,18 @@ module Acclaim
       names.include? str.strip
     end
 
+    def arity
+      @arity ||= Arity.new
+    end
+
+    def arity=(arity_or_array)
+      @arity = if arity.nil? or arity_or_array.is_a? Arity
+        arity_or_array
+      else
+        Arity.new *arity_or_array
+      end
+    end
+
     def required?
       @required
     end
@@ -31,7 +51,7 @@ module Acclaim
     end
 
     def flag?
-      not arity or arity.empty? or arity == [0, 0]
+      not arity or arity == [0, 0]
     end
 
     alias :bool?    :flag?

data/lib/acclaim/option/arity.rb

@@ -0,0 +1,65 @@
+module Acclaim
+  class Option
+
+    # Represents the the number of arguments an option can take, both mandatory
+    # and optional.
+    class Arity
+
+      attr_accessor :minimum, :optional
+      alias :required :minimum
+
+      def initialize(minimum = 0, optional = 0)
+        @minimum, @optional = minimum, optional
+      end
+
+      # Returns +true+ if the option takes +n+ and only +n+ parameters.
+      def only?(n)
+        optional.zero? and minimum == n
+      end
+
+      # Returns +true+ if the option can take an infinite number of arguments.
+      def unlimited?
+        optional < 0
+      end
+
+      # Returns +true+ if the option must take a finite number of arguments.
+      def bound?
+        not unlimited?
+      end
+
+      # Returns the total number of parameters that the option may take, which
+      # is the number of mandatory parameters plus the number of optional
+      # parameters. Returns +nil+ if the option may take an infinite number of
+      # parameters.
+      def total
+        bound? ? minimum + optional : nil
+      end
+
+      def to_a
+        [ minimum, optional ]
+      end
+
+      alias :to_ary   :to_a
+      alias :to_array :to_a
+
+      def hash
+        to_a.hash
+      end
+
+      def ==(arity)
+        to_a == arity.to_a
+      end
+
+      alias :eql? :==
+      alias :===  :==
+
+      def to_s
+        "Arity: #{minimum} +#{unlimited? ? 'infinite' : optional}"
+      end
+
+      alias :inspect :to_s
+
+    end
+
+  end
+end

data/lib/acclaim/option/parser.rb

@@ -1,4 +1,4 @@
-require 'acclaim/options'
+require 'acclaim/option/values'
 
 module Acclaim
   class Option
@@ -85,7 +85,7 @@ module Acclaim
       end
 
       def build_options_instance!
-        Options.new.tap do |options_instance|
+        Values.new.tap do |options_instance|
           options.each do |option|
             key = option.key.to_sym
             options_instance[key] = option.default
@@ -94,11 +94,11 @@ module Acclaim
               if option.flag?
                 options_instance[key] = true
               else
-                minimum, optional = option.arity
+                arity = option.arity
                 args.each do |arg|
                   arg_index = argv.index arg
-                  len = if optional >= 0
-                    arg_index + minimum + optional
+                  len = if arity.bound?
+                    arg_index + arity.total
                   else
                     argv.length - 1
                   end
@@ -108,13 +108,13 @@ module Acclaim
                     case param
                       when nil, SWITCH, ARGUMENT_SEPARATOR then break
                       else
-                        break if optional >= 0 and values.count >= minimum + optional
+                        break if arity.bound? and values.count >= arity.total
                         values << param
                     end
                   end
                   count = values.count
-                  Error.raise_wrong_arg_number count, *option.arity if count < minimum
-                  options_instance[key] = if minimum == 1 and optional.zero?
+                  Error.raise_wrong_arg_number count, *option.arity if count < arity.required
+                  options_instance[key] = if arity.only? 1
                     values.first
                   else
                     values

data/lib/acclaim/option/values.rb

@@ -0,0 +1,46 @@
+module Acclaim
+  class Option
+
+    # Represents a set of option values.
+    class Values
+
+      def [](key)
+        data[key]
+      end
+
+      def []=(key, value)
+        data[key] = value
+      end
+
+      def merge!(other, &block)
+        data.merge! other.data, &block
+      end
+
+      # Handles the following cases:
+      #
+      #   options.method = value
+      #   options.method?
+      #   options.method
+      def method_missing(method, *args, &block)
+        m = method.to_s
+        case m
+          when /=$/
+            self[:"#{m.chop!}"] = args.first
+          when /\?$/
+            self[:"#{m.chop!}"] ? true : false
+          else
+            self[method]
+        end
+      end
+
+      protected
+
+      # The option values
+      def data
+        @options ||= {}
+      end
+
+    end
+
+  end
+end

data/lib/acclaim/version.rb

@@ -3,7 +3,7 @@ module Acclaim
 
     MAJOR = 0
     MINOR = 0
-    PATCH = 1
+    PATCH = 2
     BUILD = nil
 
     STRING = [ MAJOR, MINOR, PATCH, BUILD ].compact.join '.'

data/spec/acclaim/option/parser_spec.rb

@@ -32,14 +32,13 @@ describe Acclaim::Option::Parser do
       let(:options) do
         [].tap do |opts|
           ('a'..'f').each do |c|
-            hash = { key: c, names: ["-#{c}"] }
+            hash = {}
             hash[:arity] = [1, 0] if c == 'b' or c == 'f'
             hash[:required] = true if c == 'd'
-            opts << Acclaim::Option.new(hash)
+            opts << Acclaim::Option.new(c.to_sym, "-#{c}", hash)
           end
-          opts << Acclaim::Option.new(key: 'long', names: ['--long'])
-          opts << Acclaim::Option.new(key: 'params', names: ['--parameters'],
-                                      arity: [1, 1], default: [])
+          opts << Acclaim::Option.new(:long, '--long')
+          opts << Acclaim::Option.new(:params, '--parameters', arity: [1, 1], default: [])
         end
       end
 

data/spec/acclaim/option_spec.rb

@@ -0,0 +1,36 @@
+require 'acclaim/option'
+
+describe Acclaim::Option do
+
+  describe '#initialize' do
+
+    context 'when given multiple strings' do
+
+      let(:switches) { %w(-s --switch) }
+      let(:description) { 'Description' }
+      subject { Acclaim::Option.new :key, *[switches, description].flatten }
+
+      it 'should find the switches' do
+        subject.names.should == switches
+      end
+
+      it 'should find the description' do
+        subject.description.should == description
+      end
+
+    end
+
+    context 'when given a class' do
+
+      let(:type) { Integer }
+      subject { Acclaim::Option.new :key, type }
+
+      it "should use it as the option's type" do
+        subject.type.should == type
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acclaim
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &11364480 !ruby/object:Gem::Requirement
+  requirement: &7597280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *11364480
+  version_requirements: *7597280
 description: Command-line option parser and command interface.
 email: matheus.a.m.moreira@gmail.com
 executables: []
@@ -38,10 +38,12 @@ files:
 - lib/acclaim.rb
 - lib/acclaim/command.rb
 - lib/acclaim/option.rb
+- lib/acclaim/option/arity.rb
 - lib/acclaim/option/parser.rb
-- lib/acclaim/options.rb
+- lib/acclaim/option/values.rb
 - lib/acclaim/version.rb
 - spec/acclaim/option/parser_spec.rb
+- spec/acclaim/option_spec.rb
 homepage: https://github.com/matheusmoreira/acclaim
 licenses: []
 post_install_message: 

data/lib/acclaim/options.rb

@@ -1,45 +0,0 @@
-module Acclaim
-
-  # Represents a set of options.
-  class Options
-
-    def [](key)
-      data[key]
-    end
-
-    def []=(key, value)
-      data[key] = value
-    end
-
-    def merge!(other, &block)
-      data.merge! other.data, &block
-    end
-
-    # Handles the following cases:
-    #
-    #   options.method = value
-    #   options.method?
-    #   options.method
-    def method_missing(method, *args, &block)
-      m = method.to_s
-      case m
-        when /=$/
-          self[:"#{m.chop!}"] = args.first
-        when /\?$/
-          self[:"#{m.chop!}"] ? true : false
-        else
-          self[method]
-      end
-    end
-
-    protected
-
-    # The option values
-    def data
-      @options ||= {}
-    end
-
-
-  end
-
-end