ark-cli 0.6.0 → 0.6.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a54741976deb70204c112ab5ee3ec996463ddaf6
-  data.tar.gz: bf135aed0b692a6d591dff1160773a83b896ad32
+  metadata.gz: 7c49459aed6110db0623fdd6a8404476f396e7c5
+  data.tar.gz: 0d928dbdf78fc4f50b8bc304b7bca4ba2897048c
 SHA512:
-  metadata.gz: b84c3e4562701df554ab07d821140ff4cb02c765c6aebe8d633f4a54f30e595b8d5f7eda3bf0c3b6046f2c4bca6c03eee032c790139cdcc5b431f7ef72207811
-  data.tar.gz: 819682f6427f6d4e0397a43f11ae91cb83ad54b6e4ef411dacded492c7384a6bfa43af917248cb9b1ff6f4fd8a57986f31ee3debb82f3ba59ad5242aa26b95c2
+  metadata.gz: dafceeb2dba2b2d27f70124c298814a750841dc51f8140c81df519cb5b6cdfabc3af7e2b8adc30e0a8f5bfafddb379bfac67fb4d3ce26d79cd40b7134927c09a
+  data.tar.gz: aad0ec6ed111baa93a6e430dc2b3050b474176c7f888e0d8252cfa551ecf5a5e69d0efd864049383ecfebdcacdbf93d3e168b271db73a3a0b43d50ea4e022823

data/lib/ark/cli.rb

@@ -18,8 +18,9 @@
 require 'ark/utility'
 include Ark::Log
 
-require_relative 'cli/interface.rb'
+require_relative 'cli/argument.rb'
 require_relative 'cli/option.rb'
+require_relative 'cli/interface.rb'
 require_relative 'cli/spec.rb'
 require_relative 'cli/report.rb'
 

data/lib/ark/cli/argument.rb

@@ -0,0 +1,127 @@
+module Ark # :nodoc:
+module CLI
+
+# Represents an argument, either to the program itself or for options which
+# take arguments.
+class Argument
+
+  # Raised when invalid argument syntax is given
+  class ArgumentSyntaxError < ArgumentError
+  end
+
+  # Raised when an argument value is set improperly
+  class ArgumentSetError < RuntimeError
+  end
+
+  # Parse an argument name and return an Argument object
+  def self.parse(arg)
+    arg = arg.to_s
+    name = self.strip_arg(arg)
+    if self.has_default?(arg)
+      default = self.parse_default(arg)
+      return Argument.new(name, default)
+    elsif self.is_glob?(arg)
+      return Argument.new(name, variad: true)
+    else
+      return Argument.new(name)
+    end
+  end
+
+  # Strip any special syntax from a given argument name
+  def self.strip_arg(arg)
+    return arg.to_s[/^(\S+?)(:|\.\.\.|$)/, 1]
+  end
+
+  # Return +true+ if the given argument has a default value, like +'arg:defaultvalue'+
+  def self.has_default?(arg)
+    return !arg[/^\S+?:.+/].nil?
+  end
+
+  # Parse the default value from an arg with one
+  def self.parse_default(arg)
+    return arg[/^.+?:(.+)/, 1]
+  end
+
+  # Return +true+ if the given argument is a glob, like +'arg...'+
+  def self.is_glob?(arg)
+    return !arg[/\.\.\.$/].nil?
+  end
+
+  # Validate an option name. Names must be alphanumeric, and must begin with a
+  # letter.
+  def self.valid_name?(name)
+    return !name.to_s[/^[[:alpha:]][[:alnum:]]+$/].nil?
+  end
+
+  # Initialize a new Argument object. +name+ must be alphanumeric and must begin
+  # with a letter. If this argument is unfulfilled, +default+ will be returned
+  # as its value, if default is non-nil. If +variad+ is true, then this argument
+  # will act as a glob for all trailing args.
+  def initialize(name, default=nil, variad: false)
+    unless self.class.valid_name?(name)
+      raise ArgumentSyntaxError, "Invalid argument name: #{name}"
+    end
+    @name = name.to_s
+    @default = default
+    @variad = variad
+    if self.variadic?
+      @value = []
+    else
+      @value = nil
+    end
+  end
+
+  # Return the name of this Argument
+  attr_reader :name
+
+  # Return the value for this argument. The default value will be returned if
+  # the argument is unset and the default is non-nil. If the argument is unset
+  # and there is no default, return nil.
+  def value
+    if @value.nil?
+      return @default
+    else
+      return @value
+    end
+  end
+
+  # Push +val+ onto this argument. Only valid for variadic args. For normal
+  # arguments, use #set instead.
+  def push(val)
+    unless self.variadic?
+      raise ArgumentSetError, "Cannot push onto a normal argument. Use the #set method instead."
+    end
+    @value << val
+  end
+
+  # Set the value for this argument to +val+. Only valid for non-variadic
+  # arguments. For variadic args, use #push instead.
+  def set(val)
+    if self.variadic?
+      raise ArgumentSetError, "Cannot set the value of a glob, use the #push method instead."
+    end
+    @value = val
+  end
+
+  # Return true if this argument is a glob
+  def variadic?
+    return @variad
+  end
+
+  # Return true if this argument has a default value. Variadic arguments always
+  # return true
+  def has_default?
+    return !@default.nil? || self.variadic?
+  end
+
+  # Return true if this argument has been given a value, or if it has a default
+  # value. Variadic arguments will always return true, since they are never
+  # required and always have a default value of +[]+
+  def fulfilled?
+    return !@value.nil? || self.has_default?
+  end
+end
+
+end # module CLI
+end # module Ark
+

data/lib/ark/cli/interface.rb

@@ -32,7 +32,10 @@ class Interface
     @input = input
     @spec = Spec.new
     yield @spec
-    @spec.opt :help, :h, desc: "Print usage information"
+    @spec.opt :help, :h, desc: "Print usage information and exit"
+    if @spec.get_version
+      @spec.opt :version, :V, desc: "Print version information and exit"
+    end
     self.parse
   end
 
@@ -40,13 +43,13 @@ class Interface
   def parse()
     taking_options = true
     last_opt = nil
-    refargs = @spec.get_args.clone
 
     args = []
     trailing = []
     named = {}
     options = {}
     counts = {}
+    arg_index = 0
 
     @input.each do |word|
       dbg "Parsing '#{word}'"
@@ -82,48 +85,47 @@ class Interface
         else
           dbg "Parsed output arg", 1
           taking_options = false
-          args << word
-          key = refargs.shift
-          if key
-            if key == @spec.get_variad
-              named[key] = []
-              named[key] << word
-            else
-              named[key] = word
-            end
+          arg = @spec.get_args.values[arg_index]
+          arg_index += 1
+          if arg && !arg.variadic?
+            arg.set(word)
           elsif @spec.is_variadic?
-            named[@spec.get_variad] << word
+            @spec.get_variad.push(word)
           else
             trailing << word
           end
         end
       end
     end
-    if @spec.trailing_error && !trailing.empty?
-      raise InterfaceError, "Error: got trailing option(s): #{trailing.join(', ')}"
-    end
+
     @spec.get_opts.each do |name, opt|
       options[name] = opt.value
       counts[name]  = opt.count
     end
-    @spec.get_args.each do |name|
-      if named[name].nil?
-        if @spec.has_default?(name)
-          named[name] = @spec.get_default(name)
-          args << named[name]
-        else
-          unless @spec.is_variadic? && @spec.get_variad == name
-            raise InterfaceError, "Required argument '#{name.upcase}' was not given."
-          end
-        end
-      end
-    end
-    if @spec.is_variadic?
-      named[@spec.get_variad] ||= []
+
+    @spec.get_args.each do |name, arg|
+      args << arg.value
+      named[name] = arg.value
     end
+    args.flatten!
+    args += trailing
+
     @report = Report.new(args, named, trailing, options, counts)
+
     if @report.opt(:help)
-      self.print_usage()
+      self.print_usage
+    end
+
+    if @report.opt(:version)
+      self.print_version
+    end
+
+    unless @spec.get_args.values.all? {|arg| arg.fulfilled? }
+      raise InterfaceError, "Required argument '#{name.upcase}' was not given."
+    end
+
+    if @spec.trailing_error && !@report.trailing.empty?
+      raise InterfaceError, "Error: got trailing argument(s): #{trailing.join(', ')}"
     end
   end
 
@@ -131,69 +133,72 @@ class Interface
   def usage()
     tb = TextBuilder.new()
 
-    tb.next 'USAGE:'
-    tb.push @spec.get_name if @spec.get_name
+    tb.next('USAGE:')
+    tb.push(@spec.get_name) if @spec.get_name
 
     if @spec.get_opts.values.uniq.length < 5 || @spec.option_listing
       @spec.get_opts.values.uniq.each do |opt|
-        tb.push "[#{opt.header}]"
+        tb.push("[#{opt.header}]")
       end
     else
-      tb.push '[OPTION...]'
+      tb.push('[OPTION...]')
     end
 
     if @spec.has_args?
       if @spec.is_variadic?
-        singles = @spec.get_args[0..-2].map do |a|
-          if @spec.has_default?(a)
-            a = "[#{a}]"
+        singles = @spec.get_args.values[0..-2].map do |a|
+          name = a.name
+          if a.has_default?
+            name = "[#{name}]"
           end
-          a.upcase
+          name.upcase
         end
-        tb.push singles
-        v = @spec.get_args.last.upcase
-        tb.push "[#{v}1 #{v}2...]"
+        tb.push(singles)
+        v = @spec.get_variad.name.upcase
+        tb.push("[#{v}1 #{v}2...]")
       else
-        argmap = @spec.get_args.map do |a|
-          if @spec.has_default?(a)
-            a = "[#{a}]"
+        argmap = @spec.get_args.values.map do |a|
+          name = a.name
+          if a.has_default?
+            name = "[#{name}]"
           end
-          a.upcase
+          name.upcase
         end
-        tb.push argmap
+        tb.push(argmap)
       end
     end
 
-    tb.wrap indent: 7, indent_after: true, segments: true
+    tb.wrap(indent: 7, indent_after: true, segments: true)
 
     if @spec.get_desc
-      tb.skip @spec.get_desc
+      tb.skip(@spec.get_desc)
       tb.wrap(indent: 4)
     end
 
-    tb.skip 'OPTIONS:'
-    tb.skip
+    tb.skip('OPTIONS:').skip
 
     @spec.get_opts.values.uniq.each do |opt|
-      tb.indent 4
-      tb.push opt.header
+      tb.indent(4).push(opt.header)
       if opt.desc
-        tb.next
-        tb.indent 8
-        tb.push opt.desc
+        tb.next.indent(8).push(opt.desc)
       end
       tb.skip
     end
 
-    return tb.print
+    return tb.to_s
   end
 
   # Print usage information and exit
-  def print_usage()
+  def print_usage
     puts self.usage
     exit 0
   end
 
+  def print_version
+    puts @spec.get_version
+    exit 0
+  end
+
 end # class Interface
 
 end # module CLI

data/lib/ark/cli/option.rb

@@ -1,4 +1,4 @@
-module Ark
+module Ark # :nodoc:
 module CLI
 
 # Represents an option and stores the option's current state, as well as
@@ -9,15 +9,14 @@ class Option
   # [+keys+] A list of names this option will be identified by
   # [+args+] A list of argument named this option will expect
   # [+desc+] A short description of this option
