scheming 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b21c99fc59c9fe7da35644b47be93b2d6bba2f13f4ef814008a64c92f2235323
-  data.tar.gz: c0ff8026a852f0b8e4c91bf86aa4a172502a12b3c89dcd693527863dc7cf58aa
+  metadata.gz: 670c2fce2ac13e3ae6d64790ef6fbcad0f0de413c06bb2fc3300e24686315495
+  data.tar.gz: 599cd2a5d28aed9215a011b896a7eb5a207f14f2a7ca55dcd9299abed4100e32
 SHA512:
-  metadata.gz: 93fa8e2cd04de2c77495754fe04aa2cbd84070a862835c83ef535a7830b6e41337b401f2e35dbf297434397523e24b50c8cb97063745fe58d61f881114187424
-  data.tar.gz: 61c3cf8462b6d9075e593d00fa76921bbb7958e1ac2590f2a4683ff5c2aeac40b28209e579270eff279cea0261d6d1ea8194a0a87d2ebd3b56f93f8bfc8a2966
+  metadata.gz: fb6bc063479d9b7fc4f3769d966102b0c9fccc971727bb5e72962186227dfb55d3921b40b3a26b5454defc36f1f48cf1afba680b6221ed4b84bee12ae16cce5f
+  data.tar.gz: 711e2a1f8b035ff4aa33dca7955f810cbd7e11774d221f7a2ad0da59623ce5424e4fc02a92fefac78117a1ed37b35fa3a24799547121e97daaebd523a722ef63

data/.rubocop.yml

@@ -18,3 +18,6 @@ Style/ClassAndModuleChildren:
 
 Layout/LineLength:
   Max: 90
+
+Lint/EmptyClass:
+  AllowComments: true

data/.solargraph.yml

@@ -0,0 +1,28 @@
+---
+include:
+- "**/*.rb"
+exclude:
+- spec/**/*
+- test/**/*
+- vendor/**/*
+- ".bundle/**/*"
+require: []
+domains: []
+reporters:
+- rubocop
+- require_not_found
+- typecheck
+formatter:
+  rubocop:
+    cops: safe
+    except: []
+    only: []
+    extra_args: []
+require_paths: [
+  'factory_bot',
+  'json_schemer',
+  'pry',
+  'set'
+]
+plugins: []
+max_files: 5000

data/CHANGELOG.md

@@ -1,12 +1,108 @@
 ## [Unreleased]
 
+## [0.7.0] - 2024-05-10
+
+### Added
+
+- `Tuple` type added
+
+  #### Example
+  ```ruby
+  EmailTemplate = Scheming.object do
+    attribute :id, Integer
+    attribute :data, Tuple(String, Array(String))
+  end
+
+  Scheming::Schema.json(EmailTemplate)
+  # =>
+  {
+    type: 'object',
+    additionalProperties: false,
+    required: %w[id data],
+    properties: {
+      id: { type: 'integer' },
+      data: {
+        type: 'array',
+        prefixItems: [
+          { type: 'string' },
+          {
+            type: 'array',
+            items: { type: 'string' }
+          }
+        ]
+      }
+    }
+  }
+  ```
+
+### Enhancement
+
+- Added `solorgraph` to the development process and added
+  it's typecheck to the default `rake` task.
+
+- Reduced string allocations when generating required field
+  names for objects with the JSON schema format.
+
+### Bugfix
+
+- Incorrect type syntax corrected as reported by `solargraph`.
+
+## [0.6.0] - 2024-05-04
+
+### Added
+
+- `Union` type added
+
+  #### Example
+  ```ruby
+  Order = Scheming.object do
+    attribute :id, Union(String, Integer)
+  end
+
+  Scheming::Schema.json(Order)
+  # =>
+  {
+    type: 'object',
+    additionalProperties: false,
+    required: %w[id],
+    properties: {
+      id: {
+        oneOf: [
+          { type: 'string' },
+          { type: 'integer' }
+        ]
+      }
+    }
+  }
+  ```
+
+### Fixed
+
+- Incorrect YARD comment tags and syntax.
+
+### Breaking Change
+
+- Switch from `json-schema` to `json_schemer`
+
+  > TL;DR
+    required object properties for the JSON schema
+    are now strings instead of symbols
+
+  After doing to research I've found that `json_schemer` is
+  more maintained than what was currently being used.  It has
+  a smaller footprint and is much faster at validation.
+
+  As a consequence the `required` properties needed to be
+  changed from symbols to strings in the generated JSON schema.
+
+
 ## [0.5.0] - 2024-05-02
 
 ### Added
 
 - Support for `generic` definitions
 
-  # Example
+  #### Example
   ```ruby
   Point = Scheming.generic do |(type)|
     Object(x: type, y: type)

data/Gemfile

@@ -6,8 +6,9 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'factory_bot', '~> 6.4'
-gem 'json-schema', '~> 4.3'
+gem 'json_schemer'
 gem 'pry', '~> 0.14.2'
 gem 'rake', '~> 13.0'
 gem 'rspec', '~> 3.0'
 gem 'rubocop', '~> 1.21'
+gem 'solargraph'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    scheming (0.5.0)
+    scheming (0.7.0)
 
 GEM
   remote: https://rubygems.org/
@@ -16,27 +16,40 @@ GEM
       minitest (>= 5.1)
       mutex_m
       tzinfo (~> 2.0)
-    addressable (2.8.6)
-      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
+    backport (1.2.0)
     base64 (0.2.0)
+    benchmark (0.3.0)
     bigdecimal (3.1.7)
     coderay (1.1.3)
     concurrent-ruby (1.2.3)
     connection_pool (2.4.1)
     diff-lcs (1.5.1)
     drb (2.2.1)
+    e2mmap (0.1.0)
     factory_bot (6.4.6)
       activesupport (>= 5.0.0)
+    hana (1.3.7)
     i18n (1.14.4)
       concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.6)
     json (2.7.2)
-    json-schema (4.3.0)
-      addressable (>= 2.8)
+    json_schemer (2.2.1)
+      base64
+      bigdecimal
+      hana (~> 1.3)
+      regexp_parser (~> 2.0)
+      simpleidn (~> 0.2)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
     language_server-protocol (3.17.0.3)
     method_source (1.1.0)
     minitest (5.22.3)
     mutex_m (0.2.0)
+    nokogiri (1.16.4-x86_64-linux)
+      racc (~> 1.4)
     parallel (1.24.0)
     parser (3.3.1.0)
       ast (~> 2.4.1)
@@ -44,11 +57,13 @@ GEM
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (5.0.5)
     racc (1.7.3)
     rainbow (3.1.1)
     rake (13.2.1)
+    rbs (2.8.4)
     regexp_parser (2.9.0)
+    reverse_markdown (2.1.1)
+      nokogiri
     rexml (3.2.6)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
@@ -77,21 +92,46 @@ GEM
     rubocop-ast (1.31.2)
       parser (>= 3.3.0.4)
     ruby-progressbar (1.13.0)
+    simpleidn (0.2.2)
+      unf (~> 0.1.4)
+    solargraph (0.50.0)
+      backport (~> 1.2)
+      benchmark
+      bundler (~> 2.0)
+      diff-lcs (~> 1.4)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      rbs (~> 2.0)
+      reverse_markdown (~> 2.0)
+      rubocop (~> 1.38)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    thor (1.3.1)
+    tilt (2.3.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.9.1)
     unicode-display_width (2.5.0)
+    yard (0.9.36)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
   factory_bot (~> 6.4)
-  json-schema (~> 4.3)
+  json_schemer
   pry (~> 0.14.2)
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.21)
   scheming!
+  solargraph
 
 BUNDLED WITH
    2.4.5

data/README.md

@@ -15,7 +15,7 @@ gem 'scheming'
 Definition:
 ```ruby
 LineItem = Scheming.object do
-  attribute :id, Integer
+  attribute :id, Union(Integer, String)
   attribute :name, String
   attribute :taxable, :bool
   attribute :price, Float
@@ -45,16 +45,21 @@ Scheming::Schema.json(Receipt)
 {
   type: 'object',
   additionalProperties: false,
-  required: %i[line_items total location],
+  required: %w[line_items total location],
   properties: {
     line_items: {
       type: 'array',
       items: {
         type: 'object',
         additionalProperties: false,
-        required: %i[id name taxable price],
+        required: %w[id name taxable price],
         properties: {
-          id: { type: 'integer' },
+          id: {
+            oneOf: [
+              { type: 'integer' },
+              { type: 'string' }
+            ]
+          },
           name: { type: 'string' },
           taxable: { type: 'boolean' },
           desc: {
@@ -75,7 +80,7 @@ Scheming::Schema.json(Receipt)
     location: {
       type: 'object',
       additionalProperties: false,
-      required: %i[x y],
+      required: %w[x y],
       properties: {
         x: { type: 'number' },
         y: { type: 'number' }

data/Rakefile

@@ -9,4 +9,9 @@ require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 
-task default: %i[spec rubocop]
+desc 'Run the type checker'
+task :typecheck do
+  sh 'bundle exec solargraph typecheck --level typed'
+end
+
+task default: %i[spec rubocop typecheck]

data/lib/scheming/attribute/list.rb

@@ -36,6 +36,7 @@ class Scheming::Attribute::List
   end
   alias [] attr
 
+  # @return [Array<Scheming::Attribute>]
   def required = each.select(&:is_required)
 
   # @return [Hash<Symbol, Scheming::Attribute>]

data/lib/scheming/dsl/data_builder.rb

@@ -12,7 +12,6 @@ class Scheming::DSL::DataBuilder
 
   # @param field_name [Symbol]
   # @param type_spec [Object]
-  # @param null [Boolean]
   # @return [void]
   def attribute(field_name, type_spec)
     @builder = @builder.attribute(

data/lib/scheming/dsl/tagging.rb

@@ -9,8 +9,8 @@ class Scheming::DSL::Tagging
   # creation of an [Scheming::Attribute]
   #
   class Tag
-    # @param name [Symbo]
-    # @data [Hash<Symbol, Object>]
+    # @param name [Symbol]
+    # @param data [Hash<Symbol, Object>]
     def initialize(name, data)
       @name = name
       @data = data
@@ -29,8 +29,8 @@ class Scheming::DSL::Tagging
     nil
   end
 
-  # @param taglist [Hash<Symbol, Object>]
   # @param name [Symbol]
+  # @param data [Hash<Symbol, Object>]
   # @return [Tag]
   def tag!(name, data)
     @tags[name] = Tag.new(name, data)

data/lib/scheming/dsl/type_specs.rb

@@ -26,4 +26,18 @@ module Scheming::DSL::TypeSpecs
     type = Scheming::DSL::TypeResolver.resolve(type_spec)
     Scheming::Type::Nullable.new(type)
   end
+
+  def Union(*type_specs) # rubocop:disable Naming/MethodName
+    types = type_specs.map do |type_spec|
+      Scheming::DSL::TypeResolver.resolve(type_spec)
+    end
+    Scheming::Type::Union.new(types)
+  end
+
+  def Tuple(*type_specs) # rubocop:disable Naming/MethodName
+    types = type_specs.map do |type_spec|
+      Scheming::DSL::TypeResolver.resolve(type_spec)
+    end
+    Scheming::Type::Tuple.new(types.freeze)
+  end
 end

data/lib/scheming/schema/json.rb

@@ -29,7 +29,10 @@ module Scheming::Schema
       private
 
       def required
-        attributes.required.map!(&:field_name).freeze
+        attributes
+          .required
+          .map! { |attr| attr.field_name.name }
+          .freeze
       end
 
       def properties
@@ -39,6 +42,25 @@ module Scheming::Schema
       end
     end
 
+    refine Scheming::Type::Union do
+      # @!attribute [r] types
+      #   @return [Array<Scheming::Type::Base>]
+
+      def schema = { oneOf: types.map(&:schema).freeze }
+    end
+
+    refine Scheming::Type::Tuple do
+      # @!attribute [r] types
+      #   @return [Array<Scheming::Type::Base>]
+
+      def schema
+        {
+          type: 'array',
+          prefixItems: types.map(&:schema).freeze
+        }.freeze
+      end
+    end
+
     refine Scheming::Type::Nullable do
       # @!attribute [r] type
       #   @return [Scheming::Type::Base]

data/lib/scheming/type.rb

@@ -1,5 +1,12 @@
 # frozen_string_literal: true
 
+# This is a redundant require statement; however,
+# for some reason Solargraph will not honor the
+# path for `set` in it's config.  For this reson
+# we need to require it here to prevent typecheck
+# errors.
+require 'set' # rubocop:disable Lint/RedundantRequireStatement
+
 # = Type
 #
 # Everything needed to describe and work
@@ -11,7 +18,11 @@ module Scheming::Type
   # Any and all shared functionality comes from
   # this base type definition.
   #
-  Base = Class.new
+  class Base
+    # This class left empty on purpose.  Acts
+    # merely as a tag which all types inherit
+    # back to.
+  end
 
   # = Object Type Definition
   #
@@ -30,6 +41,25 @@ module Scheming::Type
     end
   end
 
+  # = Tuple Type Definition
+  #
+  # Specifies a type which specifies specific types
+  # in a fixed order.  Another way to think of it is
+  # like an [Scheming::Type::Object] but without named
+  # attribute fields.
+  #
+  class Tuple < Base
+    # @return [Array<Scheming::Type::Base>]
+    attr_reader :types
+
+    # @param types [Array<Scheming::Type::Base>]
+    def initialize(types)
+      super()
+      @types = types
+      freeze
+    end
+  end
+
   # = Nullable Type Definition
   #
   # Type wrapper that describes a type can be either
@@ -47,6 +77,23 @@ module Scheming::Type
     end
   end
 
+  # = Union Type Definition
+  #
+  # In cases where a value can be of many different
+  # types a union is how to describe this.
+  #
+  class Union < Base
+    # @return [Array<Scheming::Type::Base>]
+    attr_reader :types
+
+    # @param types [Array<Scheming::Type::Base>]
+    def initialize(types)
+      super()
+      @types = types
+      freeze
+    end
+  end
+
   # = Enumeration Type Definition
   #
   # The wrapper that describes a type and holds

data/lib/scheming/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Scheming
-  VERSION = '0.5.0'
+  VERSION = '0.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scheming
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Ben Falk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-03 00:00:00.000000000 Z
+date: 2024-05-10 00:00:00.000000000 Z
 dependencies: []
 description: Ergonomic Data Design for the Masses
 email:
@@ -19,6 +19,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".solargraph.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock