travis-cl 1.2.4

data/lib/cl/runner/multi.rb

@@ -0,0 +1,34 @@
+class Cl
+  module Runner
+    class Multi
+      Runner.register :multi, self
+
+      attr_reader :ctx, :cmds
+
+      def initialize(ctx, *args)
+        @ctx = ctx
+        @cmds = build(group(args))
+      end
+
+      def run
+        cmds.map(&:run)
+      end
+
+      private
+
+        def group(args, cmds = [])
+          args.flatten.map(&:to_s).inject([[]]) do |cmds, arg|
+            cmd = Cmd.registered?(arg) ? Cmd[arg] : nil
+            cmd ? cmds << [cmd] : cmds.last << arg
+            cmds.reject(&:empty?)
+          end
+        end
+
+        def build(cmds)
+          cmds.map do |(cmd, *args)|
+            cmd.new(ctx, args)
+          end
+        end
+    end
+  end
+end

data/lib/cl/runner.rb

@@ -0,0 +1,10 @@
+require 'registry'
+
+class Cl
+  module Runner
+    include Registry
+  end
+end
+
+require 'cl/runner/default'
+require 'cl/runner/multi'

data/lib/cl/ui.rb

@@ -0,0 +1,146 @@
+require 'stringio'
+
+class Cl
+  module Ui
+    def self.new(ctx, opts)
+      const = Test if ctx.test?
+      const ||= Silent if opts[:silent]
+      const ||= Tty # if $stdout.tty?
+      # const ||= Pipe
+      const.new(opts)
+    end
+
+    class Base < Struct.new(:opts)
+      attr_writer :stdout
+
+      def stdout
+        @stdout ||= opts[:stdout] || $stdout
+      end
+
+      def puts(*strs)
+        stdout.puts(*strs)
+      end
+
+      def abort(error, *strs)
+        self.error [error.message, *strs].join("\n\n")
+        exit 1
+      end
+    end
+
+    class Silent < Base
+      %i(announce info notice warn error success cmd).each do |name|
+        define_method (name) { |*| }
+      end
+    end
+
+    class Test < Base
+      %i(announce info notice warn error success cmd).each do |name|
+        define_method (name) do |*args|
+          puts ["[#{name}]", *args.map(&:inspect)].join(' ')
+        end
+      end
+
+      def stdout
+        @stdout ||= StringIO.new
+      end
+
+      def abort(error, *strs)
+        raise error
+      end
+    end
+
+    class Pipe < Base
+      %i(announce info notice warn error).each do |name|
+        define_method (name) do |msg, args = nil, _ = nil|
+          puts format_msg(msg, args)
+        end
+      end
+
+      %i(success cmd).each do |name|
+        define_method (name) { |*| }
+      end
+
+      private
+
+        def format_msg(msg, args)
+          msg = [msg, args].flatten.map(&:to_s)
+          msg = msg.map { |str| quote_spaced(str) }
+          msg.join(' ').strip
+        end
+
+        def quote_spaced(str)
+          str.include?(' ') ? %("#{str}") : str
+        end
+    end
+
+    module Colors
+      COLORS = {
+        red:    "\e[31m",
+        green:  "\e[32m",
+        yellow: "\e[33m",
+        blue:   "\e[34m",
+        gray:   "\e[37m",
+        reset:  "\e[0m"
+      }
+
+      def colored(color, str)
+        [COLORS[color], str, COLORS[:reset]].join
+      end
+    end
+
+    class Tty < Base
+      include Colors
+
+      def announce(msg, args = [], msgs = [])
+        msg = format_msg(msg, args, msgs)
+        puts colored(:green, with_spacing(msg, true))
+      end
+
+      def info(msg, args = [], msgs = [])
+        msg = format_msg(msg, args, msgs)
+        puts colored(:blue, with_spacing(msg, true))
+      end
+
+      def notice(msg, args = [], msgs = [])
+        msg = format_msg(msg, args, msgs)
+        puts colored(:gray, with_spacing(msg, false))
+      end
+
+      def warn(msg, args = [], msgs = [])
+        msg = format_msg(msg, args, msgs)
+        puts colored(:yellow, with_spacing(msg, false))
+      end
+
+      def error(msg, args = [], msgs = [])
+        msg = format_msg(msg, args, msgs)
+        puts colored(:red, with_spacing(msg, true))
+      end
+
+      def success(msg)
+        announce(msg)
+        puts
+      end
+
+      def cmd(msg)
+        notice("$ #{msg}")
+      end
+
+      private
+
+        def colored(color, str)
+          opts[:color] ? super : str
+        end
+
+        def format_msg(msg, args, msgs)
+          msg = msgs[msg] % args if msg.is_a?(Symbol)
+          msg.strip
+        end
+
+        def with_spacing(str, space)
+          str = "\n#{str}" if space && !@last
+          @last = space
+          str
+        end
+    end
+  end
+end

data/lib/cl/version.rb

@@ -0,0 +1,3 @@
+class Cl
+  VERSION = '1.2.4'
+end

data/lib/cl.rb

@@ -0,0 +1,62 @@
+require 'cl/cmd'
+require 'cl/help'
+require 'cl/runner'
+require 'cl/errors'
+
+class Cl
+  singleton_class.send(:attr_accessor, :flag_values)   # remove unless Dpl needs this
+
+  attr_reader :ctx, :name, :opts
+
+  # @overload initialize(ctx, name, opts)
+  #   @param ctx  [Cl::Ctx] the current execution context (optional)
+  #   @param name [String] the program (executable) name (optional, defaults to the last segment of $0)
+  #   @param opts [Hash] options (optional)
+  #   @option opts [Cl::Runner] :runner registry key for a runner (optional, defaults to :default)
+  #   @option opts [Cl::Ui] :ui the ui for handling user interaction
+  def initialize(*args)
+    ctx   = args.shift if args.first.is_a?(Ctx)
+    @opts = args.last.is_a?(Hash) ? args.pop : {}
+    @name = args.shift || $0.split('/').last
+    @ctx  = ctx || Ctx.new(name, opts)
+  end
+
+  # Runs the command.
+  #
+  # Instantiates a runner with the given arguments, and runs it.
+  #
+  # If the command fails (raises a Cl::Error) then the exception is caught, and
+  # the process aborted with the error message and help output for the given
+  # command.
+  #
+  # @param args [Array<String>] arguments (usually ARGV)
+  def run(args)
+    runner(args).run
+  rescue UnknownCmd => e
+    ctx.abort e
+  rescue Error => e
+    ctx.abort e, help(args.first)
+  end
+
+  # Returns a runner instance for the given arguments.
+  def runner(args)
+    runner = :default if args.first.to_s == 'help'
+    runner ||= opts[:runner] || :default
+    Runner[runner].new(ctx, args)
+  end
+
+  # Returns help output for the given command
+  def help(*args)
+    runner(['help', *args]).cmd.help
+  rescue StandardError
+  end
+
+  private
+
+  # Tainting is being used for identifying values on options that have
+  # been declared as secret. Ruby taints incoming arguments, so we want to
+  # untaint them here.
+  def untaint(args)
+    args.map(&:dup)
+  end
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: travis-cl
+version: !ruby/object:Gem::Version
+  version: 1.2.4
+platform: ruby
+authors:
+- Sven Fuchs
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: regstry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: |-
+  OptionParser based CLI support for rapid CLI development in an object-oriented
+  context.
+
+  This library wraps Ruby's OptionParser for parsing your options under the hood,
+  so you get all the goodness that the Ruby standard library provides.
+
+  On top of that it adds a rich and powerful DSL for defining, validating, and
+  normalizing options, as well as automatic and gorgeous help output (modeled
+  after `gem --help`).
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- MIT_LICENSE.md
+- README.md
+- cl.gemspec
+- examples/README.md
+- examples/_src/args/cast.erb.rb
+- examples/_src/args/opts.erb.rb
+- examples/_src/args/required.erb.rb
+- examples/_src/args/splat.erb.rb
+- examples/_src/gem.erb.rb
+- examples/_src/heroku.erb.rb
+- examples/_src/rakeish.erb.rb
+- examples/_src/readme/abstract.erb.rb
+- examples/_src/readme/alias.erb.rb
+- examples/_src/readme/arg.erb.rb
+- examples/_src/readme/arg_array.erb.rb
+- examples/_src/readme/arg_type.erb.rb
+- examples/_src/readme/args_splat.erb.rb
+- examples/_src/readme/array.erb.rb
+- examples/_src/readme/basic.erb.rb
+- examples/_src/readme/default.erb.rb
+- examples/_src/readme/deprecated.erb.rb
+- examples/_src/readme/deprecated_alias.erb.rb
+- examples/_src/readme/description.erb.rb
+- examples/_src/readme/downcase.erb.rb
+- examples/_src/readme/enum.erb.rb
+- examples/_src/readme/example.erb.rb
+- examples/_src/readme/format.erb.rb
+- examples/_src/readme/internal.erb.rb
+- examples/_src/readme/negate.erb.rb
+- examples/_src/readme/note.erb.rb
+- examples/_src/readme/opts.erb.rb
+- examples/_src/readme/opts_block.erb.rb
+- examples/_src/readme/range.erb.rb
+- examples/_src/readme/registry.erb.rb
+- examples/_src/readme/required.erb.rb
+- examples/_src/readme/requireds.erb.rb
+- examples/_src/readme/requires.erb.rb
+- examples/_src/readme/runner.erb.rb
+- examples/_src/readme/runner_custom.erb.rb
+- examples/_src/readme/secret.erb.rb
+- examples/_src/readme/see.erb.rb
+- examples/_src/readme/type.erb.rb
+- examples/args/cast
+- examples/args/opts
+- examples/args/required
+- examples/args/splat
+- examples/gem
+- examples/heroku
+- examples/rakeish
+- examples/readme/abstract
+- examples/readme/alias
+- examples/readme/arg
+- examples/readme/arg_array
+- examples/readme/arg_type
+- examples/readme/args_splat
+- examples/readme/array
+- examples/readme/basic
+- examples/readme/default
+- examples/readme/deprecated
+- examples/readme/deprecated_alias
+- examples/readme/description
+- examples/readme/downcase
+- examples/readme/enum
+- examples/readme/example
+- examples/readme/format
+- examples/readme/internal
+- examples/readme/negate
+- examples/readme/note
+- examples/readme/opts
+- examples/readme/opts_block
+- examples/readme/range
+- examples/readme/registry
+- examples/readme/required
+- examples/readme/requireds
+- examples/readme/requires
+- examples/readme/runner
+- examples/readme/runner_custom
+- examples/readme/secret
+- examples/readme/see
+- examples/readme/type
+- lib/cl.rb
+- lib/cl/arg.rb
+- lib/cl/args.rb
+- lib/cl/cast.rb
+- lib/cl/cmd.rb
+- lib/cl/config.rb
+- lib/cl/config/env.rb
+- lib/cl/config/files.rb
+- lib/cl/ctx.rb
+- lib/cl/dsl.rb
+- lib/cl/errors.rb
+- lib/cl/help.rb
+- lib/cl/help/cmd.rb
+- lib/cl/help/cmds.rb
+- lib/cl/help/format.rb
+- lib/cl/help/table.rb
+- lib/cl/help/usage.rb
+- lib/cl/helper.rb
+- lib/cl/helper/suggest.rb
+- lib/cl/opt.rb
+- lib/cl/opts.rb
+- lib/cl/opts/validate.rb
+- lib/cl/parser.rb
+- lib/cl/parser/format.rb
+- lib/cl/runner.rb
+- lib/cl/runner/default.rb
+- lib/cl/runner/multi.rb
+- lib/cl/ui.rb
+- lib/cl/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: []
+rubygems_version: 3.4.21
+signing_key:
+specification_version: 4
+summary: Object-oriented OptionParser based CLI support
+test_files: []