finitio 0.12.2 → 0.12.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dba23fcd08948c1ba59360fcedd3deb9eab5b7f92c49ad8849256da1964574c6
-  data.tar.gz: eaea92410902208a2c003fe34f3935604d4c464f4917e4bf06f7129fbfc24364
+  metadata.gz: df61ed2ea8ba9643bab08463287bd7f78141b0ded15b11564715254c28eb134d
+  data.tar.gz: 4cf9ab37fe2ba85ba9d86036475f67925a075d049a8d00eb6e91f3d80bbf38aa
 SHA512:
-  metadata.gz: 890a227df66eef86898513ba4269863f603c3289c65bd65ff68b1cd6372b5d60b6ae726b46fc9d4c5c898dab78dbc50e124b84733bf6df176c5b4401803741a0
-  data.tar.gz: db438df7b731247174b40954c050893fba97d7db522e8b423bf5fb62a0075e44d6d3cb96ea5e58144416801e7ccabb8471e23ffdd1071d29ee790f9c5db1047f
+  metadata.gz: 821411d259e45809c9e1da9ee22dafb36917b0f8c42a1dd87de66ff0951f063d49127b14dafab2c23e2c4ec4c9689204519b8152a4d218fb5279ccdba52777f1
+  data.tar.gz: 94bc8e8b9f0444872cc964e56baf46c325e0f742940c9e2f081bf31e187cdb9d45165b13426f122d6020a0cd8395365d83e5a38ee8b0ab271f71669bc7edb28f

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 0.12.3 - 2025/09/01
+
+* Add Heading#project and (Multi)TupleType#project, to remove some attributes.
+
+* Add attribute description (taken from metadata) when generating JsonSchema
+  from a HashBasedType.
+
+* Add support for a hard stop when generating JsonSchema, via a jsonSchemaType
+  metadata.
+
 ## 0.12.2 - 2025/03/22
 
 * Add Heading#allbut and (Multi)TupleType#allbut, to remove some attributes.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    finitio (0.12.2)
+    finitio (0.12.3)
       citrus (>= 3.0, < 4.0)
 
 GEM
@@ -13,7 +13,7 @@ GEM
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     awesome_print (1.9.2)
-    bigdecimal (3.1.9)
+    bigdecimal (3.2.2)
     builder (3.3.0)
     citrus (3.0.2)
     concurrent-ruby (1.3.5)
@@ -56,13 +56,14 @@ GEM
       cucumber-messages (~> 12.2, >= 12.2.0)
     diff-lcs (1.3)
     docile (1.4.1)
-    ffi (1.17.1-x86_64-linux-gnu)
+    ffi (1.17.2-x86_64-linux-gnu)
     i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    json (2.10.2)
+    json (2.13.2)
+    memoist3 (1.0.0)
     middleware (0.1.0)
     minitest (5.25.5)
-    multi_json (1.15.0)
+    multi_json (1.17.0)
     multi_test (0.1.2)
     path (2.1.0)
     protobuf-cucumber (3.10.8)
@@ -70,33 +71,34 @@ GEM
       middleware
       thor
       thread_safe
-    rake (13.2.1)
-    rspec (3.13.0)
+    rake (13.3.0)
+    rspec (3.13.1)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.3)
+    rspec-core (3.13.5)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.2)
+    rspec-mocks (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.2)
+    rspec-support (3.13.5)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
     sync (0.5.0)
-    sys-uname (1.3.1)
+    sys-uname (1.4.1)
       ffi (~> 1.1)
+      memoist3 (~> 1.0.0)
     term-ansicolor (1.11.2)
       tins (~> 1.0)
-    thor (1.3.2)
+    thor (1.4.0)
     thread_safe (0.3.6)
-    tins (1.38.0)
+    tins (1.42.0)
       bigdecimal
       sync
     tzinfo (2.0.6)

data/lib/finitio/json_schema/ad_type.rb

@@ -2,6 +2,10 @@ module Finitio
   class AdType
 
     def to_json_schema(*args, &bl)
+      if type = metadata[:jsonSchemaType]
+        return { type: type }
+      end
+
       subtypes = contracts
           .map{|c| c.infotype.to_json_schema(*args, &bl) }
           .uniq

data/lib/finitio/json_schema/alias_type.rb

@@ -2,6 +2,10 @@ module Finitio
   class AliasType
 
     def to_json_schema(*args, &bl)
+      if type = metadata[:jsonSchemaType]
+        return { type: type }
+      end
+
       target.to_json_schema(*args, &bl)
     end
 

data/lib/finitio/json_schema/any_type.rb

@@ -2,6 +2,10 @@ module Finitio
   class AnyType
 
     def to_json_schema(*args, &bl)
+      if type = metadata[:jsonSchemaType]
+        return { type: type }
+      end
+
       {}
     end
 

data/lib/finitio/json_schema/builtin_type.rb

@@ -17,6 +17,10 @@ module Finitio
   class BuiltinType
 
     def to_json_schema(*args, &bl)
+      if type = metadata[:jsonSchemaType]
+        return { type: type }
+      end
+
       mapped = JsonSchema::BUILTIN_MAPPING[ruby_type]
       if mapped
         { type: mapped }

data/lib/finitio/json_schema/hash_based_type.rb

@@ -2,22 +2,27 @@ module Finitio
   module HashBasedType
 
     def to_json_schema(*args, &bl)
+      if type = metadata[:jsonSchemaType]
+        return { type: type }
+      end
+
       base = {
         type: "object"
       }
       unless heading.empty?
         base[:properties] = heading.inject({}){|ps,a|
-          ps.merge(a.name => a.type.to_json_schema(*args, &bl))
+          ps.merge(a.name => a.to_json_schema(*args, &bl))
         }
       end
       unless (reqs = heading.select{|a| a.required? }).empty?
         base[:required] = reqs.map{|a| a.name }
       end
-      base[:additionalProperties] = if heading.allow_extra?
+      additional = if heading.allow_extra?
         heading.allow_extra.to_json_schema(*args, &bl)
       else
         false
       end
+      base[:additionalProperties] = additional if additional
       base
     end
 

data/lib/finitio/json_schema/proxy_type.rb

@@ -2,6 +2,10 @@ module Finitio
   class ProxyType
 
     def to_json_schema(*args, &bl)
+      if type = metadata[:jsonSchemaType]
+        return { type: type }
+      end
+
       # ProxyType is supposed to be used only for recursive types.
       # We don't have support for references yet, so let just
       # generate an object here in the mean time.

data/lib/finitio/json_schema/rel_based_type.rb

@@ -2,6 +2,10 @@ module Finitio
   module RelBasedType
 
     def to_json_schema(*args, &bl)
+      if type = metadata[:jsonSchemaType]
+        return { type: type }
+      end
+
       {
         type: "array",
         items: tuple_type.to_json_schema(*args, &bl),

data/lib/finitio/json_schema/seq_type.rb

@@ -2,6 +2,10 @@ module Finitio
   class SeqType
 
     def to_json_schema(*args, &bl)
+      if type = metadata[:jsonSchemaType]
+        return { type: type }
+      end
+
       {
         type: "array",
         items: elm_type.to_json_schema(*args, &bl)

data/lib/finitio/json_schema/set_type.rb

@@ -2,6 +2,10 @@ module Finitio
   class SetType
 
     def to_json_schema(*args, &bl)
+      if type = metadata[:jsonSchemaType]
+        return { type: type }
+      end
+
       {
         type: "array",
         items: elm_type.to_json_schema(*args, &bl),

data/lib/finitio/json_schema/struct_type.rb

@@ -2,6 +2,10 @@ module Finitio
   class StructType
 
     def to_json_schema(*args, &bl)
+      if type = metadata[:jsonSchemaType]
+        return { type: type }
+      end
+
       {
         type: "array",
         items: component_types.map{|c| c.to_json_schema(*args, &bl) }

data/lib/finitio/json_schema/sub_type.rb

@@ -2,6 +2,10 @@ module Finitio
   class SubType
 
     def to_json_schema(*args, &bl)
+      if type = metadata[:jsonSchemaType]
+        return { type: type }
+      end
+
       # TODO: add support for constraints here...
       super_type.to_json_schema(*args, &bl)
     end

data/lib/finitio/json_schema/union_type.rb

@@ -10,6 +10,10 @@ module Finitio
     BOOLEAN_TYPE = UnionType.new([TRUE_TYPE, FALSE_TYPE])
 
     def to_json_schema(*args, &bl)
+      if type = metadata[:jsonSchemaType]
+        return { type: type }
+      end
+
       cs = candidates.reject{|c| c == NIL_TYPE }
       return { type: 'boolean'} if self == BOOLEAN_TYPE
       return cs.first.to_json_schema(*args, &bl) if cs.size == 1

data/lib/finitio/support/attribute.rb

@@ -63,5 +63,15 @@ module Finitio
       Attribute.new(name, type.unconstrained, required, metadata)
     end
 
+    def to_json_schema(*args, &bl)
+      schema = if jstype = metadata[:jsonSchemaType]
+        { type: jstype }
+      else
+        type.to_json_schema(*args, &bl)
+      end
+      schema[:description] = metadata[:description]
+      schema.compact
+    end
+
   end # class Attribute
 end # module Finitio

data/lib/finitio/support/heading.rb

@@ -114,6 +114,10 @@ module Finitio
       Heading.new(attributes.values.map{|a| a.unconstrained }, options)
     end
 
+    def project(attrs)
+      Heading.new(attributes.values.select{|a| attrs.include?(a.name) }.to_a, @options)
+    end
+
     def allbut(attrs)
       Heading.new(attributes.values.reject{|a| attrs.include?(a.name) }.to_a, @options)
     end

data/lib/finitio/type/hash_based_type.rb

@@ -61,6 +61,10 @@ module Finitio
       uped
     end
 
+    def project(attrs)
+      factor(heading.project(attrs))
+    end
+
     def allbut(attrs)
       factor(heading.allbut(attrs))
     end

data/lib/finitio/version.rb

@@ -3,7 +3,7 @@ module Finitio
 
     MAJOR = 0
     MINOR = 12
-    TINY  = 2
+    TINY  = 3
 
     def self.to_s
       [ MAJOR, MINOR, TINY ].join('.')

data/spec/json_schema/test_recursive_type.rb

@@ -28,8 +28,7 @@ module Finitio
           },
           required: [
             :children
-          ],
-          additionalProperties: false
+          ]
         })
       end
 

data/spec/json_schema/test_relation_type.rb

@@ -18,8 +18,7 @@ module Finitio
             properties: {
               a: {}
             },
-            required: [:a],
-            additionalProperties: false
+            required: [:a]
           },
           uniqueItems: true
         })

data/spec/json_schema/test_tuple_type.rb

@@ -3,7 +3,7 @@ module Finitio
     describe "TupleType" do
 
       let(:heading){
-        Heading.new([Attribute.new(:a, anyType)])
+        Heading.new([Attribute.new(:a, stringType, true, description: 'Hello')])
       }
 
       let(:tuple_type) {
@@ -14,10 +14,9 @@ module Finitio
         expect(tuple_type.to_json_schema).to eql({
           type: "object",
           properties: {
-            a: {}
+            a: {:type=>"string", :description => 'Hello'}
           },
-          required: [:a],
-          additionalProperties: false
+          required: [:a]
         })
       end
 

data/spec/syntax/nodes/test_attribute.rb

@@ -23,6 +23,19 @@ module Finitio
         end
       end
 
+      context 'with metadata' do
+        let(:input){ "/- Hello a -/\na: .Integer" }
+
+        it 'compiles to an mandatory Attribute' do
+          expect(compiled).to be_a(Attribute)
+          expect(compiled.name).to eq(:a)
+          expect(compiled.type).to be_a(BuiltinType)
+          expect(compiled.type.ruby_type).to be(Integer)
+          expect(compiled.metadata).to eql(description: 'Hello a')
+          expect(compiled).to be_required
+        end
+      end
+
       context 'a :? .Integer' do
         let(:input){ 'a :? .Integer' }
 

data/spec/syntax/nodes/test_tuple_type.rb

@@ -29,6 +29,16 @@ module Finitio
         end
       end
 
+      context '{a: .Integer}' do
+        let(:input){ '{/- Hello a -/ a: .Integer}' }
+
+        it 'compiles to a TupleType' do
+          expect(compiled).to be_a(TupleType)
+          expect(compiled.heading.size).to eq(1)
+          expect(compiled.heading[:a].metadata).to eql(description: 'Hello a')
+        end
+      end
+
       context '{a: .Integer, b: .Float}' do
         let(:input){ '{a: .Integer, b: .Float}' }
 

data/spec/type/tuple_type/test_project.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+module Finitio
+  describe TupleType, "project" do
+
+    let(:h1){ Heading.new([Attribute.new(:r, intType), Attribute.new(:b, intType)]) }
+    let(:h2){ Heading.new([Attribute.new(:b, intType)]) }
+
+    let(:t1)  { TupleType.new(h1) }
+    let(:t2)  { TupleType.new(h2) }
+
+    it 'removes unwanted atributes' do
+      expect(t1.project([:b])).to eql(t2)
+    end
+
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finitio
 version: !ruby/object:Gem::Version
-  version: 0.12.2
+  version: 0.12.3
 platform: ruby
 authors:
 - Bernard Lambeau
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-22 00:00:00.000000000 Z
+date: 2025-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: citrus
@@ -453,6 +453,7 @@ files:
 - spec/type/tuple_type/test_include.rb
 - spec/type/tuple_type/test_initialize.rb
 - spec/type/tuple_type/test_name.rb
+- spec/type/tuple_type/test_project.rb
 - spec/type/tuple_type/test_suppremum.rb
 - spec/type/union_type/test_default_name.rb
 - spec/type/union_type/test_dress.rb
@@ -669,6 +670,7 @@ test_files:
 - spec/type/tuple_type/test_include.rb
 - spec/type/tuple_type/test_initialize.rb
 - spec/type/tuple_type/test_name.rb
+- spec/type/tuple_type/test_project.rb
 - spec/type/tuple_type/test_suppremum.rb
 - spec/type/union_type/test_default_name.rb
 - spec/type/union_type/test_dress.rb