minimal_state_machine 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+.DS_Store

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Matteo Depalo
+
+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,29 @@
+# MinimalStateMachine
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'minimal_state_machine'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install minimal_state_machine
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/generators/minimal_state_machine/minimal_state_machine_generator.rb

@@ -0,0 +1,27 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+class MinimalStateMachineGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  desc "Creates migration files required by reputation system gem."
+
+  self.source_paths << File.join(File.dirname(__FILE__), 'templates')
+
+  def self.next_migration_number(path)
+    ActiveRecord::Generators::Base.next_migration_number(path)
+  end
+
+  def create_migration_files
+    create_migration_file_if_not_exist 'create_states'
+  end
+
+  private
+
+  def create_migration_file_if_not_exist(file_name)
+    unless self.class.migration_exists?(File.dirname(File.expand_path("db/migrate/#{file_name}")), file_name)
+      migration_template "#{file_name}.rb", "db/migrate/#{file_name}.rb"
+    end
+  end
+end

data/lib/generators/minimal_state_machine/templates/create_states.rb

@@ -0,0 +1,9 @@
+class CreateStates < ActiveRecord::Migration
+  def change
+    create_table :msm_states do |t|
+      t.string :type
+      t.references :state_machine, :polymorphic => true  
+      t.timestamps
+    end
+  end
+end

data/lib/minimal_state_machine.rb

@@ -0,0 +1,51 @@
+require 'minimal_state_machine/version'
+require 'minimal_state_machine/state'
+require 'active_support'
+
+module MinimalStateMachine
+  extend ActiveSupport::Concern
+
+  included do
+    has_one :state, :as => :state_machine, :class_name => 'MinimalStateMachine::State'
+
+    after_initialize :set_initial_state, :if => proc { state.nil? }
+
+    def self.states
+      {}
+    end
+
+    class InvalidStateError < StandardError; end
+
+    def state_name=(state_name)
+      raise InvalidStateError unless self.class.states.keys.map(&:to_s).include?(state_name)
+
+      if state.nil? || state.new_record?
+        self.state = self.class.states[state_name.to_sym].new
+      else
+        transition_to state_name
+      end
+    end
+
+    private
+
+    class InvalidTransitionError < StandardError; end
+
+    def transition_to(state_name)
+      if state.class.valid_transition_states.include?(state_name)
+        state.destroy
+        self.state = self.class.states[state_name.to_sym].new
+        save
+      else
+        raise InvalidTransitionError
+      end
+    end
+
+    def set_initial_state
+      if self.class.respond_to?(:initial_state) && self.class.initial_state
+        self.state_name = self.class.initial_state
+      else
+        self.state_name = self.class.states.keys.map(&:to_s).first
+      end
+    end
+  end
+end

data/lib/minimal_state_machine/state.rb

@@ -0,0 +1,13 @@
+require 'active_record'
+
+module MinimalStateMachine
+  class State < ActiveRecord::Base
+    self.table_name = 'msm_states'
+
+    def self.valid_transition_states
+      []
+    end
+    
+    belongs_to :state_machine, :polymorphic => true
+  end
+end

data/lib/minimal_state_machine/version.rb

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

data/minimal_state_machine.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'minimal_state_machine/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "minimal_state_machine"
+  gem.version       = MinimalStateMachine::VERSION
+  gem.authors       = ["Matteo Depalo"]
+  gem.email         = ["matteodepalo@gmail.com"]
+  gem.description   = %q{A state machine for activerecord implemented with the state pattern}
+  gem.summary       = %q{A state machine implemented with the state pattern}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'activerecord'
+  gem.add_dependency 'activesupport'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'debugger'
+end

data/spec/minimal_state_machine_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'msm_states'")
+ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'state_machines'")
+ActiveRecord::Base.connection.create_table(:msm_states) do |t|
+  t.string :type
+  t.references :state_machine, :polymorphic => true  
+  t.timestamps
+end
+
+ActiveRecord::Base.connection.create_table(:state_machines)
+
+class StateMachine < ActiveRecord::Base
+  include MinimalStateMachine
+
+  def self.states
+    { :open => StateMachineOpen, :closed => StateMachineClosed, :solved => StateMachineSolved }
+  end
+
+  def self.initial_state
+    'open'
+  end
+end
+
+class StateMachineOpen < MinimalStateMachine::State
+  def self.valid_transition_states
+    %w(closed)
+  end
+end
+
+class StateMachineClosed < MinimalStateMachine::State
+  def self.valid_transition_states
+    %w(solved open)
+  end
+end
+
+class StateMachineSolved < MinimalStateMachine::State; end
+
+describe StateMachine do
+  before(:each) do
+    @state_machine = StateMachine.create
+  end
+
+  it 'sets the initial state' do
+    @state_machine.state.should be_a(StateMachineOpen)
+  end
+
+  it 'changes state' do
+    @state_machine.state_name = 'closed'
+
+    @state_machine.state.should be_a(StateMachineClosed)
+  end
+
+  it 'raises an invalid transition error if the new state is not among the allowed transition states' do
+    expect { @state_machine.state_name = 'solved' }.to raise_error('MinimalStateMachine::InvalidTransitionError')
+  end
+
+  it 'raises an invalid state error if the state assigned in not among the allowed states' do
+    expect { @state_machine.state_name = 'invalid_state' }.to raise_error('MinimalStateMachine::InvalidStateError')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'minimal_state_machine'
+require 'debugger'
+
+root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database => "#{root}/db/minimal_state_machine.sqlite3"
+)
+
+RSpec.configure do |config|
+  config.before(:each) do
+    ActiveRecord::Base.connection.increment_open_transactions
+    ActiveRecord::Base.connection.begin_db_transaction
+  end
+
+  config.after(:each) do
+    ActiveRecord::Base.connection.rollback_db_transaction
+    ActiveRecord::Base.connection.decrement_open_transactions
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: minimal_state_machine
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matteo Depalo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A state machine for activerecord implemented with the state pattern
+email:
+- matteodepalo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- db/minimal_state_machine.sqlite3
+- lib/generators/minimal_state_machine/minimal_state_machine_generator.rb
+- lib/generators/minimal_state_machine/templates/create_states.rb
+- lib/minimal_state_machine.rb
+- lib/minimal_state_machine/state.rb
+- lib/minimal_state_machine/version.rb
+- minimal_state_machine.gemspec
+- spec/minimal_state_machine_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A state machine implemented with the state pattern
+test_files:
+- spec/minimal_state_machine_spec.rb
+- spec/spec_helper.rb