json_schematize 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cba47a2b20c23bb096ad36a9f71c0ebb8608da8b5ecf42746dcb7c1c223b4aeb
+  data.tar.gz: 227345574280f3dc5de25990b600976393e2bb6f970370b90cf00d1a371913e4
+SHA512:
+  metadata.gz: d53863642a7b6b1fec0e22917508ee6c9a0a8a6452ea36955f3d8349878edf42487d267978d4175f3da72b0fc87651b66f4f4a28a3c1a98b7cc8c61858b0eb1e
+  data.tar.gz: 639c2eabdcabb64fbbcc89aa83e8e6f9e314424d2bcc31a44b710aef887e98fda3a2120edae8952c2ff3d34caacbaf450a5a40ed06417397d68743c7883c9a60

data/.circleci/config.yml

@@ -0,0 +1,189 @@
+version: 2.1
+
+# Declare the orbs that we'll use in our config.
+# read more about orbs: https://circleci.com/docs/2.0/using-orbs/
+orbs:
+  ruby: circleci/ruby@1.0
+
+common_envs: &common_envs
+  environment:
+    APP_BUNDLER_VERSION: "2.3.8"
+
+executors:
+  gem:
+    parameters:
+      ruby-version:
+        default: "3.0.0"
+        type: string
+    docker:
+      - image: cimg/ruby:<< parameters.ruby-version >>
+    <<: *common_envs
+
+commands:
+  bundler-preamble:
+    description: "Install ruby and the Gemfile dependencies"
+    parameters:
+      ruby-version:
+        type: string
+        default: "3"
+        description: "Ruby Gem version"
+      key-name:
+        type: string
+        default: ""
+        description: Custom name to add to the cache key
+      cache-breaker:
+        type: string
+        default: "0"
+        description: "Cache breaker to force new cache instantiation"
+      keep-lock-file:
+        type: boolean
+        default: false
+        description: "Retain lock file when bit is set to true. Otherwise generate a new one specific for this build"
+    steps:
+      - checkout
+      - attach_workspace:
+          at: workspace
+      - unless:
+            condition:
+              equal: [ true, << parameters.keep-lock-file >> ]
+            steps:
+              - run:
+                  name: Remove Gemfile.lock
+                  command: rm Gemfile.lock
+      - restore_cache:
+          key: bundle-<< parameters.ruby-version >>-<< parameters.key-name >>-{{ checksum "Gemfile" }}-<< parameters.cache-breaker >>
+      - ruby/install-deps:
+          path: vendor/bundle
+          with-cache: false
+      - run:
+          name: "Update dependencies"
+          command: bundle update
+      - save_cache:
+          key: bundle-<< parameters.ruby-version >>-<< parameters.key-name >>-{{ checksum "Gemfile" }}-<< parameters.cache-breaker >>
+          paths:
+            - vendor/bundle
+
+jobs:
+  publish-rubygems:
+    executor: gem
+    steps:
+      - bundler-preamble:
+          keep-lock-file: true
+      - run:
+          name: Publish to Ruby Gems
+          command: |
+            if [ -z "$GEM_HOST_API_KEY" ]; then
+              echo 'Environment variable GEM_HOST_API_KEY is not present'
+              exit 1
+            fi
+            gem_output=$(gem build json_schematize.gemspec)
+            VERSION=$(printf "$gem_output" | awk '/Version: / {print $2}')
+            FILE=$(printf "$gem_output" | awk '/File: / {print $2}')
+
+            gem push ${FILE}
+
+  publish-github:
+    executor: gem
+    steps:
+      - bundler-preamble:
+          keep-lock-file: true
+      - run:
+          name: 'Get Go'
+          command: |
+            sudo apt-get update -qq
+            sudo apt-get -y --no-install-recommends install golang-go
+      - run:
+          name: 'Set Git stats'
+          command: |
+            git config user.name $GITHUB_USER
+            git config user.email $GITHUB_EMAIL
+      - run:
+          name: Publish Git Release
+          command: |
+            curl -sSL https://github.com/tcnksm/ghr/releases/download/v0.13.0/ghr_v0.13.0_linux_amd64.tar.gz | tar xz -f - -C . ghr_v0.13.0_linux_amd64/ghr
+            mv ghr_v0.13.0_linux_amd64/ghr .
+            rm -rf ghr_v0.13.0_linux_amd64
+            chmod 0755 ghr
+
+            if [ -z "$GITHUB_TOKEN" ]; then
+              echo 'Environment variable GITHUB_TOKEN is not present'
+              exit 1
+            fi
+
+            if [ -z "$GITHUB_USER" ]; then
+              echo 'Environment variable GITHUB_USER is not present'
+              exit 1
+            fi
+
+            if [ $(git tag -l "$VERSION") ]; then
+              echo "Pre existing version $VERSION, not tagging."
+              exit 0
+            fi
+
+            gem_output=$(gem build json_schematize.gemspec)
+            VERSION=$(printf "$gem_output" | awk '/Version: / {print $2}')
+            FILE=$GEM_PATH$(printf "$gem_output" | awk '/File: / {print $2}')
+
+            git tag -a $VERSION -m "$VERSION"
+
+            SHA=$(git rev-parse HEAD)
+            ./ghr -soft -t ${GITHUB_TOKEN} -u ${GITHUB_USER} -r json_schematize -c ${SHA} ${VERSION} ${FILE}
+
+  test:
+    parameters:
+      ruby-version:
+        default: "3.0.0"
+        type: string
+        description: "Ruby version to test against"
+    executor:
+      name: gem
+      ruby-version: << parameters.ruby-version >>
+    steps:
+      - bundler-preamble:
+          ruby-version: "<< parameters.ruby-version >>"
+      - run:
+          name: Setup Climate Control test-reporter
+          command: |
+            curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+            chmod +x ./cc-test-reporter
+      - run:
+          name: Run and Report tests
+          command: |
+            ./cc-test-reporter before-build
+            SIMPLE_COV_RUN=true bundle exec rspec --format RspecJunitFormatter --out test-results/rspec/rspec.xml --format progress --color
+      - when:
+          condition:
+            equal:
+              [
+                required-test-ruby2.7.5,
+                required-test-ruby<< parameters.ruby-version >>,
+              ]
+          steps:
+            - run:
+                name: Report CodeClimate Coverage
+                command: ./cc-test-reporter after-build --coverage-input-type simplecov
+workflows:
+  version: 2
+  yeet-le-jobs:
+    jobs:
+      - test:
+          matrix:
+            parameters:
+              ruby-version: ["2.7.5" , "3.0.0", "3.0.3"]
+            alias: required-matrix-tests
+          name: required-test-ruby<< matrix.ruby-version >>
+      - publish-github:
+          requires:
+            - required-matrix-tests
+          filters:
+            branches:
+              only:
+                - main
+      - publish-rubygems:
+          requires:
+            - required-matrix-tests
+      #     filters:
+      #       branches:
+      #         only:
+      #           - main
+

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/examples.txt*
+/tmp/
+.DS_Store
+
+# rspec failure tracking
+.rspec_status
+
+# generated gems
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

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

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - YYYY-MM-DD
+
+### Added
+- New feature 1
+- New feature 2
+
+### Changed
+- Changed feature 1
+- Changed feature 2
+
+### Removed
+- Removed feature 1
+- Removed feature 2
+
+### Fixed
+- Bug fix 1
+- Bug fix 2

data/CODEOWNERS

@@ -0,0 +1 @@
+@matt-taylor

data/Dockerfile

@@ -0,0 +1,16 @@
+FROM ruby:3.0.1
+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/*
+
+WORKDIR /gem
+COPY Gemfile /gem/Gemfile
+
+COPY json_schematize.gemspec /gem/json_schematize.gemspec
+COPY lib/json_schematize/version.rb /gem/lib/json_schematize/version.rb
+
+
+RUN gem update --system && gem install bundler && bundle install --jobs=3 --retry=3 && \
+    rm -rf /usr/local/bundle/cache
+
+COPY . /gem
+RUN gem build json_schematize

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem 'faker'
+gem 'pry'
+gem 'rspec', '~> 3.0'
+gem 'rspec_junit_formatter'
+gem 'simplecov', require: false, group: :test

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    json_schematize (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    faker (2.20.0)
+      i18n (>= 1.8.11, < 2)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rake (12.3.3)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rspec_junit_formatter (0.5.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  faker
+  json_schematize!
+  pry
+  pry-byebug
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rspec_junit_formatter
+  simplecov
+
+BUNDLED WITH
+   2.3.8

data/Makefile

@@ -0,0 +1,21 @@
+.PHONY: bash build bundle rspec
+
+APP_NAME?=json_schematize
+
+build: #: Build the containers that we'll need
+	docker-compose build --pull
+
+bash: #: Get a bash prompt on the core container
+	docker-compose run --rm -e RAILS_ENV=development $(APP_NAME) bash
+
+bash_test: #: Get a test bash prompt on the core container
+	docker-compose run --rm -e RAILS_ENV=test $(APP_NAME) bash
+
+down: #: Bring down the service -- Destroys everything in redis and all containers
+	docker-compose down
+
+clean: #: Clean up stopped/exited containers
+	docker-compose rm -f
+
+bundle: #: install gems for Dummy App with
+	docker-compose run --rm $(APP_NAME) bundle install

data/README.md

@@ -0,0 +1,101 @@
+# JsonSchematize
+
+`JsonSchematize` is emant to be a simple schema control version used to aprse data returned from any API.
+
+It can handle nested Schematized versions and build the tree all the way down
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'json_schematize'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install json_schematize
+
+## Usage
+
+Given hash value of the following:
+```json
+{
+  "status":"complete",
+  "id":"127392",
+  "body":
+    [
+      {
+        "status":"failed",
+        "id":"12345",
+        "field_i_dont_care_about": false
+      },
+      {
+        "status":"failed",
+        "id":"6347",
+        "field_i_dont_care_about": true
+      }
+    ]
+}
+```
+
+```ruby
+# lib/schema/internal_body
+require 'json_schematize/generator'
+
+class InternalBody < JsonSchematize::Generator
+  ALLOWED_STATUSES = [:failed, :completed, :success]
+
+  add_field name: :id, type: Integer
+  add_field name: :status, type: Symbol, validator: ->(transformed_value, raw_value) { ALLOWED_STATUSES.include?(transformed_value) }
+end
+
+###
+# lib/schema/my_first_schema
+require 'json_schematize/generator'
+require 'internal_body' #dependeing on load order
+
+class MyFirstSchema < JsonSchematize::Generator
+  add_field name: :internals, type: InternalBody, array_of_types: true, dig: ["body"]
+  add_field name: :id, type: Integer
+  add_field name: :status, type: Symbol
+end
+
+schema = MyFirstSchema.new(**json_hash)
+schema.internals.count #=> 2
+schema.internals.first.status #=> :failed
+schema.id #=> 127392
+schema.id = 999999  #assignments are still subject to validation logic for each field
+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)
+dig_type -- Methodolgy of how to dig into the given param for the field. All values of the `dig` array will be converted accordingly. Default is `none` and will attempt to use what is given. [:symbol, :string, :none].
+dig -- Array telling JsonSchematize how to dig into the provided hash
+validator -- Proc value to validate the data found in the params. Proc given (transformed_value, original_value) when calling in
+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
+```
+
+
+## Development
+
+This gem can be developed against local machine or while using docker. Simpleified Docker commands can be found in the `Makefile` or execute `make help`
+
+## Contributing
+
+This gem welcomes contribution.
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/matt-taylor/json_schematize.
+
+

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'json_schematize'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier.
+
+require 'pry'
+Pry.start

data/docker-compose.yml

@@ -0,0 +1,15 @@
+version: '3'
+
+services:
+  json_schematize:
+    command: tail -f /dev/null
+    build:
+      context: .
+      dockerfile: ./Dockerfile
+    volumes:
+      - .:/gem
+      - ..:/local
+      - bundle-cache:/usr/local/bundle:delegated
+
+volumes:
+  bundle-cache:

data/json_schematize.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/json_schematize/version"
+
+Gem::Specification.new do |spec|
+  spec.name    = "json_schematize"
+  spec.version = JsonSchematize::VERSION
+  spec.authors = ["Matt Taylor"]
+  spec.email   = ["mattius.taylor@gmail.com"]
+
+  spec.summary     = "Describe the gem here"
+  spec.description = "Describe the gem here"
+  spec.homepage    = "https://github.com/matt-taylor/json_schematize"
+  spec.license     = "MIT"
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7")
+
+  spec.metadata = {
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => spec.homepage,
+  }
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov", "~> 0.17.0"
+end

data/lib/json_schematize/field.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'json_schematize/field_transformations'
+require 'json_schematize/field_validators'
+
+class JsonSchematize::Field
+
+  attr_reader :name, :types, :dig, :symbol, :validator, :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)
+    @name = name
+    @types = types
+    @type = type
+    @dig = dig.nil? ? [name] : dig
+    @dig_type = dig_type || DEFAULT_DIG
+    @required = required
+    @validator = validator
+    @acceptable_types = []
+    @converter = converter
+    @array_of_types = array_of_types
+  end
+
+  def setup!
+    # validations must be done beofre transformations
+    valiadtions!
+    transformations!
+  end
+
+  def value_transform(value:)
+    return iterate_array_of_types(value: value) if array_of_types
+
+    raw_converter_call(value: value)
+  end
+
+  def acceptable_value?(transformed_value:, raise_on_error:)
+    if array_of_types
+      boolean = transformed_value.all? { |val| @acceptable_types.include?(val.class) }
+    else
+      boolean = @acceptable_types.include?(transformed_value.class)
+    end
+
+    if raise_on_error && (boolean==false)
+      raise JsonSchematize::InvalidFieldByType, ":#{name} is an invalid option based on acceptable klass types [#{@acceptable_types}]#{ " -- array_of_types enabled" if array_of_types }"
+    end
+
+    boolean
+  end
+
+  def acceptable_value_by_validator?(transformed_value:, raw_value:, raise_on_error:)
+    if array_of_types
+      boolean = transformed_value.all? { |val| validator.call(transformed_value, raw_value) }
+    else
+      boolean = validator.call(transformed_value, raw_value)
+    end
+
+    boolean = validator.call(transformed_value, raw_value)
+    if raise_on_error && (boolean==false)
+      raise JsonSchematize::InvalidFieldByValidator, ":#{name} is an invalid option based on validator :proc option; #{validator}#{ " -- array_of_types enabled" if array_of_types }"
+    end
+
+    boolean
+  end
+
+  def value_from_field(params)
+    begin
+      value = params.dig(*dig)
+    rescue TypeError => e
+      msg = "Unable to dig #{dig} for field :#{name}. Returning nil"
+      ::Kernel.warn(msg)
+      return nil
+    end
+
+    { raw_value: value, transformed_value: value_transform(value: value)}
+  end
+
+  private
+
+  def iterate_array_of_types(value:)
+    return raw_converter_call(value: value) unless array_of_types
+
+    unless value.is_a?(Array)
+      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)
+    end
+  end
+
+  def raw_converter_call(value:)
+    converter.call(value)
+  end
+
+  include JsonSchematize::FieldTransformations
+  include JsonSchematize::FieldValidators
+end

data/lib/json_schematize/field_transformations.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module JsonSchematize::FieldTransformations
+  DEFAULT_CONVERTERS = {
+    Float => ->(val) { val.to_f },
+    Integer => ->(val) { val.to_i },
+    String => ->(val) { val.to_s },
+    Symbol => ->(val) { val.to_sym },
+  }
+
+  def transformations!
+    transform_converter_type!
+    transform_dig_type!
+  end
+
+  def transform_converter_type!
+    return unless @converter.nil?
+
+    # validations have already happened -- We know @acceptable types is a single klass
+
+    @converter = DEFAULT_CONVERTERS[@acceptable_types[0]]
+    if @converter.nil?
+      @converter = ->(val) { @acceptable_types[0].new(val) }
+    end
+  end
+
+  def transform_dig_type!
+    case @dig_type
+    when JsonSchematize::Field::DIG_SYMBOL
+      @dig = @dig.map(&:to_sym)
+    when JsonSchematize::Field::DIG_STRING
+      @dig = @dig.map(&:to_s)
+    when JsonSchematize::Field::DIG_NONE
+      @dig
+    end
+  end
+end

data/lib/json_schematize/field_validators.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module JsonSchematize::FieldValidators
+
+  def valiadtions!
+    validate_type!(t: @type)
+    validate_types!
+    validate_name!
+    validate_validator!
+    validate_required!
+    validate_dig_type!
+    validate_dig!
+    validate_converter!
+  end
+
+  def validate_converter!
+    return if validate_converter_nil!
+
+    return if validate_converter_proc!
+
+    return if validate_converter_hash!
+
+   raise JsonSchematize::FieldError, ":converter passed unexpected type. Expected [Hash, Proc, nil]. Given [#{@converter.class}]"
+  end
+
+  def validate_converter_nil!
+    return false unless @converter.nil?
+
+    return true if @acceptable_types.length == 1
+
+    raise JsonSchematize::FieldError, ":converter expected to be populated with multiple accepted types [#{@acceptable_types}]"
+  end
+
+  def validate_converter_proc!
+    @converter.is_a?(Proc)
+  end
+
+  def validate_converter_hash!
+    return false unless converter.is_a?(Hash)
+
+    if @converter.keys.map(&:name).sort != @acceptable_types.map(&:name).sort
+      raise JsonSchematize::FieldError, ":converter given a hash. Keys of hash do not match klass types of accepted types. Given [#{converter.keys}]. Expected [#{@acceptable_types}]"
+    end
+
+    return true if @converter.values.all? { |klass| klass.is_a?(Proc) }
+
+    raise JsonSchematize::FieldError, ":converter given a hash. Values of proc must all be of type Proc"
+  end
+
+  def validate_required!
+    raise JsonSchematize::FieldError, ":required expected to be an boolean" unless [true, false].include?(@required)
+  end
+
+  def validate_dig_type!
+    values = JsonSchematize::Field::EXPECTED_DIG_TYPE
+    raise JsonSchematize::FieldError, ":dig_type expected to be an #{values}" unless values.include?(@dig_type)
+  end
+
+  def validate_validator!
+    raise JsonSchematize::FieldError, ":validator expected to be an proc" unless @validator.is_a?(Proc)
+  end
+
+  def validate_dig!
+    raise JsonSchematize::FieldError, ":dig expected to be an Array" unless @dig.is_a?(Array)
+  end
+
+  def validate_name!
+    raise JsonSchematize::FieldError, ":name expected to be symbol" unless @name.is_a?(Symbol)
+  end
+
+  def validate_type!(t:, message: ":type expected to be a Class object")
+    raise JsonSchematize::FieldError, message unless t.class == Class
+
+    return if @acceptable_types.include?(t)
+
+    @acceptable_types << t
+  end
+
+  def validate_types!
+    raise JsonSchematize::FieldError, ":types expected to be an array" unless @types.is_a?(Array)
+    @types.each do |t|
+       validate_type!(t: t, message: ":types expected to be an array with class Objects")
+    end
+  end
+end

data/lib/json_schematize/generator.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require "json_schematize/field"
+
+# SchemafiedJSON
+# JSONSchematize
+
+class JsonSchematize::Generator
+  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)
+    field_params = {
+      converter: converter,
+      dig: dig,
+      dig_type: dig_type,
+      name: name,
+      required: required,
+      type: type,
+      types: types,
+      validator: validator,
+    }
+    field = JsonSchematize::Field.new(**field_params)
+    field.setup!
+
+    if required
+      required_fields << field
+    else
+      optional_fields << field
+    end
+    convenience_methods(field: field)
+  end
+
+  def self.fields
+    required_fields + optional_fields
+  end
+
+  def self.required_fields
+    @required_fields ||= []
+  end
+
+  def self.optional_fields
+    @optional_fields ||= []
+  end
+
+  def self.convenience_methods(field:)
+    unless self.instance_methods.include?(:"#{field.name}=")
+      define_method(:"#{field.name}=") do |value|
+        validate_params = {
+          field: field,
+          raw_value: value,
+          transformed_value: value,
+          raise_on_error: raise_on_error,
+        }
+        return false unless validate_value(**validate_params)
+
+        instance_variable_set(:"@#{field.name}", value)
+        return true
+      end
+    end
+    unless self.instance_methods.include?(:"#{field.name}")
+      define_method(:"#{field.name}") do
+        instance_variable_get("@#{field.name}".to_sym)
+      end
+    end
+  end
+
+  attr_reader :__raw_params, :raise_on_error
+
+
+  def initialize(raise_on_error: true, **params)
+    @__params = params
+    @raise_on_error = raise_on_error
+
+    validate_required!
+    validate_optional!
+    assign_values!
+  end
+
+  private
+
+  def assign_values!
+    self.class.fields.each do |field|
+      value = field.value_from_field(@__params)[:transformed_value]
+
+      instance_variable_set(:"@#{field.name}", value)
+    end
+  end
+
+  def validate_required!
+    self.class.required_fields.each do |field|
+      value = field.value_from_field(@__params)
+      validate_value(field: field, raise_on_error: true, **value)
+    end
+  end
+
+  def validate_optional!
+    self.class.optional_fields.each do |field|
+      value = field.value_from_field(@__params)
+      validate_value(field: field, raise_on_error: raise_on_error, **value)
+    end
+  end
+
+  def validate_value(field:, raw_value: nil, **params)
+    field.acceptable_value?(**params) && field.acceptable_value_by_validator?(raw_value: raw_value, **params)
+  end
+end

data/lib/json_schematize/version.rb

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

data/lib/json_schematize.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "json_schematize/version"
+require "json_schematize/generator"
+
+module JsonSchematize
+  class Error < StandardError; end
+  class FieldError < Error; end
+  class InvalidField < Error; end
+  class InvalidFieldByValidator < InvalidField; end
+  class InvalidFieldByType < InvalidField; end
+  class InvalidFieldByArrayOfTypes < InvalidField; end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: json_schematize
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matt Taylor
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+description: Describe the gem here
+email:
+- mattius.taylor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- CHANGELOG.md
+- CODEOWNERS
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- Makefile
+- README.md
+- bin/console
+- docker-compose.yml
+- json_schematize.gemspec
+- lib/json_schematize.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/version.rb
+homepage: https://github.com/matt-taylor/json_schematize
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/matt-taylor/json_schematize
+  source_code_uri: https://github.com/matt-taylor/json_schematize
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Describe the gem here
+test_files: []