runfile 0.6.4 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e1e4b811b20fb3a6a072a25ad05c6cabada1191
-  data.tar.gz: 225f4622994b215a2f8528608e8979efca08da0d
+  metadata.gz: 45bf6efe3fbf5afdb2e64292cab5ec675ff1930b
+  data.tar.gz: 304c5f384ec15e0311654b8cd8e383442c2132fc
 SHA512:
-  metadata.gz: 80d1173e587d084821f875e2c2ce7e2b530503d8dd01909b5516cb7adfe28acc7d8eaf379fdf0bd0409b53c09835bedc130dbdcbe0da7344ad0d584d7a4eb98f
-  data.tar.gz: ebac3b2ea0e53e8f7f39ac6d32c874a5617d4bb66169a4f4912d9b79ab79121b73ab6af69f0643eda467f6efcc205e83433d11581e9e731271ccf8ec63d98762
+  metadata.gz: bdc1b161acd30d43cb447fdb06bb6e9ccaf0214389daac3469169a1d1fb5961ad8c96e2ab75a862d6e4d8bce8457d7c894ee25bbbdb4f2289d8886a2cd20e794
+  data.tar.gz: 653e5140d60b20fac61eec1747dadc1ba4e9823fe36222d104c41bc0760f3431c3ebf1a0d326c94ced91f6868a828247764310c424601ff783111e226c31b763

data/README.md

@@ -21,6 +21,8 @@ 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/dev/demo.gif "Runfile Demo")
+
 [Learn More in the Wiki](https://github.com/DannyBen/runfile/wiki)
 
 ---

data/lib/runfile.rb

@@ -1,10 +1,10 @@
 require 'runfile/version'
 require 'runfile/settings'
+require 'runfile/setup'
 require 'runfile/docopt_helper'
 require 'runfile/runfile_helper'
 require 'runfile/action'
 require 'runfile/runner'
 require 'runfile/dsl'
-require 'runfile/util'
-
-require 'runfile/extensions/exec'
+require 'runfile/exec'
+require 'runfile/deprecations'

data/lib/runfile/deprecations.rb

@@ -0,0 +1,14 @@
+module Runfile
+
+  # The Runfile::Exec module is derecated. It is kept here so that those
+  # who include it in the past will know what to do.
+  module Exec
+    def self.included(base)
+      say! "!txtred!Runfile::Exec is deprecated. You should change your Runfile:"
+      say! "!txtred!  1. There is no need to include Runfile::Exec, it is already included."
+      say! "!txtred!  2. Change any configuration from Runfile::Exec.pid_dir to Runfile.pid_dir"
+      abort
+    end
+  end
+
+end

data/lib/runfile/dsl.rb

@@ -2,59 +2,117 @@
 # All commands are immediately handed over to the Runner instance
 # for handling.
 
-# Smells of :reek:UtilityFunction
 module Runfile
   # Set the name of your Runfile program
+  #   name 'My Runfile'
   def name(name)
     Runner.instance.name = name
   end
 
   # Set the version of your Runfile program
+  #   version '0.1.0'
   def version(ver)
     Runner.instance.version = ver
   end
 
   # Set the one line summary of your Runfile program
+  #   summary 'Utilities for my server'
   def summary(text)
     Runner.instance.summary = text
   end
 
   # Set the usage pattern for the next action
+  #   usage 'server [--background]'
   def usage(text)
     Runner.instance.last_usage = text
   end
 
   # Set the help message for the next action
+  #   help 'Starts the server in the foreground or background'
   def help(text)
     Runner.instance.last_help = text
   end
 
   # Add an option/flag to the next action (can be called multiple
   # times)
+  #   option '-b --background', 'Start in the background'
   def option(flag, text, scope=nil)
     Runner.instance.add_option flag, text, scope
   end
 
   # Set an example command (can be called multiple times)
+  #   example 'server --background'
   def example(text)
     Runner.instance.add_example text
   end
 
   # Define the action
+  #   action :server do |args|
+  #     run 'rails server'
+  #   end
   def action(name, altname=nil, &block) 
     Runner.instance.add_action name, altname, &block
   end
 
   # Define a new command namespace
+  #   command 'server'
+  #   # ... define actions here
+  #   endcommand
   def command(name=nil)
     Runner.instance.namespace = name
   end
 
   # Cross-call another action
+  #   call 'other_action'
   def call(command_string)
     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/{extensions/exec.rb → exec.rb}

@@ -1,23 +1,19 @@
-# This module 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.
+require 'singleton'
 
 module Runfile
-  module Exec
-    def self.pid_dir=(dir)
-      @@pid_dir = dir
-    end
 
-    def self.pid_dir
-      @@pid_dir
-    end
+  # 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
 
     # Run a command, wait until it is done and continue
     def run(cmd)
       cmd = @before_run_block.call(cmd) if @before_run_block
       return false unless cmd
-      say "!txtgrn!> #{cmd}"
+      say "!txtgrn!> #{cmd}" unless Runfile.quiet
       system cmd
       @after_run_block.call(cmd) if @after_run_block
     end
@@ -26,7 +22,7 @@ module Runfile
     def run!(cmd)
       cmd = @before_run_block.call(cmd) if @before_run_block
       return false unless cmd
-      say "!txtgrn!> #{cmd}"
+      say "!txtgrn!> #{cmd}" unless Runfile.quiet
       exec cmd
     end
 
@@ -36,7 +32,7 @@ module Runfile
       cmd = @before_run_block.call(cmd) if @before_run_block
       return false unless cmd
       full_cmd = "exec #{cmd} >#{log} 2>&1"
-      say "!txtgrn!> #{full_cmd}"
+      say "!txtgrn!> #{full_cmd}" unless Runfile.quiet
       process = IO.popen "exec #{cmd} >#{log} 2>&1"
       File.write pidfile(pid), process.pid if pid
       @after_run_block.call(cmd) if @after_run_block
@@ -52,7 +48,7 @@ module Runfile
         File.delete file
         run "kill -s TERM #{pid}"
       else
-        say "!txtred!PID file not found."
+        say "!txtred!PID file not found." unless Runfile.quiet
       end
     end
 
@@ -69,7 +65,7 @@ module Runfile
     private
 
     def pid_dir
-      defined?(@@pid_dir) ? @@pid_dir : nil
+      defined?(Runfile.pid_dir) ? Runfile.pid_dir : nil
     end
 
     def pidfile(pid)
@@ -77,5 +73,4 @@ module Runfile
     end
 
   end
-
-end
+end

data/lib/runfile/runfile_helper.rb

@@ -123,18 +123,16 @@ module Runfile
 
     # Output the list of available runfiles without filename
     def say_runfile_usage(runfiles)
-      namelist = runfiles.map {|f| /([^\/]+).runfile$/.match(f)[1] }
-      width = detect_terminal_size[0]
-      max = namelist.max_by(&:length).length
-      message = "  " + namelist.map {|f| f.ljust max+1 }.join(' ')
+      runfiles_as_columns = get_runfiles_as_columns runfiles
       
       say "#{settings.intro}\n" if settings.intro
       say "Usage: run <file>"
-      say word_wrap(message, width)
+      say runfiles_as_columns
 
       show_shortcuts if settings.shortcuts
     end
 
+    # Prints a friendly output of the shortcut list
     def show_shortcuts
       say "\nShortcuts:"
       max = settings.shortcuts.keys.max_by(&:length).length
@@ -143,5 +141,24 @@ module Runfile
       end
     end
 
+    # Returns the list of runfiles, organized as columns based on the
+    # current terminal width
+    def get_runfiles_as_columns(runfiles)
+      namelist = runfile_names runfiles
+      width = detect_terminal_size[0]
+      max = namelist.max_by(&:length).length
+      message = "  " + namelist.map {|f| f.ljust max+1 }.join(' ')
+      word_wrap message, width
+    end
+
+    def runfile_names(runfiles)
+      runfiles.map {|f| /([^\/]+).runfile$/.match(f)[1] }.sort
+    end
+
+    # Returns an array of path directories
+    def path_dirs
+      ENV['PATH'].split(File::PATH_SEPARATOR)
+    end
+
   end
 end

data/lib/runfile/setup.rb

@@ -0,0 +1,19 @@
+module Runfile
+  class << self
+    # Set the directory where PID files are stored when using `run_bg`
+    #   Runfile.pid_dir = 'tmp'
+    attr_accessor :pid_dir
+
+    # Disable echoing of the command when using `run` or `run!`
+    #   Runfile.quiet = true
+    attr_accessor :quiet
+
+    # You can also configure Runfile by providing a block:
+    #  Runfile.setup do |config|
+    #    config.quiet = true
+    #  end
+    def setup
+      yield self
+    end
+  end
+end

data/lib/runfile/version.rb

@@ -1,3 +1,3 @@
 module Runfile
-  VERSION = "0.6.4"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: runfile
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.7.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-21 00:00:00.000000000 Z
+date: 2016-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -122,14 +122,15 @@ files:
 - bin/run!
 - lib/runfile.rb
 - lib/runfile/action.rb
+- lib/runfile/deprecations.rb
 - lib/runfile/docopt_helper.rb
 - lib/runfile/dsl.rb
-- lib/runfile/extensions/exec.rb
+- lib/runfile/exec.rb
 - lib/runfile/runfile_helper.rb
 - lib/runfile/runner.rb
 - lib/runfile/settings.rb
+- lib/runfile/setup.rb
 - lib/runfile/templates/Runfile
-- lib/runfile/util.rb
 - lib/runfile/version.rb
 homepage: https://github.com/DannyBen/runfile
 licenses:

data/lib/runfile/util.rb

@@ -1,15 +0,0 @@
-# Utility methods
-module Runfile
-  # Debug print and exit
-  # Smells of :reek:UncommunicativeMethodName
-  def d(obj)
-    pp obj 
-    exit
-  end
-
-  # Return an array of path directories
-  # Smells of :reek:UtilityFunction
-  def path_dirs
-    ENV['PATH'].split(File::PATH_SEPARATOR)
-  end
-end