dox 2.4.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28307d7bc11d4b35d5951f89c855b98af58877cb956a8f638a8541b9358d239d
-  data.tar.gz: 62e8c8228e9390adc964fce294ea2c83017a1da64de73d959d30588e22010317
+  metadata.gz: 9a254b169809b99600afcc0dae0e46f55f6214604ceab941215dee84c48d17af
+  data.tar.gz: a3172985b3aeeff16496a2b192808c90429519ac79c4ddb2b2a4b36f7cbc21f4
 SHA512:
-  metadata.gz: 05cc87faaf0602cb9f01bc3cf72ad7d4a98c3db5a331bad7380746f515eeea67f5143763f31107cb3d5aa44a884a62206f669138c0901f01090dcd4930a3199e
-  data.tar.gz: 85bce8dbc8b87d9244db98d449c01e7b26fce507bcdbf1eafaa454c6f554a8562bb68d5e1d949bb28f7b3dc5ac62dfc1f50b246f1619e09a36cf8d1d99aa8929
+  metadata.gz: e47d00386e96ffb5801fcacbafa0f4885dfb7574cbf458e253f0e88d1a6018de7a4efaff29399653c07b625d26695be4b9110ec87284f1be8224374405f21bd9
+  data.tar.gz: d0063b18dfe5c953bacd5b226872f4f19e8b2524c90740741d94c33f17557c48285e540695acff22d3a8b118ce845c11f0659b6b38882671c6f73b77710b48eb

data/.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches: [master]
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.1'
+          bundler-cache: true
+      - name: Run rubocop
+        run: bundle exec rubocop
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['3.1', '3.2', '3.3', '3.4', '4.0']
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rspec

data/.rubocop.yml

@@ -1,17 +1,84 @@
-LineLength:
-  Max: 120
+inherit_gem:
+  rubocop-infinum: rubocop.yml
 
-Documentation:
-  Enabled: False
+plugins:
+  - rubocop-infinum
+  - rubocop-rake
 
-WordArray:
-  Enabled: False
+AllCops:
+  TargetRubyVersion: 3.1
+
+Rails:
+  Enabled: false
+
+Naming/BlockForwarding:
+  Enabled: false
+
+Style/ArgumentsForwarding:
+  Enabled: false
 
 Style/FrozenStringLiteralComment:
   Enabled: false
 
-BlockLength:
-  Max: 250
+Style/HashAsLastArrayItem:
+  Enabled: false
+
+Style/MissingRespondToMissing:
+  Enabled: false
+
+Style/HashTransformValues:
+  Enabled: false
+
+Style/OneClassPerFile:
+  Enabled: false
+
+Lint/ConstantDefinitionInBlock:
+  Enabled: false
+
+Performance/RegexpMatch:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Max: 5
+
+RSpec/NestedGroups:
+  Max: 5
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/IndexedLet:
+  Enabled: false
+
+RSpec/ExpectInHook:
+  Enabled: false
+
+RSpec/BeEq:
+  Enabled: false
+
+RSpec/AnyInstance:
+  Enabled: false
+
+RSpec/VerifiedDoubles:
+  Enabled: false
+
+RSpec/SpecFilePathFormat:
+  Enabled: false
+
+RSpec/VoidExpect:
+  Enabled: false
+
+RSpec/NoExpectationExample:
+  Enabled: false
+
+RSpec/ReceiveMessages:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/ContextWording:
+  Enabled: false
 
-Gemspec/RequiredRubyVersion:
+RSpec/LeakyConstantDeclaration:
   Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.6.7
+3.1.7

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## v3.0.0
+
+### Enhancements
+
+- Added `Dox::HtmlRenderer` for generating HTML documentation from OpenAPI JSON specs. It resolves `$ref` references recursively and delegates HTML generation to an adapter object.
+- `Dox::HtmlRenderer` accepts an overridable `adapter:` argument, so you can provide any renderer object that responds to `build_html(title, spec)`.
+- Added `Dox.config.redoc_version` option to configure the Redoc CDN version used by the default `Dox::RedoclyAdapter` (defaults to `'2.5.1'`)
+- Updated `Dox.config.title` to serve as the fallback title when the OpenAPI spec has no `info.title`
+- Add support for Ruby 4.0
+
+### Breaking changes
+
+- [BREAKING] Dropped support for Ruby 3.0 and below (Ruby 3.1+ is required)
+
+### Good to know
+
+- External Node.js renderers (e.g. `redoc-cli`, `@redocly/cli`, `swagger-ui-offline-packager`) are no longer needed. If you only had them in `package.json` for doc generation, you can remove them and use `Dox::HtmlRenderer` instead.
+
+## v2.5.0 (2024-12-11)
+
+### Enhancements
+
+- Add `#check_file_presence_on_init` option to turn off raising error during resource initialization in case a Resource references an MD file under `#desc` that doesn't exist
+
 ## v2.4.0 (2024-11-21)
 
 ### Enhancements

data/Gemfile

@@ -3,6 +3,19 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in dox.gemspec
 gemspec
 
-rails_version = ENV['RAILS_VERSION'] || '6.0.2'
+rails_version = ENV['RAILS_VERSION'] || '7.2.0'
 
 gem 'activesupport', "~> #{rails_version}"
+
+gem 'bundler'
+gem 'codeclimate-test-reporter'
+gem 'json'
+gem 'ostruct'
+gem 'pry-nav'
+gem 'pry-rails'
+gem 'pry-stack_explorer'
+gem 'rake'
+gem 'rspec', '~> 3.0'
+gem 'rubocop-infinum'
+gem 'rubocop-rake'
+gem 'simplecov'

data/README.md

@@ -14,8 +14,8 @@ Here's a [demo app](https://github.com/infinum/dox-demo).
 Add this line to your application's Gemfile:
 
 ```ruby
-group :test do
-  gem 'dox', require: false
+group :development, :test do
+  gem 'dox'
 end
 ```
 
@@ -51,9 +51,11 @@ Set these optional options in the rails_helper:
 | schema_response_fail_file_path | Pathname instance or fullpath string | Json file that contains the default schema of a failed response. |
 | openapi_version | string | Openapi version (default: '3.0.0' ) |
 | api_version | string | Api Version (default: '1.0') |
-| title | string | Documentation title (default: 'API Documentation') |
+| title | string | Documentation title. Used as fallback when the OpenAPI spec has no `info.title`. (default: 'API Documentation') |
 | header_description | Pathname instance or string | Description (header) of the documentation (default: ''). If pathname ends with `.md`, the file is looked in `descriptions_location` folder |
 | headers_whitelist | Array of headers (strings) | Requests and responses will by default list only `Content-Type` header. To list other http headers, you must whitelist them.|
+| redoc_version | string | Redoc version used for HTML rendering (default: '2.5.1') |
+| check_file_presence_on_init | boolean | Option defaults to true. In case an .md file doesn't exist, dox won't wait for the specs to pass before attempting to print the documentation. It will raise an error early during resource initialization. If you're calling Dox.configure multiple times during the spec suite, you might want to set this to false. |
 
 Example:
 
@@ -67,6 +69,7 @@ Dox.configure do |config|
   config.title = 'API'
   config.api_version = '2.0'
   config.header_description = 'api_description.md'
+  config.redoc_version = '2.5.1'
 end
 ```
 
@@ -264,21 +267,28 @@ end
 ### Generate documentation
 Documentation is generated in 2 steps:
 
-1. generate OpenApi json file:
-```bundle exec rspec --tag apidoc -f Dox::Formatter --order defined --tag dox --out spec/api_doc/v1/schemas/docs.json```
+1. Generate an OpenAPI JSON file from your specs:
 
-2. render HTML with Redoc:
-```redoc-cli bundle -o public/api/docs/v2/docs.html spec/api_doc/v1/schemas/docs.json```
+```
+bundle exec rspec -f Dox::Formatter --order defined --tag dox --out spec/docs/v1/apispec.json
+```
+
+2. Render the OpenAPI JSON file as HTML using the built-in renderer:
+
+```ruby
+Dox::HtmlRenderer.new('spec/docs/v1/apispec.json', 'public/api/v1/docs/index.html').render
+```
+
+`Dox::HtmlRenderer` resolves all `$ref` references in the spec, extracts the title (falling back to `Dox.config.title`), and generates a self-contained HTML file powered by [Redoc](https://github.com/Redocly/redoc). The Redoc JavaScript is loaded from CDN at the version specified by `Dox.config.redoc_version`.
 
+No external Node.js dependencies are required.
 
 #### Use rake tasks
 It's recommendable to write a few rake tasks to make things easier. Here's an example:
 
 ```ruby
 namespace :dox do
-  desc 'Generate API documentation markdown'
-
-  task :json, [:version, :docs_path, :host] => :environment do |_, args|
+  task :json, [:version] => :environment do |_, args|
     require 'rspec/core/rake_task'
     version = args[:version] || :v1
 
@@ -291,27 +301,24 @@ namespace :dox do
     Rake::Task['api_spec'].invoke
   end
 
-  task :html, [:version, :docs_path, :host] => :json do |_, args|
+  task :html, [:version] => :json do |_, args|
     version = args[:version] || :v1
-    docs_path = args[:docs_path] || "api/#{version}/docs"
+    docs_path = "api/#{version}/docs"
+    spec_path = Rails.root.join("spec/docs/#{version}/apispec.json").to_s
+    output_path = Rails.root.join("public/#{docs_path}/index.html").to_s
 
-    `yarn run redoc-cli bundle -o public/#{docs_path}/index.html spec/docs/#{version}/apispec.json`
+    Dox::HtmlRenderer.new(spec_path, output_path).render
   end
 
-  task :open, [:version, :docs_path, :host] => :html do |_, args|
+  task :open, [:version] => :html do |_, args|
     version = args[:version] || :v1
-    docs_path = args[:docs_path] || "api/#{version}/docs"
+    docs_path = "api/#{version}/docs"
 
     `open public/#{docs_path}/index.html`
   end
 end
 ```
 
-#### Renderers
-You can render the HTML yourself with ReDoc:
-
-- [Redoc](https://github.com/Redocly/redoc)
-
 ### Common issues
 
 You might experience some strange issues when generating the documentation. Here are a few examples of what we've encountered so far.

data/Rakefile

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

data/dox.gemspec

@@ -5,36 +5,29 @@ require 'dox/version'
 Gem::Specification.new do |spec|
   spec.name          = 'dox'
   spec.version       = Dox::VERSION
-  spec.authors       = ['Melita Kokot', 'Vedran Hrnčić']
-  spec.email         = ['melita.kokot@gmail.com', 'vrabac266@gmail.com']
+  spec.authors       = ['Melita Kokot', 'Vedran Hrnčić', 'Marko Ćilimković']
+  spec.email         = ['melita.kokot@gmail.com', 'vrabac266@gmail.com', 'os.chilim@gmail.com']
 
   spec.summary       = 'Generates API documentation for rspec in OpenAPI format.'
   spec.homepage      = 'https://github.com/infinum/dox'
   spec.license       = 'MIT'
 
-  spec.required_ruby_version = '>= 2.0.0'
+  spec.required_ruby_version = '>= 3.1.0'
 
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
   # delete this section to allow pushing this gem to any host.
   raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.' unless spec.respond_to?(:metadata)
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'activesupport', '>= 4.0'
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'codeclimate-test-reporter'
-  spec.add_development_dependency 'json'
-  spec.add_development_dependency 'pry-nav'
-  spec.add_development_dependency 'pry-rails'
-  spec.add_development_dependency 'pry-stack_explorer'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'simplecov'
-  spec.add_runtime_dependency 'rspec-core'
+  spec.add_dependency 'activesupport', '>= 4.0'
+  spec.add_dependency 'rack'
+  spec.add_dependency 'rexml'
+  spec.add_dependency 'rspec-core'
 end

data/lib/dox/config.rb

@@ -9,7 +9,9 @@ module Dox
     attr_accessor :title
     attr_accessor :header_description
     attr_accessor :groups_order
+    attr_accessor :redoc_version
     attr_reader :descriptions_location
+    attr_writer :check_file_presence_on_init
 
     def descriptions_location=(folder_path)
       Array(folder_path).each do |path|
@@ -37,6 +39,12 @@ module Dox
       @schema_response_fail_file_path = file_path
     end
 
+    def check_file_presence_on_init
+      return false if @check_file_presence_on_init == false
+
+      @check_file_presence_on_init || true
+    end
+
     def desc_folder_path=(folder_path)
       warn(
         'DEPRECATION WARNING: desc_folder_path will be removed in the next release, please use descriptions_location instead' # rubocop:disable Layout/LineLength

data/lib/dox/dsl/resource.rb

@@ -16,6 +16,8 @@ module Dox
 
         raise(Dox::Errors::InvalidResourceError, 'Resource name is required!') if @name.blank?
         raise(Dox::Errors::InvalidResourceError, 'Resource group is required!') if @group.blank?
+
+        return unless Dox.config.check_file_presence_on_init
         raise(Dox::Errors::InvalidResourceError, "Resource desc #{@desc} is missing!") if desc_file_path.nil?
       end
 

data/lib/dox/entities/action.rb

@@ -1,7 +1,12 @@
 module Dox
   module Entities
     class Action
-      attr_reader :name, :desc, :verb, :path, :resource, :params
+      attr_reader :name
+      attr_reader :desc
+      attr_reader :verb
+      attr_reader :path
+      attr_reader :resource
+      attr_reader :params
       attr_accessor :examples
 
       def initialize(details, request)
@@ -25,7 +30,7 @@ module Dox
       def template_path
         path = request.path.dup.presence || request.fullpath.split('?').first
         path_params.each do |key, value|
-          path.sub!(%r{\/#{value}(\/|$)}, "/{#{key}}\\1")
+          path.sub!(%r{/#{value}(/|$)}, "/{#{key}}\\1")
         end
 
         path
@@ -64,7 +69,7 @@ module Dox
       end
 
       def guess_param_type(param)
-        if param =~ /^\d+$/
+        if param.to_s =~ /^\d+$/
           :number
         else
           :string

data/lib/dox/entities/example.rb

@@ -3,7 +3,11 @@ module Dox
     class Example
       extend Forwardable
 
-      attr_reader :desc, :name, :request_schema, :response_schema_success, :response_schema_fail
+      attr_reader :desc
+      attr_reader :name
+      attr_reader :request_schema
+      attr_reader :response_schema_success
+      attr_reader :response_schema_fail
 
       def_delegator :request, :method, :request_method
       def_delegator :response, :status, :response_status
@@ -68,7 +72,7 @@ module Dox
 
       def formatter(content_type)
         case content_type
-        when %r{application\/.*json}
+        when %r{application/.*json}
           Dox::Formatters::Json
         when /xml/
           Dox::Formatters::Xml
@@ -84,15 +88,16 @@ module Dox
         request.path.presence || request.fullpath.split('?')[0]
       end
 
-      attr_reader :request, :response
+      attr_reader :request
+      attr_reader :response
 
       def filter_headers(obj)
-        headers_whitelist.map do |header|
+        headers_whitelist.filter_map do |header|
           header_val = obj.headers[header]
           next if header_val.blank?
 
           [header, header_val]
-        end.compact
+        end
       end
 
       def headers_whitelist

data/lib/dox/entities/resource.rb

@@ -1,7 +1,9 @@
 module Dox
   module Entities
     class Resource
-      attr_reader :name, :desc, :group
+      attr_reader :name
+      attr_reader :desc
+      attr_reader :group
       attr_accessor :actions
 
       def initialize(details)

data/lib/dox/entities/resource_group.rb

@@ -2,7 +2,8 @@ module Dox
   module Entities
     class ResourceGroup
       attr_reader :name
-      attr_accessor :desc, :resources
+      attr_accessor :desc
+      attr_accessor :resources
 
       def initialize(details)
         @name = details[:resource_group_name]

data/lib/dox/formatters/base.rb

@@ -13,7 +13,8 @@ module Dox
 
       private
 
-      attr_reader :http_env, :body
+      attr_reader :http_env
+      attr_reader :body
     end
   end
 end

data/lib/dox/html_renderer.rb

@@ -0,0 +1,71 @@
+module Dox
+  class HtmlRenderer
+    def initialize(spec_path, output_path, adapter: Dox::RedoclyAdapter.new)
+      @spec_path = spec_path
+      @output_path = output_path
+      @adapter = adapter
+    end
+
+    def render
+      spec = JSON.load_file(spec_path)
+      resolved = resolve_file_refs(spec, ::File.dirname(spec_path))
+      title = resolved.dig('info', 'title') || Dox.config.title
+
+      FileUtils.mkdir_p(::File.dirname(output_path))
+      ::File.write(output_path, adapter.build_html(title, resolved))
+    end
+
+    private
+
+    attr_reader :spec_path
+    attr_reader :output_path
+    attr_reader :adapter
+
+    def resolve_file_refs(obj, base_dir) # rubocop:disable Metrics/MethodLength
+      case obj
+      when Hash
+        if obj.key?('$ref') && !obj['$ref'].start_with?('#')
+          load_schema(obj['$ref'], base_dir)
+        else
+          obj.transform_values { |v| resolve_file_refs(v, base_dir) }
+        end
+      when Array
+        obj.map { |item| resolve_file_refs(item, base_dir) }
+      else
+        obj
+      end
+    end
+
+    def load_schema(ref_path, base_dir)
+      full_path = ::File.expand_path(ref_path, base_dir)
+      schema = JSON.load_file(full_path)
+      resolved = resolve_file_refs(schema, ::File.dirname(full_path))
+      resolve_internal_refs(resolved)
+    end
+
+    # Internal $refs like "#/path/to/thing" are JSON pointers into the
+    # same document. Once a file is inlined into the spec, the root
+    # changes and these pointers break. This resolves them while the
+    # file's own root is still available.
+    def resolve_internal_refs(schema)
+      replace_json_pointer_refs(schema, root: schema)
+    end
+
+    def replace_json_pointer_refs(obj, root:) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength
+      case obj
+      when Hash
+        if obj.key?('$ref') && obj['$ref'].start_with?('#/')
+          keys = obj['$ref'].delete_prefix('#/').split('/')
+          target = root.dig(*keys)
+          target ? replace_json_pointer_refs(target, root: root) : obj
+        else
+          obj.transform_values { |v| replace_json_pointer_refs(v, root: root) }
+        end
+      when Array
+        obj.map { |item| replace_json_pointer_refs(item, root: root) }
+      else
+        obj
+      end
+    end
+  end
+end

data/lib/dox/printers/action_printer.rb

@@ -13,7 +13,8 @@ module Dox
 
       private
 
-      attr_accessor :action, :action_hash
+      attr_accessor :action
+      attr_accessor :action_hash
 
       def add_action
         action_hash['summary'] = action.name

data/lib/dox/printers/base_printer.rb

@@ -27,7 +27,7 @@ module Dox
 
       def formatted_body(body_str, content_type)
         case content_type
-        when %r{application\/.*json}
+        when %r{application/.*json}
           JSON.parse(body_str)
         when /xml/
           pretty_xml(body_str)
@@ -48,7 +48,11 @@ module Dox
       def format_desc(description)
         desc = description
         desc = '' if desc.nil?
-        desc = read_file(desc) if desc.end_with?('.md')
+
+        if desc.end_with?('.md')
+          desc = read_file(desc)
+          raise "#{description} file is missing!" if desc.nil?
+        end
 
         desc
       end

data/lib/dox/printers/document_printer.rb

@@ -27,18 +27,14 @@ module Dox
           openapi: Dox.config.openapi_version || '3.0.0',
           info: {
             title: Dox.config.title || 'API Documentation',
-            description: adjust_description(Dox.config.header_description || ''),
+            description: adjusted_description,
             version: Dox.config.api_version || '1.0'
           }
         }
       end
 
-      def adjust_description(description)
-        description.end_with?('.md') ? acquire_desc(description) : description
-      end
-
-      def acquire_desc(path)
-        read_file(path)
+      def adjusted_description
+        format_desc(Dox.config.header_description)
       end
 
       def group_printer

data/lib/dox/printers/example_response_printer.rb

@@ -79,7 +79,7 @@ module Dox
       end
 
       def add_headers(body)
-        body['headers'] = Hash[example.response_headers.map { |key, value| [key, { description: value }] }]
+        body['headers'] = example.response_headers.to_h { |key, value| [key, { description: value }] }
       end
     end
   end

data/lib/dox/printers/resource_group_printer.rb

@@ -5,7 +5,7 @@ module Dox
         self.resource_group = resource_group
         add_resource_group
 
-        resource_group.resources.each do |_, resource|
+        resource_group.resources.each_value do |resource|
           resource_printer.print(resource)
         end
       end

data/lib/dox/printers/resource_printer.rb

@@ -5,7 +5,7 @@ module Dox
         self.resource = resource
         add_resources
 
-        resource.actions.each do |_, action|
+        resource.actions.each_value do |action|
           action_printer.print(action)
         end
       end

data/lib/dox/redocly_adapter.rb

@@ -0,0 +1,32 @@
+module Dox
+  class RedoclyAdapter
+    DEFAULT_REDOC_VERSION = '2.5.1'.freeze
+
+    def build_html(title, spec)
+      <<~HTML
+        <!DOCTYPE html>
+        <html>
+        <head>
+          <meta charset="utf-8"/>
+          <title>#{title}</title>
+          <meta name="viewport" content="width=device-width, initial-scale=1">
+          <style>body { margin: 0; padding: 0; }</style>
+        </head>
+        <body>
+          <div id="redoc"></div>
+          <script src="https://cdn.redocly.com/redoc/v#{redoc_version}/bundles/redoc.standalone.js"></script>
+          <script>
+            Redoc.init(#{JSON.generate(spec)}, {}, document.getElementById('redoc'));
+          </script>
+        </body>
+        </html>
+      HTML
+    end
+
+    private
+
+    def redoc_version
+      Dox.config.redoc_version || DEFAULT_REDOC_VERSION
+    end
+  end
+end

data/lib/dox/version.rb

@@ -1,3 +1,3 @@
 module Dox
-  VERSION = '2.4.0'.freeze
+  VERSION = '3.0.0'.freeze
 end

data/lib/dox.rb

@@ -1,4 +1,7 @@
 require 'active_support/concern'
+require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/object/to_query'
 require 'active_support/core_ext/string'
 require 'forwardable'
 
@@ -31,12 +34,15 @@ require 'dox/printers/example_request_printer'
 require 'dox/printers/example_response_printer'
 require 'dox/printers/resource_group_printer'
 require 'dox/printers/resource_printer'
+require 'dox/redocly_adapter'
+require 'dox/html_renderer'
 require 'dox/util/http'
 require 'dox/util/file'
 require 'dox/version'
 
 module Dox
-  Error = Class.new(StandardError)
+  class Error < StandardError
+  end
 
   def self.configure
     yield(config) if block_given?

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: dox
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Melita Kokot
 - Vedran Hrnčić
-autorequire: 
+- Marko Ćilimković
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-21 00:00:00.000000000 Z
+date: 2026-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -26,125 +27,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rack
   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: codeclimate-test-reporter
-  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: json
-  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: pry-nav
-  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: pry-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: pry-stack_explorer
-  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: rake
-  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: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -152,13 +41,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rexml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -179,15 +68,17 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - melita.kokot@gmail.com
 - vrabac266@gmail.com
+- os.chilim@gmail.com
 executables:
 - dox
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -227,6 +118,7 @@ files:
 - lib/dox/formatters/multipart.rb
 - lib/dox/formatters/plain.rb
 - lib/dox/formatters/xml.rb
+- lib/dox/html_renderer.rb
 - lib/dox/printers/action_printer.rb
 - lib/dox/printers/base_printer.rb
 - lib/dox/printers/document_printer.rb
@@ -234,6 +126,7 @@ files:
 - lib/dox/printers/example_response_printer.rb
 - lib/dox/printers/resource_group_printer.rb
 - lib/dox/printers/resource_printer.rb
+- lib/dox/redocly_adapter.rb
 - lib/dox/util/file.rb
 - lib/dox/util/http.rb
 - lib/dox/version.rb
@@ -242,7 +135,8 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -250,15 +144,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.3.27
+signing_key:
 specification_version: 4
 summary: Generates API documentation for rspec in OpenAPI format.
 test_files: []