schema 0.0.2 → 0.0.3

data/README.md

@@ -9,13 +9,27 @@ Schema is a mechanism for enforcing schemas for ruby hashes. Type conversions ar
     
 ### Schemas
 
-A Schema is either a type that implements `#from` or a hash of schemas or an array with a schema as it's singgle element.
+A Schema is either a type that implements `#from` or a hash of schemas or an array with a schema as it's single element.
 
     Float # is a schema
     [Float] # is a schema
     { :string => String } # is a schema
     { :foo => [{ :bar => DateTime }]} # is a schema
 
+In Hash-schemas keys may be optional indicated by a trailing question mark.
+
+    { :optional => '42' }.transform({ :optional? => Float }) == { :optional => 42.0 }
+    {}.transform({ :optional? => Float }) == {}
+
+This also enables circular schemas (for eg. trees)
+
+    schema = { :value => Float }
+    schema.update { :children? => [schema] }
+
+### Issues
+
+- Works only for symbol keys. Not yet sure if this is a bug or a feature...
+
 ### Note on Patches/Pull Requests
  
 * Fork the project.

data/lib/schema/schema.rb

@@ -20,7 +20,12 @@ module Schema
     when Hash
       raise ArgumentError, "A #{schema.class} is no valid schema for a #{object.class}." unless object.is_a?(Hash)
       schema.inject({}) do |h, (key, subschema)|
-        h.update(key => object[key].transform(subschema))
+        if key.to_s =~ /^(.*)\?$/
+          optionalkey = $1.to_sym
+          h.update(object[optionalkey] ? { optionalkey => object[optionalkey].transform(subschema) } : {})
+        else
+          h.update(key => object[key].transform(subschema))
+        end
       end
     else
       schema.from(object)

data/lib/schema/version.rb

@@ -1,3 +1,3 @@
 module Schema
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/schema.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{schema}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Daniel Kirsch"]
-  s.date = %q{2010-12-01}
+  s.date = %q{2010-12-06}
   s.description = %q{Deep type conversion through schemas for hashes}
   s.email = %q{danishkirel@gmail.com}
   s.extra_rdoc_files = [

data/spec/schema_spec.rb

@@ -48,6 +48,35 @@ describe "Schema" do
       { :nested => [{ :hash => 42 }] }    
   end
   
+  ### optional keys in schemas
+  
+  it "should allow optional keys in schemas" do
+    schema = { :optional? => Float }
+    { :optional => '42' }.transform(schema).should == { :optional => 42.0 }
+    {}.transform(schema).should == {}
+  end
+
+  it "should cast circular schemas" do
+    schema = { :float => Float }
+    schema.update :circular? => schema # circular schemas _MUST_ be optional
+    
+    { :float => '42', :circular => { :float => '17' } }.transform(schema).should ==
+      { :float => 42.0, :circular => { :float => 17.0 } }
+  end
+
+  it "should cast circular schemas with arrays" do
+    schema = { :float => Float }
+    schema.update :circular? => [schema] # circular schemas _MUST_ be optional
+    
+    { :float => '42', :circular => { :float => '17' } }.transform(schema).should ==
+      { :float => 42.0, :circular => [{ :float => 17.0 }] }
+
+    { :float => '42', :circular => [{ :float => '17' }, { :float => '23' }] }.transform(schema).should ==
+      { :float => 42.0, :circular => [{ :float => 17.0 }, { :float => 23.0 }] }
+  end
+  
+  ### how to cope with non-present keys
+  
   it "should erase keys not present in the schema" do
     {:not => 'present'}.transform({}).should == {}
   end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Daniel Kirsch
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-01 00:00:00 +01:00
+date: 2010-12-06 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency