cl 0.1.28 → 1.0.0

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

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+<%= run sq(<<-'rb')
+    require 'cl'
+
+    class Required < Cl::Cmd
+      arg :one, required: true
+      arg :two
+
+      def run
+        p cmd: registry_key, one: one, two: two
+      end
+    end
+  rb
+-%>
+
+<%= run 'Cl.new($0).run(%w(required one two))' %>
+
+<%= out '{:cmd=>:required, :one=>"one", :two=>"two"}' %>
+
+<%= run 'Cl.new($0).run(%w(required one))' %>
+
+<%= out '{:cmd=>:required, :one=>"one", :two=>nil}' %>
+
+<%= run 'Cl.new($0).run(%w(required))' %>
+
+<%= out sq(<<-'str')
+    Missing arguments (given: 0, required: 1)
+
+    Usage: bin/examples required one [two] [options]
+
+    Arguments:
+
+      one         type: string, required: true
+      two         type: string
+
+    Options:
+
+      --help      Get help on this command
+  str
+%>
+
+<%= run 'Cl.new($0).run(%w(required one two three))' %>
+
+<%= out sq(<<-'str')
+    Too many arguments (given: 3, allowed: 2)
+
+    Usage: bin/examples required one [two] [options]
+
+    Arguments:
+
+      one         type: string, required: true
+      two         type: string
+
+    Options:
+
+      --help      Get help on this command
+  str
+%>
+

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

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+<%= run sq(<<-'rb')
+    require 'cl'
+
+    module Splat
+      class Left < Cl::Cmd
+        register :left
+
+        arg :one, type: :array, splat: true
+        args :two, :three
+
+        def run
+          p cmd: registry_key, one: one, two: two, three: three
+        end
+      end
+
+      class Middle < Cl::Cmd
+        register :middle
+
+        arg :one
+        arg :two, type: :array, splat: true
+        arg :three
+
+        def run
+          p cmd: registry_key, one: one, two: two, three: three
+        end
+      end
+
+      class Right < Cl::Cmd
+        register :right
+
+        args :one, :two
+        arg :three, type: :array, splat: true
+
+        def run
+          p cmd: registry_key, one: one, two: two, three: three
+        end
+      end
+    end
+  rb
+-%>
+
+<%= run "Cl.new('splat').run(%w(left foo bar baz buz))" %>
+
+<%= out '{:cmd=>:left, :one=>["foo", "bar"], :two=>"baz", :three=>"buz"}' %>
+
+<%= run "Cl.new('splat').run(%w(middle foo bar baz buz))" %>
+
+<%= out '{:cmd=>:middle, :one=>"foo", :two=>["bar", "baz"], :three=>"buz"}' %>
+
+<%= run "Cl.new('splat').run(%w(right foo bar baz buz))" %>
+
+<%= out '{:cmd=>:right, :one=>"foo", :two=>"bar", :three=>["baz", "buz"]}' %>

data/examples/src/gem.erb.rb

@@ -0,0 +1,95 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+<%= run sq(<<-'rb')
+    require 'cl'
+
+    module Gem
+      module Release
+        module Cmds
+          class Release < Cl::Cmd
+            arg :gemspec
+
+            opt '-h', '--host HOST', 'Push to a compatible host other than rubygems.org'
+            opt '-k', '--key KEY',   'Rubygems API key to use'
+            opt '-q', '--quiet',     'Silence output'
+
+            def run
+              p cmd: registry_key, args: args, opts: opts
+            end
+          end
+
+          class Bump < Cl::Cmd
+            opt '-v', '--version VERSION', 'The version to bump to [1.1.1|major|minor|patch|pre|rc|release]'
+            opt '--[no-]commit',           'Bump the version, but do not commit'
+
+            def run
+              p cmd: registry_key, args: args, opts: opts
+            end
+          end
+        end
+      end
+    end
+  rb
+-%>
+
+<%= run "Cl.new('gem').run(%w(help))" %>
+
+<%= out sq(<<-'str')
+    Type "gem help COMMAND [SUBCOMMAND]" for more details:
+
+    gem release [gemspec] [options]
+    gem bump [options]
+  str
+%>
+
+
+<%= run "Cl.new('gem').run(%w(help release))" %>
+# or:
+#
+#   Cl.new('gem').run(%w(release --help)))
+#   Cl.new('gem').run(%w(release -h)))
+#
+<%= out sq(<<-'str')
+    Usage: gem release [gemspec] [options]
+
+    Arguments:
+
+      gemspec              type: string
+
+    Options:
+
+      -h --host HOST       Push to a compatible host other than rubygems.org (type: string)
+      -k --key KEY         Rubygems API key to use (type: string)
+      -q --[no-]quiet      Silence output
+         --help            Get help on this command
+  str
+%>
+
+
+<%= run "Cl.new('gem').run(%w(help bump))" %>
+# or:
+#
+#   Cl.new('gem').run(%w(bump --help)))
+#   Cl.new('gem').run(%w(bump -h)))
+#
+<%= out sq(<<-'str')
+    Usage: gem bump [options]
+
+    Options:
+
+      -v --version VERSION      The version to bump to [1.1.1|major|minor|patch|pre|rc|release] (type: string)
+         --[no-]commit          Bump the version, but do not commit
+         --help                 Get help on this command
+  str
+%>
+
+
+<%= run "Cl.new('gem').run(%w(bump -v 1.1.1))" %>
+
+<%= out '{:cmd=>:bump, :args=>[], :opts=>{:version=>"1.1.1"}}' %>
+
+
+<%= run "Cl.new('gem').run(%w(release foo.gemspec -h host -k key -q))" %>
+
+<%= out '{:cmd=>:release, :args=>["foo.gemspec"], :opts=>{:host=>"host", :key=>"key", :quiet=>true}}' %>

