clio 0.2.0 → 0.3.0

data/spec/commandline/autousage.rd

@@ -52,5 +52,3 @@ Parses the option correctly.
 
     @cli.options[:verbose].assert == true
 
-QED.
-

data/spec/commandline/bracket.rd

@@ -61,4 +61,3 @@ a seaprate help! call.
 
     cmd.usage.options[0].name.assert == 'verbose'
 
-QED.

data/spec/commandline/completion.rd

@@ -31,8 +31,6 @@ Now an option.
 
   @cli.completion('c1 --o1').assert == ["TYPE"]
 
-QED.
-
 
 
 

data/spec/commandline/define.rd

@@ -41,4 +41,3 @@ Let's bring it all together in one example.
     cmd.usage.command('bar')
     cmd.to_s.assert == 'test [-v --verbose] [-f --force] [foo | bar]'
 
-QED.

data/spec/commandline/method.rd

@@ -57,4 +57,3 @@ a seaprate help! call.
 
     cmd.usage.options[0].name.assert == 'verbose'
 
-QED.

data/spec/commandline/parse.rd

@@ -69,4 +69,3 @@ Multiple subcommands.
   cmd[1].options.assert == {}
   cmd[2].options.assert == {:verbose=>true}
 
-QED.

data/spec/commandline/scenario.rd

@@ -78,4 +78,3 @@ There are no more signatures after the second.
 
     @cli[3].assert == nil
 
-QED.

data/spec/commandline/subclass.rd

@@ -3,6 +3,9 @@
 Require clio/commandline.rb.
 
   require 'clio/commandline'
+
+Fake a commandline command.
+
   $0 = 'c0'
 
 Create new subclass of Clio::Commandline.
@@ -51,4 +54,3 @@ Method missing options work.
   @cli2.o1?.assert == true
   @cli2.o2?.assert == true
 
-QED.

data/spec/string/unit.rd

@@ -50,9 +50,24 @@ string range index
     e = @s1[0..3]
     e.assert == r.to_s
 
+String addition
+
+    s1 = Clio.string("a").red
+    s2 = Clio.string("b").blue
+    s = s1 + s2
+    s.to_s.assert == Clio::ANSICode.red('a') + Clio::ANSICode.blue('b')
+
 Method #sub can replace a substring.
 
     r = @c1.sub('Hi', 'Hello')
+    r.to_s.assert == "Hello how are you."
+
+Method #gsub! can replace many substrings.
 
-QED.
+    s1 = Clio.string("axax").red
+    s2 = Clio.string("axax").blue
+    s = s1 + s2
+    s.to_s.assert == Clio::ANSICode.red('axax') + Clio::ANSICode.blue('axax')
+    s.gsub!('x', 'y')
+    s.to_s.assert == Clio::ANSICode.red('ayay') + Clio::ANSICode.blue('ayay')
 

data/spec/usage/define.rd

@@ -1,44 +1,112 @@
-= Usage Definition
+= Clio::Usage
 
-Require commandline library.
+== Create a Usage object.
+
+Require usage library.
 
   require 'clio/usage'
+
+Fake a commandline invocation.
+
   $0 = 'test'
 
 Create a Usage object.
 
   usage = Clio::Usage.new
 
-Handles a command definition using #command.
+== Basic Notation
+
+Define a usage subcommand using #subcommand.
 
   usage = Clio::Usage.new
-  usage.command('foo')
+  usage.subcommand('foo')
   usage.to_s.assert == 'test foo'
 
-Handles a command definition using #[].
+This is also aliased as #command.
 
-  #usage = Clio::Usage.new
-  #usage['foo']
-  #usage.to_s.assert == 'test foo'
+  usage = Clio::Usage.new
+  usage.command('foo')
+  usage.to_s.assert == 'test foo'
 
-Handles a toplevel switch/option using #option.
+A toplevel switch/option is defined with #option.
 
   usage = Clio::Usage.new
-  usage.option('verbose?')
+  usage.option('verbose')
   usage.to_s.assert == 'test [--verbose]'
 
