steady_state 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c80b6cce9dbf7702cdf8fd0d97c21794bcbc6a67c2ea688fcf5b150ee217df5a
-  data.tar.gz: 67bc8bc9e117e55ac21b4dcba713dbf97627354c1997e906fbb317ef06b42ac6
+  metadata.gz: 7b7ad486ead2f7c864e7ba69d8525f7d6e72fbb220c7ebabf866802f1d7ad50b
+  data.tar.gz: f46001c070069cb44e77aa330170c1204626324c175d3c11ad8d11e21aaa3123
 SHA512:
-  metadata.gz: 374352c07075b3ccb50c1c018e6b8e654ebcc84675d44e4024406dde923ba28699f58daf7b67f8161cff8ee41d9e4f75c77f59680f165b62e527787b7dd00e65
-  data.tar.gz: 6d493623807a7332a1e3b96a9849d46b6a33d59e8405dbb935ef66de4d9b054b2c471ca8421feb7f75810a2aa6694b0173a64be694a69a31a6210de2232018b0
+  metadata.gz: ac41840168b5cf0aeba5ebf7ba80784fe164013ae2926a0939e713e1fb3d686d30c945c07a1b51a68cdcbfc00b13e9a2ccb2b12480f43a166b83d6bf4d7100ed
+  data.tar.gz: f74858d2bf2552e4603272f4cf82bee27bbc2930fe2eb1661e5717c34bfd011faf638caaea83b35d230672b07fca2e017a2965c611992aeac8f60d441735cee7

data/README.md

@@ -231,6 +231,33 @@ As it stands, state history is not preserved, but it is still possible to get a
 material.state.previous_values # => ['solid']
 ```
 
+### The "States Getter"
+
+A pluralized, class-level helper method can be used to access all possible state values:
+
+```ruby
+Material.states # => ['solid', 'liquid', 'gas']
+```
+
+These values respond to reflection methods like `may_become?`, `next_values`, and `previous_values`.
+
+```
+Material.states.first.solid? # => true
+Material.states[1].may_become?('solid') # => false
+Material.states[1].next_values # => ['gas']
+```
+
+The automatic definition of this class method can be disabled by passing `states_getter: false`:
+
+```ruby
+steady_state :step, states_getter: false do
+  # ...
+end
+
+MyClass.steps # => NoMethodError
+```
+
+
 ### ActiveModel Support
 
 SteadyState is also available to classes that are not database-backed, as long as they include the `ActiveModel::Model` mixin:

data/Rakefile

@@ -13,4 +13,14 @@ require 'rspec/core'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
-task default: %i(rubocop spec)
+def default_task
+  if ENV['APPRAISAL_INITIALIZED'] || ENV['CI']
+    %i(rubocop spec)
+  else
+    require 'appraisal'
+    Appraisal::Task.new
+    %i(appraisal)
+  end
+end
+
+task(:default).clear.enhance(default_task)

data/lib/steady_state/attribute.rb

@@ -13,7 +13,7 @@ module SteadyState
     end
 
     class_methods do
-      def steady_state(attr_name, predicates: true, states_getter: true, scopes: SteadyState.active_record?(self), &block) # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity, Metrics/LineLength
+      def steady_state(attr_name, predicates: true, states_getter: true, scopes: SteadyState.active_record?(self), &block) # rubocop:disable Metrics/
         overrides = Module.new do
           define_method :"validate_#{attr_name}_transition_to" do |next_value|
             if public_send(attr_name).may_become?(next_value)

data/lib/steady_state/version.rb

@@ -1,3 +1,3 @@
 module SteadyState
-  VERSION = '0.1.0'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/spec/steady_state/attribute_spec.rb

@@ -188,11 +188,11 @@ RSpec.describe SteadyState::Attribute do
       expect(subject.step.may_become?('step-1')).to eq false
       expect(subject.step.may_become?('step-2')).to eq true
       expect(subject.step.may_become?('cancelled')).to eq true
-      expect(subject.step.next_values).to match_array(['cancelled', 'step-2'])
+      expect(subject.step.next_values).to match_array(%w(cancelled step-2))
       expect(subject.step.previous_values).to match_array([])
       expect { subject.step = 'cancelled' }.to change { subject.step }.from('step-1').to('cancelled')
       expect(subject.step.next_values).to match_array([])
-      expect(subject.step.previous_values).to match_array(['step-1', 'step-2'])
+      expect(subject.step.previous_values).to match_array(%w(step-1 step-2))
       expect(subject).to be_valid
     end
 
@@ -200,7 +200,7 @@ RSpec.describe SteadyState::Attribute do
       expect(subject.step.may_become?('step-1')).to eq false
       expect(subject.step.may_become?('step-2')).to eq true
       expect(subject.step.may_become?('cancelled')).to eq true
-      expect(subject.step.next_values).to match_array(['cancelled', 'step-2'])
+      expect(subject.step.next_values).to match_array(%w(cancelled step-2))
       expect(subject.step.previous_values).to match_array([])
       expect { subject.step = 'step-2' }.to change { subject.step }.from('step-1').to('step-2')
       expect(subject).to be_valid
@@ -212,7 +212,7 @@ RSpec.describe SteadyState::Attribute do
       expect(subject.step.previous_values).to match_array(['step-1'])
       expect { subject.step = 'cancelled' }.to change { subject.step }.from('step-2').to('cancelled')
       expect(subject.step.next_values).to match_array([])
-      expect(subject.step.previous_values).to match_array(['step-1', 'step-2'])
+      expect(subject.step.previous_values).to match_array(%w(step-1 step-2))
       expect(subject).to be_valid
     end
   end
@@ -223,7 +223,7 @@ RSpec.describe SteadyState::Attribute do
       steady_state_class.module_eval do
         attr_accessor :door
 
-        steady_state :door, options do
+        steady_state :door, **options do
           state 'open', default: true
           state 'closed', from: 'open'
           state 'locked', from: 'closed'
@@ -298,7 +298,7 @@ RSpec.describe SteadyState::Attribute do
       steady_state_class.module_eval do
         attr_accessor :car
 
-        steady_state :car, options do
+        steady_state :car, **options do
           state 'driving', default: true
           state 'stopped', from: 'driving'
           state 'parked', from: 'stopped'
@@ -339,7 +339,7 @@ RSpec.describe SteadyState::Attribute do
           defined_scopes[name] ||= callable
         end
 
-        steady_state :car, options do
+        steady_state :car, **options do
           state 'driving', default: true
           state 'stopped', from: 'driving'
           state 'parked', from: 'stopped'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: steady_state
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Nathan Griffith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-10 00:00:00.000000000 Z
+date: 2022-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -16,30 +16,30 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: betterlint
+  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: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-betterment
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -103,7 +117,8 @@ files:
 - spec/steady_state/attribute_spec.rb
 homepage: 
 licenses: []
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -112,14 +127,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.5
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Minimalist state management via "an enum with guard rails"