clive 0.8.1 → 1.0.0

data/spec/extras/expectations.rb

@@ -0,0 +1,86 @@
+module MiniTest::Assertions
+
+  def assert_true obj, msg = nil
+    msg = message(msg) { "Expected #{mu_pp(obj)} to be true" }
+    assert(obj == true, msg)
+  end
+
+  def assert_false obj, msg = nil
+    msg = message(msg) { "Expected #{mu_pp(obj)} to be false" }
+    assert(obj == false, msg)
+  end
+
+  def assert_has o1, op, o2 = UNDEFINED, msg = nil
+    return assert_predicate o1, op, msg if UNDEFINED == o2
+    msg = message(msg) { "Expected #{mu_pp(o1)} to have #{op} #{mu_pp(o2)}" }
+    assert o1.__send__(op, o2), msg
+  end
+
+  def refute_has o1, op, o2 = UNDEFINED, msg = nil
+    return refute_predicate o1, op, msg if UNDEFINED == o2
+    msg = message(msg) { "Expected #{mu_pp(o1)} to not have #{op} #{mu_pp(o2)}" }
+    refute o1.__send__(op, o2), msg
+  end
+
+  def assert_has_option obj, name, msg = nil
+    msg = message(msg) { "Expected #{mu_pp(obj)} to have the option #{name}" }
+    assert obj.has_option?(name), msg
+  end
+
+  def assert_has_command obj, name, msg = nil
+    msg = message(msg) { "Expected #{mu_pp(obj)} to have the command #{name}" }
+    assert obj.has_command?(name), msg
+  end
+
+end
+
+
+module MiniTest::Expectations
+
+  # this { ... }.must_raise ExceptionalException
+  alias_method :this, :proc
+
+  infect_an_assertion :assert_has, :must_have, :reverse
+  infect_an_assertion :refute_has, :wont_have, :reverse
+
+  infect_an_assertion :assert_true,  :must_be_true,  :unary
+  infect_an_assertion :assert_false, :must_be_false, :unary
+
+  alias_method :wont_be_false, :must_be_true
+  alias_method :wont_be_true, :must_be_false
+
+  infect_an_assertion :assert_has_option,  :must_have_option,  :reverse
+  infect_an_assertion :assert_has_command, :must_have_command, :reverse
+
+  # @example
+  #
+  #   arg.must_be_argument :name => :arg, :optional => true, :type => Integer
+  #
+  def must_be_argument(opts)
+    opts.each do |k,v|
+      self.instance_variable_get("@#{k}").must_equal v
+    end
+  end
+
+end
+
+class Hash
+
+  # @example
+  #
+  #   hsh = {:a => 5}
+  #   hsh.must_contain :a => 5
+  #
+  def must_contain(kv)
+    kv.all? {|k,v| self[k].must_equal v }
+  end
+
+  # @example
+  #
+  #   hsh = {:a => 5}
+  #   hsh.wont_contain :b => 5
+  #
+  def wont_contain(kv)
+    kv.any? {|k,v| self[k].wont_equal v }
+  end
+end

data/spec/extras/focus.rb

@@ -0,0 +1,22 @@
+# Allows you to write
+#
+#   it 'does something', :focus => true do
+#     # ...
+#   end
+#
+# and when ENV['FOCUS'] is set to 'true' it will only run tests with 
+# `:focus => true`.
+#
+#   $ FOCUS=true bundler exec rake
+#
+
+FOCUS_MODE = ENV['FOCUS'] == 'true'
+
+class MiniTest::Spec
+  class << self; alias_method :__old_it, :it; end
+  def self.it(desc="anonymous", opts={}, &block)
+    if (FOCUS_MODE == true && opts[:focus] == true) || FOCUS_MODE == false
+      __old_it(desc, &block)
+    end
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,35 @@
+$: << File.dirname(__FILE__) + '/..'
+
+if RUBY_VERSION >= "1.9"
+  begin
+    require 'duvet'
+    Duvet.start :filter => 'lib/clive'
+  rescue LoadError
+    # it doesn't really matter
+  end
+end
+
+require 'lib/clive'
+require 'rubygems'
+require 'shellwords'
+
+class Clive::Command
+  def self.create(*args, &block)
+    i = new(*args, &block)
+    i.run_block({})
+    i
+  end
+end
+
+def s(str)
+  Shellwords.split(str)
+end
+
+gem 'minitest' # use latest version
+require 'minitest/autorun'
+require 'minitest/pride'
+
+require 'extras/expectations'
+require 'extras/focus'
+
+require 'mocha'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clive
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,34 +9,33 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-05-26 00:00:00.000000000 +01:00
-default_executable: 
+date: 2012-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: ast_ast
-  requirement: &2156527100 !ruby/object:Gem::Requirement
+  name: minitest
+  requirement: &2157118780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.1
-  type: :runtime
+        version: '2.6'
+  type: :development
   prerelease: false
