explicit 0.2.4 → 0.2.5

data/lib/explicit/type/big_decimal.rb

@@ -9,23 +9,23 @@ class Explicit::Type::BigDecimal < Explicit::Type
   end
 
   def validate(value)
-    unless value.is_a?(::String) || value.is_a?(::Integer)
-      return [:error, error_i18n("bigdecimal")]
+    if !value.is_a?(::BigDecimal) && !value.is_a?(::String) && !value.is_a?(::Integer)
+      return error_i18n("big_decimal")
     end
 
-    decimalvalue = BigDecimal(value)
+    decimal_value = BigDecimal(value)
 
-    if min && decimalvalue < min
-      return [:error, error_i18n("min", min:)]
+    if min && decimal_value < min
+      return error_i18n("min", min:)
     end
 
-    if max && decimalvalue > max
-      return [:error, error_i18n("max", max:)]
+    if max && decimal_value > max
+      return error_i18n("max", max:)
     end
 
-    [:ok, decimalvalue]
+    [:ok, decimal_value]
   rescue ArgumentError
-    return [:error, error_i18n("bigdecimal")]
+    return error_i18n("big_decimal")
   end
 
   concerning :Webpage do
@@ -44,15 +44,15 @@ class Explicit::Type::BigDecimal < Explicit::Type
 
   concerning :Swagger do
     def swagger_schema
-      {
+      merge_base_swagger_schema({
         type: "string",
-        pattern: /^\d*\.?\d*$/.inspect,
+        pattern: /^\d*\.?\d*$/.inspect[1..-2],
         format: "decimal number",
-        description: swagger_description([
+        description_topics: [
           min&.then { swagger_i18n("big_decimal_min", min: _1) },
           max&.then { swagger_i18n("big_decimal_max", max: _1) }
-        ])
-      }
+        ]
+      })
     end
   end
 end

data/lib/explicit/type/boolean.rb

@@ -17,7 +17,7 @@ class Explicit::Type::Boolean < Explicit::Type
   def validate(value)
     value = VALUES[value]
 
-    return [:error, error_i18n("boolean")] if value.nil?
+    return error_i18n("boolean") if value.nil?
 
     [:ok, value]
   end
@@ -38,10 +38,9 @@ class Explicit::Type::Boolean < Explicit::Type
 
   concerning :Swagger do
     def swagger_schema
-      {
-        type: "boolean",
-        description: swagger_description([])
-      }
+      merge_base_swagger_schema({
+        type: "boolean"
+      })
     end
   end
 end

data/lib/explicit/type/date.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+class Explicit::Type::Date < Explicit::Type
+  attr_reader :min, :max
+
+  Eval = ->(expr) { expr.respond_to?(:call) ? expr.call : expr }
+
+  def initialize(min: nil, max: nil)
+    @min = min
+    @max = max
+  end
+
+  def validate(value)
+    return [:ok, value] if value.is_a?(::Date)
+    return error_i18n("string") if !value.is_a?(::String)
+
+    date = ::Date.parse(value, false)
+
+    if min
+      min_value = Eval[min]
+
+      if date.before?(min_value)
+        return error_i18n("date_min", min: min_value)
+      end
+    end
+
+    if max
+      max_value = Eval[max]
+
+      if date.after?(max_value)
+        return error_i18n("date_max", max: max_value)
+      end
+    end
+
+    [:ok, date]
+  rescue ::Date::Error
+    error_i18n("date_format")
+  end
+
+  concerning :Webpage do
+    def summary
+      "string"
+    end
+
+    def partial
+      "explicit/documentation/type/date"
+    end
+
+    def has_details?
+      true
+    end
+  end
+
+  concerning :Swagger do
+    def swagger_schema
+      {
+        type: "string",
+        pattern: /\d{4}-\d{2}-\d{2}/.inspect[1..-2],
+        format: "date",
+        description_topics: [
+          swagger_i18n("date_format")
+        ]
+      }
+    end
+  end
+end

data/lib/explicit/type/date_range.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+class Explicit::Type::DateRange < Explicit::Type
+  attr_reader :min_range, :max_range, :min_date, :max_date
+
+  FORMAT = /^(\d{4}-\d{2}-\d{2})\.\.(\d{4}-\d{2}-\d{2})$/.freeze
+
+  Eval = ->(value) do
+    value.respond_to?(:call) ? value.call : value
+  end
+
+  def initialize(min_range: nil, max_range: nil, min_date: nil, max_date: nil)
+    @min_range = min_range
+    @max_range = max_range
+    @min_date = min_date
+    @max_date = max_date
+  end
+
+  def validate(value)
+    return error_i18n("string") if !value.is_a?(::String)
+
+    match = FORMAT.match(value)
+
+    return error_i18n("date_range_format") if !match
+
+    date_1, date_2 = match.captures.map(&:to_date)
+
+    if date_1.after?(date_2)
+      return error_i18n("date_range_inverted")
+    end
+
+    if min_date
+      min_date_value = Eval[min_date]
+
+      if date_1 < min_date_value
+        return error_i18n("date_range_min_date", min_date: min_date_value)
+      end
+    end
+
+    if max_date
+      max_date_value = Eval[max_date]
+
+      if date_2 > max_date_value
+        return error_i18n("date_range_max_date", max_date: max_date_value)
+      end
+    end
+
+    if min_range
+      diff_in_days = date_2 - date_1 + 1
+
+      if diff_in_days < min_range.in_days
+        return error_i18n("date_range_min_range", min_range: min_range.inspect)
+      end
+    end
+
+    if max_range
+      diff_in_days = date_2 - date_1 + 1
+
+      if diff_in_days > max_range.in_days
+        return error_i18n("date_range_max_range", max_range: max_range.inspect)
+      end
+    end
+
+    [:ok, Range.new(date_1, date_2)]
+  end
+
+  concerning :Webpage do
+    def summary
+      "string"
+    end
+
+    def partial
+      "explicit/documentation/type/date_range"
+    end
+
+    def has_details?
+      true
+    end
+  end
+
+  concerning :Swagger do
+    def swagger_schema
+      merge_base_swagger_schema({
+        type: "string",
+        pattern: FORMAT.inspect[1..-2],
+        format: "date range",
+        description_topics: [
+          swagger_i18n("date_range"),
+          min_range&.then { swagger_i18n("date_range_min_range", min_range: _1.inspect) },
+          max_range&.then { swagger_i18n("date_range_max_range", max_range: _1.inspect) },
+        ]
+      })
+    end
+  end
+end

data/lib/explicit/type/date_time_iso8601.rb

@@ -3,14 +3,39 @@
 require "time"
 
 class Explicit::Type::DateTimeISO8601 < Explicit::Type
+  attr_reader :min, :max
+
+  Eval = ->(expr) { expr.respond_to?(:call) ? expr.call : expr }
+
+  def initialize(min: nil, max: nil)
+    @min = min
+    @max = max
+  end
+
   def validate(value)
-    return [:error, error_i18n("date_time_iso8601")] if !value.is_a?(::String)
+    return error_i18n("date_time_iso8601") if !value.is_a?(::String)
+
+    datetime = Time.iso8601(value)
 
-    timeval = Time.iso8601(value)
+    if min
+      min_value = Eval[min]
+
+      if datetime.before?(min_value)
+        return error_i18n("date_time_iso8601_min", min: min_value)
+      end
+    end
+
+    if max
+      max_value = Eval[max]
+
+      if datetime.after?(max_value)
+        return error_i18n("date_time_iso8601_max", max: max_value)
+      end
+    end
 
-    [:ok, timeval]
+    [:ok, datetime]
   rescue ArgumentError
-    [:error, error_i18n("date_time_iso8601")]
+    error_i18n("date_time_iso8601")
   end
 
   concerning :Webpage do
@@ -29,13 +54,13 @@ class Explicit::Type::DateTimeISO8601 < Explicit::Type
 
   concerning :Swagger do
     def swagger_schema
-      {
+      merge_base_swagger_schema({
         type: "string",
         format: "date-time",
-        description: swagger_description([
+        description_topics: [
           swagger_i18n("date_time_iso8601")
-        ])
-      }
+        ]
+      })
     end
   end
 end

data/lib/explicit/type/date_time_iso8601_range.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+class Explicit::Type::DateTimeISO8601Range < Explicit::Type
+  attr_reader :min_range, :max_range, :min_date_time, :max_date_time
+
+  def initialize(min_range: nil, max_range: nil, min_date_time: nil, max_date_time: nil)
+    @min_range = min_range
+    @max_range = max_range
+    @min_date_time = min_date_time
+    @max_date_time = max_date_time
+  end
+
+  Parse = ->(str) do
+    Time.iso8601(str)
+  rescue ArgumentError
+    nil
+  end
+
+  Eval = ->(value) do
+    value.respond_to?(:call) ? value.call : value
+  end
+
+  def validate(value)
+    return error_i18n("string") if !value.is_a?(::String)
+
+    parts = value.split("..")
+
+    if parts.size != 2
+      return error_i18n("date_time_iso8601_range_format")
+    end
+
+    date_time_1, date_time_2 = parts.map(&Parse)
+
+    if date_time_1.nil? || date_time_2.nil?
+      return error_i18n("date_time_iso8601_range_format")
+    end
+
+    if date_time_1.after?(date_time_2)
+      return error_i18n("date_time_iso8601_range_inverted")
+    end
+
+    if min_date_time
+      min_date_time_value = Eval[min_date_time]
+
+      if date_time_1 < min_date_time_value
+        return error_i18n("date_time_iso8601_range_min_date_time", min_date_time: min_date_time_value)
+      end
+    end
+
+    if max_date_time
+      max_date_time_value = Eval[max_date_time]
+
+      if date_time_2 > max_date_time_value
+        return error_i18n("date_time_iso8601_range_max_date_time", max_date_time: max_date_time_value)
+      end
+    end
+
+    if min_range
+      min_range_value = Eval[min_range]
+
+      diff_in_seconds = date_time_2 - date_time_1
+
+      if diff_in_seconds < min_range_value.in_seconds
+        return error_i18n("date_time_iso8601_range_min_range", min_range: min_range_value.inspect)
+      end
+    end
+
+    if max_range
+      max_range_value = Eval[max_range]
+
+      diff_in_seconds = date_time_2 - date_time_1
+
+      if diff_in_seconds > max_range_value.in_seconds
+        return error_i18n("date_time_iso8601_range_max_range", max_range: max_range_value.inspect)
+      end
+    end
+
+    [:ok, Range.new(date_time_1, date_time_2)]
+  end
+
+  concerning :Webpage do
+    def summary
+      "string"
+    end
+
+    def partial
+      "explicit/documentation/type/date_time_iso8601_range"
+    end
+
+    def has_details?
+      true
+    end
+  end
+
+  concerning :Swagger do
+    def swagger_schema
+      merge_base_swagger_schema({
+        type: "string",
+        format: "date time range",
+        description_topics: [
+          swagger_i18n("date_time_iso8601_range"),
+          min_range&.then { swagger_i18n("date_time_iso8601_range_min_range", min_range: _1.inspect) },
+          max_range&.then { swagger_i18n("date_time_iso8601_range_max_range", max_range: _1.inspect) },
+        ]
+      })
+    end
+  end
+end

data/lib/explicit/type/date_time_unix_epoch.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "time"
+
+class Explicit::Type::DateTimeUnixEpoch < Explicit::Type
+  attr_reader :min, :max
+
+  Eval = ->(expr) { expr.respond_to?(:call) ? expr.call : expr }
+
+  def initialize(min: nil, max: nil)
+    @min = min
+    @max = max
+  end
+
+  def validate(value)
+    if !value.is_a?(::Integer) && !value.is_a?(::String)
+      return error_i18n("date_time_unix_epoch")
+    end
+
+    datetime = DateTime.strptime(value.to_s, "%s")
+
+    if min
+      min_value = Eval[min]
+
+      if datetime.before?(min_value)
+        return error_i18n("date_time_unix_epoch_min", min: min_value)
+      end
+    end
+
+    if max
+      max_value = Eval[max]
+
+      if datetime.after?(max_value)
+        return error_i18n("date_time_unix_epoch_max", max: max_value)
+      end
+    end
+
+    [:ok, datetime]
+  rescue ::Date::Error
+    return error_i18n("date_time_unix_epoch")
+  end
+
+  concerning :Webpage do
+    def summary
+      "integer"
+    end
+
+    def partial
+      "explicit/documentation/type/date_time_unix_epoch"
+    end
+
+    def has_details?
+      true
+    end
+  end
+
+  concerning :Swagger do
+    def swagger_schema
+      merge_base_swagger_schema({
+        type: "integer",
+        minimum: 1,
+        format: "POSIX time",
+        description_topics: [
+          swagger_i18n("date_time_unix_epoch")
+        ]
+      })
+    end
+  end
+end

data/lib/explicit/type/enum.rb

@@ -11,7 +11,7 @@ class Explicit::Type::Enum < Explicit::Type
     if allowed_values.include?(value)
       [:ok, value]
     else
-      [:error, error_i18n("enum", allowed_values: allowed_values.inspect)]
+      error_i18n("enum", allowed_values: allowed_values.inspect)
     end
   end
 
@@ -31,11 +31,10 @@ class Explicit::Type::Enum < Explicit::Type
 
   concerning :Swagger do
     def swagger_schema
-      {
+      merge_base_swagger_schema({
         type: "string",
-        enum: allowed_values,
-        description: swagger_description([])
-      }
+        enum: allowed_values
+      })
     end
   end
 end

data/lib/explicit/type/file.rb

@@ -17,15 +17,15 @@ class Explicit::Type::File < Explicit::Type
 
   def validate(value)
     if !FILE_CLASSES.any? { |klass| value.is_a?(klass) }
-      return [:error, error_i18n("file")] 
+      return error_i18n("file")
     end
 
     if max_size && value.size > max_size
-      return [:error, error_i18n("file_max_size", max_size: number_to_human_size(max_size))]
+      return error_i18n("file_max_size", max_size: number_to_human_size(max_size))
     end
 
     if content_types.any? && !content_types.include?(value.content_type)
-      return [:error, error_i18n("file_content_type", allowed_content_types: content_types.inspect)]
+      return error_i18n("file_content_type", allowed_content_types: content_types.inspect)
     end
 
     [:ok, value]
@@ -47,14 +47,14 @@ class Explicit::Type::File < Explicit::Type
 
   concerning :Swagger do
     def swagger_schema
-      {
+      merge_base_swagger_schema({
         type: "string",
         format: "binary",
-        description: swagger_description([
+        description_topics: [
           max_size&.then { swagger_i18n("file_max_size", max_size: number_to_human_size(_1)) },
           content_types.any? ? swagger_i18n("file_content_types", content_types: content_types.join(', ')) : nil
-        ])
-      }
+        ]
+      })
     end
   end
 end

data/lib/explicit/type/hash.rb

@@ -1,28 +1,28 @@
 # frozen_string_literal: true
 
 class Explicit::Type::Hash < Explicit::Type
-  attr_reader :keytype, :valuetype, :empty
+  attr_reader :key_type, :value_type, :empty
 
-  def initialize(keytype:, valuetype:, empty: true)
-    @keytype = Explicit::Type.build(keytype)
-    @valuetype = Explicit::Type.build(valuetype)
+  def initialize(key_type:, value_type:, empty: true)
+    @key_type = Explicit::Type.build(key_type)
+    @value_type = Explicit::Type.build(value_type)
     @empty = empty
   end
 
   def validate(value)
-    return [:error, error_i18n("hash")] if !value.respond_to?(:[])
-    return [:error, error_i18n("empty")] if value.empty? && empty == false
+    return error_i18n("hash") if !value.respond_to?(:[])
+    return error_i18n("empty") if value.empty? && empty == false
 
     validated_hash = {}
 
     value.each do |key, value|
-      case [keytype.validate(key), valuetype.validate(value)]
+      case [key_type.validate(key), value_type.validate(value)]
       in [[:ok, validated_key], [:ok, validated_value]]
         validated_hash[validated_key] = validated_value
       in [[:error, error], _]
-        return [:error, error_i18n("hash_key", key:, error:)]
+        return error_i18n("hash_key", key:, error:)
       in [_, [:error, error]]
-        return [:error, error_i18n("hash_value", key:, error:)]
+        return error_i18n("hash_value", key:, error:)
       end
     end
 
@@ -45,13 +45,13 @@ class Explicit::Type::Hash < Explicit::Type
 
   concerning :Swagger do
     def swagger_schema
-      {
+      merge_base_swagger_schema({
         type: "object",
-        additionalProperties: valuetype.swagger_schema,
-        description: swagger_description([
+        additionalProperties: value_type.swagger_schema,
+        description_topics: [
           empty == false ? swagger_i18n("hash_not_empty") : nil
-        ])
-      }
+        ]
+      })
     end
   end
 end

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