scripted 0.0.1

data/Rakefile

@@ -0,0 +1,39 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+Bundler.setup
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:cucumber)
+
+require 'scripted/rake_task'
+Scripted::RakeTask.new(:scripted)
+
+task :default => [:scripted]
+
+namespace :examples do
+
+  desc "Runs the websockets example (really cool)"
+  Scripted::RakeTask.new(:websockets) do
+    config_file "examples/websockets.rb"
+  end
+
+  desc "Runs the parallel example"
+  Scripted::RakeTask.new(:parallel) do
+    config_file "examples/parallel.rb"
+  end
+
+  desc "Runs the important example"
+  Scripted::RakeTask.new(:important) do
+    config_file "examples/important.rb"
+  end
+
+  desc "Runs the pride example"
+  Scripted::RakeTask.new(:pride) do
+    config_file "examples/pride.rb"
+  end
+
+end

data/bin/scripted

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+
+require 'scripted'
+require 'optparse'
+require 'set'
+
+config = Scripted.configure
+groups = Set.new
+
+parser = OptionParser.new do |opts|
+
+  opts.on_tail("-h", "--help", "Shows the available options") do
+    puts opts
+    exit
+  end
+
+  opts.on_tail("-v", "--version", "Shows the version") do
+    puts Scripted::VERSION
+    exit
+  end
+
+  opts.on("-r", "--require a,b", Array, "Which files should be loaded (defaults to `scripted.rb`)") do |file_names|
+    config.config_file(*file_names)
+  end
+
+  opts.on("-g", "--group a,b", Array, "Which groups to run (defaults to `:default`)") do |group_names|
+    groups += group_names
+  end
+
+  opts.on("-f", "--format name", "Specify a formatter (defaults to `default`)") do |formatter|
+    config.formatter formatter
+  end
+
+  opts.on("-o", "--out output", "Specify the output of the previously specified formatter") do |out|
+    config.out out
+  end
+
+  opts.on("-c", "--[no-]color", "Use color in formatters? (defaults to yes)") do |color|
+    config.color = color
+  end
+
+  opts.on("-I PATH", "Add a directory to your load path") do |load_path|
+    $LOAD_PATH.unshift(load_path)
+  end
+
+end
+
+begin
+  parser.parse!
+  config.with_default_config_file!
+  config.load_files
+rescue OptionParser::InvalidOption => error
+  puts error
+  puts ""
+  puts parser
+  exit 1
+rescue Scripted::ConfigurationError => error
+  puts "#{error} at #{error.backtrace.first}"
+  exit 1
+end
+
+begin
+  Scripted.run config, *groups
+rescue Scripted::RunningFailed => error
+  puts error
+  exit 1
+end

data/cucumber.yml

@@ -0,0 +1,3 @@
+default: --format Fivemat --strict --tags ~@wip --color
+wip: --format pretty --wip --tags @wip --color
+no-color: --format Fivemat --strict --tags ~@wip

data/examples/important.rb

@@ -0,0 +1,31 @@
+formatter :table
+formatter :announcer
+formatter :default
+
+run "an unimportant failing command" do
+  `false`
+  unimportant!
+end
+
+run "a normal command" do
+  `echo You should see this output`
+end
+
+run "an important failing command" do
+  `false`
+  important!
+end
+
+run "another normal command" do
+  `echo You should never see this`
+end
+
+run "a forced command" do
+  `true`
+  forced!
+end
+
+run "this runs because it failed" do
+  `true`
+  only_when_failed!
+end

data/examples/parallel.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+#
+# This example shows of parallel commands.
+#
+# The output should look something like:
+#
+#     ┌─────────┬─────────┬─────────┐
+#     │ Command │ Runtime │ Status  │
+#     ├─────────┼─────────┼─────────┤
+#     │ sleep 1 │  1.061s │ success │
+#     │ sleep 1 │  1.062s │ success │
+#     │ sleep 1 │  1.064s │ success │
+#     │ sleep 1 │  1.066s │ success │
+#     │ sleep 1 │  1.064s │ success │
+#     └─────────┴─────────┴─────────┘
+#       Total runtime: 2.307s
+#
+# To run: rake examples:parallel
+
+formatter :table
+
+parallel do
+  run "sleep 1"
+  run "sleep 1"
+end
+parallel do
+  run "sleep 1"
+  run "sleep 1"
+  run "sleep 1"
+end

data/examples/pride.rb

@@ -0,0 +1,37 @@
+# Taken from Minitest's Pride formatter
+# Meant as example of custom formatters
+
+require "scripted/formatters/blank"
+
+class Pride < Scripted::Formatters::Blank
+
+  PI_3 = Math::PI / 3
+
+  def initialize(*)
+    super
+    @index  = 0
+    @colors = (0...(6 * 7)).map { |n|
+      n *= 1.0 / 6
+      r  = (3 * Math.sin(n           ) + 3).to_i
+      g  = (3 * Math.sin(n + 2 * PI_3) + 3).to_i
+      b  = (3 * Math.sin(n + 4 * PI_3) + 3).to_i
+      36 * r + 6 * g + b + 16
+    }
+    @size   = @colors.size
+  end
+
+  def each_char(char, command)
+    print pride(char)
+  end
+
+  def pride(string)
+    color = @colors[@index % @size]
+    @index += 1
+    "\e[38;5;#{color}m#{string}\e[0m"
+  end
+end
+
+formatter Pride
+
+run "rspec --no-color"
+run "cucumber -p no-color"

data/examples/websockets.rb

@@ -0,0 +1,37 @@
+# This is an example of using the websockets formatter.
+#
+# The web application is made with Ember.js. Also, even though some commands
+# might run in parallel, their output will appear properly in the web view.
+#
+# To run this: rake examples:websockets
+
+dir = File.expand_path("../websockets", __FILE__)
+
+formatter :default
+formatter :table
+
+run "start server" do
+  `bundle exec thin -e production -R #{File.join(dir, "server.ru")} -p 9292 -d start`
+end
+
+# give the server some time to start
+run "sleep 1"
+
+# opens the web page with the ember.js app
+run "open client" do
+  `bundle exec launchy http://localhost:9292/`
+end
+
+# how unbelievable meta! :)
+run "scripted with websocket formatter" do
+  `bundle exec scripted -f websocket -o http://localhost:9292/faye`
+end
+
+# keep the connection open for just a bit longer
+run "sleep 1"
+
+# forcefully shut down, because websocket connections will cause a timeout anyway
+run "shutdown server" do
+  `bundle exec thin -f stop`
+  forced!
+end

data/examples/websockets/public/ansiparse.js

@@ -0,0 +1,156 @@
+// "Borrowed" from TravisCI. Love you guys!
+ansiparse = function (str) {
+  //
+  // I'm terrible at writing parsers.
+  //
+  var matchingControl = null,
+      matchingData = null,
+      matchingText = '',
+      ansiState = [],
+      result = [],
+      state = {};
+
+  //
+  // General workflow for this thing is:
+  // \033\[33mText
+  // |     |  |
+  // |     |  matchingText
+  // |     matchingData
+  // matchingControl
+  //
+  // In further steps we hope it's all going to be fine. It usually is.
+  //
+
+  for (var i = 0; i < str.length; i++) {
+    if (matchingControl != null) {
+      if (matchingControl == '\033' && str[i] == '\[') {
+        //
+        // We've matched full control code. Lets start matching formating data.
+        //
+
+        //
+        // "emit" matched text with correct state
+        //
+        if (matchingText) {
+          state.text = matchingText;
+          result.push(state);
+          state = {};
+          matchingText = "";
+        }
+
+        matchingControl = null;
+        matchingData = '';
+      }
+      else {
+        //
+        // We failed to match anything - most likely a bad control code. We
+        // go back to matching regular strings.
+        //
+        matchingText += matchingControl + str[i];
+        matchingControl = null;
+      }
+      continue;
+    }
+    else if (matchingData != null) {
+      if (str[i] == ';') {
+        //
+        // `;` separates many formatting codes, for example: `\033[33;43m`
+        // means that both `33` and `43` should be applied.
+        //
+        // TODO: this can be simplified by modifying state here.
+        //
+        ansiState.push(matchingData);
+        matchingData = '';
+      }
+      else if (str[i] == 'm') {
+        //
+        // `m` finished whole formatting code. We can proceed to matching
+        // formatted text.
+        //
+        ansiState.push(matchingData);
+        matchingData = null;
+        matchingText = '';
+
+        //
+        // Convert matched formatting data into user-friendly state object.
+        //
+        // TODO: DRY.
+        //
+        ansiState.forEach(function (ansiCode) {
+          if (ansiparse.foregroundColors[ansiCode]) {
+            state.foreground = ansiparse.foregroundColors[ansiCode];
+          }
+          else if (ansiparse.backgroundColors[ansiCode]) {
+            state.background = ansiparse.backgroundColors[ansiCode];
+          }
+          else if (ansiCode == 39) {
+            delete state.foreground;
+          }
+          else if (ansiCode == 49) {
+            delete state.background;
+          }
+          else if (ansiparse.styles[ansiCode]) {
+            state[ansiparse.styles[ansiCode]] = true;
+          }
+          else if (ansiCode == 22) {
+            state.bold = false;
+          }
+          else if (ansiCode == 23) {
+            state.italic = false;
+          }
+          else if (ansiCode == 24) {
+            state.underline = false;
+          }
+        });
+        ansiState = [];
+      }
+      else {
+        matchingData += str[i];
+      }
+      continue;
+    }
+
+    if (str[i] == '\033') {
+      matchingControl = str[i];
+
+    }
+    else {
+      matchingText += str[i];
+    }
+  }
+
+  if (matchingText) {
+    state.text = matchingText + (matchingControl ? matchingControl : '');
+    result.push(state);
+  }
+  return result;
+}
+
+ansiparse.foregroundColors = {
+  '30': 'black',
+  '31': 'red',
+  '32': 'green',
+  '33': 'yellow',
+  '34': 'blue',
+  '35': 'magenta',
+  '36': 'cyan',
+  '37': 'white',
+  '90': 'grey'
+};
+
+ansiparse.backgroundColors = {
+  '40': 'black',
+  '41': 'red',
+  '42': 'green',
+  '43': 'yellow',
+  '44': 'blue',
+  '45': 'magenta',
+  '46': 'cyan',
+  '47': 'white'
+};
+
+ansiparse.styles = {
+  '1': 'bold',
+  '3': 'italic',
+  '4': 'underline'
+};

data/examples/websockets/server.rb

@@ -0,0 +1,32 @@
+require 'sinatra'
+require 'coffee-script'
+require 'sass'
+
+Tilt.register Tilt::ERBTemplate, 'handlebars'
+
+helpers do
+  def handlebars(name)
+    partial = render :handlebars, :"_#{name}"
+    "<script type='text/x-handlebars'>#{partial}</script>"
+  end
+end
+
+error do
+  <<-HTML
+    <h1>HALP!</h1>
+    <p>The shit hit the fan in such a way that I don't know what to do.</p>
+    <p>The error message: #{request.env['sinatra.error'].message}</p>
+  HTML
+end
+
+get "/" do
+  erb :index
+end
+
+get '/app.js' do
+  coffee :app
+end
+
+get '/style.css' do
+  sass :style
+end

data/examples/websockets/server.ru

@@ -0,0 +1,10 @@
+require 'bundler/setup'
+Bundler.setup
+
+require File.expand_path("../server.rb", __FILE__)
+
+require 'faye'
+Faye::WebSocket.load_adapter 'thin'
+use Faye::RackAdapter, :mount => '/faye'
+
+run Sinatra::Application