mister_bin 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e87b4752236683e3e699872c4d324ab6d715234789459211b12cbd5238192a13
-  data.tar.gz: 58588e6731278f5e1c8f9802f2186eec49333d54836992782437be643a07829e
+  metadata.gz: 6f6758cdef54004ba6fc9f83f4b73f318213919800393c072f00d6b21daef46b
+  data.tar.gz: 665a7f2759ac11bf3f7850cfbc2319cded0009f4776806f821c01b1b77691f26
 SHA512:
-  metadata.gz: f212bb72a9f67c744250135248f4bd2890142e8c11fde10c9fc9d1dbf25400cfdfa3e016e8ba89446ccea2053e089444d06b95d369d3c11f2ed6f0b557ef6ebd
-  data.tar.gz: aa0f21c1fe5cbfba66b9bf1042073eadfe12fd7ce5ef8f47620f63a287c314d8a47891fdb2a611f7daf68ee37889565fbbb0aa4b37a417741f409270f293d975
+  metadata.gz: 1c493f1c9e7e104be1c95d86baa4c3a806ae90272e592938787d17ae363b82a442265f7984ff32ba4708bc764124563a534b029f15180ba852430cc8d0b35e63
+  data.tar.gz: 600cda0b6a7faaa6b98a32eb970cfcc19e725dcf4402eb741d29ce036568c062e64a07602b580d1330191e87fe99b9a4c816fd6ceb8356c78d264336b2eb5fc3

data/README.md

@@ -4,6 +4,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.org/DannyBen/mister_bin.svg?branch=master)](https://travis-ci.org/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)
 
 ---
 
@@ -11,6 +12,20 @@ Build modular command line utilities.
 
 ---
 
+Contents
+--------------------------------------------------
+
+* [Contents](#contents)
+* [Installation](#installation)
+* [Design Goals](#design-goals)
+* [Example](#example)
+* [Usage](#usage)
+* [Creating the Main Executable](#creating-the-main-executable)
+    * [Runner Options](#runner-options)
+* [Creating Commands](#creating-commands)
+    * [Command DSL](#command-dsl)
+
+
 Installation
 --------------------------------------------------
 
@@ -57,10 +72,12 @@ The `git` executable:
 #!/usr/bin/env ruby
 require 'mister_bin'
 
-exit MisterBin::Runner.run __FILE__, ARGV
+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"
@@ -107,47 +124,69 @@ file, simply implement these instead:
 Creating the Main Executable
 --------------------------------------------------
 
-The main executable is usually simple, and contains this code:
+The main executable is usually simple and only serves to initialize Mister 
+Bin with options.
+
+This is the minimal code:
 
 ```ruby
 # git
 #!/usr/bin/env ruby
 require 'mister_bin'
 
-exit MisterBin::Runner.run __FILE__, ARGV
+runner = MisterBin::Runner.new 'appname'
+exitcode = runner.run ARGV
+exit exitcode
 ```
 
-It will start the execution chain based on the arguments provided 
-when running it.
+### Runner Options
 
-The `Runner.run` method requires two parameters:
+The `Runner` method requires only the name of the main executable:
 
-1. The path to the base executable file (usually, `__FILE__` is what you 
-   need).
-2. An array of arguments (usually `ARGV` is what you need).
+```ruby
+runner = MisterBin::Runner.new 'appname'
+```
 
-In addition, you may provide a `header` and a `footer` that will be 
-displayed when executing without arguments:
+In addition, you can provide an options hash:
 
 ```ruby
-# git
-#!/usr/bin/env ruby
-require 'mister_bin'
+options = {
+  header: 'My command line app'
+  footer: 'Use --help for additional info',
+  basedir: __dir__, 
+  isolate: true
+}
+
+runner = MisterBin::Runner.new 'appname', options
+```
 
-exitcode =  MisterBin::Runner.run __FILE__, ARGV,
-  header: "This is a sample header.",
-  footer: "This is a sample footer."
+#### `header`
 
-exit exitcode
-```
+Text to display before the list of commands.
+
+#### `footer`
+
+Text to display after the list of commands.
+
+#### `basedir`
 
+The directory that holds the command files. 
 
+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`
 
-Creating Subcommands
+#### `isolate`
+
+If you wish to prevent runner from searching in the `PATH` directories, 
+specify `isolate: true`
+
+
+Creating Commands
 --------------------------------------------------
 
 When the main executable is executed, it will look for files matching a 
-specific pattern in the same directory.
+specific pattern in the same directory and in the `PATH`.
 
 Assuming the main executable is called `myapp`, it will look for 
 `myapp-*.rb` files (e.g. `myapp-status.rb`)
@@ -157,8 +196,7 @@ their actions.
 
 
 
-The DSL
---------------------------------------------------
+### Command DSL
 
 The DSL is designed to create a [docopt][1] document. Most commands are 
 optional.
@@ -201,3 +239,4 @@ end
 
 
 [1]: http://docopt.org/
+

data/lib/mister_bin/commands.rb

@@ -2,11 +2,12 @@ module MisterBin
 
   # This class handles listing and finding command files
   class Commands
-    attr_reader :basename, :basedir
+    attr_reader :basename, :basedir, :isolate
 
-    def initialize(basename, basedir='.')
+    def initialize(basename, basedir='.', isolate: false)
       @basename = basename
       @basedir = basedir
+      @isolate = isolate
     end
 
     def all
@@ -45,7 +46,13 @@ module MisterBin
     end
 
     def path_helper
-      @path_helper ||= PathHelper.new(additional_dir: basedir)
+      @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

@@ -2,6 +2,7 @@ module MisterBin
 
   class PathHelper
     attr_reader :pathspec, :additional_dir
+    attr_writer :paths
 
     def initialize(additional_dir: nil, pathspec: nil)
       @additional_dir = additional_dir

data/lib/mister_bin/runner.rb

@@ -4,18 +4,14 @@ module MisterBin
   class Runner
     include Colsole
 
-    attr_reader :basefile, :basedir, :name, :header, :footer
-
-    def self.run(basefile, argv=[], header: nil, footer: nil)
-      new(basefile, header: header, footer: footer).run argv
-    end
-
-    def initialize(basefile, header: nil, footer: nil)
-      @basefile = basefile
-      @header = header
-      @footer = footer
-      @basedir = File.dirname basefile
-      @name = File.basename basefile
+    attr_reader :name, :basedir, :header, :footer, :isolate
+
+    def initialize(name, opts={})
+      @name = name
+      @header = opts[:header]
+      @footer = opts[:footer]
+      @isolate = opts[:isolate]
+      @basedir = opts[:basedir]
     end
 
     def run(argv=[])
@@ -57,7 +53,7 @@ module MisterBin
     end
 
     def commands
-      @commands ||= Commands.new name, basedir
+      @commands ||= Commands.new name, basedir, isolate: isolate
     end
   end
 end

data/lib/mister_bin/version.rb

@@ -1,3 +1,3 @@
 module MisterBin
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mister_bin
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-15 00:00:00.000000000 Z
+date: 2018-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole