cl 0.1.28 → 1.0.0

data/examples/args/cast

@@ -3,67 +3,57 @@ $: << File.expand_path('lib')
 
 require 'cl'
 
-class Bool < Cl::Cmd
-  arg :bool, type: :bool
+module Cast
+  class Bool < Cl::Cmd
+    arg :bool, type: :bool
 
-  def run
-    [registry_key, bool: bool]
+    def run
+      p cmd: registry_key, bool: bool
+    end
   end
-end
 
-class Types < Cl::Cmd
-  arg :a, type: :bool
-  arg :b, type: :int
-  arg :c, type: :float
-  arg :d
+  class Types < Cl::Cmd
+    arg :a, type: :bool
+    arg :b, type: :int
+    arg :c, type: :float
+    arg :d
 
-  def run
-    [registry_key, a: a, b: b, c: c, d: d]
+    def run
+      p cmd: registry_key, a: a, b: b, c: c, d: d
+    end
   end
 end
 
-def output(cmd, args)
-  args = args.map { |key, value| "#{key}=#{value.inspect}" }.join(' ')
-  puts "Called #{cmd} with #{args}\n\n"
-end
-
-output *Cl.new($0).run(%w(bool on))
+Cl.new($0).run(%w(bool on))
 
 # Output:
 #
-#   Called bool with bool=true
+#   {:cmd=>:bool, :bool=>true}
 
-output *Cl.new($0).run(%w(bool on))
+Cl.new($0).run(%w(types true 1 1.2 foo))
 
 # Output:
 #
-#   Called bool with bool=true
+#   {:cmd=>:types, :a=>true, :b=>1, :c=>1.2, :d=>"foo"}
 
-output *Cl.new($0).run(%w(bool on))
+Cl.new($0).run(%w(types true 1 1.2 foo bar))
 
 # Output:
 #
-#   Called bool with bool=true
-
-output *Cl.new($0).run(%w(bool on))
-
-# Output:
+#   Too many arguments (given: 5, allowed: 4)
 #
-#   Called bool with bool=true
-
-output *Cl.new($0).run(%w(types true 1 1.2 foo))
-
-# Output:
+#   Usage: bin/examples types [a:bool] [b:int] [c:float] [d] [options]
 #
-#   Called types with a=true b=1 c=1.2 d="foo"
-
-Cl.new($0).run(%w(types true 1 1.2))
-
-# Output:
+#   Arguments:
 #
-#   Too many arguments (given: 5, allowed: 4)
+#     a           type: bool
+#     b           type: int
+#     c           type: float
+#     d           type: string
+#
+#   Options:
 #
-#   Usage: cast.rb types [a (bool)] [b (int)] [c (float)] [d]
+#     --help      Get help on this command
 
 Cl.new($0).run(%w(types true one 1.2))
 
@@ -71,7 +61,18 @@ Cl.new($0).run(%w(types true one 1.2))
 #
 #   Wrong argument type (given: "one", expected: int)
 #
-#   Usage: cast.rb types [a (bool)] [b (int)] [c (float)] [d]
+#   Usage: bin/examples types [a:bool] [b:int] [c:float] [d] [options]
+#
+#   Arguments:
+#
+#     a           type: bool
+#     b           type: int
+#     c           type: float
+#     d           type: string
+#
+#   Options:
+#
+#     --help      Get help on this command
 
 Cl.new($0).run(%w(types true 1 one))
 
@@ -79,4 +80,15 @@ Cl.new($0).run(%w(types true 1 one))
 #
 #   Wrong argument type (given: "one", expected: float)
 #
-#   Usage: cast.rb types [a (bool)] [b (int)] [c (float)] [d]
+#   Usage: bin/examples types [a:bool] [b:int] [c:float] [d] [options]
+#
+#   Arguments:
+#
+#     a           type: bool
+#     b           type: int
+#     c           type: float
+#     d           type: string
+#
+#   Options:
+#
+#     --help      Get help on this command

data/examples/args/opts

@@ -3,34 +3,92 @@ $: << File.expand_path('lib')
 
 require 'cl'
 
-class Opts < Cl::Cmd
-  opt '-p', '--path PATH'
-  opt '-v', '--verbose'
+module Opts
+  class Bool < Cl::Cmd
+    arg :bool, type: :bool
 
-  def run
-    [registry_key, args, opts]
+    def run
+      p cmd: registry_key, bool: bool
+    end
   end
-end
 
-def output(cmd, args, opts)
-  puts "Called #{cmd} with args=#{args} opts=#{opts}\n\n"
+  class Types < Cl::Cmd
+    arg :a, type: :bool
+    arg :b, type: :int
+    arg :c, type: :float
+    arg :d
+
+    def run
+      p cmd: registry_key, a: a, b: b, c: c, d: d
+    end
+  end
 end
 
-output *Cl.new($0).run(%w(opts -p path -v))
+Cl.new($0).run(%w(bool on))
 
 # Output:
 #
-#   Called cast with args=[] opts={:path=>"path", :verbose=>true}
+#   {:cmd=>:bool, :bool=>true}
 
