specbook 0.1.0

data/lib/specbook/rspec.rb

@@ -0,0 +1,15 @@
+# Opt-in entrypoint for the Specbook recorders.
+# Host loads via: require "specbook/rspec"
+#
+# Honors the same env-var contract as the original support files —
+# the recorder bodies are wrapped in `if ENV["RECORD_SPECS"]` /
+# `if ENV["RECORD_TRACES"]` so requiring without the env vars set is a no-op.
+#
+# NOTE: We intentionally do NOT define a `Specbook::RSpec` module here. Doing
+# so would shadow the top-level `::RSpec` constant inside any code nested
+# under `module Specbook`, breaking references like `RSpec::Core::ExampleGroup`
+# in the recorder. The file path `specbook/rspec.rb` is the public name of
+# this entrypoint, but it does not expose a corresponding namespace.
+
+require "specbook/recorders/screenshot" if ENV["RECORD_SPECS"]
+require "specbook/recorders/playwright_trace" if ENV["RECORD_TRACES"]

data/lib/specbook/version.rb

@@ -0,0 +1,3 @@
+module Specbook
+  VERSION = "0.1.0"
+end

data/lib/specbook.rb

@@ -0,0 +1,13 @@
+require "specbook/version"
+require "specbook/configuration"
+require "specbook/engine"
+
+module Specbook
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  def self.configure
+    yield config
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: specbook
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Steve Leung
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+- !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: capybara
+  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: turnip
+  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: rack-test
+  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: Specbook is a Rails engine that turns Turnip features and RSpec system
+  specs into a browsable, animated walkthrough — screenshots with element overlays,
+  Gherkin step cards, and Playwright trace viewer.
+email:
+- steve@leungs.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- app/controllers/specbook/application_controller.rb
+- app/controllers/specbook/viewer_controller.rb
+- app/views/specbook/viewer/_app_js.html.erb
+- app/views/specbook/viewer/_screenshots_sidebar.html.erb
+- app/views/specbook/viewer/_styles.html.erb
+- app/views/specbook/viewer/_top_bar.html.erb
+- app/views/specbook/viewer/_traces_sidebar.html.erb
+- app/views/specbook/viewer/_viewer_panel.html.erb
+- app/views/specbook/viewer/show.html.erb
+- config/routes.rb
+- lib/generators/specbook/install/USAGE
+- lib/generators/specbook/install/install_generator.rb
+- lib/generators/specbook/install/templates/README
+- lib/generators/specbook/install/templates/specbook.rb
+- lib/specbook.rb
+- lib/specbook/configuration.rb
+- lib/specbook/engine.rb
+- lib/specbook/recorders/playwright_trace.rb
+- lib/specbook/recorders/screenshot.rb
+- lib/specbook/rspec.rb
+- lib/specbook/version.rb
+homepage: https://github.com/wakiki/specbook
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/wakiki/specbook
+  source_code_uri: https://github.com/wakiki/specbook
+  changelog_uri: https://github.com/wakiki/specbook/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/wakiki/specbook/issues
+  rubygems_mfa_required: 'true'
+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: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: Storybook for your Rails specs. Record. Replay. Review.
+test_files: []