finitio 0.11.2 → 0.11.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b4bcc2dab9afa958c597af1418553f339b726fb
-  data.tar.gz: 3140214a73d11d6733e770d9ca2950dae0c34650
+  metadata.gz: 29fd883abee1e98b436a1c8aa80ee32ffc9740dc
+  data.tar.gz: 9aa135c687855dbdfb6a52e245d21c3488ef0128
 SHA512:
-  metadata.gz: 18ce81cd1bd6014172453ac187e0f2e78d3f6f8729f02e1e7875fdb06c324e926a660b3af25b8cea7e224dfbc3a2b45146106533ccb49f09627822ca595e4313
-  data.tar.gz: 76ef53792f483628ce1e9c786d99d324235a244da6696d05105666d2578859368de020104f7da4a1ee096b5d2d4b7c98ae87408bbac6042f7e74e891809ea650
+  metadata.gz: 0af6653c37bc1fdb2e5aeef7f0d43e70f92d967658219b638c58a8039b975460f64ab80339d7d727aed716175cc722614973e387c5720315868bd6b8a6d1fc7c
+  data.tar.gz: ef96c4bd3a7f4910b83acab224940afe7a1885be98eeddf5ce8542c0037d0c702da98e372f55a42638cb7cef3cfbf9394dd8c0d162daace35c6731e86083c061

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+# 0.11.4 - 2023/01/06
+
+* The proxy resolution is fixed and clarified. When compiling
+  a system, all proxies are actually replaced by their actual
+  Type instance. Only recursive types still keep ProxyType
+  instances (as sentinels) ; they are bound to their target
+  type and delete dress and include? to them.
+
+  Given that ProxyType is a sentinel on recursive types, calls
+  to generate_data and to_json_schema are not delegated to the
+  target type, to avoid infinite recursions.
+
+* Generated names of instantiated high order types are better
+  (e.g. Collection<String>).
+
+# 0.11.3 - 2023/01/06
+
+* Fix json_schema generation on unresolved ProxyTypes. We use
+  "object" by default, waiting for a better support for recursive
+  types.
+
 # 0.11.2 - 2023/01/06
 
 * Fix json_schema generation on builtin_type NilClass. "null"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    finitio (0.11.2)
+    finitio (0.11.4)
       citrus (>= 3.0, < 4.0)
 
 GEM

data/lib/finitio/generation/proxy_type.rb

@@ -0,0 +1,11 @@
+module Finitio
+  class ProxyType
+
+    def generate_data(*args, &bl)
+      # Proxy type is supposed to be used only on recursive types
+      # so we can't go further to avoid a infinite recursion
+      {}
+    end
+
+  end # class ProxyType
+end # module Finitio

data/lib/finitio/generation.rb

@@ -104,3 +104,4 @@ require_relative 'generation/union_type'
 require_relative 'generation/alias_type'
 require_relative 'generation/sub_type'
 require_relative 'generation/ad_type'
+require_relative 'generation/proxy_type'

data/lib/finitio/json_schema/hash_based_type.rb

@@ -7,7 +7,7 @@ module Finitio
       }
       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.type.to_json_schema(*args, &bl))
         }
       end
       unless (reqs = heading.select{|a| a.required? }).empty?

data/lib/finitio/json_schema/proxy_type.rb

@@ -2,7 +2,10 @@ module Finitio
   class ProxyType
 
     def to_json_schema(*args, &bl)
-      @target.to_json_schema(*args, &bl) if @target
+      # 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.
+      { type: "object" }
     end
 
   end # module ProxyType

data/lib/finitio/support/compilation.rb

@@ -48,10 +48,6 @@ module Finitio
       Pathname.new(file)
     end
 
-    def resolve_proxies
-      system.resolve_proxies
-    end
-
     # Delegation to Factory
 
     TypeFactory::DSL_METHODS.each do |dsl_method|

data/lib/finitio/support/proxy_resolver.rb

@@ -0,0 +1,52 @@
+module Finitio
+  # Part of the compilation schema, this proxy resolver replaces
+  # proxies by their real Type instance.
+  #
+  # Given that Finitio can support recursive types, we do this in
+  # two passes:
+  #   1. Replace proxy types by rewrite (see Type#resolve_proxies)
+  #      in a depth first search.
+  #   2. If a loop is found, recreate a late ProxyType, that is then
+  #      bound later by mutation.
+  #
+  # So ProxyType may still be present in the type chain, but will
+  # only correspond to recursive types.
+  class ProxyResolver
+    def resolve!(system)
+      @system = system
+      @built = {}
+      @building = {}
+      @late_proxies = []
+      system.types.each_key do |name|
+        fetch(name)
+      end
+      @late_proxies.each do |proxy|
+        proxy.bind!(self)
+      end
+      system.dup(@built)
+    end
+
+    def fetch(name, &bl)
+      @built[name] || build_it(name) || import_it(name, &bl)
+    end
+
+    def build_it(name)
+      if under_build = @building[name]
+        proxy = ProxyType.new(name)
+        @late_proxies << proxy
+        proxy
+      else
+        return nil unless type = @system.fetch(name, false){ nil }
+
+        @building[name] = type
+        @built[name] = type.resolve_proxies(self)
+        @building[name] = nil
+        @built[name]
+      end
+    end
+
+    def import_it(name, &bl)
+      @system.fetch_on_imports(name, &bl)
+    end
+  end # class ProxyResolver
+end # module Finitio

data/lib/finitio/support.rb

@@ -24,4 +24,5 @@ require_relative 'support/heading'
 require_relative 'support/dress_helper'
 require_relative 'support/type_factory'
 require_relative 'support/fetch_scope'
+require_relative 'support/proxy_resolver'
 require_relative 'support/compilation'

data/lib/finitio/syntax.rb

@@ -21,18 +21,18 @@ module Finitio
     end
 
     def self.ast(source)
-      parse(source, root: "system").to_ast
+      parse(source, root: 'system').to_ast
     end
 
     def self.compile(source, cpl = nil)
       cpl = Compilation.coerce(cpl, source)
-      parse(source, root: "system").compile(cpl)
-      cpl.resolve_proxies
+      parse(source, root: 'system').compile(cpl)
+      ProxyResolver.new.resolve!(cpl.system)
     end
 
     def self.compile_type(source, cpl = nil)
       cpl = Compilation.coerce(cpl, source)
-      parse(source, root: "type").compile(cpl)
+      parse(source, root: 'type').compile(cpl)
     end
 
   end # module Syntax

data/lib/finitio/system.rb

@@ -50,24 +50,23 @@ module Finitio
     def fetch(name, with_imports = true, &bl)
       if with_imports
         @types.fetch(name) do
-          _fetch(name, @imports, &bl)
+          fetch_on_imports(name, &bl)
         end
       else
         @types.fetch(name, &bl)
       end
     end
 
-    def _fetch(name, imports, &bl)
+    def fetch_on_imports(name, imports = @imports, &bl)
       if imports.empty?
         raise KeyError, %Q{key not found: "#{name}"} unless bl
         bl.call(name)
       else
         imports.first.fetch(name, false) do
-          _fetch(name, imports[1..-1], &bl)
+          fetch_on_imports(name, imports[1..-1], &bl)
         end
       end
     end
-    private :_fetch
 
     def factory
       @factory ||= TypeFactory.new
@@ -89,22 +88,12 @@ module Finitio
       Syntax.compile(source, self.dup)
     end
 
-    def resolve_proxies(recurse = true)
-      rebuilt = {}
-      scope = FetchScope.new(self, rebuilt)
-      types.each_with_object(rebuilt) do |(name,type),memo|
-        rebuilt[name] = type.resolve_proxies(scope)
-      end
-      resolved = System.new(rebuilt, imports)
-      recurse ? resolved.resolve_proxies(false) : resolved
-    end
-
     def inspect
       @types.each_pair.map{|k,v| "#{k} = #{v}" }.join("\n")
     end
 
-    def dup
-      System.new(@types.dup, @imports.dup)
+    def dup(types = @types.dup, imports = @imports.dup)
+      System.new(types, imports)
     end
 
     def check_and_warn(logger = nil)

data/lib/finitio/type/high_order_type.rb

@@ -28,7 +28,9 @@ module Finitio
 
     def instantiate(compilation, sub_types)
       overrides = Hash[vars.zip(sub_types)]
-      defn.resolve_proxies(compilation.with_scope(overrides))
+      defn.resolve_proxies(compilation.with_scope(overrides)).dup.tap{|x|
+        x.send(:name=, "#{name}<#{overrides.values.join(',')}>", true)
+      }
     end
 
     def unconstrained

data/lib/finitio/type/proxy_type.rb

@@ -15,8 +15,26 @@ module Finitio
       "_#{target_name}_"
     end
 
+    def include?(*args, &bl)
+      raise Error, "Proxy not resolved: #{target_name}" unless @target
+
+      @target.include?(*args, &bl)
+    end
+
+    def dress(*args, &bl)
+      raise Error, "Proxy not resolved: #{target_name}" unless @target
+
+      @target.dress(*args, &bl)
+    end
+
+    def bind!(system)
+      @target = system.fetch(target_name) {
+        raise Error, "No such type `#{target_name}` in #{system}"
+      }
+    end
+
     def resolve_proxies(system)
-      system.fetch(target_name){
+      system.fetch(target_name) {
         raise Error, "No such type `#{target_name}` in #{system}"
       }
     end

data/lib/finitio/type.rb

@@ -32,8 +32,10 @@ module Finitio
       @name || default_name
     end
 
-    def name=(n)
-      raise Error, "Name already set to `#{@name}`" unless @name.nil?
+    def name=(n, force = false)
+      if !@name.nil? && !force
+        raise Error, "Name already set to `#{@name}` on #{self.class}"
+      end
       @name = n
     end
 

data/lib/finitio/version.rb

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

data/spec/inference/test_inference.rb

@@ -35,7 +35,7 @@ module Finitio
       expect(result.elm_type[:size].type.name).to eql("String")
       expect(result.elm_type[:priority].type.name).to eql("String")
 
-      puts result
+      #puts result
     end
 
   end

data/spec/json_schema/test_recursive_type.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+module Finitio
+  module JsonSchema
+    describe "A recursive type" do
+
+      let(:system){
+        ::Finitio.system <<-FIO
+          Tree = {
+            children : [Tree]
+          }
+        FIO
+      }
+
+      let(:type) {
+        system['Tree']
+      }
+
+      it 'works as expected' do
+        expect(type.to_json_schema).to eql({
+          type: "object",
+          properties: {
+            children: {
+              type: "array",
+              items: {
+                type: "object"
+              }
+            }
+          },
+          required: [
+            :children
+          ],
+          additionalProperties: false
+        })
+      end
+
+    end
+  end
+end

data/spec/regression/test_dress_on_recursive_type.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe "Dress on a recursive type" do
+  let(:schema){
+    Finitio.system <<~F
+      Tree = {
+        children: [Tree]
+      }
+      Tree
+    F
+  }
+
+  it 'works on an empty tree' do
+    expect(->(){
+      schema.dress({children: []})
+    }).not_to raise_error
+  end
+
+  it 'works on a non empty tree' do
+    expect(->(){
+      schema.dress({
+        children: [{
+          children: [{
+            children: [{
+              children: []
+            }]
+          }]
+        }]
+      })
+    }).not_to raise_error
+  end
+
+  it 'detects deep error' do
+    expect(->(){
+      schema.dress({
+        children: [{
+          children: [{
+            children: [{
+              children: [{
+                children: [{
+                  children: [{
+                    unrecognized: true,
+                    children: []
+                  }]
+                }]
+              }]
+            }]
+          }]
+        }]
+      })
+    }).to raise_error(Finitio::Error)
+  end
+end

data/spec/regression/test_name_of_generic_types.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe "The types of generics definitions" do
+  describe "When the extra map to a type" do
+    let(:schema){
+      Finitio.system <<~F
+        Collection<T> = [T]
+
+        String = .String
+        Collection<String>
+      F
+    }
+
+    it 'works' do
+      expect(schema['Main'].target.name).to eql("Collection<String>")
+    end
+  end
+end

data/spec/syntax/test_compile.rb

@@ -77,6 +77,24 @@ module Finitio
     end
 
     context 'with AD types' do
+      let(:source){
+        <<-EOF.strip
+        Int = .Integer
+        Byte = Int(i | i>0)
+        Color = .Color <rgb> { r: Byte, g: Byte, b: Byte }
+        Colors = [Color]
+        EOF
+      }
+
+      it{ should be_a(System) }
+
+      it 'should work fine' do
+        got = subject['Colors'].dress([{ r: 10, g: 15, b: 20 }])
+        expect(got.first).to be_a(Color)
+      end
+    end
+
+    context 'with AD types that make forward references' do
       let(:source){
         <<-EOF.strip
         Colors = [Color]
@@ -88,7 +106,7 @@ module Finitio
 
       it{ should be_a(System) }
 
-      it 'should work ine' do
+      it 'should work fine' do
         got = subject['Colors'].dress([{ r: 10, g: 15, b: 20 }])
         expect(got.first).to be_a(Color)
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finitio
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.11.4
 platform: ruby
 authors:
 - Bernard Lambeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-06 00:00:00.000000000 Z
+date: 2023-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: citrus
@@ -163,6 +163,7 @@ files:
 - lib/finitio/generation/heuristic.rb
 - lib/finitio/generation/heuristic/constant.rb
 - lib/finitio/generation/heuristic/random.rb
+- lib/finitio/generation/proxy_type.rb
 - lib/finitio/generation/rel_based_type.rb
 - lib/finitio/generation/seq_type.rb
 - lib/finitio/generation/set_type.rb
@@ -193,6 +194,7 @@ files:
 - lib/finitio/support/heading.rb
 - lib/finitio/support/metadata.rb
 - lib/finitio/support/proc_with_code.rb
+- lib/finitio/support/proxy_resolver.rb
 - lib/finitio/support/type_factory.rb
 - lib/finitio/syntax.rb
 - lib/finitio/syntax/definitions.rb
@@ -309,6 +311,7 @@ files:
 - spec/json_schema/test_builtin_type.rb
 - spec/json_schema/test_multi_relation_type.rb
 - spec/json_schema/test_multi_tuple_type.rb
+- spec/json_schema/test_recursive_type.rb
 - spec/json_schema/test_relation_type.rb
 - spec/json_schema/test_seq_type.rb
 - spec/json_schema/test_set_type.rb
@@ -316,7 +319,9 @@ files:
 - spec/json_schema/test_sub_type.rb
 - spec/json_schema/test_tuple_type.rb
 - spec/json_schema/test_union_type.rb
+- spec/regression/test_dress_on_recursive_type.rb
 - spec/regression/test_heading_extra_are_proxy_resolved.rb
+- spec/regression/test_name_of_generic_types.rb
 - spec/spec_helper.rb
 - spec/support/test_compare_attrs.rb
 - spec/support/test_proc_with_code.rb
@@ -487,6 +492,8 @@ signing_key:
 specification_version: 4
 summary: Finitio - in Ruby
 test_files:
+- spec/regression/test_dress_on_recursive_type.rb
+- spec/regression/test_name_of_generic_types.rb
 - spec/regression/test_heading_extra_are_proxy_resolved.rb
 - spec/test_finitio.rb
 - spec/constraint/test_named.rb
@@ -616,6 +623,7 @@ test_files:
 - spec/json_schema/test_ad_type.rb
 - spec/json_schema/test_builtin_type.rb
 - spec/json_schema/test_multi_relation_type.rb
+- spec/json_schema/test_recursive_type.rb
 - spec/json_schema/test_sub_type.rb
 - spec/json_schema/test_any_type.rb
 - spec/json_schema/test_seq_type.rb