cl 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9857c406109f06a92986bef6a3290f5b6647c17f
-  data.tar.gz: a861829fbef67c227006437d42a3848380c2b084
+SHA256:
+  metadata.gz: bb6a93f33e5cae5c1ec0b0bba6b1d3981b853ee6e5a4fde75d3b5c4df7176162
+  data.tar.gz: 0a247824d773fd1251b19e353e629780cb36b6b4f1ef3553e8ab2752ffdf9ad4
 SHA512:
-  metadata.gz: e5e446a970a5e7f180df5ee0875e25443c17f0a6599c6103440782a02cc0bb8a8380582deb2fbdaed87eee2edbf9a98a339a455f09101f6bd963a7f02a39b78e
-  data.tar.gz: d98b7935d11f18eefb33ae70c93cb12be5fb7c1a821877460a1b4cd4adaee6531b4c12991834aafe1c745ef0a0b8c4a11fa1be317b35393b5b81dc7b345ad236
+  metadata.gz: f69f9e9840312da35a16d7d27a5705e0cf3d4a8364aaff4e7f90757bad2754e8a47ce6a20779e88a16269fb2b6d3ada9215397e84dd9988eba74afc2b44373c7
+  data.tar.gz: ea7533eb5588ddedee0343dbef28a7d0bfb9b2a7bab4e9ca2e427e2ce198bc857e3ca5c55526471f657bea485dee454235939b82dd30b7c718c3c2ea0d757210

data/CHANGELOG.md

@@ -0,0 +1,47 @@
+# Changelog
+
+## 0.1.0 (unreleased)
+
+### Added
+
+* Add config, reading from env vars and yml files (inspired by gem-release)
+* Add `abstract` in order to signal a cmd is a base class that is not meant to be executed
+* Add `opt '--path', type: :array` for options that can be given multiple times
+* Add `opt '--one STR', default: 'one'`
+* Add `opt '--one STR', requires :two` or `[:two, :three]` for options that depend on other options
+* Add `opt '--one', alias: :other`
+* Add `opt '--one', deprecated: true`, and `cmd.deprected_opts`, so clients can look up which deprecated options were used
+* Add `opt '--one', alias: :other, deprecated: :other`, so that `cmd.deprecated_opts` returns the alias name if it was used
+* Add `opt '--int', max: 10, type: :integer`
+* Add `opt '--one', format: /.+/`
+* Add `opt '--one', enum: ['one', 'two']`
+* Add `required :one, [:two, :three]` (DNF, i.e: either :one or both :two and :three must be given)
+
+### Changed
+
+* Much improved help output, modeled after rubygems' help output
+* Cl is now a class
+* Use the regstry gem, remove the local Registry implementation
+* If a flag (boolean option) has a default `true` automatically add `[no-]` to
+  it, allowing to opt out
+
+### Removed
+
+* Removed cmd.defaults, options have default: [value] now
+
+## 0.0.4 (2017-08-02)
+
+* Ancient history
+
+## 0.0.3 (2017-08-02)
+
+* Ancient history
+
+## 0.0.2 (2017-04-09)
+
+* Ancient history
+
+## 0.0.1 (2017-04-08)
+
+* Ancient history
+

data/Gemfile

@@ -1,5 +1,8 @@
 source 'https://rubygems.org'
 
+gemspec
+
 group :test do
+  gem 'memfs'
   gem 'rspec'
 end

data/Gemfile.lock

@@ -1,26 +1,36 @@
+PATH
+  remote: .
+  specs:
+    cl (0.0.4)
+      regstry (~> 1.0.3)
+
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.3)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.4)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
+    memfs (1.0.0)
+    regstry (1.0.6)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  cl!
+  memfs
   rspec
 
 BUNDLED WITH
-   1.14.6
+   1.17.2

data/NOTES.md

@@ -1,25 +1,3 @@
-Usage: gem release [gemspec] [options]
+- properly catch errors, see examples/cast etc
+- add conditional required: ->(opts) { opts[:key].nil? }
 
-  Options:
-    -t, --[no-]tag                   Create a git tag and push it to the destination (defaults to false)
-    -d, --destination DESTINATION    Destination git repository (defaults to origin)
-    -k, --key KEY                    Use the given API key from ~/.gem/credentials (not set by default)
-        --host HOST                  Push to a gemcutter-compatible host other than rubygems.org (not set by default)
-
-
-  Common Options:
-    -h, --help                       Get help on this command
-    -V, --[no-]verbose               Set the verbose level of output
-    -q, --quiet                      Silence command progress meter
-        --silent                     Silence rubygems output
-        --config-file FILE           Use this config file instead of default
-        --backtrace                  Show stack backtrace on errors
-        --debug                      Turn on Ruby debugging
-        --norc                       Avoid loading any .gemrc file
-
-
-  Arguments:
-    gemspec - optional gemspec file name, will use the first *.gemspec if not specified
-
-  Summary:
-    Build gem from a gemspec and push to rubygems.org

data/README.md

@@ -14,7 +14,7 @@ module Owners
 
     args :owners
 
-    on '-t', '--to TO', 'An owner in an existing group' do |value|
+    opt '-t', '--to TO', 'An owner in an existing group' do |value|
       opts[:to] = value
     end
   end

data/examples/args/cast

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+require 'cl'
+
+class Bool < Cl::Cmd
+  arg :bool, type: :bool
+
+  def run
+    [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
+    [registry_key, a: a, b: b, c: c, d: d]
+  end
+end
+
+def output(cmd, args)
+  args = args.map { |key, value| "#{key}=#{value.inspect}" }.join(' ')
+  puts "Called #{cmd} with #{args}\n\n"
+end
+
+output *Cl.new($0).run(%w(bool on))
+
+# Output:
+#
+#   Called bool with bool=true
+
+output *Cl.new($0).run(%w(bool on))
+
+# Output:
+#
+#   Called bool with bool=true
+
+output *Cl.new($0).run(%w(bool on))
+
+# Output:
+#
+#   Called bool with bool=true
+
+output *Cl.new($0).run(%w(bool on))
+
+# Output:
+#
+#   Called bool with bool=true
+
+output *Cl.new($0).run(%w(types true 1 1.2 foo))
+
+# Output:
+#
+#   Called types with a=true b=1 c=1.2 d="foo"
+
+Cl.new($0).run(%w(types true 1 1.2))
+
+# Output:
+#
+#   Too many arguments (given: 5, allowed: 4)
+#
+#   Usage: cast.rb types [a (bool)] [b (int)] [c (float)] [d]
+
+Cl.new($0).run(%w(types true one 1.2))
+
+# Output:
+#
+#   Wrong argument type (given: "one", expected: int)
+#
+#   Usage: cast.rb types [a (bool)] [b (int)] [c (float)] [d]
+
+Cl.new($0).run(%w(types true 1 one))
+
+# Output:
+#
+#   Wrong argument type (given: "one", expected: float)
+#
+#   Usage: cast.rb types [a (bool)] [b (int)] [c (float)] [d]

data/examples/args/opts

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+require 'cl'
+
+class Opts < Cl::Cmd
+  opt '-p', '--path PATH'
+  opt '-v', '--verbose'
+
+  def run
+    [registry_key, args, opts]
+  end
+end
+
+def output(cmd, args, opts)
+  puts "Called #{cmd} with args=#{args} opts=#{opts}\n\n"
+end
+
+output *Cl.new($0).run(%w(opts -p path -v))
+
+# Output:
+#
+#   Called cast with args=[] opts={:path=>"path", :verbose=>true}
+
+output *Cl.new($0).run(%w(opts --path path --verbose))
+
+# Output:
+#
+#   Called cast with args=[] opts={:path=>"path", :verbose=>true}
+
+output *Cl.new($0).run(%w(opts one -p path two -v three))
+
+# Output:
+#
+#   Called cast with args=["one", "two", "three"] opts={:path=>"path", :verbose=>true}
+

data/examples/args/required

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+require 'cl'
+
+class Required < Cl::Cmd
+  arg :one, required: true
+  arg :two
+
+  def run
+    [registry_key, one: one, two: two]
+  end
+end
+
+def output(cmd, args)
+  args = args.map { |key, value| "#{key}=#{value.inspect}" }.join(' ')
+  puts "Called #{cmd} with #{args}\n\n"
+end
+
+output *Cl.new($0).run(%w(required one two))
+
+# Output:
+#
+#   Called required with one="one" two="two"
+
+output *Cl.new($0).run(%w(required one))
+
+# Output:
+#
+#   Called required with one="one" two=nil
+
+output *Cl.new($0).run(%w(required))
+
+# Output:
+#
+#   Missing arguments (given: 0, required: 1)
+#
+#   Usage: args.rb required one [two]
+
+output *Cl.new($0).run(%w(required one two three))
+
+# Output:
+#
+#   Too many arguments (given: 3, allowed: 2)
+#
+#   Usage: args.rb required one [two]

data/examples/args/splat

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+require 'cl'
+
+class SplatLeft < Cl::Cmd
+  register 'splat:left'
+
+  arg :one, type: :array
+  args :two, :three
+
+  def run
+    [registry_key, one: one, two: two, three: three]
+  end
+end
+
+class SplatMiddle < Cl::Cmd
+  register 'splat:middle'
+
+  arg :one
+  arg :two, type: :array
+  arg :three
+
+  def run
+    [registry_key, one: one, two: two, three: three]
+  end
+end
+
+class SplatRight < Cl::Cmd
+  register 'splat:right'
+
+  args :one, :two
+  arg :three, type: :array
+
+  def run
+    [registry_key, one: one, two: two, three: three]
+  end
+end
+
+def output(cmd, args)
+  args = args.map { |key, value| "#{key}=#{value.inspect}" }.join(' ')
+  puts "Called #{cmd} with #{args}\n\n"
+end
+
+output *Cl.new($0).run(%w(splat left foo bar baz buz))
+
+# Output:
+#
+#   Called splat:left with one=["foo", "bar"] two="baz" three="buz"
+
+output *Cl.new($0).run(%w(splat middle foo bar baz buz))
+
+# Output:
+#
+#   Called splat:middle with one="foo" two=["bar", "baz"] three="buz"
+
+output *Cl.new($0).run(%w(splat right foo bar baz buz))
+
+# Output:
+#
+#   Called splat:middle with one="foo" two="bar" three=["baz", "buz"]

data/examples/gem

@@ -0,0 +1,104 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+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
+          [registry_key, args, opts]
+        end
+      end
+
+      class Bump < Cl::Cmd
+        defaults commit: true
+
+        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
+          [registry_key, args, opts]
+        end
+      end
+    end
+  end
+end
+
+Cl.new($0).run(%w(help))
+puts
+
+# Output:
+#
+#   Type "gem help COMMAND [SUBCOMMAND]" for more details:
+#
+#   gem release [gemspec] [options]
+#   gem bump [options]
+
+Cl.new($0).run(%w(help release))
+puts
+
+# or:
+#
+#   Cl.new($0).run(%w(release --help)))
+#   Cl.new($0).run(%w(release -h)))
+#
+# Output:
+#
+#   Usage: gem release [gemspec] [options]
+#
+#   Arguments:
+#
+#     gemspec
+#
+#   Options:
+#
+#     -h --host HOST      Push to a compatible host other than rubygems.org
+#     -k --key KEY        Rubygems API key to use
+#     -q --quiet          Silence output
+#        --help           Get help on this command
+
+Cl.new($0).run(%w(help release))
+puts
+
+# or:
+#
+#   Cl.run($0, %w(release --help))
+#   Cl.run($0, %w(release -h))
+#
+# Output:
+#
+#   Usage: gem bump [options]
+#
+#   Options:
+#
+#     -v --version VERSION      The version to bump to [1.1.1|major|minor|patch|pre|rc|release]
+#        --no-commit            Bump the version, but do not commit
+#     -h --help                 Get help on this command
+
+cmds = [
+  Cl.new($0).run(%w(bump -v 1.1.1)),
+  Cl.new($0).run(%w(release foo.gemspec -h host -k key -q))
+]
+
+puts "Commands run:\n\n"
+puts cmds.map { |cmd, args, opts| "  cmd #{cmd} has run with:\n\n    args=#{args}\n    opts=#{opts}\n\n" }
+
+# Commands run:
+#
+#   cmd bump has run with:
+#
+#     args=[]
+#     opts={:version=>"1.1.1"}
+#
+#   cmd release has run with:
+#
+#     args=["foo.gemspec"]
+#     opts={:host=>"host", :key=>"key", :quiet=>true}

data/examples/heroku

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+require 'cl'
+
+module Heroku
+  module Apps
+    class Create < Cl::Cmd
+      register 'apps:create'
+
+      arg :name, required: true
+
+      opt '-o', '--org ORG'
+
+      def run; [registry_key, args, opts] end
+    end
+
+    class List < Cl::Cmd
+      register 'apps:info'
+
+      opt '-a', '--app APP'
+
+      def run; [registry_key, args, opts] end
+    end
+  end
+end
+
+def output(cmd, args, opts)
+  puts "Called #{cmd} with args=#{args} opts=#{opts}\n\n"
+end
+
+output *Cl.new($0).run(%w(apps:create name -o org))
+
+# Output:
+#
+#   Called apps:create with args=["name"] opts={:org=>"org"}
+
+output *Cl.new($0).run(%w(apps create name -o org))
+
+# Output:
+#
+#   Called apps:create with args=["name"] opts={:org=>"org"}
+
+output *Cl.new($0).run(%w(apps:info -a app))
+
+# Output:
+#
+#   Called apps:create with args=["app"] opts={}
+

data/examples/{multi.rb → rakeish}

@@ -1,3 +1,6 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
 require 'cl'
 
 module Rakeish
@@ -15,9 +18,7 @@ module Rakeish
 
       arg :name
 
-      opt '-f', '--force' do
-        opts[:force] = true
-      end
+      opt '-f', '--force'
 
       def run; [registry_key, args, opts] end
     end
@@ -27,9 +28,7 @@ module Rakeish
 
       arg :name
 
-      opt '-v', '--version VERSION' do |value|
-        opts[:version] = value
-      end
+      opt '-v', '--version VERSION'
 
       def run; [registry_key, args, opts] end
     end
@@ -40,11 +39,14 @@ def output(result)
   result.each do |cmd, args, opts|
     puts "Called #{cmd} with args=#{args} opts=#{opts}"
   end
+  puts
 end
 
-Cl.runner = :multi
-output Cl.run(*%w(db:drop production -f db:create db:migrate production -v 1))
+argv = %w(db:drop production -f db:create db:migrate production -v 1)
+output Cl.new($0, runner: :multi).run(argv)
+
 # Output:
-# Called db:drop with args=["production"] opts={:force=>true}
-# Called db:create with args=[] opts={}
-# Called db:migrate with args=["production"] opts={:version=>"1"}
+#
+#   Called db:drop with args=["production"] opts={:force=>true}
+#   Called db:create with args=[] opts={}
+#   Called db:migrate with args=["production"] opts={:version=>"1"}

data/lib/cl/arg.rb

@@ -1,7 +1,8 @@
-module Cl
+require 'cl/cast'
+
+class Cl
   class Arg < Struct.new(:name, :opts)
-    TRUE  = /^(true|yes|on)$/
-    FALSE = /^(false|no|off)$/
+    include Cast
 
     def define(const)
       const.send(:attr_accessor, name)
@@ -12,7 +13,11 @@ module Cl
     end
 
     def type
-      opts[:type] || :str
+      opts[:type] || :string
+    end
+
+    def description
+      opts[:description]
     end
 
     def splat?
@@ -23,36 +28,13 @@ module Cl
       !!opts[:required]
     end
 
-    def cast(value)
-      case type
-      when nil
-        value
-      when :array
-        Array(value).flatten.map { |value| value.split(',') }.flatten
-      when :string, :str
-        value.to_s
-      when :boolean, :bool
-        return true  if value.to_s =~ TRUE
-        return false if value.to_s =~ FALSE
-        !!value
-      when :integer, :int
-        Integer(value)
-      when :float
-        Float(value)
-      else
-        raise ArgumentError, "Unknown type: #{type}" if value
-      end
-    rescue ::ArgumentError => e
-      raise ArgumentError.new(:wrong_type, value.inspect, type)
-    end
-
     def to_s
       str = name
       case type
       when :array          then str = "#{str}.."
-      when :integer, :int  then str = "#{str} (int)"
-      when :boolean, :bool then str = "#{str} (bool)"
-      when :float          then str = "#{str} (float)"
+      when :integer, :int  then str = "#{str}:int"
+      when :boolean, :bool then str = "#{str}:bool"
+      when :float          then str = "#{str}:float"
       end
       required? ? str : "[#{str}]"
     end

data/lib/cl/args.rb

@@ -1,13 +1,16 @@
 require 'cl/arg'
 
-module Cl
+class Cl
   class Args
     include Enumerable
 
-    def define(const, name, opts = {})
+    def define(const, name, *args)
+      opts = args.last.is_a?(Hash) ? args.pop.dup : {}
+      opts[:description] = args.shift if args.any?
+
       arg = Arg.new(name, opts)
       arg.define(const)
-      args << arg
+      self.args << arg
     end
 
     def apply(cmd, args)
@@ -41,11 +44,11 @@ module Cl
       end
 
       def splat?
-        args.any?(&:splat?)
+        any?(&:splat?)
       end
 
       def required
-        args.select { |arg| arg.required? }.size
+        select(&:required?).size
       end
 
       def grouped(values)