finitio 0.7.0.pre.rc4 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e41db73ab84b38134f0f19c0340c0863ff2d134b
-  data.tar.gz: db5f29aa5ce74764ffa96124d5982b3734491790
+SHA256:
+  metadata.gz: f1f480aeb4db3e1d01d3a5d17306557bde03f0bc6fe6525f919b4bf1419026f8
+  data.tar.gz: 910e20fadff426a69d4a42299290b198cfdbc36c238b54e6e7a0b2e4777d0798
 SHA512:
-  metadata.gz: 7a48bf413dab63621f2c246fe4997ea8b0a1b9a04e3ac66ff14db4e697156cc20a56bd4ec2fee9493facbdc9466433d1f96d0e7d3a47162126402bf38e39ac88
-  data.tar.gz: 9def829a4ad8936700eba39ae1aaefebd0526def79a9c289cbfc06c2abf0b2be54771826b97c739d2cda39455223e0b60dd4f6d7e45a96bc39884338bd2312e9
+  metadata.gz: 35105c22fb14360380bee7d2ac70d170ca46a5b6fd55c5e059bf1c38f96519157645fb2581a57013de2b56c8b5730fc9cd69afca79e4693f007219705ca525c9
+  data.tar.gz: d17223fc24cd31c0cb4d56846f45403243b3921362a9fba15b6bc17b29a332480e3b90780dc5b0c3214c3f2087f4a911aee0463ca88a59a616e619a51708d214

data/CHANGELOG.md

@@ -1,3 +1,45 @@
+# 0.10.0 - 2021/01/11
+
+* Upgrade all dependencies.
+
+* Ruby < 2.3 is no longer supported.
+
+* Fix code and build under Ruby 3.0.
+
+# 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
+
+* 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,12 +1,2 @@
-source 'http://rubygems.org'
-
+source 'https://rubygems.org'
 gemspec
-
-group :development do
-  gem "rake", "~> 10.0"
-  gem "rspec", "~> 3.0"
-  gem "cucumber", "~> 1.3"
-  gem "path", "~> 1.3"
-  gem "awesome_print", "~> 1.2"
-  gem 'coveralls', require: false
-end

data/Gemfile.lock

@@ -1,71 +1,118 @@
 PATH
   remote: .
   specs:
-    finitio (0.7.0.pre.rc4)
-      citrus (>= 2.4, < 4.0)
+    finitio (0.10.0)
+      citrus (>= 3.0, < 4.0)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    awesome_print (1.6.1)
-    builder (3.2.2)
+    activesupport (5.2.4.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    awesome_print (1.8.0)
+    builder (3.2.4)
     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)
-      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)
-    gherkin (2.12.2)
-      multi_json (~> 1.3)
-    mime-types (2.4.3)
-    multi_json (1.10.1)
-    multi_test (0.1.1)
-    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)
+    concurrent-ruby (1.1.7)
+    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 (4.1.0)
+      builder (~> 3.2, >= 3.2.3)
+      cucumber-core (~> 7.1, >= 7.1.0)
+      cucumber-create-meta (~> 1.0.0, >= 1.0.0)
+      cucumber-cucumber-expressions (~> 10.1, >= 10.1.0)
+      cucumber-gherkin (~> 14.0, >= 14.0.1)
+      cucumber-html-formatter (~> 7.0, >= 7.0.0)
+      cucumber-messages (~> 12.2, >= 12.2.0)
+      cucumber-wire (~> 3.1, >= 3.1.0)
+      diff-lcs (~> 1.3, >= 1.3, < 1.4)
+      multi_test (~> 0.1, >= 0.1.2)
+      sys-uname (~> 1.0, >= 1.0.2)
+    cucumber-core (7.1.0)
+      cucumber-gherkin (~> 14.0, >= 14.0.1)
+      cucumber-messages (~> 12.2, >= 12.2.0)
+      cucumber-tag-expressions (~> 2.0, >= 2.0.4)
+    cucumber-create-meta (1.0.0)
+      cucumber-messages (~> 12.2, >= 12.2.0)
+      sys-uname (~> 1.2, >= 1.2.1)
+    cucumber-cucumber-expressions (10.3.0)
+    cucumber-gherkin (14.2.0)
+      cucumber-messages (~> 12.4, >= 12.4.0)
+    cucumber-html-formatter (7.2.0)
+      cucumber-messages (~> 12.4, >= 12.4.0)
+    cucumber-messages (12.4.0)
+      protobuf-cucumber (~> 3.10, >= 3.10.8)
+    cucumber-tag-expressions (2.0.4)
+    cucumber-wire (3.1.0)
+      cucumber-core (~> 7.1, >= 7.1.0)
+      cucumber-cucumber-expressions (~> 10.1, >= 10.1.0)
+      cucumber-messages (~> 12.2, >= 12.2.0)
+    diff-lcs (1.3)
+    docile (1.3.4)
+    ffi (1.14.2)
+    i18n (1.8.7)
+      concurrent-ruby (~> 1.0)
+    json (2.5.1)
+    middleware (0.1.0)
+    minitest (5.14.3)
+    multi_json (1.15.0)
+    multi_test (0.1.2)
+    path (2.0.1)
+    protobuf-cucumber (3.10.8)
+      activesupport (>= 3.2)
+      middleware
+      thor
+      thread_safe
+    rake (13.0.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       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.10.0)
+    rspec-mocks (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+    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.2.2)
+      ffi (~> 1.1)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tins (1.26.0)
+      sync
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby
+  x86_64-darwin-18
 
 DEPENDENCIES
-  awesome_print (~> 1.2)
-  coveralls
-  cucumber (~> 1.3)
+  awesome_print (~> 1.8)
+  coveralls (~> 0.8)
+  cucumber (~> 4.1)
   finitio!
-  path (~> 1.3)
-  rake (~> 10.0)
+  multi_json (~> 1.15)
+  path (>= 2.0, < 3.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.16.0
+   2.2.4

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/blambeau/finitio-rb.png)](https://travis-ci.org/blambeau/finitio-rb)
+[![Build Status](https://travis-ci.org/blambeau/finitio-rb.svg?branch=master)](https://travis-ci.org/blambeau/finitio-rb)
 [![Dependency Status](https://gemnasium.com/blambeau/finitio-rb.png)](https://gemnasium.com/blambeau/finitio-rb)
 [![Code Climate](https://codeclimate.com/github/blambeau/finitio-rb.png)](https://codeclimate.com/github/blambeau/finitio-rb)
 [![Coverage Status](https://coveralls.io/repos/blambeau/finitio-rb/badge.png?branch=master)](https://coveralls.io/r/blambeau/finitio-rb)
@@ -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/finitio.gemspec

@@ -1,186 +1,38 @@
-# We require your library, mainly to have access to the VERSION number.
-# Feel free to set $version manually.
 $LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
 require "finitio/version"
 $version = Finitio::Version.to_s
 
-#
-# This is your Gem specification. Default values are provided so that your library
-# should be correctly packaged given what you have described in the .noespec file.
-#
 Gem::Specification.new do |s|
-
-  ################################################################### ABOUT YOUR GEM
-
-  # Gem name (required)
   s.name = "finitio"
-
-  # Gem version (required)
   s.version = $version
-
-  # A short summary of this gem
-  #
-  # This is displayed in `gem list -d`.
   s.summary = "Finitio - in Ruby"
-
-  # A long description of this gem (required)
-  #
-  # The description should be more detailed than the summary.  For example,
-  # you might wish to copy the entire README into the description.
   s.description = "Implements the Finitio information language in Ruby."
-
-  # The URL of this gem home page (optional)
   s.homepage = "https://github.com/blambeau/finitio"
-
-  # Gem publication date (required but auto)
-  #
-  # Today is automatically used by default, uncomment only if
-  # you know what you do!
-  #
-  # s.date = Time.now.strftime('%Y-%m-%d')
-
-  # The license(s) for the library.  Each license must be a short name, no
-  # more than 64 characters.
-  #
-  # s.licences = %w{}
-
-  # The rubyforge project this gem lives under (optional)
-  #
-  # s.rubyforge_project = nil
-
-  ################################################################### ABOUT THE AUTHORS
-
-  # The list of author names who wrote this gem.
-  #
-  # If you are providing multiple authors and multiple emails they should be
-  # in the same order.
-  #
   s.authors = ["Bernard Lambeau"]
-
-  # Contact emails for this gem
-  #
-  # If you are providing multiple authors and multiple emails they should be
-  # in the same order.
-  #
-  # NOTE: Somewhat strangly this attribute is always singular!
-  #       Don't replace by s.emails = ...
   s.email  = ["blambeau@gmail.com"]
-
-  ################################################################### PATHS, FILES, BINARIES
-
-  # Paths in the gem to add to $LOAD_PATH when this gem is
-  # activated (required).
-  #
-  # The default 'lib' is typically sufficient.
   s.require_paths = ["lib"]
-
-  # Files included in this gem.
-  #
-  # By default, we take all files included in the Manifest.txt file on root
-  # of the project. Entries of the manifest are interpreted as Dir[...]
-  # patterns so that lazy people may use wilcards like lib/**/*
-  #
   here = File.expand_path(File.dirname(__FILE__))
   s.files = File.readlines(File.join(here, 'Manifest.txt')).
                  inject([]){|files, pattern| files + Dir[File.join(here, pattern.strip)]}.
                  collect{|x| x[(1+here.size)..-1]}
 
-  # Test files included in this gem.
-  #
   s.test_files = Dir["test/**/*"] + Dir["spec/**/*"]
-
-  # The path in the gem for executable scripts (optional)
-  #
   s.bindir = "bin"
-
-  # Executables included in the gem.
-  #
   s.executables = (Dir["bin/*"]).collect{|f| File.basename(f)}
-
-  ################################################################### REQUIREMENTS & INSTALL
-  # Remember the gem version requirements operators and schemes:
-  #   =  Equals version
-  #   != Not equal to version
-  #   >  Greater than version
-  #   <  Less than version
-  #   >= Greater than or equal to
-  #   <= Less than or equal to
-  #   ~> Approximately greater than
-  #
-  # Don't forget to have a look at http://lmgtfy.com/?q=Ruby+Versioning+Policies
-  # for setting your gem version.
-  #
-  # For your requirements to other gems, remember that
-  #   ">= 2.2.0"              (optimistic:  specify minimal version)
-  #   ">= 2.2.0", "< 3.0"     (pessimistic: not greater than the next major)
-  #   "~> 2.2"                (shortcut for ">= 2.2.0", "< 3.0")
-  #   "~> 2.2.0"              (shortcut for ">= 2.2.0", "< 2.3.0")
-  #
-  s.add_dependency("citrus", ">= 2.4", "< 4.0")
-
-  #
-  # One call to add_dependency('gem_name', 'gem version requirement') for each
-  # runtime dependency. These gems will be installed with your gem.
-  # One call to add_development_dependency('gem_name', 'gem version requirement')
-  # for each development dependency. These gems are required for developers
-  #
-  # We use Gemfile for development dependencies.
   
+  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("awesome_print", "~> 1.8")
+  s.add_development_dependency("coveralls", "~> 0.8")
+  s.add_development_dependency("multi_json", "~> 1.15")
 
-  # The version of ruby required by this gem
-  #
-  # Uncomment and set this if your gem requires specific ruby versions.
-  #
-  # s.required_ruby_version = ">= 0"
-
-  # The RubyGems version required by this gem
-  #
-  # s.required_rubygems_version = ">= 0"
-
-  # The platform this gem runs on.  See Gem::Platform for details.
-  #
-  # s.platform = nil
-
-  # Extensions to build when installing the gem.
-  #
-  # Valid types of extensions are extconf.rb files, configure scripts
-  # and rakefiles or mkrf_conf files.
-  #
   s.extensions = []
-
-  # External (to RubyGems) requirements that must be met for this gem to work.
-  # It’s simply information for the user.
-  #
   s.requirements = nil
-
-  # A message that gets displayed after the gem is installed
-  #
-  # Uncomment and set this if you want to say something to the user
-  # after gem installation
-  #
   s.post_install_message = nil
-
-  ################################################################### SECURITY
-
-  # The key used to sign this gem.  See Gem::Security for details.
-  #
-  # s.signing_key = nil
-
-  # The certificate chain used to sign this gem.  See Gem::Security for
-  # details.
-  #
-  # s.cert_chain = []
-
-  ################################################################### RDOC
-
-  # An ARGV style array of options to RDoc
-  #
-  # See 'rdoc --help' about this
-  #
   s.rdoc_options = []
-
-  # Extra files to add to RDoc such as README
-  #
   s.extra_rdoc_files = Dir["README.md"] + Dir["CHANGELOG.md"] + Dir["LICENCE.md"]
-
 end