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

data/README.md

@@ -2,7 +2,7 @@
 
     File        : README.md
     Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-    Date        : 2013-02-11
+    Date        : 2013-02-13
 
     Copyright   : Copyright (C) 2013  Felix C. Stegerman
     Version     : 0.0.2.SNAPSHOT
@@ -14,9 +14,27 @@
 
   [rb-]obfusk-data - data validation combinator library for ruby
 
+  https://github.com/obfusk/clj-obfusk-data in ruby.
+
   ...
 
-  https://github.com/obfusk/clj-obfusk-data in ruby.
+### ValidHash vs UnsafeValidHash
+
+  A ValidHash is always valid: modifications are rolled back if they
+  made it invalid.
+
+  An UnsafeValidHash may become invalid: modifications are always
+  performed, even if they make it invalid.
+
+  A ValidHash is therefore (probably) less efficient than an
+  UnsafeValidHash, but never becomes invalid.  Choose wisely.
+
+[]: }}}1
+
+## Examples
+[]: {{{1
+
+[]: {{{2
 
 ```ruby
 isa       = ->(cls, obj) { cls === obj } .curry
@@ -51,32 +69,68 @@ Obfusk::Data.valid? tree,
 # => true
 ```
 
+[]: }}}2
+
+[]: {{{2
+
 ```ruby
-class X < Obfusk::Data::ValidHash
-  data do
-    field :spam, []
-  end
+class Foo < Obfusk::Data::ValidHamster
+  data { field :foo, [] }
 end
 
-class Y < Obfusk::Data::ValidHamster
-  data do
-    field :spam, []
-  end
+x = Foo.new foo: 'ok'
+
+x.put :invalid, 'oops'
+# ---> Obfusk::Data::Valid::InvalidError
+
+Foo.new
+# ---> Obfusk::Data::Valid::InvalidError
+```
+
+[]: }}}2
+
+[]: {{{2
+
+```ruby
+class Bar < Obfusk::Data::ValidHash
+  data { field :bar, [] }
 end
 
-x = X.new spam: 99; x[:spam] = 88
-# OK
+y = Bar.new bar: 'ok'
+y[:bar] = 'also ok'
 
-X.new
-# raises Obfusk::Data::ValidHash::InvalidError
+begin
+  y[:invalid] = 'oops'
+rescue Obfusk::Data::Valid::InvalidError
+  y.valid?    # => true
+  y[:invalid] # => nil
+end
+```
 
-y = Y.new spam: 'yuck!'
-# OK
+[]: }}}2
 
-Y.put :invalid, 'oops.'
-# raises Obfusk::Data::ValidHamster::InvalidError
+[]: {{{2
+
+```ruby
+class Baz < Obfusk::Data::UnsafeValidHash
+  data { field :baz, [] }
+end
+
+z = Baz.new baz: 'ok'
+c = z.dup
+
+begin
+  z[:invalid] = 'oops'
+rescue Obfusk::Data::Valid::InvalidError
+  z.valid?    # => false
+  c.valid?    # => true
+  z[:invalid] # => 'oops'
+  c[:invalid] # => nil
+end
 ```
 
+[]: }}}2
+
 []: }}}1
 
 ## Specs & Docs

data/lib/obfusk/data/hamster.rb

@@ -2,59 +2,47 @@
 #
 # File        : obfusk/data/hamster.rb
 # Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-# Date        : 2013-02-11
+# Date        : 2013-02-13
 #
 # Copyright   : Copyright (C) 2013  Felix C. Stegerman
 # Licence     : GPLv2 or EPLv1
 #
 # --                                                            ; }}}1
 
-require 'obfusk/data/base'
+require 'obfusk/data/valid'
 
 module Obfusk
   module Data
 
     # @todo document
-    # @note
-    #   getting this to work depends on Hamster implementation details
-    #   as well as some black magic ;-(
+    # @note depends on Hamster implementation details !!!
     class ValidHamster < Hamster::Hash                          # {{{1
 
-      include Base
+      include Valid
 
-      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
+      def self.new (pairs = {}, &b)
+        @empty ||= super()
+        x = b ? super(&b) : @empty
+        pairs.empty? ? x.validate! : x.merge_hash(pairs)
       end
 
-      def self.new (*a, &b)
-        x = __from_hamster Hamster::Hash.new(*a, &b)
-        x.validate!; x
+      def self.empty
+        @empty ? @empty.validate! : new
       end
 
-      def self.empty
-        x = @empty ||= new; x.validate!; x
+      def except (*keys)
+        trie = keys.reduce(@trie) { |t, k| t.delete k }
+        transform_unless(trie.equal? @trie) { @trie = trie }
       end
 
-      def except (*a, &b)
-        y = self.class.__to_hamster self
-        x = self.class.__from_hamster y.except(*a, &b)
-        x.validate!; x
+      def merge_hash (pairs)
+        transform_unless(pairs.empty?) {
+          @trie = pairs.reduce(@trie) { |t, p| t.put *p }
+        }
       end
 
-      def transform (*a, &b)
-        x = super; x.validate!; x
+      def transform (&b)
+        super.validate!
       end
 
     end                                                         # }}}1

data/lib/obfusk/data/hash.rb

@@ -2,68 +2,130 @@
 #
 # File        : obfusk/data/hash.rb
 # Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-# Date        : 2013-02-11
+# Date        : 2013-02-13
 #
 # Copyright   : Copyright (C) 2013  Felix C. Stegerman
 # Licence     : GPLv2 or EPLv1
 #
 # --                                                            ; }}}1
 
-require 'obfusk/data/base'
+require 'obfusk/data/valid'
 
 module Obfusk
   module Data
 
     # @todo document
-    class ValidHash < Hash                                      # {{{1
+    # @todo what to do about defaults !?
+    class ValidHashBase < Hash                                  # {{{1
 
-      include Base
+      include Valid
 
-      class InvalidError < RuntimeError; end
+      TRANSFORMATIONS = %w{
+        []= clear delete merge! replace shift store update
+      }.map(&:to_sym)
 
-      %w{
-        []= clear delete delete_if keep_if merge! reject! replace
-        select! shift store update
-      }.map(&:to_sym).each do |m|
+      TRANSFORMATIONS_ENUMERATORS = %w{
+        delete_if keep_if reject! select!
+      }.map(&:to_sym)
+
+      UNIMPLEMENTED = %w{
+        compare_by_identity default= default_proc=
+      }.map(&:to_sym)
+
+      UNIMPLEMENTED.each do |m|
         define_method m do |*a, &b|
-          r = super(*a, &b); validate!; r
+          raise NotImplementedError
         end
       end
 
       def self.[] (*a, &b)
-        x = super; x.validate!; x
-      end
-
-      def initialize (data = {}, &block)
-        super(&block); self.merge! data
+        # NB: we must validate b/c super uses allocate instead of new
+        super.validate!
       end
 
-      def compare_by_identity
-        raise NotImplementedError
+      def initialize (data = {}, &b)
+        super(&b); self.merge! data
       end
 
+      # @return [Hash]
       def invert
         Hash[self].invert
       end
 
       def merge (*a, &b)
-        x = super; x.validate!; x
+        super.validate!
       end
 
       def reject (*a, &b)
-        x = super; x.validate!; x
+        return to_enum :reject, *a unless b
+        super.validate!
       end
 
       def select (*a, &b)
-        x = self.class[super]; x.validate!; x                   # TODO
+        return to_enum :select, *a unless b
+
+        # NB: super returns a Hash; implementing select manually is
+        # problematic b/c new() and []=; this is the simplest (but not
+        # the most efficient -- b/c copying) implementation
+
+        self.class[super]                                       # TODO
       end
 
+      # @return [Hash]
       def to_hash
         Hash[self]
       end
 
     end                                                         # }}}1
 
+    # @todo document
+    class ValidHash < ValidHashBase                             # {{{1
+
+      alias_method  :__validhash__original_replace__, :replace
+      private       :__validhash__original_replace__
+
+      def __validhash__validate_and_rollback__ (c, r)
+        begin
+          validate!; r
+        rescue InvalidError
+          __validhash__original_replace__ c; raise
+        end
+      end
+      private :__validhash__validate_and_rollback__
+
+      TRANSFORMATIONS.each do |m|
+        define_method m do |*a, &b|
+          __validhash__validate_and_rollback__ dup, super(*a, &b)
+        end
+      end
+
+      TRANSFORMATIONS_ENUMERATORS.each do |m|
+        define_method m do |*a, &b|
+          return to_enum m, *a unless b
+          __validhash__validate_and_rollback__ dup, super(*a, &b)
+        end
+      end
+
+    end                                                         # }}}1
+
+    # @todo document
+    class UnsafeValidHash < ValidHashBase                       # {{{1
+
+      TRANSFORMATIONS.each do |m|
+        define_method m do |*a, &b|
+          r = super(*a, &b); validate!; r
+        end
+      end
+
+      TRANSFORMATIONS_ENUMERATORS.each do |m|
+        define_method m do |*a, &b|
+          return to_enum m, *a unless b
+          r = super(*a, &b); validate!; r
+        end
+      end
+
+    end                                                         # }}}1
+
   end
 end
 

data/lib/obfusk/data/{base.rb → valid.rb}

@@ -1,8 +1,8 @@
 # --                                                            ; {{{1
 #
-# File        : obfusk/data/base.rb
+# File        : obfusk/data/valid.rb
 # Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-# Date        : 2013-02-11
+# Date        : 2013-02-13
 #
 # Copyright   : Copyright (C) 2013  Felix C. Stegerman
 # Licence     : GPLv2 or EPLv1
@@ -14,7 +14,10 @@ require 'obfusk/data'
 module Obfusk
   module Data
 
-    module Base
+    # @todo document
+    module Valid
+
+      class InvalidError < RuntimeError; end
 
       def self.included (base)
         base.extend ClassMethods
@@ -35,6 +38,7 @@ module Obfusk
       def validate!
         e = Obfusk::Data.validate self.class::VALIDATOR, self
         raise self.class::InvalidError, e.join('; ') if e
+        self
       end
 
       def valid?

data/lib/obfusk/data/version.rb

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

data/spec/obfusk/data/hamster_spec.rb

@@ -2,7 +2,7 @@
 #
 # File        : obfusk/data/hamster_spec.rb
 # Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-# Date        : 2013-02-11
+# Date        : 2013-02-13
 #
 # Copyright   : Copyright (C) 2013  Felix C. Stegerman
 # Licence     : GPLv2 or EPLv1
@@ -26,7 +26,7 @@ module Obfusk::Data::Hamster__Spec
     end
   end
 
-  E = Obfusk::Data::ValidHamster::InvalidError
+  E = Obfusk::Data::Valid::InvalidError
 
   # --
 
@@ -43,15 +43,15 @@ module Obfusk::Data::Hamster__Spec
         Bar.new some_other_field: 37
       end
       it 'invalid Bar' do
-        expect { Bar.new baz: 42 }.to raise_error E
+        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
+        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
+        expect { b.put :bar, 'hi!' }.to raise_error(E)
       end
     end                                                         # }}}1
 
@@ -64,14 +64,14 @@ module Obfusk::Data::Hamster__Spec
         b.except :maybe
       end
       it 'invalid empty Baz (new)' do
-        expect { Baz.new }.to raise_error E
+        expect { Baz.new }.to raise_error(E)
       end
       it 'invalid empty Baz (empty)' do
-        expect { Baz.empty }.to raise_error E
+        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
+        expect { b.except :baz }.to raise_error(E)
       end
     end                                                         # }}}1
 

data/spec/obfusk/data/hash_spec.rb

@@ -2,7 +2,7 @@
 #
 # File        : obfusk/data/hash_spec.rb
 # Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-# Date        : 2013-02-11
+# Date        : 2013-02-13
 #
 # Copyright   : Copyright (C) 2013  Felix C. Stegerman
 # Licence     : GPLv2 or EPLv1
@@ -20,12 +20,14 @@ module Obfusk::Data::Hash__Spec
   end
 
   class Baz < Obfusk::Data::ValidHash
-    data do
-      field :baz, []
-    end
+    data { field :baz, [] }
+  end
+
+  class Qux < Obfusk::Data::UnsafeValidHash
+    data { field :qux, [] }
   end
 
-  E = Obfusk::Data::ValidHash::InvalidError
+  E = Obfusk::Data::Valid::InvalidError
 
   # --
 
@@ -42,22 +44,42 @@ module Obfusk::Data::Hash__Spec
         Bar.new some_other_field: 37
       end
       it 'invalid Bar' do
-        expect { Bar.new baz: 42 }.to raise_error E
+        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
+        expect { b.merge baz: 42 }.to raise_error(E)
+        b.should be_valid
       end
       it 'invalid Bar []=' do
         b = Bar.new
-        expect { b[:bar] = 'hi!' }.to raise_error E
+        expect { b[:bar] = 'hi!' }.to raise_error(E)
+        b.should be_valid
       end
     end                                                         # }}}1
 
     context 'Baz' do                                            # {{{1
       it 'invalid Baz clear' do
         b = Baz.new baz: 'ok'
-        expect { b.clear }.to raise_error E
+        expect { b.clear }.to raise_error(E)
+        b.should be_valid
+      end
+      it 'invalid Baz reject!' do
+        b = Baz.new baz: 'ok'
+        f = b.reject!
+        expect { f.each { true } }.to raise_error(E)
+        b[:baz].should == 'ok'
+        b.should be_valid
+      end
+    end                                                         # }}}1
+
+    context 'Qux' do                                            # {{{1
+      it 'invalid Qux reject!' do
+        q = Qux.new qux: 'ok'
+        f = q.reject!
+        expect { f.each { true } }.to raise_error(E)
+        q.should be_empty
+        q.should_not be_valid
       end
     end                                                         # }}}1
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: obfusk-data
 version: !ruby/object:Gem::Version
-  version: 0.0.2.SNAPSHOT.20130212031255
+  version: 0.0.2.SNAPSHOT.20130213231507
   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: &20985220 !ruby/object:Gem::Requirement
+  requirement: &19084200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *20985220
+  version_requirements: *19084200
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &20928520 !ruby/object:Gem::Requirement
+  requirement: &19083580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *20928520
+  version_requirements: *19083580
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &20927780 !ruby/object:Gem::Requirement
+  requirement: &19082880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *20927780
+  version_requirements: *19082880
 description: ! '...
 
 '
@@ -59,7 +59,7 @@ files:
 - lib/obfusk/data/hamster.rb
 - lib/obfusk/data/version.rb
 - lib/obfusk/data/hash.rb
-- lib/obfusk/data/base.rb
+- lib/obfusk/data/valid.rb
 - lib/obfusk/data.rb
 - spec/_data.rb
 - spec/obfusk/data/hash_spec.rb