jongleur 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: feb44b1b1d4fdf30c64468be9a1ed02f8e025b8d
-  data.tar.gz: 548f9205697c18e50b70e0e937f3128f27b2c60d
+  metadata.gz: 07160e415a435e146c2b162340f0bacef4f3fb27
+  data.tar.gz: 8205d5c8ea466a6e9b1e89d4cc03a5d2f2aba548
 SHA512:
-  metadata.gz: 456f360b97b6fbef6672ab2d3f241e63a870228dd43faf0d747f7b5db7df4bd587256756a488f35a89fdc779ce63b3070baae4a4bf72b17bc20b9ca8568cd9b1
-  data.tar.gz: ede034243584f1b59b2e24ecd65650ebb7b5653c646856b35b26d9ba8008ab922127d82d2c9ffdbf9f4337e694e787fea21dc067206262f9e2dd84545e2fc439
+  metadata.gz: 9755c27900cda89b1a8c1a083d6fd05cf62f90ec1a5fd1ed796b57a35ef5049acb740984085c19e2e7feeca41f789fa4f67a1daea9574f99eef908e5a810ae66
+  data.tar.gz: 1dfc257b182634e4af25886e64fdc46986258d6739db8b5e27d0682db2b4f4989ef576eaedf3480fb7c86d574681220a3651b912e93ad5d7b3c13b093dad622a

data/.gitlab-ci.yml

@@ -1,4 +1,5 @@
 before_script:
+  - apt-get update -qq && apt-get install -y graphviz
   - ruby -v
   - which ruby
   - gem install bundler --no-ri --no-rdoc

data/CHANGELOG.md

@@ -4,3 +4,16 @@ All notable changes to this project will be documented in this file.
 
 ## [1.0.0] - 27-Aug-2018
 ### Initial Release.
+
+## [1.0.1] - 27-Aug-2018
+### Release management issues.
+
+## [1.0.2] - 27-Aug-2018
+### Release management issues.
+
+## [1.0.3] - 27-Aug-2018
+### Release management issues.
+
+## [1.0.4] - 20-Oct-2018
+### Added
+- bin/setup enhanced to install Graphviz dependency

data/README.md

@@ -135,74 +135,73 @@ Using Jongleur is easy:
 
 2. Define your Task Graph
 
-	```
-	test_graph = {
-      A: [:B, :C],
-      B: [:D],
-      C: [:D],
-      D: [:E],
-      E: []
-    }
-	```
+
+		test_graph = {
+	      A: [:B, :C],
+	      B: [:D],
+	      C: [:D],
+	      D: [:E],
+	      E: []
+	    }
+
 
 3. Add your Task Graph to Jongleur
 		
-	```
-	API.add_task_graph test_graph
+
+		API.add_task_graph test_graph
+	
+		=> [#<struct Jongleur::Task name=:A, pid=-1, running=false, exit_status=nil, success_status=nil>,
+	 		#<struct Jongleur::Task name=:B, pid=-1, running=false, exit_status=nil, success_status=nil>,
+	 		#<struct Jongleur::Task name=:C, pid=-1, running=false, exit_status=nil, success_status=nil>,
+	 		#<struct Jongleur::Task name=:D, pid=-1, running=false, exit_status=nil, success_status=nil>,
+	 		#<struct Jongleur::Task name=:E, pid=-1, running=false, exit_status=nil, success_status=nil>]
+
 	
-	=> [#<struct Jongleur::Task name=:A, pid=-1, running=false, exit_status=nil, success_status=nil>,
- 		#<struct Jongleur::Task name=:B, pid=-1, running=false, exit_status=nil, success_status=nil>,
- 		#<struct Jongleur::Task name=:C, pid=-1, running=false, exit_status=nil, success_status=nil>,
- 		#<struct Jongleur::Task name=:D, pid=-1, running=false, exit_status=nil, success_status=nil>,
- 		#<struct Jongleur::Task name=:E, pid=-1, running=false, exit_status=nil, success_status=nil>]
-	```
 	Jongleur will show you the Task Matrix for your Task Graph with all attributes set at their initial values, obviously, since the Tasks haven't ran yet.
 	
 4. (Optional) You may want to see a graphical representation of your Task Graph
-    
-    ```
-    API.print_graph('/tmp')
-    
-    => "/tmp/jongleur_graph_08252018_194828.pdf"
-    ```
+	    
+
+	    API.print_graph('/tmp')
+	    
+	    => "/tmp/jongleur_graph_08252018_194828.pdf"
+
 	Opening the PDF file will display this:
 	
 	<img src="./bin/img/DAG_graph_1.png"  width="225" height="450" alt="ETL DAG">
 	
 5. Implement your tasks. To do that you have to (i) create a new class, based on `WorkerTask` and (ii) define and `#execute` method in your class. This is the method hat Jongleur will call to run the Task. For instance task A from your Task Graph may look something like that:
    
-   ```
-   class A < Jongleur::WorkerTask
-  	  @desc = 'this is task A'
-  	  def execute
-       sleep 1
-       'A is running... '
-  	  end
-	end
-``` 	
-   You'll have to do the same for Tasks B, C, D and E, as these ae the tasks declared in the Task Graph.
+
+		   class A < Jongleur::WorkerTask
+		  	  @desc = 'this is task A'
+		  	  def execute
+		       sleep 1
+		       'A is running... '
+		  	  end
+			end
+
+	You'll have to do the same for Tasks B, C, D and E, as these ae the tasks declared in the Task Graph.
 
 6. Run the tasks. Ok, pay attention now because this is the complex bit. Nah, only joking - it's simply:
 
-   ```
-   API.run
-   
+		   $> API.run
+		   
+		  => Starting workflow...
+		  => starting task A
+		 => finished task: A, process: 2501, exit_status: 0, success: true
+		 => starting task B
+		 => starting task C
+		 => finished task: C, process: 2503, exit_status: 0, success: true
+		 => finished task: B, process: 2502, exit_status: 0, success: true
+		 => starting task D
+		 => finished task: D, process: 2505, exit_status: 0, success: true
+		 => starting task E
+		 => finished task: E, process: 2506, exit_status: 0, success: true
+		 => Workflow finished
+	  
    
-    => Starting workflow...
-	=> starting task A
- => finished task: A, process: 2501, exit_status: 0, success: true
- => starting task B
- => starting task C
- => finished task: C, process: 2503, exit_status: 0, success: true
- => finished task: B, process: 2502, exit_status: 0, success: true
- => starting task D
- => finished task: D, process: 2505, exit_status: 0, success: true
- => starting task E
- => finished task: E, process: 2506, exit_status: 0, success: true
- => Workflow finished
-   ``` 	
-   
-A __simple example__ of a client app fro Jongleur can be found [on GitLab](https://gitlab.com/RedFred7/jongleur-client)   
+A simple example of a client app for Jongleur can be found [on GitLab](https://gitlab.com/RedFred7/jongleur-client) 
 		
 ## Use-Cases
 ### Extract-Transform-Load
@@ -213,7 +212,7 @@ The ETL workflow is ideally suited to Jongleur.  You can define many Extraction
 ### Transactions
 Transactional workflows can be greatly sped up by Jongleur by parallelising parts of the transaction that are usually performed sequentially, i.e:
 
-<img src="./bin/img/transactional_DAG.png"  width="550" height="450" alt="Transaction DAG">		
+<img src="./bin/img/transactional_DAG.png"  width="550" height="450" alt="Transaction DAG">
 		
 ## Development
 
@@ -248,17 +247,14 @@ If a Task fails to run or to finish its run, Jongleur will simply go on running
 ### How can I examine the Task Matrix after Jongleur has finished?
 Jongleur serializes each run's Task Matrix as a JSON file in the `/tmp` directory. You can either view this in an editor or load it and manipulate it in Ruby with 
 
-```
-JSON.parse( File.read('/tmp/jongleur_task_matrix_08272018_103406.json') )
-```
+`JSON.parse( File.read('/tmp/jongleur_task_matrix_08272018_103406.json') )`
 
 
 ## Roadmap
 
 These are the things I'd like Jongleur to support in future releases:
 
-* Task storage mechanism, i.e. the ability for each Task to save data in a uniquely identifiable and safe way so that data can be shared between 
-  sequential tasks in a transparent and easy manner.
+* Task storage mechanism, i.e. the ability for each Task to save data in a uniquely identifiable and safe way so that data can be shared between sequential tasks in a transparent and easy manner.
 * Rails integration. Pretty self-explanatory really.
 
 ## Contributing

data/bin/setup

@@ -3,6 +3,19 @@ set -euo pipefail
 IFS=$'\n\t'
 set -vx
 
-bundle install
+unameOut="$(uname -s)"
+case "${unameOut}" in
+    Linux*)     machine=Linux;;
+    Darwin*)    machine=Mac;;
+    CYGWIN*)    machine=Cygwin;;
+    MINGW*)     machine=MinGw;;
+    *)          machine="UNKNOWN:${unameOut}"
+esac
+
+if [[ $machine == 'Linux' ]]; then
+  sudo apt-get install graphviz
+elif [[ $machine == 'Mac' ]]; then
+  brew cask install graphviz
+fi
 
-# Do any other automated setup that you need to do here
+bundle install

data/exe/test_gem.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+echo "Hello World!"

data/jongleur.gemspec

@@ -28,7 +28,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry-byebug', '~> 3.4'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.58' 
+  spec.add_development_dependency 'rubocop', '~> 0.58'
   spec.add_development_dependency 'simplecov', '~> 0.9'
   spec.add_development_dependency 'yard', '~> 0.9'
+
+  spec.post_install_message = 'Before using Jongleur, please make sure your system has the Graphviz package installed!'
 end

data/lib/jongleur/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Jongleur
-  VERSION = '1.0.3'
+  VERSION = '1.0.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jongleur
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Fred Heath
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-27 00:00:00.000000000 Z
+date: 2018-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphviz
@@ -140,7 +140,8 @@ description: Launches, schedules and manages tasks represented in a DAG as multi
   processes
 email:
 - fred@bootstrap.me.uk
-executables: []
+executables:
+- test_gem.sh
 extensions: []
 extra_rdoc_files: []
 files:
@@ -159,6 +160,7 @@ files:
 - bin/img/jongleur_m-2015.jpg
 - bin/img/transactional_DAG.png
 - bin/setup
+- exe/test_gem.sh
 - jongleur.gemspec
 - lib/jongleur.rb
 - lib/jongleur/api.rb
@@ -170,7 +172,8 @@ homepage: https://gitlab.com/RedFred7/Jongleur
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: Before using Jongleur, please make sure your system has the
+  Graphviz package installed!
 rdoc_options: []
 require_paths:
 - lib