scheming 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9200950b341609a10673661255198aacf8012bdb89b89868d66eed91aa11c395
-  data.tar.gz: 175243bb9bd5204b93b5f59f2e0b403163c86ed745a01a23c2e987bc2aab2813
+  metadata.gz: c861bcba1706b9ffe842a7d13cb55b047479d57a1c7e44a6e7fa7a934c83819a
+  data.tar.gz: 8837b76f3fa1c0c334387432a8c466085a96064482b4ff1dd00bbabc2b69c1ae
 SHA512:
-  metadata.gz: 9c83e51b6db0200f0d222250e690696061ecf581bad11e4c5916df828cfef2d6ae01da50349d7a1cdea2097b7a235fe19950c48ec0b11f628522ed734a100e48
-  data.tar.gz: b35ebaf5d8d1a30b1538471d153a7da1ed648037c84c89ec2132742bad94fcfee0b0d4744b0c82b3f36de924d30a39579e881a812f4d1ba6fc3bff9c46283415
+  metadata.gz: c8d822270972cb4abc4837c89fa8084b78132af50acc829e7b610fe74cb5ce6bc517ea579528b489b774daa4aec17dd971704ad7f54c3113589d0fee225b22ed
+  data.tar.gz: 3c72a5b224d4d345ee050045d75f72ae74413e1bb78be6f1203795b4ed015f5327ca2e998a05712e086aef4b5d4925818c09c3afb98c5ffb1ac94ba1b6374296

data/CHANGELOG.md

@@ -1,5 +1,72 @@
 ## [Unreleased]
 
+## [0.6.0]
+
+### Added
+
+- `Union` type added
+
+  # Example
+  ```ruby
+  Order = Scheming.object do
+    attribute :id, Union(String, Integer)
+  end
+
+  Scheming::Schema.json(Order)
+  # =>
+  {
+    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
+  ```ruby
+  Point = Scheming.generic do |(type)|
+    Object(x: type, y: type)
+  end
+
+  Scheming::Schema.json(Point)
+  # =>
+  {
+    type: 'object',
+    additionalProperties: false,
+    required: %i[x y],
+    properties: {
+      x: { type: 'number' },
+      y: { type: 'number' }
+    }
+  }
+  ```
+
 ## [0.4.0] - 2024-05-02
 
 ### Breaking Change
@@ -35,6 +102,8 @@
 
 ### Enhancement
 
+- Ensure all types produce valid JSON Schema
+
 ## [0.2.0] - 2024-05-01
 
 ### Added
@@ -56,8 +125,6 @@
   end
   ```
 
-- Ensure all types produce valid JSON Schema
-
 ## [0.1.0] - 2024-04-26
 
 - Initial release

data/Gemfile

@@ -6,7 +6,7 @@ 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'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    scheming (0.4.0)
+    scheming (0.6.0)
 
 GEM
   remote: https://rubygems.org/
@@ -16,8 +16,6 @@ GEM
       minitest (>= 5.1)
       mutex_m
       tzinfo (~> 2.0)
-    addressable (2.8.6)
-      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     base64 (0.2.0)
     bigdecimal (3.1.7)
@@ -28,11 +26,16 @@ GEM
     drb (2.2.1)
     factory_bot (6.4.6)
       activesupport (>= 5.0.0)
+    hana (1.3.7)
     i18n (1.14.4)
       concurrent-ruby (~> 1.0)
     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)
     language_server-protocol (3.17.0.3)
     method_source (1.1.0)
     minitest (5.22.3)
@@ -44,7 +47,6 @@ 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)
@@ -77,8 +79,13 @@ GEM
     rubocop-ast (1.31.2)
       parser (>= 3.3.0.4)
     ruby-progressbar (1.13.0)
+    simpleidn (0.2.2)
+      unf (~> 0.1.4)
     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)
 
 PLATFORMS
@@ -86,7 +93,7 @@ PLATFORMS
 
 DEPENDENCIES
   factory_bot (~> 6.4)
-  json-schema (~> 4.3)
+  json_schemer
   pry (~> 0.14.2)
   rake (~> 13.0)
   rspec (~> 3.0)

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
@@ -27,9 +27,14 @@ LineItem = Scheming.object do
   attribute :item_type, Enum('entertainment', 'staple')
 end
 
+Point = Scheming.generic do |(type)|
+  Object(x: type, y: type)
+end
+
 Receipt = Scheming.object do
   attribute :line_items, Array(LineItem)
   attribute :total, Float
+  attribute :location, Point[Float]
 end
 ```
 
@@ -40,16 +45,21 @@ Scheming::Schema.json(Receipt)
 {
   type: 'object',
   additionalProperties: false,
-  required: %i[line_items total],
+  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: {
@@ -61,12 +71,21 @@ Scheming::Schema.json(Receipt)
           price: { type: 'number' },
           item_type: {
             type: 'string',
-            enum: ['intertainment', 'staple']
+            enum: %w[entertainment staple]
           }
         }
       }
     },
-    total: { type: 'number' }
+    total: { type: 'number' },
+    location: {
+      type: 'object',
+      additionalProperties: false,
+      required: %w[x y],
+      properties: {
+        x: { type: 'number' },
+        y: { type: 'number' }
+      }
+    }
   }
 }
 ```

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

@@ -10,7 +10,7 @@ class Scheming::DSL::Tagging
   #
   class Tag
     # @param name [Symbo]
-    # @data [Hash<Symbol, Object>]
+    # @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,11 @@ 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
 end

data/lib/scheming/generic.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# = Generic
+#
+# Many types can be "templated" in a way where
+# some types get swapped in and out.  Perhaps
+# the most common example for this is with a
+# two dimensional `Point` structure. We could
+# have a point with `Float` coordinates OR they
+# could also be `Integer`:
+#
+# ```ruby
+# Object(x: Float, y: Float)
+# Object(x: Integer, y: Integer)
+# ```
+#
+# Instead of having two defintions we can have
+# a single generic that defins both:
+#
+# ```ruby
+# Point = Scheming::Generic.new do |(t)|
+#   Object(x: t, y: t)
+# end
+#
+# Point[Float]
+#
+# Point[Integer]
+# ```
+#
+class Scheming::Generic
+  def initialize(&proto_type)
+    @proto_type = proto_type
+  end
+
+  # @param types [Scheming::Type::Base]
+  def [](*types)
+    Scheming::DSL::DataBuilder
+      .new
+      .instance_exec(types, &@proto_type)
+  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.to_s.freeze }
+          .freeze
       end
 
       def properties
@@ -39,6 +42,13 @@ 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::Nullable do
       # @!attribute [r] type
       #   @return [Scheming::Type::Base]

data/lib/scheming/type.rb

@@ -47,6 +47,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.4.0'
+  VERSION = '0.6.0'
 end

data/lib/scheming.rb

@@ -10,6 +10,7 @@ module Scheming
   require_relative 'scheming/attribute'
   require_relative 'scheming/type'
   require_relative 'scheming/schema'
+  require_relative 'scheming/generic'
   require_relative 'scheming/dsl'
 
   # @return [Class]
@@ -18,4 +19,7 @@ module Scheming
     builder.instance_exec(&)
     builder.build
   end
+
+  # @return [Scheming::Generic]
+  def self.generic(&) = Scheming::Generic.new(&)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scheming
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Ben Falk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-02 00:00:00.000000000 Z
+date: 2024-05-04 00:00:00.000000000 Z
 dependencies: []
 description: Ergonomic Data Design for the Masses
 email:
@@ -35,6 +35,7 @@ files:
 - lib/scheming/dsl/tagging.rb
 - lib/scheming/dsl/type_resolver.rb
 - lib/scheming/dsl/type_specs.rb
+- lib/scheming/generic.rb
 - lib/scheming/schema.rb
 - lib/scheming/schema/json.rb
 - lib/scheming/type.rb