script 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 872a8cf06708366e28dddb15b4ce5329d886c179
-  data.tar.gz: 6d4f26cb5d7dd669933a9bd168d3060ae22488aa
+  metadata.gz: 5b3eebc0b8ffe63d808137cc772a49faa8dc9eac
+  data.tar.gz: f46549975e784a273bf327e195ea576fddd643af
 SHA512:
-  metadata.gz: 445cb6296d580a65ea6bc3e931c20fae66e134eeb5f2af47eadabf853ff9b94baed6df6d060f0b78c1d38412c797653548387b2f7b4f4d9ca02e3ed1a69333d8
-  data.tar.gz: a20c4b72f3598aa6825f888802d63fd042953ceb466710d0631aed951e47354b2f5a81c2511325898b3eee55e8186eff576e31a44ad9cef14d084191b9eb6fd9
+  metadata.gz: ee9167d56e4af31bcb123bb8456262511d67d2d303f462bfc661bd54eddd444749e1976fa4c5eed88b9aab7af5d41b909b1bfd918dfd152df258b416115c336b
+  data.tar.gz: 1fbce152e3984cc426f3cb6f3f890888b0a3542aa7e88a33367a4d13648fd69584a2cf767a9e74f0b4e9624aba5cffdbc3293e346e68674a963d00e1d87b76fe

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    script (0.0.2)
+    script (0.0.4)
       colorize
 
 GEM

data/README.md

@@ -1,11 +1,14 @@
-# Script<img width="40" align="left" src="https://cdn.codementor.io/assets/topic/category_header/ruby-on-rails-bc9ab2af8d92eb4e7eb3211d548a09ad.png"> 
+# Script[<img width="40" align="left" src="misc/ruby.png">](https://github.com/bmarkons/script#script)
+[![Build Status](https://semaphoreci.com/api/v1/bmarkons/script/branches/master/badge.svg)](https://semaphoreci.com/bmarkons/script)
+[![Gem Version](https://badge.fury.io/rb/script.svg)](https://badge.fury.io/rb/script)
 
-The Script is everything you need to make the most of Ruby, as fabulous scripting language.
+The Script is everything you need to make the most of Ruby - a fabulous scripting language. The one started with idea of having nicely formatted output, but ended up in much more...
 
 ###### Table of contents
 - [Setup](#setup)
 - [Usage](#usage)
   - [Steps](#steps)
+  - [Shareables](#shareables)
 - [Contributing](#contributing)
 - [License](#license)
 - [Code of Conduct](#code-of-conduct)
@@ -38,27 +41,21 @@ require "script"
 deploy = Script.new
 
 deploy.step("Setup tools") do
-
   `sudo apt-get install -y google-cloud-sdk kubectl`
   `gcloud auth activate-service-account $GCLOUD_SERVICE_ACCOUNT_NAME`
   `gcloud config set project dummy-project`
   `gcloud container clusters get-credentials default --zone us-east`
-  
 end
 
 deploy.step("Deploy docker image") do
-
   `docker pull dummy`
   `docker build --cache-from dummy -t dummy`
   `docker build -t scripter/script .`
   `docker push dummy`
-  
 end
 
 deploy.step("Deploy to Kubernetes cluster") do
-
   `kubectl apply -f k8s.yml --record`
-  
 end
 
 # Finally, run the script
@@ -66,7 +63,26 @@ end
 deploy.run
 ```
 
-The steps are run in order in which they are registered.
+The steps are run in order in which they are registered. The output from the script commands is nicely formatted and divided per steps:
+
+![output](https://i.imgur.com/a6F2iAh.png)
+
+In case of an exception in one of the steps, the execution of the script is aborted instantly.
+
+### Shareables
+
+In case you need to share data between steps, you can pass hash of shareables to the step block:
+
+```ruby
+script.step("Step 1") do |shareables|
+  shareables["environment"] = "production"
+end
+
+script.step("Step 2") do |shareables|
+  environment = shareables["environment"]
+  puts "Deploying on #{environment} environment"
+end
+```
 
 ## Contributing
 

data/lib/script.rb

@@ -6,6 +6,12 @@ require "script/output"
 require "colorize"
 
 class Script
+  def self.define
+    script = new
+    yield(script)
+    script.run
+  end
+
   def initialize
     @engine = Script::Engine.new
   end

data/lib/script/engine.rb

@@ -1,6 +1,7 @@
 class Script::Engine
   def initialize
     @steps = []
+    @shareables = {}
   end
 
   def steps
@@ -14,7 +15,7 @@ class Script::Engine
   def run
     @steps.each do |step|
       puts Script::Output.started(step)
-      step.run
+      step.run(@shareables)
       puts Script::Output.result(step)
 
       abort_run if step.result == :failed

data/lib/script/step.rb

@@ -4,8 +4,8 @@ class Script::Step
     @block = block
   end
 
-  def run
-    @block.call
+  def run(shareables)
+    @block.call(shareables)
     @result = :succeded
   rescue
     @result = :failed

data/lib/script/version.rb

@@ -1,3 +1,3 @@
 class Script
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/scripts/script.rb

@@ -2,17 +2,15 @@
 
 require "script"
 
-script = Script.new
+Script.define do |s|
+  s.step("step 1") do
+    puts "Step 1"
+    puts "Completed"
+    raise
+  end
 
-script.step("step 1") do
-  puts "Step 1"
-  puts "Completed"
-  raise
+  s.step("step 2") do
+    puts "Step 2"
+    puts "Completed"
+  end
 end
-
-script.step("step 2") do
-  puts "Step 2"
-  puts "Completed"
-end
-
-script.run

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: script
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - bmarkons
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-17 00:00:00.000000000 Z
+date: 2018-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -103,6 +103,7 @@ files:
 - lib/script/output.rb
 - lib/script/step.rb
 - lib/script/version.rb
+- misc/ruby.png
 - script.gemspec
 - scripts/gh-md-toc
 - scripts/script.rb
@@ -126,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: Ruby scripting