stator 0.5.0 → 0.9.0.beta

data/lib/stator/integration.rb

@@ -2,48 +2,48 @@
 
 module Stator
   class Integration
+    delegate :states,       to: :machine
+    delegate :transitions,  to: :machine
+    delegate :namespace,    to: :machine
 
-    delegate :states,       to: :@machine
-    delegate :transitions,  to: :@machine
-    delegate :namespace,    to: :@machine
-
-    attr_reader :skip_validations
-    attr_reader :skip_transition_tracking
+    attr_reader :skip_validations, :skip_transition_tracking, :record, :machine
 
     def initialize(machine, record)
       @machine = machine
       @record  = record
+      @skip_transition_tracking = false
     end
 
     def state=(new_value)
-      @record.send("#{@machine.field}=", new_value)
+      record.send("#{machine.field}=", new_value)
     end
 
     def state
-      @record.send(@machine.field)
+      record.send(machine.field)&.to_sym
     end
 
     def state_was(use_previous = false)
       if use_previous
-        @record.attribute_before_last_save(@machine.field)
+        record.previous_changes[machine.field].try(:[], 0).to_sym
       else
-        @record.attribute_in_database(@machine.field)
+        record.send("#{@machine.field}_was")
       end
     end
 
     def state_by?(state, time)
-      field_name = "#{state}_#{@machine.field}_at"
-      return false unless @record.respond_to?(field_name)
-      return false if @record.send(field_name).nil?
+      field_name = "#{state}_#{machine.field}_at"
+      return false unless record.respond_to?(field_name)
+      return false if record.send(field_name).nil?
       return true if time.nil?
-      @record.send(field_name) <= time
+
+      record.send(field_name) <= time
     end
 
     def state_changed?(use_previous = false)
       if use_previous
-        @record.saved_change_to_attribute?(@machine.field)
+        !!record.previous_changes[machine.field.to_s]
       else
-        @record.will_save_change_to_attribute?(@machine.field)
+        record.send("#{machine.field}_changed?")
       end
     end
 
@@ -51,23 +51,20 @@ module Stator
       return unless state_changed?
       return if skip_validations
 
-      was = state_was
-      is  = state
-
-      if @record.new_record?
-        invalid_state! unless @machine.matching_transition(::Stator::Transition::ANY, is)
+      if record.new_record?
+        invalid_state! unless machine.matching_transition(Stator::ANY, state)
       else
-        invalid_transition!(was, is) unless @machine.matching_transition(was, is)
+        invalid_transition!(state_was, state) unless machine.matching_transition(state_was, state)
       end
     end
 
     # TODO: i18n
     def invalid_state!
-      @record.errors.add(@machine.field, "is not a valid state")
+      record.errors.add(machine.field, 'is not a valid state')
     end
 
     def invalid_transition!(was, is)
-      @record.errors.add(@machine.field, "cannot transition to #{is.inspect} from #{was.inspect}")
+      record.errors.add(machine.field, "cannot transition to #{is} from #{was}")
     end
 
     def track_transition
@@ -83,7 +80,7 @@ module Stator
       state = state.to_s
       t = t.to_time
 
-      state_at = @record.send("#{state}_#{@machine.field}_at")
+      state_at = record.send("#{state}_#{machine.field}_at")
 
       # if we've never been in the state, the answer is no
       return false if state_at.nil?
@@ -91,20 +88,18 @@ module Stator
       # if we came into this state later in life, the answer is no
       return false if state_at > t
 
-      all_states = @machine.states.reverse
+      all_states = machine.states.reverse
 
       # grab all the states and their timestamps that occur on or after state_at and on or before the time in question
-      later_states = all_states.map do |s|
+      later_states = all_states.filter_map do |s|
         next if state == s
 
-        at = @record.send("#{s}_#{@machine.field}_at")
+        at = record.send("#{s}_#{machine.field}_at")
 
-        next if at.nil?
-        next if at < state_at
-        next if at > t
+        next if at.nil? || at < state_at || at > t
 
         { state: s, at: at }
-      end.compact
+      end
 
       # if there were no states on or after the state_at, the answer is yes
       return true if later_states.empty?
@@ -115,53 +110,51 @@ module Stator
       later_states = later_groups[later_group_key]
 
       # if the lowest timestamp is the same as the state's timestamp, evaluate based on state index
-      if later_states[0][:at] == state_at
-        return all_states.index(state) < all_states.index(later_states[0][:state])
-      end
+      return all_states.index(state) < all_states.index(later_states[0][:state]) if later_states[0][:at] == state_at
 
       false
     end
 
     def likely_state_at(t)
-      @machine.states.reverse.detect { |s| in_state_at?(s, t) }
+      machine.states.reverse.detect { |s| in_state_at?(s, t) }
     end
 
     def without_validation
-      was = @skip_validations
+      was = skip_validations
       @skip_validations = true
-      yield @record
+      yield record
     ensure
       @skip_validations = was
     end
 
     def without_transition_tracking
-      was = @skip_transition_tracking
+      was = skip_transition_tracking
       @skip_transition_tracking = true
-      yield @record
+      yield record
     ensure
       @skip_transition_tracking = was
     end
 
-    protected
+    private
 
     def attempt_to_track_state(state_to_track)
       return unless state_to_track
 
-      _attempt_to_track_change("#{state_to_track}_#{@machine.field}_at")
+      _attempt_to_track_change("#{state_to_track}_#{machine.field}_at")
     end
 
     def attempt_to_track_state_changed_timestamp
-      _attempt_to_track_change("#{@machine.field}_changed_at")
+      _attempt_to_track_change("#{machine.field}_changed_at")
     end
 
     def _attempt_to_track_change(field_name)
-      return unless @record.respond_to?(field_name)
-      return unless @record.respond_to?("#{field_name}=")
-      return unless @record.send(field_name.to_s).nil? || state_changed?
-      return if @record.will_save_change_to_attribute?(field_name)
+      return unless record.respond_to?(field_name)
+      return unless record.respond_to?("#{field_name}=")
+      return unless record.send(field_name.to_s).nil? || state_changed?
 
-      @record.send("#{field_name}=", (Time.zone || Time).now)
-    end
+      return if record.send("#{field_name}_changed?")
 
+      record.send("#{field_name}=", (Time.zone || Time).now)
+    end
   end
 end

data/lib/stator/machine.rb

@@ -1,57 +1,65 @@
+# frozen_string_literal: true
+
 module Stator
   class Machine
+    attr_reader :initial_state, :field, :transitions, :states, :namespace,
+                :class_name, :name, :aliases, :options, :tracking_enabled, :klass
+
+    def self.find_or_create(klass, *kwargs)
+      kwargs = kwargs.first
+
+      klass._stators[kwargs[:namespace]] ||= new(klass, **kwargs)
+    end
+
+    def klass
+      @klass ||= class_name.constantize
+    end
 
-    attr_reader :initial_state
-    attr_reader :field
-    attr_reader :transition_names
-    attr_reader :transitions
-    attr_reader :states
-    attr_reader :namespace
+    def initialize(klass, *options)
+      options = options.first
 
-    def initialize(klass, options = {})
       @class_name       = klass.name
       @field            = options[:field] || :state
-      @namespace        = options[:namespace]
+      @namespace        = (options[:namespace] || Stator.default_namespace).to_sym
 
-      @initial_state    = options[:initial] && options[:initial].to_s
+      @initial_state    = options[:initial]&.to_sym
+      @states           = [initial_state].compact
       @tracking_enabled = options[:track] || false
 
       @transitions      = []
       @aliases          = []
 
-      # pushed out into their own variables for performance reasons (AR integration can use method missing - see the HelperMethods module)
-      @transition_names = []
-      @states           = [@initial_state].compact
-
-      @options       = options
+      @options = options
     end
 
-    def integration(record)
-      ::Stator::Integration.new(self, record)
+    alias tracking_enabled? tracking_enabled
+
+    def evaluate_dsl(&block)
+      instance_eval(&block)
+      evaluate
     end
 
-    def get_transition(name)
-      @transitions.detect{|t| t.name.to_s == name.to_s}
+    def integration(record)
+      Stator::Integration.new(self, record)
     end
 
     def transition(name, &block)
-      t = ::Stator::Transition.new(@class_name, name, @namespace)
-      t.instance_eval(&block) if block_given?
-
-      verify_transition_validity(t)
+      Stator::Transition.new(class_name, name, namespace).tap do |t|
+        t.instance_eval(&block) if block_given?
 
-      @transitions      << t
-      @transition_names |= [t.full_name]  unless t.full_name.blank?
-      @states           |= [t.to_state]   unless t.to_state.nil?
+        verify_transition_validity(t)
 
