finitio 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1be4c866c9b4cc67fddb28b39ef618897013cd29
-  data.tar.gz: 51d2f530a4be64de2a3f9a075e5ff536775454ac
+SHA256:
+  metadata.gz: 467a7c5d8dd70fe9b5de2154217a5594182150d6e9c9996ec85c861980c02ecc
+  data.tar.gz: cadb1b56c039b7a88456f803733d9c0da9f7d879393674de0fc067c2fb71679b
 SHA512:
-  metadata.gz: 9024a94cb06ec0df550904d8b1b2029b0e54956a48d54a95ada3ca9a679fd6314278c2ae6bd524ae6ff171a71f6ec6928cb5bfda0a54cda40ddac07168770308
-  data.tar.gz: 3d2eee7016ee732383c1deb0ec202c8c2346eb5a3c2610dd1788d2dc6361c30e46a6438f96144822ff991e883cfdb0c03eb50bd7e8e6777724be91345cc6063b
+  metadata.gz: 4606b1f8de1df5a7712f8c6546252683928066a18e5e2ed91a96af2e68be552f66e3ccea26d8b6760e9ac5c073fffa416f06ae0ca8001bbac5ca4f2532469f1e
+  data.tar.gz: 1d9436c52479abab152422d471b559724e72ea7d933ec8538cf2877e1fa14bebccfc6219dcf662c76758d167653cf47fe10b0332ee2cc118b6e18229826d5eed

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 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

data/Gemfile

@@ -1,4 +1,4 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
 gemspec
 

data/Gemfile.lock

@@ -1,59 +1,58 @@
 PATH
   remote: .
   specs:
-    finitio (0.7.0)
+    finitio (0.8.0)
       citrus (>= 2.4, < 4.0)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    awesome_print (1.6.1)
-    builder (3.2.2)
+    awesome_print (1.8.0)
+    builder (3.2.3)
     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)
+    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.1)
-    diff-lcs (1.2.5)
-    docile (1.1.5)
+      multi_test (>= 0.1.2)
+    diff-lcs (1.3)
+    docile (1.3.1)
     gherkin (2.12.2)
       multi_json (~> 1.3)
-    mime-types (2.4.3)
-    multi_json (1.10.1)
-    multi_test (0.1.1)
+    json (2.2.0)
+    multi_json (1.13.1)
+    multi_test (0.1.2)
     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)
+    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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       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.8.0)
+    rspec-support (3.8.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (0.20.3)
+    tins (1.20.2)
 
 PLATFORMS
   ruby
@@ -68,4 +67,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.16.0
+   2.0.1

data/lib/finitio/generation.rb

@@ -0,0 +1,106 @@
+require 'securerandom'
+require_relative 'generation/heuristic'
+module Finitio
+  #
+  # This class helps generating random data for a given Finitio type.
+  #
+  # Example
+  #
+  #     type = Finitio.system(<<-FIO)
+  #       .Integer
+  #     FIO
+  #     gen = Finitio::Generation.new
+  #     gen.call(type)
+  #
+  # Random data is generated for most ruby builtin types, tuples and all sorts
+  # of collections (seq, set, relations).
+  #
+  # You can fine-tune the random data generation through the following means
+  # (the first one wins):
+  #
+  # * By passing generators by type name at construction:
+  #
+  #       Finition::Generation.new({
+  #         generators: {
+  #           "Name" => ->(type, g, world) { "Bernard" }
+  #         }
+  #       })
+  #
+  # * Through `examples` metadata put on type definitions:
+  #
+  #       /- examples: {"Bernard"} -/
+  #       Name = .String
+  #
+  class Generation
+
+    DEFAULT_OPTIONS = {
+
+      heuristic: Heuristic::Random.new,
+
+      collection_size: 1..10,
+
+      generators: {
+        "Date"     => ->(t,g,w) { g.heuristic.call(Date, g, w) },
+        "Time"     => ->(t,g,w) { g.heuristic.call(Time, g, w) },
+        "DateTime" => ->(t,g,w) { g.heuristic.call(DateTime, g, w) }
+      }
+
+    }
+
+    def initialize(options = {})
+      @options = DEFAULT_OPTIONS.merge(options){|k,v1,v2|
+        v1.is_a?(Hash) ? v1.merge(v2) : v2
+      }
+    end
+    attr_reader :options
+
+    def heuristic
+      options[:heuristic]
+    end
+
+    def generators
+      options[:generators]
+    end
+
+    def flip_coin
+      flip_one_out_of(2) == 1
+    end
+
+    def flip_one_out_of(n)
+      case n
+      when Integer    then Kernel.rand(n)
+      when Range      then Kernel.rand(n)
+      when Enumerable then n[flip_one_out_of(n.size)]
+      else
+        raise "Cannot flip one on #{n}"
+      end
+    end
+
+    def collection_size
+      size = options[:collection_size]
+      size = size.is_a?(Proc) ? size.call : size
+      flip_one_out_of(size)
+    end
+
+    def call(type, world = nil)
+      if gen = generators[type.name]
+        gen.call(type, self, world)
+      elsif exs = type.metadata && type.metadata[:examples]
+        flip_one_out_of(exs)
+      else
+        type.generate_data(self, world)
+      end
+    end
+
+  end # class Generation
+end # module Finitio
+require_relative 'generation/any_type'
+require_relative 'generation/builtin_type'
+require_relative 'generation/seq_type'
+require_relative 'generation/set_type'
+require_relative 'generation/hash_based_type'
+require_relative 'generation/rel_based_type'
+require_relative 'generation/union_type'
+require_relative 'generation/alias_type'
+require_relative 'generation/sub_type'
+require_relative 'generation/ad_type'

data/lib/finitio/generation/ad_type.rb

@@ -0,0 +1,10 @@
+module Finitio
+  class AdType
+
+    def generate_data(generator, world = nil)
+      infotype = generator.flip_one_out_of(contracts).infotype
+      generator.call(infotype, world)
+    end
+
+  end # class AliasType
+end # module Finitio

data/lib/finitio/generation/alias_type.rb

@@ -0,0 +1,9 @@
+module Finitio
+  class AliasType
+
+    def generate_data(generator, world = nil)
+      generator.call(target, world)
+    end
+
+  end # class AliasType
+end # module Finitio

data/lib/finitio/generation/any_type.rb

@@ -0,0 +1,11 @@
+module Finitio
+  class AnyType
+
+    def generate_data(generator, world = nil)
+      candidates = [NilClass, String, Integer, Float]
+      type = generator.flip_one_out_of(candidates)
+      generator.heuristic.call(type, generator, world)
+    end
+
+  end # class AnyType
+end # module Finitio

data/lib/finitio/generation/builtin_type.rb

@@ -0,0 +1,9 @@
+module Finitio
+  class BuiltinType
+
+    def generate_data(generator, world = nil)
+      generator.heuristic.call(ruby_type, generator, world)
+    end
+
+  end # class BuiltinType
+end # module Finitio

data/lib/finitio/generation/hash_based_type.rb

@@ -0,0 +1,15 @@
+module Finitio
+  module HashBasedType
+
+    def generate_data(generator, world = nil)
+      tuple = {}
+      heading.each do |a|
+        if a.required or generator.flip_coin
+          tuple[a.name.to_sym] = generator.call(a.type, world)
+        end
+      end
+      tuple
+    end
+
+  end # class HashBasedType
+end # module Finitio

data/lib/finitio/generation/heuristic.rb

@@ -0,0 +1,8 @@
+module Finitio
+  class Generation
+    class Heuristic
+    end # class Heuristic
+  end # class Generation
+end # module Finitio
+require_relative "heuristic/constant"
+require_relative "heuristic/random"

data/lib/finitio/generation/heuristic/constant.rb

@@ -0,0 +1,30 @@
+module Finitio
+  class Generation
+    class Heuristic
+      class Constant < Heuristic
+
+        CONSTANTS = {
+          NilClass => nil,
+          TrueClass => true,
+          FalseClass => false,
+          Integer => 99,
+          Float => 99.99,
+          String => "Hello world",
+          Date => Date.today,
+          Time => Time.now,
+          DateTime => DateTime.now,
+        }
+
+        def call(ruby_type, generator, world = nil)
+          CONSTANTS.fetch(ruby_type) do
+            CONSTANTS.each_pair do |clazz, value|
+              return value if clazz >= ruby_type
+            end
+            throw :unfound
+          end
+        end
+
+      end # class Constant
+    end # class Heuristic
+  end # class Generation
+end # module Finition

data/lib/finitio/generation/heuristic/random.rb

@@ -0,0 +1,52 @@
+module Finitio
+  class Generation
+    class Heuristic
+      class Random < Heuristic
+
+        RANDOMERS = {
+          NilClass => nil,
+
+          TrueClass => true,
+
+          FalseClass => false,
+
+          Integer => ->(_,g,_) {
+            g.flip_one_out_of(1_000_000)
+          },
+
+          Float => ->(_,g,_) {
+            g.flip_one_out_of(1_000_000)            
+          },
+
+          String => ->(_,g,_) {
+            (1..3).map{ SecureRandom.hex(6) }.join(" ")
+          },
+
+          Date => ->(_,g,_) {
+            Time.at(rand * Time.now.to_i).to_date
+          },
+
+          Time => ->(_,g,_) {
+            Time.at(rand * Time.now.to_i)
+          },
+
+          DateTime => ->(_,g,_) {
+            Time.at(rand * Time.now.to_i).to_datetime
+          }
+        }
+
+        def call(ruby_type, generator, world = nil)
+          r = RANDOMERS.fetch(ruby_type) do
+            pair = RANDOMERS.find do |clazz, value|
+              clazz >= ruby_type
+            end
+            throw :unfound unless pair
+            pair.last
+          end
+          r.is_a?(Proc) ? r.call(ruby_type, generator, world) : r
+        end
+
+      end # class Random
+    end # class Heuristic
+  end # class Generation
+end # module Finition

data/lib/finitio/generation/rel_based_type.rb

@@ -0,0 +1,13 @@
+module Finitio
+  module RelBasedType
+
+    def generate_data(generator, world = nil)
+      coll = []
+      generator.collection_size.times do
+        coll << generator.call(tuple_type, world)
+      end
+      coll.uniq
+    end
+
+  end # module RelBasedType
+end # module Finitio

data/lib/finitio/generation/seq_type.rb

@@ -0,0 +1,13 @@
+module Finitio
+  class SeqType
+
+    def generate_data(generator, world = nil)
+      coll = []
+      generator.collection_size.times do
+        coll << generator.call(elm_type, world)
+      end
+      coll
+    end
+
+  end # class SeqType
+end # module Finitio

data/lib/finitio/generation/set_type.rb

@@ -0,0 +1,13 @@
+module Finitio
+  class SetType
+
+    def generate_data(generator, world = nil)
+      coll = []
+      generator.collection_size.times do
+        coll << generator.call(elm_type, world)
+      end
+      coll.uniq
+    end
+
+  end # class SetType
+end # module Finitio