runfile 0.10.2 → 0.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcc3c5aac5c6d47e26432ed9ed5303e38dfdca077fe832f71767a42504edf828
-  data.tar.gz: a30f05d36eb902902ad484daf51b93956ddc87a386e27d08c0acb2d6fecdb1ea
+  metadata.gz: f1e4e930d902a8bb8db9d283e1cf7c33fb26c5e1dfdf77b03d5be0a3acc01609
+  data.tar.gz: cf2bf1976c2dee358a8bbd2b9465b871bc6c9630c0ca7f091000b2464615370c
 SHA512:
-  metadata.gz: 51dec6b06b052b6aa6ca13d7b07a1c7da1fc06c24f07896be9384dd28b6a4ed8d4a6e874b9b55cc02f159ce4ebc2b47a02b09af00d9c81abcd09f0a485b0dcc0
-  data.tar.gz: f46f5bd6533fc1d1f0d6f607d06ae2b4c1c99916a2cb0a0fd10c011ed75bdba50e3f80cad6c502f46ec7a4b4c03676aca75a00802f4d179a053f6aa6d7c1a1bb
+  metadata.gz: 9eaadbedb085b6a8ef13078327b2260c82fc86baebf2292868eb7d37c166206e8b529a82a67e39fbe3a1087271308d5f750ff07bea8c515e9b065d7e413cdf65
+  data.tar.gz: f837dd093b39741dabc2e67813bcd21f9ff7bdac3b52cb90990fe9b568f90801e5c344e697224ddce095af478fc7e92ace4d5be8867c97827b4627f93dd7535e

data/README.md

@@ -2,8 +2,7 @@ Runfile - If Rake and Docopt had a baby
 ==================================================
 
 [![Gem Version](https://badge.fury.io/rb/runfile.svg)](https://badge.fury.io/rb/runfile)
-[![Build Status](https://travis-ci.com/DannyBen/runfile.svg?branch=master)](https://travis-ci.com/DannyBen/runfile)
-[![BCH compliance](https://bettercodehub.com/edge/badge/DannyBen/runfile?branch=master)](https://bettercodehub.com/results/DannyBen/runfile)
+[![Build Status](https://github.com/DannyBen/runfile/workflows/Test/badge.svg)](https://github.com/DannyBen/runfile/actions?query=workflow%3ATest)
 [![Maintainability](https://api.codeclimate.com/v1/badges/81cf02ccfcc8531cb09f/maintainability)](https://codeclimate.com/github/DannyBen/runfile/maintainability)
 
 ---
@@ -20,9 +19,9 @@ to [Rake](https://github.com/ruby/rake), but with the full power of
 You create a `Runfile`, and execute commands with 
 `run command arguments -and --flags`.
 
-![Runfile Demo](https://raw.githubusercontent.com/DannyBen/runfile/master/demo.gif "Runfile Demo")
+![Runfile Demo](demo.svg "Runfile Demo")
 
-[Learn More in the Wiki](https://github.com/DannyBen/runfile/wiki)
+[Learn More in the User Guide](https://runfile.dannyb.co)
 
 ---
 
@@ -114,13 +113,12 @@ When you execute `run`, we will look for files in this order:
 When you execute `run!`, we will ignore any local Runfile and only search 
 for global (named) runfiles.
 
-Read more in the [Runfile Location and Filename wiki page](https://github.com/DannyBen/runfile/wiki/Runfile-Location-and-Filename)
+Read more on [Runfile Location and Filename](https://runfile.dannyb.co/Runfile-Location-and-Filename)
 
 
 Documentation
 --------------------------------------------------
 
+- [User Guide](https://runfile.dannyb.co)
 - [Learn by Example](https://github.com/DannyBen/runfile/tree/master/examples)
-- [Runfile Command Reference](https://github.com/DannyBen/runfile/wiki/Runfile-Command-Reference)
-- [Wiki](https://github.com/DannyBen/runfile/wiki)
 - [Rubydoc](http://www.rubydoc.info/gems/runfile)

data/lib/runfile/docopt_helper.rb

@@ -22,6 +22,8 @@ module Runfile
       @summary    = options.summary
       @actions    = options.actions
       @options    = options.options
+      @params     = options.params
+      @env_vars   = options.env_vars
       @examples   = options.examples
     end
 
@@ -35,6 +37,8 @@ module Runfile
       doc += docopt_usage
       doc += docopt_commands width
       doc += docopt_options width
+      doc += docopt_params width
+      doc += docopt_env_vars width
       doc += docopt_examples width
       doc.join "\n"
     end
@@ -74,17 +78,17 @@ module Runfile
       @options['Options'] = {} unless @options['Options']
       @options['Options']['-h --help'] = 'Show this screen'
       @options['Options']['--version'] = 'Show version number' if @version
+      section_block @options, width
+    end
 
-      doc = []
-      @options.each do |scope, values|
-        doc << "#{scope}:"
-        values.each do |flag, text|
-          helpline = "      #{text}"
-          wrapped  = word_wrap helpline, width
-          doc << "  #{flag}\n#{wrapped}\n"
-        end
-      end
-      doc
+    # Return all docopt params for 'Params' section
+    def docopt_params(width)
+      section_block @params, width
+    end
+
+    # Return all docopt params for 'Environment Variables' section
+    def docopt_env_vars(width)
+      section_block @env_vars, width
     end
 
     # Return all docopt lines for the 'Examples' section
@@ -101,6 +105,21 @@ module Runfile
       doc
     end
 
+    # Return a generic block containing scope section (e.g. "Options"), 
+    # followed by key value paragraphs.
+    def section_block(definitions, width)
+      doc = []
+      definitions.each do |scope, values|
+        doc << "#{scope}:"
+        values.each do |label, text|
+          helpline = "      #{text}"
+          wrapped  = word_wrap helpline, width
+          doc << "  #{label}\n#{wrapped}\n"
+        end
+      end
+      doc
+    end
+
     # Call the docopt handler, which will either return a parsed
     # arguments list, or halt execution and show usage.
     def args(argv)

data/lib/runfile/dsl.rb

@@ -43,6 +43,18 @@ module Runfile
       Runner.instance.add_option flag, text, scope
     end
 
+    # Add a parameter (can be called multiple times)
+    #   param 'FOLDER', 'Folder to copy'
+    def param(name, text, scope=nil)
+      Runner.instance.add_param name, text, scope
+    end
+
+    # Set an environment variable (can be called multiple times)
+    #   env_var 'USER', 'Set the user (same as --user)'
+    def env_var(name, text, scope = nil)
+      Runner.instance.add_env_var name, text, scope
+    end
+
     # Set an example command (can be called multiple times)
     #   example 'server --background'
     def example(text)
@@ -73,28 +85,28 @@ module Runfile
 
     # Run a command, wait until it is done and continue
     #   run 'rails server'
-    def run(*args)
-      ExecHandler.instance.run(*args)
+    def run(cmd)
+      ExecHandler.instance.run cmd
     end
 
     # Run a command, wait until it is done, then exit
     #   run! 'rails server'
-    def run!(*args)
-      ExecHandler.instance.run!(*args)
+    def run!(cmd)
+      ExecHandler.instance.run! cmd
     end
 
     # Run a command in the background, optionally log to a log file and save
     # the process ID in a pid file
     #   run_bg 'rails server', pid: 'rails', log: 'tmp/log.log'
-    def run_bg(*args)
-      ExecHandler.instance.run_bg(*args)
+    def run_bg(cmd, pid: nil, log: '/dev/null')
+      ExecHandler.instance.run_bg cmd, pid: pid, log: log
     end
 
     # Stop a command started with 'run_bg'. Provide the name of he pid file you 
     # used in 'run_bg'
     #   stop_bg 'rails'
-    def stop_bg(*args)
-      ExecHandler.instance.stop_bg(*args)
+    def stop_bg(pid)
+      ExecHandler.instance.stop_bg pid
     end
 
     # Set a block to be called before each run. The block should return

data/lib/runfile/runner.rb

@@ -13,7 +13,8 @@ module Runfile
     include SettingsMixin
 
     attr_accessor :last_usage, :last_help, :name, :version, 
-      :summary, :namespace, :superspace, :actions, :examples, :options
+      :summary, :namespace, :superspace, :actions, :examples, :options, 
+      :params, :env_vars
 
     # Initialize all variables to sensible defaults.
     def initialize
@@ -23,7 +24,9 @@ module Runfile
       @namespace  = nil     # dsl: command
       @actions  = {}        # dsl: action
       @options  = {}        # dsl: option
+      @params   = {}        # dsl: param
       @examples = []        # dsl: example
+      @env_vars = {}        # dsl: env_var
       @name     = "Runfile" # dsl: name
       @version  = false     # dsl: version
       @summary  = false     # dsl: summary
@@ -46,7 +49,7 @@ module Runfile
 
     # Add an action to the @actions array, and use the last known
     # usage and help messages sent by the DSL.
-    def add_action(name, altname=nil, &block)
+    def add_action(name, altname = nil, &block)
       if @last_usage.nil?
         @last_usage = altname ? "(#{name}|#{altname})" : name 
       end
@@ -66,12 +69,26 @@ module Runfile
     end
 
     # Add an option flag and its help text.
-    def add_option(flag, text, scope=nil)
-      scope or scope = 'Options'
+    def add_option(flag, text, scope = nil)
+      scope ||= 'Options'
       @options[scope] ||= {}
       @options[scope][flag] = text
     end
 
+    # Add a patameter and its help text.
+    def add_param(name, text, scope = nil)
+      scope ||= 'Parameters'
+      @params[scope] ||= {}
+      @params[scope][name] = text
+    end
+
+    # Add env_var command.
+    def add_env_var(name, text, scope = nil)
+      scope ||= 'Environment Variables'
+      @env_vars[scope] ||= {}
+      @env_vars[scope][name] = text
+    end
+
     # Add example command.
     def add_example(command)
       @examples << (@namespace ? "#{@namespace} #{command}" : command)
@@ -85,7 +102,7 @@ module Runfile
         docopt_exec argv
       rescue Docopt::Exit => ex
         puts ex.message
-        exit 1
+        exit 2
       end
     end
 
@@ -144,11 +161,12 @@ module Runfile
       maker = RunfileHelper.new
       maker.purge_settings if @ignore_settings
       runfile = maker.handle argv
-      if runfile
-        @superspace = argv[0]
-        execute argv, runfile
-      end
-      exit 1
+
+      exit 3 unless runfile
+
+      @superspace = argv[0]
+      execute argv, runfile
+      exit
     end
 
     def expand_shortcuts(argv)

data/lib/runfile/version.rb

@@ -1,3 +1,3 @@
 module Runfile
-  VERSION = "0.10.2"
+  VERSION = "0.11.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: runfile
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.11.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-03 00:00:00.000000000 Z
+date: 2020-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -84,8 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: If Rake and Docopt had a baby