finitio 0.7.0.pre.rc2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4b4c180986cc7160e2b3f76c23e37d23237cbaaf
-  data.tar.gz: b26dd47b86792ad28524e5e8f8df0ab5d56d0071
+SHA256:
+  metadata.gz: fb6a6dde74e450b0569a6f568d2f6e847a6f646b23cd815a3442e1a85dbdaedf
+  data.tar.gz: 26fd2339057cc212d2594d2d52ab66b5ae1ad6dc7db0294faa941f148406ac4a
 SHA512:
-  metadata.gz: b19ef54ca53c5e463aa6b4557d0ecd6ea537e6cdaa9349f960356b1b31525908be7d1a196cc2be9ab4985f70eea4133d2c54c03d3ee57b14cf48175efe7aaf02
-  data.tar.gz: 14d1db5a7285d522ce1ab093a5dc712f52b0c846b84e582e86fedbdfbd1320e6eafa7741b907f553aabdb29094bc7ebecf0b1a54a6358cc2ac9b761ae2289238
+  metadata.gz: f2e4bc1270b3169f3a9692473525693c90e5771c42fc01e3fdce89da676b1e6867d977fb9f29cc2603adcbdc15920dec9dde6133ccd96f50638e12614cf22eed
+  data.tar.gz: acd957a3ea361e715a17d27bb25baef4687f2ed6252a1289a8e4c660e8151c4ad2813488d9a8fbccda189903b95be5da99983b0f0a922e3590f316dd656c7371

data/CHANGELOG.md

@@ -1,3 +1,32 @@
+# 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
+
+* Add `Type#unconstrained` that returns a super type with all user specific
+  constraints removed on sub types, recursively on all non scalar types.
+
+* Add high-order types, such as `Collection<T> = [T]`
+
+* Add support for random data generation through `Finitio::Generation`.
+  Please `require 'finitio/generation'` to use it.
+
+# 0.7.0 / 2019-02-28
+
+* Implement (basic) @import feature, working with relative paths
+  and a standard library. The standard library systems are memoized
+  to avoid unnecessary parsing and compilation.
+
+* `System#check_and_warn` allows discovering warnings, infos and
+  errors in system definitions, such as duplicate type definitions
+  and import overrides.
+
+* WARN: Finitio::DEFAULT_SYSTEM is deprecated. Use @import
+  finitio/data instead.
+
 # 0.6.1 / 2018-03-23
 
 * Fix support for typed extra attributes, a KeyError was raised when

data/Gemfile

@@ -1,4 +1,4 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
 gemspec
 

data/Gemfile.lock

@@ -1,59 +1,58 @@
 PATH
   remote: .
   specs:
-    finitio (0.7.0.pre.rc2)
+    finitio (0.9.0)
       citrus (>= 2.4, < 4.0)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    awesome_print (1.6.1)
-    builder (3.2.2)
+    awesome_print (1.8.0)
+    builder (3.2.3)
     citrus (3.0.2)
-    coveralls (0.7.2)
-      multi_json (~> 1.3)
-      rest-client (= 1.6.7)
-      simplecov (>= 0.7)
-      term-ansicolor (= 1.2.2)
-      thor (= 0.18.1)
-    cucumber (1.3.18)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
+    cucumber (1.3.20)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.3)
       gherkin (~> 2.12)
       multi_json (>= 1.7.5, < 2.0)
-      multi_test (>= 0.1.1)
-    diff-lcs (1.2.5)
-    docile (1.1.5)
+      multi_test (>= 0.1.2)
+    diff-lcs (1.3)
+    docile (1.3.1)
     gherkin (2.12.2)
       multi_json (~> 1.3)
-    mime-types (2.4.3)
-    multi_json (1.10.1)
-    multi_test (0.1.1)
+    json (2.2.0)
+    multi_json (1.13.1)
+    multi_test (0.1.2)
     path (1.3.3)
-    rake (10.4.2)
-    rest-client (1.6.7)
-      mime-types (>= 1.16)
-    rspec (3.1.0)
-      rspec-core (~> 3.1.0)
-      rspec-expectations (~> 3.1.0)
-      rspec-mocks (~> 3.1.0)
-    rspec-core (3.1.7)
-      rspec-support (~> 3.1.0)
-    rspec-expectations (3.1.2)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.1.0)
-    rspec-mocks (3.1.3)
-      rspec-support (~> 3.1.0)
-    rspec-support (3.1.2)
-    simplecov (0.9.1)
-      docile (~> 1.1.0)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.8.0)
-    simplecov-html (0.8.0)
-    term-ansicolor (1.2.2)
-      tins (~> 0.8)
-    thor (0.18.1)
-    tins (0.13.2)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (0.20.3)
+    tins (1.20.2)
 
 PLATFORMS
   ruby
@@ -68,4 +67,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.16.0
+   2.0.2

data/README.md

@@ -19,7 +19,9 @@ require 'finitio'
 require 'json'
 
 # Let load a schema
-schema = Finitio::DEFAULT_SYSTEM.parse <<-FIO
+schema = Finitio.system <<-FIO
+  @import finitio/data
+
   {
     name: String( s | s.strip.size > 0 ),
     at: DateTime
@@ -98,6 +100,91 @@ module RgbContract
 end
 ```
 
+## Decompose complex system with imports
+
+It is useful to decompose complex systems in many files using the import
+feature. The latter works with relative file paths like this:
+
+```
+# child.fio
+
+Posint = .Integer(i | i >= 0)
+```
+
+```
+# parent.fio
+@import ./child.fio
+
+# Child's types are available inside the system, but not outside it, that
+# is, imported types are not themselves exported
+Byte = Posint(i | i <= 255 )
+```
+
+```
+@import ./parent.fio
+
+# This will work
+HalfByte = Byte(i | i <= 128)
+
+# But this will not: Posint is not defined
+Posint(i | i <= 128)
+```
+
+See the next section about the standard library if you need to share types
+without relying on relative paths.
+
+## Standard library
+
+Usual type definitions are already defined for simple data types, forming
+Finitio's default system:
+
+* Most ruby native (data) classes are already aliased to avoid explicit use of
+  builtins. In particular, `Integer`, `String`, etc.
+
+* A `Boolean` union type also hides the TrueClass and FalseClass distinction.
+
+* Date, Time and DateTime ADTs are also provided that perform common
+  conversions from JSON strings, through iso8601.
+
+This system is best used through Finitio's so-called "standard library", e.g.
+
+```
+@import finitio/data
+
+# String, Integer, Boolean, etc. are now available in this system
+```
+
+See `lib/finitio/stdlib/*.fio` for the precise definition of the standard library.
+
+### Contributing to the standard library
+
+Ruby gems may contribute to the standard library by specifying resolve paths.
+We suggest the following system file structure inside your gem source code:
+
+```
+lib
+  myrubygem
+  myrubygem.rb
+finitio
+  myrubygem
+    base.fio
+    advanced.fio
+```
+
+Registering the standard library path can then be done as follows:
+
+```
+# inside myrubygem.rb
+Finitio.stdlib_path(File.expand_path('../../finitio', __FILE__))
+```
+
+Then, a Finitio schema will have access to the types defined in your extension:
+
+```
+@import myrubygem/base
+@import myrubygem/advanced
+```
+
 ## About representations
 
 The `Rep` representation function mapping *Finitio* types to ruby classes is
@@ -135,14 +222,3 @@ Rep({{Ai => Ti}}) = Set<Hash<Symbol => Rep(Ti)>>
 # specified. ADTs behave as Union types if no class is bound.
 Rep(.Builtin <rep> ...) = Builtin
 ```
-
-## About the default system
-
-See `lib/finitio/Finitio/default.fio` for the precise definition of the default
-system. In summary,
-
-* Most ruby native (data) classes are already aliased to avoid explicit use of
-  builtins. In particular, `Integer`, `String`, etc.
-* A `Boolean` union type also hides the TrueClass and FalseClass distinction.
-* Date, Time and DateTime ADTs are also provided that perform common
-  conversions from JSON strings, through iso8601.

data/lib/finitio.rb

@@ -1,6 +1,7 @@
 require 'set'
 require 'time'
 require 'pathname'
+require 'thread'
 
 module Finitio
 
@@ -9,34 +10,65 @@ module Finitio
   require_relative "finitio/support"
   require_relative 'finitio/type'
   require_relative 'finitio/system'
+  require_relative "finitio/syntax"
 
   IDENTITY = ->(object){ object }
 
   ANY_TYPE = AnyType.new
 
+  LOCK = Mutex.new
+
   STDLIB_PATHS = [
     File.expand_path('../finitio/stdlib', __FILE__)
   ]
 
+  MEMOIZED_SYSTEMS = {}
+
   def stdlib_path(path)
-    STDLIB_PATHS << path
+    LOCK.synchronize {
+      STDLIB_PATHS << path
+    }
   end
 
   def parse(source)
-    require "finitio/syntax"
     Syntax.parse(source)
   end
 
   def system(source)
-    require "finitio/syntax"
-    Syntax.compile(source)
+    LOCK.synchronize {
+      _system(source)
+    }
+  end
+
+  def _system(source)
+    if expanded = is_stdlib_source?(source)
+      MEMOIZED_SYSTEMS[expanded] ||= Syntax.compile(source)
+    else
+      Syntax.compile(source)
+    end
+  end
+  private :_system
+
+  def clear_saved_systems!
+    LOCK.synchronize {
+      MEMOIZED_SYSTEMS.clear
+    }
   end
 
   def ast(source)
-    require "finitio/syntax"
     Syntax.ast(source)
   end
 
+  def is_stdlib_source?(source)
+    return false unless source.respond_to?(:to_path)
+    stdlib = STDLIB_PATHS.any?{|stdlib|
+      a_list = File.expand_path(source.to_path).split('/')
+      b_list = File.expand_path(stdlib).split('/')
+      a_list[0..b_list.size-1] == b_list
+    }
+    stdlib ? File.expand_path(source.to_path) : nil
+  end
+
   extend self
 
   DEFAULT_SYSTEM = system(File.read(

data/lib/finitio/generation.rb

@@ -0,0 +1,106 @@
+require 'securerandom'
+require_relative 'generation/heuristic'
+module Finitio
+  #
+  # This class helps generating random data for a given Finitio type.
+  #
+  # Example
+  #
+  #     type = Finitio.system(<<-FIO)
+  #       .Integer
+  #     FIO
+  #     gen = Finitio::Generation.new
+  #     gen.call(type)
+  #
+  # Random data is generated for most ruby builtin types, tuples and all sorts
+  # of collections (seq, set, relations).
+  #
+  # You can fine-tune the random data generation through the following means
+  # (the first one wins):
+  #
+  # * By passing generators by type name at construction:
+  #
+  #       Finition::Generation.new({
+  #         generators: {
+  #           "Name" => ->(type, g, world) { "Bernard" }
+  #         }
+  #       })
+  #
+  # * Through `examples` metadata put on type definitions:
+  #
+  #       /- examples: {"Bernard"} -/
+  #       Name = .String
+  #
+  class Generation
+
+    DEFAULT_OPTIONS = {
+
+      heuristic: Heuristic::Random.new,
+
+      collection_size: 1..10,
+
+      generators: {
+        "Date"     => ->(t,g,w) { g.heuristic.call(Date, g, w) },
+        "Time"     => ->(t,g,w) { g.heuristic.call(Time, g, w) },
+        "DateTime" => ->(t,g,w) { g.heuristic.call(DateTime, g, w) }
+      }
+
+    }
+
+    def initialize(options = {})
+      @options = DEFAULT_OPTIONS.merge(options){|k,v1,v2|
+        v1.is_a?(Hash) ? v1.merge(v2) : v2
+      }
+    end
+    attr_reader :options
+
+    def heuristic
+      options[:heuristic]
+    end
+
+    def generators
+      options[:generators]
+    end
+
+    def flip_coin
+      flip_one_out_of(2) == 1
+    end
+
+    def flip_one_out_of(n)
+      case n
+      when Integer    then Kernel.rand(n)
+      when Range      then Kernel.rand(n)
+      when Enumerable then n[flip_one_out_of(n.size)]
+      else
+        raise "Cannot flip one on #{n}"
+      end
+    end
+
+    def collection_size
+      size = options[:collection_size]
+      size = size.is_a?(Proc) ? size.call : size
+      flip_one_out_of(size)
+    end
+
+    def call(type, world = nil)
+      if gen = generators[type.name]
+        gen.call(type, self, world)
+      elsif exs = type.metadata && type.metadata[:examples]
+        flip_one_out_of(exs)
+      else
+        type.generate_data(self, world)
+      end
+    end
+
+  end # class Generation
+end # module Finitio
+require_relative 'generation/any_type'
+require_relative 'generation/builtin_type'
+require_relative 'generation/seq_type'
+require_relative 'generation/set_type'
+require_relative 'generation/hash_based_type'
+require_relative 'generation/rel_based_type'
+require_relative 'generation/union_type'
+require_relative 'generation/alias_type'
+require_relative 'generation/sub_type'
+require_relative 'generation/ad_type'