-Handles a toplevel switch/option with aliases using #option.
+Options can also have aliases.
 
   usage = Clio::Usage.new
-  usage.option(:verbose?, :v)
+  usage.option(:verbose, :v)
   usage.to_s.assert == 'test [-v --verbose]'
 
-An option and a subcommand.
+Arguments are defined with #argument, which takes
+a type, or name and type. Multiple arguments can
+be defined, and are processed in the order defined.
 
   usage = Clio::Usage.new
-  usage.opt('--verbose -v')
-  usage.command('foo')
-  usage.to_s.assert == 'test [-v --verbose] foo'
+  usage.argument('TYPE1')
+  usage.argument('name:TYPE2')
+  usage.to_s.assert == 'test <TYPE1> <name:TYPE2>'
+
+But arguments can be index to sepcify the index. Argument
+index start with 1 (not 0).
+
+  usage = Clio::Usage.new
+  usage.argument(1, 'TYPE1')
+  usage.argument(2, 'name:TYPE2')
+  usage.to_s.assert == 'test <TYPE1> <name:TYPE2>'
+
+Final arguments can consume all remaining arguments.
+Define this with #splat.
+
+  usage = Clio::Usage.new
+  usage.argument('TYPE').splat(true)
+  usage.to_s.assert == 'test <TYPE...>'
+
+Usage cannot have both subcommands and arguments.
+
+  usage = Clio::Usage.new
+  expect ArgumentError do
+    usage.subcommand('foo')
+    usage.argument('bar')
+  end
+
+Anything define on a Usage object, can also be
+defined for a subcommand, since Usage.new actually
+returns and subclass of Subcommand.
+
+  usage = Clio::Usage.new
+  usage.class.assert < Clio::Usage::Subcommand
+
+Bringing it all together in a .
+
+  usage = Clio::Usage.new
+  usage.option(:verbose, :v)
+  usage.command('foo').argument('TYPE')
+  usage.to_s.assert == 'test [-v --verbose] foo <TYPE>'
+
+== Bracket Notation
+
+Subcommand, options and arguments can also be defined using #[].
+They are distinighished by syntax used. For instance, to define
+a subcommand, use bare syntax.
+
+  usage = Clio::Usage.new
+  usage['foo']
+  usage.to_s.assert == 'test foo'
+
+To define an option prefix the syntax with '--' or '-', and
+aliases are separated by spaces.
+
+  usage = Clio::Usage.new
+  usage['--verbose -v']
+  usage.to_s.assert == 'test [-v --verbose]'
+
+Arguments are defined by wrapping the type or name:type in < > brackets.
+
+  usage = Clio::Usage.new
+  usage['<TYPE>']
+  usage.to_s.assert == 'test <TYPE>'
 
-QED.
 

data/spec/usage/parse.rd

@@ -43,5 +43,3 @@ A subcommand with an option.
   cli[0].options.assert == {}
   cli[1].options.assert == {:verbose=>true}
 
-QED.
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: clio
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - 7rans <transfire@gmail.com>
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-15 00:00:00 -05:00
+date: 2008-11-19 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -31,6 +31,7 @@ files:
 - lib
 - meta
 - spec
+- MANIFEST
 - CHANGES
 - RELEASE
 - README
@@ -52,11 +53,11 @@ files:
 - lib/clio/string.rb
 - lib/clio/facets/kernel.rb
 - lib/clio/facets/string.rb
-- lib/clio/usage/main.rb
 - lib/clio/usage/signature.rb
 - lib/clio/usage/command.rb
 - lib/clio/usage/parser.rb
 - lib/clio/usage/argument.rb
+- lib/clio/usage/subcommand.rb
 - lib/clio/usage/interface.rb
 - lib/clio/usage/option.rb
 - lib/clio/layout/list.rb
@@ -87,7 +88,6 @@ files:
 - spec/commandline/parse.rd
 - spec/commandline/scenario.rd
 - spec/string/unit.rd
-- MANIFEST
 has_rdoc: true
 homepage: http://clio.rubyforge.org
 post_install_message: 

data/lib/clio/usage/main.rb

@@ -1,165 +0,0 @@
-require 'clio/usage/command'
-
-module Clio
-
-  module Usage #:nodoc:
-
-    # = Main
-    #
-    # Main specifies the toplevel "Command".
-    #
-    class Main < Command
-
-      # New Usage.
-      #
-      def initialize(name=nil, &block)
-        name ||= File.basename($0)
-        super(name, &block)
-      end
-
-      # Define a command.
-      #
-      #   command('remote')
-      #   command('remote','add')
-      #
-      #def command(name, &block)
-      #  raise "Command cannot have both arguments and subcommands (eg. #{name})." unless arguments.empty?
-      #  key = name.to_s.strip
-      #  if cmd = @commands.find{|c| c === key}
-      #  else
-      #    cmd = Command.new(key, self)
-      #    @commands << cmd
-      #  end
-      #  cmd.instance_eval(&block) if block
-      #  cmd
-      #end
-
-=begin
-      #alias_method :[], :command
-
-
-      # ARRAY NOTATION
-      #-------------------------------------------------------------
-
-      #
-      def [](*args)
-        res = nil
-        head, *tail = *args
-        case head.to_s
-        when /^-/
-          x = []
-          opts = args.map do |o|
-            o = o.to_s
-            if i = o.index('=')
-              x << o[i+1..-1]
-              o[0...i]
-            else
-              o
-            end
-          end
-          x = x.uniq
-
-          res = opt(*opts)
-        else
-          args.each do |name|
-            res = command(name)
-          end
-        end
-        return res
-      end
-=end
-
-=begin
-      # Usage text.
-      #
-      def to_s
-        #s = [full_name]
-        s = [name]
-
-        case options.size
-        when 0
-        when 1, 2, 3
-          s.concat(options.collect{ |o| "[#{o.to_s.strip}]" })
-        else
-          s << "[switches]"
-        end
-# switches? vs. options
-        s << arguments.join(' ') unless arguments.empty?
-
-        case commands.size
-        when 0
-        when 1
-          s << commands.join('')
-        when 2, 3
-          s << '[' + commands.join(' | ') + ']'
-        else
-          s << 'command'
-        end
-
-        s.flatten.join(' ')
-      end
-
-      # Help text.
-      #
-      def to_s_help
-        s = []
-        unless help.empty?
-          s << help
-          s << ''
-        end
-        s << "Usage:"
-        s << "  " + to_s
-        unless commands.empty?
-          s << ''
-          s << 'Commands:'
-          s.concat(commands.collect{ |x| "  %-20s %s" % [x.key, x.help] }.sort)
-        end
-        unless arguments.empty?
-          s << ''
-          s << "Arguments:"
-          s.concat(arguments.collect{ |x| "  %-20s %s" % [x, x.help] })
-        end
-        unless options.empty?
-          s << ''
-          s << 'Switches:'
-          s.concat(options.collect{ |x| "  %-20s %s" % [x, x.help] })
-        end
-        s.flatten.join("\n")
-      end
-=end
-
-      def parse(argv)
-        Parser.new(self, argv).parse #(argv)
-      end
-
-      # Cache usage into a per-user cache file for reuse.
-      # This can be used to greatly speed up tab completion.
-      #
-      def cache
-        File.open(cache_file, 'w'){ |f| f << to_yaml }
-      end
-
-    private
-
-      # TODO: Use XDG
-
-      def cache_file
-        File.join(File.expand_path('~'), '.cache', 'clio', "#{name}.yaml")
-      end
-
-      def self.cache_file
-        File.join(File.expand_path('~'), '.cache', 'clio', "#{name}.yaml")
-      end
-
-      def self.load_cache
-        if File.file?(cache_file)
-          YAML.load(File.new(cache_file))
-        end
-      end
-
-    end#class Main
-
-  end#module Usage
-
-end#module Clio
-