travis-cl 1.2.4

data/examples/readme/alias

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+require 'cl'
+
+class Add < Cl::Cmd
+  register :add
+
+  opt '--to GROUP', alias: :group
+
+  def run
+    # 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 --group one))
+
+# Output:
+#
+#   {:opts=>{:to=>"one", :group=>"one"}, :to=>"one", :to?=>true}

data/examples/readme/arg

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

data/examples/readme/arg_array

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

data/examples/readme/arg_type

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+require 'cl'
+
+class Cmd < Cl::Cmd
+  register :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))
+
+# Output:
+#
+#   [Integer, Float, TrueClass]

data/examples/readme/args_splat

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

data/examples/readme/array

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+require 'cl'
+
+class Add < Cl::Cmd
+  register :add
+
+  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/basic

@@ -0,0 +1,67 @@
+require 'cl'
+
+# e.g. lib/owners/add.rb
+module Owners
+  class Add < Cl::Cmd
+    register :add
+
+    summary 'Add one or more owners to an existing owner group'
+
+    description <<~str
+      Use this command to add one or more owners to an existing
+      owner group.
+
+      [...]
+    str
+
+    args :owner
+
+    opt '-t', '--to TO', 'An existing owner group'
+
+    def run
+      # implement adding the owner as given in `owner` (as well as `args`)
+      # to the group given in `to` (as well as `opts[:to]`).
+      p owner: owner, to: to, to?: to?, args: args, opts: opts
+    end
+  end
+end
+
+# Running this, e.g. using `bin/owners add one,two --to group` will instantiate the
+# class `Owners::Add`, and call the method `run` on it.
+
+# e.g. bin/owners
+#
+# args normally would be ARGV
+args = %w(add one --to group)
+
+Cl.new('owners').run(args)
+
+# Output:
+#
+#   {:owner=>"one", :to=>"group", :to?=>true, :args=>["one"], :opts=>{:to=>"group"}}
+
+Cl.new('owners').run(%w(add --help))
+
+# Output:
+#
+#   Usage: owners add [owner] [options]
+#
+#   Summary:
+#
+#     Add one or more owners to an existing owner group
+#
+#   Description:
+#
+#     Use this command to add one or more owners to an existing
+#     owner group.
+#
+#     [...]
+#
+#   Arguments:
+#
+#     owner           type: string
+#
+#   Options:
+#
+#     -t --to TO      An existing owner group (type: string)
+#        --help       Get help on this command

data/examples/readme/default

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

data/examples/readme/deprecated

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

data/examples/readme/deprecated_alias

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

data/examples/readme/description

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+require 'cl'
+
+module Owners
+  class Add < Cl::Cmd
+    register :add
+
+    summary 'Add one or more owners to an existing owner group'
+
+    description <<~str
+      Use this command to add one or more owners to an existing
+      owner group.
+    str
+
+    examples <<~str
+      Adding a single user to the group admins:
+
+        owners add user --to admins
+
+      Adding a several users at once:
+
+        owners add one two three --to admins
+    str
+  end
+end
+
+Cl.new('owners').run(%w(add --help))
+
+# Output:
+#
+#   Usage: owners add [options]
+#
+#   Summary:
+#
+#     Add one or more owners to an existing owner group
+#
+#   Description:
+#
+#     Use this command to add one or more owners to an existing
+#     owner group.
+#
+#   Options:
+#
+#     --help      Get help on this command
+#
+#   Examples:
+#
+#     Adding a single user to the group admins:
+#
+#       owners add user --to admins
+#
+#     Adding a several users at once:
+#
+#       owners add one two three --to admins

data/examples/readme/downcase

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

data/examples/readme/enum

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

data/examples/readme/example

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

data/examples/readme/format

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

data/examples/readme/internal

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

data/examples/readme/negate

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+require 'cl'
+
+class Add < Cl::Cmd
+  register :add
+
+  opt '--notifications', 'Send out notifications to the team', negate: %w(skip)
+
+  def run
+    p notifications?
+  end
+end
+
+Cl.new('owners').run(%w(add --notifications))
+
+# Output:
+#
+#   true
+
+Cl.new('owners').run(%w(add --no_notifications))
+
+# Output:
+#
+#   false
+
+Cl.new('owners').run(%w(add --no-notifications))
+
+# Output:
+#
+#   false
+
+Cl.new('owners').run(%w(add --skip_notifications))
+
+# Output:
+#
+#   false
+
+Cl.new('owners').run(%w(add --skip-notifications))
+
+# Output:
+#
+#   false

data/examples/readme/note

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+require 'cl'
+
+class Add < Cl::Cmd
+  register :add
+
+  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

data/examples/readme/opts

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+require 'cl'
+
+class Add < Cl::Cmd
+  register :add
+
+  opt '--to GROUP', 'Target group to add owners to'
+
+  def run
+    p opts: opts, to: to, to?: to?
+  end
+end
+
+Cl.new('owners').run(%w(add --to one))
+
+# Output:
+#
+#   {:opts=>{:to=>"one"}, :to=>"one", :to?=>true}
+
+Cl.new('owners').run(%w(add --help))
+
+# Output:
+#
+#   Usage: owners 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,29 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+require 'cl'
+
+class Add < Cl::Cmd
+  register :add
+
+  # 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] = "group-#{value}"
+  end
+
+  def run
+    p to: to
+  end
+end
+
+Cl.new('owners').run(%w(add --to one))
+
+# Output:
+#
+#   {:to=>"group-one"}
+

data/examples/readme/range

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

data/examples/readme/registry

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+module Cmd
+  class One < Cl::Cmd
+    register :one
+  end
+
+  class Two < Cl::Cmd
+    register :two
+  end
+end
+
+p Cl::Cmd[:one] # => Cmd::One
+p Cl::Cmd[:two] # => Cmd::Two

data/examples/readme/required

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