finitio 0.7.0.pre.rc4 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e41db73ab84b38134f0f19c0340c0863ff2d134b
-  data.tar.gz: db5f29aa5ce74764ffa96124d5982b3734491790
+  metadata.gz: 1be4c866c9b4cc67fddb28b39ef618897013cd29
+  data.tar.gz: 51d2f530a4be64de2a3f9a075e5ff536775454ac
 SHA512:
-  metadata.gz: 7a48bf413dab63621f2c246fe4997ea8b0a1b9a04e3ac66ff14db4e697156cc20a56bd4ec2fee9493facbdc9466433d1f96d0e7d3a47162126402bf38e39ac88
-  data.tar.gz: 9def829a4ad8936700eba39ae1aaefebd0526def79a9c289cbfc06c2abf0b2be54771826b97c739d2cda39455223e0b60dd4f6d7e45a96bc39884338bd2312e9
+  metadata.gz: 9024a94cb06ec0df550904d8b1b2029b0e54956a48d54a95ada3ca9a679fd6314278c2ae6bd524ae6ff171a71f6ec6928cb5bfda0a54cda40ddac07168770308
+  data.tar.gz: 3d2eee7016ee732383c1deb0ec202c8c2346eb5a3c2610dd1788d2dc6361c30e46a6438f96144822ff991e883cfdb0c03eb50bd7e8e6777724be91345cc6063b

data/CHANGELOG.md

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

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    finitio (0.7.0.pre.rc4)
+    finitio (0.7.0)
       citrus (>= 2.4, < 4.0)
 
 GEM

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

@@ -16,16 +16,18 @@ module Finitio
 
   ANY_TYPE = AnyType.new
 
+  LOCK = Mutex.new
+
   STDLIB_PATHS = [
     File.expand_path('../finitio/stdlib', __FILE__)
   ]
 
   MEMOIZED_SYSTEMS = {}
 
-  MEMOIZATION_SEMAPHORE = Mutex.new
-
   def stdlib_path(path)
-    STDLIB_PATHS << path
+    LOCK.synchronize {
+      STDLIB_PATHS << path
+    }
   end
 
   def parse(source)
@@ -33,7 +35,7 @@ module Finitio
   end
 
   def system(source)
-    MEMOIZATION_SEMAPHORE.synchronize {
+    LOCK.synchronize {
       _system(source)
     }
   end
@@ -48,7 +50,7 @@ module Finitio
   private :_system
 
   def clear_saved_systems!
-    MEMOIZATION_SEMAPHORE.synchronize {
+    LOCK.synchronize {
       MEMOIZED_SYSTEMS.clear
     }
   end

data/lib/finitio/support/contract.rb

@@ -30,7 +30,7 @@ module Finitio
     end
 
     def hash
-      [infotype, dresser, undresser].hash
+      infotype.hash ^ dresser.hash ^ undresser.hash
     end
 
     def ==(other)
@@ -38,7 +38,7 @@ module Finitio
         other.is_a?(Contract) &&
         name == other.name &&
         infotype == other.infotype &&
-        dresser == other.dresser && 
+        dresser == other.dresser &&
         undresser == other.undresser
       )
     end

data/lib/finitio/system.rb

@@ -97,16 +97,20 @@ module Finitio
       System.new(@types.dup, @imports.dup)
     end
 
-    def check_and_warn(io = STDERR)
+    def check_and_warn(logger = nil)
+      logger ||= begin
+        require 'logger'
+        Logger.new(STDERR)
+      end
       each_type do |t|
         next unless t.named?
         each_import do |i|
           next unless found = i.get_type(t.name)
           if found == t
-            STDERR.puts "WARN: duplicate type def `#{t.name}`"
+            logger.info "Duplicate type def `#{t.name}`"
             break
           else
-            STDERR.puts "NOTICE: Type erasure `#{t.name}`"
+            logger.warn "Type erasure `#{t.name}`"
             break
           end
         end

data/lib/finitio/type/ad_type.rb

@@ -132,7 +132,7 @@ module Finitio
     end
 
     def hash
-      [ ruby_type, contracts ].hash
+      ruby_type.hash ^ contracts.hash
     end
 
     def ==(other)

data/lib/finitio/version.rb

@@ -3,7 +3,7 @@ module Finitio
 
     MAJOR = 0
     MINOR = 7
-    TINY  = "0-rc4"
+    TINY  = 0
 
     def self.to_s
       [ MAJOR, MINOR, TINY ].join('.')

data/spec/finitio/test_system.rb

@@ -29,15 +29,4 @@ describe Finitio, "system" do
     end
   end
 
-  context "feedback about duplicate types" do
-    before {
-      Finitio.stdlib_path(Path.dir.parent)
-    }
-    subject{
-      Finitio.system(Path.dir/"with-duplicates.fio").check_and_warn
-    }
-
-    it{ should be_a(Finitio::System) }
-  end
-
 end

data/spec/system/fixtures/system.fio

@@ -0,0 +1,2 @@
+Posint = .Integer( i | i >= 0 )
+Negint = .Integer( i | i < 0 )

data/spec/{finitio → system/fixtures}/with-duplicates.fio

@@ -1,5 +1,6 @@
 @import finitio/data
-@import finitio/system
+@import ./system
 
 NilClass = .NilClass
 Posint = .Integer( i | i >= 0 )
+Negint = .Integer( i | i <= 0 )

data/spec/system/test_check_and_warn.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+module Finitio
+  describe System, "check_and_warn" do
+
+    before {
+      Finitio.stdlib_path(Path.dir)
+    }
+
+    subject{
+      Finitio.system(Path.dir/"fixtures/with-duplicates.fio").check_and_warn(logger)
+    }
+
+    let(:logger){
+      TestLogger.new
+    }
+
+    it {
+      should be_a(Finitio::System)
+    }
+
+    it 'detects duplicate types as expected' do
+      subject
+      expect(logger.infos).to eql([
+        "Duplicate type def `NilClass`",
+        "Duplicate type def `Posint`"
+      ])
+    end
+
+    it 'detects type erasures as expected' do
+      subject
+      expect(logger.warns).to eql([
+        "Type erasure `Negint`",
+      ])
+    end
+
+    class TestLogger
+
+      def initialize
+        @warns = []
+        @infos = []
+      end
+      attr_reader :warns, :infos
+
+      def warn(msg)
+        @warns << msg
+      end
+
+      def info(msg)
+        @infos << msg
+      end
+
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finitio
 version: !ruby/object:Gem::Version
-  version: 0.7.0.pre.rc4
+  version: 0.7.0
 platform: ruby
 authors:
 - Bernard Lambeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-27 00:00:00.000000000 Z
+date: 2019-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: citrus
@@ -154,7 +154,6 @@ files:
 - spec/finitio/test_parse.rb
 - spec/finitio/test_stdlib_memoization.rb
 - spec/finitio/test_system.rb
-- spec/finitio/with-duplicates.fio
 - spec/heading/test_allow_extra.rb
 - spec/heading/test_each.rb
 - spec/heading/test_equality.rb
@@ -196,7 +195,10 @@ files:
 - spec/syntax/nodes/test_unnamed_constraint.rb
 - spec/syntax/test_compile.rb
 - spec/syntax/test_compile_type.rb
+- spec/system/fixtures/system.fio
+- spec/system/fixtures/with-duplicates.fio
 - spec/system/test_add_type.rb
+- spec/system/test_check_and_warn.rb
 - spec/system/test_dsl.rb
 - spec/system/test_dup.rb
 - spec/system/test_fetch.rb
@@ -315,9 +317,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.2
@@ -363,7 +365,6 @@ test_files:
 - spec/heading/test_each.rb
 - spec/test_finitio.rb
 - spec/finitio/test_ast.rb
-- spec/finitio/with-duplicates.fio
 - spec/finitio/system.fio
 - spec/finitio/test_system.rb
 - spec/finitio/test_parse.rb
@@ -374,6 +375,9 @@ test_files:
 - spec/system/test_dup.rb
 - spec/system/test_add_type.rb
 - spec/system/test_dsl.rb
+- spec/system/fixtures/with-duplicates.fio
+- spec/system/fixtures/system.fio
+- spec/system/test_check_and_warn.rb
 - spec/type/multi_relation_type/test_name.rb
 - spec/type/multi_relation_type/test_initialize.rb
 - spec/type/multi_relation_type/test_equality.rb