explicit 0.1.0 → 0.2.0

data/lib/explicit/spec/error.rb

@@ -15,6 +15,8 @@ module Explicit::Spec::Error
       translator.call(:agreement)
     in [:array, index, suberr]
       translator.call(:array, index:, error: translate(suberr, translator))
+    in :bigdecimal
+      translator.call(:bigdecimal)
     in :boolean
       translator.call(:boolean)
     in :date_time_iso8601
@@ -42,6 +44,7 @@ module Explicit::Spec::Error
     in [:literal, value]
       translator.call(:literal, value: value.inspect)
     in [:one_of, *errors]
+      # TODO
       errors.map { translate(_1, translator) }.join(" OR ")
     in :string
       translator.call(:string)

data/lib/explicit/spec/one_of.rb

@@ -11,12 +11,30 @@ module Explicit::Spec::OneOf
     lambda do |value|
       subspec_validators.each do |subspec_validator|
         case subspec_validator.call(value)
-        in [:ok, validated_value] then return [:ok, validated_value]
-        in [:error, err] then errors << err
+        in [:ok, validated_value]
+          return [:ok, validated_value]
+        in [:error, err]
+          errors << err
+        end
+      end
+
+      errors.each do |err|
+        if looks_like_at_least_one_attribute_matched?(value, err)
+          return [:error, err]
         end
       end
 
       [:error, [:one_of, *errors]]
     end
   end
+
+  private
+    def looks_like_at_least_one_attribute_matched?(value, err)
+      return false if !value.is_a?(::Hash)
+      return false if !err.is_a?(::Hash)
+
+      keyset = value.keys - err.keys
+
+      keyset.empty?
+    end
 end

data/lib/explicit/spec/record.rb

@@ -9,6 +9,8 @@ module Explicit::Spec::Record
     end
 
     lambda do |data|
+      return [:error, :hash] if !data.respond_to?(:[])
+
       validated_data = {}
       errors = {}
 

data/lib/explicit/spec.rb

@@ -15,6 +15,11 @@ module Explicit::Spec
     in [:array, itemspec, options]
       Explicit::Spec::Array.build(itemspec, options)
 
+    in :bigdecimal
+      Explicit::Spec::Bigdecimal.build({})
+    in [:bigdecimal, options]
+      Explicit::Spec::Bigdecimal.build(options)
+
     in :boolean
       Explicit::Spec::Boolean.build({})
     in [:boolean, options]
@@ -28,6 +33,9 @@ module Explicit::Spec
     in [:default, defaultval, subspec]
       Explicit::Spec::Default.build(defaultval, subspec)
 
+    in [:description, _, subspec]
+      Explicit::Spec.build(subspec)
+
     in [:hash, keyspec, valuespec]
       Explicit::Spec::Hash.build(keyspec, valuespec, {})
     in [:hash, keyspec, valuespec, options]

data/lib/explicit/test_helper/example_recorder.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+class Explicit::TestHelper::ExampleRecorder
+  class << self
+    def start_service
+      ::DRb.start_service("drbunix:", instance).uri
+    end
+
+    def set_remote_instance(uri)
+      ::DRb.stop_service
+
+      @remote_instance = ::DRbObject.new_with_uri(uri)
+    end
+
+    def instance
+      return @remote_instance if defined?(@remote_instance)
+
+      @local_instance ||= new
+    end
+  end
+
+  def initialize
+    @examples = Concurrent::Map.new { |hash, key| hash[key] = [] }
+  end
+
+  def add(request_gid:, params:, headers:, response:)
+    @examples[request_gid] << Explicit::Request::Example.new(
+      params:,
+      headers:,
+      response:
+    )
+  end
+
+  def save!
+    total_examples_count = @examples.sum { |_, examples| examples.size }
+    file_path = Explicit.configuration.request_examples_file_path
+
+    puts "" if Explicit.configuration.test_runner == :rspec
+    puts ""
+    puts "  [Explicit] ========="
+    puts "  [Explicit] Saving request examples to #{file_path}"
+    puts "  [Explicit] #{total_examples_count} requests recorded"
+    puts "  [Explicit] ========="
+    puts "" if Explicit.configuration.test_runner == :minitest
+
+    ::File.write(file_path, @examples.to_json, mode: "w")
+  end
+end

data/lib/explicit/test_helper.rb

@@ -1,11 +1,38 @@
 # frozen_string_literal: true
 
 module Explicit::TestHelper
-  Response = ::Data.define(:status, :data) do
-    def dig(...) = data.dig(...)
+  extend ActiveSupport::Concern
+
+  if Explicit.configuration.request_examples_persistance_enabled?
+    if Explicit.configuration.test_runner == :rspec
+      ::RSpec.configure do |config|
+        config.after(:suite) do
+          Explicit::TestHelper::ExampleRecorder.instance.save!
+        end
+      end
+    else
+      ::Minitest.after_run do
+        Explicit::TestHelper::ExampleRecorder.instance.save!
+      end
+    end
   end
 
-  def fetch(request, params:, headers: nil)
+  included do
+    if Explicit.configuration.test_runner == :minitest
+      # TODO: improve this logic
+      running_in_parallel = Minitest.parallel_executor.is_a?(ActiveSupport::Testing::ParallelizeExecutor)
+
+      if running_in_parallel
+        uri = Explicit::TestHelper::ExampleRecorder.start_service
+
+        parallelize_setup do
+          Explicit::TestHelper::ExampleRecorder.set_remote_instance(uri)
+        end
+      end
+    end
+  end
+
+  def fetch(request, params: {}, headers: {}, **opts)
     route = request.send(:routes).first
 
     if route.nil?
@@ -23,21 +50,29 @@ module Explicit::TestHelper
 
     process(route.method, route.path, params:, headers:)
 
-    response = Response.new(
+    response = Explicit::Request::Response.new(
       status: @response.status,
       data: @response.parsed_body.deep_symbolize_keys
     )
 
     ensure_response_matches_spec!(request, response)
 
+    if opts[:save_as_example]
+      ExampleRecorder.instance.add(
+        request_gid: request.gid,
+        params:,
+        headers:,
+        response:
+      )
+    end
+
     response
   end
 
   def ensure_response_matches_spec!(request, response)
-    allowed_responses = request.send(:responses)
-    response_validator = Explicit::Spec.build([:one_of, *allowed_responses])
+    validator = request.send(:responses_validator, status: response.status)
 
-    case response_validator.call({ status: response.status, data: response.data.with_indifferent_access })
+    case validator.call(response.data.with_indifferent_access)
     in [:ok, _] then :all_good
     in [:error, err] then raise Explicit::Request::InvalidResponseError.new(response, err)
     end

data/lib/explicit/version.rb

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

data/lib/explicit.rb

@@ -1,15 +1,25 @@
-require "explicit/documentation"
+require "explicit/configuration"
 require "explicit/engine"
-require "explicit/test_helper"
 require "explicit/version"
 
+require "explicit/documentation"
+require "explicit/documentation/markdown"
+require "explicit/documentation/property"
+
+require "explicit/test_helper"
+require "explicit/test_helper/example_recorder"
+
 require "explicit/request"
-require "explicit/request/invalid_params"
+require "explicit/request/example"
+require "explicit/request/invalid_params_error"
 require "explicit/request/invalid_response_error"
+require "explicit/request/response"
+require "explicit/request/route"
 
 require "explicit/spec"
 require "explicit/spec/agreement"
 require "explicit/spec/array"
+require "explicit/spec/bigdecimal"
 require "explicit/spec/boolean"
 require "explicit/spec/date_time_iso8601"
 require "explicit/spec/date_time_posix"
@@ -23,6 +33,3 @@ require "explicit/spec/nilable"
 require "explicit/spec/one_of"
 require "explicit/spec/record"
 require "explicit/spec/string"
-
-module Explicit
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: explicit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Luiz Vasconcellos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-25 00:00:00.000000000 Z
+date: 2024-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,8 +24,22 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.2.1
-description: explicit allows you to document, test and specify requests and responses
-  schemas
+- !ruby/object:Gem::Dependency
+  name: commonmarker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Explicit is a validation and documentation library for JSON APIs that
+  enforces documented specs at runtime
 email:
 - luizpvasc@gmail.com
 executables: []
@@ -38,17 +52,25 @@ files:
 - app/controllers/explicit/application_controller.rb
 - app/helpers/explicit/application_helper.rb
 - app/views/explicit/application/_documentation.html.erb
+- app/views/explicit/application/_request.html.erb
 - config/locales/en.yml
 - config/routes.rb
 - lib/explicit.rb
+- lib/explicit/configuration.rb
 - lib/explicit/documentation.rb
+- lib/explicit/documentation/markdown.rb
+- lib/explicit/documentation/property.rb
 - lib/explicit/engine.rb
 - lib/explicit/request.rb
-- lib/explicit/request/invalid_params.rb
+- lib/explicit/request/example.rb
+- lib/explicit/request/invalid_params_error.rb
 - lib/explicit/request/invalid_response_error.rb
+- lib/explicit/request/response.rb
+- lib/explicit/request/route.rb
 - lib/explicit/spec.rb
 - lib/explicit/spec/agreement.rb
 - lib/explicit/spec/array.rb
+- lib/explicit/spec/bigdecimal.rb
 - lib/explicit/spec/boolean.rb
 - lib/explicit/spec/date_time_iso8601.rb
 - lib/explicit/spec/date_time_posix.rb
@@ -63,6 +85,7 @@ files:
 - lib/explicit/spec/record.rb
 - lib/explicit/spec/string.rb
 - lib/explicit/test_helper.rb
+- lib/explicit/test_helper/example_recorder.rb
 - lib/explicit/version.rb
 - lib/tasks/schema/api_tasks.rake
 homepage: https://github.com/luizpvas/explicit
@@ -90,5 +113,5 @@ requirements: []
 rubygems_version: 3.4.22
 signing_key: 
 specification_version: 4
-summary: explicit is a documentation and validation library for JSON APIs
+summary: Explicit is a validation and documentation library for JSON APIs
 test_files: []