transition_through 1.0.0.pre.beta.1

checksums.yaml

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

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## [Unreleased]
+
+## v1.0.0
+
+Initial release.

data/CONTRIBUTING.md

@@ -0,0 +1,33 @@
+## Security issues
+
+If you have found a security related issue, please do not file an issue on
+GitHub or send a PR addressing the issue. Contact [Keygen](mailto:security@keygen.sh)
+directly. You will be given public credit for your disclosure.
+
+## Reporting issues
+
+Please try to answer the following questions in your bug report:
+
+- What did you do?
+- What did you expect to happen?
+- What happened instead?
+
+Make sure to include as much relevant information as possible. Ruby version,
+Rails version, `transition_through` version, OS version and any stack traces
+you have are very valuable.
+
+## Pull Requests
+
+- **Add tests!** Your patch won't be accepted if it doesn't have tests.
+
+- **Document any change in behaviour**. Make sure the README and any other
+  relevant documentation are kept up-to-date.
+
+- **Create topic branches**. Please don't ask us to pull from your master branch.
+
+- **One pull request per feature**. If you want to do more than one thing, send
+  multiple pull requests.
+
+- **Send coherent history**. Make sure each individual commit in your pull
+  request is meaningful. If you had to make multiple intermediate commits while
+  developing, please squash them before sending them to us.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2024 Keygen LLC
+
+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

@@ -0,0 +1,64 @@
+# transition_through
+
+[![CI](https://github.com/keygen-sh/transition_through/actions/workflows/test.yml/badge.svg)](https://github.com/keygen-sh/transition_through/actions)
+[![Gem Version](https://badge.fury.io/rb/transition_through.svg)](https://badge.fury.io/rb/transition_through)
+
+Assert state changes in sequence. Like `change { ... }`, but for asserting
+multiple changes in RSpec.
+
+Sponsored by:
+
+<a href="https://keygen.sh?ref=transition_through">
+  <div>
+    <img src="https://keygen.sh/images/logo-pill.png" width="200" alt="Keygen">
+  </div>
+</a>
+
+_A fair source software licensing and distribution API._
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem 'transition_through'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install transition_through
+```
+
+## Usage
+
+```ruby
+it 'should transition through' do
+  expect { counter.increment(3) }.to transition { counter.count }.through 0..3
+end
+```
+
+## Supported Rubies
+
+**`transition_through` supports Ruby 3.1 and above.** We encourage you to upgrade
+if you're on an older version. Ruby 3 provides a lot of great features, like
+better pattern matching and a new shorthand hash syntax.
+
+## Is it any good?
+
+Yes.
+
+## Contributing
+
+If you have an idea, or have discovered a bug, please open an issue or create a
+pull request.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/SECURITY.md

@@ -0,0 +1,8 @@
+# Security Policy
+
+## Reporting a vulnerability
+
+If you find a vulnerability in `transition_through`, please contact Keygen via
+[email](mailto:security@keygen.sh).
+
+You will be given public credit for your disclosure.

data/lib/transition_through/expression.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'prism'
+
+module TransitionThrough
+  ##
+  # TransitionExpression walks a Prism AST until we find a transition expression, e.g.:
+  #
+  #   expect { ... }.to transition { ... }.through [...]
+  #
+  # Returns the transition state in the transition block as a Result.
+  class Expression < Prism::Visitor
+    attr_reader :at, :result
+
+    def initialize(at:) = @at = at
+
+    # FIXME(ezekg) right now this only supports simple expressions, e.g. object.foo not object.foo(1).bar.
+    def visit_call_node(node)
+      case node
+      in name: :transition, block: Prism::BlockNode(body: Prism::Node(body: [Prism::CallNode(receiver:, name: method_name)]), location:) if location.start_line == at
+        @result = Result.new(receiver:, method_name:)
+      else
+        super
+      end
+    end
+
+    private
+
+    class Result
+      attr_reader :receiver, :method_name
+
+      def initialize(receiver:, method_name:)
+        @receiver    = receiver
+        @method_name = method_name
+      end
+    end
+  end
+end
+

data/lib/transition_through/matcher.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'rspec'
+require 'rspec/mocks/standalone'
+
+require_relative 'expression'
+
+module TransitionThrough
+  class Matcher
+    include RSpec::Matchers, RSpec::Matchers::Composable, RSpec::Mocks::ExampleMethods
+
+    attr_reader :state_block
+
+    def initialize(state_block)
+      @state_block     = state_block
+      @expected_states = []
+      @actual_states   = []
+    end
+
+    def supports_block_expectations? = true
+    def matches?(expect_block)
+      path, start_line = state_block.source_location
+
+      # walk the ast until we find our transition expression
+      exp = Expression.new(at: start_line)
+      ast = Prism.parse_file(path)
+
+      ast.value.accept(exp)
+
+      # raise if the expression is empty
+      raise InvalidExpressionError 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
+        receiver.respond_to?(:"#{exp.result.method_name}=") &&
+        receiver.respond_to?(exp.result.method_name)
+
+      # get the receiver's methods for stubbing
+      setter = receiver.method(:"#{exp.result.method_name}=")
+      getter = receiver.method(exp.result.method_name)
+
+      # record initial state via getter
+      @expected_states = @actual_states = [getter.call]
+
+      # stub the setter so that we can track state transitions
+      allow(receiver).to receive(setter.name) do |value|
+        @actual_states << value
+
+        setter.call(value)
+      end
+
+      # call the expect block
+      expect_block.call
+
+      # assert states match
+      @actual_states == @expected_states
+    end
+
+    def through(*values)
+      @expected_states = values.flatten(1)
+
+      self
+    end
+
+    def failure_message
+      "expected block to transition through #{@expected_states.inspect} but it transitioned through #{@actual_states.inspect}"
+    end
+
+    def failure_message_when_negated
+      "expected block not to transition through #{@expected_states.inspect} but it did"
+    end
+  end
+end
+

data/lib/transition_through/methods.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'matcher'
+
+module TransitionThrough
+  module Methods
+    def transition(&block) = Matcher.new(block)
+  end
+end
+

data/lib/transition_through/version.rb

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

data/lib/transition_through.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'transition_through/version'
+require_relative 'transition_through/expression'
+require_relative 'transition_through/matcher'
+require_relative 'transition_through/methods'
+
+module TransitionThrough
+  class InvalidExpressionError < StandardError; end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: transition_through
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre.beta.1
+platform: ruby
+authors:
+- Zeke Gabrielse
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: temporary_tables
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: prism
+  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'
+description: Assert state changes through multiple values for an object, enabling
+  you to test complex state transitions in sequence.
+email:
+- oss@keygen.sh
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE
+- README.md
+- SECURITY.md
+- lib/transition_through.rb
+- lib/transition_through/expression.rb
+- lib/transition_through/matcher.rb
+- lib/transition_through/methods.rb
+- lib/transition_through/version.rb
+homepage: https://github.com/keygen-sh/transition_through
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.4.13
+signing_key: 
+specification_version: 4
+summary: Assert state changes in sequence. Like change{}, but for asserting multiple
+  changes in RSpec.
+test_files: []