json_schematize 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6003a56233d3d53c7eb0000e6c96b93a6c4ce737eb810a894fb4096ee1890dcf
-  data.tar.gz: def4f9ac3e80f7562ac8a71bd15846d281013b973a9daa3ea2ca32ac16d32121
+  metadata.gz: 92b634c916946aab36db45a5c037f31fc03452d77c3aca4a1f9ca14109cc74aa
+  data.tar.gz: d3a3b4d1085ce8a415bc03e871ada8e1c6e250df096b566fd9dc1a9aac902204
 SHA512:
-  metadata.gz: a2aadc534091f64fd84b031c97030f4e6739c8ea65ab0d2280644ccff147ec3002ced4236d0ef9d65f4b5ae43ab7fe2e902b336a3f7ee7ababe5e2710e88fafc
-  data.tar.gz: b6b0382a87707bb66a4e57b804401213914f7792a903d98d61fa3ad4d2c640326822135cc3b435972a36bab38bd6752e27a6447d44ef03fe0200eb522c6245c4
+  metadata.gz: e0d9a3d86984c6ce6339546b12461cea1374f507d1356f2cc2ebf675f90bb954bad2559a43f9e6a014219120eaf20537bf187dfeb486ba449036de030e5a02b0
+  data.tar.gz: c6c8546e21abccee5ec36746aa2e12dd5d7cd1dde148a5d1c82ac72abd1252b03dfb815c947b04e0914e9639014a063533d9b736dbde475a32a97b01a02f8ed8

data/Gemfile.lock

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

data/README.md

@@ -86,6 +86,28 @@ converter -- Proc return is set to the field value. No furter validation is done
 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
 ```
 
+### 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
+end
+```
+
+### Custom Classes
+
+```ruby
+class CustomClasses < JsonSchematize::Generator
+  # JsonSchematize::Boolean can be used as a type when expecting a conversion of possible true or false values converted into a TrueClass or FalseClass
+  add_field name: :internals, type: JsonSchematize::Boolean
+end
+```
 
 ## Development
 

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "json_schematize/base"
+
+class JsonSchematize::Boolean < JsonSchematize::Base
+  FALSE_VALUES = ["false", "f", "0", false]
+  TRUE_VALUES = ["true", "t", "1", true]
+
+  def self.new(val)
+    return false if FALSE_VALUES.include?(val)
+    return true if TRUE_VALUES.include?(val)
+
+    raise JsonSchematize::UndefinedBoolean, "#{val} is not a valid #{self.class}"
+  end
+
+  def self.acceptable_types
+    [TrueClass, FalseClass]
+  end
+end

data/lib/json_schematize/field.rb

@@ -5,7 +5,7 @@ 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, :acceptable_types, :required, :converter, :array_of_types
 
   EXPECTED_DIG_TYPE = [DIG_SYMBOL = :symbol, DEFAULT_DIG = DIG_NONE =:none, DIG_STRING = :string]
 
@@ -23,7 +23,7 @@ class JsonSchematize::Field
   end
 
   def setup!
-    # validations must be done beofre transformations
+    # validations must be done before transformations
     valiadtions!
     transformations!
   end
@@ -36,9 +36,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 +77,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
 

data/lib/json_schematize/generator.rb

@@ -1,29 +1,31 @@
 # frozen_string_literal: true
 
 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)
     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, []),
+      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 +33,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,18 +79,24 @@ class JsonSchematize::Generator
     end
   end
 
-  attr_reader :__raw_params, :raise_on_error
+  attr_reader :__raw_params, :raise_on_error, :values_assigned
 
-
-  def initialize(raise_on_error: true, **params)
-    @__params = params
+  # stringified_params allows for params with stringed keys
+  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
 
   def assign_values!

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.2.0"
+  VERSION = "0.4.0"
 end

data/lib/json_schematize.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
-require "json_schematize/version"
+require "json_schematize/base"
+require "json_schematize/boolean"
 require "json_schematize/generator"
+require "json_schematize/version"
 
 module JsonSchematize
   class Error < StandardError; end
@@ -10,4 +12,7 @@ module JsonSchematize
   class InvalidFieldByValidator < InvalidField; end
   class InvalidFieldByType < InvalidField; end
   class InvalidFieldByArrayOfTypes < InvalidField; end
+
+  ## Customized class errors
+  class UndefinedBoolean < Error; end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_schematize
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Matt Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-08 00:00:00.000000000 Z
+date: 2022-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug
@@ -88,10 +88,13 @@ files:
 - docker-compose.yml
 - json_schematize.gemspec
 - lib/json_schematize.rb
+- lib/json_schematize/base.rb
+- lib/json_schematize/boolean.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: