cl 0.1.28 → 1.0.0

data/examples/heroku

@@ -12,7 +12,9 @@ module Heroku
 
       opt '-o', '--org ORG'
 
-      def run; [registry_key, args, opts] end
+      def run
+        p cmd: registry_key, args: args, opts: opts
+      end
     end
 
     class List < Cl::Cmd
@@ -20,30 +22,27 @@ module Heroku
 
       opt '-a', '--app APP'
 
-      def run; [registry_key, args, opts] end
+      def run
+        p cmd: registry_key, args: args, opts: opts
+      end
     end
   end
 end
 
-def output(cmd, args, opts)
-  puts "Called #{cmd} with args=#{args} opts=#{opts}\n\n"
-end
-
-output *Cl.new($0).run(%w(apps:create name -o org))
-
-# Output:
+Cl.new('heroku').run(%w(apps:create name -o org))
+# or:
 #
-#   Called apps:create with args=["name"] opts={:org=>"org"}
-
-output *Cl.new($0).run(%w(apps create name -o org))
+#   Cl.new('heroku').run(%w(apps create name -o org))
 
 # Output:
 #
-#   Called apps:create with args=["name"] opts={:org=>"org"}
+#   {:cmd=>:"apps:create", :args=>["name"], :opts=>{:org=>"org"}}
 
-output *Cl.new($0).run(%w(apps:info -a app))
+Cl.new('heroku').run(%w(apps:info -a app))
+# or:
+#
+#   Cl.new('heroku').run(%w(apps info -a app))
 
 # Output:
 #
-#   Called apps:create with args=["app"] opts={}
-
+#   {:cmd=>:"apps:info", :args=>[], :opts=>{:app=>"app"}}

data/examples/rakeish

@@ -10,7 +10,9 @@ module Rakeish
 
       arg :name
 
-      def run; [registry_key, args, opts] end
+      def run
+        p cmd: registry_key, args: args, opts: opts
+      end
     end
 
     class Drop < Cl::Cmd
@@ -20,7 +22,9 @@ module Rakeish
 
       opt '-f', '--force'
 
-      def run; [registry_key, args, opts] end
+      def run
+        p cmd: registry_key, args: args, opts: opts
+      end
     end
 
     class Migrate < Cl::Cmd
@@ -30,23 +34,17 @@ module Rakeish
 
       opt '-v', '--version VERSION'
 
-      def run; [registry_key, args, opts] end
+      def run
+        p cmd: registry_key, args: args, opts: opts
+      end
     end
   end
 end
 
-def output(result)
-  result.each do |cmd, args, opts|
-    puts "Called #{cmd} with args=#{args} opts=#{opts}"
-  end
-  puts
-end
-
-argv = %w(db:drop production -f db:create db:migrate production -v 1)
-output Cl.new($0, runner: :multi).run(argv)
+Cl.new('rake', runner: :multi).run(%w(db:drop production -f db:create db:migrate production -v 1))
 
 # Output:
 #
-#   Called db:drop with args=["production"] opts={:force=>true}
-#   Called db:create with args=[] opts={}
-#   Called db:migrate with args=["production"] opts={:version=>"1"}
+#   {:cmd=>:"db:drop", :args=>["production"], :opts=>{:force=>true}}
+#   {:cmd=>:"db:create", :args=>[], :opts=>{}}
+#   {:cmd=>:"db:migrate", :args=>["production"], :opts=>{:version=>"1"}}

data/examples/readme/abstract

@@ -8,18 +8,19 @@ class Base < Cl::Cmd
 end
 
 class Add < Base
+  def run
+    puts 'Success'
+  end
 end
 
-Cl.new('owners').help
+Cl.new('owners').run(%w(add))
 
 # Output:
 #
-#   Type "owners help COMMAND [SUBCOMMAND]" for more details:
-#
-#   owners add [options]
+#   Success
 
 Cl.new('owners').run(%w(base))
 
-# Error output:
+# Output:
 #
 #   Unknown command: base

data/examples/readme/alias

@@ -7,16 +7,13 @@ class Add < Cl::Cmd
   opt '--to GROUP', alias: :group
 
   def run
-    p opts, to, to?, group, group?
+    # p opts: opts, to: to, to?: to?, group: group, group?: group?
+    p opts: opts, to: to, to?: to?
   end
 end
 
-Cl.new('owners').run(%w(add --to one))
+Cl.new('owners').run(%w(add --group one))
 
 # Output:
 #
-#   {"to" => "one"}
-#   "one"
-#   true
-#   "one"
-#   true
+#   {:opts=>{:to=>"one", :group=>"one"}, :to=>"one", :to?=>true}

data/examples/readme/arg

@@ -7,10 +7,12 @@ class Add < Cl::Cmd
   arg :owner
 
   def run
-    p owner
+    p owner: owner
   end
 end
 
 Cl.new('owners').run(%w(add one))
 
-# => "one"
+# Output:
+#
+#   {:owner=>"one"}

data/examples/readme/arg_array

@@ -7,10 +7,12 @@ class Add < Cl::Cmd
   arg :owners, type: :array, sep: ','
 
   def run
-    p owners
+    p owners: owners
   end
 end
 
 Cl.new('owners').run(%w(add one,two))
 
-# => ["one", "two"]
+# Output:
+#
+#   {:owners=>["one", "two"]}

data/examples/readme/arg_type

@@ -15,4 +15,6 @@ end
 
 Cl.new('owners').run(%w(cmd 1 2.1 yes))
 
-# => [Integer, Float, TrueClass]
+# Output:
+#
+#   [Integer, Float, TrueClass]

data/examples/readme/args_splat

@@ -34,10 +34,19 @@ class Rgt < Cl::Cmd
 end
 
 Cl.new('splat').run(%w(lft 1 2 3 4 5))
+
+# Output:
+#
+#   [["1", "2", "3"], "4", "5"]
+
 Cl.new('splat').run(%w(mid 1 2 3 4 5))
+
+# Output:
+#
+#   ["1", ["2", "3", "4"], "5"]
+
 Cl.new('splat').run(%w(rgt 1 2 3 4 5))
 
-# =>
-# [["1", "2", "3"], "4", "5"]
-# ["1", ["2", "3", "4"], "5"]
-# ["1", "2", ["3", "4", "5"]]
+# Output:
+#
+#   ["1", "2", ["3", "4", "5"]]

data/examples/readme/default

@@ -7,7 +7,7 @@ class Add < Cl::Cmd
   opt '--to GROUP', default: 'default'
 
   def run
-    p to
+    p to: to
   end
 end
 
@@ -15,4 +15,4 @@ Cl.new('owners').run(%w(add))
 
 # Output:
 #
-#   "default"
+#   {:to=>"default"}

data/examples/readme/deprecated

@@ -4,11 +4,10 @@ $: << File.expand_path('lib')
 require 'cl'
 
 class Add < Cl::Cmd
-  opt '--to GROUP'
-  opt '--target GROUP', deprecated: 'Deprecated: --target'
+  opt '--target GROUP', deprecated: 'Deprecated.'
 
   def run
-    p to, deprecated_opts
+    p target: target, deprecations: deprecations
   end
 end
 
@@ -16,6 +15,4 @@ Cl.new('owners').run(%w(add --target one))
 
 # Output:
 #
-#   "one"
-#   {:target=>'Deprecated: --target'}
-
+#   {:target=>"one", :deprecations=>{:target=>"Deprecated."}}

data/examples/readme/deprecated_alias

@@ -7,7 +7,7 @@ class Add < Cl::Cmd
   opt '--to GROUP', alias: :target, deprecated: :target
 
   def run
-    p to, deprecated_opts
+    p to: to, deprecations: deprecations
   end
 end
 
@@ -15,6 +15,4 @@ Cl.new('owners').run(%w(add --target one))
 
 # Output:
 #
-#   "one"
-#   {:target=>:to}
-
+#   {:to=>"one", :deprecations=>{:target=>:to}}

data/examples/readme/downcase

@@ -7,7 +7,7 @@ class Add < Cl::Cmd
   opt '--to GROUP', downcase: true
 
   def run
-    p to
+    p to: to
   end
 end
 
@@ -15,4 +15,4 @@ Cl.new('owners').run(%w(add --to ONE))
 
 # Output:
 #
-#   "one"
+#   {:to=>"one"}

data/examples/readme/enum

@@ -7,7 +7,7 @@ class Add < Cl::Cmd
   opt '--to GROUP', enum: %w(one two)
 
   def run
-    p to
+    p to: to
   end
 end
 
@@ -15,12 +15,17 @@ Cl.new('owners').run(%w(add --to one))
 
 # Output:
 #
-#   "one"
+#   {:to=>"one"}
 
 Cl.new('owners').run(%w(add --to unknown))
 
-# Unknown value: to=unknown (known values: one, two)
+# Output:
+#
+#   Unknown value: to=unknown (known values: one, two)
+#
+#   Usage: owners add [options]
 #
-# Usage: enum add [options]
+#   Options:
 #
-# Options: ...
+#     --to GROUP      type: string, known values: one, two
+#     --help          Get help on this command

data/examples/readme/example

@@ -9,9 +9,11 @@ end
 
 Cl.new('owners').run(%w(add --help))
 
-# Usage: example add [options]
+# Output:
 #
-# Options:
+#   Usage: owners add [options]
 #
-#   --to GROUP      type: string, e.g.: group-one
-#   --help          Get help on this command
+#   Options:
+#
+#     --to GROUP      type: string, e.g.: group-one
+#     --help          Get help on this command

data/examples/readme/format

@@ -7,7 +7,7 @@ class Add < Cl::Cmd
   opt '--to GROUP', format: /^\w+$/
 
   def run
-    p to
+    p to: to
   end
 end
 
@@ -15,15 +15,17 @@ Cl.new('owners').run(%w(add --to one))
 
 # Output:
 #
-#   "one"
+#   {:to=>"one"}
 
 Cl.new('owners').run(['add', '--to', 'does not match!'])
 
-# Invalid format: to (format: /^\w+$/)
+# Output:
+#
+#   Invalid format: to (format: /^\w+$/)
 #
-# Usage: format add [options]
+#   Usage: owners add [options]
 #
-# Options:
+#   Options:
 #
-#   --to GROUP      type: string, format: /^\w+$/
-#   --help          Get help on this command
+#     --to GROUP      type: string, format: /^\w+$/
+#     --help          Get help on this command

data/examples/readme/internal

@@ -3,6 +3,8 @@ $: << File.expand_path('lib')
 
 require 'cl'
 
+require 'cl'
+
 class Add < Cl::Cmd
   opt '--to GROUP'
   opt '--hidden', internal: true
@@ -10,9 +12,11 @@ end
 
 Cl.new('owners').run(%w(add --help))
 
-# Usage: example add [options]
+# Output:
+#
+#   Usage: owners add [options]
 #
-# Options:
+#   Options:
 #
-#   --to GROUP      type: string, e.g.: group-one
-#   --help          Get help on this command
+#     --to GROUP      type: string
+#     --help          Get help on this command

data/examples/readme/negate

@@ -12,16 +12,31 @@ class Add < Cl::Cmd
 end
 
 Cl.new('owners').run(%w(add --notifications))
-# => true
+
+# Output:
+#
+#   true
 
 Cl.new('owners').run(%w(add --no_notifications))
-# => false
+
+# Output:
+#
+#   false
 
 Cl.new('owners').run(%w(add --no-notifications))
-# => false
+
+# Output:
+#
+#   false
 
 Cl.new('owners').run(%w(add --skip_notifications))
-# => false
+
+# Output:
+#
+#   false
 
 Cl.new('owners').run(%w(add --skip-notifications))
-# => false
+
+# Output:
+#
+#   false

data/examples/readme/node

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+require 'cl'
+
+class Add < Cl::Cmd
+  opt '--to GROUP', note: 'needs to be a group'
+end
+
+Cl.new('owners').run(%w(add --help))
+
+# Output:
+#
+#   Usage: owners add [options]
+#
+#   Options:
+#
+#     --to GROUP      type: string, note: needs to be a group
+#     --help          Get help on this command