state_tracking 1.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 11aa8ecf4c278e2618469d390459ea75bcc516ba
+  data.tar.gz: c25b31ba007c525863dd5eb800dd62424fdc1d3c
+SHA512:
+  metadata.gz: 9d819427660d35ec34f5b367312f4abe65a6b5848dace1f7e9c2fcf19f5e03296bfc1f5808b7befac7871311b8fc640d7550808872848f8a439746a2968f099f
+  data.tar.gz: 7a566c7ead46c80421c78bb6f150680df71cb4a55f4443eeac8f18801d60355aa4a53fe24b94ad41c070728dc87191946524cf56fa89a16740509765f9fd703d

data/lib/state_tracking.rb

@@ -0,0 +1,196 @@
+require 'aasm'
+require 'date'
+require 'active_support/all'
+
+require 'state_tracking/version'
+
+module StateTracking
+  extend ActiveSupport::Concern
+
+  included do
+    include ::AASM
+    before_save :_state_tracking_save
+  end
+
+  class StateTrackingProc < Proc; end
+
+  module ClassMethods
+    def state_tracking(options={}, &block)
+      # We're relying on the fact that the user is not able to set the
+      # skip_validation_on_save configuration value to true.
+      #
+      # If that's set, then the state_tracking column won't be updated.
+      aasm(column: :state, &block)
+
+      aasm.states.each do |state|
+        callbacks = state.options[:enter] ||= []
+
+        unless callbacks.is_a?(Array)
+          callbacks = state.options[:enter] = [callbacks]
+        end
+
+        # Need to make sure we don't add multiple Procs. For example, if the
+        # classes are reloaded in a development environment.
+        #
+        # Note: Using is_a? doesn't work. It doesn't recognize previously added
+        # StateTracking::StateTrackingProc as actually being instances of
+        # StateTracking::StateTrackingProc, so I have to compare by name.
+        unless callbacks.any?{|c| c.class.name == 'StateTracking::StateTrackingProc'}
+          callbacks << StateTrackingProc.new { |record|
+            record.send(:_state_tracking_record_state_change, state.name)
+          }
+        end
+      end
+
+      _override_aasm_events
+
+      # This is required because the instance methods need to override
+      # the instance methods that AASM adds.  If the instance methods
+      # are simply defined within the StateTracking module, then they
+      # get defined first, and then the AASM methods override the
+      # StateTracking methods, which is the opposite of what we want.
+      self.send(:include, InstanceMethods)
+
+      if options[:fire_events]
+        @_state_tracking_fire_states = options[:fire_events] if options[:fire_events].is_a?(Array)
+
+        self.class_eval do
+          # Note: We're defining instance methods here.
+          after_commit :_state_tracking_fire_events
+
+          def _state_tracking_fire_states
+            self.class.instance_variable_get(:@_state_tracking_fire_states)
+          end
+
+          def _state_tracking_fire_events
+            (@_state_tracking_events_to_fire || []).each do |state|
+              next if _state_tracking_fire_states &&
+                !_state_tracking_fire_states.include?(state.to_sym)
+
+              primary_key = self.class.primary_key
+              name_underscored = self.class.name.underscore
+              pkey_value = send(primary_key)
+              event_name = "#{name_underscored}_#{state}"
+
+              unless pkey_value
+                raise "Can't publish event (#{event_name.inspect}). " \
+                      "Primary key (#{primary_key.inspect}) for " \
+                      "#{self.class.name.inspect} is nil."
+              end
+
+              params = {
+                "#{name_underscored}_#{primary_key}" => pkey_value
+              }
+
+              Announcer.publish(event_name, params)
+            end
+
+            @_state_tracking_events_to_fire = nil
+          end
+
+          def _state_tracking_record_state_change(state)
+            super
+            (@_state_tracking_events_to_fire ||= []) << state.to_s
+          end
+        end
+      end
+    end
+
+    def _override_aasm_events
+      aasm.events.each do |name, *args|
+        ["#{name}!", "#{name}"].each { |meth|
+          previous = instance_method(meth)
+
+          define_method(meth) { |*args, &block|
+            _state_tracking_stash_meta(args.last)
+
+            previous.bind(self).(nil, *args, &block)
+          }
+        }
+      end
+    end
+  end # Class Methods
+
+  module InstanceMethods
+    def state_history(state_name = nil)
+      history = _state_tracking_data['history'] || []
+
+      if state_name
+        timestamp = nil
+
+        # Find most recent time when the object was in the specified state.
+        history.reverse_each do |record|
+          if record['state'] == state_name.to_s
+            timestamp = record['time']
+            break
+          end
+        end
+
+        timestamp
+      else
+        history
+      end
+    end
+
+    def was?(state_name)
+      !state_history(state_name).nil?
+    end
+
+    def state_at(time)
+      unless time.is_a?(Date) || time.is_a?(Time) || time.is_a?(DateTime)
+        raise ArgumentError, "invalid time: #{time}"
+      end
+
+      # Get the most recent state up to the time param
+      state_obj = state_history.find_all { |state_obj|
+        state_obj['time'] <= time.to_time.to_f
+      }.last
+
+      state_obj && state_obj['state']
+    end
+
+    def update_state_meta(meta={})
+      state_history = _state_tracking_data['history'].last
+      raise "No current state" unless state_history
+      state_history['meta'].merge!(meta)
+    end
+
+    def _state_tracking_stash_meta(meta={})
+      @_state_tracking_pending_meta = meta.is_a?(Hash) ? meta : nil
+    end
+
+    def _state_tracking_data
+      @__state_tracking_data ||= self.state_tracking ? JSON.parse(self.state_tracking) : {}
+    end
+
+    def _state_tracking_save
+      if @_state_tracking_data_changed
+        self.state_tracking = JSON.dump(_state_tracking_data)
+      end
+    end
+
+    def _state_tracking_record_state_change(state)
+      unless self.state || state == self.class.aasm.initial_state
+        # Want to make sure that we record entering the initial state
+        # in the history even if a subsequent state is being entered
+        # before creating the instance.
+        self.aasm.enter_initial_state
+      end
+
+      @_state_tracking_data_changed = true
+
+      (_state_tracking_data['history'] ||= []) << {
+        'state' => state.to_s,
+        'time'  => Time.now.to_f,
+        'meta' => {}
+      }
+
+      # We don't want to add stashed metadata to the initial state. Otherwise,
+      # there will be duplicate metadata in the intial_state and the current
+      # state. We will add initial_state metadata support at a later date
+      if state != self.class.aasm.initial_state && @_state_tracking_pending_meta
+        update_state_meta(@_state_tracking_pending_meta)
+      end
+    end
+  end # InstanceMethods
+end # StateTracking

data/lib/state_tracking/version.rb

@@ -0,0 +1,3 @@
+module StateTracking
+  VERSION = '1.1.2'
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: state_tracking
+version: !ruby/object:Gem::Version
+  version: 1.1.2
+platform: ruby
+authors:
+- Robert Honer
+- Kayvon Ghaffari
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aasm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.2
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: announcer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email: engineering@payout.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/state_tracking.rb
+- lib/state_tracking/version.rb
+homepage: http://github.com/payout/state_tracking
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Provides the StateTracking mixin.
+test_files: []