finitio 0.8.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 467a7c5d8dd70fe9b5de2154217a5594182150d6e9c9996ec85c861980c02ecc
-  data.tar.gz: cadb1b56c039b7a88456f803733d9c0da9f7d879393674de0fc067c2fb71679b
+SHA1:
+  metadata.gz: 67c8e3434a57c9b94e5175d34f6a20078c3ea3cd
+  data.tar.gz: 18e6c0cfc68d0ce75ec91c9e000a1a80db551a2f
 SHA512:
-  metadata.gz: 4606b1f8de1df5a7712f8c6546252683928066a18e5e2ed91a96af2e68be552f66e3ccea26d8b6760e9ac5c073fffa416f06ae0ca8001bbac5ca4f2532469f1e
-  data.tar.gz: 1d9436c52479abab152422d471b559724e72ea7d933ec8538cf2877e1fa14bebccfc6219dcf662c76758d167653cf47fe10b0332ee2cc118b6e18229826d5eed
+  metadata.gz: baa24a0c65ebe967e44dd30b6b0e381a7e9abcb2f43b3a27d1b3f573aa4f14aa718295f2efdd36846edcd87ca0920bf0f065add879d6058723ff13f93cad8ac6
+  data.tar.gz: dcb03256d1892b6c6f42321d53b7fedbf7a43219228c235f91643ab94fe22aee5d6d728c5e159817f3105dfa3aed2c20338ae6f6ba8c8a73ab186397b4674da4

data/CHANGELOG.md

@@ -1,3 +1,31 @@
+# 0.11.1 - 2021/12/09
+
+* Fix github actions and extend test grid.
+
+# 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
+
+* 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

data/Gemfile

@@ -1,12 +1,2 @@
 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,70 +1,117 @@
 PATH
   remote: .
   specs:
-    finitio (0.8.0)
-      citrus (>= 2.4, < 4.0)
+    finitio (0.11.1)
+      citrus (>= 3.0, < 4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    awesome_print (1.8.0)
-    builder (3.2.3)
+    activesupport (5.2.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    awesome_print (1.9.2)
+    builder (3.2.4)
     citrus (3.0.2)
+    concurrent-ruby (1.1.9)
     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.2)
+    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.1)
-    gherkin (2.12.2)
-      multi_json (~> 1.3)
-    json (2.2.0)
-    multi_json (1.13.1)
+    docile (1.3.5)
+    ffi (1.15.4)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    json (2.6.1)
+    middleware (0.1.0)
+    minitest (5.14.4)
+    multi_json (1.15.0)
     multi_test (0.1.2)
-    path (1.3.3)
-    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)
+    path (2.0.1)
+    protobuf-cucumber (3.10.8)
+      activesupport (>= 3.2)
+      middleware
+      thor
+      thread_safe
+    rake (13.0.6)
+    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.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
     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 (0.20.3)
-    tins (1.20.2)
+    thor (1.1.0)
+    thread_safe (0.3.6)
+    tins (1.29.1)
+      sync
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
 
 PLATFORMS
-  ruby
+  x86_64-linux
 
 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
-   2.0.1
+   2.2.33

data/README.md

