finitio 0.0.1 → 0.4.0

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# 0.4.0 / 2014-03-20
+
+* Finitio(-rb) is born from the sources of Q(rb) 0.3.0
+* Finitio.parse now recognizes Path-like objects (responding to :to_path),
+  allowing to parse files directly (through Pathname, Path, etc.).
+
+# 0.3.0 / 2014-03-09
+
+* Added AnyType abstraction, aka '.'
+* Added support for external contracts in ADTs
+* Added support for extracting an Abstract Syntax Tree from parsing result
+* Allows camelCasing in constraint names
+
+# 0.2.0 / 2014-03-04
+
+* Fix dependencies in gemspec (judofyr)
+
+# 0.1.0 / 2014-03-03
+
+* Enhancements
+
+  * Birthday!

data/Gemfile

@@ -0,0 +1,12 @@
+source 'http://rubygems.org'
+
+gemspec
+
+group :development do
+  gem "rake", "~> 10.0"
+  gem "rspec", "~> 2.14"
+  gem "cucumber", "~> 1.3"
+  gem "path", "~> 1.3"
+  gem "awesome_print", "~> 1.2"
+  gem 'coveralls', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    finitio (0.4.0)
+      citrus (~> 2.4)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    awesome_print (1.2.0)
+    builder (3.2.2)
+    citrus (2.4.1)
+    coveralls (0.7.0)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    cucumber (1.3.8)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12.1)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.0.2)
+    diff-lcs (1.2.5)
+    docile (1.1.3)
+    gherkin (2.12.2)
+      multi_json (~> 1.3)
+    mime-types (2.1)
+    multi_json (1.8.4)
+    multi_test (0.0.2)
+    path (1.3.3)
+    rake (10.1.1)
+    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)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.18.1)
+    tins (1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print (~> 1.2)
+  coveralls
+  cucumber (~> 1.3)
+  finitio!
+  path (~> 1.3)
+  rake (~> 10.0)
+  rspec (~> 2.14)

data/LICENCE.md

@@ -0,0 +1,22 @@
+# The MIT Licence
+
+    Copyright (c) 2014 - Bernard Lambeau
+
+    Permission is hereby granted, free of charge, to any person obtaining
+    a copy of this software and associated documentation files (the
+    "Software"), to deal in the Software without restriction, including
+    without limitation the rights to use, copy, modify, merge, publish,
+    distribute, sublicense, and/or sell copies of the Software, and to
+    permit persons to whom the Software is furnished to do so, subject to
+    the following conditions:
+
+    The above copyright notice and this permission notice shall be
+    included in all copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+    LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+    OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+    WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,11 @@
+CHANGELOG.md
+Gemfile
+Gemfile.lock
+lib/**/*
+LICENCE.md
+Manifest.txt
+finitio.gemspec
+Rakefile
+README.md
+spec/**/*
+tasks/**/*

data/README.md

@@ -0,0 +1,148 @@
+[![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)
+[![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)
+
+# Finitio(-rb)
+
+*Finitio* is a language for capturing information structure. Think "JSON/XML
+schema" but the right way. For more information about *Finitio* itself, see
+[www.finitio.io](http://www.finitio.io)
+
+`finitio-rb` is the ruby binding of *Finitio*. It allows defining data schemas
+and validating and coercing data against them in an idiomatic ruby way.
+
+## Example
+
+```ruby
+require 'finitio'
+require 'json'
+
+# Let load a schema
+schema = Finitio::DEFAULT_SYSTEM.parse <<-FIO
+  {
+    name: String( s | s.strip.size > 0 ),
+    at: DateTime
+  }
+FIO
+
+# Let load some JSON document
+data = JSON.parse <<-JSON
+  { "name": "Finitio", "at": "20142-03-01" }
+JSON
+
+# And try dressing that data
+puts schema.dress(data)
+```
+
+## ADTs with internal contracts
+
+`finitio-rb` tries to provide an idiomatic binding for ruby developers. In
+particular, it uses a simple convention-over-configuration protocol for
+information contracts. This protocol is easily described through an example.
+The following ADT definition:
+
+```ruby
+Color = .Color <rgb> {r: Byte, g: Byte, b: Byte}
+```
+
+expects the following ruby class:
+
+```ruby
+class Color
+
+  # Constructor & internal representation
+  def initialize(r, g, b)
+    @r, @g, @b = r, g, b
+  end
+  attr_reader :r, :g, :b
+
+  # Public dresser for the RGB information contract on the class
+  def self.rgb(tuple)
+    new(tuple[:r], tuple[:g], tuple[:b])
+  end
+
+  # Public undresser on the instance
+  def to_rgb
+    { r: @r, g: @g, b: @b }
+  end
+
+  # ...
+
+end
+```
+
+## ADTs with external contracts
+
+When the scenario above is not possible or not wanted (would require core
+extensions for instance), `finitio-rb` allows defining ADTs with external
+contracts. The following ADT definition:
+
+```ruby
+Color = .Color <rgb> {r: Byte, g: Byte, b: Byte} .RgbContract
+```
+
+expected the following ruby module:
+
+```ruby
+module RgbContract
+
+  def self.dress(tuple)
+    Color.new(tuple[:r], tuple[:g], tuple[:b])
+  end
+
+  def self.undress(color)
+    { r: color.r, g: color.g, b: color.b }
+  end
+
+end
+```
+
+## About representations
+
+The `Rep` representation function mapping *Finitio* types to ruby classes is
+as follows:
+
+```ruby
+# Any type is represented by Ruby's Object class
+Rep(.) = Object
+
+# Builtins are represented by the corresponding ruby class
+Rep(.Builtin) = Builtin
+
+# Sub types are represented by the same representation as the super type
+Rep(SuperType( s | ... )) = Rep(SuperType)
+
+# Unions are represented by the corresponding classes. The guaranteed result
+# class is thus the least common super class (^) of the corresponding
+# representations of candidate types
+Rep(T1 | ... | Tn) = Rep(T1) ^ ... ^ Rep(Tn)
+
+# Sequences are represented through ::Array.
+Rep([ElmType]) = Array<Rep(ElmType)>
+
+# Sets are represented through ::Set.
+Rep({ElmType}) = Set<Rep(ElmType)>
+
+# Tuples are represented through ruby ::Hash. Attribute names are always
+# symbolized
+Rep({Ai => Ti}) = Hash<Symbol => Rep(Ti)>
+
+# Relations are represented through ruby ::Set of ::Hash.
+Rep({{Ai => Ti}}) = Set<Hash<Symbol => Rep(Ti)>>
+
+# Abstract data types are represented through the corresponding class when
+# 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/Rakefile

@@ -0,0 +1,11 @@
+# We run tests by default
+task :default => :test
+
+#
+# Install all tasks found in tasks folder
+#
+# See .rake files there for complete documentation.
+#
+Dir["tasks/*.rake"].each do |taskfile|
+  load taskfile
+end

data/finitio.gemspec

@@ -0,0 +1,186 @@
+# 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")
+
+  #
+  # 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.
+  
+
+  # 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