finitio 0.11.3 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: acf74d5293b979c7c03d55dc9cbea273b9f85d6c
-  data.tar.gz: 14e18b10f4668fc996354ec2ceb6627eb56dffbc
+SHA256:
+  metadata.gz: 92c67dd32e89dd6c4597b4a8456572bb1a5b3de07bdf58e88bcb9dc3f0874462
+  data.tar.gz: 4ecd7898e477113040613415f9bc2cc8f23bc3605d0f71a3ccaefbbe1eaf31ff
 SHA512:
-  metadata.gz: ba3a092904c8ac102361ef17b2fc0f49d8f6ed209d2a3ffe0ec852f3c3b52772716762bf65d3604831a631f2ecc8782cdaa120b7768608849ec72bdbc164f8d2
-  data.tar.gz: a33d566ed9e25caed8b90d7228583056152ee1fb0c50533fad4008ab72d318fd3d51430f1f50146f42c77104f6fad40c86591200e168cce14de05d46995e228d
+  metadata.gz: eb3042b639a82d469bb760807e6c94e1f70c39a3249420d30e339d5f004048e8abe6026de3b3b834e3703f88b3dd10a6d2937abdba5a183444af13609cc150b5
+  data.tar.gz: f44c30f37848ad1e0b8344487cc0f0353ad694ce31c535ff6dd4ae02e903bebc92d11b29ac78ae0aa7d21f7bce6ba3fbd7ecdceb2cb6d14aa4bd3f9d6fb5164a

data/CHANGELOG.md

@@ -1,24 +1,47 @@
-# 0.11.3 - 2023/01/06
+## 0.12.0 - 2023/05/23
+
+* Remove support for ruby < 2.6
+
+* Remove support for .Fixnum and .Bignum, .Integer is now used
+  everywhere. To ease the transition, Fixum and Bignum still exist
+  in the finitio/data stdlib schema, but will be removed in 0.13.x
+
+## 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
+## 0.11.2 - 2023/01/06
 
 * Fix json_schema generation on builtin_type NilClass. "null"
   is not a valid value, we now use "string" instead.
 
-# 0.11.1 - 2021/12/09
+## 0.11.1 - 2021/12/09
 
 * Fix github actions and extend test grid.
 
-# 0.11.0 - 2021/12/09
+## 0.11.0 - 2021/12/09
 
 * Fix json schema generation of Boolean and union types with a |Nil
 * Add support for dashses in attribute names (tuple & relation types).
 
-# 0.10.0 - 2021/01/11
+## 0.10.0 - 2021/01/11
 
 * Upgrade all dependencies.
 
@@ -26,18 +49,18 @@
 
 * Fix code and build under Ruby 3.0.
 
-# 0.9.1 - 2020/12/24
+## 0.9.1 - 2020/12/24
 
 * Fixes a bug where proxy types are not properly resolved when used
   in a heading extra, e.g. `{ ...: Proxy }`
 
-# 0.9.0 - 2020/12/16
+## 0.9.0 - 2020/12/16
 
 * Add Type#to_json_schema that converts Finitio types to JSON schema
   representations. This first implementation skips all constraints on sub types,
   though. You need to explicitly require 'finitio/json_schema' to use it.
 
-# 0.8.0 - 2019/10/21
+## 0.8.0 - 2019/10/21
 
 * Add `Type#unconstrained` that returns a super type with all user specific
   constraints removed on sub types, recursively on all non scalar types.
@@ -47,7 +70,7 @@
 * Add support for random data generation through `Finitio::Generation`.
   Please `require 'finitio/generation'` to use it.
 
-# 0.7.0 / 2019-02-28
+## 0.7.0 / 2019-02-28
 
 * Implement (basic) @import feature, working with relative paths
   and a standard library. The standard library systems are memoized
@@ -60,28 +83,28 @@
 * WARN: Finitio::DEFAULT_SYSTEM is deprecated. Use @import
   finitio/data instead.
 
-# 0.6.1 / 2018-03-23
+## 0.6.1 / 2018-03-23
 
 * Fix support for typed extra attributes, a KeyError was raised when
   keys were Symbols and not Strings.
 
-# 0.6.0 / 2018-02-17
+## 0.6.0 / 2018-02-17
 
 * Add support for typed extra attributes, e.g. { ...: Integer }
 
-# 0.5.2 / 2017-01-08
+## 0.5.2 / 2017-01-08
 
 * Disable memoization in parser because it leads to terrible performance
   issues on some schemas.
 * Avoid alternatives on high-level rules (Union, SubType) to prevent many
   fallbacks that kill performance without memoization enabled.
 
-# 0.5.1 / 2015-09-22
+## 0.5.1 / 2015-09-22
 
 * Enabled memoization in parser to avoid very long parsing time on complex
   schemas.
 
-# 0.5.0 / 2015-09-18
+## 0.5.0 / 2015-09-18
 
 * Breaking changes on public API
 
