stator 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ea9ce5a04f3d128aecd8f78788c7a06a49d2785dc3669a7c54a2c973fb01f2b
-  data.tar.gz: c638206a0fb9dedf3e53403d160425054be95b1f08223e6436239f500afb9eb7
+  metadata.gz: c4db54f443ba466ae3fc6f79857816b8719e0cbacf0615f8c014ae0c71c32e81
+  data.tar.gz: 53d72d27aafa1a340c02d2d5459235488bf5e12df9198312ffe1d5121fc24912
 SHA512:
-  metadata.gz: e32e3867650801979aefd648ebc2184e0a9cf9357c0fa08146a963308c35ec610b3c5ac4a9439149acfa086b98957dd1006484310b60ab0fb18fad56a26bfe51
-  data.tar.gz: b8fa99e1f0e0bdf6a3832395d9de0730ee3a990994509c2dc8b30aa6f5ee06ca1af3114b4f9c00899cb83b15515cca142841a521ee4f0532bc863ba4d03532fe
+  metadata.gz: a2e76eb8e8bbe0e1dab6d8fbdbb6516f12cff56c26c3d10d974d4aadce08fbcabdcd49dbba710d0f904a1a04ea4c489125b18475a119de5e625a9cbb6e9406a4
+  data.tar.gz: 0fef985f07d95f3d8801f4e3534f478feb516fea223532e1e562cc85bebdc54c09222ee0087517d4c3f396f4d094ad80a9404f7e0cb69829ffa6c5ddc40bb297

data/Gemfile

@@ -5,6 +5,6 @@ gem 'activerecord', '5.2.3'
 
 gemspec
 
+gem 'activerecord-nulldb-adapter', '~> 0.4.0', require: false
 gem 'rake'
-gem 'activerecord-nulldb-adapter', '~> 0.4.0', :require => false, :git => 'git@github.com:nulldb/nulldb.git'
 gem 'rspec'

data/lib/stator/integration.rb

@@ -7,6 +7,9 @@ module Stator
     delegate :transitions,  to: :@machine
     delegate :namespace,    to: :@machine
 
+    attr_reader :skip_validations
+    attr_reader :skip_transition_tracking
+
     def initialize(machine, record)
       @machine = machine
       @record  = record
@@ -38,7 +41,7 @@ module Stator
 
     def validate_transition
       return unless state_changed?
-      return if @machine.skip_validations
+      return if skip_validations
 
       was = state_was
       is  = state
@@ -60,7 +63,7 @@ module Stator
     end
 
     def track_transition
-      return if @machine.skip_transition_tracking
+      return if skip_transition_tracking
 
       attempt_to_track_state(state)
       attempt_to_track_state_changed_timestamp
@@ -115,6 +118,22 @@ module Stator
       @machine.states.reverse.detect { |s| in_state_at?(s, t) }
     end
 
+    def without_validation
+      was = @skip_validations
+      @skip_validations = true
+      yield @record
+    ensure
+      @skip_validations = was
+    end
+
+    def without_transition_tracking
+      was = @skip_transition_tracking
+      @skip_transition_tracking = true
+      yield @record
+    ensure
+      @skip_transition_tracking = was
+    end
+
     protected
 
     def attempt_to_track_state(state_to_track)

data/lib/stator/machine.rb

@@ -7,16 +7,14 @@ module Stator
     attr_reader :transitions
     attr_reader :states
     attr_reader :namespace
-    attr_reader :skip_validations
-    attr_reader :skip_transition_tracking
-
 
     def initialize(klass, options = {})
-      @class_name    = klass.name
-      @field         = options[:field] || :state
-      @namespace     = options[:namespace] || nil
+      @class_name       = klass.name
+      @field            = options[:field] || :state
+      @namespace        = options[:namespace]
 
-      @initial_state = options[:initial] && options[:initial].to_s
+      @initial_state    = options[:initial] && options[:initial].to_s
+      @tracking_enabled = options[:track] || false
 
       @transitions      = []
       @aliases          = []
@@ -26,7 +24,6 @@ module Stator
       @states           = [@initial_state].compact
 
       @options       = options
-
     end
 
     def integration(record)
@@ -38,7 +35,6 @@ module Stator
     end
 
     def transition(name, &block)
-
       t = ::Stator::Transition.new(@class_name, name, @namespace)
       t.instance_eval(&block) if block_given?
 
@@ -66,6 +62,10 @@ module Stator
       end
     end
 
+    def tracking_enabled?
+      @tracking_enabled
+    end
+
     def conditional(*states, &block)
       _namespace = @namespace
 
@@ -88,22 +88,6 @@ module Stator
       @class_name.constantize
     end
 
-    def without_validation
-      was = @skip_validations
-      @skip_validations = true
-      yield
-    ensure
-      @skip_validations = was
-    end
-
-    def without_transition_tracking
-      was = @skip_transition_tracking
-      @skip_transition_tracking = true
-      yield
-    ensure
-      @skip_transition_tracking = was
-    end
-
     protected
 
     def verify_transition_validity(transition)

data/lib/stator/model.rb

@@ -35,26 +35,25 @@ module Stator
 
       def self.included(base)
         base.class_eval do
-          before_save :_stator_track_transition, prepend: true
+          before_save :_stator_maybe_track_transition, prepend: true
         end
       end
 
       def in_state_at?(state, t, namespace = '')
-        machine = self._stator(namespace)
-        machine.integration(self).in_state_at?(state, t)
+        _integration(namespace).in_state_at?(state, t)
       end
 
       def likely_state_at(t, namespace = '')
-        machine = self._stator(namespace)
-        machine.integration(self).likely_state_at(t)
+        _integration(namespace).likely_state_at(t)
       end
 
       protected
 
-
-      def _stator_track_transition
+      def _stator_maybe_track_transition
         self._stators.each do |namespace, machine|
-          machine.integration(self).track_transition
+          next unless machine.tracking_enabled?
+
+          _integration(namespace).track_transition
         end
 
         true
@@ -70,23 +69,28 @@ module Stator
         end
       end
 
+      def initialize_dup(other)
+        @_integrations = {}
+        super
+      end
+
       def without_state_transition_validations(namespace = '')
-        self._stator(namespace).without_validation do
-          yield
+        _integration(namespace).without_validation do
+          yield self
         end
       end
 
       def without_state_transition_tracking(namespace = '')
-        self._stator(namespace).without_transition_tracking do
-          yield
+        _integration(namespace).without_transition_tracking do
+          yield self
         end
       end
 
       protected
 
       def _stator_validate_transition
-        self._stators.each do |namespace, machine|
-          machine.integration(self).validate_transition
+        self._stators.each_key do |namespace|
+          _integration(namespace).validate_transition
         end
       end
 
@@ -94,6 +98,12 @@ module Stator
         self.class._stator(namespace)
       end
 
+      def _integration(namespace = '')
+        @_integrations ||= {}
+        @_integrations[namespace] ||= _stator(namespace).integration(self)
+        @_integrations[namespace]
+      end
+
     end
   end
 end

data/lib/stator/transition.rb

@@ -86,7 +86,7 @@ module Stator
     def generate_methods
       klass.class_eval <<-EV, __FILE__, __LINE__ + 1
         def #{@full_name}(should_save = true)
-          integration = self._stator(#{@namespace.inspect}).integration(self)
+          integration = _integration(#{@namespace.to_s.inspect})
 
           unless can_#{@full_name}?
             integration.invalid_transition!(integration.state, #{@to.inspect}) if should_save
@@ -98,7 +98,7 @@ module Stator
         end
 
         def #{@full_name}!
-          integration = self._stator(#{@namespace.inspect}).integration(self)
+          integration = _integration(#{@namespace.to_s.inspect})
 
           unless can_#{@full_name}?
             integration.invalid_transition!(integration.state, #{@to.inspect})
@@ -110,10 +110,10 @@ module Stator
         end
 
         def can_#{@full_name}?
-          machine     = self._stator(#{@namespace.inspect})
-          return true if machine.skip_validations
+          integration = _integration(#{@namespace.to_s.inspect})
+          return true if integration.skip_validations
 
-          integration = machine.integration(self)
+          machine     = self._stator(#{@namespace.to_s.inspect})
           transition  = machine.transitions.detect{|t| t.full_name.to_s == #{@full_name.inspect}.to_s }
           transition.can?(integration.state)
         end

data/lib/stator/version.rb

@@ -4,7 +4,7 @@ module Stator
 
   MAJOR       = 0
   MINOR       = 3
-  PATCH       = 1
+  PATCH       = 3
   PRERELEASE  = nil
 
   VERSION = [MAJOR, MINOR, PATCH, PRERELEASE].compact.join(".")

data/spec/model_spec.rb

@@ -160,6 +160,42 @@ describe Stator::Model do
     u.activated_state_at.should_not be_nil
   end
 
+  it "should skip tracking timestamps if opted out of with thread safety" do
+    threads = []
+    skip = User.new(email: "skip@example.com")
+    nope = User.new(email: "nope@example.com")
+
+    threads << Thread.new do
+      sleep 0.5
+      nope.semiactivate!
+    end
+    threads << Thread.new do
+      skip.without_state_transition_tracking do
+        sleep 1
+        skip.semiactivate!
+      end
+    end
+
+    threads.each(&:join)
+
+    nope.semiactivated_state_at.should_not be_nil
+    skip.semiactivated_state_at.should be_nil
+  end
+
+  it "should not inherit _integration cache on dup" do
+    u = User.new(email: "user@example.com")
+    u.save!
+
+    u_duped = u.dup
+
+    u.semiactivate!
+
+    u_duped_integration = u_duped.send(:_integration)
+
+    u_duped_integration.state.should_not eql(u.state)
+    u_duped_integration.instance_values["record"].should eq(u_duped)
+  end
+
   describe "helper methods" do
     it "should answer the question of whether the state is currently the one invoked" do
       a = Animal.new
@@ -254,6 +290,21 @@ describe Stator::Model do
       u.state.should eql("semiactivated")
       u.semiactivated_state_at.should eql(t)
     end
+
+    it "should allow opting into track by namespace" do
+      z = ZooKeeper.new(name: "Doug")
+      z.employment_state.should eql("hired")
+      z.employment_fire!
+      z.fired_employment_state_at.should_not be_nil
+
+      z.employment_hire!
+      z.hired_employment_state_at.should_not be_nil
+
+      z.working_start!
+      z.started_working_state_at.should be_nil
+      z.working_end!
+      z.ended_working_state_at.should be_nil
+    end
   end
 
   describe "aliasing" do

data/spec/support/models.rb

@@ -134,6 +134,33 @@ class Zoo < ActiveRecord::Base
   end
 end
 
+class ZooKeeper < ActiveRecord::Base
+  extend Stator::Model
+
+  stator namespace: 'employment', field: 'employment_state', track: true do
+    transition :hire do
+      from nil, :fired
+      to :hired
+    end
+
+    transition :fire do
+      from :hired
+      to :fired
+    end
+  end
+
+  stator namespace: 'working', field: 'working_state', track: false do
+    transition :start do
+      from nil, :ended
+      to :started
+    end
+
+    transition :end do
+      from :started
+      to :ended
+    end
+  end
+end
 
 class Farm < ActiveRecord::Base
   extend Stator::Model

data/spec/support/schema.rb

@@ -22,6 +22,16 @@ ActiveRecord::Schema.define(:version => 20130628161227) do
     t.datetime "born_status_at"
   end
 
+  create_table "zoo_keepers", :force => true do |t|
+    t.string   "name"
+    t.string   "employment_state",                      :default => 'hired'
+    t.datetime "hired_employment_state_at"
+    t.datetime "fired_employment_state_at"
+    t.string   "working_state"
+    t.datetime "started_working_state_at"
+    t.datetime "ended_working_state_at"
+  end
+
   create_table "zoos", :force => true do |t|
     t.string   "name"
     t.string   "state",                                 :default => 'closed'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stator
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.3
 platform: ruby
 authors:
 - Mike Nelson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-22 00:00:00.000000000 Z
+date: 2021-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -75,8 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: The simplest of ActiveRecord state machines