oas_rails 0.17.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfa0787c34b55b3a16ad7d606cee9c950c2d6b8bbefd0ff7529ed44fcd63b4b8
-  data.tar.gz: ebf135745a3c80267567e6eddc3064f25c89527cb155d0654fb94bcf9ca52b32
+  metadata.gz: d23aa895481ff8d0bd25e9d681dcc2bb5738b26306b78a9e76d9366959898e0b
+  data.tar.gz: f8160302249f30abd9959c11ce365b5ad5992f7b7b14c5a1ab1cba53ee0ababd
 SHA512:
-  metadata.gz: 770939ee5caeb0bfae558a7479e2f0f94ca74b9880f5645ae5a1e0db06bd5c4243c939a63cd4a267e3ff8b85ef003b073f20a8c82240af8391fd89637a92447b
-  data.tar.gz: b71703565f950bc1b48dac836ce4e77a1627364f6ed9068bd565a97a46617ae576a6a01cf33661be9faf9825e03db32c6da65ee3f8213407e2e1966a10ea52e3
+  metadata.gz: 2428433ef2f680ad3a0c7ec4a72b1eeaced918977fd5db5fa4919047784583e6cf7369d77091056817ee48cb1597922785c94e53b7ddf8fe00b0ea7d8ef848d4
+  data.tar.gz: b046fb2101c8f521c6d5e8b41eae979d363a311355a58dec5ccec6802e4ad4521b9c0f1a5186d525692a8c7df6d1ed1a50afcbc31c54b7bf5d661906d404a168

data/lib/oas_rails/configuration.rb

@@ -1,6 +1,6 @@
 module OasRails
   class Configuration < OasCore::Configuration
-    attr_accessor :autodiscover_request_body, :autodiscover_responses, :ignored_actions, :rapidoc_theme, :layout
+    attr_accessor :autodiscover_request_body, :autodiscover_responses, :ignored_actions, :rapidoc_theme, :layout, :source_oas_path
     attr_reader :route_extractor, :include_mode
 
     def initialize
@@ -12,12 +12,21 @@ module OasRails
       @ignored_actions = []
       @rapidoc_theme = :rails
       @layout = nil
+      @source_oas_path = nil
 
       # TODO: implement
       # autodiscover_request_body
       # autodiscover_responses
     end
 
+    def excluded_columns_incoming
+      %i[id created_at updated_at deleted_at]
+    end
+
+    def excluded_columns_outgoing
+      []
+    end
+
     def include_mode=(value)
       valid_modes = %i[all with_tags explicit]
       raise ArgumentError, "include_mode must be one of #{valid_modes}" unless valid_modes.include?(value)

data/lib/oas_rails/extractors/route_extractor.rb

@@ -66,7 +66,7 @@ module OasRails
           return false if RAILS_DEFAULT_CONTROLLERS.any? { |default| route.defaults[:controller].start_with?(default) }
           return false if RAILS_DEFAULT_PATHS.any? { |path| route.path.spec.to_s.include?(path) }
           return false unless route.path.spec.to_s.start_with?(OasRails.config.api_path)
-          return false if ignore_custom_actions(route)
+          return false if ignore_custom_actions?(route)
 
           true
         end
@@ -99,7 +99,7 @@ module OasRails
         # Support controller name only to ignore all controller actions.
         # Support ignoring "controller#action"
         # Ignoring "controller#action" AND "api_path/controller#action"
-        def ignore_custom_actions(route)
+        def ignore_custom_actions?(route)
           api_path = "#{OasRails.config.api_path.sub(%r{\A/}, '')}/".sub(%r{/+$}, '/')
           ignored_actions = OasRails.config.ignored_actions.flat_map do |custom_route|
             if custom_route.start_with?(api_path)

data/lib/oas_rails/version.rb

@@ -1,3 +1,3 @@
 module OasRails
-  VERSION = "0.17.1"
+  VERSION = "1.0.0"
 end

data/lib/oas_rails.rb

@@ -34,9 +34,9 @@ module OasRails
       OasCore.config = config
 
       host_routes = Extractors::RouteExtractor.host_routes
-      oas = OasCore::Builders::SpecificationBuilder.new.with_oas_routes(host_routes).build
+      oas_source = config.source_oas_path ? read_source_oas_file : {}
 
-      oas.to_spec
+      OasCore.build(host_routes, oas_source: oas_source)
     end
 
     def configure
@@ -47,11 +47,22 @@ module OasRails
       @config ||= Configuration.new
     end
 
+    private
+
     def clear_cache
       return if Rails.env.production?
 
       MethodSource.clear_cache
       OasRails::Extractors::RouteExtractor.clear_cache
     end
+
+    def read_source_oas_file
+      file_path = Rails.root.join(config.source_oas_path)
+      JSON.parse(File.read(file_path), symbolize_names: true)
+    rescue Errno::ENOENT => e
+      raise "Failed to read source OAS file at #{file_path}: #{e.message}"
+    rescue JSON::ParserError => e
+      raise "Failed to parse source OAS file at #{file_path}: #{e.message}"
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oas_rails
 version: !ruby/object:Gem::Version
-  version: 0.17.1
+  version: 1.0.0
 platform: ruby
 authors:
 - a-chacon
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: 1.0.0
 description: OasRails is a Rails engine for generating automatic interactive documentation
   for your Rails APIs. It generates an OAS 3.1 document and displays it using RapiDoc.
 email: