stator 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bd69f892293770471063f818138639b932e78120
-  data.tar.gz: 8f0f90685de79f5fd2d29e9170dc25a8c82bc6bb
+SHA256:
+  metadata.gz: 3ea9ce5a04f3d128aecd8f78788c7a06a49d2785dc3669a7c54a2c973fb01f2b
+  data.tar.gz: c638206a0fb9dedf3e53403d160425054be95b1f08223e6436239f500afb9eb7
 SHA512:
-  metadata.gz: e167050e139b82a6d1004739881e42a90dc711f0465d23823475876bf05254ecb0157e41b4038ae82e2779dcb102df5d334750d86da6da367ca78e237b4a0b40
-  data.tar.gz: 8e5346d2586207932a1bdddff88d828953c2ffaebca9a98861845a2fde0b95a7b0a7b2d0c0f2a534c4b85db960534cd3cea14139ff10a1a41323056e6d3ecb3b
+  metadata.gz: e32e3867650801979aefd648ebc2184e0a9cf9357c0fa08146a963308c35ec610b3c5ac4a9439149acfa086b98957dd1006484310b60ab0fb18fad56a26bfe51
+  data.tar.gz: b8fa99e1f0e0bdf6a3832395d9de0730ee3a990994509c2dc8b30aa6f5ee06ca1af3114b4f9c00899cb83b15515cca142841a521ee4f0532bc863ba4d03532fe

data/.ruby-version

@@ -1 +1 @@
-2.2.3
+2.5.1

data/lib/stator/integration.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 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
 
     def initialize(machine, record)
       @machine = machine
@@ -11,7 +13,7 @@ module Stator
     end
 
     def state=(new_value)
-      @record.send("#{@machine.field}=",  new_value)
+      @record.send("#{@machine.field}=", new_value)
     end
 
     def state
@@ -35,11 +37,11 @@ module Stator
     end
 
     def validate_transition
-      return unless self.state_changed?
+      return unless state_changed?
       return if @machine.skip_validations
 
-      was = self.state_was
-      is  = self.state
+      was = state_was
+      is  = state
 
       if @record.new_record?
         invalid_state! unless @machine.matching_transition(::Stator::Transition::ANY, is)
@@ -48,7 +50,7 @@ module Stator
       end
     end
 
-    # todo: i18n
+    # TODO: i18n
     def invalid_state!
       @record.errors.add(@machine.field, "is not a valid state")
     end
@@ -60,8 +62,8 @@ module Stator
     def track_transition
       return if @machine.skip_transition_tracking
 
-      self.attempt_to_track_state(self.state)
-      self.attempt_to_track_state_changed_timestamp
+      attempt_to_track_state(state)
+      attempt_to_track_state_changed_timestamp
 
       true
     end
@@ -82,7 +84,6 @@ module Stator
 
       # 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|
-
         next if state == s
 
         at = @record.send("#{s}_#{@machine.field}_at")
@@ -98,8 +99,8 @@ module Stator
       return true if later_states.empty?
 
       # grab the states that were present at the lowest timestamp
-      later_groups = later_states.group_by{|s| s[:at] }
-      later_group_key = later_groups.keys.sort[0]
+      later_groups = later_states.group_by { |s| s[:at] }
+      later_group_key = later_groups.keys.min
       later_states = later_groups[later_group_key]
 
       # if the lowest timestamp is the same as the state's timestamp, evaluate based on state index
@@ -111,13 +112,14 @@ module Stator
     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
 
     protected
 
     def attempt_to_track_state(state_to_track)
       return unless state_to_track
+
       _attempt_to_track_change("#{state_to_track}_#{@machine.field}_at")
     end
 
@@ -128,7 +130,8 @@ module Stator
     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}").nil? || self.state_changed?
+      return unless @record.send(field_name.to_s).nil? || state_changed?
+      return if @record.send("#{field_name}_changed?")
 
       @record.send("#{field_name}=", (Time.zone || Time).now)
     end

data/lib/stator/version.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 module Stator
+
   MAJOR       = 0
   MINOR       = 3
-  PATCH       = 0
+  PATCH       = 1
   PRERELEASE  = nil
 
-  VERSION = [MAJOR, MINOR, PATCH, PRERELEASE].compact.join('.')
+  VERSION = [MAJOR, MINOR, PATCH, PRERELEASE].compact.join(".")
+
 end

data/spec/model_spec.rb

@@ -1,103 +1,104 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe Stator::Model do
+require "spec_helper"
 
-  it 'should set the default state after initialization' do
+describe Stator::Model do
+  it "should set the default state after initialization" do
     u = User.new
-    u.state.should eql('pending')
+    u.state.should eql("pending")
   end
 
-  it 'should see the initial setting of the state as a change with the initial state as the previous value' do
+  it "should see the initial setting of the state as a change with the initial state as the previous value" do
     u = User.new
-    u.state = 'activated'
-    u.state_was.should eql('pending')
+    u.state = "activated"
+    u.state_was.should eql("pending")
   end
 
-  it 'should not obstruct normal validations' do
+  it "should not obstruct normal validations" do
     u = User.new
     u.should_not be_valid
     u.errors[:email].grep(/length/).should_not be_empty
   end
 
-  it 'should ensure a valid state transition when given a bogus state' do
+  it "should ensure a valid state transition when given a bogus state" do
     u = User.new
-    u.state = 'anythingelse'
+    u.state = "anythingelse"
 
     u.should_not be_valid
-    u.errors[:state].should eql(['is not a valid state'])
+    u.errors[:state].should eql(["is not a valid state"])
   end
 
-  it 'should allow creation at any state' do
-    u = User.new(:email => 'doug@example.com')
-    u.state = 'hyperactivated'
+  it "should allow creation at any state" do
+    u = User.new(email: "doug@example.com")
+    u.state = "hyperactivated"
 
     u.should be_valid
   end
 
-  it 'should ensure a valid state transition when given an illegal state based on the current state' do
+  it "should ensure a valid state transition when given an illegal state based on the current state" do
     u = User.new
 
     allow(u).to receive(:new_record?).and_return(false)
 
-    u.state = 'hyperactivated'
+    u.state = "hyperactivated"
 
     u.should_not be_valid
     u.errors[:state].should_not be_empty
   end
 
-  it 'should not allow a transition that is currently in a `to` state' do
-    u = User.new(:email => 'fred@example.com')
+  it "should not allow a transition that is currently in a `to` state" do
+    u = User.new(email: "fred@example.com")
     u.activate!
     u.hyperactivate!
 
-    lambda{
+    lambda {
       u.hyperactivate!
     }.should raise_error(/cannot transition to \"hyperactivated\" from \"hyperactivated\"/)
   end
 
-  it 'should run conditional validations' do
+  it "should run conditional validations" do
     u = User.new
-    u.state = 'semiactivated'
+    u.state = "semiactivated"
     u.should_not be_valid
 
     u.errors[:state].should be_empty
     u.errors[:email].grep(/format/).should_not be_empty
   end
 
-  it 'should invoke callbacks' do
-    u = User.new(:activated => true, :email => 'doug@example.com', :name => 'doug')
+  it "should invoke callbacks" do
+    u = User.new(activated: true, email: "doug@example.com", name: "doug")
     u.activated.should == true
 
     u.deactivate
 
     u.activated.should == false
-    u.state.should eql('deactivated')
+    u.state.should eql("deactivated")
     u.activated_state_at.should be_nil
     u.should be_persisted
   end
 
-  it 'should blow up if the record is invalid and a bang method is used' do
-    u = User.new(:email => 'doug@other.com', :name => 'doug')
-    lambda{
+  it "should blow up if the record is invalid and a bang method is used" do
+    u = User.new(email: "doug@other.com", name: "doug")
+    lambda {
       u.activate!
     }.should raise_error(ActiveRecord::RecordInvalid)
   end
 
-  it 'should allow for other fields to be used other than state' do
+  it "should allow for other fields to be used other than state" do
     a = Animal.new
     a.should be_valid
 
     a.birth!
   end
 
-  it 'should create implicit transitions for state declarations' do
+  it "should create implicit transitions for state declarations" do
     a = Animal.new
     a.should_not be_grown_up
-    a.status = 'grown_up'
+    a.status = "grown_up"
     a.save
   end
 
-  it 'should allow multiple machines in the same model' do
+  it "should allow multiple machines in the same model" do
     f = Farm.new
     f.should be_dirty
     f.should be_house_dirty
@@ -112,30 +113,30 @@ describe Stator::Model do
     f.should_not be_house_dirty
   end
 
-  it 'should allow saving to be skipped' do
+  it "should allow saving to be skipped" do
     f = Farm.new
     f.cleanup(false)
 
     f.should_not be_persisted
   end
 
-  it 'should allow no initial state' do
+  it "should allow no initial state" do
     f = Factory.new
     f.state.should be_nil
 
     f.construct.should eql(true)
 
-    f.state.should eql('constructed')
+    f.state.should eql("constructed")
   end
 
-  it 'should allow any transition if validations are opted out of' do
+  it "should allow any transition if validations are opted out of" do
     u = User.new
-    u.email = 'doug@example.com'
+    u.email = "doug@example.com"
 
     u.can_hyperactivate?.should eql(false)
     u.hyperactivate.should eql(false)
 
-    u.state.should eql('pending')
+    u.state.should eql("pending")
 
     u.without_state_transition_validations do
       u.can_hyperactivate?.should eql(true)
@@ -143,13 +144,13 @@ describe Stator::Model do
     end
   end
 
-  it 'should skip tracking timestamps if opted out of' do
+  it "should skip tracking timestamps if opted out of" do
     u = User.new
-    u.email = 'doug@example.com'
+    u.email = "doug@example.com"
 
     u.without_state_transition_tracking do
       u.semiactivate!
-      u.state.should eql('semiactivated')
+      u.state.should eql("semiactivated")
       u.semiactivated_state_at.should be_nil
     end
 
@@ -159,9 +160,8 @@ describe Stator::Model do
     u.activated_state_at.should_not be_nil
   end
 
-  describe 'helper methods' do
-
-    it 'should answer the question of whether the state is currently the one invoked' do
+  describe "helper methods" do
+    it "should answer the question of whether the state is currently the one invoked" do
       a = Animal.new
       a.should be_unborn
       a.should_not be_born
@@ -172,7 +172,7 @@ describe Stator::Model do
       a.should_not be_unborn
     end
 
-    it 'should determine if it can validly execute a transition' do
+    it "should determine if it can validly execute a transition" do
       a = Animal.new
       a.can_birth?.should eql(true)
 
@@ -180,22 +180,20 @@ describe Stator::Model do
 
       a.can_birth?.should eql(false)
     end
-
   end
 
-  describe 'tracker methods' do
-
+  describe "tracker methods" do
     before do
-      Time.zone = 'Eastern Time (US & Canada)'
+      Time.zone = "Eastern Time (US & Canada)"
     end
 
-    it 'should store the initial state timestamp when the record is created' do
+    it "should store the initial state timestamp when the record is created" do
       a = Animal.new
       a.save
       a.unborn_status_at.should be_within(1).of(Time.zone.now)
     end
 
-    it 'should store when a record changed state for the first time' do
+    it "should store when a record changed state for the first time" do
       a = Animal.new
       a.unborn_status_at.should be_nil
       a.born_status_at.should be_nil
@@ -204,7 +202,7 @@ describe Stator::Model do
       a.born_status_at.should be_within(1).of(Time.zone.now)
     end
 
-    it 'should store when a record change states' do
+    it "should store when a record change states" do
       a = Animal.new
       a.status_changed_at.should be_nil
 
@@ -218,12 +216,11 @@ describe Stator::Model do
       a.save
 
       a.status_changed_at.should eql(previous_status_changed_at)
-
     end
 
-    it 'should prepend the setting of the timestamp so other callbacks can use it' do
+    it "should prepend the setting of the timestamp so other callbacks can use it" do
       u = User.new
-      u.email = 'doug@example.com'
+      u.email = "doug@example.com"
 
       u.tagged_at.should be_nil
       u.semiactivate!
@@ -232,11 +229,36 @@ describe Stator::Model do
       u.tagged_at.should_not be_nil
     end
 
+    it "should respect the timestamp if explicitly provided" do
+      t = Time.at(Time.now.to_i - 3600)
+
+      u = User.new
+      u.email = "doug@example.com"
+      u.state = "semiactivated"
+      u.semiactivated_state_at = t
+      u.save!
+
+      u.state.should eql("semiactivated")
+      u.semiactivated_state_at.should eql(t)
+    end
+
+    it "should respect the timestamp if explicitly provided via create" do
+      t = Time.at(Time.now.to_i - 3600)
+
+      u = User.create!(
+        email: "doug@example.com",
+        state: "semiactivated",
+        semiactivated_state_at: t
+      )
+
+      u.state.should eql("semiactivated")
+      u.semiactivated_state_at.should eql(t)
+    end
   end
 
-  describe 'aliasing' do
-    it 'should allow aliasing within the dsl' do
-      u = User.new(:email => 'doug@example.com')
+  describe "aliasing" do
+    it "should allow aliasing within the dsl" do
+      u = User.new(email: "doug@example.com")
       u.should respond_to(:active?)
       u.should respond_to(:inactive?)
 
@@ -253,11 +275,11 @@ describe Stator::Model do
       u.should be_active
       u.should_not be_inactive
 
-      User::ACTIVE_STATES.should eql(['activated', 'hyperactivated'])
-      User::INACTIVE_STATES.should eql(['pending', 'deactivated', 'semiactivated'])
+      User::ACTIVE_STATES.should eql(%w[activated hyperactivated])
+      User::INACTIVE_STATES.should eql(%w[pending deactivated semiactivated])
 
-      User.active.to_sql.gsub('  ', ' ').should eq("SELECT users.* FROM users WHERE users.state IN ('activated', 'hyperactivated')")
-      User.inactive.to_sql.gsub('  ', ' ').should eq("SELECT users.* FROM users WHERE users.state IN ('pending', 'deactivated', 'semiactivated')")
+      User.active.to_sql.gsub("  ", " ").should eq("SELECT users.* FROM users WHERE users.state IN ('activated', 'hyperactivated')")
+      User.inactive.to_sql.gsub("  ", " ").should eq("SELECT users.* FROM users WHERE users.state IN ('pending', 'deactivated', 'semiactivated')")
     end
 
     it "should evaluate inverses correctly" do
@@ -272,7 +294,7 @@ describe Stator::Model do
       f.should be_house_cleaned
     end
 
-    it 'should namespace aliases just like everything else' do
+    it "should namespace aliases just like everything else" do
       f = Farm.new
       f.should respond_to(:house_cleaned?)
 
@@ -282,24 +304,23 @@ describe Stator::Model do
       f.should be_house_cleaned
     end
 
-    it 'should allow for explicit constant and scope names to be provided' do
+    it "should allow for explicit constant and scope names to be provided" do
       User.should respond_to(:luke_warmers)
       (!!defined?(User::LUKE_WARMERS)).should eql(true)
       u = User.new
       u.should respond_to(:luke_warm?)
     end
 
-    it 'should not create constants or scopes by default' do
+    it "should not create constants or scopes by default" do
       u = User.new
       u.should respond_to(:iced_tea?)
       (!!defined?(User::ICED_TEA_STATES)).should eql(false)
       User.should_not respond_to(:iced_tea)
     end
 
-    it 'should determine the full list of states correctly' do
+    it "should determine the full list of states correctly" do
       states = User._stator("").states
-      states.should eql(["pending", "activated", "deactivated", "semiactivated", "hyperactivated"])
+      states.should eql(%w[pending activated deactivated semiactivated hyperactivated])
     end
   end
-
 end

metadata

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