transition_through 1.0.0.pre.beta.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 245765e994574db116dd542c12e40bd84fe6487f130f647761fc542a19745b45
-  data.tar.gz: fd51b8b84f3c552abb310b6e8912c657449474b80e481f05d4f08b5eb8bca266
+  metadata.gz: 0d41241876048696d75e8385c63202cb72388eff35471a01a4e5501254f97b3d
+  data.tar.gz: 9c5dcb7d15d133d6f128d037bf2769ecf66d0fea596832fc72f5813cccc0157c
 SHA512:
-  metadata.gz: 9b671d76bcece48f74db7248870a0182b841dc52484007802128d727a5ea2d5d075f66b202953450c19207527d99a88d70d0ebf481d0e999c99d049e0d8f3007
-  data.tar.gz: ca866a6ef2d58f7ca14c9b4a46218e445dd205c3df0f42f7170044127fb8de43cf4818edf1bb1bd68b1fb57dbcd4f72699c7ce4c52a7eb1fb0ca242114ffda77
+  metadata.gz: 5bf54daf3b5d0e04e7f9653cfd3d7dbf3ef3e582ffed4e6a6f01bc982214090ddccf953a4da9187a1683d7fac404ad848a1c3f1b347b27062587c0d08970e5cc
+  data.tar.gz: de27354247781e9728b735cf5864c42e775c7496bcccf392b0c65daca1710a6f84fe4b78e3307697a73d6d59eea70c74cc3114233d95406fe5f17dd57408b10b

data/README.md

@@ -40,10 +40,34 @@ $ gem install transition_through
 
 ```ruby
 it 'should transition through' do
-  expect { counter.increment(3) }.to transition { counter.count }.through 0..3
+  counter = Counter.new
+  count   = -> {
+    counter.count = 0
+    counter.increment
+    counter.count  = counter.count + 3
+    counter.count -= 2
+    counter.decrement(by: 2)
+  }
+
+  expect { count.call }.to transition { counter.count }.through [0, 1, 4, 2, 0]
+end
+
+it 'should transition nowhere' do
+  counter = Counter.new
+  count   = -> {}
+
+  expect { count.call }.to transition { counter.count }.nowhere
 end
 ```
 
+## Note on instance variables
+
+Currently, mutating state through an instance variable is not supported. This
+due to the fact that instance variables cannot be observed for changes like an
+accessor can. For more information, see [the tests](https://github.com/keygen-sh/transition_through/blob/d2c6b685e4959d08e70bb5012af98fa01fcdebef/spec/transition_through_spec.rb#L8-L21).
+
+If you know of a way to support ivars, please open an issue or PR.
+
 ## Supported Rubies
 
 **`transition_through` supports Ruby 3.1 and above.** We encourage you to upgrade

data/lib/transition_through/matcher.rb

@@ -19,6 +19,8 @@ module TransitionThrough
 
     def supports_block_expectations? = true
     def matches?(expect_block)
+      raise InvalidExpressionError, 'transition block is required' if state_block.nil?
+
       path, start_line = state_block.source_location
 
       # walk the ast until we find our transition expression
@@ -27,14 +29,14 @@ module TransitionThrough
 
       ast.value.accept(exp)
 
-      # raise if the expression is empty
-      raise InvalidExpressionError if
+      # raise if the expression is too complex or empty
+      raise InvalidExpressionError, 'complex or empty transition expressions are not supported' if
         exp.result.nil? || exp.result.receiver.nil? || exp.result.method_name.nil?
 
       # get the actual transitioning object from the state block's binding
       receiver = state_block.binding.eval(exp.result.receiver.name.to_s)
 
-      raise InvalidExpressionError unless
+      raise InvalidExpressionError, "expected accessor #{receiver.class}##{exp.result.method_name} but it's missing" unless
         receiver.respond_to?(:"#{exp.result.method_name}=") &&
         receiver.respond_to?(exp.result.method_name)
 
@@ -59,12 +61,16 @@ module TransitionThrough
       @actual_states == @expected_states
     end
 
+    # assert state changes across array or range of values
     def through(*values)
       @expected_states = values.flatten(1)
 
-      self
+      self # allow chaining
     end
 
+    # noop because no change is default assertion
+    def nowhere = self
+
     def failure_message
       "expected block to transition through #{@expected_states.inspect} but it transitioned through #{@actual_states.inspect}"
     end

data/lib/transition_through/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TransitionThrough
-  VERSION = '1.0.0-beta.1'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: transition_through
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.beta.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Zeke Gabrielse
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Assert state changes through multiple values for an object, enabling
-  you to test complex state transitions in sequence.
+  you to test complex state transitions in sequence with RSpec.
 email:
 - oss@keygen.sh
 executables: []
@@ -113,9 +113,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.4.13
 signing_key: