dox 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ac14990e1aed86a15afdb17c5c35ad6ac8a53f77048b6b1603b60b33aef6525
-  data.tar.gz: d3b39910094b5bbb713a9955846484a191490e4679cb342e944ddcfd97485613
+  metadata.gz: 6a1fcae5e0c58ef6689eaede57da79f082f2207d6da123f5251d994deafbca75
+  data.tar.gz: 9a76f7f7e8be9312d3b3e509d1acec8d9fd39aa6e4004e3a1f9f2b2475005c61
 SHA512:
-  metadata.gz: d38a2f5c4a68bdc79ee57242008ec9b5d838478c75788404b83cabaa1faf886479495eeefaab182288a020a2b3bda5b7c800e2dcc82161b69a50ff23d5bef72d
-  data.tar.gz: 3d1f9d58ea318955a97cc1dccd6d6fa79bcf622b169e5d198a6dde5c3e1b97fdfa15dc36f4d3ada5393de72a43508b794ba69d95f75e8627836b2cb83f731e01
+  metadata.gz: 9713ae85d917e7fac673c5e3d78bf2ba3a9c04d943373b98c13c47b67dde4bf53fe5e1eec49117f919a22286120b9ffdcb47eed4bb749ff44661a039a326285d
+  data.tar.gz: 18c023ed7556dd63095d7473d858ea577a38e75a507830359a41ef4303ac29f0690e40a3f4aa1ab63dd3d5b5321adc58262b3ac67c1a70e16d20cf84c029fd6c

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # 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

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/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.2.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.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Melita Kokot
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-03 00:00:00.000000000 Z
+date: 2024-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport