osc_machete_rails 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8fd50095c5fcd06e3563aaaed87004a06c9e76aa
+  data.tar.gz: c0b622235dee4361de6467d929f352d875905c24
+SHA512:
+  metadata.gz: 38d903278baf2add66f71037dbb192b15a65b75b019eb2f9ba080e2a110cb9d014d0b1c59aa0231ef048a0277211f919da9643b2763cf9994d0cbf63ac6477fc
+  data.tar.gz: 84231e28bb943ea11a0cbde8ca6325c0ac89ed6b0ec882ce7b5be6e3150a7a4591adf4a7a6a204e019eaf327449547a3d54ffea1b110ba53106f3a1f1a3f6b0b

data/CHANGELOG.md

@@ -0,0 +1,76 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+### Changed
+
+- remove `AwesimRails` as a dependency
+
+## [1.1.0] - 2016-03-03
+
+### Fixed
+
+- fix precompiling assets when a database is not available (which almost always happens when you go to share an app)
+
+### Changed
+
+- status_label view helper now accepts a second optional argument specifying the tag that wraps the label (defaults to span)
+- status_label view helper now adds the class `status_label` to the labels for easier customization of the labels
+
+## [1.0.1] - 2016-02-19
+
+### Fixed
+
+- Fix module used so Statusable.update_status_of_all_active_jobs is called on each request
+
+## 1.0.0 - 2016-02-03
+
+This release notes changes from existing files pulled out of osc-machete gem and
+added features and fixed defects that this gem introduces.
+
+### Fixed
+
+- `update_status!` on the `Job` models (models that include `OscMacheteRails::Statusable`) is called at beginning of each request instead of in the `after_find` hook, so you no longer need to preload to trigger the update (a big hangup we had earlier for each new developer)
+- even if you did preload for the `Job` models, superfluous sql calls were being made for each model - this was eliminated
+- with the latest version of torque new status values were causing problems with status display on simulations. Introducing the Status value object fixed this problem
+- proper error handling avoided various odd behavior that resulted if job submission failed
+
+### Added
+
+- Rails generators to scaffold a workflow
+- status_label helper to replace the one previously manually added or generated by Rails application template (this one handles Status values appropriately)
+- Initialization option: change OscMacheteRails.update_status_of_all_active_jobs_on_each_request to false if you want to disable the update of all active jobs on each request
+- workflow.rb: before_destroy we stop all of the jobs and if that succeeds we delete the staged directory if "staged_dir" exists on model that has a workflow
+- statusable.rb: Added Statusable#stop to allow qdel-ing the job. This could be used to implement a stop feature if you wanted to stop a simulation but keep from deleting the files it had created so far.
+
+
+### Changed
+
+workflow.rb (from v0.6.3 of osc-machete to latest osc_machete_rails)
+
+- in module OscMacheteRails instead of OSC::Machete::SimpleJob
+- handle errors when submitting jobs, logging the error and setting it on the model#errors object
+- if submitting a job fails, we delete the staged directory that was created during submission
+
+statusable.rb (from v0.6.3 of osc-machete to latest osc_machete_rails)
+
+- in module OscMacheteRails instead of OSC::Machete::SimpleJob
+- models that include Statutable no longer are updated via after_find hook. instead a new class method "update_status_of_all_active_jobs" is called to call `Statusable#update_status!` on each instance that is in an active state (running, queued, etc.). this is called at the beginning of each request via a before_action hook on the application controller.
+- update_status! handles PBS::Error's when checking the status, logs an error in the log and then leaves the model untouched
+- Statusable#status returns OSC::Machete::Status object instead of a character
+- Statusable#status= can accept a character, nil or an OSC::Machete::Status
+- Statusable#job= lets you set the attributes of an OSC::Machete::Job object to the Statusable model. Backwards compatibility supports saving the attributes script_name, job_path, and pbsid. New models produced by the generators use a job_cache column that stores a hash, and script, pbsid, and host are saved here instead.
+- setters `script_name=` and `job_path=` do not exist on models that are generated using the generators (models that have a job_cache column)
+
+
+
+### Removed
+
+
+[Unreleased]: https://github.com/AweSim-OSC/osc_machete_rails/compare/v1.1.0...master
+[1.1.0]: https://github.com/AweSim-OSC/osc_machete_rails/compare/v1.0.1...v1.1.0
+[1.0.1]: https://github.com/AweSim-OSC/osc_machete_rails/compare/v1.0.0...v1.0.1
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015-2016 Ohio Supercomputer Center
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,14 @@
+# OscMacheteRails
+
+Build and manage simulation workflows.
+
+## Installation
+
+To use, add this line to your application's Gemfile:
+
+    gem 'osc_machete_rails'
+
+And then execute:
+
+    $ bundle install
+

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'OscMacheteRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/osc_machete_rails/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/osc_machete_rails/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/osc_machete_rails/application_controller.rb

@@ -0,0 +1,4 @@
+module OscMacheteRails
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/osc_machete_rails/application_helper.rb

@@ -0,0 +1,4 @@
+module OscMacheteRails
+  module ApplicationHelper
+  end
+end

data/app/views/layouts/osc_machete_rails/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>OscMacheteRails</title>
+  <%= stylesheet_link_tag    "osc_machete_rails/application", media: "all" %>
+  <%= javascript_include_tag "osc_machete_rails/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+OscMacheteRails::Engine.routes.draw do
+end

data/lib/generators/active_record/job_model_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators/active_record/model/model_generator'
+require 'generators/active_record/orm_helpers'
+
+class ActiveRecord::JobModelGenerator < ActiveRecord::Generators::ModelGenerator
+  include ActiveRecord::OrmHelpers
+  source_root File.expand_path('../templates', __FILE__)
+
+  # overrides original ModelGenerator#create_model_file to make a job_model instead of a model
+  # since we are inheriting from ModelGenerator, we get the tests and all the other good stuff
+  def create_model_file
+    template 'job_model.rb', File.join('app/models', class_path, "#{file_name}.rb")
+  end
+end

data/lib/generators/active_record/orm_helpers.rb

@@ -0,0 +1,6 @@
+module ActiveRecord::OrmHelpers
+  private
+    def migration_template(source, destination, config = {})
+      super 'migration.rb', destination, config
+    end
+end

data/lib/generators/active_record/templates/job_model.rb

@@ -0,0 +1,17 @@
+<% module_namespacing do -%>
+class <%= class_name %> < <%= parent_class_name.classify %>
+  include OscMacheteRails::Statusable
+
+<% attributes.select(&:reference?).each do |attribute| -%>
+  belongs_to :<%= attribute.name %><%= ', polymorphic: true' if attribute.polymorphic? %>
+<% end -%>
+<% if attributes.any?(&:password_digest?) -%>
+  has_secure_password
+<% end -%>
+
+  # Determine if the results are valid
+  # def results_valid?
+  #   # CODE GOES HERE
+  # end
+end
+<% end -%>

data/lib/generators/active_record/templates/migration.rb

@@ -0,0 +1,19 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def change
+    create_table :<%= table_name %> do |t|
+<% attributes.each do |attribute| -%>
+<% if attribute.password_digest? -%>
+      t.string :password_digest<%= attribute.inject_options %>
+<% else -%>
+      t.<%= attribute.type %> :<%= attribute.name %><%= attribute.inject_options %>
+<% end -%>
+<% end -%>
+<% if options[:timestamps] %>
+      t.timestamps
+<% end -%>
+    end
+<% attributes_with_index.each do |attribute| -%>
+    add_index :<%= table_name %>, :<%= attribute.index_name %><%= attribute.inject_index_options %>
+<% end -%>
+  end
+end