-output *Cl.new($0).run(%w(opts --path path --verbose))
+Cl.new($0).run(%w(types true 1 1.2 foo))
 
 # Output:
 #
-#   Called cast with args=[] opts={:path=>"path", :verbose=>true}
+#   {:cmd=>:types, :a=>true, :b=>1, :c=>1.2, :d=>"foo"}
 
-output *Cl.new($0).run(%w(opts one -p path two -v three))
+Cl.new($0).run(%w(types true 1 1.2 foo bar))
 
 # Output:
 #
-#   Called cast with args=["one", "two", "three"] opts={:path=>"path", :verbose=>true}
+#   Too many arguments (given: 5, allowed: 4)
+#
+#   Usage: bin/examples types [a:bool] [b:int] [c:float] [d] [options]
+#
+#   Arguments:
+#
+#     a           type: bool
+#     b           type: int
+#     c           type: float
+#     d           type: string
+#
+#   Options:
+#
+#     --help      Get help on this command
+
+Cl.new($0).run(%w(types true one 1.2))
 
+# Output:
+#
+#   Wrong argument type (given: "one", expected: int)
+#
+#   Usage: bin/examples types [a:bool] [b:int] [c:float] [d] [options]
+#
+#   Arguments:
+#
+#     a           type: bool
+#     b           type: int
+#     c           type: float
+#     d           type: string
+#
+#   Options:
+#
+#     --help      Get help on this command
+
+Cl.new($0).run(%w(types true 1 one))
+
+# Output:
+#
+#   Wrong argument type (given: "one", expected: float)
+#
+#   Usage: bin/examples types [a:bool] [b:int] [c:float] [d] [options]
+#
+#   Arguments:
+#
+#     a           type: bool
+#     b           type: int
+#     c           type: float
+#     d           type: string
+#
+#   Options:
+#
+#     --help      Get help on this command

data/examples/args/required

@@ -8,39 +8,53 @@ class Required < Cl::Cmd
   arg :two
 
   def run
-    [registry_key, one: one, two: two]
+    p cmd: registry_key, one: one, two: two
   end
 end
 
-def output(cmd, args)
-  args = args.map { |key, value| "#{key}=#{value.inspect}" }.join(' ')
-  puts "Called #{cmd} with #{args}\n\n"
-end
-
-output *Cl.new($0).run(%w(required one two))
+Cl.new($0).run(%w(required one two))
 
 # Output:
 #
-#   Called required with one="one" two="two"
+#   {:cmd=>:required, :one=>"one", :two=>"two"}
 
-output *Cl.new($0).run(%w(required one))
+Cl.new($0).run(%w(required one))
 
 # Output:
 #
-#   Called required with one="one" two=nil
+#   {:cmd=>:required, :one=>"one", :two=>nil}
 
-output *Cl.new($0).run(%w(required))
+Cl.new($0).run(%w(required))
 
 # Output:
 #
 #   Missing arguments (given: 0, required: 1)
 #
-#   Usage: args.rb required one [two]
+#   Usage: bin/examples required one [two] [options]
+#
+#   Arguments:
+#
+#     one         type: string, required: true
+#     two         type: string
+#
+#   Options:
+#
+#     --help      Get help on this command
 
-output *Cl.new($0).run(%w(required one two three))
+Cl.new($0).run(%w(required one two three))
 
 # Output:
 #
 #   Too many arguments (given: 3, allowed: 2)
 #
-#   Usage: args.rb required one [two]
+#   Usage: bin/examples required one [two] [options]
+#
+#   Arguments:
+#
+#     one         type: string, required: true
+#     two         type: string
+#
+#   Options:
+#
+#     --help      Get help on this command
+

data/examples/args/splat

@@ -3,59 +3,56 @@ $: << File.expand_path('lib')
 
 require 'cl'
 
-class SplatLeft < Cl::Cmd
-  register 'splat:left'
+module Splat
+  class Left < Cl::Cmd
+    register :left
 
-  arg :one, type: :array
-  args :two, :three
+    arg :one, type: :array, splat: true
+    args :two, :three
 
-  def run
-    [registry_key, one: one, two: two, three: three]
+    def run
+      p cmd: registry_key, one: one, two: two, three: three
+    end
   end
-end
 
-class SplatMiddle < Cl::Cmd
-  register 'splat:middle'
+  class Middle < Cl::Cmd
+    register :middle
 
-  arg :one
-  arg :two, type: :array
-  arg :three
+    arg :one
+    arg :two, type: :array, splat: true
+    arg :three
 
-  def run
-    [registry_key, one: one, two: two, three: three]
+    def run
+      p cmd: registry_key, one: one, two: two, three: three
+    end
   end
-end
 
-class SplatRight < Cl::Cmd
-  register 'splat:right'
+  class Right < Cl::Cmd
+    register :right
 
-  args :one, :two
-  arg :three, type: :array
+    args :one, :two
+    arg :three, type: :array, splat: true
 
-  def run
-    [registry_key, one: one, two: two, three: three]
+    def run
+      p cmd: registry_key, one: one, two: two, three: three
+    end
   end
 end
 
