openapi_components 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 22cf1d49b2868f8264758ffcd466461b999abd3a6138e852228086fbb10dbadd
+  data.tar.gz: 8d84dc30e4ef16d72752fe5f248884bd7c8508f85edba61586b122aef9768655
+SHA512:
+  metadata.gz: 6799d7375dd7c7bb5df9b3df749f26b2b5919028596069d4421b1e8907de5f426c6d4553ac8a129acda40e9378c7c641d33ae2bc9485741a8e2733f28e8f50bd
+  data.tar.gz: 9ddc4730cd2045c1e54b841b60df884325ea1fcf618654b370f6426da2517bf8d17109a9c359d7a9788eacd66412955cd02d037bde4a0910de2357d560165407

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-09-02
+
+- `OpenapiComponents::Loader` / `OpenapiComponents.load`: assemble an OpenAPI document from
+  `base.*` plus one file per component; YAML, JSON and Ruby sources; nested directories;
+  shared modules; collision detection across shared, local and inline components.
+- Ruby component files evaluate against a context with a `ref(name, type = :schemas)` helper.
+- `verify_refs` (default on) raises `BrokenReferenceError` for dangling internal `$ref`.
+- `OpenapiComponents::Lint.broken_refs`, `.orphans`, `.load` for finished documents.
+- Global `OpenapiComponents.configure` with per-call overrides.
+- Requires Ruby >= 3.1.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at cheerful.mf@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.13"
+gem "rubocop", "~> 1.75"
+gem "rubocop-rspec", "~> 3.5"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Mark Frost
+
+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,184 @@
+# openapi_components
+
+One file per OpenAPI component, assembled into a document. Built for [rswag](https://github.com/rswag/rswag), works with anything that takes an OpenAPI document as Ruby data.
+
+rswag generates `paths` from your request specs, but everything under `components` still has to be
+handed to it as one big hash per document. Past a few dozen schemas that hash becomes a single
+multi-thousand-line YAML file nobody wants to touch, and the enums inside it drift away from the
+constants in your code.
+
+`openapi_components` replaces that file with a directory tree:
+
+```
+swagger/
+├── shared/
+│   └── widgets/
+│       └── schemas/
+│           ├── Widget.yml
+│           └── WidgetOptions.yml
+└── settings/
+    ├── base.yml                  # info, servers, security — everything but components and paths
+    ├── schemas/
+    │   ├── Account.yml
+    │   ├── AccountKind.rb        # a Ruby file: enums come from your code
+    │   └── nested/Address.json   # nesting is free, only the file name matters
+    ├── parameters/
+    │   └── page.yml
+    ├── responses/
+    │   └── NotFound.yml
+    └── securitySchemes/
+        └── bearerAuth.yml
+```
+
+Every file becomes one entry under `components/<directory>/<file name>`. Formats: `.yml`, `.yaml`,
+`.json`, `.rb`. All nine OpenAPI 3.x component types are supported (`schemas`, `responses`,
+`parameters`, `examples`, `requestBodies`, `headers`, `securitySchemes`, `links`, `callbacks`).
+
+The gem has no runtime dependencies and does not depend on rswag itself: it produces a plain Hash,
+so it works with anything that accepts an OpenAPI document as Ruby data.
+
+## Installation
+
+```ruby
+group :development, :test do
+  gem "openapi_components"
+end
+```
+
+## Usage with rswag
+
+```ruby
+# spec/swagger_helper.rb
+require "openapi_components"
+
+OpenapiComponents.configure do |config|
+  config.root = Rails.root.join("swagger")
+end
+
+RSpec.configure do |config|
+  config.openapi_root = Rails.root.join("swagger-build").to_s
+  config.openapi_specs = {
+    "settings.yml" => OpenapiComponents.load(:settings, shared: %i[widgets periods]),
+    "reports.yml"  => OpenapiComponents.load(:reports, shared: %i[widgets]),
+    "core.yml"     => OpenapiComponents.load(:core)
+  }
+  config.openapi_format = :yaml
+end
+```
+
+`OpenapiComponents.load(name, **options)` is shorthand for `OpenapiComponents::Loader.new(name, **options).call`.
+Keys in the returned hash are symbols, which is what rswag expects.
+
+### Base file
+
+`<root>/<name>/base.{yml,yaml,json,rb}` is the document skeleton. Anything goes in it; `components`
+may be omitted, `~`, or contain inline entries (those participate in collision detection like files do).
+
+### Shared modules
+
+Components used by several documents live under `<root>/<shared_dir>/<module>/<componentType>/`
+and are pulled in with `shared:`. Shared modules load first, so a document-local file with the same
+name raises `NameAlreadyUsedError` instead of silently winning.
+
+### Ruby components
+
+A `.rb` file is evaluated and its last expression is the component. Constants resolve from the top
+level, so application code is right there:
+
+```ruby
+# swagger/settings/schemas/AccountKind.rb
+{ type: "string", enum: Account::KINDS.keys }
+```
+
+```ruby
+# swagger/settings/schemas/Accounts.rb
+{
+  type: "array",
+  maxItems: Account::PAGE_SIZE,
+  items: ref("Account")            # => { "$ref" => "#/components/schemas/Account" }
+}
+```
+
+`ref(name, type = :schemas)` is the only helper. Anything responding to `to_h` is accepted, so
+a `Struct`, a `Data` instance, or the output of your favourite JSON Schema builder all work.
+
+Because `.rb` and `.yml` files sit side by side, you can migrate one component at a time.
+
+### Reference verification
+
+By default the loader raises `BrokenReferenceError` when a component points at
+`#/components/...` that does not exist in the assembled document. Only internal pointers are
+checked; external references (`other.yml#/...`) are ignored. Turn it off per document with
+`verify_refs: false` or globally in the configuration.
+
+## Lint
+
+`OpenapiComponents::Lint` works on the loader output and on finished files, for example what
+`rake rswag:specs:swaggerize` writes. That matters for orphan detection: only the finished file
+has the `paths` that make a component "used".
+
+```ruby
+# spec/openapi_lint_spec.rb
+RSpec.describe "OpenAPI documents" do
+  Dir[Rails.root.join("swagger-build/*.yml")].each do |file|
+    describe File.basename(file) do
+      let(:document) { OpenapiComponents::Lint.load(file) }
+
+      it "has no dangling $ref" do
+        expect(OpenapiComponents::Lint.broken_refs(document)).to be_empty
+      end
+
+      it "has no unreferenced components" do
+        expect(OpenapiComponents::Lint.orphans(document)).to be_empty
+      end
+    end
+  end
+end
+```
+
+* `broken_refs(document)` returns `Reference(target, location)` structs for every internal `$ref`
+  that resolves to nothing.
+* `orphans(document)` returns `Orphan(type, name)` structs for components unreachable from anything
+  outside `components`. Reachability is transitive, so two unused schemas that reference each other
+  are both reported. `securitySchemes` are skipped because `security:` requirements name them
+  without `$ref`.
+* `load(path)` reads a YAML document with symbolized keys.
+
+Running the orphan check on a real project for the first time is usually revealing: with
+`shared:` modules it is easy to pull a hundred schemas into a document that references six of them.
+
+## Configuration
+
+| option              | default    | meaning                                                          |
+|---------------------|------------|------------------------------------------------------------------|
+| `root`              | `"swagger"`| directory containing the document folders                        |
+| `shared_dir`        | `"shared"` | folder under `root` holding shared modules; cannot be a document |
+| `permitted_classes` | `[Date]`   | passed to `YAML.safe_load_file` for the `.yml` files             |
+| `verify_refs`       | `true`     | raise on dangling internal `$ref` after assembling               |
+
+Every option can be set globally through `OpenapiComponents.configure` or per document as a keyword
+to `Loader.new` / `OpenapiComponents.load`.
+
+## Errors
+
+All errors inherit from `OpenapiComponents::Error`.
+
+| error                  | when                                                             |
+|------------------------|------------------------------------------------------------------|
+| `ReservedNameError`    | the document name equals `shared_dir`                            |
+| `MissingBaseError`     | no `base.*` in the document folder                               |
+| `AmbiguousBaseError`   | more than one `base.*`                                           |
+| `NameAlreadyUsedError` | the same component name from two sources (file, shared, inline)  |
+| `InvalidSourceError`   | a file did not produce a Hash                                    |
+| `BrokenReferenceError` | dangling internal `$ref` with `verify_refs` on                   |
+
+## Development
+
+```
+bin/setup
+bundle exec rake        # rspec + rubocop
+```
+
+## License
+
+MIT. See [LICENSE.txt](LICENSE.txt).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/openapi_components/configuration.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module OpenapiComponents
+  class Configuration
+    attr_accessor :root, :shared_dir, :permitted_classes, :verify_refs
+
+    def initialize
+      @root = "swagger"
+      @shared_dir = "shared"
+      @permitted_classes = [Date]
+      @verify_refs = true
+    end
+  end
+end

data/lib/openapi_components/errors.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module OpenapiComponents
+  class Error < StandardError; end
+
+  class ReservedNameError < Error
+    def initialize(name)
+      super("`#{name}` is the shared directory and cannot be loaded as a document")
+    end
+  end
+
+  class MissingBaseError < Error
+    def initialize(dir)
+      super("No base.{yml,yaml,json,rb} found in #{dir}")
+    end
+  end
+
+  class AmbiguousBaseError < Error
+    def initialize(paths)
+      super("More than one base file found:\n  #{paths.join("\n  ")}")
+    end
+  end
+
+  class NameAlreadyUsedError < Error
+    def initialize(document:, type:, name:, first:, second:)
+      super("[#{document}] #{type}/#{name} is defined twice:\n  #{first}\n  #{second}")
+    end
+  end
+
+  class InvalidSourceError < Error
+    def initialize(path, value)
+      super("#{path} must evaluate to a Hash, got #{value.class}")
+    end
+  end
+
+  class UnsupportedFormatError < Error
+    def initialize(path)
+      super("#{path}: unsupported extension, expected one of #{Source::EXTENSIONS.join(", ")}")
+    end
+  end
+
+  class BrokenReferenceError < Error
+    def initialize(document, references)
+      list = references.map { |ref| "  #{ref.target} (at #{ref.location})" }
+      super("[#{document}] unresolved $ref:\n#{list.join("\n")}")
+    end
+  end
+end

data/lib/openapi_components/hash_utils.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module OpenapiComponents
+  module HashUtils
+    module_function
+
+    def deep_symbolize_keys(value)
+      case value
+      when Hash
+        value.to_h { |key, nested| [key.respond_to?(:to_sym) ? key.to_sym : key, deep_symbolize_keys(nested)] }
+      when Array
+        value.map { |item| deep_symbolize_keys(item) }
+      else
+        value
+      end
+    end
+  end
+end

data/lib/openapi_components/lint.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module OpenapiComponents
+  # Static checks over an assembled document. Works on the loader output as
+  # well as on a finished file (e.g. what `rswag:specs:swaggerize` wrote), so
+  # orphan detection can see the paths rswag adds later.
+  module Lint
+    Reference = Struct.new(:target, :location)
+    Orphan = Struct.new(:type, :name)
+
+    POINTER = %r{\A#/components/(?<type>[^/]+)/(?<name>[^/]+)\z}
+
+    # Security schemes are referenced by name through `security:` requirements,
+    # never through $ref, so reachability analysis cannot see them.
+    UNTRACKED_TYPES = %i[securitySchemes].freeze
+
+    module_function
+
+    def load(path, permitted_classes: [Date, Time])
+      HashUtils.deep_symbolize_keys(YAML.safe_load_file(path, permitted_classes: permitted_classes, aliases: true))
+    end
+
+    def broken_refs(document)
+      document = HashUtils.deep_symbolize_keys(document)
+      references(document).reject { |reference| resolve(document, reference.target) }
+    end
+
+    def orphans(document)
+      document = HashUtils.deep_symbolize_keys(document)
+      reachable = reachable_targets(document)
+
+      each_component(document).reject { |type, name| reachable.include?(pointer(type, name)) }
+                              .map { |type, name| Orphan.new(type, name) }
+    end
+
+    def reachable_targets(document)
+      reachable = Set.new
+      queue = references(document.except(:components)).map(&:target)
+
+      until queue.empty?
+        target = queue.shift
+        next unless reachable.add?(target)
+
+        node = resolve(document, target)
+        queue.concat(references(node).map(&:target)) if node
+      end
+
+      reachable
+    end
+
+    def references(node, location = [], found = [])
+      children(node).each do |key, value|
+        if ref?(key, value)
+          found << Reference.new(value, location.join("/"))
+        else
+          references(value, location + [key], found)
+        end
+      end
+      found
+    end
+
+    def children(node)
+      case node
+      when Hash then node
+      when Array then node.each_with_index.map { |value, index| [index, value] }
+      else []
+      end
+    end
+
+    def ref?(key, value)
+      key == :$ref && value.is_a?(String) && value.start_with?("#/components/")
+    end
+
+    def resolve(document, target)
+      match = POINTER.match(target)
+      return unless match
+
+      document.dig(:components, match[:type].to_sym, match[:name].to_sym)
+    end
+
+    def pointer(type, name)
+      "#/components/#{type}/#{name}"
+    end
+
+    def each_component(document)
+      (document[:components] || {}).flat_map do |type, entries|
+        next [] if UNTRACKED_TYPES.include?(type) || !entries.is_a?(Hash)
+
+        entries.keys.map { |name| [type, name] }
+      end
+    end
+  end
+end

data/lib/openapi_components/loader.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module OpenapiComponents
+  # Assembles one OpenAPI document from a directory tree:
+  #
+  #   <root>/<name>/base.{yml,json,rb}          document skeleton (info, servers, security, ...)
+  #   <root>/<name>/<componentType>/**/<Name>.* one component per file, keyed by the file name
+  #   <root>/<shared_dir>/<module>/<componentType>/**/<Name>.*   opt-in via `shared:`
+  #
+  # Shared modules load first, so a document-local file with the same name is
+  # reported as a collision rather than silently winning.
+  class Loader
+    attr_reader :name, :root, :shared, :shared_dir, :permitted_classes, :verify_refs
+
+    def initialize(name, shared: [], root: nil, shared_dir: nil, permitted_classes: nil, verify_refs: nil)
+      config = OpenapiComponents.configuration
+      @name = name.to_s
+      @shared = Array(shared).map(&:to_s)
+      @root = (root || config.root).to_s
+      @shared_dir = (shared_dir || config.shared_dir).to_s
+      @permitted_classes = permitted_classes || config.permitted_classes
+      @verify_refs = verify_refs.nil? ? config.verify_refs : verify_refs
+    end
+
+    def call
+      raise ReservedNameError, name if name == shared_dir
+
+      @sources = {}
+      document = base
+      document[:components] = components_of(document)
+      register_inline_components(document)
+
+      COMPONENT_TYPES.each { |type| component_paths(type).each { |path| add(document, type, path) } }
+
+      check_references(document) if verify_refs
+      document
+    end
+
+    private
+
+    def component_paths(type)
+      shared.flat_map { |mod| Source.glob(File.join(root, shared_dir, mod, type.to_s)) } +
+        Source.glob(File.join(root, name, type.to_s))
+    end
+
+    def base
+      candidates = Dir.glob(File.join(root, name, "base{#{Source::EXTENSIONS.join(",")}}"))
+      raise MissingBaseError, File.join(root, name) if candidates.empty?
+      raise AmbiguousBaseError, candidates if candidates.size > 1
+
+      Source.read(candidates.first, permitted_classes: permitted_classes)
+    end
+
+    def components_of(document)
+      components = document[:components]
+      components.is_a?(Hash) ? components : {}
+    end
+
+    def register_inline_components(document)
+      document[:components].each do |type, entries|
+        next unless entries.is_a?(Hash)
+
+        entries.each_key { |component_name| @sources[[type, component_name]] = "#{base_path} (inline)" }
+      end
+    end
+
+    def base_path
+      File.join(root, name, "base.*")
+    end
+
+    def add(document, type, path)
+      component_name = File.basename(path, File.extname(path)).to_sym
+      previous = @sources[[type, component_name]]
+      if previous
+        raise NameAlreadyUsedError.new(document: name, type: type, name: component_name, first: previous, second: path)
+      end
+
+      @sources[[type, component_name]] = path
+      (document[:components][type] ||= {})[component_name] = Source.read(path, permitted_classes: permitted_classes)
+    end
+
+    def check_references(document)
+      broken = Lint.broken_refs(document)
+      raise BrokenReferenceError.new(name, broken) unless broken.empty?
+    end
+  end
+end

data/lib/openapi_components/ruby_context.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module OpenapiComponents
+  # The object a `.rb` component file is evaluated against. The file's last
+  # expression is the component; constants resolve from the top level, so
+  # application code (enums, limits, defaults) can be interpolated directly.
+  class RubyContext
+    def initialize(path)
+      @__path = path
+    end
+
+    def ref(name, type = :schemas)
+      { "$ref" => "#/components/#{type}/#{name}" }
+    end
+
+    def __evaluate
+      instance_eval(File.read(@__path), @__path, 1)
+    end
+  end
+end

data/lib/openapi_components/source.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module OpenapiComponents
+  module Source
+    EXTENSIONS = %w[.yml .yaml .json .rb].freeze
+
+    module_function
+
+    def glob(dir)
+      Dir.glob(File.join(dir, "**", "*{#{EXTENSIONS.join(",")}}"))
+    end
+
+    def read(path, permitted_classes:)
+      value = case File.extname(path)
+              when ".yml", ".yaml" then YAML.safe_load_file(path, permitted_classes: permitted_classes, aliases: true)
+              when ".json" then JSON.parse(File.read(path))
+              when ".rb" then RubyContext.new(path).__evaluate
+              else raise UnsupportedFormatError, path
+              end
+
+      HashUtils.deep_symbolize_keys(coerce(path, value))
+    end
+
+    def coerce(path, value)
+      return value if value.is_a?(Hash)
+      return value.to_h if !value.nil? && !value.is_a?(Array) && value.respond_to?(:to_h)
+
+      raise InvalidSourceError.new(path, value)
+    end
+  end
+end

data/lib/openapi_components/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module OpenapiComponents
+  VERSION = "0.1.0"
+end

data/lib/openapi_components.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "date"
+require "json"
+require "set"
+require "yaml"
+
+require_relative "openapi_components/version"
+require_relative "openapi_components/errors"
+require_relative "openapi_components/configuration"
+require_relative "openapi_components/hash_utils"
+require_relative "openapi_components/ruby_context"
+require_relative "openapi_components/source"
+require_relative "openapi_components/loader"
+require_relative "openapi_components/lint"
+
+module OpenapiComponents
+  # Every reusable object type OpenAPI 3.x allows under `components`.
+  COMPONENT_TYPES = %i[
+    schemas responses parameters examples requestBodies headers securitySchemes links callbacks
+  ].freeze
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+
+    def load(name, **options)
+      Loader.new(name, **options).call
+    end
+  end
+end

data/openapi_components.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/openapi_components/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "openapi_components"
+  spec.version = OpenapiComponents::VERSION
+  spec.authors = ["Mark Frost"]
+  spec.email = ["cheerful.mf@gmail.com"]
+
+  spec.summary = "One file per OpenAPI component, assembled into a document. Built for rswag, works with anything."
+  spec.description = <<~TEXT
+    Keep every OpenAPI component (schema, parameter, response, ...) in its own YAML, JSON or Ruby
+    file, share components between documents, and assemble the hash rswag's `config.openapi_specs`
+    (or any other OpenAPI consumer) expects. Ruby component files can reference application
+    constants, so enums and limits stay defined once. Ships a linter for dangling $ref pointers and
+    unreferenced components.
+  TEXT
+  spec.homepage = "https://github.com/frostmark/openapi_components"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.1.0"
+
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|spec)/|\.(?:git|github|rspec|rubocop))})
+    end
+  end
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: openapi_components
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mark Frost
+bindir: bin
+cert_chain: []
+date: 2026-09-02 00:00:00.000000000 Z
+dependencies: []
+description: |
+  Keep every OpenAPI component (schema, parameter, response, ...) in its own YAML, JSON or Ruby
+  file, share components between documents, and assemble the hash rswag's `config.openapi_specs`
+  (or any other OpenAPI consumer) expects. Ruby component files can reference application
+  constants, so enums and limits stay defined once. Ships a linter for dangling $ref pointers and
+  unreferenced components.
+email:
+- cheerful.mf@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/openapi_components.rb
+- lib/openapi_components/configuration.rb
+- lib/openapi_components/errors.rb
+- lib/openapi_components/hash_utils.rb
+- lib/openapi_components/lint.rb
+- lib/openapi_components/loader.rb
+- lib/openapi_components/ruby_context.rb
+- lib/openapi_components/source.rb
+- lib/openapi_components/version.rb
+- openapi_components.gemspec
+homepage: https://github.com/frostmark/openapi_components
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/frostmark/openapi_components
+  changelog_uri: https://github.com/frostmark/openapi_components/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.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: One file per OpenAPI component, assembled into a document. Built for rswag,
+  works with anything.
+test_files: []