runfile 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b9025fd4b3e8a2ee35daaeb3b9c058732bfc88fc88891381761b2ee80b8d7fc
-  data.tar.gz: 7586f94445866e5819a7d29667056c7f2cca94ed4b41e448396c17e9964bc474
+  metadata.gz: 79a1c61423d09207b687d93f98035c5ca6b5e9d36f7b4acc12d93ccaa817c873
+  data.tar.gz: 0d870a0f93a9add25113e8030a02ce99dd2ecb0ed8f42d5eddb69b520b998da0
 SHA512:
-  metadata.gz: 87af85bbce27734b356fee01ed2097d5f77fc9fdc2f44f251cf5ccb07562944bc53c9b52c30602d0b991e5c6b9eb03ddb8195b23923812d4184bd5164cec9401
-  data.tar.gz: d3ac178489ca8e8a3a99090d035e2d57cf55d5f93a8199d18a7ac9150d27d2ac48b1c4d70b1d45f9cf2b79f55327aeb1847b0f4a9ae73749cf787ea47b90bb58
+  metadata.gz: 387383e744bac9dbd8ab89598df2a3217a4fa58f120b60ab7c31bbbfec074ae3fee0512cdee002b740af3aa85a6cd930ddfeefbe1d14deec182ebf77d57c8ab6
+  data.tar.gz: ca1b2962b157454842a0050cd3bf70826509362e7b18b9ebd2c1cc863480b0ac7f7556ad9e4fed27bad22b9c11238cf6b063e57e8b1d0459607fdb791c4ea1ae

data/README.md

@@ -1,18 +1,21 @@
-Runfile - If Rake and Docopt had a baby
-==================================================
+<div align='center'>
+<img src='logo.svg' width=280>
+
+# Runfile - command line for your projects
 
 [![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)
 
 ---
 
-A beautiful command line application framework.  
-Rake-inspired, Docopt inside.
+A beautiful command line application framework  
+Rake-inspired - Docopt inside
 
 ---
 
+</div>
+
 **Runfile** lets you create command line applications in a way similar 
 to [Rake](https://github.com/ruby/rake), but with the full power of 
 [Docopt](http://docopt.org/) command line options.
@@ -20,28 +23,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")
-
-[Learn More in the Wiki](https://github.com/DannyBen/runfile/wiki)
-
----
-
-**Upgrade Notice:**  
-If you are upgrading to 0.9.x - the `name` command was replaced 
-with `title`.
-
----
-
-Install
---------------------------------------------------
-
-```shell
-$ gem install runfile
-```
-
+![Runfile Demo](demo.svg "Runfile Demo")
 
-Quick Start
---------------------------------------------------
+## Quick Start
 
 ```shell
 $ run new        # create a new Runfile
@@ -50,8 +34,7 @@ $ vi Runfile     # edit the Runfile
 ```
 
 
-Example
---------------------------------------------------
+## Example
 
 The most minimal `Runfile` looks like this:
 
@@ -64,14 +47,14 @@ end
 
 You can then run it by executing this command:
 
-```
+```shell
 $ run greet Luke
 Hello Luke
 ```
 
 Executing `run` without parameters, will show the usage patterns:
 
-```
+```shell
 $ run
 Usage:
   run greet <name>
@@ -80,7 +63,7 @@ Usage:
 
 Executing `run --help` will show the full help document (docopt)
 
-```
+```shell
 $ run --help
 Runfile 0.0.0
 
@@ -96,31 +79,26 @@ Options:
       Show version
 ```
 
+## Documentation
 
-Runfile per project or global Runfiles
---------------------------------------------------
-
-In addition to the per project `Runfile` files, it is also possible to 
-create global runfiles that are accessible to you only or to anybody on 
-the system.
+- [User Guide](https://runfile.dannyb.co/)
+- [Learn by Example](https://github.com/DannyBen/runfile/tree/master/examples#readme)
 
-When you execute `run`, we will look for files in this order:
+## Breaking changes in 0.12.0
 
-- `Runfile` in the current directory
-- `*.runfile` in the current directory
-- `~/runfile/**/*.runfile`
-- `/etc/runfile/**/*.runfile`
+Note that version 0.12.0 removes several commands from the DSL. 
+If you were using any of the Colsole commands (`say`, `resay`, etc.), or any of
+the `run`, `run_bg` commands, you will have to adjust your Runfile since they are
+no longer available.
 
-When you execute `run!`, we will ignore any local Runfile and only search 
-for global (named) runfiles.
+For convenience, you can simply `require runfile/compatibility` at the top of 
+your Runfile, to still have this functionality included.
 
-Read more in the [Runfile Location and Filename wiki page](https://github.com/DannyBen/runfile/wiki/Runfile-Location-and-Filename)
+More info and alternative solutions in
+[this pull request](https://github.com/DannyBen/runfile/pull/46).
 
+## Contributing / Support
 
-Documentation
---------------------------------------------------
+If you experience any issue, have a question or a suggestion, or if you wish
+to contribute, feel free to [open an issue](https://github.com/DannyBen/runfile/issues).
 
-- [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/bin/run

@@ -5,7 +5,6 @@ require 'runfile'
 # for dev
 # require File.dirname(__FILE__) + "/../lib/runfile"
 
-include Colsole
 include Runfile::DSL
 
 Runfile::Runner.instance.execute ARGV

data/bin/run!

@@ -11,7 +11,6 @@ require 'runfile'
 # for dev
 # require File.dirname(__FILE__) + "/../lib/runfile"
 
-include Colsole
 include Runfile::DSL
 
 Runfile::Runner.instance.execute ARGV, false

data/lib/runfile/{exec.rb → compatibility.rb}

@@ -1,13 +1,19 @@
-require 'singleton'
+# This file provides a compatibility layer for version 0.12.0 so that
+# all the Colsole methods (say, resay...) and ExecHandler methods
+# (run, run_bg...) are still available
+# Simply require 'runfile/compatibility' to have the same functionality
+# as older versions.
+#
+# Notes:
+# - You need to have the colsole gem installed
+# - Requiring this file also includes it (see the end of the file).
+# - This functinality will be removed in future versions
+# - More info: https://github.com/DannyBen/runfile/pull/46
+require 'colsole'
 
 module Runfile
-
-  # This class provides methods for easily and politely run shell commands
-  # through a Runfile action.
-  # It is mainly a convenient wrapper around `system` and `exec` and it also
-  # adds functions for running background tasks with ease.
-  class ExecHandler
-    include Singleton
+  module Compatibilty
+    include Colsole
 
     # Run a command, wait until it is done and continue
     def run(cmd)
@@ -62,7 +68,7 @@ module Runfile
       @after_run_block = block
     end
 
-    private
+  private
 
     def pid_dir
       defined?(Runfile.pid_dir) ? Runfile.pid_dir : nil
@@ -73,4 +79,6 @@ module Runfile
     end
 
   end
-end
+end
+
+include Runfile::Compatibilty

data/lib/runfile/docopt_helper.rb

@@ -1,5 +1,4 @@
 require 'docopt'
-require 'colsole'
 
 module Runfile
   # The DocoptHelper class handles the dynamic generation of the 
@@ -7,7 +6,7 @@ module Runfile
   # to call Docopt so it returns the parsed arguments or halts with
   # usage message).
   class DocoptHelper
-    include Colsole
+    using Refinements
 
     # The constructor expects to an object that responds to all the 
     # textual details needed to generate a docopt document (name, version, 
@@ -23,13 +22,14 @@ module Runfile
       @actions    = options.actions
       @options    = options.options
       @params     = options.params
+      @env_vars   = options.env_vars
       @examples   = options.examples
     end
 
     # Generate a document based on all the actions, help messages
     # and options we have collected from the Runfile DSL.
     def docopt
-      width = detect_terminal_size[0]
+      width = Terminal.width
       doc = []
       doc << (@version ? "#{@name} #{@version}" : "#{@name}")
       doc << "#{@summary}" if @summary
@@ -37,6 +37,7 @@ module Runfile
       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
@@ -65,7 +66,7 @@ module Runfile
         doc << "Commands:" unless caption_printed
         caption_printed = true
         helpline = "      #{action.help}"
-        wrapped  = word_wrap helpline, width
+        wrapped  = helpline.word_wrap width
         doc << "  #{action.usage}\n#{wrapped}\n" unless action.usage == false
       end
       doc
@@ -84,6 +85,11 @@ module Runfile
       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
     def docopt_examples(width)
       return [] if @examples.empty?
@@ -92,7 +98,7 @@ module Runfile
       base_command = @superspace ? "run #{@superspace}" : "run"
       @examples.each do |command|
         helpline = "  #{base_command} #{command}"
-        wrapped  = word_wrap helpline, width
+        wrapped  = helpline.word_wrap width
         doc << "#{wrapped}"
       end
       doc
@@ -106,7 +112,7 @@ module Runfile
         doc << "#{scope}:"
         values.each do |label, text|
           helpline = "      #{text}"
-          wrapped  = word_wrap helpline, width
+          wrapped  = helpline.word_wrap width
           doc << "  #{label}\n#{wrapped}\n"
         end
       end

data/lib/runfile/dsl.rb

@@ -49,6 +49,12 @@ module Runfile
       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)
@@ -77,51 +83,6 @@ module Runfile
       Runner.instance.cross_call command_string
     end
 
-    # Run a command, wait until it is done and continue
-    #   run 'rails server'
-    def run(*args)
-      ExecHandler.instance.run(*args)
-    end
-
-    # Run a command, wait until it is done, then exit
-    #   run! 'rails server'
-    def run!(*args)
-      ExecHandler.instance.run!(*args)
-    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)
-    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)
-    end
-
-    # Set a block to be called before each run. The block should return
-    # the command to run, since this is intended to let the block modify
-    # the command if it needs to.
-    #   before_run do |command|
-    #     puts "BEFORE #{command}"
-    #     command
-    #   end
-    def before_run(&block)
-      ExecHandler.instance.before_run(&block)
-    end
-
-    # Set a block to be called after each run
-    #   before_run do |command|
-    #     puts "AFTER #{command}"
-    #   end
-    def after_run(&block)
-      ExecHandler.instance.after_run(&block)
-    end
-
     # Also allow to use 'endcommand' instead of 'command' to end
     # a command namespace definition
     alias_method :endcommand, :command

data/lib/runfile/refinements.rb

@@ -0,0 +1,22 @@
+module Runfile
+  module Refinements
+    refine String do
+      def word_wrap(length = nil)
+        text = self
+
+        length ||= Terminal.width
+        lead = text[/^\s*/]
+        text.strip!
+        length -= lead.length
+        text.split("\n").collect! do |line|
+          if line.length > length
+            line.gsub!(/([^\s]{#{length}})([^\s$])/, "\\1 \\2")
+            line.gsub(/(.{1,#{length}})(\s+|$)/, "#{lead}\\1\n").rstrip
+          else
+            "#{lead}#{line}"
+          end
+        end * "\n"
+      end
+    end
+  end
+end

data/lib/runfile/runfile_helper.rb

@@ -8,6 +8,7 @@ module Runfile
   # 2. Creating new runfiles (`run new`)
   # 3. Showing a list of found system runfiles in a colorful help
   class RunfileHelper
+    using Refinements
     include SettingsMixin
     
     # Handle the case when `run` is called without a Runfile 
@@ -72,14 +73,14 @@ module Runfile
 
     # Show some helpful tips, and a list of available runfiles
     def show_make_help(runfiles, compact=false)
-      say "!txtpur!Runfile engine v#{Runfile::VERSION}" unless compact
+      puts "Runfile engine v#{Runfile::VERSION}" unless compact
       if runfiles.size < 3 and !compact
-        say "\nTip: Type '!txtblu!run new!txtrst!' or '!txtblu!run new name!txtrst!' to create a runfile.\nFor global access, place !txtblu!named.runfiles!txtrst! in ~/runfile/ or in /etc/runfile/."
+        puts "\nTip: Type 'run new' or 'run new name' to create a runfile.\nFor global access, place named.runfiles in ~/runfile/ or in /etc/runfile/."
       end
       if runfiles.empty? 
-        say "\n!txtred!Runfile not found."
+        puts "\nRunfile not found."
       else
-        say ""
+        puts ""
         compact ? say_runfile_usage(runfiles) : say_runfile_list(runfiles)
       end
     end
@@ -110,14 +111,14 @@ module Runfile
     def say_runfile_list(runfiles)
       runfile_paths = runfiles.map { |f| File.dirname f }
       max = runfile_paths.max_by(&:length).size
-      width = detect_terminal_size[0]
+      width = Terminal.width
       runfiles.each do |f|
         f[/([^\/]+).runfile$/]
         command  = "run #{$1}"
         spacer_size = width - max - command.size - 6
         spacer_size = [1, spacer_size].max
         spacer = '.' * spacer_size
-        say "  !txtgrn!#{command}!txtrst! #{spacer} #{File.dirname f}"
+        puts "  #{command} #{spacer} #{File.dirname f}"
       end
     end
 
@@ -125,19 +126,19 @@ module Runfile
     def say_runfile_usage(runfiles)
       runfiles_as_columns = get_runfiles_as_columns runfiles
       
-      say "#{settings.intro}\n" if settings.intro
-      say "Usage: run <file>"
-      say runfiles_as_columns
+      puts "#{settings.intro}\n" if settings.intro
+      puts "Usage: run <file>"
+      puts runfiles_as_columns
 
       show_shortcuts if settings.shortcuts
     end
 
     # Prints a friendly output of the shortcut list
     def show_shortcuts
-      say "\nShortcuts:"
+      puts "\nShortcuts:"
       max = settings.shortcuts.keys.max_by(&:length).length
       settings.shortcuts.each_pair do |shortcut, command|
-        say "  #{shortcut.rjust max} : #{command}"
+        puts "  #{shortcut.rjust max} : #{command}"
       end
     end
 
@@ -145,10 +146,10 @@ module Runfile
     # current terminal width
     def get_runfiles_as_columns(runfiles)
       namelist = runfile_names runfiles
-      width = detect_terminal_size[0]
+      width = Terminal.width
       max = namelist.max_by(&:length).length
       message = "  " + namelist.map {|f| f.ljust max+1 }.join(' ')
-      word_wrap message, width
+      message.word_wrap width
     end
 
     def runfile_names(runfiles)

data/lib/runfile/runner.rb

@@ -14,7 +14,7 @@ module Runfile
 
     attr_accessor :last_usage, :last_help, :name, :version, 
       :summary, :namespace, :superspace, :actions, :examples, :options, 
-      :params
+      :params, :env_vars
 
     # Initialize all variables to sensible defaults.
     def initialize
@@ -26,6 +26,7 @@ module Runfile
       @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
@@ -48,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
@@ -68,19 +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 or scope = 'Parameters'
+    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)
@@ -166,7 +174,6 @@ module Runfile
       if settings.shortcuts and settings.shortcuts[possible_candidate]
         shortcut_value = settings.shortcuts[argv[0]]
         expanded = shortcut_value.split ' '
-        say "!txtblu!# #{possible_candidate} > #{shortcut_value}"
         argv.shift
         argv = expanded + argv
       end

data/lib/runfile/templates/Runfile

@@ -2,13 +2,15 @@ title   "Greeter"
 summary "A sample Runfile"
 version "0.1.0"
 
-usage  "hello [<name> --color]"
+usage  "hello [<name> --shout]"
 help   "Say hello"
-option "-c --color", "Greet with color"
+option "-s --shout", "Greet louder"
 action :hello do |args|
-  if args['--color']
-    say "!txtgrn!Hello #{args['<name>']}"
+  message = "Hello #{args['<name>']}"
+  
+  if args['--shout']
+    puts message.upcase
   else
-    say "Hello #{args['<name>']}"
+    puts message
   end
 end

data/lib/runfile/terminal.rb

@@ -0,0 +1,32 @@
+# This file provides some terminal related utilities (extracted from Colsole)
+
+module Runfile
+  class Terminal
+    class << self
+      def size(default = [80,30])
+        if (ENV['COLUMNS'] =~ /^\d+$/) && (ENV['LINES'] =~ /^\d+$/)
+          result = [ENV['COLUMNS'].to_i, ENV['LINES'].to_i]
+        elsif (RUBY_PLATFORM =~ /java/ || (!STDIN.tty? && ENV['TERM'])) && command_exist?('tput')
+          result = [`tput cols 2>&1`.to_i, `tput lines 2>&1`.to_i]
+        elsif STDIN.tty? && command_exist?('stty')
+          result = `stty size 2>&1`.scan(/\d+/).map { |s| s.to_i }.reverse
+        else
+          result = default
+        end
+        result = default unless result[0].is_a? Integer and result[1].is_a? Integer and result[0] > 0 and result[1] > 0
+        result
+      end
+
+      def width
+        size[0]
+      end
+
+      def command_exist?(command)
+        ENV['PATH'].split(File::PATH_SEPARATOR).any? do |dir|
+          File.exist?(File.join dir, command) or File.exist?(File.join dir, "#{command}.exe")
+        end
+      end
+
+    end
+  end
+end

data/lib/runfile/version.rb

@@ -1,3 +1,3 @@
 module Runfile
-  VERSION = "0.11.0"
+  VERSION = "0.12.0"
 end

data/lib/runfile.rb

@@ -1,4 +1,6 @@
 require 'runfile/version'
+require 'runfile/terminal'
+require 'runfile/refinements'
 require 'runfile/settings'
 require 'runfile/setup'
 require 'runfile/docopt_helper'
@@ -6,6 +8,3 @@ require 'runfile/runfile_helper'
 require 'runfile/action'
 require 'runfile/runner'
 require 'runfile/dsl'
-require 'runfile/exec'
-
-require 'byebug' if ENV['BYEBUG']

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: runfile
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-11 00:00:00.000000000 Z
+date: 2021-09-29 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: colsole
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: docopt
   requirement: !ruby/object:Gem::Requirement
@@ -52,14 +38,16 @@ files:
 - bin/run!
 - lib/runfile.rb
 - lib/runfile/action.rb
+- lib/runfile/compatibility.rb
 - lib/runfile/docopt_helper.rb
 - lib/runfile/dsl.rb
-- lib/runfile/exec.rb
+- lib/runfile/refinements.rb
 - lib/runfile/runfile_helper.rb
 - lib/runfile/runner.rb
 - lib/runfile/settings.rb
 - lib/runfile/setup.rb
 - lib/runfile/templates/Runfile
+- lib/runfile/terminal.rb
 - lib/runfile/version.rb
 homepage: https://github.com/DannyBen/runfile
 licenses:
@@ -77,15 +65,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.2.25
 signing_key: 
 specification_version: 4
 summary: If Rake and Docopt had a baby