schema 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Daniel Kirsch
+
+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/README.md

@@ -0,0 +1,31 @@
+# Schema
+
+Schema is a mechanism for enforcing schemas for ruby hashes. Type conversions are specified in a schema-hash and applied to a hash that shall be transformed.
+
+### SYNOPSIS
+
+    Schema.transform({:float => '42', :array_of_strings => 23}, {:float => Float, :array_of_strings => [String]})
+    # => {:float => 42.0, :array_of_strings => ['23']}
+    
+### 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.
+
+    Float # is a schema
+    [Float] # is a schema
+    { :string => String } # is a schema
+    { :foo => [{ :bar => DateTime }]} # is a schema
+
+### Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+### Copyright
+
+Copyright (c) 2010 Daniel Kirsch. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  require './lib/schema/version'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "schema"
+    gem.summary = %Q{Schemas for hashes}
+    gem.description = %Q{Deep type conversion through schemas for hashes}
+    gem.email = "danishkirel@gmail.com"
+    gem.homepage = "http://github.com/kirel/schema"
+    gem.authors = ["Daniel Kirsch"]
+    gem.add_development_dependency "rspec", "~> 2.2"
+    gem.add_development_dependency "yard", ">= 0"
+    gem.version = Schema::VERSION    
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :spec => :check_dependencies
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/lib/schema.rb

@@ -0,0 +1,4 @@
+require 'schema/version'
+require 'schema/schema'
+require 'schema/core_ext'
+require 'schema/include'

data/lib/schema/core_ext.rb

@@ -0,0 +1,31 @@
+require 'date'
+
+class Float
+  def self.from val
+    val.to_f
+  end
+end
+
+class Integer
+  def self.from val
+    val.to_i
+  end
+end
+
+class String
+  def self.from val
+    val.to_s
+  end
+end
+
+class Date
+  def self.from val
+    parse val
+  end
+end
+
+class DateTime
+  def self.from val
+    parse val
+  end
+end

data/lib/schema/include.rb

@@ -0,0 +1,9 @@
+module Schema
+  module Include
+    # Include this module into Object to have a handy #transform on every object.
+    # Then object.transform(schema) is like calling Schema.transform(object, schema).
+    def transform schema
+      Schema.transform self, schema
+    end
+  end
+end

data/lib/schema/schema.rb

@@ -0,0 +1,29 @@
+module Schema
+  # transform
+  # @param object The object to be transformed.
+  # @param schema A valid schema. For hashes only hashes and for arrays only arrays are valid schemas.
+  #   For everything else either a type (e.g. <tt>Float</tt>)
+  #   or an Array with a single type element (e.g. <tt>[String]</tt>) is a valid Schema.
+  def self.transform object, schema
+    case schema
+    when Array
+      raise ArgumentError, "An empty Array is not a valid schema." unless schema.first
+      # for now we only transform into the first schema-array element
+      case object
+      when nil
+        []
+      when Array
+        object.map { |e| e.transform(schema.first) }
+      else
+        [object.transform(schema.first)]
+      end
+    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))
+      end
+    else
+      schema.from(object)
+    end
+  end  
+end

data/lib/schema/version.rb

@@ -0,0 +1,3 @@
+module Schema
+  VERSION = '0.0.1'
+end

data/spec/schema_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+Object.send :include, Schema::Include
+
+describe "Schema" do
+
+  it "should cast simple types" do
+    42.transform(String).should == '42'
+    42.transform(String).should be_kind_of(String)
+    '42'.transform(Float).should == 42.0
+    '42'.transform(Float).should be_kind_of(Float)
+    '42'.transform(Integer).should == 42
+    '42'.transform(Integer).should be_kind_of(Integer)
+  end
+  
+  it "should cast dates" do
+    '2010-12-01T12:00:00+01:00'.transform(DateTime).should == DateTime.parse('2010-12-01T12:00:00+01:00')
+    '2010-12-01'.transform(Date).should == Date.parse('2010-12-01')
+  end
+  
+  it "should cast hashes of simple types" do
+    {:string => 'string'}.transform({:string => String}).should == {:string => 'string'}
+    {:float => '42'}.transform({:float => Float}).should == {:float => 42.0}
+    {:integer => '42'}.transform({:integer => Integer}).should == {:integer => 42}
+  end
+  
+  it "should cast arrays" do
+    {}.transform({:float => [Float]}).should == {:float => []}
+    {:float => '42'}.transform({:float => [Float]}).should == {:float => [42.0]}
+    {:float => ['42']}.transform({:float => [Float]}).should == {:float => [42.0]}
+    {:float => ['42','13']}.transform({:float => [Float]}).should == {:float => [42.0, 13.0]}
+  end
+  
+  it "should cast nested hashes" do
+    { :nested => { :hash => '42' } }.transform({ :nested => { :hash => Integer } }).should ==
+      { :nested => { :hash => 42 } }
+  end
+  
+  it "should cast nested arrays of simple types" do
+    { :nested => { :hash => '42' } }.transform({ :nested => { :hash => [Integer] } }).should ==
+      { :nested => { :hash => [42] } }    
+  end
+
+  it "should cast nested arrays of hashes" do
+    { :nested => { :hash => '42' } }.transform({ :nested => [{ :hash => Integer }] }).should ==
+      { :nested => [{ :hash => 42 }] }    
+  end
+  
+  it "should erase keys not present in the schema" do
+    {:not => 'present'}.transform({}).should == {}
+  end
+  
+  ### misuse
+  
+  it "should not allow non hash transform with hash" do
+    lambda { 42.transform({}) }.should raise_error(ArgumentError)
+  end
+  
+  it "should not allow an empty array as schema" do
+    lambda { 42.transform([]) }.should raise_error(ArgumentError)
+  end
+  
+  # it "should not cast arrays to simple types" do
+  #   lambda { [].transform([]) }.should raise_error(ArgumentError)
+  # end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'schema'
+require 'rspec'

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: schema
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Daniel Kirsch
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-01 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 2
+        version: "2.2"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Deep type conversion through schemas for hashes
+email: danishkirel@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- LICENSE
+- README.md
+- Rakefile
+- autotest/discover.rb
+- lib/schema.rb
+- lib/schema/core_ext.rb
+- lib/schema/include.rb
+- lib/schema/schema.rb
+- lib/schema/version.rb
+- spec/schema_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/kirel/schema
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Schemas for hashes
+test_files: 
+- spec/schema_spec.rb
+- spec/spec_helper.rb