cl 0.1.28 → 1.0.0

data/examples/readme/opts

@@ -7,7 +7,7 @@ class Add < Cl::Cmd
   opt '--to GROUP', 'Target group to add owners to'
 
   def run
-    p opts, to, to?
+    p opts: opts, to: to, to?: to?
   end
 end
 
@@ -15,15 +15,15 @@ Cl.new('owners').run(%w(add --to one))
 
 # Output:
 #
-#   {"to" => "one"}
-#   "one"
-#   true
+#   {:opts=>{:to=>"one"}, :to=>"one", :to?=>true}
 
 Cl.new('owners').run(%w(add --help))
 
-# Usage: opts add [options]
+# Output:
+#
+#   Usage: owners add [options]
 #
-# Options:
+#   Options:
 #
-#   --to GROUP      Target group to add owners to (type: string)
-#   --help          Get help on this command
+#     --to GROUP      Target group to add owners to (type: string)
+#     --help          Get help on this command

data/examples/readme/opts_block

@@ -11,11 +11,11 @@ class Add < Cl::Cmd
   # * value, name, type
   # * value, name, type, opts
   opt '--to GROUP' do |value|
-    opts[:to] = "#{value.upcase}!"
+    opts[:to] = "group-#{value}"
   end
 
   def run
-    p to
+    p to: to
   end
 end
 
@@ -23,4 +23,5 @@ Cl.new('owners').run(%w(add --to one))
 
 # Output:
 #
-#   "ONE!"
+#   {:to=>"group-one"}
+

data/examples/readme/range

@@ -7,7 +7,7 @@ class Add < Cl::Cmd
   opt '--retries COUNT', type: :integer, min: 1, max: 5
 
   def run
-    p retries
+    p retries: retries
   end
 end
 
@@ -15,15 +15,17 @@ Cl.new('owners').run(%w(add --retries 1))
 
 # Output:
 #
-#   1
+#   {:retries=>1}
 
 Cl.new('owners').run(%w(add --retries 10))
 
-# Out of range: retries (max: 5)
+# Output:
+#
+#   Out of range: retries (min: 1, max: 5)
 #
-# Usage: max add [options]
+#   Usage: owners add [options]
 #
-# Options:
+#   Options:
 #
-#   --retries COUNT      type: integer, min: 1, max: 5
-#   --help               Get help on this command
+#     --retries COUNT      type: integer, min: 1, max: 5
+#     --help               Get help on this command

data/examples/readme/required

@@ -7,7 +7,7 @@ class Add < Cl::Cmd
   opt '--to GROUP', required: true
 
   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(%w(add))
 
-# Missing required option: to
+# Output:
+#
+#   Missing required option: to
 #
-# Usage: required add [options]
+#   Usage: owners add [options]
 #
-# Options:
+#   Options:
 #
-#   --to GROUP      type: string, required: true
-#   --help          Get help on this command
+#     --to GROUP      type: string, required: true
+#     --help          Get help on this command

data/examples/readme/requireds

@@ -1,36 +1,44 @@
 #!/usr/bin/env ruby
 $: << File.expand_path('lib')
 
-require 'cl'
-
 class Add < Cl::Cmd
-  # read DNF, i.e. "apikey OR username AND password
-  required :api_key, [:username, :password]
+  # read DNF, i.e. "token OR user AND pass
+  required :token, [:user, :pass]
 
-  opt '--api_key KEY'
-  opt '--username NAME'
-  opt '--password PASS'
+  opt '--token TOKEN'
+  opt '--user NAME'
+  opt '--pass PASS'
 
   def run
-    p to, retries
+    p token: token, user: user, pass: pass
   end
 end
 
-Cl.new('owners').run(%w(add --to one --retries 1))
+Cl.new('owners').run(%w(add --token token))
+
+# Output:
+#
+#   {:token=>"token", :user=>nil, :pass=>nil}
+
+Cl.new('owners').run(%w(add --user user --pass pass))
 
 # Output:
 #
-#   "one"
-#   1
+#   {:token=>nil, :user=>"user", :pass=>"pass"}
 
-Cl.new('owners').run(%w(add --retries 1))
+Cl.new('owners').run(%w(add))
 
-# Missing option: to (required by retries)
+# Output:
+#
+#   Missing options: token, or user and pass
+#
+#   Usage: owners add [options]
 #
-# Usage: requires add [options]
+#   Options:
 #
-# Options:
+#     Either token, or user and pass are required.
 #
-#   --to GROUP         type: string
-#   --retries INT      type: string, requires: to
-#   --help             Get help on this command
+#     --token TOKEN      type: string
+#     --user NAME        type: string
+#     --pass PASS        type: string
+#     --help             Get help on this command

data/examples/readme/requires

@@ -1,32 +1,31 @@
 #!/usr/bin/env ruby
 $: << File.expand_path('lib')
 
-require 'cl'
-
 class Add < Cl::Cmd
   opt '--to GROUP'
-  opt '--retries INT', requires: :to
+  opt '--other GROUP', requires: :to
 
   def run
-    p to, retries
+    p to: to, other: other
   end
 end
 
-Cl.new('owners').run(%w(add --to one --retries 1))
+Cl.new('owners').run(%w(add --to one --other two))
 
 # Output:
 #
-#   "one"
-#   1
+#   {:to=>"one", :other=>"two"}
 
-Cl.new('owners').run(%w(add --retries 1))
+Cl.new('owners').run(%w(add --other two))
 
-# Missing option: to (required by retries)
+# Output:
+#
+#   Missing option: to (required by other)
 #
-# Usage: requires add [options]
+#   Usage: owners add [options]
 #
-# Options:
+#   Options:
 #
-#   --to GROUP         type: string
-#   --retries INT      type: string, requires: to
-#   --help             Get help on this command
+#     --to GROUP         type: string
+#     --other GROUP      type: string, requires: to
+#     --help             Get help on this command

data/examples/readme/secret

@@ -1,21 +1,19 @@
 #!/usr/bin/env ruby
 $: << File.expand_path('lib')
 
-require 'cl'
-
 class Add < Cl::Cmd
-  opt '--to GROUP'
-  opt '--password PASS', secret: true
+  opt '--pass PASS', secret: true
 
   def run
-    puts [:secret?, self.class.opts[:password].secret?].join(' ')
-    puts [:tainted?, password.tainted?].join(' ')
+    p(
+      secret?: self.class.opts[:pass].secret?,
+      tainted?: pass.tainted?
+    )
   end
 end
 
-Cl.new('owners').run(%w(add --password pass))
+Cl.new('owners').run(%w(add --pass pass))
 
 # Output:
 #
-#   secret? true
-#   tainted? true
+#   {:secret?=>true, :tainted?=>true}

data/examples/readme/see

@@ -5,17 +5,15 @@ require 'cl'
 
 class Add < Cl::Cmd
   opt '--to GROUP', see: 'https://docs.io/cli/owners/add'
-
-  def run
-    p retries
-  end
 end
 
 Cl.new('owners').run(%w(add --help))
 
-# Usage: see add [options]
+# Output:
+#
+#   Usage: owners add [options]
 #
-# Options:
+#   Options:
 #
-#   --to GROUP      type: string, see: https://docs.io/cli/owners/add
-#   --help          Get help on this command
+#     --to GROUP      type: string, see: https://docs.io/cli/owners/add
+#     --help          Get help on this command

data/examples/readme/type

@@ -1,15 +1,13 @@
 #!/usr/bin/env ruby
 $: << File.expand_path('lib')
 
-require 'cl'
-
 class Add < Cl::Cmd
   opt '--active BOOL', type: :boolean
   opt '--retries INT', type: :integer
   opt '--sleep FLOAT', type: :float
 
   def run
-    p active.class, retries.class, sleep.class
+    p active: active.class, retries: retries.class, sleep: sleep.class
   end
 end
 
@@ -17,6 +15,4 @@ Cl.new('owners').run(%w(add --active yes --retries 1 --sleep 0.1))
 
 # Output:
 #
-#   TrueClass
-#   Integer
-#   Float
+#   {:active=>TrueClass, :retries=>Integer, :sleep=>Float}

data/examples/src/args/cast.erb.rb

@@ -0,0 +1,96 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+<%= run sq(<<-'rb')
+    require 'cl'
+
+    module Cast
+      class Bool < Cl::Cmd
+        arg :bool, type: :bool
+
+        def run
+          p cmd: registry_key, bool: bool
+        end
+      end
+
+      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
+  rb
+-%>
+
+<%= run 'Cl.new($0).run(%w(bool on))' %>
+
+<%= out '{:cmd=>:bool, :bool=>true}' %>
+
+<%= run 'Cl.new($0).run(%w(types true 1 1.2 foo))' %>
+
+<%= out '{:cmd=>:types, :a=>true, :b=>1, :c=>1.2, :d=>"foo"}' %>
+
+<%= run 'Cl.new($0).run(%w(types true 1 1.2 foo bar))' %>
+
+<%= out sq(<<-'str')
+    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
+  str
+%>
+
+<%= run 'Cl.new($0).run(%w(types true one 1.2))' %>
+
+<%= out sq(<<-'str')
+    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
+  str
+%>
+
+<%= run 'Cl.new($0).run(%w(types true 1 one))' %>
+
+<%= out sq(<<-'str')
+    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
+  str
+%>

data/examples/src/args/opts.erb.rb

@@ -0,0 +1,96 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+<%= run sq(<<-'rb')
+    require 'cl'
+
+    module Opts
+      class Bool < Cl::Cmd
+        arg :bool, type: :bool
+
+        def run
+          p cmd: registry_key, bool: bool
+        end
+      end
+
+      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
+  rb
+-%>
+
+<%= run 'Cl.new($0).run(%w(bool on))' %>
+
+<%= out '{:cmd=>:bool, :bool=>true}' %>
+
+<%= run 'Cl.new($0).run(%w(types true 1 1.2 foo))' %>
+
+<%= out '{:cmd=>:types, :a=>true, :b=>1, :c=>1.2, :d=>"foo"}' %>
+
+<%= run 'Cl.new($0).run(%w(types true 1 1.2 foo bar))' %>
+
+<%= out sq(<<-'str')
+    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
+  str
+%>
+
+<%= run 'Cl.new($0).run(%w(types true one 1.2))' %>
+
+<%= out sq(<<-'str')
+    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
+  str
+%>
+
+<%= run 'Cl.new($0).run(%w(types true 1 one))' %>
+
+<%= out sq(<<-'str')
+    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
+  str
+%>