explicit 0.2.5 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5c59437da284708551b719ae8b40a62e98e38886b6327807edef311068b7634
-  data.tar.gz: 9175b15ba7d61853e56ec823a781565b413886793f32efeb8f5ae37459511ff4
+  metadata.gz: b817ec6fe610ab86d5938a0b7958633f4f34e68a4d02b9bd8c8a50bf831622bc
+  data.tar.gz: 8cb2aae4e5a1d582734b6e1f4a917f0b07b4cf4839932dd1e2a5754f3320663b
 SHA512:
-  metadata.gz: 0ebe27efff3c7a9e1379e2e2025a9c75499905efaa1bdaaacff51ff17e963175e1cfc2d2e81f98f4fce615f6161be792ebad385a38471e2a9901bb076e17f3d3
-  data.tar.gz: 1da9daabfa4d8e59c85051eff97fce1f9091fb744ec3294403fc7baff972c50cf0b965ea0670f92fe26a9d8bbc01337a8a7631f1a32465e2f8e9ce764f036657
+  metadata.gz: 1e385f89b47ec351fb000f5b9097d5ccf6233ac01dd57b9e07e87ac9488718528655ef7033686dc482dd9fc9812063f64c1f79313492157dd3ecad63055ff01b
+  data.tar.gz: 5fefc99c8c881d334364102f17e9cab4247bf0486dd5744e041654e83354e2b0265dbfaf2f41f185b354370356c33823c036b13fc2010db459e998ae0ba436ef

data/README.md

@@ -255,6 +255,8 @@ documentation for your API. The following methods are available:
 
 - `page_title(text)` - Sets the web page title.
 - `company_logo_url(url)` - Shows the company logo in the navigation menu.
+  The url can also be a lambda that returns the url, useful for referencing
+  assets at runtime.
 - `favicon_url(url)` - Adds a favicon to the web page.
 - `version(semver)` - Sets the version of the API. Default: "1.0"
 - `section(name, &block)` - Adds a section to the navigation menu.

data/lib/explicit/documentation/builder.rb

@@ -59,6 +59,7 @@ module Explicit::Documentation
 
     def merge_request_examples_from_file!
       return if !Explicit.configuration.request_examples_file_path
+      return if !::File.exist?(Explicit.configuration.request_examples_file_path)
 
       encoded = ::File.read(Explicit.configuration.request_examples_file_path)
 

data/lib/explicit/documentation/output/webpage.rb

@@ -19,15 +19,17 @@ module Explicit::Documentation::Output
     end
 
     private
+      Eval = ->(value) { value.respond_to?(:call) ? value.call : value }
+
       def render_documentation_page
         Explicit::ApplicationController.render(
           partial: "explicit/documentation/page",
           locals: {
             url_helpers: @builder.rails_engine.routes.url_helpers,
-            page_title: builder.get_page_title,
-            company_logo_url: builder.get_company_logo_url,
-            favicon_url: builder.get_favicon_url,
-            version: builder.get_version,
+            page_title: Eval[builder.get_page_title],
+            company_logo_url: Eval[builder.get_company_logo_url],
+            favicon_url: Eval[builder.get_favicon_url],
+            version: Eval[builder.get_version],
             sections: builder.sections,
           }
         )

data/lib/explicit/test_helper.rb

@@ -50,7 +50,13 @@ module Explicit::TestHelper
     end
 
     method = route.method
-    path = (request.get_base_path || "") + route.path
+    path = (request.get_base_path || "") + route.replace_path_params(params)
+
+    if missing_path_param?(route, params)
+      raise <<~DESC
+        The request #{route} needs the following path parameters: #{route.params.join(", ")}
+      DESC
+    end
 
     process(method, path, params:, headers:)
 
@@ -88,6 +94,10 @@ module Explicit::TestHelper
     response
   end
 
+  def missing_path_param?(route, params)
+    route.params.any? { params.fetch(_1, nil).nil? }
+  end
+
   def ensure_response_matches_documented_type!(request, response)
     responses_type = request.responses_type(status: response.status)
 

data/lib/explicit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Explicit
-  VERSION = "0.2.5"
+  VERSION = "0.2.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: explicit
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.7
 platform: ruby
 authors:
 - Luiz Vasconcellos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-01-12 00:00:00.000000000 Z
+date: 2025-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails