scheming 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c861bcba1706b9ffe842a7d13cb55b047479d57a1c7e44a6e7fa7a934c83819a
-  data.tar.gz: 8837b76f3fa1c0c334387432a8c466085a96064482b4ff1dd00bbabc2b69c1ae
+  metadata.gz: 670c2fce2ac13e3ae6d64790ef6fbcad0f0de413c06bb2fc3300e24686315495
+  data.tar.gz: 599cd2a5d28aed9215a011b896a7eb5a207f14f2a7ca55dcd9299abed4100e32
 SHA512:
-  metadata.gz: c8d822270972cb4abc4837c89fa8084b78132af50acc829e7b610fe74cb5ce6bc517ea579528b489b774daa4aec17dd971704ad7f54c3113589d0fee225b22ed
-  data.tar.gz: 3c72a5b224d4d345ee050045d75f72ae74413e1bb78be6f1203795b4ed015f5327ca2e998a05712e086aef4b5d4925818c09c3afb98c5ffb1ac94ba1b6374296
+  metadata.gz: fb6bc063479d9b7fc4f3769d966102b0c9fccc971727bb5e72962186227dfb55d3921b40b3a26b5454defc36f1f48cf1afba680b6221ed4b84bee12ae16cce5f
+  data.tar.gz: 711e2a1f8b035ff4aa33dca7955f810cbd7e11774d221f7a2ad0da59623ce5424e4fc02a92fefac78117a1ed37b35fa3a24799547121e97daaebd523a722ef63

data/.rubocop.yml

@@ -18,3 +18,6 @@ Style/ClassAndModuleChildren:
 
 Layout/LineLength:
   Max: 90
+
+Lint/EmptyClass:
+  AllowComments: true

data/.solargraph.yml

@@ -0,0 +1,28 @@
+---
+include:
+- "**/*.rb"
+exclude:
+- spec/**/*
+- test/**/*
+- vendor/**/*
+- ".bundle/**/*"
+require: []
+domains: []
+reporters:
+- rubocop
+- require_not_found
+- typecheck
+formatter:
+  rubocop:
+    cops: safe
+    except: []
+    only: []
+    extra_args: []
+require_paths: [
+  'factory_bot',
+  'json_schemer',
+  'pry',
+  'set'
+]
+plugins: []
+max_files: 5000

data/CHANGELOG.md

@@ -1,12 +1,59 @@
 ## [Unreleased]
 
-## [0.6.0]
+## [0.7.0] - 2024-05-10
+
+### Added
+
+- `Tuple` type added
+
+  #### Example
+  ```ruby
+  EmailTemplate = Scheming.object do
+    attribute :id, Integer
+    attribute :data, Tuple(String, Array(String))
+  end
+
+  Scheming::Schema.json(EmailTemplate)
+  # =>
+  {
+    type: 'object',
+    additionalProperties: false,
+    required: %w[id data],
+    properties: {
+      id: { type: 'integer' },
+      data: {
+        type: 'array',
+        prefixItems: [
+          { type: 'string' },
+          {
+            type: 'array',
+            items: { type: 'string' }
+          }
+        ]
+      }
+    }
+  }
+  ```
+
+### Enhancement
+
+- Added `solorgraph` to the development process and added
+  it's typecheck to the default `rake` task.
+
+- Reduced string allocations when generating required field
+  names for objects with the JSON schema format.
+
+### Bugfix
+
+- Incorrect type syntax corrected as reported by `solargraph`.
+
+## [0.6.0] - 2024-05-04
 
 ### Added
 
 - `Union` type added
 
-  # Example
+  #### Example
   ```ruby
   Order = Scheming.object do
     attribute :id, Union(String, Integer)
@@ -15,10 +62,17 @@
   Scheming::Schema.json(Order)
   # =>
   {
-    oneOf: [
-      { type: 'string' },
-      { type: 'integer' }
-    ]
+    type: 'object',
+    additionalProperties: false,
+    required: %w[id],
+    properties: {
+      id: {
+        oneOf: [
+          { type: 'string' },
+          { type: 'integer' }
+        ]
+      }
+    }
   }
   ```
 
@@ -48,7 +102,7 @@
 
 - Support for `generic` definitions
 
-  # Example
+  #### Example
   ```ruby
   Point = Scheming.generic do |(type)|
     Object(x: type, y: type)

data/Gemfile

@@ -11,3 +11,4 @@ gem 'pry', '~> 0.14.2'
 gem 'rake', '~> 13.0'
 gem 'rspec', '~> 3.0'
 gem 'rubocop', '~> 1.21'
+gem 'solargraph'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    scheming (0.6.0)
+    scheming (0.7.0)
 
 GEM
   remote: https://rubygems.org/
@@ -17,18 +17,22 @@ GEM
       mutex_m
       tzinfo (~> 2.0)
     ast (2.4.2)
+    backport (1.2.0)
     base64 (0.2.0)
+    benchmark (0.3.0)
     bigdecimal (3.1.7)
     coderay (1.1.3)
     concurrent-ruby (1.2.3)
     connection_pool (2.4.1)
     diff-lcs (1.5.1)
     drb (2.2.1)
+    e2mmap (0.1.0)
     factory_bot (6.4.6)
       activesupport (>= 5.0.0)
     hana (1.3.7)
     i18n (1.14.4)
       concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.6)
     json (2.7.2)
     json_schemer (2.2.1)
       base64
@@ -36,10 +40,16 @@ GEM
       hana (~> 1.3)
       regexp_parser (~> 2.0)
       simpleidn (~> 0.2)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
     language_server-protocol (3.17.0.3)
     method_source (1.1.0)
     minitest (5.22.3)
     mutex_m (0.2.0)
+    nokogiri (1.16.4-x86_64-linux)
+      racc (~> 1.4)
     parallel (1.24.0)
     parser (3.3.1.0)
       ast (~> 2.4.1)
@@ -50,7 +60,10 @@ GEM
     racc (1.7.3)
     rainbow (3.1.1)
     rake (13.2.1)
+    rbs (2.8.4)
     regexp_parser (2.9.0)
+    reverse_markdown (2.1.1)
+      nokogiri
     rexml (3.2.6)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
@@ -81,12 +94,31 @@ GEM
     ruby-progressbar (1.13.0)
     simpleidn (0.2.2)
       unf (~> 0.1.4)
+    solargraph (0.50.0)
+      backport (~> 1.2)
+      benchmark
+      bundler (~> 2.0)
+      diff-lcs (~> 1.4)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      rbs (~> 2.0)
+      reverse_markdown (~> 2.0)
+      rubocop (~> 1.38)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    thor (1.3.1)
+    tilt (2.3.0)
     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)
+    yard (0.9.36)
 
 PLATFORMS
   x86_64-linux
@@ -99,6 +131,7 @@ DEPENDENCIES
   rspec (~> 3.0)
   rubocop (~> 1.21)
   scheming!
+  solargraph
 
 BUNDLED WITH
    2.4.5

data/Rakefile

@@ -9,4 +9,9 @@ require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 
-task default: %i[spec rubocop]
+desc 'Run the type checker'
+task :typecheck do
+  sh 'bundle exec solargraph typecheck --level typed'
+end
+
+task default: %i[spec rubocop typecheck]

data/lib/scheming/attribute/list.rb

@@ -36,6 +36,7 @@ class Scheming::Attribute::List
   end
   alias [] attr
 
+  # @return [Array<Scheming::Attribute>]
   def required = each.select(&:is_required)
 
   # @return [Hash<Symbol, Scheming::Attribute>]

data/lib/scheming/dsl/tagging.rb

@@ -9,7 +9,7 @@ class Scheming::DSL::Tagging
   # creation of an [Scheming::Attribute]
   #
   class Tag
-    # @param name [Symbo]
+    # @param name [Symbol]
     # @param data [Hash<Symbol, Object>]
     def initialize(name, data)
       @name = name

data/lib/scheming/dsl/type_specs.rb

@@ -33,4 +33,11 @@ module Scheming::DSL::TypeSpecs
     end
     Scheming::Type::Union.new(types)
   end
+
+  def Tuple(*type_specs) # rubocop:disable Naming/MethodName
+    types = type_specs.map do |type_spec|
+      Scheming::DSL::TypeResolver.resolve(type_spec)
+    end
+    Scheming::Type::Tuple.new(types.freeze)
+  end
 end

data/lib/scheming/schema/json.rb

@@ -31,7 +31,7 @@ module Scheming::Schema
       def required
         attributes
           .required
-          .map! { |attr| attr.field_name.to_s.freeze }
+          .map! { |attr| attr.field_name.name }
           .freeze
       end
 
@@ -49,6 +49,18 @@ module Scheming::Schema
       def schema = { oneOf: types.map(&:schema).freeze }
     end
 
+    refine Scheming::Type::Tuple do
+      # @!attribute [r] types
+      #   @return [Array<Scheming::Type::Base>]
+
+      def schema
+        {
+          type: 'array',
+          prefixItems: types.map(&:schema).freeze
+        }.freeze
+      end
+    end
+
     refine Scheming::Type::Nullable do
       # @!attribute [r] type
       #   @return [Scheming::Type::Base]

data/lib/scheming/type.rb

@@ -1,5 +1,12 @@
 # frozen_string_literal: true
 
+# This is a redundant require statement; however,
+# for some reason Solargraph will not honor the
+# path for `set` in it's config.  For this reson
+# we need to require it here to prevent typecheck
+# errors.
+require 'set' # rubocop:disable Lint/RedundantRequireStatement
+
 # = Type
 #
 # Everything needed to describe and work
@@ -11,7 +18,11 @@ module Scheming::Type
   # Any and all shared functionality comes from
   # this base type definition.
   #
-  Base = Class.new
+  class Base
+    # This class left empty on purpose.  Acts
+    # merely as a tag which all types inherit
+    # back to.
+  end
 
   # = Object Type Definition
   #
@@ -30,6 +41,25 @@ module Scheming::Type
     end
   end
 
+  # = Tuple Type Definition
+  #
+  # Specifies a type which specifies specific types
+  # in a fixed order.  Another way to think of it is
+  # like an [Scheming::Type::Object] but without named
+  # attribute fields.
+  #
+  class Tuple < Base
+    # @return [Array<Scheming::Type::Base>]
+    attr_reader :types
+
+    # @param types [Array<Scheming::Type::Base>]
+    def initialize(types)
+      super()
+      @types = types
+      freeze
+    end
+  end
+
   # = Nullable Type Definition
   #
   # Type wrapper that describes a type can be either

data/lib/scheming/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scheming
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Ben Falk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-04 00:00:00.000000000 Z
+date: 2024-05-10 00:00:00.000000000 Z
 dependencies: []
 description: Ergonomic Data Design for the Masses
 email:
@@ -19,6 +19,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".solargraph.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock