runfile 0.12.0.pre.rc1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ee58eaa893425817219f8fa94a2e96a7789363dc3082f3f8c520130357199e6
-  data.tar.gz: 607dc6702aeb3b9ec09f71c88c32292c98f3a0b7c1c6dfefbfbdb1cec02e5738
+  metadata.gz: 79a1c61423d09207b687d93f98035c5ca6b5e9d36f7b4acc12d93ccaa817c873
+  data.tar.gz: 0d870a0f93a9add25113e8030a02ce99dd2ecb0ed8f42d5eddb69b520b998da0
 SHA512:
-  metadata.gz: be7893890fc0075e964c49bf3aea294b6337bf5440f0ccea2d56a223439fa7eaa5128cad2d9e8bff57798d77ec55b5c686f10acc7726f2d7b9de6f74d55ca4b7
-  data.tar.gz: b0e1b8aa6a11d96433c8bbcf09d92d3838ff6a7e1959b34542b16286d5248a76d0bf6f83fedb8f6520fe880d60450b65c72a052dcc79e79d4e292972de6b5ba4
+  metadata.gz: 387383e744bac9dbd8ab89598df2a3217a4fa58f120b60ab7c31bbbfec074ae3fee0512cdee002b740af3aa85a6cd930ddfeefbe1d14deec182ebf77d57c8ab6
+  data.tar.gz: ca1b2962b157454842a0050cd3bf70826509362e7b18b9ebd2c1cc863480b0ac7f7556ad9e4fed27bad22b9c11238cf6b063e57e8b1d0459607fdb791c4ea1ae

data/README.md

@@ -84,6 +84,19 @@ Options:
 - [User Guide](https://runfile.dannyb.co/)
 - [Learn by Example](https://github.com/DannyBen/runfile/tree/master/examples#readme)
 
+## Breaking changes in 0.12.0
+
+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.
+
+For convenience, you can simply `require runfile/compatibility` at the top of 
+your Runfile, to still have this functionality included.
+
+More info and alternative solutions in
+[this pull request](https://github.com/DannyBen/runfile/pull/46).
+
 ## Contributing / Support
 
 If you experience any issue, have a question or a suggestion, or if you wish

data/lib/runfile/compatibility.rb

@@ -0,0 +1,84 @@
+# 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
+  module Compatibilty
+    include Colsole
+
+    # 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}" unless Runfile.quiet
+      system cmd
+      @after_run_block.call(cmd) if @after_run_block
+    end
+
+    # Run a command, wait until it is done, then exit
+    def run!(cmd)
+      cmd = @before_run_block.call(cmd) if @before_run_block
+      return false unless cmd
+      say "!txtgrn!> #{cmd}" unless Runfile.quiet
+      exec cmd
+    end
+
+    # Run a command in the background, optionally log to a log file and save
+    # the process ID in a pid file
+    def run_bg(cmd, pid: nil, log: '/dev/null')
+      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}" 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
+      return process.pid
+    end
+
+    # Stop a command started with 'run_bg'. Provide the name of he pid file you 
+    # used in 'run_bg'
+    def stop_bg(pid)
+      file = pidfile(pid)
+      if File.exist? file
+        pid = File.read file
+        File.delete file
+        run "kill -s TERM #{pid}"
+      else
+        say "!txtred!PID file not found." unless Runfile.quiet
+      end
+    end
+
+    # Set a block to be called before each run
+    def before_run(&block)
+      @before_run_block = block
+    end
+
+    # Set a block to be called after each run
+    def after_run(&block)
+      @after_run_block = block
+    end
+
+  private
+
+    def pid_dir
+      defined?(Runfile.pid_dir) ? Runfile.pid_dir : nil
+    end
+
+    def pidfile(pid)
+      pid_dir ? "#{pid_dir}/#{pid}.pid" : "#{pid}.pid"
+    end
+
+  end
+end
+
+include Runfile::Compatibilty

data/lib/runfile/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: runfile
 version: !ruby/object:Gem::Version
-  version: 0.12.0.pre.rc1
+  version: 0.12.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-28 00:00:00.000000000 Z
+date: 2021-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt
@@ -38,6 +38,7 @@ 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/refinements.rb
@@ -67,9 +68,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.2.25
 signing_key: