stator 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a5f5716fec773ccafe1308d20a5db86c1efc0ba71467cbc82c208e97782ad07
-  data.tar.gz: '09a4cb4b225d8897ec737da39be2c571e59ad005fd3a771a7afa7f19b56f8ac6'
+  metadata.gz: 69cde7f0870cc5691869d9e3dbc94c886a74472ec0c858ded58d7f4fde0b5ac1
+  data.tar.gz: 9d72a8142353d239883d4c0d244ca1ef9d46e9dde2bf602e19a7c28e53951e3a
 SHA512:
-  metadata.gz: 52e7539f9a6933b0c9badbd8dd276be7cc8518a4bd3f62b98d5095ee5c92aff165fba2e9dd6614c80f93251ba599750dfd7ba1e12f445e3b2339effe46d17d02
-  data.tar.gz: 1a338be123d40ef09c21a1e986a768e9156de07ea02b911439dd9ce5887d5db528b266d01e1812be610f06d1d0fc8b495d659f5e0d3dd61ae72247a99fec46b0
+  metadata.gz: 29bcc2f18487e5d081e8270646b6a5b612f04aae32c7d0341dda09bf1d90440e6f0788215553ea0d3f86528d8a5593df61d9cb62790fe586af49202bc34db7f1
+  data.tar.gz: 354327de6f695f02c8dffd2b9ed1a6a717c49cb88628a1b1edd7120e152348c6c2aa39f010018d05cb9f0638b3917afd811c3dce49a840996d1881a003ec985f

data/lib/stator/integration.rb

@@ -158,7 +158,7 @@ module Stator
       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 if @record.will_save_change_to_attribute?(field_name) && !@record.send(field_name.to_s).nil?
 
       @record.send("#{field_name}=", (Time.zone || Time).now)
     end

data/lib/stator/version.rb

@@ -3,7 +3,7 @@
 module Stator
 
   MAJOR       = 0
-  MINOR       = 8
+  MINOR       = 9
   PATCH       = 0
   PRERELEASE  = nil
 

data/stator.gemspec

@@ -13,11 +13,15 @@ Gem::Specification.new do |gem|
   gem.homepage      = "https://github.com/guideline-tech/stator"
   gem.license       = "MIT"
 
-  gem.files         = `git ls-files`.split($/)
+  # Specify which files should be added to the gem when it is released.
+  gem.files = Dir["lib/**/*"] + Dir["*.gemspec"]
+
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
+  gem.metadata["allowed_push_host"] = "https://rubygems.org"
+  gem.metadata["rubygems_mfa_required"] = "true"
+
   gem.add_dependency 'base64'
   gem.add_dependency 'benchmark'
   gem.add_dependency 'bigdecimal'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stator
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Mike Nelson
@@ -101,30 +101,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/CODEOWNERS"
-- ".github/dependabot.yml"
-- ".github/workflows/build.yml"
-- ".gitignore"
-- ".rspec"
-- ".ruby-gemset"
-- ".ruby-version"
-- Appraisals
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
-- gemfiles/activerecord_6.0.gemfile
-- gemfiles/activerecord_6.0.gemfile.lock
-- gemfiles/activerecord_6.1.gemfile
-- gemfiles/activerecord_6.1.gemfile.lock
-- gemfiles/activerecord_7.0.gemfile
-- gemfiles/activerecord_7.0.gemfile.lock
-- gemfiles/activerecord_7.1.gemfile
-- gemfiles/activerecord_7.1.gemfile.lock
-- gemfiles/activerecord_7.2.gemfile
-- gemfiles/activerecord_7.2.gemfile.lock
-- gemfiles/activerecord_8.0.gemfile
-- gemfiles/activerecord_8.0.gemfile.lock
 - lib/stator.rb
 - lib/stator/alias.rb
 - lib/stator/integration.rb
@@ -132,15 +108,13 @@ files:
 - lib/stator/model.rb
 - lib/stator/transition.rb
 - lib/stator/version.rb
-- spec/model_spec.rb
-- spec/spec_helper.rb
-- spec/support/models.rb
-- spec/support/schema.rb
 - stator.gemspec
 homepage: https://github.com/guideline-tech/stator
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -155,11 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.8
 specification_version: 4
 summary: The simplest of ActiveRecord state machines
-test_files:
-- spec/model_spec.rb
-- spec/spec_helper.rb
-- spec/support/models.rb
-- spec/support/schema.rb
+test_files: []

data/.github/CODEOWNERS

@@ -1 +0,0 @@
-.github/workflows     @guideline-tech/engineering

data/.github/dependabot.yml

@@ -1,24 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    open-pull-requests-limit: 20
-    schedule:
-      interval: "daily"
-      time: "09:00"
-      timezone: "America/New_York"
-    commit-message:
-      prefix: "[github-actions] "      
-  - package-ecosystem: "bundler"
-    directory: "/"
-    schedule:
-      interval: "daily"
-      time: "08:30"
-      timezone: "America/New_York"
-    allow:
-      - dependency-type: "all"      
-    versioning-strategy: increase
-    open-pull-requests-limit: 20
-    insecure-external-code-execution: deny
-    commit-message:
-      prefix: "[bundler] "      

data/.github/workflows/build.yml

@@ -1,23 +0,0 @@
-name: build
-on:
-  pull_request:
-  push:
-      branches:
-        - main
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby-version: [3.2, 3.3, 3.4]
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          show-progress: 'false'
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby-version }}
-          bundler-cache: true # runs `bundle install` and caches installed gems automatically
-      - run: bundle exec appraisal install
-      - run: bundle exec appraisal rspec

data/.gitignore

@@ -1,17 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/.rspec

@@ -1,2 +0,0 @@
---color
---format documentation

data/.ruby-gemset

@@ -1 +0,0 @@
-stator

data/.ruby-version

@@ -1 +0,0 @@
-3.4.2

data/Appraisals

@@ -1,26 +0,0 @@
-appraise "activerecord-6.0" do
-  gem "activerecord", "~> 6.0.0"
-  gem "concurrent-ruby", "1.3.4"
-end
-
-appraise "activerecord-6.1" do
-  gem "activerecord", "~> 6.1.0"
-  gem "concurrent-ruby", "1.3.4"
-end
-
-appraise "activerecord-7.0" do
-  gem "activerecord", "~> 7.0.0"
-  gem "concurrent-ruby", "1.3.4"
-end
-
-appraise "activerecord-7.1" do
-  gem "activerecord", "~> 7.1.0"
-end
-
-appraise "activerecord-7.2" do
-  gem "activerecord", "~> 7.2.0"
-end
-
-appraise "activerecord-8.0" do
-  gem "activerecord", "~> 8.0.0"
-end

data/Gemfile

@@ -1,10 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in stator.gemspec
-gemspec
-
-gem "appraisal"
-
-gem "activerecord-nulldb-adapter"
-gem "rake"
-gem "rspec"

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2013 Mike Nelson
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,230 +0,0 @@
-# Stator
-
-Stator is a minimalist's state machine. It's a simple dsl that uses existing ActiveRecord functionality to accomplish common state machine functionality. This is not a full-featured computer-science driven gem, it's a gem that covers the 98% of use cases that I've run into.
-
-```ruby
-gem 'stator', '~> x.y.z'
-```
-
-## Usage
-
-If you've used the state_machine gem it's a pretty similar dsl. You define your state machine, transitions, states, and your callbacks (if any). One difference is that stator assumes you've set your db column's default value to the initial state.
-
-```ruby
-  class User < ActiveRecord::Base
-    extend Stator::Model
-
-    # initial state (column default) is "unactivated"
-    stator do
-
-      transition :semiactivate do
-        from :unactivated
-        to   :semiactivated
-      end
-
-      transition :activate do
-        from :unactivated, :semiactivated
-        to   :activated
-      end
-
-      transition :deactivate do
-        from any
-        to   :deactivate
-      end
-
-    end
-  end
-```
-
-Then you use like this:
-
-```ruby
-u = User.new
-u.state
-# => 'unactivated'
-u.persisted?
-# => false
-u.semiactivate
-# => true
-u.state
-# => 'semiactivated'
-u.persisted?
-# => true
-```
-
-## Advanced Usage
-
-The intention of stator was to avoid hijacking ActiveRecord or reinvent the wheel. You can conditionally validate, invoke callbacks, etc. via a conditional block - no magic:
-
-```ruby
-class User < ActiveRecord::Base
-  extend Stator::Model
-
-  stator field: :status, track: true do
-
-    transition :activate do
-      from :unactivated
-      to   :activated
-
-      # conditions is a string condition which will ensure the state
-      # was one of the `from` states and is one of the `to` states.
-      conditional do |conditions|
-        validate :validate_user_ip_not_blacklisted, if: conditions
-      end
-
-    end
-
-    # conditions is a string condition which will ensure the state
-    # is one of the ones provided.
-    conditional :unactivated do |conditions|
-      validates :email, presence: true, unless: conditions
-    end
-
-  end
-end
-```
-
-Within a transition, the `conditional` block accepts a `use_previous` option which tells the state checks to use the record's previous_changes rather than the current changes. This is especially useful for after_commit scenarios where the record's changes hash is cleared before the execution begins.
-
-```ruby
-transition :activate do
-  from :unactivated
-  to   :activated
-
-  conditional(use_previous: true) do |conditions|
-    after_commit :send_things, if: conditions
-  end
-```
-
-The instance has some convenience methods which are generated by the state machine:
-
-```ruby
-u = User.new
-u.activated?
-# => false
-u.can_activate?
-# => true
-```
-
-Note that asking if a transition can take place via `can_[transition_name]?` does not invoke validations. It simply determines whether the record is in a state which the transition can take place from.
-
-The `track: true` option enables timekeeping of the state transition. It will try to set a field in the format of "state_field_at" before saving the record. For example, in the previous state machine the following would occur:
-
-```ruby
-u = User.new
-u.activate
-
-u.activated_status_at
-  # => (now)
-```
-
-`track: true` will also look for a "state_changed_at" field and will update that if it's present.
-
-You can have multiple state machines for your model:
-
-```ruby
-
-class User < ActiveRecord::Base
-  extend Stator::Model
-
-  # initial state = asleep
-  stator do
-    # wake up
-  end
-
-  # initial state = incomplete
-  stator namespace: 'homework', field: 'homework_state' do
-    # get it done
-  end
-end
-```
-
-If you need to access the state machine directly, you can do so via the class:
-
-```ruby
-User._stator(namespace)
-```
-
-You can opt out of state transition validation by using the `without_state_transition_validations` method:
-
-```ruby
-user.without_state_transition_validations do
-  user.activate!
-end
-```
-
-#### Aliasing
-
-It's a really common case to have a set of states evaluated as a single concept. For example, many apps have a concept of "active" users. You generally see something like this:
-
-```ruby
-class User < ActiveRecord::Base
-  ACTIVE_STATES = %w(semiactivated activated)
-
-  scope :active, -> { where(state: ACTIVE_STATES) }
-
-  def active?
-    self.state.in?(ACTIVE_STATES)
-  end
-end
-```
-
-To this point, we're doing ok. But how about defining inactive as well? At this point things start getting a little dirtier since a change to ACTIVE_STATES should impact INACTIVE_STATES. For this reason, stator allows you to define state aliases:
-
-```ruby
-class User < ActiveRecord::Base
-  extend Stator::Model
-
-  stator do
-    # forgoing state definitions...
-
-    state_alias :active do
-      is :semiactivated, :activated
-      opposite :inactive
-    end
-  end
-end
-```
-
-The provided example will define an `active?` and `inactive?` method. If you want to create the constant and/or the scope, just pass them as options to the state_alias method:
-
-```ruby
-# will generate a User::ACTIVE_STATES constant, User.active scope, and User#active? instance method
-state_alias :active, scope: true, constant: true do
-  # ...
-end
-```
-
-Passing `true` for the scope or constant will result in default naming conventions. You can pass your own names if you'd rather:
-
-```ruby
-# will generate a User::THE_ACTIVE_STATES constant, User.the_active_ones scope, and User#active? instance method
-state_alias :active, scope: :the_active_ones, constant: :the_active_states do
-  # ...
-end
-```
-
-The `opposite` method also accepts the scope and constant options, but does not yield to a block since the state definitions are inheritenly tied to the ones described in the parent state_alias block.
-
-## Development
-
-Run test suite against current Rails version:
-
-```
-bundle exec rake spec
-```
-
-Run test suite against all supported Rails versions using `appraisal`:
-
-```
-bundle exec appraisal rake spec
-```
-
-For help updating the `Gemfile` or changing supported Rails versions, see the `appraisal` gem [README](https://github.com/thoughtbot/appraisal#usage).
-
-Note that the gemfiles in `gemfiles/*` are auto-generated by `appraisal` and should not be modified directly.
-
-#### TODO
-
-- Allow for multiple variations of a transition (shift_down style - :third_gear => :second_gear, :second_gear => :first_gear)
-- Create adapters for different backends (not just ActiveRecord)

data/Rakefile

@@ -1,9 +0,0 @@
-#!/usr/bin/env rake
-require 'rake'
-require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = 'spec/*_spec.rb'
-end
-task :default  => :spec

data/gemfiles/activerecord_6.0.gemfile

@@ -1,12 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "appraisal"
-gem "activerecord-nulldb-adapter"
-gem "rake"
-gem "rspec"
-gem "activerecord", "~> 6.0.0"
-gem "concurrent-ruby", "1.3.4"
-
-gemspec path: "../"

data/gemfiles/activerecord_6.0.gemfile.lock

@@ -1,102 +0,0 @@
-PATH
-  remote: ..
-  specs:
-    stator (0.8.0)
-      activerecord (>= 6.0)
-      base64
-      benchmark
-      bigdecimal
-      logger
-      mutex_m
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (6.0.6.1)
-      activesupport (= 6.0.6.1)
-    activerecord (6.0.6.1)
-      activemodel (= 6.0.6.1)
-      activesupport (= 6.0.6.1)
-    activerecord-nulldb-adapter (1.1.1)
-      activerecord (>= 6.0, < 8.1)
-    activesupport (6.0.6.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    appraisal (2.5.0)
-      bundler
-      rake
-      thor (>= 0.14.0)
-    base64 (0.2.0)
-    benchmark (0.4.0)
-    bigdecimal (3.1.9)
-    concurrent-ruby (1.3.4)
-    diff-lcs (1.6.1)
-    i18n (1.14.7)
-      concurrent-ruby (~> 1.0)
-    logger (1.7.0)
-    minitest (5.25.5)
-    mutex_m (0.3.0)
-    rake (13.2.1)
-    rspec (3.13.0)
-      rspec-core (~> 3.13.0)
-      rspec-expectations (~> 3.13.0)
-      rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.3)
-      rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-support (3.13.2)
-    thor (1.3.2)
-    thread_safe (0.3.6)
-    tzinfo (1.2.11)
-      thread_safe (~> 0.1)
-    zeitwerk (2.7.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activerecord (~> 6.0.0)
-  activerecord-nulldb-adapter
-  appraisal
-  concurrent-ruby (= 1.3.4)
-  rake
-  rspec
-  stator!
-
-CHECKSUMS
-  activemodel (6.0.6.1) sha256=8856126e35d604084e5531dc6d29095bee431b93e7899687dfec59da929b6f5f
-  activerecord (6.0.6.1) sha256=be387b7c8997ea5373d42bf56d2789914a742b67357701677d769ce8a31ba139
-  activerecord-nulldb-adapter (1.1.1) sha256=034c91106183b954b072fba14c2786adf1a2b9e852ce04f85f823afaf03e9820
-  activesupport (6.0.6.1) sha256=6f01805552bb9b123db05b506ddc64af8285ccfc835a3169c9ec6c8a1d8c43ac
-  appraisal (2.5.0) sha256=36989221be127913b0dba8d114da2001e6b2dceea7bd4951200eaba764eed3ce
-  base64 (0.2.0) sha256=0f25e9b21a02a0cc0cea8ef92b2041035d39350946e8789c562b2d1a3da01507
-  benchmark (0.4.0) sha256=0f12f8c495545e3710c3e4f0480f63f06b4c842cc94cec7f33a956f5180e874a
-  bigdecimal (3.1.9) sha256=2ffc742031521ad69c2dfc815a98e426a230a3d22aeac1995826a75dabfad8cc
-  concurrent-ruby (1.3.4) sha256=d4aa926339b0a86b5b5054a0a8c580163e6f5dcbdfd0f4bb916b1a2570731c32
-  diff-lcs (1.6.1) sha256=12a5a83f3e37a8e2f4427268e305914d5f1879f22b4e73bb1a09f76a3dd86cd4
-  i18n (1.14.7) sha256=ceba573f8138ff2c0915427f1fc5bdf4aa3ab8ae88c8ce255eb3ecf0a11a5d0f
-  logger (1.7.0) sha256=196edec7cc44b66cfb40f9755ce11b392f21f7967696af15d274dde7edff0203
-  minitest (5.25.5) sha256=391b6c6cb43a4802bfb7c93af1ebe2ac66a210293f4a3fb7db36f2fc7dc2c756
-  mutex_m (0.3.0) sha256=cfcb04ac16b69c4813777022fdceda24e9f798e48092a2b817eb4c0a782b0751
-  rake (13.2.1) sha256=46cb38dae65d7d74b6020a4ac9d48afed8eb8149c040eccf0523bec91907059d
-  rspec (3.13.0) sha256=d490914ac1d5a5a64a0e1400c1d54ddd2a501324d703b8cfe83f458337bab993
-  rspec-core (3.13.3) sha256=25136507f4f9cf2e8977a2851e64e438b4331646054e345998714108745cdfe4
-  rspec-expectations (3.13.3) sha256=0e6b5af59b900147698ea0ff80456c4f2e69cac4394fbd392fbd1ca561f66c58
-  rspec-mocks (3.13.2) sha256=2327335def0e1665325a9b617e3af9ae20272741d80ac550336309a7c59abdef
-  rspec-support (3.13.2) sha256=cea3a2463fd9b84b9dcc9685efd80ea701aa8f7b3decb3b3ce795ed67737dbec
-  stator (0.8.0)
-  thor (1.3.2) sha256=eef0293b9e24158ccad7ab383ae83534b7ad4ed99c09f96f1a6b036550abbeda
-  thread_safe (0.3.6) sha256=9ed7072821b51c57e8d6b7011a8e282e25aeea3a4065eab326e43f66f063b05a
-  tzinfo (1.2.11) sha256=6501f6a12175ca0243118b83f7c7c2b7978aaec7a0980550a124d007ad6361b6
-  zeitwerk (2.7.2) sha256=842e067cb11eb923d747249badfb5fcdc9652d6f20a1f06453317920fdcd4673
-
-BUNDLED WITH
-   2.6.7

data/gemfiles/activerecord_6.1.gemfile

@@ -1,12 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "appraisal"
-gem "activerecord-nulldb-adapter"
-gem "rake"
-gem "rspec"
-gem "activerecord", "~> 6.1.0"
-gem "concurrent-ruby", "1.3.4"
-
-gemspec path: "../"