grape-oas 1.3.0 → 1.5.0

data/lib/grape_oas/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GrapeOAS
-  VERSION = "1.3.0"
+  VERSION = "1.5.0"
 end

data/lib/grape_oas.rb

@@ -46,6 +46,29 @@ module GrapeOAS
   # Used by the default logger and the test capture helper.
   LOG_FORMATTER = proc { |_severity, _datetime, _progname, msg| "[grape-oas] #{msg}\n" }
 
+  # Default mapping from a schema's canonical class name to its OAS component/definition ref name.
+  # Replaces Ruby's `::` module separator with `_` so ref names are valid across tooling that rejects colons.
+  DEFAULT_SCHEMA_REF_NAME = ->(name) { name.gsub("::", "_") }
+
+  # Configurable callable that derives the OAS component/definition ref name
+  # from a schema's canonical class name. Applied to every `$ref` target and
+  # every component/definition key so custom mangling stays consistent.
+  #
+  # @return [#call(String) -> String]
+  def schema_ref_name
+    @schema_ref_name ||= DEFAULT_SCHEMA_REF_NAME
+  end
+
+  # @param value [#call, nil] a callable receiving the canonical name,
+  #   or nil to reset to the default mangler
+  def schema_ref_name=(value)
+    raise ArgumentError, "schema_ref_name must respond to :call (got #{value.class})" if value && !value.respond_to?(:call)
+
+    @schema_ref_name = value
+  end
+
+  module_function :schema_ref_name, :schema_ref_name=
+
   # Configurable logger for schema generation warnings.
   # Defaults to Logger on $stderr. Set to Rails.logger or Logger.new(File::NULL).
   #
@@ -144,11 +167,11 @@ module GrapeOAS
     @type_resolvers ||= begin
       registry = TypeResolvers::Registry.new
       # Register built-in resolvers in order of precedence
-      # ArrayResolver handles "[Type]" patterns first
+      # ArrayResolver handles "[Type]" / "Array[Type, ...]" patterns first
       registry.register(TypeResolvers::ArrayResolver)
       # DryTypeResolver handles Dry::Types (standalone, not arrays)
       registry.register(TypeResolvers::DryTypeResolver)
-      # PrimitiveResolver is the fallback for basic types
+      # PrimitiveResolver handles known Ruby primitives
       registry.register(TypeResolvers::PrimitiveResolver)
       registry
     end
@@ -192,11 +215,18 @@ module GrapeOAS
   #   # Only includes paths like /users, /users/{id}, etc.
   #
   def generate(app:, schema_type: :oas3, **options)
-    if options[:nullable_strategy].nil? && options.key?(:nullable_keyword) && %i[oas3 oas30].include?(schema_type)
-      options[:nullable_strategy] = if options[:nullable_keyword] == false
-                                      Constants::NullableStrategy::TYPE_ARRAY
-                                    else
-                                      Constants::NullableStrategy::KEYWORD
+    if options[:nullable_strategy].nil? && options.key?(:nullable_keyword)
+      options[:nullable_strategy] = case schema_type
+                                    when :oas2
+                                      Constants::NullableStrategy::OAS2_DEFAULT
+                                    when :oas3, :oas30
+                                      if options[:nullable_keyword] == false
+                                        Constants::NullableStrategy::TYPE_ARRAY
+                                      else
+                                        Constants::NullableStrategy::OAS3_DEFAULT
+                                      end
+                                    when :oas31
+                                      Constants::NullableStrategy::OAS31_DEFAULT
                                     end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-oas
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Andrei Subbota
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-27 00:00:00.000000000 Z
+date: 2026-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -47,10 +47,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
-- CONTRIBUTING.md
 - LICENSE.txt
 - README.md
-- RELEASING.md
+- UPGRADING.md
 - grape-oas.gemspec
 - lib/grape-oas.rb
 - lib/grape_oas.rb
@@ -66,6 +65,7 @@ files:
 - lib/grape_oas/api_model_builder.rb
 - lib/grape_oas/api_model_builders/concerns/content_type_resolver.rb
 - lib/grape_oas/api_model_builders/concerns/oas_utilities.rb
+- lib/grape_oas/api_model_builders/concerns/route_validations.rb
 - lib/grape_oas/api_model_builders/concerns/type_resolver.rb
 - lib/grape_oas/api_model_builders/operation.rb
 - lib/grape_oas/api_model_builders/path.rb
@@ -133,6 +133,7 @@ files:
 - lib/grape_oas/schema_constraints.rb
 - lib/grape_oas/type_resolvers/array_resolver.rb
 - lib/grape_oas/type_resolvers/base.rb
+- lib/grape_oas/type_resolvers/default_resolver.rb
 - lib/grape_oas/type_resolvers/dry_type_resolver.rb
 - lib/grape_oas/type_resolvers/primitive_resolver.rb
 - lib/grape_oas/type_resolvers/registry.rb

data/CONTRIBUTING.md

@@ -1,87 +0,0 @@
-# Contributing to Grape::OAS
-
-We welcome contributions to Grape::OAS! This document provides guidelines for contributing.
-
-## Getting Started
-
-1. **Fork the repository** on GitHub
-
-2. **Clone your fork**:
-   ```bash
-   git clone https://github.com/YOUR_USERNAME/grape-oas.git
-   cd grape-oas
-   ```
-
-3. **Set up upstream remote**:
-   ```bash
-   git remote add upstream https://github.com/numbata/grape-oas.git
-   ```
-
-4. **Install dependencies**:
-   ```bash
-   bin/setup
-   ```
-
-## Development Workflow
-
-1. **Create a topic branch**:
-   ```bash
-   git checkout -b my-feature
-   ```
-
-2. **Write tests** for your changes in `test/`
-
-3. **Implement your feature or fix**
-
-4. **Run the test suite**:
-   ```bash
-   bundle exec rake test
-   ```
-
-5. **Run RuboCop**:
-   ```bash
-   bundle exec rubocop
-   ```
-
-6. **Run all checks**:
-   ```bash
-   bundle exec rake
-   ```
-
-## Submitting Changes
-
-1. **Update CHANGELOG.md** under "Unreleased" section
-
-2. **Write clear commit messages** describing what and why
-
-3. **Push to your fork**:
-   ```bash
-   git push origin my-feature
-   ```
-
-4. **Open a Pull Request** against the `main` branch
-
-## Pull Request Guidelines
-
-- Keep PRs focused on a single change
-- Include tests for new functionality
-- Update documentation if needed
-- Ensure CI passes before requesting review
-
-## Code Style
-
-- Follow existing code conventions
-- RuboCop enforces style - run it before committing
-- Use descriptive variable and method names
-
-## Testing
-
-- Write tests for all new functionality
-- Ensure existing tests pass
-- Aim for good coverage of edge cases
-
-## Questions?
-
-Open an issue for questions or discussions about potential changes.
-
-Thank you for contributing!

data/RELEASING.md

@@ -1,109 +0,0 @@
-# Releasing Grape::OAS
-
-This document describes the release process for the grape-oas gem.
-
-## Pre-Release Checks
-
-Before releasing, ensure:
-
-1. All tests pass locally and in CI:
-   ```bash
-   bundle install
-   bundle exec rake
-   ```
-
-2. The CHANGELOG.md is up to date with all changes since the last release.
-
-3. The version number in `lib/grape_oas/version.rb` is correct.
-
-## Release Steps
-
-### Automated Release Process
-
-1. **Update the version** in `lib/grape_oas/version.rb` to the release version
-
-2. **Prepare the CHANGELOG**:
-   ```bash
-   bundle exec rake release:prerelease
-   ```
-   This task will:
-   - Replace "Unreleased" with the version number and today's date
-   - Remove any "Your contribution here" placeholder lines
-   - Commit with message "Preparing for release vX.X.X"
-
-   **Note**: The task is idempotent - safe to run multiple times.
-
-3. **Push and create the release**:
-   ```bash
-   git push origin main
-   bundle exec rake release
-   ```
-   This will:
-   - Build the gem
-   - Create a git tag
-   - Push the tag to GitHub
-   - Push the gem to RubyGems.org
-
-<details>
-<summary>Manual Release Steps (if needed)</summary>
-
-1. **Update CHANGELOG.md**
-   - Change "Unreleased" to the version number and date
-   - Remove any "Your contribution here" placeholder lines
-
-2. **Commit the release preparation**:
-   ```bash
-   git add CHANGELOG.md
-   git commit -m "Preparing for release v0.x.x"
-   git push origin main
-   ```
-
-3. **Create and push the release**:
-   ```bash
-   bundle exec rake release
-   ```
-   This will:
-   - Build the gem
-   - Create a git tag
-   - Push the tag to GitHub
-   - Push the gem to RubyGems.org
-</details>
-
-## Post-Release
-
-You can automate the post-release preparation with:
-
-```bash
-bundle exec rake release:postrelease
-git push origin main
-```
-
-This task will:
-- Bump the patch version in `lib/grape_oas/version.rb`
-- Ensure CHANGELOG.md has an "Unreleased" section with "* Your contribution here" placeholder
-- Commit the changes with message "Prepare for next development iteration"
-
-**Note**: The task is idempotent - safe to run multiple times without duplicating work.
-
-<details>
-<summary>Manual Post-Release Steps (if needed)</summary>
-
-1. **Prepare for next development cycle**:
-   - Add "Unreleased" section to CHANGELOG.md with "* Your contribution here" placeholder
-   - Bump version in `lib/grape_oas/version.rb`
-
-2. **Commit post-release changes**:
-   ```bash
-   git add CHANGELOG.md lib/grape_oas/version.rb
-   git commit -m "Prepare for next development iteration"
-   git push origin main
-   ```
-</details>
-
-## Versioning
-
-This project follows [Semantic Versioning](https://semver.org/):
-
-- **MAJOR**: Incompatible API changes
-- **MINOR**: New functionality in a backward compatible manner
-- **PATCH**: Backward compatible bug fixes