grifork 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 051978666d0eb719ebe0d1fb7396767f2849b60b
-  data.tar.gz: d1db36aff5d670f124ab13dadfa8288347ed1998
+  metadata.gz: 140949f8595ff1cc52066e358268d58378b4274e
+  data.tar.gz: ffd353ed0b6ce568d9f8f598b55c6b92e1ebfce6
 SHA512:
-  metadata.gz: 728ccefbb4558dc6caccd3a8a1504a52ad19fd8627d993046a82003545d0ee812cd66285088b96a858013eac16db4b25257207eadf1d6a94d7fd49b735be692d
-  data.tar.gz: b61507b73b372ba673b1d4eb9a78c85efce6c49d7a4b1534723392ceca9e80b9274c67b926490c044849f91a6753f03dda902b6b1914440a44ce7ae518f1bd57
+  metadata.gz: 85dfb2017ae8dc051c23ca48fd8c179c3ec0c98b7c111fa8a49a1c7300ea87e87494e0d7a7950f0a51067c5a959c61ea9ca6ca1a987ef2db88ca7cf277392e11
+  data.tar.gz: 5c5cfe37f565437fba03aaddb48071319cd04c58c591e4b76499160facc167ef287081ad667a4403f92e81e085acc6b5f5a4ea75cbf30979740ef8dc745719f8

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.5.0 (2016/10/10)
+
+Features: (#4)
+
+- New DSL methods:
+  - `#prepare`, `#finish`: Initialize or teardown the whole build procedure
+  - `#prepare_remote`, `#finish_remote`: Initialize or teardown the procedure on
+    remote hosts in `:grifork` mode
+
 ## 0.4.0 (2016/10/9)
 
 Bug Fix: (#3)

data/example/Griforkfile.grifork

@@ -32,6 +32,12 @@ hosts ['web1.internal', 'web2.internal', '192.168.10.1', '192.168.10.2']
 # Available full Hash options are bellow:
 rsync delete: true, bwlimit: 4096, verbose: false, excludes: [], rsh: nil, dry_run: false
 
+# Prepare before running tasks on localhost
+prepare do
+  sh :echo, ['Prepare grifork mode.']
+  sh :mkdir, %w(-p path/to/tmp)
+end
+
 # Define task run on localhost
 local do
   sh :echo, %W(LOCAL: #{src} => #{dst})
@@ -39,6 +45,12 @@ local do
   rsync '/path/to/src/', '/path/to/dest/'
 end
 
+# Prepare in the beginning of grifork tasks on remote
+prepare_remote do
+  sh :echo, ['Prepare grifork on remote.']
+  sh %(cd path/to/app && bundle install)
+end
+
 # Define task run on remote hosts
 # NOTE: This task is run as "local" task on remote
 #  different from "remote" task in :standalone mode
@@ -48,3 +60,15 @@ remote do
   rsync '/path/to/src/', '/path/to/dest/'
 end
 
+# Closing tasks on remote
+finish_remote do
+  sh :echo, ['Finish grifork on remote.']
+  sh %(cd path/to/app && bundle clean)
+end
+
+# Closing tasks finally on localhost
+finish do
+  sh :echo, ['Finish grifork mode.']
+  sh :rm, %w(-rf path/to/tmp)
+end
+

data/example/Griforkfile.standalone

@@ -23,6 +23,12 @@ ssh user: 'someone', keys: ['path/to/identity_file'], passphrase: 'xxx'
 # Available full Hash options are bellow:
 rsync delete: true, bwlimit: 4096, verbose: false, excludes: [], rsh: nil, dry_run: false
 
+# Prepare before running tasks
+prepare do
+  sh :echo, ['Prepare standalone mode.']
+  sh :mkdir, %w(-p path/to/tmp)
+end
+
 # Define task run on localhost
 local do
   sh :echo, %W(LOCAL: #{src} => #{dst})
@@ -37,3 +43,9 @@ remote do
   rsync_remote '/path/to/src/', '/path/to/dest/'
 end
 
+# Closing tasks
+finish do
+  sh :echo, ['Finish standalone mode.']
+  sh :rm, %w(-rf path/to/tmp)
+end
+

data/lib/grifork.rb

@@ -17,7 +17,8 @@ class Grifork
   require_relative 'grifork/executor'
   require_relative 'grifork/mixin/executable'
   require_relative 'grifork/executor/grifork'
-  require_relative 'grifork/executor/task'
+  require_relative 'grifork/executor/carrier'
+  require_relative 'grifork/executor/local'
   require_relative 'grifork/dsl'
   require_relative 'grifork/cli'
   require_relative 'grifork/version'

data/lib/grifork/config.rb

@@ -1,6 +1,10 @@
 class Grifork::Config
-  attr_reader   :branches, :hosts, :log, :local_task, :remote_task, :grifork
-  attr_accessor :griforkfile, :dry_run
+  attrs = {
+    ro: %i(branches hosts log grifork local_task remote_task prepare_task finish_task),
+    rw: %i(griforkfile dry_run),
+  }
+  attr_reader   *attrs[:ro]
+  attr_accessor *attrs[:rw]
 
   def initialize(args)
     args.each do |key, val|

data/lib/grifork/dsl.rb

@@ -114,24 +114,59 @@ class Grifork::DSL
   end
 
   # Define tasks to execute at localhost
-  # @param &task [Proc] Codes to be executed by an object of {Grifork::Executor::Task}
+  # @param &task [Proc] Codes to be executed by an object of {Grifork::Executor::Carrier}
+  # @note In +:grifork+ mode, this is executed only at localhost
   def local(&task)
     return if @on_remote
-    config_set(:local_task, Grifork::Executor::Task.new(:local, &task))
+    config_set(:local_task, Grifork::Executor::Carrier.new(:local, &task))
   end
 
   # Define tasks to execute at remote host
-  # @param &task [Proc] Codes to be executed by an object of {Grifork::Executor::Task}
+  # @param &task [Proc] Codes to be executed by an object of {Grifork::Executor::Carrier}
   # @note In +:standalone+ mode, the task is executed at localhost actually.
   #  In +:grifork+ mode, it is executed at remote hosts via +grifork+ command on remote hosts
   def remote(&task)
     if @on_remote
-      config_set(:local_task, Grifork::Executor::Task.new(:local, &task))
+      config_set(:local_task, Grifork::Executor::Carrier.new(:local, &task))
     else
-      config_set(:remote_task, Grifork::Executor::Task.new(:remote, &task))
+      config_set(:remote_task, Grifork::Executor::Carrier.new(:remote, &task))
     end
   end
 
+  # Define tasks to execute at localhost before starting procedure
+  # @param &task [Proc] Codes to be executed by an object of {Grifork::Executor::Local}
+  # @note In +:grifork+ mode, this is executed only at localhost
+  def prepare(&task)
+    return if @on_remote
+    config_set(:prepare_task, Grifork::Executor::Local.new(:prepare, &task))
+  end
+
+  # Define tasks to execute at localhost in the end of procedure
+  # @param &task [Proc] Codes to be executed by an object of {Grifork::Executor::Local}
+  # @note In +:grifork+ mode, this is executed only at localhost
+  def finish(&task)
+    return if @on_remote
+    config_set(:finish_task, Grifork::Executor::Local.new(:finish, &task))
+  end
+
+  # Define tasks to execute at remote host which execute +grifork+ tasks in +:grifork+
+  # mode before starting its procedure
+  # @param &task [Proc] Codes to be executed by an object of {Grifork::Executor::Local}
+  # @note In +:standalone+ mode, this is never executed
+  def prepare_remote(&task)
+    return unless @on_remote
+    config_set(:prepare_task, Grifork::Executor::Local.new(:prepare, &task))
+  end
+
+  # Define tasks to execute at remote host which execute +grifork+ tasks in +:grifork+
+  # mode in the end of its procedure
+  # @param &task [Proc] Codes to be executed by an object of {Grifork::Executor::Local}
+  # @note In +:standalone+ mode, this is never executed
+  def finish_remote(&task)
+    return unless @on_remote
+    config_set(:finish_task, Grifork::Executor::Local.new(:finish, &task))
+  end
+
   private
 
   def config_set(key, value)

data/lib/grifork/executor/{task.rb → carrier.rb}

@@ -1,4 +1,4 @@
-class Grifork::Executor::Task
+class Grifork::Executor::Carrier
   include Grifork::Executable
 
   # Initialize with task

data/lib/grifork/executor/local.rb

@@ -0,0 +1,15 @@
+class Grifork::Executor::Local
+  include Grifork::Executable
+
+  # Initialize with task
+  # @param &task [Proc] task to execute
+  def initialize(type, &task)
+    @type = type
+    @task = task
+  end
+
+  # Run the task
+  def run
+    instance_eval(&@task)
+  end
+end

data/lib/grifork/graph.rb

@@ -29,6 +29,8 @@ class Grifork::Graph
 
   # Launch local and remote tasks through whole graph
   def launch_tasks
+    config.prepare_task.run if config.prepare_task
+
     # level = 1
     Parallel.map(root.children, config.parallel => root.children.size) do |node|
       logger.info("Run locally. localhost => #{node.host}")
@@ -36,10 +38,14 @@ class Grifork::Graph
     end
     # level in (2..depth)
     fork_remote_tasks(root.children)
+
+    config.finish_task.run if config.finish_task
   end
 
   # Run grifork command on child nodes recursively
   def grifork
+    config.prepare_task.run if config.prepare_task
+
     if root.children.size.zero?
       logger.debug("#{root} Reached leaf. Nothing to do.")
       return
@@ -53,6 +59,8 @@ class Grifork::Graph
       end
       Grifork::Executor::Grifork.new.run(child)
     end
+
+    config.finish_task.run if config.finish_task
   end
 
   # Print graph structure for debug usage

data/lib/grifork/version.rb

@@ -1,3 +1,3 @@
 class Grifork
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grifork
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - key-amb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-08 00:00:00.000000000 Z
+date: 2016-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -134,8 +134,9 @@ files:
 - lib/grifork/config.rb
 - lib/grifork/dsl.rb
 - lib/grifork/executor.rb
+- lib/grifork/executor/carrier.rb
 - lib/grifork/executor/grifork.rb
-- lib/grifork/executor/task.rb
+- lib/grifork/executor/local.rb
 - lib/grifork/graph.rb
 - lib/grifork/graph/node.rb
 - lib/grifork/logger.rb