mister_bin 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 513b43b53f6ec698926a9ab1238141b687b2e26b6fc874bac1573445b56b6d16
-  data.tar.gz: 8b7b49dc14d2a87675f9956e8b3307fe7b16a9e32b815f07f2fb1383466c29a0
+  metadata.gz: ddbb5dc8eedf74546e9ef64f0350f8d8c66dd54e3178add8b7a5df40f92661ed
+  data.tar.gz: 785e3517267fa3d36d54fe0fab06eecb0b35067c11fed79a05183fd3352783ee
 SHA512:
-  metadata.gz: 18acd89e58ee2fb9c57b60328233299cb28271f97f29624b94146f3112d55235af278631ca256e1557e6796c3662e82198f6907e67c70e00a83fb86776fba515
-  data.tar.gz: 666fdc19987cc2a0eeb2859325b25f6dd5cc90c5e62a309a1af958fda2991567dce62301a7c97d6a62f745e2b201acb363e12ec8e8726feba18b84baccbd85cb
+  metadata.gz: 698068f7f0fe7b8105d07e13ac6758f955ae16450fe27162bef782852dc1cbdfcce77bcd15ff9b3df5d9d1872c5d661773167e88af9c7adb3064650d658960c6
+  data.tar.gz: 79d047bb38ca948ad5b548eb641f26e50b95064fbae0abb9d51fc7841d1a53538f15b770820d4bfa5bc725d6a7d581a42c64937f10cb6744fbfa3d49b29c37ff

data/README.md

@@ -2,7 +2,7 @@ Mister Bin
 ==================================================
 
 [![Gem Version](https://badge.fury.io/rb/mister_bin.svg)](https://badge.fury.io/rb/mister_bin)
-[![Build Status](https://travis-ci.com/DannyBen/mister_bin.svg?branch=master)](https://travis-ci.com/DannyBen/mister_bin)
+[![Build Status](https://github.com/DannyBen/mister_bin/workflows/Test/badge.svg)](https://github.com/DannyBen/mister_bin/actions?query=workflow%3ATest)
 [![Maintainability](https://api.codeclimate.com/v1/badges/ae82443a99c2839d8ba8/maintainability)](https://codeclimate.com/github/DannyBen/mister_bin/maintainability)
 
 ---
@@ -69,7 +69,7 @@ Creating a command line utility with Mister Bin involves at least two files:
 2. One or more subcommand files. These files use the DSL, and will usually be
    placed in your `lib/<your gem>/commands` folder.
 
-WHen executing the commands, you can use only the first letters of the 
+When executing the commands, you can use only the first letters of the 
 command name. Mister Bin will search for the command that starts with your 
 input, and if it finds one and one only, it will execute it. For example, 
 if you have a `server` command, you can execute it with `yourapp s` if it
@@ -195,7 +195,7 @@ These classes can use any of the below DSL commands, and must define a
 
 ### Command DSL
 
-The DSL is designed to create a [docopt][1] document. Most commands are 
+The DSL is designed to create a [docopt] document. Most commands are 
 optional.
 
 The below example outlines all available DSL commands.
@@ -244,7 +244,7 @@ example "app ls --all"
 
 Interactive Terminal
 --------------------------------------------------
-Mister Bin comes with an interactive terminal thaht allows you to set up a
+Mister Bin comes with an interactive terminal that allows you to set up a
 console that sends all commands to your runner.
 
 ![Demo](https://raw.githubusercontent.com/DannyBen/mister_bin/master/demo/terminal.gif)
@@ -297,7 +297,7 @@ end
 ```
 
 These are the available options. All string options are displayed with 
-the [Colsole][5] `say` command so they support color markers.
+the [Colsole] `say` command so they support color markers.
 
 #### `header`
 
@@ -346,18 +346,21 @@ In the Wild
 Several examples of real world use of Mister Bin in the wild (well, 
 "In the Back Yard" really...).
 
-- [AudioAddict][4] - Command line utility for the AudioAddict radio network
-- [Madman][3] - The Markdown Swiss Army Knife
-- [Kojo][2] - Command line utility for generating config files from templates 
-  and definition files
-- [Jobly][6] - Compact job server with API, CLI and Web UI
-- [Slacktail][7] - Command line utility for following your Slack chat from the terminal
-
-
-[1]: http://docopt.org/
-[2]: https://github.com/DannyBen/kojo
-[3]: https://github.com/DannyBen/madman
-[4]: https://github.com/DannyBen/audio_addict
-[5]: https://github.com/dannyben/colsole
-[6]: https://github.com/dannyben/jobly
-[7]: https://github.com/dannyben/slacktail
+- [AudioAddict] - Command line utility for the AudioAddict radio network
+- [Bashly] - Bash command line framework and CLI Generator
+- [Jobly] - Compact job server with API, CLI and Web UI
+- [Kojo] - Command line utility for generating config files from templates and definition files
+- [Madman] - The Markdown Swiss Army Knife
+- [Slacktail] - Command line utility for following your Slack chat from the terminal
+- [Site Link Analyzer] - Command line utility for finding broken links in a site
+
+
+[docopt]: http://docopt.org/
+[Kojo]: https://github.com/DannyBen/kojo
+[Madman]: https://github.com/DannyBen/madman
+[AudioAddict]: https://github.com/DannyBen/audio_addict
+[Colsole]: https://github.com/dannyben/colsole
+[Jobly]: https://github.com/dannyben/jobly
+[Slacktail]: https://github.com/dannyben/slacktail
+[Site Link Analyzer]: https://github.com/dannyben/sla
+[Bashly]: https://github.com/DannyBen/bashly

data/lib/mister_bin/command.rb

@@ -7,21 +7,19 @@ module MisterBin
 
     attr_reader :args
 
-    def initialize(args = nil)
-      @args = args
+    def execute(argv = [])
+      @args = Docopt.docopt self.class.docopt, version: self.class.meta.version, argv: argv
+      target = self.class.find_target_command self, args
+      exitcode = send target
+      exitcode.is_a?(Numeric) ? exitcode : 0
+    rescue Docopt::Exit => e
+      puts e.message
+      1
     end
 
     class << self
-      def execute(argv=[])
-        args = Docopt.docopt docopt, version: meta.version, argv: argv
-        instance = new args
-        target = find_target_command instance, args
-        exitcode = instance.send target
-        exitcode.is_a?(Numeric) ? exitcode : 0
-
-      rescue Docopt::Exit => e
-        puts e.message
-        1
+      def execute(argv = [])
+        new.execute argv
       end
 
       # DSL
@@ -67,14 +65,10 @@ module MisterBin
         @meta ||= CommandMeta.new
       end
 
-    protected
-
       def docopt
         meta.docopt
       end
 
-    private
-
       def target_commands
         @target_commands ||= []
       end
@@ -82,11 +76,10 @@ module MisterBin
       def find_target_command(instance, args)
         target_commands.each do |target|
           method_name = :"#{target}_command"
-          return method_name if instance.respond_to? method_name and args[target.to_s]
+          return method_name if instance.respond_to?(method_name) && args[target.to_s]
         end
         :run
       end
-
     end
   end
 end

data/lib/mister_bin/command_meta.rb

@@ -1,9 +1,8 @@
 require 'colsole'
 
 module MisterBin
-
   # This class is responsible for holding all the meta data for a command and
-  # for generating a text string ready to be used by Docopt. 
+  # for generating a text string ready to be used by Docopt.
   class CommandMeta
     include Colsole
 
@@ -23,8 +22,10 @@ module MisterBin
     end
 
     def docopt
-      [summary_string, help_string, usage_string, commands_string,
-        options_string, params_string, env_string, examples_string].compact.join "\n"
+      [
+        summary_string, help_string, usage_string, commands_string,
+        options_string, params_string, env_string, examples_string
+      ].compact.join "\n"
     end
 
     def description
@@ -38,60 +39,63 @@ module MisterBin
   private
 
     def summary_string
-      summary ? word_wrap(summary) + "\n" : nil
+      summary ? "#{word_wrap(summary)}\n" : nil
     end
 
     def help_string
-      help ? word_wrap(help) + "\n" : nil
+      help ? "#{word_wrap(help)}\n" : nil
     end
 
     def usage_string
-      result = ["Usage:"]
+      result = ['Usage:']
       usages.each { |text| result << word_wrap("  #{text}") }
-      result << ""
+      result << ''
       result.join "\n"
     end
 
     def options_string
-      result = ["Options:"]
+      result = ['Options:']
       options.each do |option|
         result << "  #{option[0]}"
         result << word_wrap("    #{option[1]}")
-        result << ""
+        result << ''
       end
 
-      result << "  -h --help"
+      result << '  -h --help'
       result << "    Show this help\n"
 
       if version
-        result << "  --version"
+        result << '  --version'
         result << "    Show version number\n"
       end
-      
+
       result.join "\n"
     end
 
     def params_string
       return nil if params.empty?
+
       key_value_block 'Parameters:', params
     end
 
     def env_string
       return nil if env_vars.empty?
+
       key_value_block 'Environment Variables:', env_vars
     end
 
     def commands_string
       return nil if commands.empty?
+
       key_value_block 'Commands:', commands
     end
 
     def examples_string
       return nil if examples.empty?
 
-      result = ["Examples:"]
+      result = ['Examples:']
       examples.each { |text| result << word_wrap("  #{text}") }
-      result << ""
+      result << ''
       result.join "\n"
     end
 
@@ -100,11 +104,10 @@ module MisterBin
       pairs.each do |key, value|
         result << "  #{key}"
         result << word_wrap("    #{value}")
-        result << ""
+        result << ''
       end
 
       result.join "\n"
     end
-
   end
 end

data/lib/mister_bin/runner.rb

@@ -6,7 +6,7 @@ module MisterBin
 
     attr_reader :header, :footer, :version, :commands, :handler
 
-    def initialize(opts={})
+    def initialize(opts = {})
       @header = opts[:header]
       @footer = opts[:footer]
       @version = opts[:version]
@@ -22,22 +22,22 @@ module MisterBin
       @handler = to
     end
 
-    def run(argv=[])
+    def run(argv = [])
       if handler
         handler.execute argv
       elsif argv.empty?
         show_subs
-      elsif argv == ['--help'] or argv == ['-h']
+      elsif (argv == ['--help']) || (argv == ['-h'])
         show_help
-      elsif version and (argv == ['--version'] or argv == ['-v'])
+      elsif version && ((argv == ['--version']) || (argv == ['-v']))
         puts version
-        return 1
+        1
       else
         execute argv
       end
     end
 
-    private
+  private
 
     def execute(argv)
       argv = normalize_argv_command argv
@@ -54,19 +54,20 @@ module MisterBin
     def normalize_argv_command(argv)
       command = argv[0]
       return argv if commands.has_key? command
-      candidates = commands.keys.select { |key| key =~ /^#{command}/ }
+
+      candidates = commands.keys.grep(/^#{command}/)
       argv[0] = candidates.first if candidates.count == 1
       argv
     end
 
     def show_subs
       if commands.empty?
-        say "No subcommands found"
+        say 'No subcommands found'
       else
         show_subs!
       end
 
-      return 1
+      1
     end
 
     def show_subs!
@@ -74,8 +75,8 @@ module MisterBin
       max_summary_size = terminal_width - longest_key - 6
 
       say "#{header}\n" if header
-      
-      say "Commands:"
+
+      say 'Commands:'
       commands.each do |key, command|
         summary = command.meta.description
         summary = summary[0..max_summary_size].strip
@@ -87,12 +88,12 @@ module MisterBin
 
     def show_help
       if commands.empty?
-        say "No subcommands found"
+        say 'No subcommands found'
       else
         show_help!
       end
 
-      return 1
+      1
     end
 
     def show_help!
@@ -100,17 +101,15 @@ module MisterBin
 
       commands.each do |key, command|
         meta = command.meta
-        next unless meta.help or meta.summary
+        next unless meta.help || meta.summary
 
         say "!txtgrn!#{key}"
         help = meta.help || meta.summary
         say word_wrap "  #{help}"
-        say ""
+        say ''
       end
 
-      say "#{footer}" if footer
+      say footer.to_s if footer
     end
-
-
   end
-end
+end

data/lib/mister_bin/terminal.rb

@@ -8,7 +8,7 @@ module MisterBin
 
     attr_reader :runner, :options
 
-    def initialize(runner, options=nil)
+    def initialize(runner, options = nil)
       @runner = runner
       @options = options || {}
     end
@@ -18,7 +18,7 @@ module MisterBin
     end
 
     def start
-      Readline.completion_append_character = " "
+      Readline.completion_append_character = ' '
       Readline.completion_proc = autocomplete_handler if autocomplete
 
       welcome_messages
@@ -57,9 +57,9 @@ module MisterBin
       command = Shellwords.shellwords input
 
       if reserved_commands.include? command.first
-        reserved_commands[command.first].call command[1..-1]
-      elsif !disable_system_shell and command.first&.start_with? system_character
-        system input[1..-1]
+        reserved_commands[command.first].call command[1..]
+      elsif !disable_system_shell && command.first&.start_with?(system_character)
+        system input[1..]
       else
         runner.run command
       end
@@ -70,7 +70,7 @@ module MisterBin
     end
 
     def exit_commands
-      @exit_commands ||= options[:exit_commands] || ['exit', 'q']
+      @exit_commands ||= options[:exit_commands] || %w[exit q]
     end
 
     def header
@@ -78,7 +78,7 @@ module MisterBin
     end
 
     def input_loop
-      while input = Readline.readline(prompt, true) do
+      while (input = Readline.readline prompt, true)
         break unless execute input
       end
     end
@@ -93,7 +93,7 @@ module MisterBin
 
     def safe_input_loop
       input_loop
-    # :nocov:
+      # :nocov:
     rescue Interrupt
       say exit_message if exit_message
       false
@@ -102,7 +102,7 @@ module MisterBin
       say "!txtred!#{e.class}"
       say e.message
       true
-    # :nocov:
+      # :nocov:
     end
 
     def show_usage
@@ -117,6 +117,5 @@ module MisterBin
       say header if header
       runner.run if show_usage
     end
-
   end
 end

data/lib/mister_bin/version.rb

@@ -1,3 +1,3 @@
 module MisterBin
-  VERSION = "0.7.1"
-end
+  VERSION = '0.7.2'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mister_bin
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-28 00:00:00.000000000 Z
+date: 2022-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: docopt
   requirement: !ruby/object:Gem::Requirement
@@ -54,7 +54,8 @@ files:
 homepage: https://github.com/dannyben/mister_bin
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -63,14 +64,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.3.14
 signing_key: 
 specification_version: 4
 summary: Command line interface for your gems