Module: StateGate

Defined in:
lib/state_gate.rb,
lib/state_gate/type.rb,
lib/state_gate/engine.rb,
lib/state_gate/builder.rb,
lib/state_gate/engine/fixer.rb,
lib/state_gate/engine/scoper.rb,
lib/state_gate/engine/stator.rb,
lib/state_gate/engine/errator.rb,
lib/state_gate/engine/sequencer.rb,
lib/state_gate/engine/configurator.rb,
lib/state_gate/engine/transitioner.rb,
lib/state_gate/builder/scope_methods.rb,
lib/state_gate/builder/state_methods.rb,
lib/state_gate/builder/transition_methods.rb,
lib/state_gate/builder/conflict_detection_methods.rb,
lib/state_gate/builder/transition_validation_methods.rb,
lib/state_gate/builder/dynamic_module_creation_methods.rb

Overview

StateGate

Builds and attaches a StateGate::Engine to the desired ActiveRecord String attribute.

States and transitions are provided within a configuration block, enabling the state-gate to ensure that only defined states are accepted as values for the attribute, and that states may only transition to other allowed states.

Class User
  include StateGate

  state_gate :attribute_name do
    ... configuration ...
  end
end

The Attribute Name

The attribute_name must be:

  • a Symbol

  • the name of a database String column attribute

  • not an aliased attribute name

Configuration Options

The configuration defines the state names, allowed transitions and a number of options to help customise the state-gate to your exact preference.

Options include:

state

Required name for the new state, supplied as a Symbol. The ‘state-gate` requires a minimum of two states to be defined.

state :state_name

:transitions_to

An optional list of the other state that this state is allowed to change to.
  state :state_1, transtions_to: [:state_2, :state_3, :state_4]
  state :state_2, transtions_to: :state_4
  state :state_3, transtions_to: :any
  state :state_4

:human

An optional String name to used when displaying gthe state in a view. If no
name is specified, it will default to +:state.titleized+.
  state :state_1, transtions_to: [:state_2, :state_3], human: "My State"
default

Optional setting to specify the default state for a new object. The state name is given as a Symbol.

default :state_name
prefix

Optional setting to add a given Symbol before each state name when using Class Scopes. This helps to differential between multiple attributes that have similar state names.

prefix :before  #=> Class.before_active
suffix

Optional setting to add a given Symbol after each state name when using Class Scopes. This helps to differential between multiple attributes that have similar state names.

suffix :after  #=> Class.active_after
make_sequential

Optional setting to automatically add transitions from each state to both the preceeding and following states.

make_sequential

:one_way

Option to restrict the generated transitions to one directtion only: from each
state to the follow state.
  make_sequential :one_way

:loop

Option to add transitions from the last state to the first and, unless +:one_way+
is specified, also from the first state to the last.
  make_sequential :one_way, :loop
no_scopes

Optional setting to disable the generation of Class Scope helpers methods.

no_scopes

Defined Under Namespace

Classes: Builder, ConfigurationError, ConflictError, Engine, Type

Class Method Summary collapse

Class Method Details

.symbolize(val) ⇒ Symbol?

Returns the Symbol version of the provided value as long as it responds to #to_s and has no included whitespace in the resulting String.

Examples:

StateGate.symbolize('Test')    #=> :test

StateGate.symbolize(:Test)     #=> :test

StateGate.symbolize('My Test') #=> nil

StateGate.symbolize('')        #=> nil

Parameters:

  • val (String, #to_s) —

    the string to convert in to a Symbol

Returns:

  • (Symbol) —

    the converted string

  • (nil) —

    if the string cannot be converted



147
148
149
150
151
152
153
 
# File 'lib/state_gate.rb', line 147

def self.symbolize(val)
  return nil if     val.blank?
  return nil unless val.respond_to?(:to_s)
  return nil unless val.to_s.remove(/\s+/) == val.to_s

  val.to_s.downcase.to_sym
end