explicit 0.2.16 → 0.2.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ea020d82544c742432038439630cad304e496fb33335e44de226db513feacbe
-  data.tar.gz: f733ee198a502d8962e5e726527153f28e924e275ddbe7f965e7b8dc89ee74f9
+  metadata.gz: 28e91e624223bafc22d197130a6ae5973f6a2364f6dd192d8e2f70b74fe88968
+  data.tar.gz: 3fcacbe34bd45dc3b988f703f05928a65af46f284b498a64e83f12539cc2ef86
 SHA512:
-  metadata.gz: 31c95c4c1751c84cc4e02a2141bc209005700ac8aba906caecfbaf38193e92d43ad42832bd37a844487ccfc0f7ed433689e078545baf5b35d2db267bff419eff
-  data.tar.gz: fcbdf61db1ed115b8d0e8c28ff0ba7ea434f4c6c4096dda5e3b238777709a2797d4279906deba7cea11364b90ee2bb43bfeb4b846aad12098b1f2ce84ae6c0de
+  metadata.gz: bc53aeced2b49c6667fb723a681d8e01b8e2529713a07f142281d2b2bcd40dc619c435c08ad7d7aee38aeceac7e053fd2d46a8e2d438bf82211a4fbd63ba12b7
+  data.tar.gz: cf4995522dab379e5277ac328e55968d0bc30b8850d64fcf7fb25b7afb9eae0c0c865df0813b7578dbff0d91f179b10a32e51b4c9b797932ab1aec95091c54ba

data/README.md

@@ -45,6 +45,7 @@ documented types at runtime.
    - [Customizing error messages](#customizing-error-messages)
    - [Customizing error serialization](#customizing-error-serialization)
    - [Raise on invalid example](#raise-on-invalid-example)
+   - [CORS](#cors)
 
 # Installation
 
@@ -841,7 +842,20 @@ end
 
 ### Raise on invalid example
 
+When adding a request example with `example(params:, response:)`, the response
+must match the documented types. If it doesn't match, Explicit logs a warning,
+but you can choose a more strict behaviour that raises an error instead.
+
 ```ruby
 config.raise_on_invalid_example = true # default is false
 config.raise_on_invalid_example = ::Rails.env.development? # recommended
 ```
+
+### CORS
+
+Enable/disable [CORS headers](https://github.com/luizpvas/explicit/blob/main/lib/explicit/documentation/output/swagger.rb#L67-L74)
+support.
+
+```ruby
+config.cors_enabled = true
+```

data/lib/explicit/configuration.rb

@@ -6,6 +6,7 @@ module Explicit
   class Configuration
     def initialize
       @rescue_from_invalid_params = true
+      @cors_enabled = !defined?(::Rack::Cors)
     end
 
     def request_examples_file_path=(path)
@@ -36,6 +37,14 @@ module Explicit
       @raise_on_invalid_example
     end
 
+    def cors_enabled=(enabled)
+      @cors_enabled = enabled
+    end
+
+    def cors_enabled?
+      @cors_enabled
+    end
+
     def test_runner=(test_runner)
       @test_runner = test_runner
     end

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

@@ -65,6 +65,8 @@ module Explicit::Documentation::Output
       end
 
       def cors_access_control_headers
+        return {} if !::Explicit.configuration.cors_enabled?
+
         {
           "Access-Control-Allow-Origin" => "*",
           "Access-Control-Allow-Methods" => "GET, OPTIONS",

data/lib/explicit/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: explicit
 version: !ruby/object:Gem::Version
-  version: 0.2.16
+  version: 0.2.17
 platform: ruby
 authors:
 - Luiz Vasconcellos