@@ -147,29 +170,29 @@
   * Make Finitio compatible with both Citrus 2.4.x and Citrus 3.x
   * Fixed parsing of constraint expressions having inner parentheses
 
-# 0.4.1 / 2014-03-20
+## 0.4.1 / 2014-03-20
 
 * Fixed access to the default system that lead to 'Unknown system
   Finitio/default (Finitio::Error)'
 
-# 0.4.0 / 2014-03-20
+## 0.4.0 / 2014-03-20
 
 * Finitio(-rb) is born from the sources of Q(rb) 0.3.0
 * Finitio.parse now recognizes Path-like objects (responding to :to_path),
   allowing to parse files directly (through Pathname, Path, etc.).
 
-# 0.3.0 / 2014-03-09
+## 0.3.0 / 2014-03-09
 
 * Added AnyType abstraction, aka '.'
 * Added support for external contracts in ADTs
 * Added support for extracting an Abstract Syntax Tree from parsing result
 * Allows camelCasing in constraint names
 
-# 0.2.0 / 2014-03-04
+## 0.2.0 / 2014-03-04
 
 * Fix dependencies in gemspec (judofyr)
 
-# 0.1.0 / 2014-03-03
+## 0.1.0 / 2014-03-03
 
 * Enhancements
 

data/Gemfile.lock

@@ -1,21 +1,21 @@
 PATH
   remote: .
   specs:
-    finitio (0.11.3)
+    finitio (0.12.0)
       citrus (>= 3.0, < 4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.8.1)
+    activesupport (7.0.4.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
     awesome_print (1.9.2)
     builder (3.2.4)
     citrus (3.0.2)
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.2.2)
     coveralls (0.8.23)
       json (>= 1.8, < 3)
       simplecov (~> 0.16.1)
@@ -54,16 +54,16 @@ GEM
       cucumber-cucumber-expressions (~> 10.1, >= 10.1.0)
       cucumber-messages (~> 12.2, >= 12.2.0)
     diff-lcs (1.3)
-    docile (1.3.5)
+    docile (1.4.0)
     ffi (1.15.5)
-    i18n (1.12.0)
+    i18n (1.13.0)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
     middleware (0.1.0)
-    minitest (5.15.0)
+    minitest (5.18.0)
     multi_json (1.15.0)
     multi_test (0.1.2)
-    path (2.0.1)
+    path (2.1.0)
     protobuf-cucumber (3.10.8)
       activesupport (>= 3.2)
       middleware
@@ -74,12 +74,12 @@ GEM
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
       rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.0)
+    rspec-core (3.12.2)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.1)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.1)
+    rspec-mocks (3.12.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
@@ -89,16 +89,16 @@ GEM
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
     sync (0.5.0)
-    sys-uname (1.2.2)
+    sys-uname (1.2.3)
       ffi (~> 1.1)
     term-ansicolor (1.7.1)
       tins (~> 1.0)
-    thor (1.2.1)
+    thor (1.2.2)
     thread_safe (0.3.6)
     tins (1.32.1)
       sync
-    tzinfo (1.2.10)
-      thread_safe (~> 0.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
 
 PLATFORMS
   x86_64-linux
@@ -109,7 +109,7 @@ DEPENDENCIES
   cucumber (~> 4.1)
   finitio!
   multi_json (~> 1.15)
-  path (>= 2.0, < 3.0)
+  path (>= 2.1, < 3.0)
   rake (~> 13.0)
   rspec (~> 3.0)
 

data/finitio.gemspec

@@ -19,13 +19,13 @@ Gem::Specification.new do |s|
   s.test_files = Dir["test/**/*"] + Dir["spec/**/*"]
   s.bindir = "bin"
   s.executables = (Dir["bin/*"]).collect{|f| File.basename(f)}
-  
+
   s.add_dependency("citrus", ">= 3.0", "< 4.0")
-  
+
   s.add_development_dependency("rake", "~> 13.0")
   s.add_development_dependency("rspec", "~> 3.0")
   s.add_development_dependency("cucumber", "~> 4.1")
-  s.add_development_dependency("path", ">= 2.0", "< 3.0")
+  s.add_development_dependency("path", ">= 2.1", "< 3.0")
   s.add_development_dependency("awesome_print", "~> 1.8")
   s.add_development_dependency("coveralls", "~> 0.8")
   s.add_development_dependency("multi_json", "~> 1.15")

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/builtin_type.rb

@@ -5,8 +5,6 @@ module Finitio
       NilClass => "string", # jsonapi does not support null
       String => "string",
       Integer => "integer",
-      Fixnum => "integer",
-      Bignum => "integer",
       Float => "number",
       Numeric => "number",
       TrueClass => "boolean",

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

data/lib/finitio/stdlib/finitio/data.fio

@@ -11,8 +11,8 @@ Boolean    = .TrueClass|.FalseClass
 
 # Numbers
 Numeric = .Numeric
-Fixnum  = .Fixnum
-Bignum  = .Bignum
+Fixnum = .Integer
+Bignum = .Integer
 Integer = .Integer
 Float   = .Float
 Real    = .Float

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/ad_type.rb

@@ -30,7 +30,7 @@ module Finitio
   #     rgb_infotype  = TupleType.new(...)
   #
   #     # The RGB contract converter, an object that responds to `call` to
-  #     # convert from a valid Hash[r: Fixnum, ...] to a ColorImpl instance.
+  #     # convert from a valid Hash[r: Integer, ...] to a ColorImpl instance.
   #     rgb_contract = ...
   #
   #     AdType.new(ColorImpl, rgb: [rgb_infotype, rgb_contract], hex: ...)

data/lib/finitio/type/builtin_type.rb

@@ -3,21 +3,21 @@ module Finitio
   # A BuiltinType generator allows capuring an information type to a type of
   # the host language, here a Ruby class. For instance,
   #
-  #     Int := BuiltinType(ruby.Fixnum)
+  #     Int := BuiltinType(ruby.Integer)
   #
   # The set of values captured by the information type is the same set of
   # values that can be represented by the host type. In the example, `Int`
-  # captures the same set of numbers as ruby's Fixnum.
+  # captures the same set of numbers as ruby's Integer.
   #
   # The ruby class is used as concrete representation of the information type.
   # In the example:
   #
-  #     R(Int) = Fixnum
+  #     R(Int) = Integer
   #
   # Accordingly, the `dress` transformation function has the following signature:
   #
   #     dress :: Alpha  -> Int    throws TypeError
-  #     dress :: Object -> Fixnum throws TypeError
+  #     dress :: Object -> Integer throws TypeError
   #
   class BuiltinType < Type
 

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/struct_type.rb

@@ -8,7 +8,7 @@ module Finitio
   #
   # This class allows capturing those information types, as in:
   #
-  #     Length = BuiltinType.new(Fixnum)
+  #     Length = BuiltinType.new(Integer)
   #     Angle  = BuiltinType.new(Float)
   #     Point  = StructType.new([Length, Angle])
   #
@@ -16,7 +16,7 @@ module Finitio
   # values map to the concrete representations of each component type:
   #
   #     R(Point) = Array[R(Length) ^ R(Angle)]
-  #              = Array[Fixnum ^ Float]
+  #              = Array[Integer ^ Float]
   #              = Array[Numeric]
   #
   # where `^` denotes the `least common super type` operator on ruby classes.

data/lib/finitio/type/sub_type.rb

@@ -18,12 +18,12 @@ module Finitio
   # The concrete representation of the super type is kept as representation
   # of the sub type. In other words:
   #
-  #     R(Byte) = R(Int) = Fixnum
+  #     R(Byte) = R(Int) = Integer
   #
   # Accordingly, the `dress` transformation function has the following signature:
   #
   #     dress :: Alpha  -> Byte   throws TypeError
-  #     dress :: Object -> Fixnum throws TypeError
+  #     dress :: Object -> Integer throws TypeError
   #
   class SubType < Type
 

data/lib/finitio/type/tuple_type.rb

@@ -7,7 +7,7 @@ module Finitio
   #
   # This class allows capturing those information types, as in:
   #
-  #     Length = BuiltinType.new(Fixnum)
+  #     Length = BuiltinType.new(Integer)
   #     Angle  = BuiltinType.new(Float)
   #     Point  = TupleType.new(Heading.new([
   #                Attribute.new(:r, Length),
@@ -19,7 +19,7 @@ module Finitio
   # type:
   #
   #     R(Point) = Hash[r: R(Length), theta: R(Angle)]
-  #              = Hash[r: Fixnum, theta: Float]
+  #              = Hash[r: Integer, theta: Float]
   #
   # Accordingly, the `dress` transformation function has the signature below.
   # It expects it's Alpha/Object argument to be a Hash with all and only the
@@ -27,7 +27,7 @@ module Finitio
   # applies on every attribute value according to their respective type.
   #
   #     dress :: Alpha  -> Point                         throws TypeError
-  #     dress :: Object -> Hash[r: Fixnum, theta: Float] throws TypeError
+  #     dress :: Object -> Hash[r: Integer, theta: Float] throws TypeError
   #
   class TupleType < Type
     include HeadingBasedType

data/lib/finitio/type/union_type.rb

@@ -8,7 +8,7 @@ module Finitio
   #
   # This class allows capturing such union types, as follows:
   #
-  #     Int     = BuiltinType.new(Fixnum)
+  #     Int     = BuiltinType.new(Integer)
   #     Real    = BuiltinType.new(Float)
   #     Numeric = UnionType.new([ Int, Real ])
   #
@@ -17,7 +17,7 @@ module Finitio
   # value ends the process and the value is simply returned. Accordingly,
   # the concrete representation will be
   #
-  #     R(Numeric) = R(Int) ^ R(Real) = Fixnum ^ Float = Numeric
+  #     R(Numeric) = R(Int) ^ R(Real) = Integer ^ Float = Numeric
   #
   # where `^` denotes the `least common super type` operator on ruby classes.
   #

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