cl 0.1.28 → 1.0.0

data/examples/src/readme/array.erb.rb

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

data/examples/src/readme/default.erb.rb

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

data/examples/src/readme/deprecated.erb.rb

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

data/examples/src/readme/deprecated_alias.erb.rb

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

data/examples/src/readme/downcase.erb.rb

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

data/examples/src/readme/enum.erb.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+<%= run sq(<<-'rb')
+    require 'cl'
+
+    class Add < Cl::Cmd
+      opt '--to GROUP', enum: %w(one two)
+
+      def run
+        p to: to
+      end
+    end
+  rb
+-%>
+
+<%= run "Cl.new('owners').run(%w(add --to one))" %>
+
+<%= out '{:to=>"one"}' %>
+
+<%= run "Cl.new('owners').run(%w(add --to unknown))" %>
+
+<%= out sq(<<-'str')
+    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
+  str
+%>

data/examples/src/readme/example.erb.rb

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

data/examples/src/readme/format.erb.rb

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

data/examples/src/readme/internal.erb.rb

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

data/examples/src/readme/negate.erb.rb

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

data/examples/src/readme/node.erb.rb

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

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

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

data/examples/src/readme/opts_block.erb.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+<%= run sq(<<-'rb')
+    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] = "group-#{value}"
+      end
+
+      def run
+        p to: to
+      end
+    end
+  rb
+-%>
+
+<%= run "Cl.new('owners').run(%w(add --to one))" %>
+
+<%= out '{:to=>"group-one"}' %>
+

data/examples/src/readme/range.erb.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+<%= run sq(<<-'rb')
+    require 'cl'
+
+    class Add < Cl::Cmd
+      opt '--retries COUNT', type: :integer, min: 1, max: 5
+
+      def run
+        p retries: retries
+      end
+    end
+  rb
+-%>
+
+<%= run "Cl.new('owners').run(%w(add --retries 1))" %>
+
+<%= out '{:retries=>1}' %>
+
+<%= run "Cl.new('owners').run(%w(add --retries 10))" %>
+
+<%= out sq(<<-'str')
+    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
+  str
+%>

data/examples/src/readme/required.erb.rb

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

data/examples/src/readme/requireds.erb.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+<%= run sq(<<-'rb')
+  class Add < Cl::Cmd
+    # read DNF, i.e. "token OR user AND pass
+    required :token, [:user, :pass]
+
+    opt '--token TOKEN'
+    opt '--user NAME'
+    opt '--pass PASS'
+
+    def run
+      p token: token, user: user, pass: pass
+    end
+  end
+  rb
+-%>
+
+<%= run "Cl.new('owners').run(%w(add --token token))" %>
+
+<%= out '{:token=>"token", :user=>nil, :pass=>nil}' %>
+
+<%= run "Cl.new('owners').run(%w(add --user user --pass pass))" %>
+
+<%= out '{:token=>nil, :user=>"user", :pass=>"pass"}' %>
+
+<%= run "Cl.new('owners').run(%w(add))" %>
+
+<%= out sq(<<-'str')
+  Missing options: token, or user and pass
+
+  Usage: owners add [options]
+
+  Options:
+
+    Either token, or user and pass are required.
+
+    --token TOKEN      type: string
+    --user NAME        type: string
+    --pass PASS        type: string
+    --help             Get help on this command
+  str
+%>