-      t
+        @transitions      << t
+        @states           |= [t.to_state] unless t.to_state.nil?
+      end
     end
 
     def state_alias(name, options = {}, &block)
-      a = ::Stator::Alias.new(self, name, options)
-      a.instance_eval(&block) if block_given?
-      @aliases << a
-      a
+      Stator::Alias.new(self, name, options).tap do |a|
+        # puts "ALIAS: #{a.inspect}"
+        a.instance_eval(&block) if block_given?
+        @aliases << a
+      end
     end
 
     def state(name, &block)
@@ -62,33 +70,31 @@ module Stator
       end
     end
 
-    def tracking_enabled?
-      @tracking_enabled
-    end
-
     def conditional(*states, &block)
-      _namespace = @namespace
+      state_check = proc { states.include?(current_state) }
 
-      klass.instance_exec(proc { states.map(&:to_s).include?(self._stator(_namespace).integration(self).state) }, &block)
+      klass.instance_exec(state_check, &block)
     end
 
     def matching_transition(from, to)
-      @transitions.detect do |transition|
-        transition.valid?(from, to)
-      end
+      transitions.detect { |transition| transition.valid?(from, to) }
     end
 
     def evaluate
-      @transitions.each(&:evaluate)
-      @aliases.each(&:evaluate)
+      transitions.each(&:evaluate)
+      aliases.each(&:evaluate)
       generate_methods
     end
 
-    def klass
-      @class_name.constantize
-    end
+    private
 
-    protected
+    def attr_name(name)
+      if namespace == Stator.default_namespace
+        name.to_sym
+      else
+        [namespace, name].compact.join('_').to_sym
+      end
+    end
 
     def verify_transition_validity(transition)
       verify_state_singularity_of_transition(transition)
@@ -98,34 +104,29 @@ module Stator
     def verify_state_singularity_of_transition(transition)
       transition.from_states.each do |from|
         if matching_transition(from, transition.to_state)
-          raise "[Stator] another transition already exists which moves #{@class_name} from #{from.inspect} to #{transition.to_state.inspect}"
+          raise "[Stator] another transition already exists which moves #{class_name} from #{from} to #{transition}"
         end
       end
     end
 
     def verify_name_singularity_of_transition(transition)
-      if @transitions.detect{|other| transition.name && transition.name == other.name }
-        raise "[Stator] another transition already exists with the name of #{transition.name.inspect} in the #{@class_name} class"
+      if transitions.detect { |other| transition.name && transition.name == other.name }
+        raise "[Stator] another transition already exists with the name of #{transition.name} in the #{class_name} class"
       end
     end
 
     def generate_methods
-      self.states.each do |state|
-        method_name = [@namespace, state].compact.join('_')
+      states.each do |state|
         klass.class_eval <<-EV, __FILE__, __LINE__ + 1
-          def #{method_name}?
-            integration = self._stator(#{@namespace.inspect}).integration(self)
-            integration.state == #{state.to_s.inspect}
+          def #{attr_name(state)}?
+            _stator_integration(:#{namespace}).state.to_sym == :#{state}
           end
 
-          def #{method_name}_state_by?(time)
-            integration = self._stator(#{@namespace.inspect}).integration(self)
-            integration.state_by?(#{state.to_s.inspect}, time)
+          def #{attr_name(state)}_state_by?(time)
+            _stator_integration(:#{namespace}).state_by?(:#{state}.to_sym, time)
           end
         EV
       end
     end
-
-
   end
 end

data/lib/stator/model.rb

@@ -1,113 +1,118 @@
+# frozen_string_literal: true
+
 module Stator
   module Model
+    extend ActiveSupport::Concern
 
-    def stator(options = {}, &block)
-
-      class_attribute :_stators unless respond_to?(:_stators)
+    included do
+      class_attribute :_stators
+      attr_accessor :_stator_integrations
 
-      include InstanceMethods   unless self.included_modules.include?(InstanceMethods)
-      include TrackerMethods    if options[:track] == true
+      validate :_stator_validate_transition
 
       self._stators ||= {}
 
-      unless self.abstract_class?
-        f = options[:field] || :state
-        # rescue nil since the table may not exist yet.
-        initial = self.columns_hash[f.to_s].default rescue nil
-        options = options.merge(initial: initial) if initial
-      end
-
-      machine = (self._stators[options[:namespace].to_s] ||= ::Stator::Machine.new(self, options))
-
-      if block_given?
-        machine.instance_eval(&block)
-        machine.evaluate
-      end
-
-      machine
+      before_save :_stator_maybe_track_transition, prepend: true
     end
 
-    def _stator(namespace)
-      self._stators[namespace.to_s]
-    end
+    class_methods do
+      def stator(namespace: nil, field: :state, initial: nil, track: true, &block)
+        unless abstract_class?
+          # Discover the default value (usually initial) from the table...
+          # but rescue nil since the table may not exist yet.
+          initial = _determine_initial_stator_state(field)
+        end
 
-    module TrackerMethods
+        opts = { namespace: _stator_namespace(namespace), field: field.to_sym, initial: initial, track: track }
 
-      def self.included(base)
-        base.class_eval do
-          before_save :_stator_maybe_track_transition, prepend: true
+        Stator::Machine.find_or_create(self, **opts).tap do |machine|
+          machine.evaluate_dsl(&block) if block_given?
         end
       end
 
-      def in_state_at?(state, t, namespace = '')
-        _integration(namespace).in_state_at?(state, t)
+      def _stator(namespace)
+        self._stators[_stator_namespace(namespace)]
       end
 
-      def likely_state_at(t, namespace = '')
-        _integration(namespace).likely_state_at(t)
-      end
+      def _stator_namespace(namespace = nil)
+        namespace = nil if namespace.blank?
 
-      def state_by?(state, t, namespace = '')
-        _integration(namespace).state_by?(state, t)
+        (namespace || Stator.default_namespace).to_sym
       end
 
-      protected
+      def _determine_initial_stator_state(field)
+        columns_hash[field.to_s].default.to_sym
+      rescue StandardError
+        nil
+      end
+    end
 
-      def _stator_maybe_track_transition
-        self._stators.each do |namespace, machine|
-          next unless machine.tracking_enabled?
+    def initialize_dup(other)
+      @_stator_integrations = {}
+      super
+    end
 
-          _integration(namespace).track_transition
-        end
+    def without_state_transition_validations(namespace = '')
+      _stator_integration(namespace).without_validation do
+        yield self
+      end
+    end
 
-        true
+    def without_state_transition_tracking(namespace = '')
+      _stator_integration(namespace).without_transition_tracking do
+        yield self
       end
+    end
 
+    def current_state
+      _stator_integration.state&.to_sym
     end
 
-    module InstanceMethods
+    def in_state_at?(state, t, namespace = '')
+      _stator_integration(namespace).in_state_at?(state, t)
+    end
 
-      def self.included(base)
-        base.class_eval do
-          validate :_stator_validate_transition
-        end
-      end
+    def likely_state_at(t, namespace = '')
+      _stator_integration(namespace).likely_state_at(t)
+    end
 
-      def initialize_dup(other)
-        @_integrations = {}
-        super
-      end
+    def state_by?(state, t, namespace = '')
+      _stator_integration(namespace).state_by?(state, t)
+    end
 
-      def without_state_transition_validations(namespace = '')
-        _integration(namespace).without_validation do
-          yield self
-        end
-      end
+    private
 
-      def without_state_transition_tracking(namespace = '')
-        _integration(namespace).without_transition_tracking do
-          yield self
-        end
-      end
+    # core methods
+    def _stator(namespace = nil)
+      self.class._stator(namespace)
+    end
 
-      protected
+    def _stator_namespace(namespace = nil)
+      self.class._stator_namespace(namespace)
+    end
 
-      def _stator_validate_transition
-        self._stators.each_key do |namespace|
-          _integration(namespace).validate_transition
-        end
-      end
+    def _stator_integration(namespace = nil)
+      ns = _stator_namespace(namespace)
 
-      def _stator(namespace = '')
-        self.class._stator(namespace)
+      self._stator_integrations ||= {}
+      self._stator_integrations[ns] ||= self.class._stator(ns).integration(self)
+    end
+
+    # validation/transitional
+    def _stator_validate_transition
+      self._stators.each_key do |namespace|
+        _stator_integration(namespace).validate_transition
       end
+    end
+
+    def _stator_maybe_track_transition
+      self._stators.each do |namespace, machine|
+        next unless machine.tracking_enabled?
 
-      def _integration(namespace = '')
-        @_integrations ||= {}
-        @_integrations[namespace] ||= _stator(namespace).integration(self)
-        @_integrations[namespace]
+        _stator_integration(namespace).track_transition
       end
 
+      true
     end
   end
 end