scheming 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff00e122a5534ba54406fa8ffbf47b936fa564fdb26fd601299b0a8f508ebff1
-  data.tar.gz: e45e06743f0bc67d1176b7d6489127e476fd8e80e3ae67a2787d544cda7213df
+  metadata.gz: 9200950b341609a10673661255198aacf8012bdb89b89868d66eed91aa11c395
+  data.tar.gz: 175243bb9bd5204b93b5f59f2e0b403163c86ed745a01a23c2e987bc2aab2813
 SHA512:
-  metadata.gz: d2a00a25d768946d55420bbd27a47fe598068f806d438b37930a62455647d65be1f72f5961be55e8e82723befa11713dad504fdebce532d228b521dcc3abc3f3
-  data.tar.gz: dbef726a89b0831591327eb7a23c6686f566f0b8ec790fb58b0b2214615bb7b32419b6267a1edff4418b69dba9794e18e3744e6e816fbeffb20aa41cd5b160b5
+  metadata.gz: 9c83e51b6db0200f0d222250e690696061ecf581bad11e4c5916df828cfef2d6ae01da50349d7a1cdea2097b7a235fe19950c48ec0b11f628522ed734a100e48
+  data.tar.gz: b35ebaf5d8d1a30b1538471d153a7da1ed648037c84c89ec2132742bad94fcfee0b0d4744b0c82b3f36de924d30a39579e881a812f4d1ba6fc3bff9c46283415

data/CHANGELOG.md

@@ -1,8 +1,39 @@
 ## [Unreleased]
 
-## [0.1.0] - 2024-04-26
+## [0.4.0] - 2024-05-02
 
-- Initial release
+### Breaking Change
+
+- Opting for a `tag` system to work with attributes instead
+  of a blanket lexical scope like `optional` to work with
+  attributes.  The long term goal is to expand out the tagging
+  system so that it can support much more than we can
+  anticipate today.
+
+  # Example:
+  ```ruby
+  LineItem = Scheming.object do
+    attribute :id, Integer
+    attribute :name, String
+    attribute :taxable, :bool
+    attribute :price, Float
+
+    tag(:optional)
+    attribute :desc, Nullable(String)
+
+    tag(:optional)
+    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
 
 ## [0.2.0] - 2024-05-01
 
@@ -24,3 +55,9 @@
     attribute :item_type, Enum('entertainment', 'staple')
   end
   ```
+
+- Ensure all types produce valid JSON Schema
+
+## [0.1.0] - 2024-04-26
+
+- Initial release

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.4.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

@@ -20,9 +20,10 @@ LineItem = Scheming.object do
   attribute :taxable, :bool
   attribute :price, Float
 
-  optional
-
+  tag(:optional)
   attribute :desc, Nullable(String)
+
+  tag(:optional)
   attribute :item_type, Enum('entertainment', 'staple')
 end
 
@@ -57,15 +58,15 @@ Scheming::Schema.json(Receipt)
               { type: 'null' }
             ]
           },
-          price: { type: 'numeric' },
+          price: { type: 'number' },
           item_type: {
             type: 'string',
-            enum: Set['intertainment', 'staple']
+            enum: ['intertainment', 'staple']
           }
         }
       }
     },
-    total: { type: 'numeric' }
+    total: { type: 'number' }
   }
 }
 ```

data/lib/scheming/dsl/data_builder.rb

@@ -7,7 +7,7 @@ class Scheming::DSL::DataBuilder
   def initialize(builder = Scheming::Attribute::ListBuilder.new)
     @builder = builder
     @resolver = Scheming::DSL::TypeResolver
-    @required = true
+    @tagging = Scheming::DSL::Tagging.new
   end
 
   # @param field_name [Symbol]
@@ -18,14 +18,17 @@ class Scheming::DSL::DataBuilder
     @builder = @builder.attribute(
       field_name,
       type: @resolver.resolve(type_spec),
-      is_required: @required
+      **@tagging.attribute_params
     )
+    @tagging.reset!
     nil
   end
 
-  # Mark all arrtibutes after this as optional
-  def optional
-    @required = false
+  # @param name [Symbol]
+  # @param args [Hash<Symbol, Object>]
+  def tag(name, **args)
+    @tagging.tag!(name, args)
+    nil
   end
 
   # @return [Class]

data/lib/scheming/dsl/tagging.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# = Type Resolver
+class Scheming::DSL::Tagging
+  # = Attribute Tag
+  #
+  # Simple representation of a concept
+  # that can be used to aid in the
+  # creation of an [Scheming::Attribute]
+  #
+  class Tag
+    # @param name [Symbo]
+    # @data [Hash<Symbol, Object>]
+    def initialize(name, data)
+      @name = name
+      @data = data
+    end
+  end
+  private_constant :Tag
+
+  def initialize
+    # @type [Hash<Symbol, Tag>]
+    @tags = {}
+  end
+
+  # @return [void]
+  def reset!
+    @tags.clear
+    nil
+  end
+
+  # @param taglist [Hash<Symbol, Object>]
+  # @param name [Symbol]
+  # @return [Tag]
+  def tag!(name, data)
+    @tags[name] = Tag.new(name, data)
+  end
+
+  def attribute_params
+    {
+      is_required: missing?(:optional)
+    }
+  end
+
+  def missing?(name) = !has?(name)
+  def has?(name) = @tags.key?(name)
+end

data/lib/scheming/dsl.rb

@@ -8,6 +8,7 @@
 # who need to know.
 #
 module Scheming::DSL
+  require_relative 'dsl/tagging'
   require_relative 'dsl/type_specs'
   require_relative 'dsl/data_builder'
   require_relative 'dsl/object_type_def'

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.2.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scheming
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ben Falk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-01 00:00:00.000000000 Z
+date: 2024-05-02 00:00:00.000000000 Z
 dependencies: []
 description: Ergonomic Data Design for the Masses
 email:
@@ -32,6 +32,7 @@ files:
 - lib/scheming/dsl.rb
 - lib/scheming/dsl/data_builder.rb
 - lib/scheming/dsl/object_type_def.rb
+- lib/scheming/dsl/tagging.rb
 - lib/scheming/dsl/type_resolver.rb
 - lib/scheming/dsl/type_specs.rb
 - lib/scheming/schema.rb
@@ -39,7 +40,7 @@ files:
 - lib/scheming/type.rb
 - lib/scheming/version.rb
 - sig/scheming.rbs
-homepage: 
+homepage: https://github.com/benfalk/scheming
 licenses:
 - MIT
 metadata: