cl 0.1.12 → 0.1.13

data/examples/readme/alias

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+require 'cl'
+
+class Add < Cl::Cmd
+  opt '--to GROUP', alias: :group
+
+  def run
+    p opts, to, to?, group, group?
+  end
+end
+
+Cl.new('owners').run(%w(add --to one))
+
+# Output:
+#
+#   {"to" => "one"}
+#   "one"
+#   true
+#   "one"
+#   true

data/examples/readme/arg

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+require 'cl'
+
+class Add < Cl::Cmd
+  arg :owner
+
+  def run
+    p owner
+  end
+end
+
+Cl.new('owners').run(%w(add one))
+
+# => "one"

data/examples/readme/arg_array

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+require 'cl'
+
+class Add < Cl::Cmd
+  arg :owners, type: :array, sep: ','
+
+  def run
+    p owners
+  end
+end
+
+Cl.new('owners').run(%w(add one,two))
+
+# => ["one", "two"]

data/examples/readme/arg_type

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+require 'cl'
+
+class Cmd < Cl::Cmd
+  arg :one, type: :integer
+  arg :two, type: :float
+  arg :three, type: :boolean
+
+  def run
+    p [one.class, two.class, three.class]
+  end
+end
+
+Cl.new('owners').run(%w(cmd 1 2.1 yes))
+
+# => [Integer, Float, TrueClass]

data/examples/readme/args_splat

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+require 'cl'
+
+class Lft < Cl::Cmd
+  arg :a, type: :array, splat: true
+  arg :b
+  arg :c
+
+  def run
+    p [a, b, c]
+  end
+end
+
+class Mid < Cl::Cmd
+  arg :a
+  arg :b, type: :array, splat: true
+  arg :c
+
+  def run
+    p [a, b, c]
+  end
+end
+
+class Rgt < Cl::Cmd
+  arg :a
+  arg :b
+  arg :c, type: :array, splat: true
+
+  def run
+    p [a, b, c]
+  end
+end
+
+Cl.new('splat').run(%w(lft 1 2 3 4 5))
+Cl.new('splat').run(%w(mid 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"]]

data/examples/readme/array

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+require 'cl'
+
+class Add < Cl::Cmd
+  opt '--to GROUP', type: :array
+
+  def run
+    p to
+  end
+end
+
+Cl.new('owners').run(%w(add --to one --to two))
+
+# Output:
+#
+#   ["one", "two"]

data/examples/readme/default

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+require 'cl'
+
+class Add < Cl::Cmd
+  opt '--to GROUP', default: 'default'
+
+  def run
+    p to
+  end
+end
+
+Cl.new('owners').run(%w(add))
+
+# Output:
+#
+#   "default"

data/examples/readme/deprecated

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+require 'cl'
+
+class Add < Cl::Cmd
+  opt '--to GROUP'
+  opt '--target GROUP', deprecated: 'Deprecated: --target'
+
+  def run
+    p to, deprecated_opts
+  end
+end
+
+Cl.new('owners').run(%w(add --target one))
+
+# Output:
+#
+#   "one"
+#   {:target=>'Deprecated: --target'}
+

data/examples/readme/deprecated_alias

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+require 'cl'
+
+class Add < Cl::Cmd
+  opt '--to GROUP', alias: :target, deprecated: :target
+
+  def run
+    p to, deprecated_opts
+  end
+end
+
+Cl.new('owners').run(%w(add --target one))
+
+# Output:
+#
+#   "one"
+#   {:target=>:to}
+

data/examples/readme/downcase

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+require 'cl'
+
+class Add < Cl::Cmd
+  opt '--to GROUP', downcase: true
+
+  def run
+    p to
+  end
+end
+
+Cl.new('owners').run(%w(add --to ONE))
+
+# Output:
+#
+#   "one"

data/examples/readme/enum

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+require 'cl'
+
+class Add < Cl::Cmd
+  opt '--to GROUP', enum: %w(one two)
+
+  def run
+    p to
+  end
+end
+
+Cl.new('owners').run(%w(add --to one))
+
+# Output:
+#
+#   "one"
+
+Cl.new('owners').run(%w(add --to unknown))
+
+# Unknown value: to=unknown (known values: one, two)
+#
+# Usage: enum add [options]
+#
+# Options: ...

data/examples/readme/example

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

data/examples/readme/format

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+require 'cl'
+
+class Add < Cl::Cmd
+  opt '--to GROUP', format: /^\w+$/
+
+  def run
+    p to
+  end
+end
+
+Cl.new('owners').run(%w(add --to one))
+
+# Output:
+#
+#   "one"
+
+Cl.new('owners').run(['add', '--to', 'does not match!'])
+
+Invalid format: to (format: /^\w+$/)
+
+Usage: format add [options]
+
+Options:
+
+  --to GROUP      type: string, format: /^\w+$/
+  --help          Get help on this command

data/examples/readme/internal

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+require 'cl'
+
+class Add < Cl::Cmd
+  opt '--to GROUP'
+  opt '--hidden', internal: true
+end
+
+Cl.new('owners').run(%w(add --help))
+
+# Usage: example add [options]
+#
+# Options:
+#
+#   --to GROUP      type: string, e.g.: group-one
+#   --help          Get help on this command

data/examples/readme/opts

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+require 'cl'
+
+class Add < Cl::Cmd
+  opt '--to GROUP', 'Target group to add owners to'
+
+  def run
+    p opts, to, to?
+  end
+end
+
+Cl.new('owners').run(%w(add --to one))
+
+# Output:
+#
+#   {"to" => "one"}
+#   "one"
+#   true
+
+Cl.new('owners').run(%w(add --help))
+
+# Usage: opts add [options]
+#
+# Options:
+#
+#   --to GROUP      Target group to add owners to (type: string)
+#   --help          Get help on this command

data/examples/readme/opts_block

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+require 'cl'
+
+class Add < Cl::Cmd
+  # depending on its arity the block can receive:
+  #
+  # * value
+  # * value, name
+  # * value, name, type
+  # * value, name, type, opts
+  opt '--to GROUP' do |value|
+    opts[:to] = "#{value.upcase}!"
+  end
+
+  def run
+    p to
+  end
+end
+
+Cl.new('owners').run(%w(add --to one))
+
+# Output:
+#
+#   "ONE!"

data/examples/readme/range

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+require 'cl'
+
+class Add < Cl::Cmd
+  opt '--retries COUNT', type: :integer, min: 1, max: 5
+
+  def run
+    p retries
+  end
+end
+
+Cl.new('owners').run(%w(add --retries 1))
+
+# Output:
+#
+#   1
+
+Cl.new('owners').run(%w(add --retries 10))
+
+# Out of range: retries (max: 5)
+#
+# Usage: max add [options]
+#
+# Options:
+#
+#   --retries COUNT      type: integer, min: 1, max: 5
+#   --help               Get help on this command

data/examples/readme/required

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+require 'cl'
+
+class Add < Cl::Cmd
+  opt '--to GROUP', required: true
+
+  def run
+    p to
+  end
+end
+
+Cl.new('owners').run(%w(add --to one))
+
+# Output:
+#
+#   "one"
+
+Cl.new('owners').run(%w(add))
+
+# Missing required option: to
+#
+# Usage: required add [options]
+#
+# Options:
+#
+#   --to GROUP      type: string, required: true
+#   --help          Get help on this command

data/examples/readme/requireds

@@ -0,0 +1,36 @@
+#!/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]
+
+  opt '--api_key KEY'
+  opt '--username NAME'
+  opt '--password PASS'
+
+  def run
+    p to, retries
+  end
+end
+
+Cl.new('owners').run(%w(add --to one --retries 1))
+
+# Output:
+#
+#   "one"
+#   1
+
+Cl.new('owners').run(%w(add --retries 1))
+
+# Missing option: to (required by retries)
+#
+# Usage: requires add [options]
+#
+# Options:
+#
+#   --to GROUP         type: string
+#   --retries INT      type: string, requires: to
+#   --help             Get help on this command