-def output(cmd, args)
-  args = args.map { |key, value| "#{key}=#{value.inspect}" }.join(' ')
-  puts "Called #{cmd} with #{args}\n\n"
-end
-
-output *Cl.new($0).run(%w(splat left foo bar baz buz))
+Cl.new('splat').run(%w(left foo bar baz buz))
 
 # Output:
 #
-#   Called splat:left with one=["foo", "bar"] two="baz" three="buz"
+#   {:cmd=>:left, :one=>["foo", "bar"], :two=>"baz", :three=>"buz"}
 
-output *Cl.new($0).run(%w(splat middle foo bar baz buz))
+Cl.new('splat').run(%w(middle foo bar baz buz))
 
 # Output:
 #
-#   Called splat:middle with one="foo" two=["bar", "baz"] three="buz"
+#   {:cmd=>:middle, :one=>"foo", :two=>["bar", "baz"], :three=>"buz"}
 
-output *Cl.new($0).run(%w(splat right foo bar baz buz))
+Cl.new('splat').run(%w(right foo bar baz buz))
 
 # Output:
 #
-#   Called splat:middle with one="foo" two="bar" three=["baz", "buz"]
+#   {:cmd=>:right, :one=>"foo", :two=>"bar", :three=>["baz", "buz"]}

data/examples/gem

@@ -14,26 +14,23 @@ module Gem
         opt '-q', '--quiet',     'Silence output'
 
         def run
-          [registry_key, args, opts]
+          p cmd: registry_key, args: args, opts: opts
         end
       end
 
       class Bump < Cl::Cmd
-        defaults commit: true
-
         opt '-v', '--version VERSION', 'The version to bump to [1.1.1|major|minor|patch|pre|rc|release]'
         opt '--[no-]commit',           'Bump the version, but do not commit'
 
         def run
-          [registry_key, args, opts]
+          p cmd: registry_key, args: args, opts: opts
         end
       end
     end
   end
 end
 
-Cl.new($0).run(%w(help))
-puts
+Cl.new('gem').run(%w(help))
 
 # Output:
 #
@@ -42,13 +39,12 @@ puts
 #   gem release [gemspec] [options]
 #   gem bump [options]
 
-Cl.new($0).run(%w(help release))
-puts
 
+Cl.new('gem').run(%w(help release))
 # or:
 #
-#   Cl.new($0).run(%w(release --help)))
-#   Cl.new($0).run(%w(release -h)))
+#   Cl.new('gem').run(%w(release --help)))
+#   Cl.new('gem').run(%w(release -h)))
 #
 # Output:
 #
@@ -56,22 +52,21 @@ puts
 #
 #   Arguments:
 #
-#     gemspec
+#     gemspec              type: string
 #
 #   Options:
 #
-#     -h --host HOST      Push to a compatible host other than rubygems.org
-#     -k --key KEY        Rubygems API key to use
-#     -q --quiet          Silence output
-#        --help           Get help on this command
+#     -h --host HOST       Push to a compatible host other than rubygems.org (type: string)
+#     -k --key KEY         Rubygems API key to use (type: string)
+#     -q --[no-]quiet      Silence output
+#        --help            Get help on this command
 
-Cl.new($0).run(%w(help release))
-puts
 
+Cl.new('gem').run(%w(help bump))
 # or:
 #
-#   Cl.run($0, %w(release --help))
-#   Cl.run($0, %w(release -h))
+#   Cl.new('gem').run(%w(bump --help)))
+#   Cl.new('gem').run(%w(bump -h)))
 #
 # Output:
 #
@@ -79,26 +74,20 @@ puts
 #
 #   Options:
 #
-#     -v --version VERSION      The version to bump to [1.1.1|major|minor|patch|pre|rc|release]
-#        --no-commit            Bump the version, but do not commit
-#     -h --help                 Get help on this command
+#     -v --version VERSION      The version to bump to [1.1.1|major|minor|patch|pre|rc|release] (type: string)
+#        --[no-]commit          Bump the version, but do not commit
+#        --help                 Get help on this command
 
-cmds = [
-  Cl.new($0).run(%w(bump -v 1.1.1)),
-  Cl.new($0).run(%w(release foo.gemspec -h host -k key -q))
-]
 
-puts "Commands run:\n\n"
-puts cmds.map { |cmd, args, opts| "  cmd #{cmd} has run with:\n\n    args=#{args}\n    opts=#{opts}\n\n" }
+Cl.new('gem').run(%w(bump -v 1.1.1))
 
-# Commands run:
-#
-#   cmd bump has run with:
-#
-#     args=[]
-#     opts={:version=>"1.1.1"}
+# Output:
 #
-#   cmd release has run with:
+#   {:cmd=>:bump, :args=>[], :opts=>{:version=>"1.1.1"}}
+
+
+Cl.new('gem').run(%w(release foo.gemspec -h host -k key -q))
+
+# Output:
 #
-#     args=["foo.gemspec"]
-#     opts={:host=>"host", :key=>"key", :quiet=>true}
+#   {:cmd=>:release, :args=>["foo.gemspec"], :opts=>{:host=>"host", :key=>"key", :quiet=>true}}