json_schematize 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30ba73765eb1eef7075be586554ca29eddc7ae7b81cc293aa526dc47715fbb77
-  data.tar.gz: f10b1d7668e6fecd3fc0b8c8a2dcc649df1ede93ce344e2a437209b1d94446c5
+  metadata.gz: 8d0fba5a93c9300806e91b5d13da3d16974a72d7598d3b180bd4f9ab13b711c1
+  data.tar.gz: 7361e6e1b2994abd945ab62f90f6d3d7a17fd5e8a51ba11f78525316e2062436
 SHA512:
-  metadata.gz: a8f5b17a8d1a4d0defb7898b4f8ed2721b960e8b3dbf5216db4ef2dc0d9c56ad9f3d9fe71c67f05735f6838aea729d79d9680614280e142de2f3f2ff17be51c0
-  data.tar.gz: 51624964387dcd0f1699827e497f170f31a7ac8d542398ac6fd14cb2d81719cc9c6d018b2dc2178718b6e008e320806b41c3bd77a50f208204a023fb63fae76c
+  metadata.gz: a0c5362513008667000c309259dfb21e61835eb150f095f18bfdd84cba21e391d3d44de2bd2d72ed7fffc34963122c029d4032e8ecc5d3459d1f5818dd935f5c
+  data.tar.gz: 25a59ae832bd2eb65bf92dabe3dac3989f34ad0b46d49e554ec19769b83549b71a2387237b45ee6a7c9e3472662db74c197029ecae2bda1b1ce6b292fdaf79b1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    json_schematize (0.3.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,7 +84,23 @@ 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
+
+Defaults can be added for all fields for any of the available options. This can be useful for returned API calls when the body is parsed as a Hash with String keys.
+
+```ruby
+class SchemaWithDefaults < JsonSchematize::Generator
+  schema_default option: :dig_type, value: :string
+
+  add_field name: :internals, type: InternalBody, array_of_types: true
+  add_field name: :id, type: Integer
+  add_field name: :status, type: Symbol, required: false, empty_value: "empty"
+end
 ```
+
 ### Custom Classes
 
 ```ruby

data/lib/json_schematize/base.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class JsonSchematize::Base
+  def self.acceptable_types
+    raise NoMethodError, "Expected acceptable_values to be defined in parent class"
+  end
+end

data/lib/json_schematize/boolean.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
-class JsonSchematize::Boolean
+require "json_schematize/base"
+
+class JsonSchematize::Boolean < JsonSchematize::Base
   FALSE_VALUES = ["false", "f", "0", false]
   TRUE_VALUES = ["true", "t", "1", true]
 
@@ -10,4 +12,8 @@ class JsonSchematize::Boolean
 
     raise JsonSchematize::UndefinedBoolean, "#{val} is not a valid #{self.class}"
   end
+
+  def self.acceptable_types
+    [TrueClass, FalseClass]
+  end
 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, :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 beofre transformations
-    valiadtions!
+    # validations must be done before transformations
+    validations!
     transformations!
+    @acceptable_types << ((empty_value.class == Class) ? empty_value : empty_value.class)
   end
 
   def value_transform(value:)
@@ -36,9 +39,9 @@ class JsonSchematize::Field
 
   def acceptable_value?(transformed_value:, raise_on_error:)
     if array_of_types
-      boolean = transformed_value.all? { |val| @acceptable_types.include?(val.class) }
+      boolean = transformed_value.all? { |val| validate_acceptable_types(val: val) }
     else
-      boolean = @acceptable_types.include?(transformed_value.class)
+      boolean = validate_acceptable_types(val: transformed_value)
     end
 
     if raise_on_error && (boolean==false)
@@ -77,6 +80,18 @@ class JsonSchematize::Field
 
   private
 
+  def validate_acceptable_types(val:)
+    (all_allowed_types + @acceptable_types).include?(val.class)
+  end
+
+  def all_allowed_types
+    @all_allowed_types ||= begin
+      @acceptable_types.map do |t|
+        t.acceptable_types if t.ancestors.include?(JsonSchematize::Base)
+      end.compact.flatten
+    end
+  end
+
   def iterate_array_of_types(value:)
     return raw_converter_call(value: value) unless array_of_types
 
@@ -90,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,29 +1,33 @@
 # frozen_string_literal: true
 
+require "json_schematize/empty_value"
 require "json_schematize/field"
-
-# SchemafiedJSON
-# JSONSchematize
+require "json_schematize/introspect"
 
 class JsonSchematize::Generator
-  EMPTY_VALIDATOR = ->(_transformed_value,_raw_value) { true }
+  EMPTY_VALIDATOR = ->(_transformed_value, _raw_value) { true }
   PROTECTED_METHODS = [:assign_values!, :convenience_methods, :validate_required!, :validate_optional!, :validate_value]
 
-  def self.add_field(name:, type: nil, types: [], dig_type: nil, dig: nil, validator: EMPTY_VALIDATOR, required: true, converter: nil, array_of_types: false)
+  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, empty_value: nil)
     field_params = {
-      converter: converter,
-      dig: dig,
-      dig_type: dig_type,
+      converter: converter || schema_defaults[:converter],
+      dig: dig || schema_defaults[:dig],
+      dig_type: dig_type || schema_defaults[:dig_type],
       name: name,
-      required: required,
-      type: type,
-      types: types,
-      validator: validator,
+      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),
     }
+
     field = JsonSchematize::Field.new(**field_params)
     field.setup!
 
-    if required
+    if field_params[:required] == true
       required_fields << field
     else
       optional_fields << field
@@ -31,6 +35,18 @@ class JsonSchematize::Generator
     convenience_methods(field: field)
   end
 
+  def self.schema_default(option:, value:)
+    if fields.length > 0
+      ::Kernel.warn("Default [#{option}] set after fields #{fields.map(&:name)} created. #{option} default will behave inconsistently")
+    end
+
+    schema_defaults[option.to_sym] = value
+  end
+
+  def self.schema_defaults
+    @schema_defaults ||= {}
+  end
+
   def self.fields
     required_fields + optional_fields
   end
@@ -65,16 +81,21 @@ class JsonSchematize::Generator
     end
   end
 
-  attr_reader :__raw_params, :raise_on_error
+  attr_reader :__raw_params, :raise_on_error, :values_assigned
 
   # stringified_params allows for params with stringed keys
-  def initialize(stringified_params = {}, raise_on_error: true, **params)
-    @__params = stringified_params.empty? ? params : stringified_params
+  def initialize(stringified_params = nil, raise_on_error: true, **params)
+    @values_assigned = false
+    @__params = stringified_params.nil? ? params : stringified_params
+    @__raw_params = @__params
     @raise_on_error = raise_on_error
 
-    validate_required!
-    validate_optional!
-    assign_values!
+    if @__params
+      validate_required!
+      validate_optional!
+      assign_values!
+      @values_assigned = true
+    end
   end
 
   private

data/lib/json_schematize/introspect.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module JsonSchematize::Introspect
+  def to_h
+    self.class.fields.map do |field|
+      [field.name, instance_variable_get(:"@#{field.name}")]
+    end.to_h
+  end
+  alias :to_hash :to_h
+
+  def deep_inspect(with_raw_params: false, with_field: false)
+    self.class.fields.map do |field|
+      value = {
+        required: field.required,
+        acceptable_types: field.acceptable_types,
+        value: instance_variable_get(:"@#{field.name}"),
+      }
+      value[:field] = field if with_field
+      value[:raw_params] = @__raw_params if with_raw_params
+      [field.name, value]
+    end.to_h
+  end
+
+  def inspect
+    "#<#{self.class} - required fields: #{self.class.required_fields.map(&:name)}; optional fields: #{self.class.optional_fields.map(&:name)}>"
+  end
+end

data/lib/json_schematize/version.rb

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

data/lib/json_schematize.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
-require "json_schematize/version"
-require "json_schematize/generator"
+require "json_schematize/base"
 require "json_schematize/boolean"
+require "json_schematize/generator"
+require "json_schematize/version"
 
 module JsonSchematize
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_schematize
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Matt Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-10 00:00:00.000000000 Z
+date: 2022-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug
@@ -88,11 +88,14 @@ files:
 - docker-compose.yml
 - json_schematize.gemspec
 - 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
 - lib/json_schematize/generator.rb
+- lib/json_schematize/introspect.rb
 - lib/json_schematize/version.rb
 homepage: https://github.com/matt-taylor/json_schematize
 licenses: