dox 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a1fcae5e0c58ef6689eaede57da79f082f2207d6da123f5251d994deafbca75
-  data.tar.gz: 9a76f7f7e8be9312d3b3e509d1acec8d9fd39aa6e4004e3a1f9f2b2475005c61
+  metadata.gz: 28307d7bc11d4b35d5951f89c855b98af58877cb956a8f638a8541b9358d239d
+  data.tar.gz: 62e8c8228e9390adc964fce294ea2c83017a1da64de73d959d30588e22010317
 SHA512:
-  metadata.gz: 9713ae85d917e7fac673c5e3d78bf2ba3a9c04d943373b98c13c47b67dde4bf53fe5e1eec49117f919a22286120b9ffdcb47eed4bb749ff44661a039a326285d
-  data.tar.gz: 18c023ed7556dd63095d7473d858ea577a38e75a507830359a41ef4303ac29f0690e40a3f4aa1ab63dd3d5b5321adc58262b3ac67c1a70e16d20cf84c029fd6c
+  metadata.gz: 05cc87faaf0602cb9f01bc3cf72ad7d4a98c3db5a331bad7380746f515eeea67f5143763f31107cb3d5aa44a884a62206f669138c0901f01090dcd4930a3199e
+  data.tar.gz: 85bce8dbc8b87d9244db98d449c01e7b26fce507bcdbf1eafaa454c6f554a8562bb68d5e1d949bb28f7b3dc5ac62dfc1f50b246f1619e09a36cf8d1d99aa8929

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## v2.4.0 (2024-11-21)
+
+### Enhancements
+
+- Raise error in case a Resource references an MD file under `#desc` that doesn't exist
+
+
 ## v2.3.0 (2024-02-20)
 
 ### Enhancements

data/lib/dox/dsl/resource.rb

@@ -16,6 +16,7 @@ module Dox
 
         raise(Dox::Errors::InvalidResourceError, 'Resource name is required!') if @name.blank?
         raise(Dox::Errors::InvalidResourceError, 'Resource group is required!') if @group.blank?
+        raise(Dox::Errors::InvalidResourceError, "Resource desc #{@desc} is missing!") if desc_file_path.nil?
       end
 
       def config
@@ -26,6 +27,14 @@ module Dox
           apidoc: true
         }
       end
+
+      private
+
+      def desc_file_path
+        return true if @desc.nil? || !@desc.end_with?('.md')
+
+        Util::File.file_path(@desc).presence
+      end
     end
   end
 end

data/lib/dox/printers/base_printer.rb

@@ -20,14 +20,9 @@ module Dox
       end
 
       def read_file(path, config_root_path: Dox.config.descriptions_location)
-        return '' unless config_root_path
+        full_path = Util::File.file_path(path, config_root_path: config_root_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
+        full_path.nil? ? nil : File.read(full_path)
       end
 
       def formatted_body(body_str, content_type)

data/lib/dox/util/file.rb

@@ -0,0 +1,18 @@
+module Dox
+  module Util
+    module File
+      def self.file_path(path, config_root_path: Dox.config.descriptions_location)
+        return '' unless config_root_path
+
+        config_root_path.each do |root_path|
+          full_path = ::File.join(root_path, path)
+          next unless ::File.exist?(full_path)
+
+          return full_path
+        end
+
+        nil
+      end
+    end
+  end
+end

data/lib/dox/version.rb

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

data/lib/dox.rb

@@ -32,6 +32,7 @@ require 'dox/printers/example_response_printer'
 require 'dox/printers/resource_group_printer'
 require 'dox/printers/resource_printer'
 require 'dox/util/http'
+require 'dox/util/file'
 require 'dox/version'
 
 module Dox

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dox
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Melita Kokot
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-20 00:00:00.000000000 Z
+date: 2024-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -234,6 +234,7 @@ files:
 - lib/dox/printers/example_response_printer.rb
 - lib/dox/printers/resource_group_printer.rb
 - lib/dox/printers/resource_printer.rb
+- lib/dox/util/file.rb
 - lib/dox/util/http.rb
 - lib/dox/version.rb
 homepage: https://github.com/infinum/dox