rake-multilogs 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64d4859313b42953886395d47fc659c685bcac240fcc1cdf7629152be7cfcca5
-  data.tar.gz: f7da7f6086547bb179bd5e1210b5d3f8ddb3fe8423855969aa8536b6b2412062
+  metadata.gz: b6f75135ee16d2687d59a5a8b7e4fd6f51e605641780e954616c1baacf43691f
+  data.tar.gz: 5d86280f61247d95e3f2404ad196c63b9895dc6be16103fa456f4dcd1098e8ca
 SHA512:
-  metadata.gz: 04f34a77107f34c4dce60865f260f8e154b3c805f719c67f4c496fbfd23cb3eadec8dd10ede8ee4d8c4f6cffdc545a2848127e7b950e5d6645abf8bb21ccead2
-  data.tar.gz: 07bb9c6bdafa949605454cb953b29d23d4e5edd3b6bf0befc63628afc3b72bd12d540b08725483d5dbe0231ca22c765dee8ef40d5a17040bc0a21718265e226c
+  metadata.gz: 9d9613373228fc4b73f4279285a081781fec14fd165a2fd6c5944e05364bcd8f0bf6c41f04bd64146291f7a410f17086a74e55436bb1a6e32e811decfc09b895
+  data.tar.gz: 808140c38fdd77cfd396811ada2ff2e2e376b899b817a1689692d2790c92e3b8ea2e82ab7f695778cd330703a50135c91a9ce7a7fa3dc9ef0208907443e36de0

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.2.0] - 2018-06-12
+### Added
+- `before_fork` and `after_fork` hooks
+
+
+## 0.1.0 - 2018-06-11
+### Added
+- A gem to group Rake multitask output by task
+
+
+[Unreleased]: https://github.com/haines/rake-multilogs/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/haines/rake-multilogs/compare/v0.1.0...v0.2.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rake-multilogs (0.1.0)
+    rake-multilogs (0.2.0)
       rake (~> 12.1)
 
 GEM

data/README.md

@@ -43,6 +43,23 @@ Add this line to your application's Rakefile:
 require "rake/multilogs"
 ```
 
+Your multitasks will now run concurrently in forked processes, with each task's output displayed after all tasks have completed.
+
+The use of forking rather than the default threading implementation means that database connections and other resources need to be handled carefully.
+You need to make sure each forked process has its own connection by using the `before_fork` and `after_fork` hooks.
+
+For example, with Active Record, you can put the following config in your Rakefile:
+
+```ruby
+Rake::Multilogs.before_fork do
+  ActiveRecord::Base.connection.disconnect!
+end
+
+Rake::Multilogs.after_fork do
+  ActiveRecord::Base.establish_connection
+end
+```
+
 
 ## Development
 

data/Rakefile

@@ -13,6 +13,7 @@ RuboCop::RakeTask.new
 
 desc "Generate documentation"
 YARD::Rake::YardocTask.new :doc
+CLEAN << ".yardoc/"
 CLOBBER << "doc/"
 
 task :default => [:doc, :rubocop, :test]

data/lib/rake/multilogs.rb

@@ -14,6 +14,49 @@ module Rake
   #
   # This requires `Process.fork`, so is not supported on JRuby or Windows.
   module Multilogs
+    class << self
+      # Register a block to be called from the multitask before running its
+      # prerequisites. This is called from the parent process before forking,
+      # and will receive the multitask as a parameter.
+      #
+      # @example Handling database connections with Active Record
+      #   Rake::Multilogs.before_fork do
+      #     ActiveRecord::Base.connection.disconnect!
+      #   end
+      #
+      # @param block [#to_proc] the block to call (must accept zero or one parameters)
+      # @return [void]
+      def before_fork(&block)
+        @before_fork = block
+      end
+
+      # Register a block to be called before executing a task. This is called
+      # from the child processes after forking, and from the parent process
+      # after the prerequisites have completed and the child processes have
+      # exited. In each case it will receive the task that is about to execute
+      # as a parameter.
+      #
+      # @example Handling database connections with Active Record
+      #   Rake::Multilogs.after_fork do
+      #     ActiveRecord::Base.establish_connection
+      #   end
+      #
+      # @param block [#to_proc] the block to call (must accept zero or one parameters)
+      # @return [void]
+      def after_fork(&block)
+        @after_fork = block
+      end
+
+      # @private
+      def call_before_fork(task)
+        @before_fork&.call(task)
+      end
+
+      # @private
+      def call_after_fork(task)
+        @after_fork&.call(task)
+      end
+    end
   end
 end
 

data/lib/rake/multilogs/fork.rb

@@ -41,6 +41,7 @@ module Rake
         end
 
         @task.application.standard_exception_handling do
+          Multilogs.call_after_fork @task
           @task.send :invoke_with_call_chain, @args, @invocation_chain
         end
       end

data/lib/rake/multilogs/task.rb

@@ -9,11 +9,15 @@ module Rake
       # task and displaying it when all tasks have completed.
       # @return [void]
       def invoke_prerequisites_concurrently(task_args, invocation_chain)
+        Multilogs.call_before_fork self
+
         Forks.new(
           tasks: prerequisite_tasks,
           args: task_args,
           invocation_chain: invocation_chain
         ).invoke
+
+        Multilogs.call_after_fork self
       end
     end
   end

data/lib/rake/multilogs/version.rb

@@ -3,6 +3,6 @@
 module Rake
   module Multilogs
     # Current version of the rake-multilogs gem.
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rake-multilogs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Haines
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-11 00:00:00.000000000 Z
+date: 2018-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -122,6 +122,7 @@ files:
 - ".ruby-version"
 - ".travis.yml"
 - ".yardopts"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock