state_attr 0.1.9

data/README.md

@@ -0,0 +1,40 @@
+# About
+
+StateAttr is an minimalistic state machine approach for rails allowing multiple state attributes at the same time.
+
+# Installation
+
+    gem install state_attr
+
+# Examples
+
+    state_attr :state, {
+      nil => :first,
+      :first => [:second, :third],
+      :second => :last,
+      :third => nil,
+    }
+
+    state_attr :invitation_state, {
+      :invited => %w{approved rejected},
+      :approved => :rejected,
+      :rejected => :approved,
+    }, :initial => :invited
+
+    state_attr :progress, {
+      nil => :one,
+      :one => :two,
+      :two => :three
+    } do |old, new|
+      if new == :three
+        send_mail "You just finished."
+      else
+        send_mail "You just made to #{new}."
+      end
+    end
+
+# Options
+
+ - :initial => :value - initial `value` (not yet implemented)
+ - :setter => :exception - raise exception when calling `state=`
+ - :switch_not_allowed => :silent - do not raise exception when switch is not allowed

data/Rakefile

@@ -0,0 +1,24 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the session_management plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the session_management plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'SessionManagement'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/lib/state_attr/state.rb

@@ -0,0 +1,72 @@
+module StateAttr
+  module ClassMethods
+    class State
+
+      def initialize(parent, field, machine, logger, options)
+        @parent = parent
+        @field = field
+        #convert different types of input to array of symbols
+        @machine = {}
+        machine.each { |key, value| @machine[key] = value.nil? ? [nil] : Array(value).map(&:to_sym) }
+        @logger = logger
+        @options = options
+        @callback = "on_#{@field}_change".to_sym
+      end
+
+      def to_s
+        read_state.to_s
+      end
+
+      # current state value
+      def value
+        read_state
+      end
+      alias_method :current, :value
+
+      # validates if state is one of the given states
+      def is?(*symbols)
+        !symbols.flatten.select { |state| read_state == state }.empty?
+      end
+
+      # array of allowed stated
+      def allowed
+        @machine[read_state] || []
+      end
+
+      #validate if can switch to given state
+      def allowed?(state)
+        allowed.include?(state) || is?(state)
+      end
+
+      # if allowed switch to given state, if not raise exception
+      def switch(state)
+        if (allowed?(state))
+          write_state(state)
+        elsif @options[:switch_not_allowed] == :silent
+          @logger.error "#{@parent.class.name} changing #{@field} from '#{read_state}' to '#{state}' is not allowed, allowed states are '#{allowed*'\', \''}'"
+          false
+        else
+          raise "#{@parent.class.name} error, changing #{@field} from '#{read_state}' to '#{state}' is not allowed, allowed states are '#{allowed*'\', \''}'"
+        end
+      end
+
+      private
+
+      def read_state
+        @parent.read_attribute(@field).try(:to_sym)
+      end
+
+      def write_state(state)
+        if @parent.methods.include? @callback.to_s
+          unless @parent.send @callback, read_state, state
+            @logger.warn "#{@parent.class.name}: change #{@field} from '#{read_state}' to '#{state}' was rejected by callback"
+            return false
+          end
+        end
+        @logger.debug "#{@parent.class.name}: changing #{@field} from '#{read_state}' to '#{state}'"
+        @parent.write_attribute(@field, state.try(:to_s))
+        true
+      end
+    end
+  end
+end

data/lib/state_attr.rb

@@ -0,0 +1,36 @@
+require 'state_attr/state'
+module StateAttr
+
+  module ClassMethods
+    def state_attr(attr, machine, options={}, &block)
+      #attr, initial = attr
+      self.send :define_method, attr do
+        @state_handlers ||= {}
+        @state_handlers[attr] ||= State.new(self, attr, machine, logger, options)
+        @state_handlers[attr]
+      end
+
+      if options[:setter] == :exception
+        self.send :define_method, "#{attr}=".to_sym do |state|
+          raise "#{self.class.name} error, manual setting of state is not allowed (new value '#{state}')"
+        end
+      else
+        self.send :define_method, "#{attr}=".to_sym do |state|
+          @state_handlers ||= {}
+          @state_handlers[attr] ||= State.new(self, attr, machine, logger, options)
+          @state_handlers[attr].switch(state)
+        end
+      end
+
+      if block_given?
+        self.send :define_method, "on_#{attr}_change".to_sym do |*args|
+          block.call *args
+        end
+      end
+    end
+  end
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+end

data/rails/init.rb

@@ -0,0 +1,2 @@
+require 'state_attr'
+ActiveRecord::Base.send( :include, StateAttr )

