breadkit-rspec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 17012e9c7a478381843b2a2e507146f76694f5b90682e0703d9065f69cdf9edb
+  data.tar.gz: 84fef55083fec4a4d28f978fa284c56962e5889b82f5e76b8246fe1b618c1aec
+SHA512:
+  metadata.gz: 2e33ab84993a87a1befdb285abf3bbbc7f8b44659b91e81ad8db018917b17fd567aca35667e7a9f96ee29c9d87106a28b0387c87e5d6e31a825b827f29739459
+  data.tar.gz: 8a5db88e462b1468a9e54bf73bf53c5625d1e637e93909cbc77701c27f853849d57a14558caff7fc1779af7afb0e66f83a9777d3407e355c7f5d8278a21bc6d6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.1.0
+
+- Initial release.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 ydah
+
+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,56 @@
+# breadkit-rspec
+
+RSpec matchers for resolved [Breadkit](https://github.com/breadkit/breadkit) circuits.
+
+## Install
+
+Requires Ruby 3.3 or newer and Breadkit core 0.2.x:
+
+```sh
+gem install breadkit-rspec
+```
+
+If the required releases are not yet on RubyGems, add both main checkouts to
+your Gemfile:
+
+```ruby
+gem "breadkit", git: "https://github.com/breadkit/breadkit.git", branch: "main"
+gem "breadkit-rspec", git: "https://github.com/breadkit/breadkit-rspec.git", branch: "main"
+```
+
+Require the matchers in `spec/spec_helper.rb`:
+
+```ruby
+require "breadkit/rspec"
+```
+
+## Test a circuit
+
+```ruby
+RSpec.describe "LED circuit" do
+  let(:circuit) { Breadkit.load("circuits/led.bk.rb") }
+
+  it "connects the LED through the resistor" do
+    expect(circuit).to connect("R1.2", "D1.anode")
+    expect(circuit).not_to connect("D1.cathode", :VCC)
+  end
+
+  it "connects the switched input when pressed" do
+    expect(circuit).to connect("R1.1", :VCC).in_state("SW1")
+  end
+end
+```
+
+`connect` resolves pin aliases, named nets, and hole IDs through
+`Breadkit::Circuit#net_of`. It fails when either reference is unknown. Use
+`.in_state("SW1")` for a switch state; an unknown state raises an error.
+Use `.in_state("SW1,SW2")` to close both named switches while leaving the
+others open. Named states do not require enumerating every switch combination.
+
+## Development
+
+Clone `breadkit` and `breadkit-rspec` as sibling directories, then run
+`bundle install` and `bundle exec rake` here. The gem is independent of
+`breadkit-lint` and `breadkit-render`.
+
+MIT licensed. See [LICENSE.txt](LICENSE.txt).

data/lib/breadkit/rspec/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Breadkit
+  module RSpec
+    VERSION = "0.1.0"
+  end
+end

data/lib/breadkit/rspec.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "breadkit"
+require "rspec/expectations"
+require_relative "rspec/version"
+
+RSpec::Matchers.define :connect do |left, right|
+  chain :in_state do |name|
+    @state_name = name.to_s
+  end
+
+  match do |circuit|
+    raise ArgumentError, "expected a Breadkit::Circuit" unless circuit.is_a?(Breadkit::Circuit)
+
+    if @state_name
+      names = @state_name.split(",", -1)
+      switches = names.map { |name| circuit.components[name] }
+      valid = names.uniq.length == names.length &&
+              switches.all? { |component| component && Array(component.part.data["switch"]).any? }
+      raise ArgumentError, "unknown circuit state: #{@state_name}" unless valid
+
+      closed = switches.flat_map { |component| Array(component.part.data["switch"]).map { |pair| [component, pair] } }
+      state = Breadkit::State.new(name: @state_name, closed_switches: closed)
+    end
+
+    @left_net = circuit.net_of(left, state)
+    @right_net = circuit.net_of(right, state)
+    raise ArgumentError, "unknown circuit reference: #{left}" unless @left_net
+    raise ArgumentError, "unknown circuit reference: #{right}" unless @right_net
+
+    @left_net.equal?(@right_net)
+  end
+
+  failure_message do
+    "expected #{left.inspect} and #{right.inspect} to share a net; separate nets " \
+      "(#{@left_net&.name || "unknown"} and #{@right_net&.name || "unknown"})"
+  end
+
+  failure_message_when_negated do
+    "expected #{left.inspect} and #{right.inspect} to be isolated, but both resolve to #{@left_net.name}"
+  end
+end

data/sig/breadkit/rspec.rbs

@@ -0,0 +1,5 @@
+module Breadkit
+  module RSpec
+    VERSION: String
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: breadkit-rspec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yudai Takada
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: breadkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Test resolved Breadkit circuit connections and switch states with RSpec
+  expectations.
+email:
+- t.yudai92@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/breadkit/rspec.rb
+- lib/breadkit/rspec/version.rb
+- sig/breadkit/rspec.rbs
+homepage: https://github.com/breadkit/breadkit-rspec
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/breadkit/breadkit-rspec
+  source_code_uri: https://github.com/breadkit/breadkit-rspec/tree/main
+  documentation_uri: https://github.com/breadkit/breadkit-rspec#readme
+  bug_tracker_uri: https://github.com/breadkit/breadkit-rspec/issues
+  changelog_uri: https://github.com/breadkit/breadkit-rspec/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.16
+specification_version: 4
+summary: RSpec matchers for Breadkit circuits.
+test_files: []