finitio 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 467a7c5d8dd70fe9b5de2154217a5594182150d6e9c9996ec85c861980c02ecc
-  data.tar.gz: cadb1b56c039b7a88456f803733d9c0da9f7d879393674de0fc067c2fb71679b
+  metadata.gz: fb6a6dde74e450b0569a6f568d2f6e847a6f646b23cd815a3442e1a85dbdaedf
+  data.tar.gz: 26fd2339057cc212d2594d2d52ab66b5ae1ad6dc7db0294faa941f148406ac4a
 SHA512:
-  metadata.gz: 4606b1f8de1df5a7712f8c6546252683928066a18e5e2ed91a96af2e68be552f66e3ccea26d8b6760e9ac5c073fffa416f06ae0ca8001bbac5ca4f2532469f1e
-  data.tar.gz: 1d9436c52479abab152422d471b559724e72ea7d933ec8538cf2877e1fa14bebccfc6219dcf662c76758d167653cf47fe10b0332ee2cc118b6e18229826d5eed
+  metadata.gz: f2e4bc1270b3169f3a9692473525693c90e5771c42fc01e3fdce89da676b1e6867d977fb9f29cc2603adcbdc15920dec9dde6133ccd96f50638e12614cf22eed
+  data.tar.gz: acd957a3ea361e715a17d27bb25baef4687f2ed6252a1289a8e4c660e8151c4ad2813488d9a8fbccda189903b95be5da99983b0f0a922e3590f316dd656c7371

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 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.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    finitio (0.8.0)
+    finitio (0.9.0)
       citrus (>= 2.4, < 4.0)
 
 GEM
@@ -67,4 +67,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   2.0.1
+   2.0.2

data/lib/finitio/json_schema.rb

@@ -0,0 +1,16 @@
+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'

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,27 @@
+module Finitio
+  module JsonSchema
+
+    BUILTIN_MAPPING = {
+      NilClass => "null",
+      String => "string",
+      Integer => "integer",
+      Fixnum => "integer",
+      Bignum => "integer",
+      Float => "number",
+      Numeric => "number"
+    }
+
+  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/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,11 @@
+module Finitio
+  class UnionType
+
+    def to_json_schema(*args, &bl)
+      {
+        anyOf: candidates.map{|c| c.to_json_schema(*args, &bl) }
+      }
+    end
+
+  end # class UnionType
+end # module Finitio

data/lib/finitio/version.rb

@@ -2,7 +2,7 @@ module Finitio
   module Version
 
     MAJOR = 0
-    MINOR = 8
+    MINOR = 9
     TINY  = 0
 
     def self.to_s

data/spec/inference/test_inference.rb

@@ -4,15 +4,15 @@ module Finitio
   describe Inference do
 
     let(:system) {
-      Finitio.system <<-FIO
-@import finitio/data
+      Finitio.system <<~FIO
+        @import finitio/data
 
-Nil = .NilClass
-Boolean = .TrueClass|.FalseClass
-Integer = .Integer
-Date = .Date <iso8601> .String \\( s | Date.iso8601(s) )
-                               \\( d | d.iso8601       )
-String = .String
+        Nil = .NilClass
+        Boolean = .TrueClass|.FalseClass
+        Integer = .Integer
+        Date = .Date <iso8601> .String \\( s | Date.iso8601(s) )
+                                       \\( d | d.iso8601       )
+        String = .String
       FIO
     }
 

data/spec/json_schema/test_ad_type.rb

@@ -0,0 +1,20 @@
+module Finitio
+  module JsonSchema
+    describe "AdType" do
+
+      let(:type) {
+        type = AdType.new(Color, [rgb_contract, hex_contract])
+      }
+
+      it 'works as expected' do
+        expect(type.to_json_schema).to eql({
+          anyOf: [
+            { type: "integer" },
+            { type: "string" }
+          ]
+        })
+      end
+
+    end
+  end
+end

data/spec/json_schema/test_alias_type.rb

@@ -0,0 +1,15 @@
+module Finitio
+  module JsonSchema
+    describe "AliasType" do
+
+      let(:alias_type) {
+        AliasType.new(anyType, "X")
+      }
+
+      it 'works as expected' do
+        expect(alias_type.to_json_schema).to eql({})
+      end
+
+    end
+  end
+end

data/spec/json_schema/test_any_type.rb

@@ -0,0 +1,11 @@
+module Finitio
+  module JsonSchema
+    describe "AnyType" do
+
+      it 'works as expected' do
+        expect(anyType.to_json_schema).to eql({})
+      end
+
+    end
+  end
+end

data/spec/json_schema/test_builtin_type.rb

@@ -0,0 +1,51 @@
+module Finitio
+  module JsonSchema
+    describe "BuiltinType" do
+
+      let(:builtin_type) {
+        BuiltinType.new(ruby_type)
+      }
+
+      subject {
+        builtin_type.to_json_schema
+      }
+
+      context 'with NilClass' do
+        let(:ruby_type){ NilClass }
+
+        it 'works' do
+          expect(subject).to eql({ type: "null" })
+        end
+      end
+
+      context 'with String' do
+        let(:ruby_type){ String }
+
+        it 'works' do
+          expect(subject).to eql({ type: "string" })
+        end
+      end
+
+      [Fixnum, Bignum, Integer].each do |rt|
+        context "with #{rt}" do
+          let(:ruby_type){ rt }
+
+          it 'works' do
+            expect(subject).to eql({ type: "integer" })
+          end
+        end
+      end
+
+      [Float, Numeric].each do |rt|
+        context "with #{rt}" do
+          let(:ruby_type){ rt }
+
+          it 'works' do
+            expect(subject).to eql({ type: "number" })
+          end
+        end
+      end
+
+    end
+  end
+end

data/spec/json_schema/test_multi_relation_type.rb

@@ -0,0 +1,58 @@
+module Finitio
+  module JsonSchema
+    describe "MultiRelationType" do
+
+      context 'with a true allow extra and some optional attribute' do
+        let(:heading){
+          Heading.new([
+            Attribute.new(:a, anyType),
+            Attribute.new(:b, anyType, false),
+          ], allow_extra: true)
+        }
+
+        let(:multi_relation_type) {
+          MultiRelationType.new(heading)
+        }
+
+        it 'works as expected' do
+          expect(multi_relation_type.to_json_schema).to eql({
+            type: "array",
+            items: {
+              type: "object",
+              properties: {
+                a: {},
+                b: {}
+              },
+              required: [:a],
+              additionalProperties: {}
+            },
+            uniqueItems: true
+          })
+        end
+      end
+
+      context 'with a allow extra requiring Strings' do
+        let(:heading){
+          Heading.new([
+          ], allow_extra: BuiltinType.new(String))
+        }
+
+        let(:multi_relation_type) {
+          MultiRelationType.new(heading)
+        }
+
+        it 'works as expected' do
+          expect(multi_relation_type.to_json_schema).to eql({
+            type: "array",
+            items: {
+              type: "object",
+              additionalProperties: { type: "string" }
+            },
+            uniqueItems: true
+          })
+        end
+      end
+
+    end
+  end
+end

data/spec/json_schema/test_multi_tuple_type.rb

@@ -0,0 +1,50 @@
+module Finitio
+  module JsonSchema
+    describe "MultiTupleType" do
+
+      context 'with a true allow extra and some optional attribute' do
+        let(:heading){
+          Heading.new([
+            Attribute.new(:a, anyType),
+            Attribute.new(:b, anyType, false),
+          ], allow_extra: true)
+        }
+
+        let(:multi_tuple_type) {
+          MultiTupleType.new(heading)
+        }
+
+        it 'works as expected' do
+          expect(multi_tuple_type.to_json_schema).to eql({
+            type: "object",
+            properties: {
+              a: {},
+              b: {}
+            },
+            required: [:a],
+            additionalProperties: {}
+          })
+        end
+      end
+
+      context 'with a allow extra requiring Strings' do
+        let(:heading){
+          Heading.new([
+          ], allow_extra: BuiltinType.new(String))
+        }
+
+        let(:multi_tuple_type) {
+          MultiTupleType.new(heading)
+        }
+
+        it 'works as expected' do
+          expect(multi_tuple_type.to_json_schema).to eql({
+            type: "object",
+            additionalProperties: { type: "string" }
+          })
+        end
+      end
+
+    end
+  end
+end

data/spec/json_schema/test_relation_type.rb

@@ -0,0 +1,30 @@
+module Finitio
+  module JsonSchema
+    describe "RelationType" do
+
+      let(:heading){
+        Heading.new([Attribute.new(:a, anyType)])
+      }
+
+      let(:tuple_type) {
+        RelationType.new(heading)
+      }
+
+      it 'works as expected' do
+        expect(tuple_type.to_json_schema).to eql({
+          type: "array",
+          items: {
+            type: "object",
+            properties: {
+              a: {}
+            },
+            required: [:a],
+            additionalProperties: false
+          },
+          uniqueItems: true
+        })
+      end
+
+    end
+  end
+end

data/spec/json_schema/test_seq_type.rb

@@ -0,0 +1,18 @@
+module Finitio
+  module JsonSchema
+    describe "SeqType" do
+
+      let(:type) {
+        SeqType.new(anyType)
+      }
+
+      it 'works as expected' do
+        expect(type.to_json_schema).to eql({
+          type: "array",
+          items: {}
+        })
+      end
+
+    end
+  end
+end

data/spec/json_schema/test_set_type.rb

@@ -0,0 +1,19 @@
+module Finitio
+  module JsonSchema
+    describe "SetType" do
+
+      let(:type) {
+        SetType.new(anyType)
+      }
+
+      it 'works as expected' do
+        expect(type.to_json_schema).to eql({
+          type: "array",
+          items: {},
+          uniqueItems: true
+        })
+      end
+
+    end
+  end
+end

data/spec/json_schema/test_struct_type.rb

@@ -0,0 +1,18 @@
+module Finitio
+  module JsonSchema
+    describe "StructType" do
+
+      let(:type) {
+        StructType.new([anyType,anyType])
+      }
+
+      it 'works as expected' do
+        expect(type.to_json_schema).to eql({
+          type: "array",
+          items: [{},{}]
+        })
+      end
+
+    end
+  end
+end

data/spec/json_schema/test_sub_type.rb

@@ -0,0 +1,17 @@
+module Finitio
+  module JsonSchema
+    describe "SubType" do
+
+      let(:type) {
+        byte
+      }
+
+      it 'skips constraints (for now)' do
+        expect(byte.to_json_schema).to eql({
+          type: "integer"
+        })
+      end
+
+    end
+  end
+end

data/spec/json_schema/test_tuple_type.rb

@@ -0,0 +1,26 @@
+module Finitio
+  module JsonSchema
+    describe "TupleType" do
+
+      let(:heading){
+        Heading.new([Attribute.new(:a, anyType)])
+      }
+
+      let(:tuple_type) {
+        TupleType.new(heading)
+      }
+
+      it 'works as expected' do
+        expect(tuple_type.to_json_schema).to eql({
+          type: "object",
+          properties: {
+            a: {}
+          },
+          required: [:a],
+          additionalProperties: false
+        })
+      end
+
+    end
+  end
+end

data/spec/json_schema/test_union_type.rb

@@ -0,0 +1,17 @@
+module Finitio
+  module JsonSchema
+    describe "UnionType" do
+
+      let(:union_type) {
+        UnionType.new([anyType])
+      }
+
+      it 'works as expected' do
+        expect(union_type.to_json_schema).to eql({
+          anyOf: [{}]
+        })
+      end
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@ require 'path'
 require 'finitio'
 require 'finitio/syntax'
 require 'finitio/generation'
+require 'finitio/json_schema'
 
 require 'coveralls'
 Coveralls.wear!
@@ -126,7 +127,7 @@ module SpecHelpers
   end
 
   def hex_contract
-    @hex_contract ||= Finitio::Contract.new(floatType, Color.method(:hex), Finitio::IDENTITY, :hex)
+    @hex_contract ||= Finitio::Contract.new(stringType, Color.method(:hex), Finitio::IDENTITY, :hex)
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finitio
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Bernard Lambeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-21 00:00:00.000000000 Z
+date: 2020-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: citrus
@@ -65,6 +65,18 @@ files:
 - lib/finitio/generation/sub_type.rb
 - lib/finitio/generation/union_type.rb
 - lib/finitio/inference.rb
+- lib/finitio/json_schema.rb
+- lib/finitio/json_schema/ad_type.rb
+- lib/finitio/json_schema/alias_type.rb
+- lib/finitio/json_schema/any_type.rb
+- lib/finitio/json_schema/builtin_type.rb
+- lib/finitio/json_schema/hash_based_type.rb
+- lib/finitio/json_schema/rel_based_type.rb
+- lib/finitio/json_schema/seq_type.rb
+- lib/finitio/json_schema/set_type.rb
+- lib/finitio/json_schema/struct_type.rb
+- lib/finitio/json_schema/sub_type.rb
+- lib/finitio/json_schema/union_type.rb
 - lib/finitio/stdlib/finitio/data.fio
 - lib/finitio/support.rb
 - lib/finitio/support/attribute.rb
@@ -186,6 +198,19 @@ files:
 - spec/heading/test_suppremum.rb
 - spec/heading/test_to_name.rb
 - spec/inference/test_inference.rb
+- spec/json_schema/test_ad_type.rb
+- spec/json_schema/test_alias_type.rb
+- spec/json_schema/test_any_type.rb
+- 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_relation_type.rb
+- spec/json_schema/test_seq_type.rb
+- spec/json_schema/test_set_type.rb
+- spec/json_schema/test_struct_type.rb
+- spec/json_schema/test_sub_type.rb
+- spec/json_schema/test_tuple_type.rb
+- spec/json_schema/test_union_type.rb
 - spec/spec_helper.rb
 - spec/support/test_compare_attrs.rb
 - spec/support/test_proc_with_code.rb
@@ -350,13 +375,25 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Finitio - in Ruby
 test_files:
 - spec/inference/test_inference.rb
+- spec/json_schema/test_union_type.rb
+- spec/json_schema/test_alias_type.rb
+- spec/json_schema/test_builtin_type.rb
+- spec/json_schema/test_set_type.rb
+- spec/json_schema/test_multi_tuple_type.rb
+- spec/json_schema/test_sub_type.rb
+- spec/json_schema/test_relation_type.rb
+- spec/json_schema/test_multi_relation_type.rb
+- spec/json_schema/test_any_type.rb
+- spec/json_schema/test_ad_type.rb
+- spec/json_schema/test_seq_type.rb
+- spec/json_schema/test_tuple_type.rb
+- spec/json_schema/test_struct_type.rb
 - spec/syntax/nodes/test_system.rb
 - spec/syntax/nodes/test_union_type.rb
 - spec/syntax/nodes/test_constraints.rb