scheming 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9200950b341609a10673661255198aacf8012bdb89b89868d66eed91aa11c395
-  data.tar.gz: 175243bb9bd5204b93b5f59f2e0b403163c86ed745a01a23c2e987bc2aab2813
+  metadata.gz: b21c99fc59c9fe7da35644b47be93b2d6bba2f13f4ef814008a64c92f2235323
+  data.tar.gz: c0ff8026a852f0b8e4c91bf86aa4a172502a12b3c89dcd693527863dc7cf58aa
 SHA512:
-  metadata.gz: 9c83e51b6db0200f0d222250e690696061ecf581bad11e4c5916df828cfef2d6ae01da50349d7a1cdea2097b7a235fe19950c48ec0b11f628522ed734a100e48
-  data.tar.gz: b35ebaf5d8d1a30b1538471d153a7da1ed648037c84c89ec2132742bad94fcfee0b0d4744b0c82b3f36de924d30a39579e881a812f4d1ba6fc3bff9c46283415
+  metadata.gz: 93fa8e2cd04de2c77495754fe04aa2cbd84070a862835c83ef535a7830b6e41337b401f2e35dbf297434397523e24b50c8cb97063745fe58d61f881114187424
+  data.tar.gz: 61c3cf8462b6d9075e593d00fa76921bbb7958e1ac2590f2a4683ff5c2aeac40b28209e579270eff279cea0261d6d1ea8194a0a87d2ebd3b56f93f8bfc8a2966

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 ## [Unreleased]
 
+## [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 +60,8 @@
 
 ### Enhancement
 
+- Ensure all types produce valid JSON Schema
+
 ## [0.2.0] - 2024-05-01
 
 ### Added
@@ -56,8 +83,6 @@
   end
   ```
 
-- Ensure all types produce valid JSON Schema
-
 ## [0.1.0] - 2024-04-26
 
 - Initial release

data/Gemfile.lock

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

data/README.md

@@ -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,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',
@@ -61,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/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.4.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.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Ben Falk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-02 00:00:00.000000000 Z
+date: 2024-05-03 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