script 0.0.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b3eebc0b8ffe63d808137cc772a49faa8dc9eac
-  data.tar.gz: f46549975e784a273bf327e195ea576fddd643af
+  metadata.gz: f1399ac78e96bea7357b6e68477cf6ec9c379966
+  data.tar.gz: b6458f57445515f08e39e4bec1ed9a6ca41bcf51
 SHA512:
-  metadata.gz: ee9167d56e4af31bcb123bb8456262511d67d2d303f462bfc661bd54eddd444749e1976fa4c5eed88b9aab7af5d41b909b1bfd918dfd152df258b416115c336b
-  data.tar.gz: 1fbce152e3984cc426f3cb6f3f890888b0a3542aa7e88a33367a4d13648fd69584a2cf767a9e74f0b4e9624aba5cffdbc3293e346e68674a963d00e1d87b76fe
+  metadata.gz: ea4674a144d25c850401e77a3db238d0ac028f1f9f591f20e4626e54a164e8fc1b584f71b9ab84bf2a800405beb6daae3b7e41c8c601bc57dd0d1825c856246a
+  data.tar.gz: bafbaf00ab2d203846f5b2c064341b6443b9adebe444b712bf95c6306678a09a101457afe86b1c5a4e534cad4b0f321d274787f1449a95a6e0eceec27a78fdf7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    script (0.0.4)
+    script (1.0.0)
       colorize
 
 GEM
@@ -15,6 +15,8 @@ GEM
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
       rspec-mocks (~> 3.7.0)
+    rspec-autotest (1.0.0)
+      rspec-core (>= 2.99.0.beta1, < 4.0.0)
     rspec-core (3.7.0)
       rspec-support (~> 3.7.0)
     rspec-expectations (3.7.0)
@@ -29,10 +31,11 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler
   byebug
   rake (~> 10.0)
   rspec (~> 3.0)
+  rspec-autotest
   script!
 
 BUNDLED WITH

data/README.md

@@ -8,6 +8,7 @@ The Script is everything you need to make the most of Ruby - a fabulous scriptin
 - [Setup](#setup)
 - [Usage](#usage)
   - [Steps](#steps)
+  - [Output](#output)
   - [Shareables](#shareables)
 - [Contributing](#contributing)
 - [License](#license)
@@ -21,53 +22,75 @@ Install gem:
 gem install script
 ```
 
-And require it in your script file:
+Or add it as dependency to your Gemfile:
+
+```ruby
+gem 'script'
+```
+
+Then simply require it in your script file:
 
 ```
 require 'script'
 ```
 
+And you're good to go.
+
 ## Usage
 
 ### Steps
 
-Reason about the step as a logical group of commands. Lets take for instance, the deploy script which builds a docker image, pushes it to Dockerhub and eventually creates the deployment on Kubernetes.
+Steps encourages you to split commands into higher level constructs which are essential for more complex scripts. 
+
+Use Script to define the steps:
 
 ```ruby
-#!/usr/local/bin/ruby
+#!/usr/bin/env ruby
 
 require "script"
 
-deploy = Script.new
+Script.define do |s|
+  s.step("step 1") do
+    # Commands
+  end
 
-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`
+  s.step("step 2") do
+    # Commands
+  end
 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
+Once you've run the ruby script, it will execute each of the steps in the order they were defined.
 
-deploy.step("Deploy to Kubernetes cluster") do
-  `kubectl apply -f k8s.yml --record`
-end
+### Error handling
 
-# Finally, run the script
+In case of an error in one of the steps, the script is stopped right away without executing further steps.
 
-deploy.run
-```
+### Output
+
+Nicely formatted output is the primary motivation behind the Script. Most of the time you want to separate your commands output , in order to help investigation or debugging later.
 
-The steps are run in order in which they are registered. The output from the script commands is nicely formatted and divided per steps:
+Let's take for an example the following script:
 
-![output](https://i.imgur.com/a6F2iAh.png)
+```ruby
+#!/usr/bin/env ruby
+
+require "script"
 
-In case of an exception in one of the steps, the execution of the script is aborted instantly.
+Script.define do |s|
+  s.step("setup") do
+    system("bundle install") 
+  end
+
+  s.step("build") do
+    system("bundle exec rake spec")
+  end
+
+  s.step("deploy") do
+    system("gem push script-*")
+  end
+end
+```
 
 ### Shareables
 
@@ -75,12 +98,12 @@ In case you need to share data between steps, you can pass hash of shareables to
 
 ```ruby
 script.step("Step 1") do |shareables|
-  shareables["environment"] = "production"
+shareables["environment"] = "production"
 end
 
 script.step("Step 2") do |shareables|
-  environment = shareables["environment"]
-  puts "Deploying on #{environment} environment"
+environment = shareables["environment"]
+puts "Deploying on #{environment} environment"
 end
 ```
 

data/lib/script/version.rb

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

data/script.gemspec

@@ -23,8 +23,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "colorize"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "byebug"
+  spec.add_development_dependency "rspec-autotest"
 end

data/scripts/script.rb

@@ -3,14 +3,16 @@
 require "script"
 
 Script.define do |s|
-  s.step("step 1") do
-    puts "Step 1"
-    puts "Completed"
-    raise
-  end
+	s.step("setup") do
+		system("bundle install") 
+	end
 
-  s.step("step 2") do
-    puts "Step 2"
-    puts "Completed"
-  end
+	s.step("build") do
+		system("bundle exec rake spec")
+	end
+
+	s.step("deploy") do
+		system("gem push script-*")
+	end
 end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: script
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.0
 platform: ruby
 authors:
 - bmarkons
@@ -28,16 +28,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-autotest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Gives you a hand with composing neat Ruby scripts.
 email:
 - mamaveb@gmail.com