finitio 0.4.1 → 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cae1bbbd04a1136243171e987246538c9b575800
+  data.tar.gz: d1de82b9707e8969bad9b51297fd8ebc62f18d27
+SHA512:
+  metadata.gz: 1511839793f7c4595e158494d8a879f8edad4331c1e0774836bbaf752ca325f1769d62c7a6c03fd966b8ad09d23b78f4ba67117b94981ac0977ebd162f9c8e92
+  data.tar.gz: 519e91f7ba489a200cfd05c462fc0014d836211efcce7b69cbae44c77ca4a3044a36984022153e083d929f7373da5778f593c87f3dd14150d07f259a12739008

data/CHANGELOG.md

@@ -1,3 +1,69 @@
+# 0.5.0 / HEAD
+
+* Breaking changes on public API
+
+  * Finitio.parse now returns the parsing tree, no longer the compiled system,
+    use Finitio.system instead.
+
+  * Dress error messages have been changed from `Invalid value xxx for Type` to
+    a more friendly `Invalid Type xxx`. The rationale is that end-users might
+    be exposed to those messages in practice. The new messages seem less cryptic.
+
+* Major enhancements
+
+  * Types no longer have to declared before being used. In order words, the
+    following will work fine even if Bigint references Posint that is declared
+    afterwards:
+
+        ```
+        Bigint = Posint( i | i >= 255 )
+        Posint = Integer( i | i >= 0 )
+        { length: Bigint }
+        ```
+
+  * Added support for recursive types, e.g.,
+
+        ```
+        Tree = { label: String, children: [Tree] }
+        ```
+
+  * Added support for MultiTuple and MultiRelation types, aka "optional
+    vs. required attributes". In the following system, `Person` is a multi
+    tuple while `Persons` is a multi relation; the date of birth is optional
+    in both cases:
+
+        ```
+        Person  =  { name : String, dob :? Date }
+        Persons = {{ name : String, dob :? Date }}
+        ```
+
+  * Added basic support for namespacing, through dots being now allowed in
+    type names. More namespacing support will be added later.
+
+
+        ```
+        This.Is.A.NameSpaced.Type = .Integer( i | i >= 0 )
+        { length: This.Is.A.NameSpaced.Type }
+        ```
+
+  * Attribute names can now start with an underscore, e.g. '_links'
+
+  * Error now have an `root_cause` helper.
+
+  * Dress errors resulting from Union and AdType now set a cause to the first
+    error encountered during the various attempts to dress.
+
+* Breaking changes on undocumented APIs
+
+  * Removed factory methods from the Finitio module itself. Use a System
+    instance instead.
+  * Removed Finitio::DataType
+
+* Other changes & Bug fixes
+
+  * Make Finitio compatible with both Citrus 2.4.x and Citrus 3.x
+  * Fixed parsing of constraint expressions having inner parentheses
+
 # 0.4.1 / 2014-03-20
 
 * Fixed access to the default system that lead to 'Unknown system

data/Gemfile

@@ -4,7 +4,7 @@ gemspec
 
 group :development do
   gem "rake", "~> 10.0"
-  gem "rspec", "~> 2.14"
+  gem "rspec", "~> 3.0"
   gem "cucumber", "~> 1.3"
   gem "path", "~> 1.3"
   gem "awesome_print", "~> 1.2"

data/Gemfile.lock

@@ -1,55 +1,59 @@
 PATH
   remote: .
   specs:
-    finitio (0.4.1)
-      citrus (~> 2.4)
+    finitio (0.5.0)
+      citrus (>= 2.4, < 4.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    awesome_print (1.2.0)
+    awesome_print (1.6.1)
     builder (3.2.2)
-    citrus (2.4.1)
-    coveralls (0.7.0)
+    citrus (3.0.2)
+    coveralls (0.7.2)
       multi_json (~> 1.3)
-      rest-client
+      rest-client (= 1.6.7)
       simplecov (>= 0.7)
-      term-ansicolor
-      thor
-    cucumber (1.3.8)
+      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.1)
+      gherkin (~> 2.12)
       multi_json (>= 1.7.5, < 2.0)
-      multi_test (>= 0.0.2)
+      multi_test (>= 0.1.1)
     diff-lcs (1.2.5)
-    docile (1.1.3)
+    docile (1.1.5)
     gherkin (2.12.2)
       multi_json (~> 1.3)
-    mime-types (2.1)
-    multi_json (1.8.4)
-    multi_test (0.0.2)
+    mime-types (2.4.3)
+    multi_json (1.10.1)
+    multi_test (0.1.1)
     path (1.3.3)
-    rake (10.1.1)
+    rake (10.4.2)
     rest-client (1.6.7)
       mime-types (>= 1.16)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.7)
-    rspec-expectations (2.14.4)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.4)
-    simplecov (0.8.2)
+    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)
+      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
+      multi_json (~> 1.0)
       simplecov-html (~> 0.8.0)
     simplecov-html (0.8.0)
-    term-ansicolor (1.3.0)
-      tins (~> 1.0)
+    term-ansicolor (1.2.2)
+      tins (~> 0.8)
     thor (0.18.1)
-    tins (1.0.0)
+    tins (0.13.2)
 
 PLATFORMS
   ruby
@@ -61,4 +65,4 @@ DEPENDENCIES
   finitio!
   path (~> 1.3)
   rake (~> 10.0)
-  rspec (~> 2.14)
+  rspec (~> 3.0)

data/finitio.gemspec

@@ -116,7 +116,7 @@ Gem::Specification.new do |s|
   #   "~> 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")
+  s.add_dependency("citrus", ">= 2.4", "< 4.0")
 
   #
   # One call to add_dependency('gem_name', 'gem version requirement') for each

data/lib/finitio.rb

@@ -3,40 +3,20 @@ require 'time'
 
 module Finitio
 
-  DSL_METHODS = [
-    :attribute,
-    :heading,
-    :constraints,
-    :any,
-    :builtin,
-    :adt,
-    :subtype,
-    :union,
-    :seq,
-    :set,
-    :tuple,
-    :relation,
-    :type
-  ]
-
   require_relative "finitio/version"
   require_relative "finitio/errors"
   require_relative "finitio/support"
   require_relative 'finitio/type'
-  require_relative 'finitio/data_type'
   require_relative 'finitio/system'
 
-  DEFAULT_FACTORY = TypeFactory.new
-
   IDENTITY = ->(object){ object }
 
-  DSL_METHODS.each do |meth|
-    define_method(meth) do |*args, &bl|
-      DEFAULT_FACTORY.public_send(meth, *args, &bl)
-    end
+  def parse(source)
+    require "finitio/syntax"
+    Syntax.parse(source)
   end
 
-  def parse(source)
+  def system(source)
     require "finitio/syntax"
     Syntax.compile(source)
   end
@@ -46,21 +26,9 @@ module Finitio
     Syntax.ast(source)
   end
 
-  def system(identifier)
-    f = File.expand_path("../finitio/#{identifier}.fio", __FILE__)
-    if File.exists?(f)
-      parse(File.read(f))
-    else
-      raise Error, "Unknown system #{identifier}"
-    end
-  end
-
-  def definition_files(of)
-    dir = File.expand_path("../finitio/#{of}", __FILE__)
-    Dir.glob("#{dir}/*.fio")
-  end
-
   extend self
 
-  DEFAULT_SYSTEM = system('Finitio/default')
+  DEFAULT_SYSTEM = system(File.read(
+    File.expand_path('../finitio/Finitio/default.fio', __FILE__)
+  ))
 end # module Finitio

data/lib/finitio/errors.rb

@@ -8,6 +8,20 @@ module Finitio
     end
     attr_reader :cause
 
+    def root_cause(sandbox = true)
+      # 1) no deeper cause, it's me
+      return self if cause.nil?
+
+      # 2) not a Finitio cause and sandbox
+      return self if sandbox and not cause.is_a?(Error)
+
+      # 3) cause may not go deeper
+      return cause unless cause.respond_to?(:root_cause)
+
+      # 4) delegate
+      cause.root_cause
+    end
+
   end # class Error
 
   class TypeError < Error

data/lib/finitio/support.rb

@@ -1,5 +1,8 @@
+require_relative 'support/metadata'
 require_relative 'support/attribute'
+require_relative 'support/constraint'
+require_relative 'support/contract'
 require_relative 'support/heading'
 require_relative 'support/dress_helper'
-require_relative 'support/collection_type'
 require_relative 'support/type_factory'
+require_relative 'support/compilation'

data/lib/finitio/support/attribute.rb

@@ -6,8 +6,9 @@ module Finitio
   # type is a Finitio type.
   #
   class Attribute
+    include Metadata
 
-    def initialize(name, type)
+    def initialize(name, type, required = true, metadata = nil)
       unless name.is_a?(Symbol)
         raise ArgumentError, "Symbol expected for attribute name, got `#{name}`"
       end
@@ -16,9 +17,14 @@ module Finitio
         raise ArgumentError, "Type expected for attribute domain, got `#{type}`"
       end
 
-      @name, @type = name, type
+      @name, @type, @required, @metadata = name, type, required, metadata
+    end
+    attr_reader :name, :type, :required
+    alias :required? :required
+
+    def optional?
+      !required?
     end
-    attr_reader :name, :type
 
     # Fetch the attribute on `arg`, which is expected to be a Hash object.
     #
@@ -36,17 +42,17 @@ module Finitio
     end
 
     def to_name
-      "#{name}: #{type}"
+      required ? "#{name}: #{type}" : "#{name} :? #{type}"
     end
 
     def ==(other)
-      return nil unless other.is_a?(Attribute)
-      name==other.name and type==other.type
+      other.is_a?(Attribute) && name==other.name && \
+      type==other.type && required==other.required
     end
     alias :eql? :==
 
     def hash
-      name.hash ^ type.hash
+      name.hash ^ type.hash ^ required.hash
     end
 
   end # class Attribute

data/lib/finitio/support/compilation.rb

@@ -0,0 +1,55 @@
+module Finitio
+  class Compilation
+
+    def initialize(system = System.new, factory = TypeFactory.new)
+      @system  = system
+      @factory = factory
+      @proxies = []
+    end
+    attr_reader :system, :factory, :proxies
+
+    def self.coerce(arg)
+      case arg
+      when NilClass    then new
+      when System      then new(arg, arg.factory)
+      when TypeFactory then new(System.new, arg)
+      else
+        raise ArgumentError, "Unable to coerce `#{arg}`"
+      end
+    end
+
+    def resolve_proxies!
+      proxies.each do |p|
+        p.resolve(system)
+      end
+      self
+    end
+
+    # Delegation to Factory
+
+    TypeFactory::DSL_METHODS.each do |dsl_method|
+      define_method(dsl_method){|*args, &bl|
+        factory.public_send(dsl_method, *args, &bl)
+      }
+    end
+
+    def proxy(*args, &bl)
+      proxy = factory.proxy(*args, &bl)
+      proxies << proxy
+      proxy
+    end
+
+    # Delegation to System
+
+    [
+      :add_type,
+      :fetch,
+      :main,
+    ].each do |meth|
+      define_method(meth) do |*args, &bl|
+        system.public_send(meth, *args, &bl)
+      end
+    end
+
+  end # class Compilation
+end # module Finitio

data/lib/finitio/support/constraint.rb

@@ -0,0 +1,46 @@
+module Finitio
+  class Constraint
+    include Metadata
+
+    def initialize(native, name = nil, metadata = nil)
+      unless native.respond_to?(:===)
+        raise ArgumentError, "Constraint must respond to :==="
+      end
+      unless name.nil? or name.is_a?(Symbol)
+        raise ArgumentError, "Constraint name must be a Symbol"
+      end
+      @native = native
+      @name = name
+      @metadata = metadata
+    end
+
+    attr_reader :native
+    protected :native
+
+    def anonymous?
+      @name.nil?
+    end
+
+    def named?
+      !anonymous?
+    end
+
+    def name
+      @name || :default
+    end
+
+    def ===(*args, &bl)
+      native.===(*args, &bl)
+    end
+
+    def ==(other)
+      super || (other.is_a?(Constraint) && native==other.native)
+    end
+    alias :eql? :==
+
+    def hash
+      self.class.hash ^ native.hash
+    end
+
+  end # class Constraint
+end # module Finitio