simple_transitions 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/README.rdoc

@@ -0,0 +1,4 @@
+= simple_transitions
+    This gem doesn't really implement a state machine.  All it really does is provide
+    an easy way to transition a model from one status to another using standard form
+    submit buttons, while also saving other changes made to that model.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/lib/simple_transitions.rb

@@ -0,0 +1,9 @@
+require 'active_record'
+require 'action_view'
+
+require 'simple_transitions/definition'
+require 'simple_transitions/form_builder'
+require 'simple_transitions/model'
+
+ActiveRecord::Base.send :include, SimpleTransitions::Model
+ActionView::Helpers::FormBuilder.send(:include, SimpleTransitions::FormBuilder)

data/lib/simple_transitions/definition.rb

@@ -0,0 +1,29 @@
+module SimpleTransitions
+
+  class Definition
+    def initialize(model, column, &block)
+      @model  = model
+      @column = column
+      instance_eval(&block)
+    end
+
+    def transition(transition_name, options)
+      from, to        = options.values_at(:from, :to)
+      callback        = options[:callback]
+      writer_method   = "_#{transition_name}="
+      column          = @column
+
+      [from].flatten.each do |from_state|
+        @model.available_transitions[from_state] << "_#{transition_name}"
+      end
+
+      # define a writer method so an appropriately named submit button can trigger the transition
+      @model.send(:define_method, writer_method) do |unused_value|
+        new_state = to.respond_to?(:call) ? to.call(self) : to
+        self.send("#{column}=", new_state)
+        self.current_transition = transition_name
+      end
+    end
+  end
+
+end

data/lib/simple_transitions/form_builder.rb

@@ -0,0 +1,15 @@
+module SimpleTransitions
+
+  module FormBuilder
+    def transition_submit_buttons
+      submits = []
+
+      @object.available_transitions.each do |transition|
+        submits << submit("Save & #{transition.to_s.humanize.titleize.strip}", :name => "#{@object_name}[#{transition}]")
+      end
+
+      submits.join.html_safe
+    end
+  end
+
+end

data/lib/simple_transitions/model.rb

@@ -0,0 +1,30 @@
+module SimpleTransitions
+
+  module Model
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def transitioning?(transition_name)
+      current_transition == transition_name
+    end
+
+    module ClassMethods
+      def simple_transitions(column, &block)
+        @available_transitions = Hash.new { |h,k| h[k] = [] }
+        class << self
+          attr_accessor :available_transitions
+        end
+
+        attr_accessor :current_transition
+
+        define_method :available_transitions do
+          self.class.available_transitions[self.send(column)]
+        end
+
+        SimpleTransitions::Definition.new(self, column, &block)
+      end
+    end
+  end
+
+end

data/lib/simple_transitions/version.rb

@@ -0,0 +1,3 @@
+module SimpleTransitions
+  VERSION = "0.0.1"
+end

data/simple_state_machine.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "simple_transitions/version"
+
+Gem::Specification.new do |s|
+  s.name        = "simple_transitions"
+  s.version     = SimpleTransitions::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Adam McCrea"]
+  s.email       = ["adam@edgecase.com"]
+  s.homepage    = ""
+  s.summary     = %q{Minimalist state machine (not really) for Rails}
+  s.description = %q{
+    This gem doesn't really implement a state machine.  All it really does is provide
+    an easy way to transition a model from one status to another using standard form
+    submit buttons, while also saving other changes made to that model.
+  }
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'activerecord', '~> 3.0.3'
+  s.add_dependency 'actionpack',   '~> 3.0.3'
+
+  s.add_development_dependency 'rspec', '~> 2.4.0'
+end

data/spec/model_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe SimpleTransitions::Model do
+
+  let(:order) { Order.new }
+
+  describe "#available_transitions" do
+    it "always returns an array" do
+      order.status = 'invalid'
+      order.available_transitions.should == []
+    end
+
+    it "returns only the transitions that are available to the current state" do
+      order.status = 'paid'
+      order.available_transitions.should == ['_cancel']
+    end
+  end
+
+  describe "writer methods for transitioning state" do
+    it "are generated for each transition" do
+      order.should respond_to(:_pay=)
+      order.should respond_to(:_cancel=)
+    end
+
+    it "set the state column on the model to the appropriate next state" do
+      order.status = 'pending'
+      order._pay = 'whatever'
+      order.status.should == 'paid'
+    end
+
+    it "set the state column on the model from multiple statues to next state" do
+      ['pending', 'paid'].each do |from|
+        order.status = from
+        order._cancel = 'whatever'
+        order.status.should == 'cancelled'
+      end
+    end
+
+    it "set the state using a proc" do
+      order.status = 'paid'
+      order.should_receive(:next_status)
+      order._next = 'whatever'
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'bundler'
+Bundler.require(:default, :development)
+
+class Order
+  extend SimpleTransitions::Model::ClassMethods
+  attr_accessor :status
+
+  simple_transitions :status do
+    transition :pay,    :from => 'pending',           :to => 'paid'
+    transition :cancel, :from => ['pending', 'paid'], :to => 'cancelled'
+    transition :next,   :from => 'incomplete',        :to => proc { |o| o.next_status }
+  end
+
+  def next_status
+    'complete'
+  end
+end
+

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification 
+name: simple_transitions
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Adam McCrea
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-02 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 3
+        version: 3.0.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 3
+        version: 3.0.3
+  type: :runtime
+  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
+        - 4
+        - 0
+        version: 2.4.0
+  type: :development
+  version_requirements: *id003
+description: "\n    This gem doesn't really implement a state machine.  All it really does is provide\n    an easy way to transition a model from one status to another using standard form\n    submit buttons, while also saving other changes made to that model.\n  "
+email: 
+- adam@edgecase.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/simple_transitions.rb
+- lib/simple_transitions/definition.rb
+- lib/simple_transitions/form_builder.rb
+- lib/simple_transitions/model.rb
+- lib/simple_transitions/version.rb
+- simple_state_machine.gemspec
+- spec/model_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ""
+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: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Minimalist state machine (not really) for Rails
+test_files: 
+- spec/model_spec.rb
+- spec/spec_helper.rb