state_machine-audit_trail 0.0.1

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+/.bundle
+Gemfile.lock
+pkg/*
+.DS_Store
+*.rbc
+/doc
+.yardoc

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in state_machine_logger.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jesse Storimer & Willem van Bergen
+
+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,37 @@
+= StateMachine audit trail
+
+The plugin for the state machine gem (see https://github.com/pluginaweek/state_machine) adds support for keeping an audit trail for any state machine. Having an audit trail gives you a complete history of the state changes in your model. This history allows you to investigate incidents or perform analytics, like: "How long does it take on average to go from state a to state b?", or "What percentage of cases goes from state a to b via state c?"
+
+Note: while the state_machine gem integrates with multiple ORMs, this plugin currently only has an ActiveRecord backend. It should be easy to add support for other ActiveModel-based ORMs though.
+
+== Usage
+
+First, make the gem available by adding it to your <tt>Gemfile</tt>, and run <tt>bundle install</tt>:
+
+  gem 'state_machine-audit_trail'
+    
+Create a model/table that holds the audit trail. The table needs to have a foreign key to the original object, am "event" field, a "from" state field, a "to" state field, and a "created_at" timestamp that stores the timestamp of the transition. This gem comes with a Rails 3 generator to create a model and a migration like that.
+
+  rails generate state_machine:audit_trail <model> <state_attribute>
+    
+For a model called "Model", and a state attribute "state", this will generate the ModelStateTransition model and an accompanying migration.
+
+Next, tell your state machine you want to keep an audit trail:
+
+  class Model < ActiveRecord::Base
+    state_machine :state, :initial => :start do
+      log_transitions
+      ...
+
+If your audit trail model does not use the default naming scheme, provide it using the <tt>:to</tt> option:
+
+  class Model < ActiveRecord::Base
+    state_machine :state, :initial => :start do
+      log_transitions :to => 'ModelAuditTrail'
+      ...
+
+That's it! The plugin will register an <tt>after_transition</tt> callback that is used to log all transitions. It will also log the initial state if there is one.
+
+== About
+
+This plugin is written by Jesse Storimer and Willem van Bergen for Shopify. It is released under the MIT license (see LICENSE)

data/Rakefile

@@ -0,0 +1,2 @@
+require File.expand_path('./tasks/github_gem', File.dirname(__FILE__))
+GithubGem::RakeTasks.new

data/lib/state_machine-audit_trail.rb

@@ -0,0 +1,2 @@
+# To keep Rails happy
+require 'state_machine/audit_trail'

data/lib/state_machine/audit_trail.rb

@@ -0,0 +1,21 @@
+require 'state_machine'
+
+module StateMachine::AuditTrail
+    
+  VERSION = "0.0.1"
+    
+  def self.setup
+    StateMachine::Machine.send(:include, StateMachine::AuditTrail::TransitionLogging)
+  end
+  
+  def self.create(transition_class)
+    return ActiveRecord.new(transition_class) if transition_class < ::ActiveRecord::Base
+    raise NotImplemented, "Only support for ActiveRecord is included at this time"
+  end
+end
+
+require 'state_machine/audit_trail/transition_logging'
+require 'state_machine/audit_trail/base'
+require 'state_machine/audit_trail/active_record'
+require 'state_machine/audit_trail/railtie' if defined?(::Rails)
+StateMachine::AuditTrail.setup

data/lib/state_machine/audit_trail/active_record.rb

@@ -0,0 +1,11 @@
+class StateMachine::AuditTrail::ActiveRecord < StateMachine::AuditTrail::Base
+  def log(object, event, from, to, timestamp = Time.now)
+    # Let ActiveRecord manage the timestamp for us so it does the 
+    # right thing width regards to timezones.
+    transition_class.create(foreign_key_field(object) => object.id, :event => event, :from => from, :to => to)
+  end
+
+  def foreign_key_field(object)
+    object.class.name.foreign_key.to_sym
+  end
+end

data/lib/state_machine/audit_trail/base.rb

@@ -0,0 +1,5 @@
+class StateMachine::AuditTrail::Base < Struct.new(:transition_class)
+  def log(object, event, from, to, timestamp = Time.now)
+    raise NotImplemented, "Implement in a subclass."
+  end
+end

data/lib/state_machine/audit_trail/railtie.rb

@@ -0,0 +1,5 @@
+class StateMachine::AuditTrail::Railtie < ::Rails::Railtie
+  generators do
+    require 'state_machine/audit_trail_generator'
+  end
+end

data/lib/state_machine/audit_trail/transition_logging.rb

@@ -0,0 +1,32 @@
+module StateMachine::AuditTrail::TransitionLogging
+  attr_accessor :transition_class_name
+
+  def log_transitions(options = {})
+    state_machine = self
+    state_machine.transition_class_name = (options[:to] || default_transition_class_name).to_s
+
+    state_machine.after_transition do |object, transition|
+      state_machine.audit_trail.log(object, transition.event, transition.from, transition.to)
+    end
+
+    state_machine.owner_class.after_create do |object|
+      if !object.send(state_machine.attribute).nil?
+        state_machine.audit_trail.log(object, nil, nil, object.send(state_machine.attribute))
+      end
+    end
+  end
+
+  def audit_trail
+    @transition_logger ||= StateMachine::AuditTrail.create(transition_class)
+  end
+
+  private
+
+  def transition_class
+    @transition_class ||= transition_class_name.constantize
+  end
+
+  def default_transition_class_name
+    "#{owner_class.name}#{attribute.to_s.camelize}Transition"
+  end
+end

data/lib/state_machine/audit_trail_generator.rb

@@ -0,0 +1,21 @@
+require 'rails/generators'
+
+class StateMachine::AuditTrailGenerator < ::Rails::Generators::Base
+  
+  source_root File.join(File.dirname(__FILE__), 'templates')
+  
+  argument :source_model
+  argument :state_attribute, :default => 'state'
+  argument :transition_model, :default => nil
+
+
+  def create_model
+    Rails::Generators.invoke('model', [transition_class_name, "#{source_model.tableize}:references", "event:string", "from:string", "to:string", "created_at:timestamp", '--no-timestamps'])
+  end
+  
+  protected
+  
+  def transition_class_name
+    transition_model || "#{source_model.camelize}#{state_attribute.camelize}Transition"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,92 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'rspec'
+require 'active_record'
+require 'state_machine/audit_trail'
+
+
+### Setup test database
+
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+
+ActiveRecord::Base.connection.create_table(:test_models) do |t|
+  t.string :state
+  t.timestamps
+end
+
+ActiveRecord::Base.connection.create_table(:test_model_with_multiple_state_machines) do |t|
+  t.string :first
+  t.string :second
+  t.timestamps
+end
+
+
+
+def create_transition_table(owner_class, state)
+  class_name = "#{owner_class.name}#{state.to_s.camelize}Transition"
+  
+  ActiveRecord::Base.connection.create_table(class_name.tableize) do |t|
+    t.integer owner_class.name.foreign_key
+    t.string :event
+    t.string :from
+    t.string :to
+    t.datetime :created_at
+  end
+end
+
+
+# We probably want to provide a generator for this model and the accompanying migration.
+class TestModelStateTransition < ActiveRecord::Base
+  belongs_to :test_model
+end
+
+class TestModelWithMultipleStateMachinesFirstTransition < ActiveRecord::Base
+  belongs_to :test_model
+end
+
+class TestModelWithMultipleStateMachinesSecondTransition < ActiveRecord::Base
+  belongs_to :test_model
+end
+
+
+class TestModel < ActiveRecord::Base
+
+  state_machine :state, :initial => :waiting do # log initial state?
+    log_transitions 
+
+    event :start do
+      transition [:waiting, :stopped] => :started
+    end
+    
+    event :stop do
+      transition :started => :stopped
+    end
+  end
+end
+
+class TestModelWithMultipleStateMachines < ActiveRecord::Base
+
+  state_machine :first, :initial => :beginning do
+    log_transitions 
+
+    event :begin_first do
+      transition :beginning => :end
+    end
+  end
+  
+  state_machine :second do
+    log_transitions 
+
+    event :begin_second do
+      transition nil => :beginning
+    end
+  end
+end
+
+create_transition_table(TestModel, :state)  
+create_transition_table(TestModelWithMultipleStateMachines, :first)  
+create_transition_table(TestModelWithMultipleStateMachines, :second)  
+
+RSpec.configure do |config|
+end

data/spec/state_machine/audit_trail_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe StateMachine::AuditTrail do
+  it "should have a VERSION constant" do
+    StateMachine::AuditTrail.const_defined?('VERSION').should be_true
+  end
+  
+  it "should log an event with all fields set correctly" do
+    m = TestModel.create!
+    m.start!
+    last_transition = TestModelStateTransition.where(:test_model_id => m.id).last
+
+    last_transition.event.should == 'start'
+    last_transition.from.should == 'waiting'
+    last_transition.to.should == 'started'
+    last_transition.created_at.should be_within(10.seconds).of(Time.now.utc)
+  end
+  
+  it "should log multiple events" do
+    m = TestModel.create!
+
+    lambda do
+      m.start
+      m.stop
+      m.start
+    end.should change(TestModelStateTransition, :count).by(3)
+  end
+  
+  it "should do nothing when the transition is not exectuted successfully" do
+    m = TestModel.create!
+    lambda { m.stop }.should_not change(TestModelStateTransition, :count)
+  end
+  
+  it "should log a state_machine specific event for the affected state machine" do
+    m = TestModelWithMultipleStateMachines.create!
+    lambda { m.begin_first! }.should change(TestModelWithMultipleStateMachinesFirstTransition, :count).by(1)
+  end
+
+  it "should not log a state_machine specific event for the unaffected state machine" do
+    m = TestModelWithMultipleStateMachines.create!
+    lambda { m.begin_first! }.should_not change(TestModelWithMultipleStateMachinesSecondTransition, :count)
+  end
+  
+  it "should log a transition for the inital state" do
+    lambda { TestModelWithMultipleStateMachines.create! }.should change(TestModelWithMultipleStateMachinesFirstTransition, :count).by(1)
+  end
+  
+  it "should only log the :to state for an initial state" do
+    TestModelWithMultipleStateMachines.create!
+    initial_transition = TestModelWithMultipleStateMachinesFirstTransition.last
+    initial_transition.event.should be_nil
+    initial_transition.from.should be_nil
+    initial_transition.to.should == 'beginning'
+    initial_transition.created_at.should be_within(10.seconds).of(Time.now.utc)
+  end
+  
+  it "should not log a transition when the state machine does not have an initial state" do
+    lambda { TestModelWithMultipleStateMachines.create! }.should_not change(TestModelWithMultipleStateMachinesSecondTransition, :count)
+  end
+  
+  it "should create a transiction for the first record when the state machine does not have an initial state" do
+    m = TestModelWithMultipleStateMachines.create!
+    lambda { m.begin_second! }.should change(TestModelWithMultipleStateMachinesSecondTransition, :count).by(1)
+  end
+  
+  it "should not have a value for the from state when the state machine does not have an initial state" do
+    m = TestModelWithMultipleStateMachines.create!
+    m.begin_second!
+    first_transition = TestModelWithMultipleStateMachinesSecondTransition.last
+    first_transition.event.should == 'begin_second'
+    first_transition.from.should be_nil
+    first_transition.to.should == 'beginning'
+    first_transition.created_at.should be_within(10.seconds).of(Time.now.utc)
+  end
+end

data/state_machine-audit_trail.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name        = "state_machine-audit_trail"
+  s.version     = "0.0.1"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Willem van Bergen", "Jesse Storimer"]
+  s.email       = ["willem@shopify.com", "jesse.storimer@shopify.com"]
+  s.homepage    = "https://github.com/wvanbergen/state_machine-audit_trail"
+  s.summary     = %q{Log transitions on a state machine to support auditing and business process analytics.}
+  s.description = %q{Log transitions on a state machine to support auditing and business process analytics.}
+
+  s.rubyforge_project = "state_machine"
+
+  s.add_runtime_dependency('state_machine')
+
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rspec', '~> 2')
+  s.add_development_dependency('activerecord', '~> 3')
+  s.add_development_dependency('sqlite3')
+
+  s.files      = %w(.gitignore Gemfile LICENSE README.rdoc Rakefile lib/state_machine-audit_trail.rb lib/state_machine/audit_trail.rb lib/state_machine/audit_trail/active_record.rb lib/state_machine/audit_trail/base.rb lib/state_machine/audit_trail/railtie.rb lib/state_machine/audit_trail/transition_logging.rb lib/state_machine/audit_trail_generator.rb spec/spec_helper.rb spec/state_machine/audit_trail_spec.rb state_machine-audit_trail.gemspec tasks/github_gem.rb)
+  s.test_files = %w(spec/state_machine/audit_trail_spec.rb)
+end

data/tasks/github_gem.rb

@@ -0,0 +1,365 @@
+require 'rubygems'
+require 'rake'
+require 'rake/tasklib'
+require 'date'
+require 'set'
+
+module GithubGem
+
+  # Detects the gemspc file of this project using heuristics.
+  def self.detect_gemspec_file
+    FileList['*.gemspec'].first
+  end
+
+  # Detects the main include file of this project using heuristics
+  def self.detect_main_include
+    if File.exist?(File.expand_path("../lib/#{File.basename(detect_gemspec_file, '.gemspec').gsub(/-/, '/')}.rb", detect_gemspec_file))
+      "lib/#{File.basename(detect_gemspec_file, '.gemspec').gsub(/-/, '/')}.rb"
+    elsif FileList['lib/*.rb'].length == 1
+      FileList['lib/*.rb'].first
+    else
+      nil
+    end
+  end
+
+  class RakeTasks
+
+    attr_reader   :gemspec, :modified_files
+    attr_accessor :gemspec_file, :task_namespace, :main_include, :root_dir, :spec_pattern, :test_pattern, :remote, :remote_branch, :local_branch
+
+    # Initializes the settings, yields itself for configuration
+    # and defines the rake tasks based on the gemspec file.
+    def initialize(task_namespace = :gem)
+      @gemspec_file   = GithubGem.detect_gemspec_file
+      @task_namespace = task_namespace
+      @main_include   = GithubGem.detect_main_include
+      @modified_files = Set.new
+      @root_dir       = Dir.pwd
+      @test_pattern   = 'test/**/*_test.rb'
+      @spec_pattern   = 'spec/**/*_spec.rb'
+      @local_branch   = 'master'
+      @remote         = 'origin'
+      @remote_branch  = 'master'
+
+      yield(self) if block_given?
+
+      load_gemspec!
+      define_tasks!
+    end
+
+    protected
+
+    def git
+      @git ||= ENV['GIT'] || 'git'
+    end
+
+    # Define Unit test tasks
+    def define_test_tasks!
+      require 'rake/testtask'
+
+      namespace(:test) do
+        Rake::TestTask.new(:basic) do |t|
+          t.pattern = test_pattern
+          t.verbose = true
+          t.libs << 'test'
+        end
+      end
+
+      desc "Run all unit tests for #{gemspec.name}"
+      task(:test => ['test:basic'])
+    end
+
+    # Defines RSpec tasks
+    def define_rspec_tasks!
+      require 'rspec/core/rake_task'
+
+      namespace(:spec) do
+        desc "Verify all RSpec examples for #{gemspec.name}"
+        RSpec::Core::RakeTask.new(:basic) do |t|
+          t.pattern = spec_pattern
+        end
+
+        desc "Verify all RSpec examples for #{gemspec.name} and output specdoc"
+        RSpec::Core::RakeTask.new(:specdoc) do |t|
+          t.pattern = spec_pattern
+          t.rspec_opts = ['--format', 'documentation', '--color']
+        end
+
+        desc "Run RCov on specs for #{gemspec.name}"
+        RSpec::Core::RakeTask.new(:rcov) do |t|
+          t.pattern = spec_pattern
+          t.rcov = true
+          t.rcov_opts = ['--exclude', '"spec/*,gems/*"', '--rails']
+        end
+      end
+
+      desc "Verify all RSpec examples for #{gemspec.name} and output specdoc"
+      task(:spec => ['spec:specdoc'])
+    end
+
+    # Defines the rake tasks
+    def define_tasks!
+
+      define_test_tasks!  if has_tests?
+      define_rspec_tasks! if has_specs?
+
+      namespace(@task_namespace) do
+        desc "Updates the filelist in the gemspec file"
+        task(:manifest) { manifest_task }
+
+        desc "Builds the .gem package"
+        task(:build => :manifest) { build_task }
+
+        desc "Sets the version of the gem in the gemspec"
+        task(:set_version => [:check_version, :check_current_branch]) { version_task }
+        task(:check_version => :fetch_origin) { check_version_task }
+
+        task(:fetch_origin) { fetch_origin_task }
+        task(:check_current_branch) { check_current_branch_task }
+        task(:check_clean_status) { check_clean_status_task }
+        task(:check_not_diverged => :fetch_origin) { check_not_diverged_task }
+
+        checks = [:check_current_branch, :check_clean_status, :check_not_diverged, :check_version]
+        checks.unshift('spec:basic') if has_specs?
+        checks.unshift('test:basic') if has_tests?
+        # checks.push << [:check_rubyforge] if gemspec.rubyforge_project
+
+        desc "Perform all checks that would occur before a release"
+        task(:release_checks => checks)
+
+        release_tasks = [:release_checks, :set_version, :build, :github_release, :gemcutter_release]
+        # release_tasks << [:rubyforge_release] if gemspec.rubyforge_project
+
+        desc "Release a new version of the gem using the VERSION environment variable"
+        task(:release => release_tasks) { release_task }
+        
+        namespace(:release) do
+          desc "Release the next version of the gem, by incrementing the last version segment by 1"
+          task(:next => [:next_version] + release_tasks) { release_task }
+
+          desc "Release the next version of the gem, using a patch increment (0.0.1)"
+          task(:patch => [:next_patch_version] + release_tasks) { release_task }
+
+          desc "Release the next version of the gem, using a minor increment (0.1.0)"
+          task(:minor => [:next_minor_version] + release_tasks) { release_task }
+
+          desc "Release the next version of the gem, using a major increment (1.0.0)"
+          task(:major => [:next_major_version] + release_tasks) { release_task }
+        end
+
+        # task(:check_rubyforge)   { check_rubyforge_task }
+        # task(:rubyforge_release) { rubyforge_release_task }
+        task(:gemcutter_release) { gemcutter_release_task }
+        task(:github_release => [:commit_modified_files, :tag_version]) { github_release_task }
+        task(:tag_version) { tag_version_task }
+        task(:commit_modified_files) { commit_modified_files_task }
+
+        task(:next_version)       { next_version_task }
+        task(:next_patch_version)  { next_version_task(:patch) }
+        task(:next_minor_version) { next_version_task(:minor) }
+        task(:next_major_version) { next_version_task(:major) }
+        
+        desc "Updates the gem release tasks with the latest version on Github"
+        task(:update_tasks) { update_tasks_task }
+      end
+    end
+
+    # Updates the files list and test_files list in the gemspec file using the list of files
+    # in the repository and the spec/test file pattern.
+    def manifest_task
+      # Load all the gem's files using "git ls-files"
+      repository_files = `#{git} ls-files`.split("\n")
+      test_files       = Dir[test_pattern] + Dir[spec_pattern]
+
+      update_gemspec(:files, repository_files)
+      update_gemspec(:test_files, repository_files & test_files)
+    end
+
+    # Builds the gem
+    def build_task
+      sh "gem build -q #{gemspec_file}"
+      Dir.mkdir('pkg') unless File.exist?('pkg')
+      sh "mv #{gemspec.name}-#{gemspec.version}.gem pkg/#{gemspec.name}-#{gemspec.version}.gem"
+    end
+
+    def newest_version
+      `#{git} tag`.split("\n").map { |tag| tag.split('-').last }.compact.map { |v| Gem::Version.new(v) }.max || Gem::Version.new('0.0.0')
+    end
+
+    def next_version(increment = nil)
+      next_version = newest_version.segments
+      increment_index = case increment
+        when :micro then 3
+        when :patch then 2
+        when :minor then 1
+        when :major then 0
+        else next_version.length - 1
+      end
+      
+      next_version[increment_index] ||= 0
+      next_version[increment_index] = next_version[increment_index].succ
+      ((increment_index + 1)...next_version.length).each { |i| next_version[i] = 0 }
+      
+      Gem::Version.new(next_version.join('.'))
+    end
+
+    def next_version_task(increment = nil)
+      ENV['VERSION'] = next_version(increment).version
+      puts "Releasing version #{ENV['VERSION']}..."
+    end
+
+    # Updates the version number in the gemspec file, the VERSION constant in the main
+    # include file and the contents of the VERSION file.
+    def version_task
+      update_gemspec(:version, ENV['VERSION']) if ENV['VERSION']
+      update_gemspec(:date, Date.today)
+
+      update_version_file(gemspec.version)
+      update_version_constant(gemspec.version)
+    end
+
+    def check_version_task
+      raise "#{ENV['VERSION']} is not a valid version number!" if ENV['VERSION'] && !Gem::Version.correct?(ENV['VERSION'])
+      proposed_version = Gem::Version.new((ENV['VERSION'] || gemspec.version).dup)
+      raise "This version (#{proposed_version}) is not higher than the highest tagged version (#{newest_version})" if newest_version >= proposed_version
+    end
+
+    # Checks whether the current branch is not diverged from the remote branch
+    def check_not_diverged_task
+      raise "The current branch is diverged from the remote branch!" if `#{git} rev-list HEAD..#{remote}/#{remote_branch}`.split("\n").any?
+    end
+
+    # Checks whether the repository status ic clean
+    def check_clean_status_task
+      raise "The current working copy contains modifications" if `#{git} ls-files -m`.split("\n").any?
+    end
+
+    # Checks whether the current branch is correct
+    def check_current_branch_task
+      raise "Currently not on #{local_branch} branch!" unless `#{git} branch`.split("\n").detect { |b| /^\* / =~ b } == "* #{local_branch}"
+    end
+
+    # Fetches the latest updates from Github
+    def fetch_origin_task
+      sh git, 'fetch', remote
+    end
+
+    # Commits every file that has been changed by the release task.
+    def commit_modified_files_task
+      really_modified = `#{git} ls-files -m #{modified_files.entries.join(' ')}`.split("\n")
+      if really_modified.any?
+        really_modified.each { |file| sh git, 'add', file }
+        sh git, 'commit', '-m', "Released #{gemspec.name} gem version #{gemspec.version}."
+      end
+    end
+
+    # Adds a tag for the released version
+    def tag_version_task
+      sh git, 'tag', '-a', "#{gemspec.name}-#{gemspec.version}", '-m', "Released #{gemspec.name} gem version #{gemspec.version}."
+    end
+
+    # Pushes the changes and tag to github
+    def github_release_task
+      sh git, 'push', '--tags', remote, remote_branch
+    end
+
+    def gemcutter_release_task
+      sh "gem", 'push', "pkg/#{gemspec.name}-#{gemspec.version}.gem"
+    end
+
+    # Gem release task.
+    # All work is done by the task's dependencies, so just display a release completed message.
+    def release_task
+      puts
+      puts "Release successful."
+    end
+
+    private
+
+    # Checks whether this project has any RSpec files
+    def has_specs?
+      FileList[spec_pattern].any?
+    end
+
+    # Checks whether this project has any unit test files
+    def has_tests?
+      FileList[test_pattern].any?
+    end
+
+    # Loads the gemspec file
+    def load_gemspec!
+      @gemspec = eval(File.read(@gemspec_file))
+    end
+
+    # Updates the VERSION file with the new version
+    def update_version_file(version)
+      if File.exists?('VERSION')
+        File.open('VERSION', 'w') { |f| f << version.to_s }
+        modified_files << 'VERSION'
+      end
+    end
+
+    # Updates the VERSION constant in the main include file if it exists
+    def update_version_constant(version)
+      if main_include && File.exist?(main_include)
+        file_contents = File.read(main_include)
+        if file_contents.sub!(/^(\s+VERSION\s*=\s*)[^\s].*$/) { $1 + version.to_s.inspect }
+          File.open(main_include, 'w') { |f| f << file_contents }
+          modified_files << main_include
+        end
+      end
+    end
+
+    # Updates an attribute of the gemspec file.
+    # This function will open the file, and search/replace the attribute using a regular expression.
+    def update_gemspec(attribute, new_value, literal = false)
+
+      unless literal
+        new_value = case new_value
+          when Array        then "%w(#{new_value.join(' ')})"
+          when Hash, String then new_value.inspect
+          when Date         then new_value.strftime('%Y-%m-%d').inspect
+          else              raise "Cannot write value #{new_value.inspect} to gemspec file!"
+        end
+      end
+
+      spec   = File.read(gemspec_file)
+      regexp = Regexp.new('^(\s+\w+\.' + Regexp.quote(attribute.to_s) + '\s*=\s*)[^\s].*$')
+      if spec.sub!(regexp) { $1 + new_value }
+        File.open(gemspec_file, 'w') { |f| f << spec }
+        modified_files << gemspec_file
+
+        # Reload the gemspec so the changes are incorporated
+        load_gemspec!
+        
+        # Also mark the Gemfile.lock file as changed because of the new version.
+        modified_files << 'Gemfile.lock' if File.exist?(File.join(root_dir, 'Gemfile.lock'))
+      end
+    end
+
+    # Updates the tasks file using the latest file found on Github
+    def update_tasks_task
+      require 'net/https'
+      require 'uri'
+      
+      uri = URI.parse('https://github.com/wvanbergen/github-gem/raw/master/tasks/github-gem.rake')
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      response = http.request(Net::HTTP::Get.new(uri.path))
+
+      if Net::HTTPSuccess === response
+        open(__FILE__, "w") { |file| file.write(response.body) }
+        relative_file = File.expand_path(__FILE__).sub(%r[^#{@root_dir}/], '')
+        if `#{git} ls-files -m #{relative_file}`.split("\n").any?
+          sh git, 'add', relative_file
+          sh git, 'commit', '-m', "Updated to latest gem release management tasks."
+        else
+          puts "Release managament tasks already are at the latest version."
+        end
+      else
+        raise "Download failed with HTTP status #{response.code}!"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification 
+name: state_machine-audit_trail
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Willem van Bergen
+- Jesse Storimer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-15 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: state_machine
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        version: "2"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        version: "3"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: Log transitions on a state machine to support auditing and business process analytics.
+email: 
+- willem@shopify.com
+- jesse.storimer@shopify.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/state_machine-audit_trail.rb
+- lib/state_machine/audit_trail.rb
+- lib/state_machine/audit_trail/active_record.rb
+- lib/state_machine/audit_trail/base.rb
+- lib/state_machine/audit_trail/railtie.rb
+- lib/state_machine/audit_trail/transition_logging.rb
+- lib/state_machine/audit_trail_generator.rb
+- spec/spec_helper.rb
+- spec/state_machine/audit_trail_spec.rb
+- state_machine-audit_trail.gemspec
+- tasks/github_gem.rb
+has_rdoc: true
+homepage: https://github.com/wvanbergen/state_machine-audit_trail
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: state_machine
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Log transitions on a state machine to support auditing and business process analytics.
+test_files: 
+- spec/state_machine/audit_trail_spec.rb