Merge pull request #165 from exoego/feat

Allow path-based config overrides

lib/rspec/openapi.rb

@@ -32,6 +32,9 @@ module RSpec::OpenAPI
   @path_records = Hash.new { |h, k| h[k] = [] }
   @ignored_path_params = %i[controller action format]
 
+  # This is the configuraion override file name we look for within each path.
+  @config_filename = 'rspec_openapi.rb'
+
   class << self
     attr_accessor :path,
                   :title,
@@ -49,5 +52,7 @@ class << self
                   :response_headers,
                   :path_records,
                   :ignored_path_params
+
+    attr_reader   :config_filename
   end
 end

lib/rspec/openapi/result_recorder.rb

@@ -7,8 +7,16 @@ def initialize(path_records)
   end
 
   def record_results!
-    title = RSpec::OpenAPI.title
     @path_records.each do |path, records|
+      # Look for a path-specific config file and run it.
+      config_file = File.join(File.dirname(path), RSpec::OpenAPI.config_filename)
+      begin
+        require config_file if File.exist?(config_file)
+      rescue => e
+        puts "WARNING: Unable to load #{config_file}: #{e}"
+      end
+
+      title = RSpec::OpenAPI.title
       RSpec::OpenAPI::SchemaFile.new(path).edit do |spec|
         schema = RSpec::OpenAPI::DefaultSchema.build(title)
         schema[:info].merge!(RSpec::OpenAPI.info)

spec/roda/doc/openapi.json

@@ -1,8 +1,8 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "title": "OpenAPI Documentation",
-    "version": "1.0.0"
+    "title": "Override title",
+    "version": "7.7.7"
   },
   "servers": [
 

spec/roda/doc/openapi.yaml

@@ -1,8 +1,8 @@
 ---
 openapi: 3.0.3
 info:
-  title: OpenAPI Documentation
-  version: 1.0.0
+  title: Override title
+  version: 7.7.7
 servers: []
 paths:
   "/roda":

spec/roda/doc/rspec_openapi.rb

@@ -0,0 +1,2 @@
+RSpec::OpenAPI.title = 'Override title'
+RSpec::OpenAPI.application_version = '7.7.7'