scripted 0.0.1

data/examples/websockets/views/_client.handlebars

@@ -0,0 +1,47 @@
+<div class="container">
+  <div class="page-header">
+    {{#view Scripted.ConnectionStatusView}}{{content.message}}{{/view}}
+    <h1>Scripted <small>live command line output via websockets</small></h1>
+  </div>
+
+  {{#view Scripted.RunnerView}}{{message}}{{/view}}
+
+  {{#if Scripted.CommandsController.hasCommands}}
+    <table class="table table-striped table-bordered">
+      <thead>
+        <tr>
+          <th>Command</th>
+          <th>Runtime (s)</th>
+          <th>Status</th>
+        </tr>
+      </thead>
+      <tbody>
+        {{#each Scripted.CommandsController}}
+          {{#view Scripted.CommandView contentBinding="this"}}
+            <tr>
+              <td>{{content.name}}</td>
+              <td>{{content.roundedRuntime}}</td>
+              <td>{{#view Scripted.CommandStatusView contentBinding="content"}}{{text}}{{/view}}</td>
+            </tr>
+          {{/view}}
+        {{/each}}
+      </tbody>
+    </table>
+
+    {{#each Scripted.CommandsController}}
+      {{#view Scripted.CommandView contentBinding="this"}}
+        <h3>{{content.name}} {{#view Scripted.CommandStatusView contentBinding="content"}}{{text}}{{/view}}</h3>
+        {{#if hasOutput}}
+          <div class="output">
+            <pre>{{output}}</pre>
+          </div>
+        {{/if}}
+      {{/view}}
+    {{/each}}
+  {{else}}
+    <div class="well">
+      Run <tt>bundle exec scripted --format websocket --out http://localhost:9292/faye</tt> to start.
+    </div>
+  {{/if}}
+
+</div>

data/examples/websockets/views/app.coffee

@@ -0,0 +1,210 @@
+Scripted = Em.Application.create
+
+  received: (data) ->
+    action = @["on_#{data.action}"]
+    action(data) if action
+
+  on_start: (data) ->
+    Scripted.CommandsController.clear()
+    Scripted.Runner.setProperties(data.runner)
+    for command in data.commands
+      Scripted.updateCommand(command)
+
+  on_stop: (data) ->
+    Scripted.Runner.setProperties(data.runner)
+    for command in data.commands
+      Scripted.updateCommand(command)
+
+  on_execute: (data) ->
+    Scripted.updateCommand(data.command)
+
+  on_done: (data) ->
+    Scripted.updateCommand(data.command)
+
+  on_output: (data) ->
+    for output in data.output
+      command = Scripted.updateCommand(output.command).set('output', output.output)
+
+  updateCommand: (command) ->
+    Scripted.CommandsController.updateOrCreate(command)
+
+Scripted.ConnectionStatus = Em.Object.create
+
+  status: "error"
+  message: "No Connection"
+
+  success: ->
+    if @get('hasErrored')
+      window.location.reload()
+    @set 'status', 'success'
+    @set 'message', 'Connected'
+
+  error: (message) ->
+    @set 'status', 'error'
+    @set 'message', "Error: #{message}"
+    @set 'hasErrored', true
+
+
+
+Scripted.ConnectionStatusView = Em.View.extend
+
+  contentBinding: 'Scripted.ConnectionStatus'
+  tagName: 'span'
+  classNameBindings: ['default', 'status']
+
+  default: "pull-right label"
+
+  status: (->
+    switch @get('content').get('status')
+      when "success" then "label-success"
+      when "error" then "label-important"
+      else "label-warning"
+  ).property('content.status')
+
+
+
+Scripted.CommandStatusView = Em.View.extend
+
+  tagName: 'span'
+  classNameBindings: ['className']
+
+  text: (->
+    @get('content').get('human_status')
+  ).property('content.human_status')
+
+  className: (->
+    status_code = @get('content').get('status_code')
+    switch status_code
+      when "running"                                             then "label label-info"
+      when "success", "success_ran_because_other_command_failed" then "label label-success"
+      when "failed", "failed_ran_because_other_command_failed"   then "label label-important"
+      when "failed_but_ignored"                                  then "label label-warning"
+      when "failed_and_halted"                                   then "label label-inverse"
+      else "label"
+  ).property('content.status_code')
+
+Scripted.CommandView = Em.View.extend
+
+  classNameBindings: ['content.status_code']
+
+  output: (->
+    html = ""
+    output = @get('content').get('output')
+    nodes = ansiparse(output)
+    for node in nodes
+      html += "<span class='#{node.foreground}'>#{node.text}</span>"
+    new Handlebars.SafeString(html)
+  ).property('content.output')
+
+  hasOutput: (->
+    output = @get('content').get('output')
+    output and output != ""
+  ).property('content.output')
+
+  outputChanged: (->
+    output = this.$('.output')
+    scrollDown = -> output[0].scrollTop = output[0].scrollHeight + 100000
+    if output.length > 0
+      setTimeout scrollDown, 100
+      setTimeout scrollDown, 500
+  ).observes('output', 'content.status_code')
+
+Scripted.Runner = Em.Object.create
+
+  running: false
+  executed: false
+  started_at: null
+
+  roundedRuntime: (->
+    value = @get('runtime')
+    if value
+      value.toFixed(3)
+    else
+      ""
+  ).property('runtime')
+
+Scripted.RunnerView = Em.View.extend
+
+  contentBinding: 'Scripted.Runner'
+  classNameBindings: ["alert", "alertType"]
+
+  alert: (-> "alert").property()
+
+  message: (->
+    content = @get('content')
+    commandsCount = "<strong>#{Scripted.CommandsController.content.length}</strong>"
+    started_at = content.get('started_at')
+    text = if Scripted.CommandsController.get('hasCommands')
+      if not content.get('executed')
+        "Running #{commandsCount} commands"
+      else if content.get('failed')
+        "One or more commands have failed"
+      else
+        "Success! Ran #{commandsCount} commands in <strong>#{content.get('roundedRuntime')}</strong> seconds"
+    else
+      "There are <strong>no</strong> commands yet."
+    new Handlebars.SafeString(text)
+  ).property('content.started_at', 'content.failed', 'content.executed', 'content.roundedRuntime', 'Scripted.CommandsController.hasCommands')
+
+  alertType: (->
+    failed = @get('content').get('failed')
+    running = @get('content').get('running')
+    executed = @get('content').get('executed')
+    if failed
+      "alert-error"
+    else if running
+      "alert-info"
+    else if executed
+      "alert-success"
+    else
+      ""
+  ).property('content.failed', 'content.running', 'content.executed')
+
+Scripted.Command = Em.Object.extend
+
+  id: null
+  name: ""
+  status_code: "unknown"
+  output: ''
+
+  roundedRuntime: (->
+    value = @get('runtime')
+    if value
+      value.toFixed(3)
+    else
+      ""
+  ).property('runtime')
+
+Scripted.CommandsController = Em.ArrayController.create
+
+  content: []
+
+  updateOrCreate: (data) ->
+    command = @findCommand(data)
+    if command
+      command.setProperties(data)
+    else
+      command = Scripted.Command.create(data)
+      @pushObject(command)
+      command
+
+
+  findCommand: (data) ->
+    if @get('hasCommands')
+      @find((command) -> command.get('id') is data.id)
+    else
+      null
+
+  hasCommands: (->
+    @get('content').length > 0
+  ).property('lastObject')
+
+jQuery ->
+  client = new Faye.Client('http://localhost:9292/faye')
+  subscription = client.subscribe '/scripted', (data) -> Scripted.received(data)
+  subscription.callback -> Scripted.ConnectionStatus.success()
+  subscription.errback (error) -> Scripted.ConnectionStatus.error(error.message)
+  client.bind 'transport:down', -> Scripted.ConnectionStatus.error("No Connection")
+  client.bind 'transport:up', -> Scripted.ConnectionStatus.success()
+
+window.Scripted = Scripted

data/examples/websockets/views/index.erb

@@ -0,0 +1 @@
+<%= handlebars "client" %>

data/examples/websockets/views/layout.erb

@@ -0,0 +1,14 @@
+<!doctype html>
+<html>
+  <head>
+    <title>Websocket Client</title>
+    <script type="text/javascript" src="http://localhost:9292/faye/client.js"></script>
+    <script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js"></script>
+    <script type="text/javascript" src="http://cloud.github.com/downloads/emberjs/ember.js/ember-0.9.8.1.min.js"></script>
+    <script type="text/javascript" src="/ansiparse.js"></script>
+    <script type="text/javascript" src="/app.js"></script>
+    <link href="http://current.bootstrapcdn.com/bootstrap-v204/css/bootstrap-combined.min.css" rel="stylesheet">
+    <link href="/style.css" rel="stylesheet">
+  </head>
+  <body><%= yield %></body>
+</html>

data/examples/websockets/views/style.sass

@@ -0,0 +1,61 @@
+.black
+  color: #555555
+.red
+  color: #FF6C60
+.green
+  color: #99CC99
+.yellow
+  color: #FFFFB6
+.blue
+  color: #6699CC
+.magenta
+  color: #FF73FD
+.cyan
+  color: #C6C5FE
+.white
+  color: #F6F3E8
+.grey
+  color: #555555
+
+h2
+  margin: 10px 0
+
+pre
+  border: 0 none
+  background: black
+  color: #F6F3E8
+  font-family: "DejaVu Sans Mono", "Droid Sans Mono", "Menlo", "Monaco", "Courier New", monospace
+  font-size: 14px
+  margin: 0
+
+.output pre
+  vertical-align: bottom
+
+.output
+  font-size: 14px
+  max-height: 1000px
+  overflow-y: scroll
+  overflow-x: hidden
+
+.success .output
+  transition-duration: 0.5s
+  -moz-transition-duration: 0.5s
+  -webkit-transition-duration: 0.5s
+  -o-transition-duration: 0.5s
+  max-height: 100px
+
+h3 .label
+  vertical-align: 2px
+
+.cursor
+  background: #F6F3E8
+.prompt
+  color: #6699CC
+
+tt
+  background-color: #DDD
+  padding: 3px 6px
+  margin: 0 5px
+  -webkit-border-radius: 4px
+  -moz-border-radius: 4px
+  border-radius: 4px

data/features/controlling_exit_status.feature

@@ -0,0 +1,124 @@
+Feature: Controlling Exit Status
+
+  By default, Scripted will run all commands. If a command failed (e.g. if you
+  have failing tests) the entire run will be marked as failed. In Unix terms,
+  this means the exit code will be zero for successful runs and non-zero for
+  failed runs.
+
+  Sometimes it doesn't make sense to continue running commands if one failed,
+  like when an important setup command failed. If this is the case, you can
+  mark the command as important. If this commands fails, it will not run the
+  following commands.
+
+  Here RSpec won't run if the database cannot be created:
+
+  ``` ruby
+  run "create the database" do
+    rake "db:create"
+    important!
+  end
+
+  run "rspec"
+  ```
+
+  Sometimes you don't care if the command failed or not. The recommended
+  approach is to change the command itself so it does behave, but if you can't
+  do that, you can mark it with `unimportant!`.
+
+  ``` ruby
+  run "some command" do
+    unimportant!
+  end
+  ```
+
+  Sometimes a command can be very important to you. An example might be
+  shutting down daemons after a test run. You always want these commands to
+  run, even if your test suite failed. You can mark these with `forced!`
+
+  ``` ruby
+  run "stop xvfb" do
+    `/etc/init.d/xvfb`
+    forced!
+  end
+  ```
+
+  If the run did fail, you might want to do some extra work, like sending an
+  email. You can mark those with `only_when_failed!`.
+
+  ``` ruby
+  run "email" do
+    `mail -s Failure you@example.org`
+    only_when_failed!
+  end
+  ```
+
+
+  Scenario: Having failing commands
+    Given the configuration:
+    """
+    run "false"
+    run "echo this should still run"
+    """
+    When I run scripted
+    Then it should fail
+    And the output should contain "this should still run"
+
+  Scenario: A failing important command
+    Given the configuration:
+    """
+    run "false" do
+      important!
+    end
+    run "echo this command will not be run"
+    """
+    When I run scripted
+    Then it should fail
+    And the output should not contain "this command will not be run"
+
+  Scenario: Enforcing commands
+    Given the configuration:
+    """
+    run "false" do
+      important!
+    end
+    run "echo this command is forced" do
+      forced!
+    end
+    """
+    When I run scripted
+    Then it should fail
+    And the output should contain "this command is forced"
+
+  Scenario: A failing command that would otherwise have failed.
+    Given the configuration:
+    """
+    run "false" do
+      unimportant!
+    end
+    """
+    When I run scripted
+    Then it should pass
+
+  Scenario: Only when failed with a failing command
+    Given the configuration:
+    """
+    run "false"
+    run "echo only when failed has run" do
+      only_when_failed!
+    end
+    """
+    When I run scripted
+    Then it should fail
+    And the output should contain "only when failed has run"
+
+  Scenario: Only when failed when nothing failed
+    Given the configuration:
+    """
+    run "true"
+    run "echo only when failed has run" do
+      only_when_failed!
+    end
+    """
+    When I run scripted
+    Then it should pass
+    And the output should not contain "only when failed has run"