-  version_requirements: *2156527100
+  version_requirements: *2157118780
 - !ruby/object:Gem::Dependency
-  name: attr_plus
-  requirement: &2156526180 !ruby/object:Gem::Requirement
+  name: mocha
+  requirement: &2157118180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.3'
-  type: :runtime
+        version: '0.10'
+  type: :development
   prerelease: false
-  version_requirements: *2156526180
+  version_requirements: *2157118180
 description: ! "    Clive provides a DSL for building command line interfaces. It
-  allows \n    you to define commands, switches, flags (switches with options) and
-  \n    boolean switches, it then parses the input and runs the correct blocks.\n"
+  allows \n    you to define commands and options, which can also take arguments,
+  \n    and then runs the correct stuff!\n"
 email: m@hawx.me
 executables: []
 extensions: []
@@ -44,30 +43,43 @@ extra_rdoc_files: []
 files:
 - README.md
 - LICENSE
-- lib/clive/bool.rb
+- lib/clive/argument.rb
+- lib/clive/arguments/parser.rb
+- lib/clive/arguments.rb
+- lib/clive/base.rb
 - lib/clive/command.rb
-- lib/clive/exceptions.rb
-- lib/clive/flag.rb
+- lib/clive/error.rb
+- lib/clive/formatter/colour.rb
+- lib/clive/formatter/plain.rb
 - lib/clive/formatter.rb
+- lib/clive/option/runner.rb
 - lib/clive/option.rb
 - lib/clive/output.rb
 - lib/clive/parser.rb
-- lib/clive/switch.rb
-- lib/clive/tokens.rb
+- lib/clive/struct_hash.rb
+- lib/clive/type/definitions.rb
+- lib/clive/type/lookup.rb
+- lib/clive/type.rb
 - lib/clive/version.rb
 - lib/clive.rb
-- spec/clive/bool_spec.rb
+- spec/clive/a_cli_spec.rb
+- spec/clive/argument_spec.rb
+- spec/clive/arguments/parser_spec.rb
+- spec/clive/arguments_spec.rb
 - spec/clive/command_spec.rb
-- spec/clive/flag_spec.rb
-- spec/clive/formatter_spec.rb
+- spec/clive/formatter/colour_spec.rb
+- spec/clive/formatter/plain_spec.rb
+- spec/clive/option/runner_spec.rb
 - spec/clive/option_spec.rb
 - spec/clive/output_spec.rb
 - spec/clive/parser_spec.rb
-- spec/clive/switch_spec.rb
-- spec/clive/tokens_spec.rb
-- spec/shared_specs.rb
-- spec/spec_helper.rb
-has_rdoc: true
+- spec/clive/struct_hash_spec.rb
+- spec/clive/type/definitions_spec.rb
+- spec/clive/type_spec.rb
+- spec/clive_spec.rb
+- spec/extras/expectations.rb
+- spec/extras/focus.rb
+- spec/helper.rb
 homepage: http://github.com/hawx/clive
 licenses: []
 post_install_message: 
@@ -88,19 +100,27 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: A DSL for building command line interfaces.
 test_files:
-- spec/clive/bool_spec.rb
+- spec/clive/a_cli_spec.rb
+- spec/clive/argument_spec.rb
+- spec/clive/arguments/parser_spec.rb
+- spec/clive/arguments_spec.rb
 - spec/clive/command_spec.rb
-- spec/clive/flag_spec.rb
-- spec/clive/formatter_spec.rb
+- spec/clive/formatter/colour_spec.rb
+- spec/clive/formatter/plain_spec.rb
+- spec/clive/option/runner_spec.rb
 - spec/clive/option_spec.rb
 - spec/clive/output_spec.rb
 - spec/clive/parser_spec.rb
-- spec/clive/switch_spec.rb
-- spec/clive/tokens_spec.rb
-- spec/shared_specs.rb
-- spec/spec_helper.rb
+- spec/clive/struct_hash_spec.rb
+- spec/clive/type/definitions_spec.rb
+- spec/clive/type_spec.rb
+- spec/clive_spec.rb
+- spec/extras/expectations.rb
+- spec/extras/focus.rb
+- spec/helper.rb
+has_rdoc: 

data/lib/clive/bool.rb

@@ -1,67 +0,0 @@
-module Clive
-
-  # A switch which can be triggered with either --no-[name] and --[name].
-  # The 'truth' of this is then passed to the block.
-  #
-  class Bool < Option
-    attr_accessor :truth
-    
-    # Creates a new Bool switch instance. A boolean switch has a truth, 
-    # this determines what is passed to the block. They should be created 
-    # in pairs so one can be +--something+ the other +--no-something+.
-    # NOTE: this does not happen within this class!
-    #
-    # +short+ and/or +desc+ can be omitted when creating a Boolean, all
-    # other arguments must be present.
-    #
-    # @param names [Array[Symbol]]
-    #   Names that the boolean switch can be called with, must include
-    #   a long name (eg. 2 or more characters) so that the --no- can
-    #   be prefixed.
-    #
-    # @param desc [String]
-    #   A description of the bool.
-    #
-    # @param truth [true, false] 
-    #   Truth of the switch to create.
-    #
-    # @yield [true, false] A block to be run when the switch is triggered
-    # @raise [MissingLongName] Raised when a long name is not given
-    #
-    def initialize(names, desc, truth, &block)
-      @names = []
-      names.each do |i|
-        if truth
-          @names << i.to_s
-        else
-          @names << "no-#{i.to_s}" if i.to_s.length > 1
-        end
-      end
-      
-      # booleans require a long name to add --no- to
-      unless @names.find_all {|i| i.length > 1}.length > 0
-        raise MissingLongName, @names[0]
-      end
-      
-      @desc = desc
-      @truth = truth
-      @block = block
-    end
-    
-    # Run the block with the switches truth.
-    def run
-      @block.call(@truth)
-    end
-    
-    # Should only return a hash when this is the 'true' switch.
-    # @see Clive::Option#to_h
-    def to_h
-      if @truth
-        {'names' => names_to_strings(true), 'desc' => @desc}
-      else
-        nil
-      end
-    end
-  
-  end
-end

data/lib/clive/exceptions.rb

@@ -1,54 +0,0 @@
-module Clive
-  
-  # General problem
-  class CliveError < StandardError
-    attr_accessor :args
-    
-    def initialize(*args)
-      @args = args
-    end
-    
-    def self.filter_backtrace(array)
-      unless $DEBUG
-        array = [$0]
-      end
-      array
-    end
-    
-    def set_backtrace(array)
-      super(self.class.filter_backtrace(array))
-    end
-    
-    def message
-      self.reason + ': ' + args.join(' ')
-    end
-    alias_method :to_s, :message
-    
-  end
-  
-  # General problem with input
-  class ParseError < CliveError
-    def reason; "parse error"; end
-  end
-  
-  # Long name is missing for bool
-  class MissingLongName < CliveError
-    def reason; "missing long name"; end
-  end
-  
-  # A flag has a missing argument
-  class MissingArgument < ParseError
-    def reason; "missing argument"; end
-  end
-  
-  # A flag has a wrong argument
-  class InvalidArgument < ParseError
-    def reason; "invalid argument"; end
-  end
-  
-  # An option that wasn't defined has been found
-  class NoOptionError < ParseError
-    def reason; "invalid option"; end
-  end
-  
-end

data/lib/clive/flag.rb

@@ -1,199 +0,0 @@
-module Clive
-  
-  # A switch that takes one or more arguments.
-  #   eg. wget --tries=10
-  #       wget -t 10
-  #
-  class Flag < Option
-    attr_reader :args
-        
-    # Creates a new Flag instance. A flag is a switch that can take one or more
-    # arguments.
-    #
-    # @param names [Array[Symbol]]
-    #   An array of names the flag can be invoked by. Can contain a long name
-    #   and/or a short name.
-    #
-    # @param desc [String]
-    #   A description of the flag.
-    #
-    # @param arguments [String, Array, Range]
-    #   Either, a string showing the arguments to be given, eg.
-    #     
-    #     "FROM"          # single argument required, or
-    #     "[FROM]"        # single optional argument, or
-    #     "FROM TO"       # multiple arguments required, or
-    #     "FROM [VIA] TO" # multiple arguments with optional argument
-    #
-    #   OR an array of acceptable inputs, eg.
-    #
-    #     %w(large small medium) # will only accept these arguments
-    #   
-    #   OR a range, showing the acceptable inputs, eg.
-    #     1..10 #=> means 1, 2, 3, ..., 8, 9, 10
-    #
-    # @yield [String] 
-    #   A block to be run if switch is triggered, will always be passed a string
-    #
-    def initialize(names, desc, arguments, &block)
-      @names = names.map(&:to_s)
-      self.args = (arguments || "ARG")
-      
-      @desc  = desc
-      @block = block
-    end
-    
-    def args=(val)
-      case val
-      when String
-        if val[-3..-1] == "..."
-          @args = {:type => :splat, :base_name => val[0..-4]}
-        
-        else
-          @args = {:type => :list, :arguments => []}
-          val.split(' ').each do |arg|
-            optional = false
-            if arg[0] == "["
-              optional = true
-              arg = arg[1..-2]
-            end
-
-            @args[:arguments] << {:name => arg, :optional => optional}
-          end
-        end
-      when Range
-        @args = {:type => :range, :range => val}
-      when Array
-        @args = {:type => :choice, :items => val}
-      end
-    end
-    
-    # Runs the block that was given with an argument
-    #
-    # @param [Array] args arguments to pass to the block
-    # @raise [InvalidArgument] only if +args+ is an array of acceptable inputs
-    #   and a match is not found.
-    def run(args)
-      case @args[:type]
-      when :list
-        args = optimise_fill(args, @args[:arguments].map {|i| !i[:optional] })
-      when :choice
-        unless @args[:items].map{|i| i.to_s}.include?(args[0])
-          raise InvalidArgument.new(args)
-        end
-      when :range
-        unless @args[:range].to_a.map {|i| i.to_s}.include?(args[0])
-          raise InvalidArgument.new(args)
-        end
-      when :splat
-        args = [args]
-      end
-      @block.call(*args)
-    end
-    
-    
-    # @param type [Symbol]
-    #   Can be passed three things; :all, returns size of all arguments; :optional
-    #   returns all optional arguments; :mandatory, returns size of mandatory arguments.
-    def arg_size(type=:all)
-      case @args[:type]
-      when :list
-        case type
-        when :all
-          @args[:arguments].size
-        when :optional
-          @args[:arguments].find_all {|i| i[:optional] == true }.size
-        when :mandatory
-          @args[:arguments].find_all {|i| i[:optional] == false }.size
-        end
-      
-      when :choice, :range
-        (type == :optional) ? 0 : 1
-      
-      when :splat
-        case type
-        when :all
-          1.0/0 # Infinity!
-        when :optional
-          1.0/0 # Infinity!
-        when :mandatory
-          1
-        end
-      end
-    end
-    
-    def args_to_string
-      case @args[:type]
-      when :list
-        r = []
-        @args[:arguments].each do |arg|
-          if arg[:optional]
-            r << "[" + arg[:name] + "]"
-          else
-            r << "<" + arg[:name] + ">"
-          end
-        end
-        r.join(' ')
-      when :choice, :range
-        ""
-      when :splat
-        "<#{@args[:base_name]}1> ..."
-      end
-    end
-    
-    def options_to_string
-      case @args[:type]
-      when :list, :splat
-        ''
-      when :choice
-        '(' + @args[:items].join(', ') + ')'
-      when :range
-        '(' + @args[:range].to_s + ')'
-      end
-    end
-    
-    def to_h
-      {
-        'names'   => names_to_strings,
-        'desc'    => @desc,
-        'args'    => args_to_string,
-        'options' => options_to_string
-      }
-    end
-    
-    
-    # Attempts to fill +self+ with values from +input+, giving priority to 
-    # true, then false. If insufficient input to fill all false will use nil.
-    #
-    # @param [Array] input array of values to fill +self+ with
-    # @return [Array] filled array
-    #
-    # @example
-    #
-    #   [true, false, false, true].optimise_fill(["a", "b", "c"])
-    #   #=> ["a", "b", nil, "c"]
-    #
-    #
-    def optimise_fill(input, match)
-      diff = input.size - match.reject{|i| i == false}.size
-      
-      result = []
-      match.each_index do |i|
-        curr_item = match[i]
-        if curr_item == true
-          result << input.shift
-        else
-          if diff > 0
-            result << input.shift
-            diff -= 1
-          else
-            result << nil
-          end
-        end
-      end
-      result
-    end
-    
-    
-  end
-end