methodical 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Avdi Grimm
+
+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.rdoc

@@ -0,0 +1,17 @@
+= methodical
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Avdi Grimm. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "methodical"
+    gem.summary = %Q{Automation framework for sequential operations}
+    gem.description = %Q{Sorry, no description yet}
+    gem.email = "avdi@avdi.org"
+    gem.homepage = "http://github.com/avdi/methodical"
+    gem.authors = ["Avdi Grimm"]
+    gem.add_dependency "extlib", "~> 0.9.14"
+    gem.add_dependency "arrayfields", "~> 4.7"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "mocha", "~> 0.9.8"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.spec_files += FileList['test/**/*_test.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "methodical #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/methodical.rb

@@ -0,0 +1 @@
+require 'extlib'

data/lib/methodical/action_item.rb

@@ -0,0 +1,139 @@
+require 'forwardable'
+require 'methodical/disposition'
+require 'methodical/executable'
+
+module Methodical
+  class ActionItem
+    include Executable
+    extend Forwardable
+
+    attr_reader   :title
+    attr_reader   :error
+    attr_writer   :ignored
+    attr_reader   :disposition
+    attr_accessor :walkthrough
+
+    def_delegators :disposition, 
+                   :status, 
+                   :status=,
+                   :explanation,
+                   :explanation=,
+                   :result,
+                   :result=,
+                   :error,
+                   :error=,
+                   :details,
+                   :details=,
+                   :succeeded?,
+                   :failed?,
+                   :bad?,
+                   :done?,
+                   :halted?,
+                   :done_and_ok?
+
+    def initialize(title)
+      @title          = title
+      @ignored        = false
+      @disposition    = Disposition.new([:not_started, "", nil])
+      @raise_on_error = false
+    end
+
+    def to_s
+      synopsis
+    end
+
+    def synopsis
+      "#{title}: #{human_status}" + 
+        (explanation.blank? ? "." : " (#{explanation})#{ignored_suffix}.")
+    end
+
+    def inspect
+      "##<#{self.class.name}:#{title}:#{object_id}>"
+    end
+
+    def human_status
+      case status
+      when :failed, :abort                     then "Failed"
+      when :bad                                then "Error"
+      when :succeeded, :sufficient, :finish    then "OK"
+      when :in_progress                        then "In progress"
+      when :not_started                        then "Not started"
+      when :skipped                            then "Skipped"
+      else raise "Invalid status #{status.inspect}"
+      end
+    end
+
+    def ignored?
+      @ignored
+    end
+
+    def relevant?
+      !ignored?
+    end
+
+    def continue?
+      disposition.continuable?
+    end
+
+    def decisive?
+      !ignored? && disposition.decisive?
+    end
+
+    def update!(status, explanation, result, error=nil, details="")
+      self.status      = status
+      self.explanation = explanation
+      self.result      = result
+      self.error       = error
+      self.details     = details
+      disposition
+    end
+
+    # Disposition methods
+    def succeed!(explanation="", result=nil, details="")
+      throw(:methodical_disposition, 
+        Methodical::Disposition(:succeeded, explanation, result, nil, details))
+    end
+
+    def fail!(explanation="", result=nil, error=nil, details="")
+      throw(:methodical_disposition, 
+        Methodical::Disposition(:failed, explanation, result, error, details))
+    end
+
+    def skip!(explanation="", details="")
+      throw(:methodical_disposition, 
+        Methodical::Disposition(:skipped, explanation, nil, nil, details))
+    end
+
+    def checkpoint!(explanation="", memento=nil, details="")
+      throw(:methodical_disposition, 
+        Methodical::Disposition(:in_progress, explanation, memento, nil, details))
+    end
+
+    def sufficient!(explanation="", result=nil, details="")
+      throw(:methodical_disposition, 
+        Methodical::Disposition(:sufficient, explanation, result, nil, details))
+    end
+
+    def finish!(explanation="", result=nil, details="")
+      throw(:methodical_disposition, 
+        Methodical::Disposition(:finish, explanation, result, nil, details))
+    end
+
+    def abort!(explanation="", result=nil, error=nil, details="")
+      throw(:methodical_disposition, 
+        Methodical::Disposition(:abort, explanation, result, error, details))
+    end
+
+    protected
+    
+    private
+
+    def ignored_suffix
+      if ignored? && failed?
+        " (Ignored)"
+      else
+        ""
+      end
+    end
+  end
+end

data/lib/methodical/checklist.rb

@@ -0,0 +1,29 @@
+require 'delegate'
+require 'methodical/walkthrough'
+
+module Methodical
+  class Checklist < DelegateClass(Array)
+    attr_reader :title
+
+    def initialize(title)
+      @title = title
+      super([])
+    end
+
+    def new_walkthrough
+      Walkthrough.new(self)
+    end
+
+    def perform_walkthrough!(baton=nil, raise_on_error=false, &block)
+      walkthrough = new_walkthrough
+      walkthrough.perform!(baton, raise_on_error, &block)
+      walkthrough
+    end
+
+    def <<(object)
+      raise ArgumentError, "No nils allowed" if object.nil?
+      super(object)
+      object
+    end
+  end
+end

data/lib/methodical/disposition.rb

@@ -0,0 +1,132 @@
+require 'arrayfields'
+
+module Methodical
+  def self.Disposition(*args)
+    if args.size == 1
+      object = args.first
+      if Disposition === object
+        object
+      elsif object.kind_of?(Array)     && 
+          object.size >= 2             &&
+          object[0].kind_of?(Symbol)   &&
+          object[1].kind_of?(String)
+        Disposition.new(object)
+      else
+        Disposition.new([:succeeded, "", object])
+      end
+    else
+      Disposition.new(args)
+    end
+  end
+
+  Disposition = Array.struct :status, :explanation, :result, :error, :details
+
+  # A Disposition represents the status of an ActionItem (step)
+  #
+  # Explanation of statuses:
+  #
+  # * not_started: The action has not yet been performed
+  # * in_progress: The action has been started, and has not finished.
+  # * succeeded:   The action succeeded. If all actions succeed, the walkthrough
+  #                is considered a success.
+  # * failed:      The action failed. The walkthrough will fail unless the
+  #                "ignored" flag was set; but the walkthrough will not be
+  #                halted.
+  # * sufficient:  The action succeeded. Later steps will be executed, but
+  #                the walkthrough will be a success even if there are later
+  #                failures.
+  # * finish:      The action succeeded.  No more steps will be performed.
+  # * abort:       The action failed, and no more steps will be performed.
+  # * bad:         An error occured outside of the range of any expected failure
+  #                modes. The walkthrough will continue, but will be marked as
+  #                failed.
+  # * skipped:     The action was skipped. The "explanation" field should
+  #                contain the reason for skipping the action.
+  class Disposition
+    VALID_STATUSES = [
+      :not_started,
+      :in_progress,
+      :succeeded,
+      :failed,
+      :sufficient,
+      :finish,
+      :abort,
+      :bad,
+      :skipped
+    ]
+
+    alias_method :base_initialize, :initialize
+    def initialize(*args)
+      base_initialize(*args)
+      self.details ||= ""
+      validate!
+    end
+
+    alias_method :memento, :result
+    alias_method :memento=, :result=
+
+    def ok?
+      !failed?
+    end
+
+    def failed?
+      [:failed, :bad, :abort].include?(status)
+    end
+
+    def succeeded?
+      [:succeeded, :sufficient, :finish].include?(status)
+    end
+
+    def bad?
+      status == :bad
+    end
+
+    def skipped?
+      status == :skipped
+    end
+
+    def done?
+      succeeded? || failed? || skipped?
+    end
+
+    def continuable?
+      !halted?
+    end
+
+    def halted?
+      status == :abort || status == :finish
+    end
+
+    def decisive?
+      [:sufficient, :finish, :failed, :bad, :abort].include?(status)
+    end
+
+    def done_and_ok?
+      done? && ok?
+    end
+
+    def merge(params)
+      params.inject(self.class.new(self)) {|d, (k,v)| d[k] = v; d}
+    end
+
+    private
+
+    def validate!
+      unless VALID_STATUSES.include?(status)
+        raise ArgumentError, "Invalid status #{status.inspect}" 
+      end
+      unless explanation.kind_of?(String)
+        raise ArgumentError, "Explanation must be a String"
+      end
+      if result.kind_of?(Exception)
+        raise ArgumentError, "Result must not be an Exception"
+      end
+      if error && !error.kind_of?(Exception)
+        raise ArgumentError, "Error must be an Exception"
+      end
+      unless details.kind_of?(String)
+        raise ArgumentError, "Details must be a String"
+      end
+    end
+  end
+end

data/lib/methodical/dsl.rb

@@ -0,0 +1,111 @@
+require 'methodical/simple_action_item'
+require 'methodical/modifier'
+
+module Methodical
+  module DSL
+    def action(title, &block)
+      SimpleActionItem.new(title, &block)
+    end
+
+    def sufficient
+      Modifier.new("Sufficient") do |action_item, baton|
+        disposition = action_item.execute!(baton)
+        if(disposition.status == :succeeded)
+          disposition.merge(:status => :sufficient)
+        else
+          disposition
+        end
+      end
+    end
+
+    def requisite
+      Modifier.new("Requisite") do |action_item, baton|
+        disposition = action_item.execute!(baton)
+        if(disposition.failed?)
+          disposition.merge(:status => :abort)
+        else
+          disposition
+        end
+      end
+    end
+
+    def skip_if(reason, &block)
+      Modifier.new("Skip if #{reason}") do |action_item, baton|
+        if block.call(baton, action_item)
+          action_item.skip!(reason)
+        else
+          action_item.call(baton, action_item)
+        end
+      end
+    end
+
+    def handle_error(error_type, &block)
+      Modifier.new("Handle error #{error_type}") do |action_item, baton|
+        begin
+          action_item.execute!(baton, true)
+        rescue error_type => error
+          block.call(baton, action_item, error)
+        end
+      end
+    end
+
+    def recover_failure
+      Modifier.new("Recover from failure") do |action_item, baton|
+        disposition = action_item.execute!(baton)
+        if disposition.status == :failed
+          yield(baton, action_item, disposition)
+        end
+      end
+    end
+
+    def ignore
+      Modifier.new("Ignore failures") do |action_item, baton|
+        action_item.ignored=true
+        action_item.call(baton, action_item)
+      end
+    end
+
+    # Filter and optionally modify step disposition
+    def filter(&block)
+      Modifier.new("Filter disposition") do |action_item, baton|
+        block.call(action_item.execute!(baton))
+      end
+    end
+
+    # TODO Factor this out into its own class, it's a bit big
+    # TODO we may want to roll this functionality into the core Checklist. It
+    # would be nice if a retried action would actually show up in the log, e.g.:
+    # 8. Do some work (Failed; Retrying)
+    # 8. Do some work (Succeeded)
+    def retry_on_failure(
+        times_to_retry=1, time_limit_in_seconds=:none, options={})
+      max_tries = times_to_retry.to_i + 1
+      clock = options.fetch(:clock) { Time }
+      cutoff_time = if time_limit_in_seconds == :none 
+                      :none
+                    else
+                      clock.now + time_limit_in_seconds
+                    end
+      description = 
+        "Retry #{times_to_retry} times"
+      unless time_limit_in_seconds == :none
+        description << " or #{time_limit_in_seconds} seconds"
+      end
+      Modifier.new(description) do 
+        |action_item, baton|
+        tries = 0
+        begin
+          disposition = action_item.execute!(baton)
+          tries += 1
+          if disposition.failed? && 
+              (cutoff_time != :none) && 
+              (clock.now >= cutoff_time)
+            break
+          end
+        end until disposition.succeeded? || tries >= max_tries
+        disposition
+      end
+    end
+
+  end
+end