cl 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f989a757e92bffbfc45652517bbec98cc8cdd09b9aa6809e4822c807de4c3cd
-  data.tar.gz: e315d830caf5e61f236d962d83d25c4a3e45c04e6672189a8358ad04c7007e2c
+  metadata.gz: 531d9fab776f1d706d8c86d087528b1a889f3511197ae5cad48d8c75a6a8aa1d
+  data.tar.gz: f1090e76ddfa1d0cec7a3b054b140eb6d56934ba34db6dfb7deb230eabc26f12
 SHA512:
-  metadata.gz: d9ad4c4d902a66dbe56581053ca7babeca533a65af31d22ff815f17f9f2a386fa238fe9686af776a0df510d7cd1a6696fd32b3fc3061d9cda00f22130bcb520a
-  data.tar.gz: 4554e81d0a53997506257670514195e1df150c8d8fe51e35bb956e40e7216d211139ae98403d9c25d05fbc66feff35eaec31471252e78a5555ff88aa2644f947
+  metadata.gz: 5aa9ba9d3938ac7ca67e138e3f265f3d15ec1e0aad66f7102fe3c2ac1577be3edd2565d1edec045d79d420d5d62e7c833f3fb1e130d410684a441e7c7b44f992
+  data.tar.gz: 82c15f26babdf980a89436e215837e2a54f161a32657764318657a3c45ec8ce60786f2e51973add04011546aae3aedbd4964e5d025450e705aa9d3a513cf8c91

data/CHANGELOG.md

@@ -6,7 +6,7 @@
 
 * 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 `required :one, [:two, :three]` (DNF, i.e: either :one or both :two and :three must be given)
+* Add `required :one, [:two, :three]` (DNF, i.e: either `:one` or both `:two` and `:three` must be given)
 * Add `opt '--one STR', 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

data/NOTES.md

@@ -4,4 +4,6 @@
 
 - refactor Help::Cmd and Table so that everything goes into one big table
 
-- wrap long lines in help output
+- add args descriptions
+
+

data/README.md

@@ -1,22 +1,58 @@
 # CL [![Build Status](https://travis-ci.org/svenfuchs/cl.svg?branch=master)](https://travis-ci.org/svenfuchs/cl)
 
-This library wraps Ruby's `OptionParser` in order to make it easier to use it in an object oriented context.
+This library wraps Ruby's `OptionParser` in order to make it easier to use it
+in an object oriented context.
 
-## Usage
+It uses `OptionParser` for parsing your options, so you get all the goodness that
+this true gem from Ruby's stoneage provides. But on top of that it also provides
+a rich DSL for defining, validating, and normalizing options, and automatic and
+gorgeous help output (modelled after Rubygem's `gem --help` output).
+
+## Basic Usage
 
 ```ruby
 module Owners
-  class Add < Cli::Cmd
+  class Add < Cl::Cmd
+    summary 'Add one or more owners to an existing owner group'
 
-    register 'owners:add'
+    description <<~str
+      Use this command to add one or more owners to an existing
+      owner group.
 
-    purpose 'Add one or more owners to an existing owner group'
+      These will be visible in [...]
+    str
 
     args :owners
 
-    opt '-t', '--to TO', 'An owner in an existing group' do |value|
+    opt '-t', '--to TO', 'An existing owner group' do |value|
       opts[:to] = value
     end
   end
 end
 ```
+
+Help output:
+
+```txt
+Usage: owners add [owners] [options]
+
+Arguments:
+
+  owners          type: string
+
+Options:
+
+  -t --to TO      An existing owner group (type: string, required: true)
+     --help       Get help on this command (type: flag)
+
+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.
+
+  These will be visible in [...]
+```

data/examples/owners

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('lib')
+
+# Example from the README
+
+require 'cl'
+
+module Owners
+  class Add < Cl::Cmd
+
+    register 'owners: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.
+
+      These will be visible in [...]
+    str
+
+    args :owners #, 'Comma separated list of owner login names who are to be added to the owner group'
+
+    opt '-t', '--to TO', 'An existing owner group', required: true
+  end
+end
+
+Cl.new($0).run(%w(add --help))

data/lib/cl/help/cmd.rb

@@ -4,6 +4,8 @@ require 'cl/help/usage'
 class Cl
   class Help
     class Cmd
+      include Regex
+
       attr_reader :cmd
 
       def initialize(cmd)
@@ -100,7 +102,7 @@ class Cl
         opts << "alias: #{format_aliases(opt)}" if opt.aliases?
         opts << "requires: #{opt.requires.join(', ')}" if opt.requires?
         opts << "default: #{format_default(opt)}" if opt.default?
-        opts << "known values: #{opt.enum.join(', ')}" if opt.enum?
+        opts << "known values: #{format_enum(opt)}" if opt.enum?
         opts << "format: #{opt.format}" if opt.format?
         opts << "downcase: true" if opt.downcase?
         opts << "max: #{opt.max}" if opt.max?
@@ -118,6 +120,9 @@ class Cl
         end.join(', ')
       end
 
+      def format_enum(opt)
+        opt.enum.map { |value| format_regex(value) }.join(', ')
+      end
 
       def format_type(obj)
         return obj.type unless obj.is_a?(Opt) && obj.type == :array

data/lib/cl/version.rb

@@ -1,3 +1,3 @@
 class Cl
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cl
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Sven Fuchs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-12 00:00:00.000000000 Z
+date: 2019-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: regstry
@@ -42,6 +42,7 @@ files:
 - examples/args/splat
 - examples/gem
 - examples/heroku
+- examples/owners
 - examples/rakeish
 - lib/cl.rb
 - lib/cl/arg.rb