Module: StateMachine::Integrations::Base::ClassMethods

Included in:

StateMachine::Integrations::Base

Defined in:

lib/state_machine/integrations/base.rb

Instance Attribute Summary (collapse)

• - (Object) defaults readonly

  The default options to use for state machines using this integration.

Instance Method Summary (collapse)

• - (Boolean) available?

  Whether this integration is available for the current library.

• - (Object) extended(base)

  Extends the given object with any version overrides that are currently active.

• - (Object) integration_name

  The name of the integration.

• - (Object) locale_path

  The path to the locale file containing translations for this integration.

• - (Boolean) matches?(klass)

  Whether the integration should be used for the given class.

• - (Boolean) matches_ancestors?(ancestors)

  Whether the integration should be used for the given list of ancestors.

• - (Object) matching_ancestors

  The list of ancestor names that cause this integration to matched.

• - (Object) version(name, &block)

  Creates a new version override for an integration.

• - (Object) versions

  Tracks the various version overrides for an integration.

7
8
9

# File 'lib/state_machine/integrations/base.rb', line 7

def defaults
  @defaults
end

23
24
25

# File 'lib/state_machine/integrations/base.rb', line 23

def available?
  matching_ancestors.any? && Object.const_defined?(matching_ancestors[0].split('::')[0])
end

86
87
88
89
90

# File 'lib/state_machine/integrations/base.rb', line 86

def extended(base)
  versions.each do |version|
     base.extend(version) if version.active?
  end
end

10
11
12
13
14
15
16
17
18

# File 'lib/state_machine/integrations/base.rb', line 10

def integration_name
  @integration_name ||= begin
    name = self.name.split('::').last
    name.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
    name.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
    name.downcase!
    name.to_sym
  end
end

79
80
81
82

# File 'lib/state_machine/integrations/base.rb', line 79

def locale_path
  path = "#{File.dirname(__FILE__)}/#{integration_name}/locale.rb"
  path if File.exists?(path)
end

33
34
35

# File 'lib/state_machine/integrations/base.rb', line 33

def matches?(klass)
  matches_ancestors?(klass.ancestors.map {|ancestor| ancestor.name})
end

38
39
40

# File 'lib/state_machine/integrations/base.rb', line 38

def matches_ancestors?(ancestors)
  (ancestors & matching_ancestors).any?
end

28
29
30

# File 'lib/state_machine/integrations/base.rb', line 28

def matching_ancestors
  []
end

module StateMachine
  module Integrations
    module ORMLibrary
      version '0.2.x - 0.3.x' do
        def self.active?
          ::ORMLibrary::VERSION >= '0.2.0' && ::ORMLibrary::VERSION < '0.4.0'
        end

        def invalidate(object, attribute, message, values = [])
          # Override here...
        end
      end
    end
  end
end

71
72
73
74

# File 'lib/state_machine/integrations/base.rb', line 71

def version(name, &block)
  versions << mod = Module.new(&block)
  mod
end

43
44
45

# File 'lib/state_machine/integrations/base.rb', line 43

def versions
  @versions ||= []
end