obfusk-data 0.0.2.SNAPSHOT.20130211214657 → 0.0.2.SNAPSHOT.20130212031255

data/README.md

@@ -51,6 +51,32 @@ Obfusk::Data.valid? tree,
 # => true
 ```
 
+```ruby
+class X < Obfusk::Data::ValidHash
+  data do
+    field :spam, []
+  end
+end
+
+class Y < Obfusk::Data::ValidHamster
+  data do
+    field :spam, []
+  end
+end
+
+x = X.new spam: 99; x[:spam] = 88
+# OK
+
+X.new
+# raises Obfusk::Data::ValidHash::InvalidError
+
+y = Y.new spam: 'yuck!'
+# OK
+
+Y.put :invalid, 'oops.'
+# raises Obfusk::Data::ValidHamster::InvalidError
+```
+
 []: }}}1
 
 ## Specs & Docs
@@ -64,10 +90,6 @@ Obfusk::Data.valid? tree,
 ## TODO
 []: {{{1
 
-  * add more ruby-ish api ?
-
-#
-
   * write more specs
   * write more docs
   * show isa errors

data/Rakefile

@@ -1,5 +1,10 @@
 desc 'Run specs'
 task :spec do
+  sh 'rspec -c'
+end
+
+desc 'Run specs verbosely'
+task 'spec:verbose' do
   sh 'rspec -cfd'
 end
 
@@ -9,7 +14,7 @@ task :docs do
 end
 
 desc 'List undocumented objects'
-task :undocumented do
+task 'docs:undoc' do
   sh 'yard stats --list-undoc'
 end
 
@@ -27,6 +32,6 @@ task :snapshot do
 end
 
 desc 'Undo SNAPSHOT gem'
-task 'snapshot-undo' do
+task 'snapshot:undo' do
   sh 'git checkout -- lib/obfusk/data/version.rb'
 end

data/lib/obfusk/data/base.rb

@@ -0,0 +1,49 @@
+# --                                                            ; {{{1
+#
+# File        : obfusk/data/base.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 'obfusk/data'
+
+module Obfusk
+  module Data
+
+    module Base
+
+      def self.included (base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+
+        def data (*a, &b)
+          const_set :VALIDATOR, Obfusk::Data.data(*a, &b)
+        end
+
+        def union (*a, &b)
+          const_set :VALIDATOR, Obfusk::Data.union(*a, &b)
+        end
+
+      end
+
+      def validate!
+        e = Obfusk::Data.validate self.class::VALIDATOR, self
+        raise self.class::InvalidError, e.join('; ') if e
+      end
+
+      def valid?
+        Obfusk::Data.valid? self.class::VALIDATOR, self
+      end
+
+    end
+
+  end
+end
+
+# vim: set tw=70 sw=2 sts=2 et fdm=marker :

data/lib/obfusk/data/hamster.rb

@@ -0,0 +1,65 @@
+# --                                                            ; {{{1
+#
+# File        : obfusk/data/hamster.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 'obfusk/data/base'
+
+module Obfusk
+  module Data
+
+    # @todo document
+    # @note
+    #   getting this to work depends on Hamster implementation details
+    #   as well as some black magic ;-(
+    class ValidHamster < Hamster::Hash                          # {{{1
+
+      include Base
+
+      class InvalidError < RuntimeError; end
+
+      def self.__from_hamster (x)
+        data  = x.instance_eval { [@trie, @default] }
+        y     = allocate
+        y.instance_eval { @trie, @default = data }
+        y
+      end
+
+      def self.__to_hamster (x)
+        data  = x.instance_eval { [@trie, @default] }
+        y     = Hamster::Hash.allocate
+        y.instance_eval { @trie, @default = data }
+        y
+      end
+
+      def self.new (*a, &b)
+        x = __from_hamster Hamster::Hash.new(*a, &b)
+        x.validate!; x
+      end
+
+      def self.empty
+        x = @empty ||= new; x.validate!; x
+      end
+
+      def except (*a, &b)
+        y = self.class.__to_hamster self
+        x = self.class.__from_hamster y.except(*a, &b)
+        x.validate!; x
+      end
+
+      def transform (*a, &b)
+        x = super; x.validate!; x
+      end
+
+    end                                                         # }}}1
+
+  end
+end
+
+# vim: set tw=70 sw=2 sts=2 et fdm=marker :

data/lib/obfusk/data/hash.rb

@@ -0,0 +1,70 @@
+# --                                                            ; {{{1
+#
+# File        : obfusk/data/hash.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 'obfusk/data/base'
+
+module Obfusk
+  module Data
+
+    # @todo document
+    class ValidHash < Hash                                      # {{{1
+
+      include Base
+
+      class InvalidError < RuntimeError; end
+
+      %w{
+        []= clear delete delete_if keep_if merge! reject! replace
+        select! shift store update
+      }.map(&:to_sym).each do |m|
+        define_method m do |*a, &b|
+          r = super(*a, &b); validate!; r
+        end
+      end
+
+      def self.[] (*a, &b)
+        x = super; x.validate!; x
+      end
+
+      def initialize (data = {}, &block)
+        super(&block); self.merge! data
+      end
+
+      def compare_by_identity
+        raise NotImplementedError
+      end
+
+      def invert
+        Hash[self].invert
+      end
+
+      def merge (*a, &b)
+        x = super; x.validate!; x
+      end
+
+      def reject (*a, &b)
+        x = super; x.validate!; x
+      end
+
+      def select (*a, &b)
+        x = self.class[super]; x.validate!; x                   # TODO
+      end
+
+      def to_hash
+        Hash[self]
+      end
+
+    end                                                         # }}}1
+
+  end
+end
+
+# vim: set tw=70 sw=2 sts=2 et fdm=marker :

data/lib/obfusk/data/version.rb

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

data/spec/_data.rb

@@ -0,0 +1,94 @@
+# --                                                            ; {{{1
+#
+# File        : _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 'obfusk/data'
+
+module Obfusk::Data__Spec
+
+  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
+
+end
+
+# vim: set tw=70 sw=2 sts=2 et fdm=marker :

data/spec/obfusk/data/hamster_spec.rb

@@ -0,0 +1,84 @@
+# --                                                            ; {{{1
+#
+# File        : obfusk/data/hamster_spec.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 'obfusk/data/hamster'
+
+module Obfusk::Data::Hamster__Spec
+
+  class Bar < Obfusk::Data::ValidHamster
+    data other_fields: ->(x) { /other/.match x } do
+      field :bar, [->(x) { /bar/.match x }], optional: true
+    end
+  end
+
+  class Baz < Obfusk::Data::ValidHamster
+    data do
+      field :baz  , []
+      field :maybe, [], optional: true
+    end
+  end
+
+  E = Obfusk::Data::ValidHamster::InvalidError
+
+  # --
+
+  describe Obfusk::Data::ValidHamster do
+
+    context 'Bar' do                                            # {{{1
+      it 'valid empty Bar (2x)' do
+        Bar.new; Bar.empty
+      end
+      it 'valid Bar' do
+        Bar.new bar: 'bar?!'
+      end
+      it 'valid Bar w/ other field' do
+        Bar.new some_other_field: 37
+      end
+      it 'invalid Bar' do
+        expect { Bar.new baz: 42 }.to raise_error E
+      end
+      it 'invalid Bar merge' do
+        b = Bar.new
+        expect { b.merge Hamster.hash baz: 42 }.to raise_error E
+      end
+      it 'invalid Bar put' do
+        b = Bar.new
+        expect { b.put :bar, 'hi!' }.to raise_error E
+      end
+    end                                                         # }}}1
+
+    context 'Baz' do                                            # {{{1
+      it 'valid Baz' do
+        Baz.new baz: 'ok!'
+      end
+      it 'valid Baz except' do
+        b = Baz.new baz: 1, maybe: 2
+        b.except :maybe
+      end
+      it 'invalid empty Baz (new)' do
+        expect { Baz.new }.to raise_error E
+      end
+      it 'invalid empty Baz (empty)' do
+        expect { Baz.empty }.to raise_error E
+      end
+      it 'invalid Baz except' do
+        b = Baz.new baz: 1, maybe: 2
+        expect { b.except :baz }.to raise_error E
+      end
+    end                                                         # }}}1
+
+    # ... TODO ...
+
+  end
+
+end
+
+# vim: set tw=70 sw=2 sts=2 et fdm=marker :

data/spec/obfusk/data/hash_spec.rb

@@ -0,0 +1,70 @@
+# --                                                            ; {{{1
+#
+# File        : obfusk/data/hash_spec.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 'obfusk/data/hash'
+
+module Obfusk::Data::Hash__Spec
+
+  class Bar < Obfusk::Data::ValidHash
+    data other_fields: ->(x) { /other/.match x } do
+      field :bar, [->(x) { /bar/.match x }], optional: true
+    end
+  end
+
+  class Baz < Obfusk::Data::ValidHash
+    data do
+      field :baz, []
+    end
+  end
+
+  E = Obfusk::Data::ValidHash::InvalidError
+
+  # --
+
+  describe Obfusk::Data::ValidHash do
+
+    context 'Bar' do                                            # {{{1
+      it 'valid empty Bar' do
+        Bar.new
+      end
+      it 'valid Bar' do
+        Bar.new bar: 'bar?!'
+      end
+      it 'valid Bar w/ other field' do
+        Bar.new some_other_field: 37
+      end
+      it 'invalid Bar' do
+        expect { Bar.new baz: 42 }.to raise_error E
+      end
+      it 'invalid Bar merge' do
+        b = Bar.new
+        expect { b.merge baz: 42 }.to raise_error E
+      end
+      it 'invalid Bar []=' do
+        b = Bar.new
+        expect { b[:bar] = 'hi!' }.to raise_error E
+      end
+    end                                                         # }}}1
+
+    context 'Baz' do                                            # {{{1
+      it 'invalid Baz clear' do
+        b = Baz.new baz: 'ok'
+        expect { b.clear }.to raise_error E
+      end
+    end                                                         # }}}1
+
+    # ... TODO ...
+
+  end
+
+end
+
+# vim: set tw=70 sw=2 sts=2 et fdm=marker :

data/spec/obfusk/data_spec.rb

@@ -1,148 +1,72 @@
 # --                                                            ; {{{1
 #
-# File        : obfusk/data.rb
+# File        : obfusk/data_spec.rb
 # Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-# Date        : 2013-02-08
+# Date        : 2013-02-11
 #
 # Copyright   : Copyright (C) 2013  Felix C. Stegerman
 # Licence     : GPLv2 or EPLv1
 #
 # --                                                            ; }}}1
 
-require 'obfusk/data'
+require './spec/_data'
+
+module Obfusk::Data__Spec
+
+  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 ...
 
-# --
-
-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
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: obfusk-data
 version: !ruby/object:Gem::Version
-  version: 0.0.2.SNAPSHOT.20130211214657
+  version: 0.0.2.SNAPSHOT.20130212031255
   prerelease: 6
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2013-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hamster
-  requirement: &9955760 !ruby/object:Gem::Requirement
+  requirement: &20985220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *9955760
+  version_requirements: *20985220
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &9955240 !ruby/object:Gem::Requirement
+  requirement: &20928520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *9955240
+  version_requirements: *20928520
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &9954660 !ruby/object:Gem::Requirement
+  requirement: &20927780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *9954660
+  version_requirements: *20927780
 description: ! '...
 
 '
@@ -56,8 +56,14 @@ files:
 - .yardopts
 - README.md
 - Rakefile
+- lib/obfusk/data/hamster.rb
 - lib/obfusk/data/version.rb
+- lib/obfusk/data/hash.rb
+- lib/obfusk/data/base.rb
 - lib/obfusk/data.rb
+- spec/_data.rb
+- spec/obfusk/data/hash_spec.rb
+- spec/obfusk/data/hamster_spec.rb
 - spec/obfusk/data_spec.rb
 - obfusk-data.gemspec
 homepage: https://github.com/obfusk/rb-obfusk-data