cl 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f86887c16aed295c0207a4c5005decf8fd1cc05
+  data.tar.gz: 12260c6e0abc90a6b2df31fd3ce1797189953539
+SHA512:
+  metadata.gz: b4277518e42daa3e8f19bf612ffdae68c6244e28a043915e1842fdc28b200493e5fbe41f821b2040443f861e7e8cafae0d705b08d592b7cfd2dcc51cc719a73e
+  data.tar.gz: 54a224126510e271f4847ffc6a089cb130af5ac00e0c50c8d001e1d183f8c5d2ebd8c3dd48b56742764503c7379ef4bf06333994d195b4f82496c81d956e475e

data/Gemfile

@@ -0,0 +1,3 @@
+group :test do
+  gem 'rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,25 @@
+GEM
+  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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+
+BUNDLED WITH
+   1.14.5

data/MIT_LICENSE.md

@@ -0,0 +1,21 @@
+# MIT LICENSE
+
+Copyright (c) 2017  Sven Fuchs <me@svenfuchs.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,23 @@
+# CLI
+
+This library wraps Ruby's `OptionParser` in order to make it easier to use it in an object oriented context.
+
+## Usage
+
+```
+module Owners
+  class Add < Struct.new(:args, :opts)
+    include Cli::Cmd
+
+    register 'owners:add'
+
+    purpose 'Add one or more owners to an existing owner group'
+
+    args :owners
+
+    on '-t', '--to TO', 'An owner in an existing group' do |value|
+      opts[:to] = value
+    end
+  end
+end
+```

data/lib/cli.rb

@@ -0,0 +1,19 @@
+require 'cli/cmd'
+require 'cli/help'
+require 'cli/runner'
+
+module Cli
+  def included(const)
+    const.send(:include, Cmd)
+  end
+
+  def run(*args)
+    Runner.new(*args).run
+  end
+
+  def help
+    Runner.new(:help).run
+  end
+
+  extend self
+end

data/lib/cli/cmd.rb

@@ -0,0 +1,28 @@
+require 'cli/registry'
+
+module Cli
+  module Cmd
+    def self.included(const)
+      const.send :include, Registry
+      const.send :extend, ClassMethods
+    end
+
+    module ClassMethods
+      def args(*args)
+        args.any? ? @args = args : @args ||= []
+      end
+
+      def purpose(purpose = nil)
+        purpose ? @purpose = purpose : @purpose
+      end
+
+      def on(*args, &block)
+        opts << [args, block]
+      end
+
+      def opts
+        @opts ||= superclass.respond_to?(:opts) ? superclass.opts : []
+      end
+    end
+  end
+end

data/lib/cli/cmds.rb

@@ -0,0 +1,28 @@
+require 'cli/options'
+
+module Cli
+  class Cmds < Struct.new(:args)
+    def lookup
+      cmd || abort("Unknown command: #{args.join(' ')}")
+      opts = Options.new(cmd.opts, args).opts
+      [cmd, args - cmds, opts]
+    end
+
+    private
+
+      def cmds
+        name = cmd.registry_key.to_s
+        args.take_while do |arg|
+          name = name.sub(/#{arg}(:|$)/, '') if name =~ /#{arg}(:|$)/
+        end
+      end
+
+      def cmd
+        @cmd ||= keys.map { |key| Cli[key] }.compact.last
+      end
+
+      def keys
+        @keys ||= args.inject([]) { |keys, key| keys << [keys.last, key].compact.join(':') }
+      end
+  end
+end

data/lib/cli/format/cmd.rb

@@ -0,0 +1,31 @@
+require 'cli/format/table'
+require 'cli/format/usage'
+
+module Cli
+  class Format
+    class Cmd < Struct.new(:cmd)
+      def format
+        [banner, Table.new(opts).format].join("\n")
+      end
+
+      def banner
+        banner = []
+        banner << "#{cmd.purpose}\n" if cmd.purpose
+        banner << "Usage: #{Usage.new(cmd).format}\n"
+        banner
+      end
+
+      def opts
+        cmd.opts.map do |opts, block|
+          comment = opts.detect { |opt| !opt?(opt) }
+          opts = opts.select { |opt| opt?(opt) }
+          [opts.sort_by(&:size).join(' '), comment]
+        end
+      end
+
+      def opt?(str)
+        str.start_with?('-')
+      end
+    end
+  end
+end

data/lib/cli/format/list.rb

@@ -0,0 +1,22 @@
+require 'cli/format/table'
+require 'cli/format/usage'
+
+module Cli
+  class Format
+    class List < Struct.new(:cmds)
+      HEAD = %(Type "#{$0} help COMMAND [SUBCOMMAND]" for more details:\n)
+
+      def format
+        [HEAD, Format::Table.new(list).format].join("\n")
+      end
+
+      def list
+        cmds.map { |cmd| format_cmd(cmd) }
+      end
+
+      def format_cmd(cmd)
+        ["#{$0} #{Usage.new(cmd).format}", cmd.purpose]
+      end
+    end
+  end
+end

data/lib/cli/format/table.rb

@@ -0,0 +1,19 @@
+module Cli
+  class Format
+    class Table < Struct.new(:data, :separator)
+      def format
+        rows.join("\n")
+      end
+
+      def rows
+        rows = data.map { |lft, rgt| [lft.ljust(width), rgt] }
+        rows = rows.map { |lft, rgt| "#{lft} #{"# #{rgt}" if rgt}".strip }
+        rows.map(&:strip)
+      end
+
+      def width
+        @width ||= data.map(&:first).max_by(&:size).size
+      end
+    end
+  end
+end

data/lib/cli/format/usage.rb

@@ -0,0 +1,20 @@
+module Cli
+  class Format
+    class Usage < Struct.new(:cmd)
+      def format
+        usage = [name]
+        usage += cmd.args.map { |arg| "[#{arg}]" }
+        usage << '[options]' if opts?
+        usage.join(' ')
+      end
+
+      def name
+        cmd.registry_key.to_s.gsub(':', ' ')
+      end
+
+      def opts?
+        cmd.opts.any?
+      end
+    end
+  end
+end

data/lib/cli/help.rb

@@ -0,0 +1,31 @@
+require 'cli/format/cmd'
+require 'cli/format/list'
+
+module Cli
+  class Help < Struct.new(:args, :opts)
+    include Cli::Cmd
+
+    register :help
+
+    def run
+      puts help
+    end
+
+    def help
+      cmd ? Format::Cmd.new(cmd).format : Format::List.new(cmds).format
+    end
+
+    private
+
+      def cmds
+        cmds = Cli.cmds.reject { |cmd| cmd.registry_key == :help }
+        key  = args.join(':') if args
+        cmds = cmds.select { |cmd| cmd.registry_key.to_s.start_with?(key) } if key
+        cmds
+      end
+
+      def cmd
+        args && Cli[args.join(':')]
+      end
+  end
+end

data/lib/cli/options.rb

@@ -0,0 +1,11 @@
+module Cli
+  class Options < OptionParser
+    attr_reader :opts
+
+    def initialize(opts, args)
+      @opts = {}
+      super { opts.each { |args, block| on(*args) { |*args| instance_exec(*args, &block) } } }
+      parse!(args)
+    end
+  end
+end

data/lib/cli/registry.rb

@@ -0,0 +1,53 @@
+module Cli
+  class << self
+    def []=(key, object)
+      registry[key.to_sym] = object
+    end
+
+    def [](key)
+      key && registry[key.to_sym]
+    end
+
+    def cmds
+      registry.values
+    end
+
+    def registry
+      @registry ||= {}
+    end
+  end
+
+  module Registry
+    class << self
+      def included(const)
+        const.send(:extend, ClassMethods)
+        const.send(:include, InstanceMethods)
+      end
+    end
+
+    module ClassMethods
+      attr_reader :registry_key
+
+      def [](key)
+        Cli[key.to_sym]
+      end
+
+      def register(key)
+        Cli[key] = self
+        @registry_key = key.to_sym
+      end
+
+      def underscore(string)
+        string.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        downcase
+      end
+    end
+
+    module InstanceMethods
+      def registry_key
+        self.class.registry_key
+      end
+    end
+  end
+end

data/lib/cli/runner.rb

@@ -0,0 +1,20 @@
+require 'cli/cmds'
+
+module Cli
+  class Runner
+    attr_reader :const, :args, :opts
+
+    def initialize(*args)
+      args = args.flatten.map(&:to_s)
+      @const, @args, @opts = Cmds.new(args).lookup
+    end
+
+    def run
+      cmd.run
+    end
+
+    def cmd
+      const.new(args, opts)
+    end
+  end
+end

data/lib/cli/version.rb

@@ -0,0 +1,3 @@
+module Cli
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: cl
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sven Fuchs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-09 00:00:00.000000000 Z
+dependencies: []
+description: OptionParser based CLI support.
+email: me@svenfuchs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- MIT_LICENSE.md
+- README.md
+- lib/cli.rb
+- lib/cli/cmd.rb
+- lib/cli/cmds.rb
+- lib/cli/format/cmd.rb
+- lib/cli/format/list.rb
+- lib/cli/format/table.rb
+- lib/cli/format/usage.rb
+- lib/cli/help.rb
+- lib/cli/options.rb
+- lib/cli/registry.rb
+- lib/cli/runner.rb
+- lib/cli/version.rb
+homepage: https://github.com/svenfuchs/cl
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: OptionParser based CLI support
+test_files: []