specy_docs 0.1.0

data/lib/specy_docs.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'specy_docs/version'
+require 'specy_docs/configuration'
+require 'specy_docs/capturable'
+require 'specy_docs/report_generator'
+require 'specy_docs/engine'
+
+module SpecyDocs
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+
+    # Install Capturable into RSpec.
+    # When +capture_paths+ is configured, includes by file path so specs without
+    # +type: :request+ (e.g. legacy controller specs) can still be captured.
+    # Otherwise includes for +type: :request+ only.
+    def setup_rspec(rspec_config)
+      paths = Array(configuration.capture_paths).map(&:to_s).reject(&:empty?)
+
+      if paths.empty?
+        rspec_config.include Capturable, type: :request
+      else
+        rspec_config.include Capturable, file_path: capture_paths_pattern(paths)
+      end
+    end
+
+    def capture_paths_pattern(paths = configuration.capture_paths)
+      Regexp.union(
+        Array(paths).map(&:to_s).reject(&:empty?).map do |path|
+          escaped = Regexp.escape(path.sub(%r{\A\./}, '').delete_suffix('/'))
+          %r{(?:\A|/|\./)#{escaped}/}
+        end
+      )
+    end
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: specy_docs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thabo Titus
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+description: Capture request/response examples from RSpec request specs and serve
+  a browsable docs UI from a mountable Rails engine.
+email:
+- hello@thabotitus.co.za
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- app/controllers/specy_docs/application_controller.rb
+- app/controllers/specy_docs/docs_controller.rb
+- app/frontend/app.js
+- app/frontend/styles.css
+- app/views/specy_docs/docs/show.html.erb
+- config/routes.rb
+- lib/specy_docs.rb
+- lib/specy_docs/capturable.rb
+- lib/specy_docs/configuration.rb
+- lib/specy_docs/engine.rb
+- lib/specy_docs/report_generator.rb
+- lib/specy_docs/tasks/specy_docs_tasks.rake
+- lib/specy_docs/version.rb
+homepage: https://github.com/thabotitus/specy_docs
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/thabotitus/specy_docs
+  source_code_uri: https://github.com/thabotitus/specy_docs
+  changelog_uri: https://github.com/thabotitus/specy_docs/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Mountable API docs generated from RSpec request captures
+test_files: []