scheming 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a71514dd3a8b1f9640a40adf0bbfd928cab9abe7b6981fad8ac0e25a1c7add01
-  data.tar.gz: edad4ab18d9c22efebbdc39b9a7c74d451e9a41b9b85892a743bb0dc726301b2
+  metadata.gz: bc01781074d4363c7a93440ca775680ad40e390eadf0dd84501501f96aad242f
+  data.tar.gz: c5356c5b7beb9d74f6489db0d4024973755fc5c2b6a5c015a97d4b21d612191c
 SHA512:
-  metadata.gz: daaff46c5331a1dd747fadfd50701f497225d05104d443dce75c0b8d244445943cea917e5d2ad39a2daf2fbe271ea08edd0930ac351a12dd1ff552c05b6fb590
-  data.tar.gz: 28f7756667869ff46d076f74dc89849d65a5fc3609c2c472d85f02cfe16143c74936ac7d16bb2d577650b53df159d9402d34926999f6e8aa3808d721dec2afc9
+  metadata.gz: d5ebcaf385cbf2148e37d326c06bd49bd6aa584c9d419096dbb8a7e5f909c191c93b1bc1a294c2a4589c9bf2a9902bf775d73679c440134ebae600ce25e9f110
+  data.tar.gz: 169ff09cbed7450f5d22754db231e98b5752d98fc00b8dfd2613cb0f0054c59efa24e4b8e86331b32823e76341de46685b8a45abda5416396cdd3b81f8809890

data/CHANGELOG.md

@@ -3,3 +3,36 @@
 ## [0.1.0] - 2024-04-26
 
 - Initial release
+
+## [0.2.0] - 2024-05-01
+
+### Added
+
+- Support for `optional` fields
+
+  # Example:
+  ```ruby
+  LineItem = Scheming.object do
+    attribute :id, Integer
+    attribute :name, String
+    attribute :taxable, :bool
+    attribute :price, Float
+
+    optional
+
+    attribute :desc, Nullable(String)
+    attribute :item_type, Enum('entertainment', 'staple')
+  end
+  ```
+
+## [0.3.0] - 2024-05-01
+
+### Bugfix
+
+- JSON Schema for Float was `numeric` instead of `number`
+
+- JSON Schema production of `Enum` **must** be an array
+
+### Enhancement
+
+- Ensure all types produce valid JSON Schema

data/Gemfile

@@ -6,6 +6,7 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'factory_bot', '~> 6.4'
+gem 'json-schema', '~> 4.3'
 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.1.0)
+    scheming (0.3.0)
 
 GEM
   remote: https://rubygems.org/
@@ -16,6 +16,8 @@ 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)
@@ -29,6 +31,8 @@ GEM
     i18n (1.14.4)
       concurrent-ruby (~> 1.0)
     json (2.7.2)
+    json-schema (4.3.0)
+      addressable (>= 2.8)
     language_server-protocol (3.17.0.3)
     method_source (1.1.0)
     minitest (5.22.3)
@@ -40,6 +44,7 @@ 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)
@@ -81,6 +86,7 @@ PLATFORMS
 
 DEPENDENCIES
   factory_bot (~> 6.4)
+  json-schema (~> 4.3)
   pry (~> 0.14.2)
   rake (~> 13.0)
   rspec (~> 3.0)

data/README.md

@@ -18,9 +18,12 @@ LineItem = Scheming.object do
   attribute :id, Integer
   attribute :name, String
   attribute :taxable, :bool
-  attribute :desc, Nullable(String)
   attribute :price, Float
-  attribute :type, Enum('entertainment', 'staple')
+
+  optional
+
+  attribute :desc, Nullable(String)
+  attribute :item_type, Enum('entertainment', 'staple')
 end
 
 Receipt = Scheming.object do
@@ -43,7 +46,7 @@ Scheming::Schema.json(Receipt)
       items: {
         type: 'object',
         additionalProperties: false,
-        required: %i[id name taxable desc price item_type],
+        required: %i[id name taxable price],
         properties: {
           id: { type: 'integer' },
           name: { type: 'string' },
@@ -54,15 +57,15 @@ Scheming::Schema.json(Receipt)
               { type: 'null' }
             ]
           },
-          price: { type: 'numeric' },
+          price: { type: 'number' },
           item_type: {
             type: 'string',
-            enum: %w[entertainment staple].to_set
+            enum: ['intertainment', 'staple']
           }
         }
       }
     },
-    total: { type: 'numeric' }
+    total: { type: 'number' }
   }
 }
 ```

data/lib/scheming/dsl/data_builder.rb

@@ -7,6 +7,7 @@ class Scheming::DSL::DataBuilder
   def initialize(builder = Scheming::Attribute::ListBuilder.new)
     @builder = builder
     @resolver = Scheming::DSL::TypeResolver
+    @required = true
   end
 
   # @param field_name [Symbol]
@@ -14,11 +15,19 @@ class Scheming::DSL::DataBuilder
   # @param null [Boolean]
   # @return [void]
   def attribute(field_name, type_spec)
-    type = @resolver.resolve(type_spec)
-    @builder = @builder.attribute(field_name, type:)
+    @builder = @builder.attribute(
+      field_name,
+      type: @resolver.resolve(type_spec),
+      is_required: @required
+    )
     nil
   end
 
+  # Mark all arrtibutes after this as optional
+  def optional
+    @required = false
+  end
+
   # @return [Class]
   def build
     list = @builder.build

data/lib/scheming/schema/json.rb

@@ -6,7 +6,7 @@ module Scheming::Schema
     module Constants
       NULL = { type: 'null' }.freeze
       INTEGER = { type: 'integer' }.freeze
-      FLOAT = { type: 'numeric' }.freeze
+      FLOAT = { type: 'number' }.freeze
       STRING = { type: 'string' }.freeze
       BOOLEAN = { type: 'boolean' }.freeze
     end
@@ -68,7 +68,7 @@ module Scheming::Schema
 
     refine Scheming::Type::Enum do
       def schema
-        type.schema.merge(enum: values).freeze
+        type.schema.merge(enum: values.to_a.freeze).freeze
       end
     end
 

data/lib/scheming/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scheming
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ben Falk
@@ -39,10 +39,12 @@ files:
 - lib/scheming/type.rb
 - lib/scheming/version.rb
 - sig/scheming.rbs
-homepage: 
+homepage: https://github.com/benfalk/scheming
 licenses:
 - MIT
 metadata:
+  source_code_uri: https://github.com/benfalk/scheming
+  changelog_uri: https://raw.githubusercontent.com/benfalk/scheming/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []