obfusk-data 0.0.2.SNAPSHOT.20130211214657

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/README.md

@@ -0,0 +1,96 @@
+[]: {{{1
+
+    File        : README.md
+    Maintainer  : Felix C. Stegerman <flx@obfusk.net>
+    Date        : 2013-02-11
+
+    Copyright   : Copyright (C) 2013  Felix C. Stegerman
+    Version     : 0.0.2.SNAPSHOT
+
+[]: }}}1
+
+## Description
+[]: {{{1
+
+  [rb-]obfusk-data - data validation combinator library for ruby
+
+  ...
+
+  https://github.com/obfusk/clj-obfusk-data in ruby.
+
+```ruby
+isa       = ->(cls, obj) { cls === obj } .curry
+is_string = isa[String]
+is_email  = ->(x) { %r{^.*@.*\.[a-z]+$}.match x }
+
+address = Obfusk::Data.data do
+  field [:street, :number, :postal_code, :town], [is_string]
+  field :country, [is_string], optional: true
+end
+
+person = Obfusk::Data.data do
+  field [:first_name, :last_name, :phone_number], [is_string]
+  field :email, [is_string, is_email]
+  field :address, [], isa: [address]
+end
+
+tree = Obfusk::Data.union :type do |_tree|
+  data :empty
+  data :leaf do
+    field :value, []
+  end
+  data :node do
+    field [:left, :right], [], isa: [_tree]
+  end
+end
+
+Obfusk::Data.valid? tree,
+  { type: :node,
+    left: { type: :empty },
+    right: { type: :leaf, value: "spam!" } }
+# => true
+```
+
+[]: }}}1
+
+## Specs & Docs
+[]: {{{1
+
+    $ rake spec
+    $ rake docs
+
+[]: }}}1
+
+## TODO
+[]: {{{1
+
+  * add more ruby-ish api ?
+
+#
+
+  * write more specs
+  * write more docs
+  * show isa errors
+  * ...
+
+[]: }}}1
+
+## License
+[]: {{{1
+
+  GPLv2 [1] or EPLv1 [2].
+
+[]: }}}1
+
+## References
+[]: {{{1
+
+  [1] GNU General Public License, version 2
+  --- http://www.opensource.org/licenses/GPL-2.0
+
+  [2] Eclipse Public License, version 1
+  --- http://www.opensource.org/licenses/EPL-1.0
+
+[]: }}}1
+
+[]: ! ( vim: set tw=70 sw=2 sts=2 et fdm=marker : )

data/Rakefile

@@ -0,0 +1,32 @@
+desc 'Run specs'
+task :spec do
+  sh 'rspec -cfd'
+end
+
+desc 'Generate docs'
+task :docs do
+  sh 'yardoc | cat'
+end
+
+desc 'List undocumented objects'
+task :undocumented do
+  sh 'yard stats --list-undoc'
+end
+
+desc 'Cleanup'
+task :clean do
+  sh 'rm -rf .yardoc/ doc/ *.gem'
+end
+
+desc 'Build SNAPSHOT gem'
+task :snapshot do
+  v = Time.new.strftime '%Y%m%d%H%M%S'
+  f = 'lib/obfusk/data/version.rb'
+  sh "sed -ri~ 's!(SNAPSHOT)!\\1.#{v}!' #{f}"
+  sh 'gem build obfusk-data.gemspec'
+end
+
+desc 'Undo SNAPSHOT gem'
+task 'snapshot-undo' do
+  sh 'git checkout -- lib/obfusk/data/version.rb'
+end

data/lib/obfusk/data/version.rb

@@ -0,0 +1,6 @@
+module Obfusk
+  module Data
+    VERSION = '0.0.2.SNAPSHOT.20130211214657'
+    DATE    = '2013-02-11'
+  end
+end

data/lib/obfusk/data.rb

@@ -0,0 +1,221 @@
+# --                                                            ; {{{1
+#
+# File        : obfusk/data.rb
+# Maintainer  : Felix C. Stegerman <flx@obfusk.net>
+# Date        : 2013-02-11
+#
+# Copyright   : Copyright (C) 2013  Felix C. Stegerman
+# Licence     : GPLv2 or EPLv1
+#
+# --                                                            ; }}}1
+
+require 'hamster'
+require 'set'
+
+module Obfusk
+  module Data
+
+    # this proxy allows us to define recursive types
+    PROXY = ->(; f, bind, proxy) {                              # {{{1
+      proxy = ->(*args) {
+        raise 'unbound PROXY called!' unless f                  # TODO
+        f[*args]
+      }
+      bind = ->(g) {
+        raise 'PROXY can only be bound once' if f               # TODO
+        f = g
+      }
+      [proxy, bind]
+    }                                                           # }}}1
+
+    # this helper allows us to run field in the block passed to data
+    class FieldsHelper                                          # {{{1
+      # init
+      def initialize
+        @_fields = []
+      end
+
+      # add field
+      def field (*args)
+        @_fields << Obfusk::Data.field(*args)
+      end
+
+      # get fields
+      def _fields
+        @_fields
+      end
+    end                                                         # }}}1
+
+    # this helper allows us to run data in the block passed to union
+    class DatasHelper                                           # {{{1
+      # init
+      def initialize
+        @_datas = {}
+      end
+
+      # add data
+      def data (value, &block)
+        @_datas[value] = Obfusk::Data._blk_flds block
+      end
+
+      # get datas
+      def _datas
+        @_datas
+      end
+    end                                                         # }}}1
+
+    # --
+
+    # empty sequence?
+    def self._blank? (x)
+      String === x || Enumerable === x ? x.empty? : false
+    end
+
+    # add error
+    def self._error (st, *msg)
+      e1 = st[:errors]
+      e2 = e1.add msg.join
+      st.put :errors, e2
+    end
+
+    # --
+
+    # if only we had clojure's :keys ;-(
+    def self._get_keys (x, keys)
+      x.values_at *keys.map(&:to_sym)
+    end
+
+    # run block in instance of helper
+    def self._blk_hlp (cls, block, *args)
+      x = cls.new
+      x.instance_exec *args, &block
+      x
+    end
+
+    # turn block into fields using FieldsHelper
+    def self._blk_flds (block, *args)
+      block ? _blk_hlp(FieldsHelper, block, *args)._fields : []
+    end
+
+    # --
+
+    # data validator w/o block magic
+    def self.data_ (fields, opts = {})                          # {{{1
+      o_flds  = opts[:other_fields]
+      isa     = opts.fetch :isa, []
+      st      = Hamster.hash errors: Hamster.vector,
+                  processed: Hamster.set
+
+      ->(x ; st_, ks, pks, eks) {
+        if isa.any? { |x| validate x }
+          _error st '[data] has failed isa'                     # TODO
+        else
+          st_ = fields.reduce(st) { |s, f| f[x, s] }
+          ks  = x.keys.to_set
+          pks = st_[:processed]
+          eks = ks - pks
+
+          if !o_flds && !eks.empty?
+            _error st_, '[data] has extraneous fields'
+          elsif o_flds.respond_to?(:to_proc) && !eks.all?(&o_flds)
+            _error st_, '[data] has invalid other fields'
+          else
+            st_
+          end
+        end
+      }
+    end                                                         # }}}1
+
+    # A data validator.  ...
+    def self.data (opts = {}, &block)
+      proxy, bind = PROXY[]
+      data        = data_ _blk_flds(block, proxy), opts
+      bind[data]
+      data
+    end
+
+    # --
+
+    # validate a field
+    def self._validate_field (name, predicates, opts, x, st)    # {{{1
+      field = x[name]
+      preds = predicates.map(&:to_proc)
+      isa   = opts.fetch :isa, []
+
+      st_   = st.put :processed, st[:processed].add(name)
+      err   = ->(*msg) { _error st_, (opts[:message] || msg.join) }
+
+      optional, o_nil, blank, o_if, o_if_not =
+        _get_keys opts, %w{ optional o_nil blank o_if o_if_not }
+
+      if (o_if && !o_if[x]) || (o_if_not && o_if_not[x])
+        st_
+      elsif !x.has_key? name
+        optional ? st_ : err['[field] not found: ', name]
+      elsif field.nil?
+        o_nil || optional ? st_ : err['[field] is nil: ', name]
+      elsif _blank?(field) && !(blank || optional)
+        err['[field] is blank: ', name]
+      elsif !preds.all? { |p| p[field] }
+        err['[field] has failed predicates: ', name]
+      elsif isa.any? { |x| validate x, field }
+        err['[field] has failed isa: ', name]                   # TODO
+      else
+        st_
+      end
+    end                                                         # }}}1
+
+    # A data field.  Predicates are functions that are invoked with
+    # the field's value, and must all return true.  ...
+    def self.field (names, predicates, opts = {})
+      f   = ->(n, x, s) { _validate_field n, predicates, opts, x, s }
+      ns  = Enumerable === names ? names : [names]
+
+      ->(x, st) { ns.reduce(st) { |s, name| f[name, x, s] } }
+    end
+
+    # --
+
+    # union w/o block magic and data wrapping
+    def self.union__ (key, datas)
+      f = field key, [->(x) { Symbol === x }]
+
+      ->(x, st ; fields) {
+        fields = datas.fetch(x.fetch(key)) + [f]
+        fields.reduce(st) { |s, field| field[x, s] }
+      }
+    end
+
+    # union w/o block magic
+    def self.union_ (key, datas, opts = {})
+      data_ [union__(key, datas)], opts
+    end
+
+    # Union of data fields.  ...
+    def self.union (key, opts = {}, &block)
+      proxy, bind = PROXY[]
+      datas       = _blk_hlp(DatasHelper, block, proxy)._datas
+      data        = union_ key, datas, opts
+      bind[data]
+      data
+    end
+
+    # --
+
+    # Validate.
+    # @return [nil]       if valid
+    # @return [<String>]  errors otherwise
+    def self.validate (f, x)
+      e = f[x][:errors]
+      e.empty? ? nil : e.to_a
+    end
+
+    # Validate.
+    def self.valid? (f, x)
+      validate(f, x).nil?
+    end
+
+  end
+end
+
+# vim: set tw=70 sw=2 sts=2 et fdm=marker :

data/obfusk-data.gemspec

@@ -0,0 +1,29 @@
+require File.expand_path('../lib/obfusk/data/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'obfusk-data'
+  s.homepage    = 'https://github.com/obfusk/rb-obfusk-data'
+  s.summary     = 'data validation combinator library for ruby'
+
+  s.description = <<-END.gsub(/^ {4}/, '')                      # TODO
+    ...
+  END
+
+  s.version     = Obfusk::Data::VERSION
+  s.date        = Obfusk::Data::DATE
+
+  s.authors     = [ 'Felix C. Stegerman' ]
+  s.email       = %w{ flx@obfusk.net }
+
+  s.licenses    = %w{ GPLv2 EPLv1 }
+
+  s.files       = %w{ .yardopts README.md Rakefile } \
+                + Dir[*%w{ {lib,spec}/**/*.rb *.gemspec }]
+
+  s.add_runtime_dependency      'hamster'
+
+  s.add_development_dependency  'rake'
+  s.add_development_dependency  'rspec'
+
+  s.required_ruby_version = '>= 1.9.1'
+end

data/spec/obfusk/data_spec.rb

@@ -0,0 +1,149 @@
+# --                                                            ; {{{1
+#
+# File        : obfusk/data.rb
+# Maintainer  : Felix C. Stegerman <flx@obfusk.net>
+# Date        : 2013-02-08
+#
+# Copyright   : Copyright (C) 2013  Felix C. Stegerman
+# Licence     : GPLv2 or EPLv1
+#
+# --                                                            ; }}}1
+
+require 'obfusk/data'
+
+# --
+
+isa       = ->(cls, obj) { cls === obj } .curry
+is_string = isa[String]
+
+is_email  = ->(x) { %r{^.*@.*\.[a-z]+$}.match x }
+is_url    = ->(x) { %r{^https?://.*$}.match x }
+
+is_object_id = ->(x) {
+  is_string[x] && x.length == 16 &&
+    x.chars.all? { |c| %{^[a-zA-Z0-9]$}.match c }
+}
+
+is_id_seq = ->(x) { isa[Enumberable, x] && x.all?(&is_object_id) }
+is_id_map = ->(m) {
+  isa[Hash, m] && m.all? { |k,v| is_string[k] && is_object_id[v] }
+}
+
+# --
+
+foo = Obfusk::Data.data other_fields: ->(x) { %r{^data_}.match x }
+
+tree = Obfusk::Data.union :type do |_tree|
+  data :empty
+  data :leaf do
+    field :value, []
+  end
+  data :node do
+    field [:left, :right], [], isa: [_tree]
+  end
+end
+
+# --
+
+address = Obfusk::Data.data do
+  field [:street, :number, :postal_code, :town], [is_string]
+  field :country, [is_string], optional: true
+end
+
+person = Obfusk::Data.data do
+  field [:first_name, :last_name, :phone_number], [is_string]
+  field :email, [is_string, is_email]
+  field :address, [], isa: [address]
+end
+
+# --
+
+collection = Obfusk::Data.data do
+  field :_id  , [is_object_id]
+  field :app  , [is_string]
+  field :icon , [is_object_id]
+  field :items, [is_id_seq]
+  field :title, [is_string], optional: true
+end
+
+item = Obfusk::Data.data do
+  field :_id            , [is_object_id]
+  field :type           , [is_string]
+  field :icon           , [is_object_id], nil: true
+  field :data           , []            , optional: true
+  field :title          , [is_string]   , optional: true
+  field :url            , [is_url]      , optional: true
+  field [:refs, :files] , [is_id_map]   , optional: true
+
+  # (not= (contains? x :url)
+  #       (contains? (get x :files {}) :url))                   ; TODO
+end
+
+item_files = Obfusk::Data.data do
+  field :url, [is_url], optional: true
+end
+
+image_item = Obfusk::Data.data isa: [item] do
+  field :icon , [:nil?]
+  field :data , [:nil?], optional: true
+  field :files, isa: [item_files]
+end
+
+# --
+
+describe Obfusk::Data do
+
+  context 'foo' do                                              # {{{1
+    it 'valid empty foo' do
+      should be_valid foo, {}
+    end
+    it 'valid foo' do
+      should be_valid foo, { data_bar: 37 }
+    end
+    it 'invalid foo' do
+      should_not be_valid foo, { baz: 42 }
+    end
+  end                                                           # }}}1
+
+  context 'tree' do                                             # {{{1
+    it 'valid empty tree' do
+      should be_valid tree, { type: :empty }
+    end
+    it 'invalid empty tree' do
+      should_not be_valid tree, { type: :empty, foo: 'hi!' }
+    end
+    it 'valid tree leaf' do
+      should be_valid tree, { type: :leaf, value: 3.14 }
+    end
+    it 'invalid tree leaf' do
+      should_not be_valid tree, { type: :leaf }
+    end
+    it 'valid tree node' do
+      should be_valid tree,
+        { type: :node,
+          left: { type: :empty },
+          right: { type: :leaf, value: 'spam!' } }
+    end
+    it 'invalid tree node' do
+      should_not be_valid tree,
+        { type: :node, left: { type: :empty }, right: nil }
+    end
+  end                                                           # }}}1
+
+  context 'address' do                                          # {{{1
+    it 'valid address' do
+      should be_valid address,
+        { street: 'baker street', number: '221b',
+          town: 'london', postal_code: '???', country: 'uk' }
+    end
+    it 'invalid address' do
+      should_not be_valid address,
+        { street: 'baker street', number: 404 }
+    end
+  end                                                           # }}}1
+
+  # ... TODO ...
+
+end
+
+# vim: set tw=70 sw=2 sts=2 et fdm=marker :

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: obfusk-data
+version: !ruby/object:Gem::Version
+  version: 0.0.2.SNAPSHOT.20130211214657
+  prerelease: 6
+platform: ruby
+authors:
+- Felix C. Stegerman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hamster
+  requirement: &9955760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *9955760
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &9955240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *9955240
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &9954660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *9954660
+description: ! '...
+
+'
+email:
+- flx@obfusk.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .yardopts
+- README.md
+- Rakefile
+- lib/obfusk/data/version.rb
+- lib/obfusk/data.rb
+- spec/obfusk/data_spec.rb
+- obfusk-data.gemspec
+homepage: https://github.com/obfusk/rb-obfusk-data
+licenses:
+- GPLv2
+- EPLv1
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: data validation combinator library for ruby
+test_files: []
+has_rdoc: