dox 2.1.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90c15cf757218b0357b046e8d4170b96ce3fb0072c59f68141653e04c0dd9a2e
-  data.tar.gz: 47f6d55378aad845267e8d86ecb9a75f1625a0599ec35501bb0dd77f6006d97e
+  metadata.gz: 6a1fcae5e0c58ef6689eaede57da79f082f2207d6da123f5251d994deafbca75
+  data.tar.gz: 9a76f7f7e8be9312d3b3e509d1acec8d9fd39aa6e4004e3a1f9f2b2475005c61
 SHA512:
-  metadata.gz: dd57224cb90c0803256d6427fbd520324d5eef21b2f66edcb0f4881fec48943e39eecb08eb42a39808c13fa1f121e8af3f69f8668c130616e96ea5ca67f0a396
-  data.tar.gz: cd21d5496bfc0d28549be4546b0cf6f34bda12bcc05fc792dd2a0db7ac12a7a2199c18ddf20cef4c04d19b112dbb1b602f5dbe85843e6863f478737255bab89e
+  metadata.gz: 9713ae85d917e7fac673c5e3d78bf2ba3a9c04d943373b98c13c47b67dde4bf53fe5e1eec49117f919a22286120b9ffdcb47eed4bb749ff44661a039a326285d
+  data.tar.gz: 18c023ed7556dd63095d7473d858ea577a38e75a507830359a41ef4303ac29f0690e40a3f4aa1ab63dd3d5b5321adc58262b3ac67c1a70e16d20cf84c029fd6c

data/.ruby-version

@@ -1 +1 @@
-2.5.5
+2.6.7

data/CHANGELOG.md

@@ -0,0 +1,156 @@
+# Changelog
+
+## v2.3.0 (2024-02-20)
+
+### Enhancements
+
+- Enable `#descriptions_location` config to be an array of pathname instances or fullpath strings, which will make dox search resource descriptions in more folders, not just one
+
+```bash
+DEPRECATION WARNING: Rails 7.1 will return Content-Type header without modification. If you want just the MIME type, please use `#media_type` instead.
+```
+
+## v2.2.0 (2022-11-03)
+
+### Enhancements
+
+- Prepare dox for Rails 7.1 - Start using `#media_type` on request and response objects (removes following deprecation message):
+
+```bash
+DEPRECATION WARNING: Rails 7.1 will return Content-Type header without modification. If you want just the MIME type, please use `#media_type` instead.
+```
+
+## v2.1.0 (2021-03-26)
+
+### Enhancements
+
+- Added 'activesupport' as a runtime dependency
+- Dropped 'rails' as a runtime dependency
+
+
+## v2.0.0 (2020-08-08)
+
+### Enhancements
+
+- Added `Dox.config.title`
+- Added `Dox.config.header_description`
+- Added `Dox.config.version`
+
+
+### Breaking changes / Deprecations
+
+- [BREAKING] The API description format changed from API-blueprint to OpenAPI.
+- [BREAKING] Base structure is now defined in .json format
+- [BREAKING] Output is written to a .json file
+- [BREAKING] Html is rendered with Redoc instead of Aglio
+- [BREAKING] Renamed `Dox.config.desc_folder_path` -> `Dox.config.descriptions_location`
+- [BREAKING] Removed `endpoint` method from document resource block
+- [DEPRECATED] `Dox.config.header_file_path`
+
+
+## v1.3.0 (2021-03-26)
+
+### Enhancements
+
+- Added 'activesupport' as a runtime dependency
+- Dropped 'rails' as a runtime dependency
+
+
+## v1.2.0 (2019-11-27)
+
+### Enhancements
+
+- Support Multipart payload with pretty formatting (based on `content-type` header)
+
+
+### Bugfixes
+
+- Explicit passing of an empty hash for `params` in actions now works as expected
+
+
+## v1.1.0 (2018-02-19)
+
+### Enhancements
+
+- Full RSpec failure dump to stderr if any test fails when running tests with Dox::Formatter
+- Support any payload format with pretty formatting for JSON and XML (based on `content-type` header)
+
+
+### Bugfixes
+
+- Ignore subdomain request header in headers output
+
+
+## v1.0.2 (2017-06-10)
+
+### Enhancements
+
+- Set minimal Ruby version to 2.x
+
+
+### Bugfixes
+
+- Fixed parsing blank request body string
+
+
+## v1.0.1 (2017-06-10)
+
+### Enhancements
+
+- Add Rake tasks for generating documentation to Readme
+
+
+### Bugfixes
+
+- Fix printing request body for test examples
+
+
+## v1.0.0 (2017-05-06)
+
+### Enhancements
+
+- Guess path params for URI definition from example's request object
+- Validate HTTP verbs specified in the descriptors' actions
+- Document only examples whitelisted with `dox` tag
+- Added option for whitelisting additional HTTP headers for examples
+- Show request HTTP verb and fullpath for each action request
+- Dox executable
+
+
+### Bugfixes
+
+- Ignore body in query params (Rails 4 issue) for example request URL
+- Pull request and response objects from example metadata
+
+
+## v1.0.0.alpha (2016-10-18)
+
+### Enhancements
+
+- Updated the dependencies
+- `extend Dox::DSL::Syntax` instead of `include Dox::DSL::Syntax` in descriptors
+
+
+### Breaking changes / Deprecations
+
+- [BREAKING] Raise errors on missing required dox attributes in descriptors
+
+
+## v0.0.3 (2016-06-22)
+
+### Bugfixes
+
+- Fixed example identifier for examples with query params
+
+
+## v0.0.2 (2016-06-14)
+
+### Enhancements
+
+- Created core classes and a DSL for manipulating the examples in specs
+- Added usage to readme
+
+
+## v0.0.1 (2016-06-06)
+
+- First release of the dox gem where the initial gem skeleton has been created

data/README.md

@@ -45,7 +45,7 @@ Set these optional options in the rails_helper:
 
 | Option | Value | Description |
 | -- | -- | -- |
-| descriptions_location | Pathname instance or fullpath string | Folder containing markdown descriptions of resources. |
+| descriptions_location | Pathname instance or fullpath string (can be an array) | Folder containing markdown descriptions of resources. |
 | schema_request_folder_path | Pathname instance or fullpath string | Folder with request schemas of resources. |
 | schema_response_folder_path | Pathname instance or fullpath string | Folder with response schemas of resources. |
 | schema_response_fail_file_path | Pathname instance or fullpath string | Json file that contains the default schema of a failed response. |

data/lib/dox/config.rb

@@ -12,9 +12,11 @@ module Dox
     attr_reader :descriptions_location
 
     def descriptions_location=(folder_path)
-      raise(Errors::FolderNotFoundError, folder_path) unless Dir.exist?(folder_path)
+      Array(folder_path).each do |path|
+        raise(Errors::FolderNotFoundError, path) unless Dir.exist?(path)
+      end
 
-      @descriptions_location = folder_path
+      @descriptions_location = Array(folder_path)
     end
 
     def schema_request_folder_path=(folder_path)

data/lib/dox/entities/example.rb

@@ -5,10 +5,8 @@ module Dox
 
       attr_reader :desc, :name, :request_schema, :response_schema_success, :response_schema_fail
 
-      def_delegator :response, :status, :response_status
-      def_delegator :response, :content_type, :response_content_type
-      def_delegator :request, :content_type, :request_content_type
       def_delegator :request, :method, :request_method
+      def_delegator :response, :status, :response_status
 
       def initialize(details, request, response)
         @desc = details[:description]
@@ -53,6 +51,15 @@ module Dox
         end
       end
 
+      # Rails 7 changes content_type result
+      def request_content_type
+        request.respond_to?(:media_type) ? request.media_type : request.content_type
+      end
+
+      def response_content_type
+        response.respond_to?(:media_type) ? response.media_type : response.content_type
+      end
+
       private
 
       def format_content(http_env, content_type)

data/lib/dox/printers/base_printer.rb

@@ -19,10 +19,15 @@ module Dox
         hash[key] = default
       end
 
-      def read_file(path, root_path: Dox.config.descriptions_location)
-        return '' unless root_path
+      def read_file(path, config_root_path: Dox.config.descriptions_location)
+        return '' unless config_root_path
 
-        File.read(File.join(root_path, path))
+        config_root_path.each do |root_path|
+          file_path = File.join(root_path, path)
+          next unless File.exist?(file_path)
+
+          return File.read(file_path)
+        end
       end
 
       def formatted_body(body_str, content_type)

data/lib/dox/version.rb

@@ -1,3 +1,3 @@
 module Dox
-  VERSION = '2.1.0'.freeze
+  VERSION = '2.3.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dox
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Melita Kokot
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-26 00:00:00.000000000 Z
+date: 2024-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -193,7 +193,7 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
-- CHANGES.md
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -256,8 +256,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Generates API documentation for rspec in OpenAPI format.

data/CHANGES.md

@@ -1,113 +0,0 @@
-# Changelog
-
-## Version 2.1.0
-
-Released on March 26, 2021
-
-Add:
-- 'activesupport' as a runtime dependency
-
-Drop:
-- 'rails' as a runtime dependency
-
-## Version 2.0.0
-
-Released on August 8, 2020
-
-Change:
-- BREAKING CHANGE The API description format changed from API-blueprint to OpenAPI.
-- BREAKING CHANGE Base structure is now defined in .json format
-- BREAKING CHANGE Output is written to a .json file
-- BREAKING CHANGE Html is rendered with Redoc instead of Aglio
-- Renamed `Dox.config.desc_folder_path` -> `Dox.config.descriptions_location`
-- Depricated `Dox.config.header_file_path`
-- Removed `endpoint` method from document resource block
-
-New:
-- Added `Dox.config.title`
-- Added `Dox.config.header_description`
-- Added `Dox.config.version`
-
-## Version 1.2.0
-
-Released on November 27, 2019
-
-New:
-- Support Multipart payload with pretty formatting (based on `content-type` header)
-
-Fix:
-- Explicit passing of an empty hash for `params` in actions now works as expected
-
-
-## Version 1.1.0
-
-Released on February 19, 2018
-
-New:
-- Full RSpec failure dump to stderr if any test fails when running tests with Dox::Formatter
-- Support any payload format with pretty formatting for JSON and XML (based on `content-type` header)
-
-Fix:
-- Ignore subdomain request header in headers output
-
-
-## Version 1.0.1
-
-Released on June 10, 2017
-
-New:
-- Add Rake tasks for generating documentation to Readme
-
-Fix:
-- Fix printing request body for test examples
-
-
-## Version 1.0.0
-
-Released on May 6, 2017
-
-New:
-- Guess path params for URI definition from example's request object
-- Validate HTTP verbs specified in the descriptors' actions
-- Document only examples whitelisted with `dox` tag
-- Added option for whitelisting additional HTTP headers for examples
-- Show request HTTP verb and fullpath for each action request
-- Dox executable
-
-Fix:
-- Ignore body in query params (Rails 4 issue) for example request URL
-- Pull request and response objects from example metadata
-
-## Version 1.0.0.alpha
-
-Released on October 18, 2016
-
-- Updated the dependencies
-
-New:
-- Raise errors on missing required dox attributes in descriptors
-- `extend Dox::DSL::Syntax` instead of `include Dox::DSL::Syntax` in descriptors
-
-
-## Version 0.0.3
-
-Released on June 22, 2016
-
-Fix:
-- Fixed example identifier for examples with query params
-
-
-## Version 0.0.2
-
-
-Released on June 14, 2016
-
-- Created core classes and a DSL for manipulating the examples in specs
-- Added usage to readme
-
-
-## Version 0.0.1
-
-Released on June 06, 2016
-
-- First release of the dox gem where the initial gem skeleton has been created