data/lib/generators/active_record/templates/module.rb

@@ -0,0 +1,7 @@
+<% module_namespacing do -%>
+module <%= class_path.map(&:camelize).join('::') %>
+  def self.table_name_prefix
+    '<%= namespaced? ? namespaced_class_path.join('_') : class_path.join('_') %>_'
+  end
+end
+<% end -%>

data/lib/generators/active_record/templates/workflow_model.rb

@@ -0,0 +1,34 @@
+<% module_namespacing do -%>
+class <%= class_name %> < <%= parent_class_name.classify %>
+  has_many :<%= job.plural_name %>, dependent: :destroy
+  has_machete_workflow_of :<%= job.plural_name %>
+
+<% attributes.select(&:reference?).each do |attribute| -%>
+  belongs_to :<%= attribute.name %><%= ', polymorphic: true' if attribute.polymorphic? %>
+<% end -%>
+<% if attributes.any?(&:password_digest?) -%>
+  has_secure_password
+<% end -%>
+
+  # Name that defines the template/target dirs
+  def staging_template_name
+    "<%= file_name %>"
+  end
+
+  # Define tasks to do after staging template directory typically copy over
+  # uploaded files here
+  # def after_stage(staged_dir)
+  #   # CODE HERE
+  # end
+
+  # Build an array of Machete jobs that are then submitted to the batch server
+  def build_jobs(staged_dir, job_list = [])
+    job_list << OSC::Machete::Job.new(script: staged_dir.join("main.sh"))
+  end
+
+  # Make copy of workflow
+  def copy
+    self.dup
+  end
+end
+<% end -%>

data/lib/generators/active_record/workflow_model_generator.rb

@@ -0,0 +1,30 @@
+require 'rails/generators/active_record/model/model_generator'
+require 'generators/active_record/orm_helpers'
+require 'generators/osc_machete_rails/job_helpers'
+
+class ActiveRecord::WorkflowModelGenerator < ActiveRecord::Generators::ModelGenerator
+  include ActiveRecord::OrmHelpers
+  include OscMacheteRails::JobHelpers
+  source_root File.expand_path('../templates', __FILE__)
+
+  # add a new attribute to the generator
+  # the workflow needs to know what the job model is
+  # to render the template properly
+  attr_reader :job
+
+  # jobs is a new attribute type, like "references", so we can let the user specify the corresponding
+  # job model. This attribute is used in the workflow_model.rb template file. i.e.
+  #
+  #     rails g osc_machete_rails:workflow_model Container name:string container_job:jobs
+  #
+  def initialize(args, *options)
+    @job = parse_job!(args)
+    super
+  end
+
+  # overrides original ModelGenerator#create_model_file to make a workflow_model instead of a model
+  # since we are inheriting from ModelGenerator, we get the tests and all the other good stuff
+  def create_model_file
+    template 'workflow_model.rb', File.join('app/models', class_path, "#{file_name}.rb")
+  end
+end

data/lib/generators/osc_machete_rails/USAGE

@@ -0,0 +1,36 @@
+Description:
+    Scaffolds an entire workflow, from models and migrations to controller and
+    views, along with a full test suite. The resource is ready to use as a
+    starting point for your Workflow.
+
+    Pass the name of the workflow (in singular form), either CamelCased or
+    under_scored, as the first argument, and an optional list of attribute
+    pairs.
+
+    Attributes are field arguments specifying the model's attributes. You can
+    optionally pass the type and an index to each field. For instance:
+    "title body:text tracking_id:integer:uniq" will generate a title field of
+    string type, a body with text type and a tracking_id as an integer with an
+    unique index. "index" could also be given instead of "uniq" if one desires
+    a non unique index.
+
+    Timestamps are added by default, so you don't have to specify them by hand
+    as 'created_at:datetime updated_at:datetime'.
+
+    You don't have to think up every attribute up front, but it helps to
+    sketch out a few so you can start working with the resource immediately.
+
+    For example, 'osc_machete_rails:scaffold container name pressure:decimal'
+    gives you a workflow model with those two attributes, a workflow template,
+    a job model, a controller that handles the
+    create/show/update/destroy/submit/copy, forms to create and edit your
+    posts, and an index that lists them all, as well as a resources :containers
+    declaration in config/routes.rb.
+
+    If you want to remove all the generated files, run
+    'rails destroy osc_machete_rails:scaffold WorkflowName'.
+
+Examples:
+    `rails generate osc_machete_rails:scaffold structure`
+    `rails generate osc_machete_rails:scaffold fan name comments:text centrifugal:boolean`
+    `rails generate osc_machete_rails:scaffold heatsink material temperature:decimal`

data/lib/generators/osc_machete_rails/erb/erb_generator.rb

@@ -0,0 +1,5 @@
+require 'rails/generators/erb/scaffold/scaffold_generator'
+
+class OscMacheteRails::ErbGenerator < Erb::Generators::ScaffoldGenerator
+  source_root File.expand_path('../templates', __FILE__)
+end

data/lib/generators/osc_machete_rails/erb/templates/_form.html.erb

@@ -0,0 +1,21 @@
+<%%# Uses rails_bootstrap_form gem. API at: https://github.com/bootstrap-ruby/rails-bootstrap-forms %>
+<%%= bootstrap_form_for(<%= singular_table_name %>) do |f| %>
+  <%%= f.alert_message "Please fix the errors below." %>
+
+<% attributes.each do |attribute| -%>
+<% if attribute.password_digest? -%>
+  <%%= f.password_field :password %>
+  <%%= f.password_field :password_confirmation %>
+<% else -%>
+  <%%= f.<%= attribute.field_type %> :<%= attribute.column_name %> %>
+<% end -%>
+<% end -%>
+
+  <%%= f.submit 'Save', class: 'btn btn-primary' %>
+  <%%= f.button 'Reset', type: :reset, class: 'btn btn-default' %>
+
+  <hr>
+
+  <%%= link_to 'Back', <%= index_helper %>_path, class: 'btn btn-default' %>
+  <%%= link_to 'Show', <%= singular_table_name %>, class: 'btn btn-primary' unless <%= singular_table_name %>.new_record? %>
+<%% end %>

data/lib/generators/osc_machete_rails/erb/templates/edit.html.erb

@@ -0,0 +1,5 @@
+<div class="page-header">
+  <h2>Editing <%= singular_table_name.titleize %></h2>
+</div>
+
+<%%= render 'form', <%= singular_table_name %>: @<%= singular_table_name %> %>

data/lib/generators/osc_machete_rails/erb/templates/index.html.erb

@@ -0,0 +1,41 @@
+<div class="page-header">
+  <h2>Listing <%= plural_table_name.titleize %></h2>
+</div>
+
+<table class="table data-table">
+  <thead>
+    <tr>
+      <th>#</th>
+      <th>Status</th>
+<% attributes.reject(&:password_digest?).each do |attribute| -%>
+      <th><%= attribute.human_name %></th>
+<% end -%>
+      <th class="no-sort"></th>
+      <th class="no-sort"></th>
+      <th class="no-sort"></th>
+      <th class="no-sort"></th>
+      <th class="no-sort"></th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <%% @<%= plural_table_name %>.each do |<%= singular_table_name %>| %>
+      <tr>
+        <td><%%= <%= singular_table_name %>.id %></td>
+        <td><%%= status_label(<%= singular_table_name %>) %></td>
+<% attributes.reject(&:password_digest?).each do |attribute| -%>
+        <td><%%= <%= singular_table_name %>.<%= attribute.name %> %></td>
+<% end -%>
+        <td><%%= link_to 'Submit', submit_<%= singular_table_name %>_path(<%= singular_table_name %>), method: :put, class: 'btn btn-success btn-sm' unless <%= singular_table_name %>.submitted? %></td>
+        <td><%%= link_to 'Show', <%= singular_table_name %>, class: 'btn btn-primary btn-sm' %></td>
+        <td><%%= link_to 'Edit', edit_<%= singular_table_name %>_path(<%= singular_table_name %>), class: 'btn btn-default btn-sm' unless <%= singular_table_name %>.submitted? %></td>
+        <td><%%= link_to 'Copy', copy_<%= singular_table_name %>_path(<%= singular_table_name %>), method: :put, class: 'btn btn-default btn-sm' %></td>
+        <td><%%= link_to 'Destroy', <%= singular_table_name %>, method: :delete, class: 'btn btn-danger btn-sm', data: { confirm: 'Are you sure?' } %></td>
+      </tr>
+    <%% end %>
+  </tbody>
+</table>
+
+<br>
+
+<%%= link_to 'New <%= singular_table_name.titleize %>', new_<%= singular_table_name %>_path %>

data/lib/generators/osc_machete_rails/erb/templates/new.html.erb

@@ -0,0 +1,5 @@
+<div class="page-header">
+    <h2>New <%= singular_table_name.titleize %></h2>
+</div>
+
+<%%= render 'form', <%= singular_table_name %>: @<%= singular_table_name %> %>

data/lib/generators/osc_machete_rails/erb/templates/show.html.erb

@@ -0,0 +1,13 @@
+<div class="page-header">
+    <h2>Showing <%= singular_table_name.titleize %></h2>
+</div>
+
+<% attributes.reject(&:password_digest?).each do |attribute| -%>
+<p>
+  <strong><%= attribute.human_name %>:</strong>
+  <%%= @<%= singular_table_name %>.<%= attribute.name %> %>
+</p>
+
+<% end -%>
+<%%= link_to 'Back', <%= index_helper %>_path, class: 'btn btn-default' %>
+<%%= link_to 'Edit', edit_<%= singular_table_name %>_path(@<%= singular_table_name %>), class: 'btn btn-default' %>

data/lib/generators/osc_machete_rails/job_helpers.rb

@@ -0,0 +1,10 @@
+module OscMacheteRails::JobHelpers
+  private
+    def parse_job!(args)
+      jobs = args.grep(/:jobs$/)
+      args = args - jobs
+
+      job_attrib = jobs.first || "#{args.first.underscore}_job:jobs"
+      Rails::Generators::GeneratedAttribute.parse job_attrib
+    end
+end

data/lib/generators/osc_machete_rails/job_model/USAGE

@@ -0,0 +1,28 @@
+Description:
+    Stubs out a new job model. Pass the model name, either CamelCased or
+    under_scored, and an optional list of attribute pairs as arguments.
+
+    Attribute pairs are field:type arguments specifying the
+    model's attributes. Timestamps are added by default, so you don't have to
+    specify them by hand as 'created_at:datetime updated_at:datetime'.
+
+    You don't have to think up every attribute up front, but it helps to
+    sketch out a few so you can start working with the model immediately.
+
+    This generator invokes your configured ORM and test framework, which
+    defaults to ActiveRecord and TestUnit.
+
+Available field types:
+
+    For more information see:
+
+        `rails generate model --help`
+
+Example:
+    `rails generate osc_machete_rails:job_model ThingJob thing:references`
+
+        For ActiveRecord and TestUnit it creates:
+            Model:      app/models/thing_job.rb
+            Test:       test/models/thing_job_test.rb
+            Fixtures:   test/fixtures/thing_jobs.yml
+            Migration:  db/migrate/XXX_create_thing_jobs.rb

data/lib/generators/osc_machete_rails/job_model/job_model_generator.rb

@@ -0,0 +1,13 @@
+class OscMacheteRails::JobModelGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path("../templates", __FILE__)
+
+  def initialize(args, *options)
+    args |= %w(status:string)
+    args |= %w(job_cache:text)
+
+    super
+  end
+
+  argument :attributes, type: :array, default: [], banner: "field[:type][:index] field[:type][:index]"
+  hook_for :orm, required: true
+end

data/lib/generators/osc_machete_rails/resource_route/USAGE

@@ -0,0 +1,3 @@
+Description:
+    Create rails files for resource_route generator. Adds two Workflow specific
+    routes.

data/lib/generators/osc_machete_rails/resource_route/resource_route_generator.rb

@@ -0,0 +1,57 @@
+class OscMacheteRails::ResourceRouteGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+
+  # Properly nests namespaces passed into a generator
+  #
+  #   $ rails generate osc_machete_rails:workflow_route admin/users/products
+  #
+  # should give you
+  #
+  #   namespace :admin do
+  #     namespace :users
+  #       resources :products do
+  #         member do
+  #           put 'submit'
+  #           put 'copy'
+  #         end
+  #       end
+  #     end
+  #   end
+  def add_workflow_route
+    return if options[:actions].present?
+
+    # iterates over all namespaces and opens up blocks
+    regular_class_path.each_with_index do |namespace, index|
+      write("namespace :#{namespace} do", index + 1)
+    end
+
+    # inserts the primary resource
+    write("resources :#{file_name.pluralize} do", route_length + 1)
+    write("member do", route_length + 2)
+    write("put 'submit'", route_length + 3)
+    write("put 'copy'", route_length + 3)
+    write("end", route_length + 2)
+    write("end", route_length + 1)
+
+    # ends blocks
+    regular_class_path.each_index do |index|
+      write("end", route_length - index)
+    end
+
+    # route prepends two spaces onto the front of the string that is passed, this corrects that
+    route route_string[2..-1]
+  end
+
+  private
+    def route_string
+      @route_string ||= ""
+    end
+
+    def write(str, indent)
+      route_string << "#{"  " * indent}#{str}\n"
+    end
+
+    def route_length
+      regular_class_path.length
+    end
+end

data/lib/generators/osc_machete_rails/scaffold_controller/USAGE

@@ -0,0 +1,17 @@
+Description:
+    Stubs out a scaffolded controller, its seven RESTful actions + two Workflow
+    actions and related views. Pass the model name, either CamelCased or
+    under_scored. The controller name is retrieved as a pluralized version of
+    the model name.
+
+    This generates a controller class in app/controllers and invokes helper,
+    template engine and test framework generators.
+
+Example:
+    `rails generate osc_machete_rails:scaffold_controller Thing`
+
+    Thing controller with URLs like /thing/submit.
+        Controller: app/controllers/things_controller.rb
+        Test:       test/controllers/things_controller_test.rb
+        Views:      app/views/things/index.html.erb [...]
+        Helper:     app/helpers/things_helper.rb

data/lib/generators/osc_machete_rails/scaffold_controller/scaffold_controller_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators/rails/scaffold_controller/scaffold_controller_generator'
+require 'generators/osc_machete_rails/job_helpers'
+
+class OscMacheteRails::ScaffoldControllerGenerator < Rails::Generators::ScaffoldControllerGenerator
+  include OscMacheteRails::JobHelpers
+  source_root File.expand_path('../templates', __FILE__)
+
+  # attribute to know what the job model is - see comments on active_record/workflow_model_generator.rb
+  attr_reader :job
+
+  def initialize(args, *options)
+    @job = parse_job!(args)
+
+    super
+  end
+
+  # override ScaffoldControllerGenerator
+  # by recalling hook_for, the erb_generator will be searched for under OscMacheteRails
+  # (idiosyncracy of Thor)
+  #
+  # the default template engine is erb, so we provide specific erb_generator.rb and its templates
+  # see lib/generators/osc_machete_rails/erb for details
+  hook_for :template_engine
+end