explicit 0.2.4 → 0.2.6

data/lib/explicit/type/integer.rb

@@ -26,22 +26,22 @@ class Explicit::Type::Integer < Explicit::Type
         nil
       end
 
-    return [:error, error_i18n("integer")] if value.nil?
+    return error_i18n("integer") if value.nil?
 
     if min && value < min
-      return [:error, error_i18n("min", min:)]
+      return error_i18n("min", min:)
     end
 
     if max && value > max
-      return [:error, error_i18n("max", max:)]
+      return error_i18n("max", max:)
     end
 
     if negative == false && value < 0
-      return [:error, error_i18n("not_negative")]
+      return error_i18n("not_negative")
     end
 
     if positive == false && value > 0
-      return [:error, error_i18n("not_positive")]
+      return error_i18n("not_positive")
     end
 
     [:ok, value]
@@ -63,17 +63,17 @@ class Explicit::Type::Integer < Explicit::Type
 
   concerning :Swagger do
     def swagger_schema
-      {
+      merge_base_swagger_schema({
         type: "integer",
         minimum: min,
         maximum: max,
-        description: swagger_description([
+        description_topics: [
           positive == false ? swagger_i18n("integer_not_positive") : nil,
           positive == true ? swagger_i18n("integer_only_positive") : nil,
           negative == false ? swagger_i18n("integer_not_negative") : nil,
           negative == true ? swagger_i18n("integer_only_negative") : nil
-        ])
-      }.compact_blank
+        ]
+      })
     end
   end
 end

data/lib/explicit/type/literal.rb

@@ -15,7 +15,7 @@ class Explicit::Type::Literal < Explicit::Type
     if value == @value
       [:ok, value]
     else
-      [:error, error_i18n("literal", value: @value.inspect)]
+      error_i18n("literal", value: @value.inspect)
     end
   end
 
@@ -35,11 +35,10 @@ class Explicit::Type::Literal < Explicit::Type
 
   concerning :Swagger do
     def swagger_schema
-      {
+      merge_base_swagger_schema({
         type: @value.is_a?(::String) ? "string" : "integer",
-        enum: [@value],
-        description: swagger_description([])
-      }
+        enum: [@value]
+      })
     end
   end
 end

data/lib/explicit/type/modifiers/default.rb

@@ -5,7 +5,7 @@ module Explicit::Type::Modifiers::Default
 
   def apply(default, type)
     Explicit::Type.build(type).tap do |type|
-      type.default = default if type.is_a?(Explicit::Type) # TODO: remove check
+      type.default = default
 
       original_validate = type.method(:validate)
 

data/lib/explicit/type/modifiers/description.rb

@@ -5,7 +5,7 @@ module Explicit::Type::Modifiers::Description
 
   def apply(description, type)
     Explicit::Type.build(type).tap do |type|
-      type.description = description if type.is_a?(Explicit::Type) # TODO: remove check
+      type.description = description
     end
   end
 end

data/lib/explicit/type/modifiers/nilable.rb

@@ -5,7 +5,7 @@ module Explicit::Type::Modifiers::Nilable
 
   def apply(type)
     Explicit::Type.build(type).tap do |type|
-      type.nilable = true if type.is_a?(Explicit::Type) # TODO: remove check
+      type.nilable = true
 
       original_validate = type.method(:validate)
 

data/lib/explicit/type/one_of.rb

@@ -5,6 +5,20 @@ class Explicit::Type::OneOf < Explicit::Type
 
   def initialize(subtypes:)
     @subtypes = subtypes.map { Explicit::Type.build(_1) }
+    @subtypes_are_records = @subtypes.all? { _1.is_a?(Explicit::Type::Record) }
+    @literal_attribute_name_shared_by_all_subtypes = nil
+
+    if @subtypes_are_records
+      literal_types = @subtypes.map do |subtype|
+        subtype.attributes.find { |name, type| type.is_a?(Explicit::Type::Literal) }
+      end
+
+      literal_names = literal_types.map { |name, _| name }.uniq
+
+      if literal_types.all?(&:present?) && literal_names.one?
+        @literal_attribute_name_shared_by_all_subtypes = literal_names.first
+      end
+    end
   end
 
   def validate(value)
@@ -19,7 +33,51 @@ class Explicit::Type::OneOf < Explicit::Type
       end
     end
 
-    [:error, errors.join(" OR ")]
+    if (err = guess_error_for_intended_subtype_via_matching_literal(value:, errors:))
+      return [:error, err]
+    end
+
+    if (err = guess_error_for_intended_subtype_via_matching_keys(value:, errors:))
+      return [:error, err]
+    end
+
+    error =
+      if @subtypes_are_records
+        errors.map { ::JSON.pretty_generate(_1) }.join("\n\n#{ ::I18n.t('explicit.errors.one_of_separator')}\n\n")
+      else
+        errors.join(" #{I18n.t('explicit.errors.one_of_separator')} ")
+      end
+
+    [:error, error]
+  end
+
+  def guess_error_for_intended_subtype_via_matching_literal(value:, errors:)
+    return nil if !@literal_attribute_name_shared_by_all_subtypes
+    return nil if !value.is_a?(::Hash)
+
+    errors.find do |error|
+      !error.key?(@literal_attribute_name_shared_by_all_subtypes)
+    end
+  end
+
+  def guess_error_for_intended_subtype_via_matching_keys(value:, errors:)
+    return nil if !@subtypes_are_records
+    return nil if !value.is_a?(::Hash)
+
+    matches = @subtypes.zip(errors).filter_map do |(subtype, error)|
+      s1 = Set.new(subtype.attributes.keys)
+      s2 = Set.new(value.keys)
+
+      if s1.intersection(s2).size.positive?
+        { subtype:, error: }
+      else
+        nil
+      end
+    end
+
+    return matches.first[:error] if matches.one?
+
+    nil
   end
 
   concerning :Webpage do

data/lib/explicit/type/record.rb

@@ -4,7 +4,7 @@ class Explicit::Type::Record < Explicit::Type
   attr_reader :attributes
 
   def initialize(attributes:)
-    @attributes = attributes.map do |attribute_name, type|
+    @attributes = attributes.to_h do |attribute_name, type|
       type = Explicit::Type.build(type) if !type.is_a?(Explicit::Type)
 
       [attribute_name, type]
@@ -12,7 +12,7 @@ class Explicit::Type::Record < Explicit::Type
   end
 
   def validate(data)
-    return [:error, error_i18n("hash")] if !data.respond_to?(:[])
+    return error_i18n("hash") if !data.respond_to?(:[])
 
     validated_data = {}
     errors = {}
@@ -85,12 +85,11 @@ class Explicit::Type::Record < Explicit::Type
         type.required? ? name.to_s : nil
       end
 
-      {
+      merge_base_swagger_schema({
         type: "object",
         properties:,
-        required:,
-        description: swagger_description([])
-      }.compact_blank
+        required:
+      })
     end
   end
 end

data/lib/explicit/type/string.rb

@@ -1,37 +1,37 @@
 # frozen_string_literal: true
 
 class Explicit::Type::String < Explicit::Type
-  attr_reader :empty, :strip, :format, :minlength, :maxlength, :downcase
+  attr_reader :empty, :strip, :format, :min_length, :max_length, :downcase
 
-  def initialize(empty: nil, strip: nil, format: nil, minlength: nil, maxlength: nil, downcase: false)
+  def initialize(empty: nil, strip: nil, format: nil, min_length: nil, max_length: nil, downcase: false)
     @empty = empty
     @strip = strip
     @format = format
-    @minlength = minlength
-    @maxlength = maxlength
+    @min_length = min_length
+    @max_length = max_length
     @downcase = downcase
   end
 
   def validate(value)
-    return [:error, error_i18n("string")] if !value.is_a?(::String)
+    return error_i18n("string") if !value.is_a?(::String)
 
     value = value.strip if strip
     value = value.downcase if downcase
 
     if empty == false && value.empty?
-      return [:error, error_i18n("empty")]
+      return error_i18n("empty")
     end
 
-    if minlength && value.length < minlength
-      return [:error, error_i18n("minlength", minlength:)]
+    if min_length && value.length < min_length
+      return error_i18n("min_length", min_length:)
     end
 
-    if maxlength && value.length > maxlength
-      return [:error, error_i18n("maxlength", maxlength:)]
+    if max_length && value.length > max_length
+      return error_i18n("max_length", max_length:)
     end
 
     if format && !format.match?(value)
-      return [:error, error_i18n("format", regex: format.inspect)]
+      return error_i18n("format", regex: format.inspect)
     end
 
     [:ok, value]
@@ -47,22 +47,22 @@ class Explicit::Type::String < Explicit::Type
     end
 
     def has_details?
-      !empty.nil? || format.present? || minlength.present? || maxlength.present?
+      !empty.nil? || format.present? || min_length.present? || max_length.present?
     end
   end
 
   concerning :Swagger do
     def swagger_schema
-      {
+      merge_base_swagger_schema({
         type: "string",
-        pattern: format&.inspect,
-        minLength: minlength || (empty == false ? 1 : nil),
-        maxLength: maxlength,
-        description: swagger_description([
+        pattern: format&.inspect&.then { _1[1..-2] },
+        minLength: min_length || (empty == false ? 1 : nil),
+        maxLength: max_length,
+        description_topics: [
           empty == false ? swagger_i18n("string_not_empty") : nil,
           downcase == true ? swagger_i18n("string_downcase") : nil
-        ])
-      }.compact_blank
+        ]
+      })
     end
   end
 end

data/lib/explicit/type.rb

@@ -8,28 +8,48 @@ class Explicit::Type
     in :agreement
       Explicit::Type::Agreement.new
 
-    in [:array, itemtype]
-      Explicit::Type::Array.new(itemtype:)
-    in [:array, itemtype, options]
-      Explicit::Type::Array.new(itemtype:, **options)
+    in [:array, item_type]
+      Explicit::Type::Array.new(item_type:)
+    in [:array, item_type, options]
+      Explicit::Type::Array.new(item_type:, **options)
 
-    in :bigdecimal
+    in :big_decimal
       Explicit::Type::BigDecimal.new
-    in [:bigdecimal, options]
+    in [:big_decimal, options]
       Explicit::Type::BigDecimal.new(**options)
 
     in :boolean
       Explicit::Type::Boolean.new
 
+    in :date_range
+      Explicit::Type::DateRange.new
+    in [:date_range, options]
+      Explicit::Type::DateRange.new(**options)
+
+    in :date_time_iso8601_range
+      Explicit::Type::DateTimeISO8601Range.new()
+    in [:date_time_iso8601_range, options]
+      Explicit::Type::DateTimeISO8601Range.new(**options)
+
     in :date_time_iso8601
       Explicit::Type::DateTimeISO8601.new
-    in :date_time_posix
-      Explicit::Type::DateTimePosix.new
+    in [:date_time_iso8601, options]
+      Explicit::Type::DateTimeISO8601.new(**options)
+
+    in :date_time_unix_epoch
+      Explicit::Type::DateTimeUnixEpoch.new
+    in [:date_time_unix_epoch, options]
+      Explicit::Type::DateTimeUnixEpoch.new(**options)
+
+    in :date
+      Explicit::Type::Date.new
+    in [:date, options]
+      Explicit::Type::Date.new(**options)
 
-    in [:hash, keytype, valuetype]
-      Explicit::Type::Hash.new(keytype:, valuetype:)
-    in [:hash, keytype, valuetype, options]
-      Explicit::Type::Hash.new(keytype:, valuetype:, **options)
+    in [:hash, key_type, value_type]
+      Explicit::Type::Hash.new(key_type:, value_type:)
+    in [:hash, key_type, value_type, options]
+      Explicit::Type::Hash.new(key_type:, value_type:, **options)
 
     in [:enum, allowed_values]
       Explicit::Type::Enum.new(allowed_values)
@@ -89,7 +109,7 @@ class Explicit::Type
   def error_i18n(name, context = {})
     key = "explicit.errors.#{name}"
 
-    ::I18n.t(key, **context)
+    [:error, ::I18n.t(key, **context)]
   end
 
   def swagger_i18n(name, context = {})
@@ -98,15 +118,30 @@ class Explicit::Type
     ::I18n.t(key, **context)
   end
 
-  def swagger_description(extras)
-    extras = extras.compact_blank
-
-    if description.present? && extras.empty?
-      description
-    elsif description.present? && extras.any?
-      description + "\n\n" + extras.compact_blank.join("\n")
-    else
-      extras.compact_blank.join("\n")
-    end
+  def merge_base_swagger_schema(attributes)
+    topics = attributes.delete(:description_topics)&.compact_blank || []
+
+    formatted_description =
+      if description.present? && topics.empty?
+        description
+      elsif description.present? && topics.any?
+        description + "\n\n" + topics.join("\n")
+      else
+        topics.join("\n")
+      end
+
+    default_value =
+      if default&.respond_to?(:call)
+        nil
+      else
+        default
+      end
+
+    base_attributes = {
+      default: default_value,
+      description: formatted_description
+    }
+
+    base_attributes.merge(attributes).compact_blank
   end
 end

data/lib/explicit/version.rb

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

data/lib/explicit.rb

@@ -28,8 +28,11 @@ require "explicit/type/agreement"
 require "explicit/type/array"
 require "explicit/type/big_decimal"
 require "explicit/type/boolean"
+require "explicit/type/date_range"
+require "explicit/type/date_time_iso8601_range"
 require "explicit/type/date_time_iso8601"
-require "explicit/type/date_time_posix"
+require "explicit/type/date_time_unix_epoch"
+require "explicit/type/date"
 require "explicit/type/enum"
 require "explicit/type/file"
 require "explicit/type/hash"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: explicit
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.6
 platform: ruby
 authors:
 - Luiz Vasconcellos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-01-06 00:00:00.000000000 Z
+date: 2025-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -59,8 +59,11 @@ files:
 - app/views/explicit/documentation/type/_array.html.erb
 - app/views/explicit/documentation/type/_big_decimal.html.erb
 - app/views/explicit/documentation/type/_boolean.html.erb
+- app/views/explicit/documentation/type/_date.html.erb
+- app/views/explicit/documentation/type/_date_range.html.erb
 - app/views/explicit/documentation/type/_date_time_iso8601.html.erb
-- app/views/explicit/documentation/type/_date_time_posix.html.erb
+- app/views/explicit/documentation/type/_date_time_iso8601_range.html.erb
+- app/views/explicit/documentation/type/_date_time_unix_epoch.html.erb
 - app/views/explicit/documentation/type/_enum.html.erb
 - app/views/explicit/documentation/type/_file.html.erb
 - app/views/explicit/documentation/type/_hash.html.erb
@@ -94,8 +97,11 @@ files:
 - lib/explicit/type/array.rb
 - lib/explicit/type/big_decimal.rb
 - lib/explicit/type/boolean.rb
+- lib/explicit/type/date.rb
+- lib/explicit/type/date_range.rb
 - lib/explicit/type/date_time_iso8601.rb
-- lib/explicit/type/date_time_posix.rb
+- lib/explicit/type/date_time_iso8601_range.rb
+- lib/explicit/type/date_time_unix_epoch.rb
 - lib/explicit/type/enum.rb
 - lib/explicit/type/file.rb
 - lib/explicit/type/hash.rb

data/lib/explicit/type/date_time_posix.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-require "time"
-
-class Explicit::Type::DateTimePosix < Explicit::Type
-  def validate(value)
-    if !value.is_a?(::Integer) && !value.is_a?(::String)
-      return [:error, error_i18n("date_time_posix")]
-    end
-
-    datetimeval = DateTime.strptime(value.to_s, "%s")
-
-    [:ok, datetimeval]
-  rescue Date::Error
-    return [:error, error_i18n("date_time_posix")]
-  end
-
-  concerning :Webpage do
-    def summary
-      "integer"
-    end
-
-    def partial
-      "explicit/documentation/type/date_time_posix"
-    end
-
-    def has_details?
-      true
-    end
-  end
-
-  concerning :Swagger do
-    def swagger_schema
-      {
-        type: "integer",
-        minimum: 1,
-        format: "POSIX time",
-        description: swagger_description([
-          swagger_i18n("date_time_posix")
-        ])
-      }
-    end
-  end
-end