jsexp 1.0.0

data/README.md

@@ -0,0 +1,48 @@
+jsexp
+=====
+
+json schemas with s-expressions
+
+This is a tool to do common json validations. `jsexp` factors out validations into a schema.
+
+Unlike [JSON Schema](http://tools.ietf.org/html/draft-zyp-json-schema-03), `jsexp` is not written in json and does not specify media types.
+
+Example
+-------
+
+    schema = { 
+      'name' => String, # case expression
+      'email' => /@/, # case expression
+      'p' => (0.0..1.0), # case expression
+      'id' => [:range, [0, :inf]], # indefinite range
+      'color' => [:enum, ['red', 'green', 'blue']], # enum
+      'offset' => [:tuple, [Float, Float]], # exact-size array
+      'samples' => [:array, [:tuple, [Float, Float]]] # indefinite array
+      'description' => [:optional, String] # optional field
+    }
+    obj = {
+      'name' => '',
+      'email' => 'user@example.com',
+      'p' => 0.5,
+      'id' => 0,
+      'color' => 'red',
+      'offset' => [0.0, 0.0],
+      'samples' => [
+        [0.0, 0.0],
+        [0.0, 0.0]
+      ]
+    }
+
+    puts JSExp.valid?(schema, obj)
+    # true
+
+Non-features
+------------
+
+ -  default values: use defaults.merge(input) prior to validation
+ -  string length bounds: use /^.{3,5}$/
+ -  array/map size bounds
+ -  key expressions
+ -  nested schemas: This is a source of arbitrary complexity.
+ -  specific error messages: Refer to the schema to see what's wrong.
+ -  lambdas: Do more complex validation yourself.

data/examples/example.rb

@@ -0,0 +1,26 @@
+require 'jsexp'
+
+schema = { 
+  'name' => String,
+  'email' => /@/,
+  'p' => (0.0..1.0),
+  'id' => [:range, [0, :inf]],
+  'color' => [:enum, ['red', 'green', 'blue']],
+  'offset' => [:tuple, [Float, Float]],
+  'samples' => [:array, [:tuple, [Float, Float]]],
+  'description' => [:optional, String]
+}
+obj = {
+  'name' => '',
+  'email' => 'user@example.com',
+  'p' => 0.5,
+  'id' => 0,
+  'color' => 'red',
+  'offset' => [0.0, 0.0],
+  'samples' => [
+    [0.0, 0.0],
+    [0.0, 0.0]
+  ]
+}
+
+puts JSExp.valid?(schema, obj)

data/lib/jsexp.rb

@@ -0,0 +1,35 @@
+module JSExp
+
+def JSExp.valid?(schema, obj)
+  if schema.is_a?(Hash)
+    obj.is_a?(Hash) && schema.map {|key, schema_| 
+      if schema_.is_a?(Array) && schema_[0] == :optional
+        !obj.key?(key) || valid?(schema_[1], obj[key])
+      else
+        obj.key?(key) && valid?(schema_, obj[key])
+      end
+    }.all?
+  elsif schema.is_a?(Array)
+    case schema[0]
+    when :array
+      obj.is_a?(Array) && obj.map {|x| valid?(schema[1], x)}.all?
+    when :enum
+      schema[1].include?(obj)
+    when :range
+      min, max = schema[1]
+      (min == :inf ? true : obj.class == min.class && obj >= min) && 
+      (max == :inf ? true : obj.class == max.class && obj <= max)
+    when :tuple
+      obj.is_a?(Array) && obj.size == schema[1].size && schema[1].each_index.map {|i| valid?(schema[1][i], obj[i])}.all?
+    end
+  else
+    case obj
+    when schema
+      true
+    else
+      false
+    end
+  end
+end
+
+end

data/test/jsexp_test.rb

@@ -0,0 +1,64 @@
+$:.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
+require 'jsexp'
+require 'minitest/autorun'
+
+describe JSExp do
+  it 'validates case expressions' do
+    JSExp.valid?(String, '').must_equal true
+    JSExp.valid?(String, 0).must_equal false
+
+    JSExp.valid?(Integer, 0).must_equal true
+    JSExp.valid?(Integer, 0.0).must_equal false
+
+    JSExp.valid?(Float, 0.0).must_equal true
+    JSExp.valid?(Float, 0).must_equal false
+
+    JSExp.valid?(/@/, 'user@example.com').must_equal true
+    JSExp.valid?(/@/, '').must_equal false
+
+    JSExp.valid?((0..10), 5).must_equal true
+    JSExp.valid?((0..10), 11).must_equal false
+
+    JSExp.valid?((0.0..1.0), 0.5).must_equal true
+    JSExp.valid?((0.0..1.0), 1.1).must_equal false
+  end
+
+  it 'validates indefinite arrays' do
+    JSExp.valid?([:array, Integer], []).must_equal true
+    JSExp.valid?([:array, Integer], [0]).must_equal true
+    JSExp.valid?([:array, Integer], [0, 0]).must_equal true
+    JSExp.valid?([:array, Integer], [0.0]).must_equal false
+    JSExp.valid?([:array, Integer], [0, 0.0]).must_equal false
+  end
+
+  it 'validates enums' do
+    JSExp.valid?([:enum, ['red', 'green', 'blue']], 'red').must_equal true
+  end
+
+  it 'validates optional fields' do
+    schema = {
+      'id' => [:optional, String]
+    }
+    JSExp.valid?(schema, {}).must_equal true
+    JSExp.valid?(schema, {'id' => ''}).must_equal true
+    JSExp.valid?(schema, {'id' => 0}).must_equal false
+  end
+
+  it 'validates indefinite ranges' do
+    JSExp.valid?([:range, [0, :inf]], 0).must_equal true
+    JSExp.valid?([:range, [0, :inf]], -1).must_equal false
+    JSExp.valid?([:range, [0, :inf]], 0.0).must_equal false
+
+    JSExp.valid?([:range, [:inf, 0]], 0).must_equal true
+    JSExp.valid?([:range, [:inf, 0]], 1).must_equal false
+
+    JSExp.valid?([:range, [:inf, :inf]], 0).must_equal true
+  end
+
+  it 'validates tuples' do
+    JSExp.valid?([:tuple, [Integer, Float]], [0, 0.0]).must_equal true
+    JSExp.valid?([:tuple, [Integer, Float]], 0).must_equal false
+    JSExp.valid?([:tuple, [Integer, Float]], [0]).must_equal false
+    JSExp.valid?([:tuple, [Integer, Float]], [0, 0.0, 0]).must_equal false
+  end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: jsexp
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Matthew King
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-23 00:00:00.000000000 Z
+dependencies: []
+description: json schemas with s-expressions
+email: matthew.y.king@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- examples/example.rb
+- lib/jsexp.rb
+- test/jsexp_test.rb
+homepage: http://github.com/mking/jsexp
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: json schemas
+test_files:
+- test/jsexp_test.rb