-  def initialize(long, short=nil, args=nil, defaults=nil, desc=nil)
-    @long     = long
-    @short    = short
-    @args     = args || []
-    @defaults = defaults || {}
-    @vals     = []
-    @flag     = false
-    @count    = 0
-    @desc     = desc || ''
+  def initialize(long, short=nil, args=nil, desc=nil)
+    @long      = long
+    @short     = short
+    @args      = args || []
+    @flag      = false
+    @count     = 0
+    @desc      = desc || ''
+    @arg_index = 0
   end
 
   # A count of how many times this option has been given on the command line.
@@ -39,19 +38,14 @@ class Option
     return @args.length
   end
 
-  # Return a count of how many arguments this option still expects
-  def vals_needed()
-    if self.flag?
-      return 0
-    else
-      return @args.length - @vals.length
-    end
-  end
-
   # True if this option has received all the arguments it expects, or if this
   # option expects no arguments
   def full?
-    return self.vals_needed == 0
+    if self.flag?
+      return true
+    else
+      return (@args.length - @arg_index) < 1
+    end
   end
 
   # True if this option expects no arguments; opposite of #has_args?
@@ -71,9 +65,11 @@ class Option
     end
   end
 
-  # Pass an argument +arg+ to this option
-  def push(arg)
-    @vals << arg
+  # Pass an argument to this option
+  def push(val)
+    arg = @args[@arg_index]
+    @arg_index += 1
+    arg.set(val)
   end
 
   # Return the current value of this option
@@ -81,17 +77,9 @@ class Option
     if self.flag?
       return @flag
     else
-      if self.full? && @vals.length == 1
-        return @vals[0]
-      elsif self.full?
-        return @vals
-      else
-        if !@defaults.compact.empty?
-          return @defaults.length > 1 ? @defaults : @defaults.first
-        else
-          return nil
-        end
-      end
+      vals = @args.map {|a| a.value }
+      vals = vals.first if vals.length == 1
+      return vals
     end
   end
 
@@ -105,7 +93,7 @@ class Option
     if self.flag?
       args = ''
     else
-      args = ' ' + @args.join(', ').upcase
+      args = ' ' + @args.map {|a| a.name }.join(', ').upcase
     end
     short = @short ? "-#{@short} " : ''
     return "#{short}--#{@long}#{args}"

data/lib/ark/cli/report.rb

@@ -27,6 +27,11 @@ class Report
     return @trailing
   end
 
+  # Get a hash of all options and their values
+  def opts
+    return @options
+  end
+
   # Get the value of an option by +name+
   def opt(name)
     return @options[name.to_s]

data/lib/ark/cli/spec.rb

@@ -17,7 +17,7 @@ class Spec
 
   # Initialize a bare interface +Spec+
   def initialize()
-    @args = []
+    @arguments = {}
     @options = {}
     @variadic       = false
     @option_listing = false
@@ -31,49 +31,6 @@ class Spec
   # If true, an error will be raised if trailing arguments are given
   attr_reader :trailing_error
 
-  private
-
-  # Strip any special syntax from a given argument. Used when parsing arguments
-  def strip(arg)
-    return arg[/^(\S+?)(:|\.\.\.|$)/, 1]
-  end
-
-  # Return +true+ if the given argument has a default value, like +'arg:defaultvalue'+
-  def defaulted?(arg)
-    return !arg[/^\S+?:.+/].nil?
-  end
-
-  # Parse the default value from an arg with one
-  def parse_default(arg)
-    return arg[/^.+?:(.+)/, 1]
-  end
-
-  # Return +true+ if the given argument is a glob, like +'arg...'+
-  def variadic?(arg)
-    return !arg[/\.\.\.$/].nil?
-  end
-
-  # Parse a given argument, interpreting any special syntax, and storing
-  # argument information as needed
-  def parse_arg(arg, default: nil, last: false)
-    stripped = strip(arg)
-    @args << stripped
-    if defaulted?(arg)
-      @defaults[stripped] = parse_default(arg)
-    end
-    if variadic?(arg)
-      if last
-        @variadic = true
-        @variad = stripped
-      else
-        raise ArgumentSyntaxError,
-        "Variadic arguments must come last. Offending variad is '#{arg}'"
-      end
-    end
-  end
-
-  public
-
   # Get the name defined for this spec
   def get_name
     return @name
@@ -86,7 +43,12 @@ class Spec
 
   # Get an array of argument names defined for this spec
   def get_args
-    return @args
+    return @arguments
+  end
+
+  # Get version information defined for this spec
+  def get_version
+    return @version
   end
 
   # Return +true+ if this interface has any options defined for it
@@ -108,6 +70,15 @@ class Spec
     return @options[name]
   end
 
+  # Get an +Argument+ object for the given argument +name+
+  def get_arg(name)
+    name = name.to_s
+    if !@arguments.keys.member?(name)
+      raise NoSuchArgumentError, "Error, no such argument: '#{name}'"
+    end
+    return @arguments[name]
+  end
+
   # Return +true+ if this interface is variadic
   def is_variadic?
     return @variadic
@@ -118,34 +89,21 @@ class Spec
     return @variad
   end
 
-  # Return +true+ if the given argument +arg+ has a default value
-  def has_default?(arg)
-    @defaults.key?(arg.to_s)
-  end
-
-  # Return a hash of all default values
-  def get_defaults
-    return @defaults
-  end
-
-  # Return the default value of the given argument +arg+
-  def get_default(arg)
-    @defaults[arg.to_s]
-  end
-
   # Return +true+ if this interface has any arguments defined
   def has_args?
-    @args.length > 0
+    @arguments.length > 0
   end
 
   # Specify general information about the program
   # [+name+] Name of the program
   # [+desc+] Short description of the program
   # [+args+] A list of named arguments
-  def header(name: nil, desc: nil, args: [])
+  # [+version+] Current version information for the program
+  def header(name: nil, desc: nil, args: [], version: nil)
     self.name(name)
     self.desc(desc)
     self.args(args)
+    self.version(version)
   end
 
   # Set the name of the program to +str+
@@ -160,16 +118,26 @@ class Spec
 
   # Define what arguments the program will accept
   def args(*input)
-    @args = []
-    @defaults = {}
-
+    @arguments = {}
     input.flatten.each_with_index do |item, i|
       item = item.to_s
       last = (input.length - (i + 1)) == 0
-      parse_arg(item, last: last)
+      arg  = Argument.parse(item)
+      if arg.variadic?
+        if !last
+          raise ArgumentSyntaxError, "Variadic arguments must come last. Offending variad is '#{arg}'"
+        else
+          @variadic = true
+          @variad = arg
+        end
+      end
+      @arguments[arg.name] = arg
     end
+  end
 
-    @refargs = @args.clone
+  # Set the version information for the program to +str+
+  def version(str)
+    @version = str.to_s if str
   end
 
   # Define an Option
@@ -180,20 +148,8 @@ class Spec
     long = long.to_s
     short = short.to_s if short
     args = [args] if args.is_a?(String)
-    defaults = []
-    if args
-      args.map! do |arg|
-        arg = arg.to_s
-        if defaulted?(arg)
-          defaults << parse_default(arg)
-          arg = strip(arg)
-        else
-          defaults << nil
-        end
-        arg
-      end
-    end
-    o = Option.new(long, short, args, defaults, desc)
+    args.map! {|a| Argument.parse(a) } if args
+    o = Option.new(long, short, args, desc)
     @options[long] = o
     @options[short] = o if short
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ark-cli
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.8
 platform: ruby
 authors:
 - Macquarie Sharpless
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-09 00:00:00.000000000 Z
+date: 2015-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ark-util
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.0
 description: |
   A library for parsing options and arguments from the commandline. Parses ARGV
   and returns an object holding information about what options were set on the
@@ -42,6 +42,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/ark/cli.rb
+- lib/ark/cli/argument.rb
 - lib/ark/cli/interface.rb
 - lib/ark/cli/option.rb
 - lib/ark/cli/report.rb