mister_bin 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 992b34023bc6042c8e5cada1a4d33674df2fda7856e3d67ec07e3e4607253ad5
-  data.tar.gz: 1943a0338104dcbc63c14a62526d113ad2124443f694536aeec38a650dc49375
+  metadata.gz: df7d632c9b2d36ebd6cd52b961d4f690868575234528fa77c563e2766d4449b2
+  data.tar.gz: 8fef21a944ed08a965139c21ce96bf2560f1acfd0016b076345cd113d70933df
 SHA512:
-  metadata.gz: 5d9454d65eef5a5f1f53ce6198011331ef772fece59fe831f1abb33d616f3e4847f2d6ff40281bb8aa6d50f40ede1616b5f012109df942460c61efb0fa7ea7e8
-  data.tar.gz: 03dfe016fe75b4baa7da4fef059396f3534168ba284033b5037afd715b4e86efbf0461d0972e498828764df9f0b44034d647a570bd01fdd21ba3feede5c86798
+  metadata.gz: 48f0fc73b3731e339e4d131df19519c203b2ce8f1e9030323867eac715fe21793d9be8193675376a6538783a1bbbadfb1c4af40fce5076377f81a5ba1a3f82cd
+  data.tar.gz: 49f22c1ec956275a8c3c8a0681d9fc324e147db4595dea3681b5bc85212933a78738833b57dfa8eaa7221219f4dad172578c9726ea52d96cd38df0d9ca2dc2b1

data/README.md

@@ -2,13 +2,13 @@ Mister Bin
 ==================================================
 
 [![Gem Version](https://badge.fury.io/rb/mister_bin.svg)](https://badge.fury.io/rb/mister_bin)
-[![Build Status](https://travis-ci.org/DannyBen/mister_bin.svg?branch=master)](https://travis-ci.org/DannyBen/mister_bin)
+[![Build Status](https://travis-ci.com/DannyBen/mister_bin.svg?branch=master)](https://travis-ci.com/DannyBen/mister_bin)
 [![Maintainability](https://api.codeclimate.com/v1/badges/ae82443a99c2839d8ba8/maintainability)](https://codeclimate.com/github/DannyBen/mister_bin/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/ae82443a99c2839d8ba8/test_coverage)](https://codeclimate.com/github/DannyBen/mister_bin/test_coverage)
 
 ---
 
-Build modular command line utilities.
+A command line framework for adding command line utilities to your gems.
 
 ---
 
@@ -41,7 +41,6 @@ Design Goals
   involved in building command line utilities.
 - Provide a mechanism for separating each command and subcommand to its 
   own file.
-- Support the ability to extend a given command from different sources.
 - Allow gem developers to easily add command line interface to their gems.
 - Allow for easy and straight forward testing of the generated CLI.
 
@@ -59,65 +58,10 @@ Usage
 
 Creating a command line utility with Mister Bin involves at least two files:
 
-1. The main "app" file. This is the actual "executable".
-2. One or more subcommand files. These files use the DSL.
-
-For example, assuming we would like to create a command line tool similar 
-to `git`, we will create two files:
-
-The `git` executable:
-
-```ruby
-# git
-#!/usr/bin/env ruby
-require 'mister_bin'
-
-runner = MisterBin::Runner.new 'git', basedir: __dir__
-exitcode =  runner.run ARGV
-```
-
-The file to handle the `git push` command:
-
-```ruby
-# git-push.rb
-version "0.1.0"
-help "Push git repo"
-
-usage "git push [--all]"
-
-option "--all", "Push all branches"
-
-action do |args|
-  if args['--all']
-    puts "pushing all"
-  else
-    puts "pushing, some..."
-  end
-end
-```
-
-Mister Bin also provides support for secondary subcommands. For example,
-if you want to create a command line that responds to the below commands:
-
-```
-$ git status
-$ git repo create
-$ git repo delete
-```
-
-You will need to create these files:
-
-1. `git`
-2. `git-status.rb`
-3. `git-repo-create.rb`
-4. `git-repo-delete.rb`
-
-Alternatively, if you prefer to handle all `repo` subcommands in a single 
-file, simply implement these instead:
-
-1. `git`
-2. `git-status.rb`
-3. `git-repo.rb`
+1. The main "bin" file. This is the actual executable, and if you are 
+   developing a gem, this will be in the `bin` directory of your folder.
+2. One or more subcommand files. These files use the DSL, and will usually be
+   placed in your `lib/<your gem>/commands folder.
 
 
 
@@ -130,35 +74,23 @@ Bin with options.
 This is the minimal code:
 
 ```ruby
-# git
 #!/usr/bin/env ruby
-require 'mister_bin'
+runner = MisterBin::Runner.new
+
+runner.route 'dir',   to: DirCommand
+runner.route 'greet', to: GreetCommand
 
-runner = MisterBin::Runner.new 'appname'
-exitcode = runner.run ARGV
-exit exitcode
+exit runner.run ARGV
 ```
 
 ### Runner Options
 
-The `Runner` method requires only the name of the main executable:
+The `Runner` object accepts an optional hash of options:
 
 ```ruby
-runner = MisterBin::Runner.new 'appname'
-```
-
-In addition, you can provide an options hash:
-
-```ruby
-options = {
+runner = MisterBin::Runner.new version: '1.2.3',
   header: 'My command line app'
-  version: '1.2.3',
   footer: 'Use --help for additional info',
-  basedir: __dir__, 
-  isolate: true
-}
-
-runner = MisterBin::Runner.new 'appname', options
 ```
 
 #### `version`
@@ -173,32 +105,52 @@ Text to display before the list of commands.
 
 Text to display after the list of commands.
 
-#### `basedir`
 
-The directory that holds the command files. 
+### Runner Routes
+
+The `Runner` object needs to be told how to route commands that are executed
+in the command line.
 
-By default, the runner will look for its command files in all the `PATH` 
-directories. You may add another directory to this search path by specifying
-it with `basedir`
+Use the `#route` method as follows:
 
-#### `isolate`
+```ruby
+runner = MisterBin::Runner.new
+runner.route <regex>, to: <Class Name>
+```
+
+for example:
 
-If you wish to prevent runner from searching in the `PATH` directories, 
-specify `isolate: true`
+```ruby
+runner = MisterBin::Runner.new
+runner.route 'dir', to: DirCommand
+runner.route 'greet', to: GreetCommand
+runner.route 'config init', to: ConfigInitializerCommand
+runner.route 'config show', to: ConfigDisplayerCommand
+```
 
 
 Creating Commands
 --------------------------------------------------
 
-When the main executable is executed, it will look for files matching a 
-specific pattern in the same directory and in the `PATH`.
+Create command classes by in heriting from `MisterBin::Command`, for example:
 
-Assuming the main executable is called `myapp`, it will look for 
-`myapp-*.rb` files (e.g. `myapp-status.rb`)
+```ruby
+require 'mister_bin'
+
+class GreetCommand < MisterBin::Command
+  summary "Say hi"
+  usage "app greet [NAME]"
+  param "NAME", "The recipient of the greeting"
 
-These files do not need to be executables, and should use the DSL to define
-their actions.
+  def run(args)
+    name = args['NAME'] || 'Luke'
+    puts "#{name}... I am your father..."
+  end
+end
+```
 
+These classes can use any of the below DSL commands, and must define a
+`def run(args)` method.
 
 
 ### Command DSL

data/lib/mister_bin.rb

@@ -1,8 +1,5 @@
 require 'mister_bin/command'
-require 'mister_bin/commands'
 require 'mister_bin/docopt_maker'
-require 'mister_bin/path_helper'
 require 'mister_bin/runner'
-require 'mister_bin/script'
 
 require 'byebug' if ENV['BYEBUG']

data/lib/mister_bin/command.rb

@@ -1,25 +1,66 @@
+require 'docopt'
+
 module MisterBin
   class Command
-    attr_reader :command, :file, :type
+    class << self
+      def description
+        maker.summary || maker.help || ''
+      end
 
-    def initialize(command, file)
-      @command = command
-      @file = file
-      @type = command =~ / / ? :secondary : :primary
-    end
+      def execute(argv=[])
+        args = Docopt.docopt docopt, version: maker.version, argv: argv
+        exitcode = new.run args
+        exitcode.is_a?(Numeric) ? exitcode : 0
 
-    def run(argv=[])
-      script.execute argv
-    end
+      rescue Docopt::Exit => e
+        puts e.message
+        1
+      end
 
-    def metadata
-      script.metadata
-    end
+      # DSL
+
+      def summary(text)
+        maker.summary = text
+      end
+
+      def help(text)
+        maker.help = text
+      end
+
+      def version(text)
+        maker.version = text
+      end
+
+      def usage(text)
+        maker.usages << text
+      end
+
+      def option(flags, text)
+        maker.options << [flags, text]
+      end
+
+      def param(param, text)
+        maker.params << [param, text]
+      end
+
+      def example(text)
+        maker.examples << text
+      end
+
+      def environment(name, value)
+        maker.env_vars << [name, value]
+      end
+
+      protected
+
+      def maker
+        @maker ||= DocoptMaker.new
+      end
 
-    private
+      def docopt
+        maker.docopt
+      end
 
-    def script
-      @script ||= Script.new file
     end
   end
-end
+end

data/lib/mister_bin/runner.rb

@@ -4,15 +4,17 @@ module MisterBin
   class Runner
     include Colsole
 
-    attr_reader :name, :basedir, :header, :footer, :isolate, :version
+    attr_reader :header, :footer, :version, :commands
 
-    def initialize(name, opts={})
-      @name = name
+    def initialize(opts={})
       @header = opts[:header]
       @footer = opts[:footer]
-      @isolate = opts[:isolate]
-      @basedir = opts[:basedir]
       @version = opts[:version]
+      @commands = opts[:commands] || {}
+    end
+
+    def route(key, to: )
+      commands[key] = to
     end
 
     def run(argv=[])
@@ -29,18 +31,21 @@ module MisterBin
     private
 
     def execute(argv)
-      command = commands.find argv[0], argv[1]
+      command = find_command argv
 
       if command
-        execute_command command, argv
+        command.execute argv
       else
-        puts "Unknown command: #{argv[0]}\n\n"
+        say "!txtred!Unknown command\n"
         show_subs
       end
     end
 
-    def execute_command(command, argv)
-      command.run argv
+    def find_command(argv)
+      argv_line = argv.join ' '
+      candidates = commands.keys.select { |c| argv_line =~ /^#{c}/ }
+      candidate = candidates.first
+      candidate ? commands[candidate] : nil
     end
 
     def show_subs
@@ -61,7 +66,7 @@ module MisterBin
       
       say "Commands:"
       commands.each do |key, command|
-        summary = command.metadata[:summary] || ''
+        summary = command.description
         summary = summary[0..max_summary_size].strip
         say "  !bldgrn!#{key.ljust longest_key}  !txtrst!#{summary}"
       end
@@ -69,8 +74,5 @@ module MisterBin
       say "\n#{footer}" if footer
     end
 
-    def commands
-      @commands ||= Commands.new name, basedir, isolate: isolate
-    end
   end
 end

data/lib/mister_bin/version.rb

@@ -1,3 +1,3 @@
 module MisterBin
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mister_bin
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-18 00:00:00.000000000 Z
+date: 2018-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -173,11 +173,8 @@ files:
 - README.md
 - lib/mister_bin.rb
 - lib/mister_bin/command.rb
-- lib/mister_bin/commands.rb
 - lib/mister_bin/docopt_maker.rb
-- lib/mister_bin/path_helper.rb
 - lib/mister_bin/runner.rb
-- lib/mister_bin/script.rb
 - lib/mister_bin/version.rb
 homepage: https://github.com/dannyben/mister_bin
 licenses:

data/lib/mister_bin/commands.rb

@@ -1,59 +0,0 @@
-require 'forwardable'
-
-module MisterBin
-
-  # This class handles listing and finding command files
-  class Commands
-    extend Forwardable
-    
-    attr_reader :basename, :basedir, :isolate
-    def_delegators :all, :[], :<<, :each, :size, :keys, :values, :empty?
-
-    def initialize(basename, basedir='.', isolate: false)
-      @basename = basename
-      @basedir = basedir
-      @isolate = isolate
-    end
-
-    def all
-      @all ||= all!
-    end
-
-    def find(command, subcommand=nil)
-      if subcommand and keys.include? "#{command} #{subcommand}"
-        all["#{command} #{subcommand}"]
-      else
-        all["#{command}"]
-      end
-    end
-
-    private
-
-    def all!
-      result = {}
-      files.map do |file|
-        if file =~ /#{basename}-([a-z]+)-([a-z]+)\.rb/
-          command = "#{$1} #{$2}"
-        elsif file =~ /#{basename}-([a-z]+)\.rb/
-          command = $1
-        end
-        result[command] = Command.new command, file
-      end
-      result.sort.to_h
-    end
-
-    def files
-      @files ||= path_helper.search("#{basename}-*.rb")
-    end
-
-    def path_helper
-      @path_helper ||= path_helper!
-    end
-
-    def path_helper!
-      helper = PathHelper.new(additional_dir: basedir)
-      helper.paths = [basedir] if isolate
-      helper
-    end
-  end
-end

data/lib/mister_bin/path_helper.rb

@@ -1,30 +0,0 @@
-module MisterBin
-
-  class PathHelper
-    attr_reader :pathspec, :additional_dir
-    attr_writer :paths
-
-    def initialize(additional_dir: nil, pathspec: nil)
-      @additional_dir = additional_dir
-      @pathspec = pathspec || ENV['PATH']
-    end
-
-    def search(glob)
-      result = []
-      paths.each { |path| result += Dir["#{path}/#{glob}"] }
-      result
-    end
-
-    def paths
-      @paths ||= paths!
-    end
-
-    private
-
-    def paths!
-      result = pathspec.split File::PATH_SEPARATOR
-      result.push additional_dir if additional_dir
-      result
-    end
-  end
-end

data/lib/mister_bin/script.rb

@@ -1,101 +0,0 @@
-require 'docopt'
-require 'colsole'
-
-module MisterBin
-  class Script
-    # We are in cluding colsole to allow the evaluated script to use its
-    # functions
-    include Colsole
-
-    attr_reader :file, :action_block
-
-    def initialize(file)
-      @file = file
-    end
-
-    def execute(argv=[])
-      build_docopt
-      execute! argv
-    rescue Docopt::Exit => e
-      puts e.message
-      1
-    end
-
-    def docopt
-      maker.docopt
-    end
-
-    def metadata
-      @metadata ||= metadata!
-    end
-
-    # DSL
-
-    def summary(text)
-      maker.summary = text
-    end
-
-    def help(text)
-      maker.help = text
-    end
-
-    def version(text)
-      maker.version = text
-    end
-
-    def usage(text)
-      maker.usages << text
-    end
-
-    def option(flags, text)
-      maker.options << [flags, text]
-    end
-
-    def param(param, text)
-      maker.params << [param, text]
-    end
-
-    def example(text)
-      maker.examples << text
-    end
-
-    def environment(name, value)
-      maker.env_vars << [name, value]
-    end
-
-    def action(&block)
-      @action_block = block
-    end
-
-    private
-
-    def metadata!
-      instance_eval script
-
-      { 
-        summary: (maker.summary || maker.help), 
-        version: maker.version 
-      }
-    end
-
-    def execute!(argv)
-      args = Docopt.docopt docopt, version: maker.version, argv: argv
-      exitcode = action_block.call args if action_block
-      exitcode.is_a?(Numeric) ? exitcode : 0
-    end
-
-    def build_docopt
-      @maker = nil
-      instance_eval script
-      docopt
-    end
-
-    def maker
-      @maker ||= DocoptMaker.new
-    end
-
-    def script
-      @script ||= File.read file
-    end
-  end
-end