data/examples/src/heroku.erb.rb

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+<%= run sq(<<-'rb')
+    require 'cl'
+
+    module Heroku
+      module Apps
+        class Create < Cl::Cmd
+          register 'apps:create'
+
+          arg :name, required: true
+
+          opt '-o', '--org ORG'
+
+          def run
+            p cmd: registry_key, args: args, opts: opts
+          end
+        end
+
+        class List < Cl::Cmd
+          register 'apps:info'
+
+          opt '-a', '--app APP'
+
+          def run
+            p cmd: registry_key, args: args, opts: opts
+          end
+        end
+      end
+    end
+  rb
+-%>
+
+<%= run "Cl.new('heroku').run(%w(apps:create name -o org))" %>
+# or:
+#
+#   Cl.new('heroku').run(%w(apps create name -o org))
+
+<%= out '{:cmd=>:"apps:create", :args=>["name"], :opts=>{:org=>"org"}}' %>
+
+<%= run "Cl.new('heroku').run(%w(apps:info -a app))" %>
+# or:
+#
+#   Cl.new('heroku').run(%w(apps info -a app))
+
+<%= out '{:cmd=>:"apps:info", :args=>[], :opts=>{:app=>"app"}}' %>

data/examples/src/rakeish.erb.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+<%= run sq(<<-'rb')
+    require 'cl'
+
+    module Rakeish
+      module Db
+        class Create < Cl::Cmd
+          register 'db:create'
+
+          arg :name
+
+          def run
+            p cmd: registry_key, args: args, opts: opts
+          end
+        end
+
+        class Drop < Cl::Cmd
+          register 'db:drop'
+
+          arg :name
+
+          opt '-f', '--force'
+
+          def run
+            p cmd: registry_key, args: args, opts: opts
+          end
+        end
+
+        class Migrate < Cl::Cmd
+          register 'db:migrate'
+
+          arg :name
+
+          opt '-v', '--version VERSION'
+
+          def run
+            p cmd: registry_key, args: args, opts: opts
+          end
+        end
+      end
+    end
+  rb
+-%>
+
+<%= run "Cl.new('rake', runner: :multi).run(%w(db:drop production -f db:create db:migrate production -v 1))" %>
+
+<%= out sq(<<-'str')
+    {:cmd=>:"db:drop", :args=>["production"], :opts=>{:force=>true}}
+    {:cmd=>:"db:create", :args=>[], :opts=>{}}
+    {:cmd=>:"db:migrate", :args=>["production"], :opts=>{:version=>"1"}}
+  str
+%>

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

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+require 'cl'
+
+<%= run sq(<<-'rb')
+    class Base < Cl::Cmd
+      abstract
+    end
+
+    class Add < Base
+      def run
+        puts 'Success'
+      end
+    end
+  rb
+-%>
+
+<%= run "Cl.new('owners').run(%w(add))" %>
+
+<%= out 'Success' %>
+
+<%= run "Cl.new('owners').run(%w(base))" %>
+
+<%= out 'Unknown command: base' %>

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

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+<%= run sq(<<-'rb')
+    require 'cl'
+
+    class Add < Cl::Cmd
+      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
+  rb
+-%>
+
+<%= run "Cl.new('owners').run(%w(add --group one))" %>
+
+<%= out '{:opts=>{:to=>"one", :group=>"one"}, :to=>"one", :to?=>true}' %>

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

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

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

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

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

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+<%= run sq(<<-'rb')
+    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
+  rb
+-%>
+
+<%= run "Cl.new('owners').run(%w(cmd 1 2.1 yes))" %>
+
+<%= out "[#{RUBY_VERSION < '2.4' ? 'Fixnum' : 'Integer'}, Float, TrueClass]" %>

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

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+<%= run sq(<<-'rb')
+    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
+  rb
+-%>
+
+<%= run "Cl.new('splat').run(%w(lft 1 2 3 4 5))" %>
+
+<%= out '[["1", "2", "3"], "4", "5"]' %>
+
+<%= run "Cl.new('splat').run(%w(mid 1 2 3 4 5))" %>
+
+<%= out '["1", ["2", "3", "4"], "5"]' %>
+
+<%= run "Cl.new('splat').run(%w(rgt 1 2 3 4 5))" %>
+
+<%= out '["1", "2", ["3", "4", "5"]]' %>