osteele-jcon 0.1.0

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2008 Oliver Steele
+
+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.rdoc

@@ -0,0 +1,46 @@
+= JCon -- JavaScript Type Conformance Checking
+
+JCON (the "JavaScript Conformance" gem), is a companion to JSON.  It
+tests JSON values against ECMAScript 4.0-style type definitions
+(PDF[http://www.ecmascript.org/es4/spec/overview.pdf]), such as
+<code>string?</code>, <code>(int, boolean)</code>, or <code>[string, (int, boolean), {x:double, y:double}?]</code>.
+
+JCON also defines an RSpec matcher, <code>conforms_to_js</code>.
+
+Use JCON together with the {JavaScript
+Fu Rails plugin}[http://osteele.com/archives/2008/04/javascript-fu-rails-plugin] to test the argument values in generated JavaScript function calls.
+
+
+== Install
+
+  gem install rcon
+
+== Usage
+
+  type = JCON::parse "[string, int]"
+  type.contains?(['a', 1]) # => true
+  type.contains?(['a', 'b']) # => false
+  type.contains?(['a', 1, 2]) # => true
+  
+  type = JCON::parse "type S = (string, int); {a: [S], b: int}"
+  type.contains?({:a => [1, 'b'], :b => 2}) # => true
+
+== RSpec Matcher
+
+  [1, 'xyzzy'].should conform_to_js('[int, string]')
+  [1, 2, 'xyzzy'].should_not conform_to_js('[int, string]')
+  {:x => 1}.should conform_to_js('{x: int}')
+
+Use this with the {JavaScript Fu Rails plugin}[http://osteele.com/archives/2008/04/javascript-fu-rails-plugin] to test JSON arguments:
+
+  '<script>fn("id", {x:1, y:2}, true)</script>'.should call_js('fn') do |args|
+    args[0].should conform_to_js('string')
+    args[1].should conform_to_js('{x:int, y:int}')
+    args[2].should conform_to_js('boolean')
+    # or:
+    args.should conform_to_js('[string, {x:int, y:int}, boolean]')
+  end
+
+== License
+
+Copyright 2008 by {Oliver Steele}[http://workingwithrails.com/person/12359-oliver-steele].  All rights reserved.  Released under the MIT License.

data/TODO

@@ -0,0 +1,26 @@
+= JCon TODO
+
+Next:
+* docs -- add the README
+* check the spec
+* add method to display path to mismatch
+* rename SimpleType
+
+Error detection:
+* circular references
+* duplicate definitions
+
+Test cases:
+* recursive types
+
+Parser:
+* can property name be string?
+
+Conformance:
+* byte
+
+Future:
+* function(this:T | T | T= | ... | ...[T]) : T | void
+* 'class'
+* js implementation
+* includes

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: osteele-jcon
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Oliver Steele
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-22 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Test JSON values for conformance with ECMAScript 4.0 types.
+email: steele@osteele.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- TODO
+- LICENSE
+files: 
+- README.rdoc
+- TODO
+- LICENSE
+has_rdoc: true
+homepage: http://jcon.rubyforge.org
+post_install_message: 
+rdoc_options: 
+- --title
+- "JCON: Test JSON values against a schema"
+- --main
+- README
+- --exclude
+- spec/.*
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: jcon
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Test JSON values against a schema.
+test_files: []
+