scheming 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc01781074d4363c7a93440ca775680ad40e390eadf0dd84501501f96aad242f
-  data.tar.gz: c5356c5b7beb9d74f6489db0d4024973755fc5c2b6a5c015a97d4b21d612191c
+  metadata.gz: b21c99fc59c9fe7da35644b47be93b2d6bba2f13f4ef814008a64c92f2235323
+  data.tar.gz: c0ff8026a852f0b8e4c91bf86aa4a172502a12b3c89dcd693527863dc7cf58aa
 SHA512:
-  metadata.gz: d5ebcaf385cbf2148e37d326c06bd49bd6aa584c9d419096dbb8a7e5f909c191c93b1bc1a294c2a4589c9bf2a9902bf775d73679c440134ebae600ce25e9f110
-  data.tar.gz: 169ff09cbed7450f5d22754db231e98b5752d98fc00b8dfd2613cb0f0054c59efa24e4b8e86331b32823e76341de46685b8a45abda5416396cdd3b81f8809890
+  metadata.gz: 93fa8e2cd04de2c77495754fe04aa2cbd84070a862835c83ef535a7830b6e41337b401f2e35dbf297434397523e24b50c8cb97063745fe58d61f881114187424
+  data.tar.gz: 61c3cf8462b6d9075e593d00fa76921bbb7958e1ac2590f2a4683ff5c2aeac40b28209e579270eff279cea0261d6d1ea8194a0a87d2ebd3b56f93f8bfc8a2966

data/CHANGELOG.md

@@ -1,14 +1,39 @@
 ## [Unreleased]
 
-## [0.1.0] - 2024-04-26
+## [0.5.0] - 2024-05-02
 
-- Initial release
+### Added
 
-## [0.2.0] - 2024-05-01
+- Support for `generic` definitions
 
-### Added
+  # Example
+  ```ruby
+  Point = Scheming.generic do |(type)|
+    Object(x: type, y: type)
+  end
 
-- Support for `optional` fields
+  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
+
+- 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
@@ -18,12 +43,12 @@
     attribute :taxable, :bool
     attribute :price, Float
 
-    optional
-
+    tag(:optional)
     attribute :desc, Nullable(String)
+
+    tag(:optional)
     attribute :item_type, Enum('entertainment', 'staple')
   end
-  ```
 
 ## [0.3.0] - 2024-05-01
 
@@ -36,3 +61,28 @@
 ### Enhancement
 
 - Ensure all types produce valid JSON Schema
+
+## [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.1.0] - 2024-04-26
+
+- Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    scheming (0.3.0)
+    scheming (0.5.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -20,15 +20,21 @@ 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
 
+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
 ```
 
@@ -39,7 +45,7 @@ Scheming::Schema.json(Receipt)
 {
   type: 'object',
   additionalProperties: false,
-  required: %i[line_items total],
+  required: %i[line_items total location],
   properties: {
     line_items: {
       type: 'array',
@@ -60,12 +66,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: %i[x y],
+      properties: {
+        x: { type: 'number' },
+        y: { 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/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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Scheming
-  VERSION = '0.3.0'
+  VERSION = '0.5.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.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Ben Falk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-01 00:00:00.000000000 Z
+date: 2024-05-03 00:00:00.000000000 Z
 dependencies: []
 description: Ergonomic Data Design for the Masses
 email:
@@ -32,8 +32,10 @@ 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/generic.rb
 - lib/scheming/schema.rb
 - lib/scheming/schema/json.rb
 - lib/scheming/type.rb