json_schematize 0.9.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41661866a0f6debaa7bacc0897f12f00fe0ee156deb2c18dbacd28ef205a1079
-  data.tar.gz: d053b83bc1b4a3fb39b80ad18e126fa535102beeb988e036ab0d76564934af22
+  metadata.gz: 4a137c2d8b5ad986a86ac234f6c03802af2c175b06fc85ff69cf57794a378cca
+  data.tar.gz: b449ba15bc26b4f3026d8904bb25a76bcbd26e8ac50ab40deee36f6c1e165544
 SHA512:
-  metadata.gz: 7c8d4f0c708c44330f76d64b280b0dfdc2f8a3cf8aa8f99de36ad5ad4bdb0a9e41ba1329b128730942016195e456cd1842bae61d3782108462305a174244f7de
-  data.tar.gz: e64e2b257ea5c8cf8db6e1e01d88297a7f3a15724cb8efacb4bac4a2953aad4e2208e70f1f579e428181d5265170fbfa07f2a8bb736a08fe8193b66556627003
+  metadata.gz: 18739039d4c14428e0ec8ad33ed4b229669cceb8cecb11fa851e13a7ca04eb73a78c2faf0bfd34b49957cea90494d1fecd0d31c94c76ea67afc798007ca08288
+  data.tar.gz: 8b51b98b196a7f1a106c409fb957aa259a5751e07d7ae18b823a1439f877987f359a91eb53bd6ff2d1a597fd9e91dafa307f3eb7beef890427eef44267701b5f

data/.circleci/config.yml

@@ -12,10 +12,10 @@ workflows:
       - cst/enforce-gem-version-bump
       - cst/rspec-ruby:
           rspec-system-args: "SIMPLE_COV_RUN=true"
-          cc-report-collect-ruby: "2.7.5"
+          cc-report-collect-ruby: "3.3.6"
           matrix:
             parameters:
-              ruby-version: ["2.7.5" , "3.0.0", "3.0.3"]
+              ruby-version: ["3.2.4", "3.3.6"]
             alias: required-matrix-tests
           name: test-ruby<< matrix.ruby-version >>
       - cst/publish-gem:

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM ruby:3.0.1
+FROM ruby:3.3.6
 RUN cd /tmp && curl -L --output ghr.tar.gz https://github.com/tcnksm/ghr/releases/download/v0.12.0/ghr_v0.12.0_linux_amd64.tar.gz && \
     tar -xzvf ghr.tar.gz && chmod +x ghr_v0.12.0_linux_amd64/ghr && mv ghr_v0.12.0_linux_amd64/ghr /usr/local/bin/ghr && rm -rf /tmp/*
 

data/Gemfile.lock

@@ -1,29 +1,43 @@
 PATH
   remote: .
   specs:
-    json_schematize (0.9.0)
-      class_composer (~> 1.0)
+    json_schematize (0.11.0)
+      class_composer (>= 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4.3)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+    activesupport (8.0.1)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      tzinfo (~> 2.0)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    base64 (0.2.0)
+    benchmark (0.4.0)
+    bigdecimal (3.1.9)
     byebug (11.1.3)
-    class_composer (1.0.2)
+    class_composer (2.1.0)
     coderay (1.1.3)
-    concurrent-ruby (1.2.2)
-    diff-lcs (1.5.0)
-    docile (1.4.0)
-    faker (3.1.1)
+    concurrent-ruby (1.3.4)
+    connection_pool (2.4.1)
+    diff-lcs (1.5.1)
+    docile (1.4.1)
+    drb (2.2.1)
+    faker (3.5.1)
       i18n (>= 1.8.11, < 2)
-    i18n (1.12.0)
+    i18n (1.14.6)
       concurrent-ruby (~> 1.0)
-    method_source (1.0.0)
-    minitest (5.18.0)
+    logger (1.6.4)
+    method_source (1.1.0)
+    minitest (5.25.4)
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -31,31 +45,34 @@ GEM
       byebug (~> 11.0)
       pry (>= 0.13, < 0.15)
     rake (12.3.3)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.1)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.2)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
     rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
+    securerandom (0.4.1)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
+    simplecov-html (0.13.1)
     simplecov_json_formatter (0.1.4)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
+    uri (1.0.2)
 
 PLATFORMS
+  aarch64-linux
   x86_64-darwin-20
   x86_64-linux
 

data/json_schematize.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.homepage    = "https://github.com/matt-taylor/json_schematize"
   spec.license     = "MIT"
 
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.7")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.2")
 
   spec.metadata = {
     "homepage_uri" => spec.homepage,
@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "class_composer", "~> 1.0"
+  spec.add_dependency "class_composer", ">= 1.0"
 
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "rake", "~> 12.0"

data/lib/json_schematize/cache/class_methods/client.rb

@@ -2,12 +2,11 @@
 
 module JsonSchematize::Cache::ClassMethods
   module Client
-
     def __deserialize_keys__(key_hash_bytes)
       return [{}, 0] if key_hash_bytes.nil?
 
       min_expire = Time.now.to_i
-      key_hash =  Marshal.load(key_hash_bytes)
+      key_hash =  __marshalize__(key_hash_bytes)
       keys_removed = 0
       key_hash.each do |key, expire|
         next if expire.to_i > min_expire
@@ -22,6 +21,10 @@ module JsonSchematize::Cache::ClassMethods
       [{}, 0]
     end
 
+    def __marshalize__(key_hash_bytes)
+      Marshal.load(key_hash_bytes)
+    end
+
     def __update_record_keeper__!(expire:, cache_key:, delete_key: false)
       record_of_truth = cached_keys(with_expire: true)
       if delete_key

data/lib/json_schematize/field.rb

@@ -5,7 +5,7 @@ require 'json_schematize/field_validators'
 
 class JsonSchematize::Field
 
-  attr_reader :name, :types, :dig, :dig_type, :symbol, :validator, :empty_value
+  attr_reader :name, :types, :type, :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]
@@ -89,7 +89,11 @@ class JsonSchematize::Field
   private
 
   def validate_acceptable_types(val:)
-    (all_allowed_types + @acceptable_types).include?(val.class)
+    types = (all_allowed_types + @acceptable_types)
+    return true if types.include?(val.class)
+
+    # Allow inheritance here as well -- this only works when a custom converter is defined
+    Class === val ? types.any? { _1 > val } : false
   end
 
   def all_allowed_types
@@ -108,8 +112,14 @@ class JsonSchematize::Field
       raise JsonSchematize::InvalidFieldByArrayOfTypes, ":#{name} expected to be an array based on :array_of_types flag. Given #{value.class}"
     end
 
-    value.map do |val|
-      raw_converter_call(value: val)
+    if value.all? { JsonSchematize::Generator === _1 }
+      # We have already done the work to convert it into a Schematizable object
+      # Return the array and allow the remaining validations to take place
+      value
+    else
+      value.map do |val|
+        raw_converter_call(value: val)
+      end
     end
   end
 

data/lib/json_schematize/generator.rb

@@ -2,13 +2,15 @@
 
 require "json_schematize/cache"
 require "json_schematize/field"
-require "json_schematize/introspect"
+require "json_schematize/introspect_instance_methods"
+require "json_schematize/introspect_class_methods"
 
 class JsonSchematize::Generator
   EMPTY_VALIDATOR = ->(_transformed_value, _raw_value) { true }
   PROTECTED_METHODS = [:assign_values!, :convenience_methods, :validate_required!, :validate_optional!, :validate_value]
 
-  include JsonSchematize::Introspect
+  include JsonSchematize::Introspect::InstanceMethods
+  extend JsonSchematize::Introspect::ClassMethods
 
   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, hash_of_types: nil, hash_of_types_key: "name")
     require "json_schematize/empty_value"

data/lib/json_schematize/introspect_class_methods.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module JsonSchematize::Introspect
+  module ClassMethods
+    def introspect(deep: false, prepend_dig: [], introspection: {})
+      fields.each do |field|
+        naming = (prepend_dig + field.dig).compact
+        type_metadata = __field_type__(field)
+        introspection[naming.join(".")] = {
+          required: field.required,
+          allowed: type_metadata[:humanize],
+        }
+
+        if deep && type_metadata[:deep_introspection]
+          prepended_naming = if field.array_of_types
+            naming.dup.tap { _1[-1] = "#{_1[-1]}[x]"}
+          else
+            naming.dup
+          end
+          type_metadata[:types][0].introspect(deep:, prepend_dig: prepended_naming, introspection: introspection)
+        end
+      end
+
+      introspection
+    end
+
+    def __field_type__(field)
+      types = Array(field.type || field.types)
+      deep_introspection = false
+      type_string = if types.length == 0
+        "Anything"
+      elsif types.length == 1
+        type = types.first
+        if JsonSchematize::Generator > type
+          deep_introspection = true
+          if field.array_of_types
+            "Array of #{type}"
+          else
+            type
+          end
+        else
+          type
+        end
+      else
+        "One of [#{types}]"
+      end
+
+      {
+        humanize: type_string,
+        types:,
+        deep_introspection:,
+      }
+    end
+  end
+end

data/lib/json_schematize/introspect_instance_methods.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module JsonSchematize::Introspect
+  module InstanceMethods
+    def to_h
+      self.class.fields.map do |field|
+        value = method(:"#{field.name}").()
+        if field.array_of_types
+          [field.name, value.map(&:to_h)]
+        elsif value.class == Class
+          [field.name, value.to_s]
+        elsif JsonSchematize::Generator > value.class
+          [field.name, value.to_h]
+        else
+          [field.name, value]
+        end
+      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
+      stringify = to_h.map { |k, v| "#{k}:#{v}" }.join(", ")
+      "#<#{self.class} - required fields: #{self.class.required_fields.map(&:name)}; #{stringify}>"
+    end
+  end
+end

data/lib/json_schematize/version.rb

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

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: json_schematize
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Matt Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-03 00:00:00.000000000 Z
+date: 2024-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: class_composer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
@@ -90,7 +90,6 @@ files:
 - ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
-- ".ruby-version"
 - CHANGELOG.md
 - CODEOWNERS
 - Dockerfile
@@ -116,7 +115,8 @@ files:
 - 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/introspect_class_methods.rb
+- lib/json_schematize/introspect_instance_methods.rb
 - lib/json_schematize/version.rb
 homepage: https://github.com/matt-taylor/json_schematize
 licenses:
@@ -132,14 +132,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.9
 signing_key: 
 specification_version: 4
 summary: This gem gives you the ability to turn API results into a standardized schema's

data/.ruby-version

@@ -1 +0,0 @@
-2.7.4

data/lib/json_schematize/introspect.rb

@@ -1,28 +0,0 @@
-# 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
-    stringify = to_h.map { |k, v| "#{k}:#{v}" }.join(", ")
-    "#<#{self.class} - required fields: #{self.class.required_fields.map(&:name)}; #{stringify}>"
-  end
-end