json_schematize 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92b634c916946aab36db45a5c037f31fc03452d77c3aca4a1f9ca14109cc74aa
-  data.tar.gz: d3a3b4d1085ce8a415bc03e871ada8e1c6e250df096b566fd9dc1a9aac902204
+  metadata.gz: 8d0fba5a93c9300806e91b5d13da3d16974a72d7598d3b180bd4f9ab13b711c1
+  data.tar.gz: 7361e6e1b2994abd945ab62f90f6d3d7a17fd5e8a51ba11f78525316e2062436
 SHA512:
-  metadata.gz: e0d9a3d86984c6ce6339546b12461cea1374f507d1356f2cc2ebf675f90bb954bad2559a43f9e6a014219120eaf20537bf187dfeb486ba449036de030e5a02b0
-  data.tar.gz: c6c8546e21abccee5ec36746aa2e12dd5d7cd1dde148a5d1c82ac72abd1252b03dfb815c947b04e0914e9639014a063533d9b736dbde475a32a97b01a02f8ed8
+  metadata.gz: a0c5362513008667000c309259dfb21e61835eb150f095f18bfdd84cba21e391d3d44de2bd2d72ed7fffc34963122c029d4032e8ecc5d3459d1f5818dd935f5c
+  data.tar.gz: 25a59ae832bd2eb65bf92dabe3dac3989f34ad0b46d49e554ec19769b83549b71a2387237b45ee6a7c9e3472662db74c197029ecae2bda1b1ce6b292fdaf79b1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    json_schematize (0.4.0)
+    json_schematize (0.5.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -74,7 +74,7 @@ schema.id #=> 999999
 ```
 
 ### Field options:
-```bash
+```
 name -- Name of the field. Field name can be accessed from the instance
 type -- Class of the expected field type
 types -- To be used when you want the field to have multiple types. Useful for similar classes like DateTime, Date, Time (converter must be supplied when multiple types are given)
@@ -84,6 +84,7 @@ validator -- Proc value to validate the data found in the params. Proc given (tr
 required -- Default is true. When not set, each instance class can optionally decide if they want to raise when an this is set to false.
 converter -- Proc return is set to the field value. No furter validation is done. Given (value) as a parameter
 array_of_types -- Detailed example above. Set this value to true when the dig param is to an array and you want all values in array to be parsed the given type
+empty_value -- When required is false, this value is used to fill the field. By default it is JsonSchematize::EmptyValue, but can be changed to anything
 ```
 
 ### Schema defaults
@@ -96,7 +97,7 @@ class SchemaWithDefaults < JsonSchematize::Generator
 
   add_field name: :internals, type: InternalBody, array_of_types: true
   add_field name: :id, type: Integer
-  add_field name: :status, type: Symbol
+  add_field name: :status, type: Symbol, required: false, empty_value: "empty"
 end
 ```
 

data/lib/json_schematize/empty_value.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class JsonSchematize::EmptyValue
+  def initialize(*)
+  end
+end

data/lib/json_schematize/field.rb

@@ -5,11 +5,12 @@ require 'json_schematize/field_validators'
 
 class JsonSchematize::Field
 
-  attr_reader :name, :types, :dig, :dig_type, :symbol, :validator, :acceptable_types, :required, :converter, :array_of_types
+  attr_reader :name, :types, :dig, :dig_type, :symbol, :validator, :empty_value
+  attr_reader :acceptable_types, :required, :converter, :array_of_types
 
   EXPECTED_DIG_TYPE = [DIG_SYMBOL = :symbol, DEFAULT_DIG = DIG_NONE =:none, DIG_STRING = :string]
 
-  def initialize(name:, types:, dig:, dig_type:, validator:, type:, required:, converter:, array_of_types: false)
+  def initialize(name:, types:, dig:, dig_type:, validator:, type:, required:, converter:, empty_value:, array_of_types: false)
     @name = name
     @types = types
     @type = type
@@ -19,13 +20,15 @@ class JsonSchematize::Field
     @validator = validator
     @acceptable_types = []
     @converter = converter
+    @empty_value = empty_value
     @array_of_types = array_of_types
   end
 
   def setup!
     # validations must be done before transformations
-    valiadtions!
+    validations!
     transformations!
+    @acceptable_types << ((empty_value.class == Class) ? empty_value : empty_value.class)
   end
 
   def value_transform(value:)
@@ -102,9 +105,15 @@ class JsonSchematize::Field
   end
 
   def raw_converter_call(value:)
+    return convert_empty_value if value.nil? && (required == false)
+
     converter.call(value)
   end
 
+  def convert_empty_value
+    empty_value.class == Class ? empty_value.new : empty_value
+  end
+
   include JsonSchematize::FieldTransformations
   include JsonSchematize::FieldValidators
 end

data/lib/json_schematize/field_validators.rb

@@ -2,7 +2,7 @@
 
 module JsonSchematize::FieldValidators
 
-  def valiadtions!
+  def validations!
     validate_type!(t: @type)
     validate_types!
     validate_name!

data/lib/json_schematize/generator.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "json_schematize/empty_value"
 require "json_schematize/field"
 require "json_schematize/introspect"
 
@@ -9,7 +10,7 @@ class JsonSchematize::Generator
 
   include JsonSchematize::Introspect
 
-  def self.add_field(name:, type: nil, types: nil, dig_type: nil, dig: nil, validator: nil, required: nil, converter: nil, array_of_types: nil)
+  def self.add_field(name:, type: nil, types: nil, dig_type: nil, dig: nil, validator: nil, required: nil, converter: nil, array_of_types: nil, empty_value: nil)
     field_params = {
       converter: converter || schema_defaults[:converter],
       dig: dig || schema_defaults[:dig],
@@ -18,6 +19,7 @@ class JsonSchematize::Generator
       required: (required.nil? ? schema_defaults.fetch(:required, true) : required),
       type: type || schema_defaults[:type],
       types: types || schema_defaults.fetch(:types, []),
+      empty_value: empty_value || schema_defaults.fetch(:empty_value, JsonSchematize::EmptyValue),
       validator: validator || schema_defaults.fetch(:validator, EMPTY_VALIDATOR),
       array_of_types: (array_of_types.nil? ? schema_defaults.fetch(:array_of_types, false) : array_of_types),
     }
@@ -96,7 +98,6 @@ class JsonSchematize::Generator
     end
   end
 
-
   private
 
   def assign_values!

data/lib/json_schematize/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JsonSchematize
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_schematize
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Matt Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-12 00:00:00.000000000 Z
+date: 2022-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug
@@ -90,6 +90,7 @@ files:
 - lib/json_schematize.rb
 - lib/json_schematize/base.rb
 - lib/json_schematize/boolean.rb
+- lib/json_schematize/empty_value.rb
 - lib/json_schematize/field.rb
 - lib/json_schematize/field_transformations.rb
 - lib/json_schematize/field_validators.rb