@@ -1,5 +1,4 @@
-[![Build Status](https://travis-ci.org/blambeau/finitio-rb.png)](https://travis-ci.org/blambeau/finitio-rb)
-[![Dependency Status](https://gemnasium.com/blambeau/finitio-rb.png)](https://gemnasium.com/blambeau/finitio-rb)
+[![Build Status](https://travis-ci.org/blambeau/finitio-rb.svg?branch=master)](https://travis-ci.org/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)
 

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

data/lib/finitio/json_schema/ad_type.rb

@@ -0,0 +1,11 @@
+module Finitio
+  class AdType
+
+    def to_json_schema(*args, &bl)
+      {
+        anyOf: contracts.map{|c| c.infotype.to_json_schema(*args, &bl) }
+      }
+    end
+
+  end # class AdType
+end # module Finitio

data/lib/finitio/json_schema/alias_type.rb

@@ -0,0 +1,9 @@
+module Finitio
+  class AliasType
+
+    def to_json_schema(*args, &bl)
+      target.to_json_schema(*args, &bl)
+    end
+
+  end # class AliasType
+end # module Finitio

data/lib/finitio/json_schema/any_type.rb

@@ -0,0 +1,9 @@
+module Finitio
+  class AnyType
+
+    def to_json_schema(*args, &bl)
+      {}
+    end
+
+  end # class AnyType
+end # module Finitio

data/lib/finitio/json_schema/builtin_type.rb

@@ -0,0 +1,30 @@
+module Finitio
+  module JsonSchema
+
+    BUILTIN_MAPPING = {
+      NilClass => "null",
+      String => "string",
+      Integer => "integer",
+      Fixnum => "integer",
+      Bignum => "integer",
+      Float => "number",
+      Numeric => "number",
+      TrueClass => "boolean",
+      FalseClass => "boolean",
+      Object => "object"
+    }
+
+  end
+  class BuiltinType
+
+    def to_json_schema(*args, &bl)
+      mapped = JsonSchema::BUILTIN_MAPPING[ruby_type]
+      if mapped
+        { type: mapped }
+      else
+        raise JsonSchema::Error, "Unable to map #{ruby_type} to json-schema"
+      end
+    end
+
+  end # class BuiltinType
+end # module Finitio

data/lib/finitio/json_schema/hash_based_type.rb

@@ -0,0 +1,25 @@
+module Finitio
+  module HashBasedType
+
+    def to_json_schema(*args, &bl)
+      base = {
+        type: "object"
+      }
+      unless heading.empty?
+        base[:properties] = heading.inject({}){|ps,a|
+            ps.merge(a.name => a.type.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?
+        heading.allow_extra.to_json_schema(*args, &bl)
+      else
+        false
+      end
+      base
+    end
+
+  end # module HashBasedType
+end # module UnionType

data/lib/finitio/json_schema/proxy_type.rb

@@ -0,0 +1,9 @@
+module Finitio
+  class ProxyType
+
+    def to_json_schema(*args, &bl)
+      @target.to_json_schema(*args, &bl) if @target
+    end
+
+  end # module ProxyType
+end # module UnionType

data/lib/finitio/json_schema/rel_based_type.rb

@@ -0,0 +1,13 @@
+module Finitio
+  module RelBasedType
+
+    def to_json_schema(*args, &bl)
+      {
+        type: "array",
+        items: tuple_type.to_json_schema(*args, &bl),
+        uniqueItems: true
+      }
+    end
+
+  end # module RelBasedType
+end # module Finitio

data/lib/finitio/json_schema/seq_type.rb

@@ -0,0 +1,12 @@
+module Finitio
+  class SeqType
+
+    def to_json_schema(*args, &bl)
+      {
+        type: "array",
+        items: elm_type.to_json_schema(*args, &bl)
+      }
+    end
+
+  end # class SeqType
+end # module Finitio

data/lib/finitio/json_schema/set_type.rb

@@ -0,0 +1,13 @@
+module Finitio
+  class SetType
+
+    def to_json_schema(*args, &bl)
+      {
+        type: "array",
+        items: elm_type.to_json_schema(*args, &bl),
+        uniqueItems: true
+      }
+    end
+
+  end # class SetType
+end # module Finitio

data/lib/finitio/json_schema/struct_type.rb

@@ -0,0 +1,12 @@
+module Finitio
+  class StructType
+
+    def to_json_schema(*args, &bl)
+      {
+        type: "array",
+        items: component_types.map{|c| c.to_json_schema(*args, &bl) }
+      }
+    end
+
+  end # class StructType
+end # module Finitio

data/lib/finitio/json_schema/sub_type.rb

@@ -0,0 +1,10 @@
+module Finitio
+  class SubType
+
+    def to_json_schema(*args, &bl)
+      # TODO: add support for constraints here...
+      super_type.to_json_schema(*args, &bl)
+    end
+
+  end # class SubType
+end # module Finitio

data/lib/finitio/json_schema/union_type.rb

@@ -0,0 +1,23 @@
+module Finitio
+  class UnionType
+
+    NIL_TYPE = BuiltinType.new(NilClass)
+
+    FALSE_TYPE = BuiltinType.new(TrueClass)
+
+    TRUE_TYPE = BuiltinType.new(FalseClass)
+
+    BOOLEAN_TYPE = UnionType.new([TRUE_TYPE, FALSE_TYPE])
+
+    def to_json_schema(*args, &bl)
+      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
+
+      {
+        anyOf: cs.map{|c| c.to_json_schema(*args, &bl) }
+      }
+    end
+
+  end # class UnionType
+end # module Finitio

data/lib/finitio/json_schema.rb

@@ -0,0 +1,17 @@
+module Finitio
+  module JsonSchema
+    class Error < Finitio::Error; end
+  end # module JsonSchema
+end # module Finitio
+require_relative 'json_schema/ad_type'
+require_relative 'json_schema/any_type'
+require_relative 'json_schema/alias_type'
+require_relative 'json_schema/builtin_type'
+require_relative 'json_schema/hash_based_type'
+require_relative 'json_schema/rel_based_type'
+require_relative 'json_schema/seq_type'
+require_relative 'json_schema/set_type'
+require_relative 'json_schema/struct_type'
+require_relative 'json_schema/sub_type'
+require_relative 'json_schema/union_type'
+require_relative 'json_schema/proxy_type'

data/lib/finitio/support/heading.rb

@@ -100,8 +100,14 @@ module Finitio
     protected   :attributes, :options
 
     def resolve_proxies(system)
-      as = attributes.map{|k,a| a.resolve_proxies(system) }
-      Heading.new(as, options)
+      as = attributes.map{|k,a|
+        a.resolve_proxies(system)
+      }
+      opts = options.dup
+      if options[:allow_extra] && options[:allow_extra].is_a?(Type)
+        opts[:allow_extra] = opts[:allow_extra].resolve_proxies(system)
+      end
+      Heading.new(as, opts)
     end
 
     def unconstrained

data/lib/finitio/syntax/lexer.citrus

@@ -21,7 +21,7 @@ grammar Finitio::Syntax::Lexer
   end
 
   rule attribute_name
-    /[a-z_][a-zA-Z0-9_]*/
+    /[a-z_][a-zA-Z0-9_\-]*/
   end
 
   rule type_name

data/lib/finitio/version.rb

@@ -2,8 +2,8 @@ module Finitio
   module Version
 
     MAJOR = 0
-    MINOR = 8
-    TINY  = 0
+    MINOR = 11
+    TINY  = 1
 
     def self.to_s
       [ MAJOR, MINOR, TINY ].join('.')