data/state_attr.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.name = "state_attr"
+  s.version = "0.1.9"
+  s.date = "2011-05-16"
+  s.summary = "Minimalistic state machine approach allowing multiple state attributes at the same time."
+  s.email = "mpapis@gmail.com"
+  s.homepage = "http://github.com/mpapis/state_attr/tree/master"
+  s.description = "Minimalistic state machine."
+  s.has_rdoc = false
+  s.authors = ["Michal Papis"]
+  s.files = [
+              "lib/state_attr.rb",
+              "lib/state_attr/state.rb",
+              "rails/init.rb",
+              "Rakefile",
+              "README.md",
+              "state_attr.gemspec",
+              "test/test_helper.rb",
+              "test/unit/state_attr_test.rb",
+            ]
+  #s.add_dependency("rails",["~>2","~>3"])
+end

data/test/test_helper.rb

@@ -0,0 +1,46 @@
+require 'test/unit'
+require 'state_attr'
+
+# fake rails
+class << nil
+  def try *args
+    nil
+  end
+end
+
+class Object
+  def try *args
+    send *args
+  end
+end
+
+class Logger
+  def info msg
+  end
+  def warn msg
+  end
+  def error msg
+  end
+  def debug msg
+  end
+end
+RAILS_DEFAULT_LOGGER = Logger.new
+
+module ActiveRecord
+  class Base
+    def write_attribute(name, value)
+      @attributes ||= {}
+      @attributes[name] = value
+    end
+    def read_attribute(name)
+      attributes[name]
+    end
+    def attributes
+      @attributes || {}
+    end
+    def logger
+      RAILS_DEFAULT_LOGGER
+    end
+    include StateAttr
+  end
+end

data/test/unit/state_attr_test.rb

@@ -0,0 +1,79 @@
+require 'test_helper'
+
+class FakeModel < ActiveRecord::Base
+  state_attr :state1, {
+    nil => :a,
+    :a => :b,
+  }, :setter => :exception
+
+  state_attr :state2, {
+    nil => [:d,:f],
+    :d => [:e,:f],
+    :f => [:d,:e],
+    :e => nil,
+  }, :setter => :exception
+
+  state_attr :state3, {
+    nil => :g,
+    :g => :h,
+  }
+end
+
+class StateAttrTest < Test::Unit::TestCase
+  def test_single_set_read
+    model = FakeModel.new
+    assert_equal nil, model.state1.value
+    assert_equal "", model.state1.to_s
+    model.state1.switch(:a)
+    assert_equal :a, model.state1.value
+    assert_equal "a", "#{model.state1}"
+  end
+  def test_single_set_fail
+    model = FakeModel.new
+    assert_raises RuntimeError do
+      model.state1.switch(:c)
+    end
+    assert_equal nil, model.state1.value
+  end
+  def test_single_assignment_fail
+    model = FakeModel.new
+    assert_raises RuntimeError do
+      model.state1=:a
+    end
+    assert_equal nil, model.state1.value
+  end
+  def test_single_assignment_success
+    model = FakeModel.new
+    model.state3=:g
+    assert_equal :g, model.state3.value
+  end
+  def test_single_set_nil
+    model = FakeModel.new
+    model.state2.switch(:d)
+    model.state2.switch(:e)
+    assert_equal :e, model.state2.value
+    model.state2.switch(nil)
+    assert_equal nil, model.state2.value
+  end
+  def test_double_set
+    model = FakeModel.new
+    model.state1.switch(:a)
+    model.state2.switch(:d)
+    assert_equal :a, model.state1.value
+    assert_equal :d, model.state2.value
+  end
+  def test_single_is?
+    model = FakeModel.new
+    model.state2.switch(:d)
+    assert model.state2.is?(:d)
+    assert !model.state2.is?(:e)
+    assert model.state2.is?(:d,:e)
+  end
+  def test_single_allowed?
+    model = FakeModel.new
+    model.state2.switch(:d)
+    assert !model.state2.allowed?(nil)
+    assert model.state2.allowed?(:d)
+    assert model.state2.allowed?(:e)
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: state_attr
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 9
+  version: 0.1.9
+platform: ruby
+authors: 
+- Michal Papis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-16 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Minimalistic state machine.
+email: mpapis@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/state_attr.rb
+- lib/state_attr/state.rb
+- rails/init.rb
+- Rakefile
+- README.md
+- state_attr.gemspec
+- test/test_helper.rb
+- test/unit/state_attr_test.rb
+has_rdoc: true
+homepage: http://github.com/mpapis/state_attr/tree/master
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Minimalistic state machine approach allowing multiple state attributes at the same time.
+test_files: []
+