autoparse 0.2.3 → 0.3.0

data/CHANGELOG

@@ -1,3 +1,9 @@
+== 0.3.0
+
+* fixed handling of additional properties w/ a set schema
+* modified index methods to allow either raw or parsed access
+* modified index methods to default to parsed access
+
 == 0.2.3
 
 * fixed stupid bug in inspect method

data/lib/autoparse.rb

@@ -46,6 +46,11 @@ module AutoParse
       def self.additional_properties_schema
         # Override the superclass implementation so we're not always returning
         # the empty schema.
+        if @additional_properties_schema.data['$ref']
+          # Dereference the schema if necessary.
+          @additional_properties_schema =
+            @additional_properties_schema.dereference
+        end
         return @additional_properties_schema
       end
 
@@ -81,89 +86,50 @@ module AutoParse
           schema_data['additionalProperties'] == nil
         # Schema-less unknown properties are allowed.
         @additional_properties_schema = EMPTY_SCHEMA
-        define_method('method_missing') do |method, *params, &block|
-          # We need to convert from Ruby calling style to JavaScript calling
-          # style. If this fails, attempt to use JavaScript calling style
-          # directly.
-
-          # We can't modify the method in-place because this affects the call
-          # to super.
-          stripped_method = method.to_s
-          assignment = false
-          if stripped_method[-1..-1] == '='
-            assignment = true
-            stripped_method[-1..-1] = ''
-          end
-          key = INFLECTOR.camelize(stripped_method)
-          key[0..0] = key[0..0].downcase
-          if self[key] != nil
-            value = self[key]
-          elsif self[stripped_method] != nil
-            key = stripped_method
-            value = self[stripped_method]
-          else
-            # Method not found.
-            super(method, *params, &block)
-          end
-          # If additionalProperties is simply set to true, no parsing takes
-          # place and all values are treated as 'any'.
-          if assignment
-            new_value = params[0]
-            self[key] = new_value
-          else
-            value
-          end
-        end
-
       elsif schema_data['additionalProperties']
         # Unknown properties follow the supplied schema.
         ap_schema = AutoParse.generate(
           schema_data['additionalProperties'], :parent => self
         )
         @additional_properties_schema = ap_schema
-        define_method('method_missing') do |method, *params, &block|
-          # We need to convert from Ruby calling style to JavaScript calling
-          # style. If this fails, attempt to use JavaScript calling style
-          # directly.
-
-          # We can't modify the method in-place because this affects the call
-          # to super.
-          stripped_method = method.to_s
-          assignment = false
-          if stripped_method[-1..-1] == '='
-            assignment = true
-            stripped_method[-1..-1] = ''
-          end
-          key = INFLECTOR.camelize(stripped_method)
-          key[0..0] = key[0..0].downcase
-          if self[key] != nil
-            value = self[key]
-          elsif self[stripped_method] != nil
-            key = stripped_method
-            value = self[stripped_method]
-          else
-            # Method not found.
-            super
-          end
-          if assignment
-            # In the case of assignment, it's very likely the developer is
-            # passing in an unparsed Hash value. This value must be parsed.
-            # Unfortunately, we may accidentally reparse something that's
-            # already in a parsed state because Schema.new(Schema.new(data))
-            # is completely valid. This will cause performance issues if
-            # developers are careless, but since there's no good reason to
-            # do assignment on parsed objects, hopefully this should not
-            # cause problems often.
-            new_value = params[0]
-            self[key] = ap_schema.new(new_value)
-          else
-            ap_schema.new(value)
-          end
-        end
       else
         @additional_properties_schema = nil
       end
 
+      define_method('method_missing') do |method, *params, &block|
+        # We need to convert from Ruby calling style to JavaScript calling
+        # style. If this fails, attempt to use JavaScript calling style
+        # directly.
+
+        # We can't modify the method in-place because this affects the call
+        # to super.
+        stripped_method = method.to_s
+        assignment = false
+        if stripped_method[-1..-1] == '='
+          assignment = true
+          stripped_method[-1..-1] = ''
+        end
+        key = INFLECTOR.camelize(stripped_method)
+        key[0..0] = key[0..0].downcase
+        if @data[key] != nil
+          # Data found
+        elsif @data[stripped_method] != nil
+          # Data found
+          key = stripped_method
+        else
+          # Method not found.
+          super(method, *params, &block)
+        end
+        # If additionalProperties is simply set to true, no parsing takes
+        # place and all values are treated as 'any'.
+        if assignment
+          new_value = params[0]
+          self.__set__(key, new_value)
+        else
+          self.__get__(key)
+        end
+      end
+
       if schema_data['dependencies']
         for dependency_key, dependency_data in schema_data['dependencies']
           self.property_dependencies[dependency_key] = dependency_data

data/lib/autoparse/instance.rb

@@ -84,11 +84,11 @@ module AutoParse
     end
 
     def self.data
-      return @schema_data
+      return @schema_data ||= {}
     end
 
     def self.description
-      return @schema_data['description']
+      return self.data['description']
     end
 
     def self.validate_string_property(property_value, schema_data)
@@ -323,47 +323,66 @@ module AutoParse
     end
 
     def __get__(property_name)
-      property_key = self.class.keys[property_name]
+      property_key = self.class.keys[property_name] || property_name
 
       schema_class = self.class.properties[property_key]
+      schema_class = self.class.additional_properties_schema if !schema_class
       if !schema_class
-        raise TypeError,
-          "Missing property schema for '#{property_key}'."
-      end
-      if schema_class.data['$ref']
-        # Dereference the schema if necessary.
-        schema_class = schema_class.dereference
-        # Avoid this dereference in the future.
-        self.class.properties[property_key] = schema_class
-      end
+        @data[property_key]
+      else
+        if schema_class.data['$ref']
+          # Dereference the schema if necessary.
+          schema_class = schema_class.dereference
+          # Avoid this dereference in the future.
+          self.class.properties[property_key] = schema_class
+        end
 
-      value = self[property_key] || schema_class.data['default']
+        value = @data[property_key] || schema_class.data['default']
 
-      AutoParse.import(value, schema_class)
+        AutoParse.import(value, schema_class)
+      end
     end
     protected :__get__
 
     def __set__(property_name, value)
-      property_key = self.class.keys[property_name]
+      property_key = self.class.keys[property_name] || property_name
 
       schema_class = self.class.properties[property_key]
-      if schema_class.data['$ref']
-        # Dereference the schema if necessary.
-        schema_class = schema_class.dereference
-        # Avoid this dereference in the future.
-        self.class.properties[property_key] = schema_class
-      end
+      schema_class = self.class.additional_properties_schema if !schema_class
+      if !schema_class
+        @data[property_key] = value
+      else
+        if schema_class.data['$ref']
+          # Dereference the schema if necessary.
+          schema_class = schema_class.dereference
+          # Avoid this dereference in the future.
+          self.class.properties[property_key] = schema_class
+        end
 
-      self[property_key] = AutoParse.export(value, schema_class)
+        @data[property_key] = AutoParse.export(value, schema_class)
+      end
     end
     protected :__set__
 
-    def [](key)
-      return @data[key]
+    def [](key, raw=false)
+      if raw == true
+        return @data[key]
+      else
+        return self.__get__(key)
+      end
     end
 
-    def []=(key, value)
-      return @data[key] = value
+    def []=(key, raw=false, value=:undefined)
+      if value == :undefined
+        # Due to the way Ruby handles default values in assignment methods,
+        # we have to swap some values around here.
+        raw, value = false, raw
+      end
+      if raw == true
+        return @data[key] = value
+      else
+        return self.__set__(key, value)
+      end
     end
 
     ##
@@ -371,7 +390,7 @@ module AutoParse
     def valid?
       unvalidated_fields = @data.keys.dup
       for property_key, schema_class in self.class.properties
-        property_value = self[property_key]
+        property_value = @data[property_key]
         if !self.class.validate_property_value(
             property_value, schema_class.data)
           return false
@@ -388,7 +407,7 @@ module AutoParse
         when String, Array
           property_dependencies = [property_dependencies].flatten
           for dependency_key in property_dependencies
-            dependency_value = self[dependency_key]
+            dependency_value = @data[dependency_key]
             return false if dependency_value == nil
           end
         when Class
@@ -406,9 +425,13 @@ module AutoParse
         return false unless unvalidated_fields.empty?
       elsif self.class.additional_properties_schema != EMPTY_SCHEMA
         # Validate all remaining fields against this schema
-
-        # Make sure tests don't pass prematurely
-        return false
+        for property_key in unvalidated_fields
+          property_value = @data[property_key]
+          if !self.class.additional_properties_schema.validate_property_value(
+              property_value, self.class.additional_properties_schema.data)
+            return false
+          end
+        end
       end
       if self.class.superclass && self.class.superclass != Instance &&
           self.class.ancestors.first != Instance

data/lib/autoparse/version.rb

@@ -17,8 +17,8 @@ unless defined? AutoParse::VERSION
   module AutoParse
     module VERSION
       MAJOR = 0
-      MINOR = 2
-      TINY  = 3
+      MINOR = 3
+      TINY  = 0
 
       STRING = [MAJOR, MINOR, TINY].join('.')
     end

data/spec/autoparse/instance_spec.rb

@@ -482,6 +482,184 @@ describe AutoParse::Instance, 'with the adult schema' do
   end
 end
 
+describe AutoParse::Instance, 'with the user list schema' do
+  before do
+    @person_uri = Addressable::URI.new(
+      :scheme => 'file',
+      :host => '',
+      :path => File.expand_path(File.join(spec_dir, './data/person.json'))
+    )
+    @person_schema_data =
+      JSON.parse(File.open(@person_uri.path, 'r') { |f| f.read })
+    @person_parser = AutoParse.generate(
+      @person_schema_data, :uri => @person_uri
+    )
+
+    @user_list_uri = Addressable::URI.new(
+      :scheme => 'file',
+      :host => '',
+      :path => File.expand_path(File.join(spec_dir, './data/user-list.json'))
+    )
+    @user_list_schema_data =
+      JSON.parse(File.open(@user_list_uri.path, 'r') { |f| f.read })
+    @user_list_parser = AutoParse.generate(
+      @user_list_schema_data, :uri => @user_list_uri
+    )
+  end
+
+  it 'should have the correct URI' do
+    @user_list_parser.uri.should === @user_list_uri
+  end
+
+  it 'should accept a valid person input' do
+    instance = @user_list_parser.new({
+      "users" => {
+        "bobaman@google.com" => {
+          "name" => "Bob Aman",
+          "age" => 29
+        }
+      }
+    })
+    instance.should be_valid
+  end
+
+  it 'should accept extra fields' do
+    instance = @user_list_parser.new({
+      "users" => {
+        "bobaman@google.com" => {
+          "name" => "Bob Aman",
+          "age" => 29,
+          "extra" => "bonus!"
+        }
+      },
+      "extra" => "bonus!"
+    })
+    instance.should be_valid
+  end
+
+  it 'should not accept additional properties that do not validate' do
+    instance = @user_list_parser.new({
+      "users" => {
+        "bobaman@google.com" => {
+          "name" => "Bob Aman",
+          "age" => 29
+        },
+        "oldguy@example.com" => {
+          "name" => "Methuselah",
+          "age" => 969
+        }
+      }
+    })
+    instance.should_not be_valid
+  end
+
+  it 'should not accept additional properties that do not validate' do
+    instance = @user_list_parser.new({
+      "users" => {
+        "bobaman@google.com" => {
+          "name" => "Bob Aman",
+          "age" => 29.7
+        }
+      }
+    })
+    instance.should_not be_valid
+  end
+
+  it 'should expose values via generated accessors' do
+    instance = @user_list_parser.new({
+      "users" => {
+        "bobaman@google.com" => {
+          "name" => "Bob Aman",
+          "age" => 29
+        }
+      }
+    })
+    instance.users['bobaman@google.com'].name.should == "Bob Aman"
+    instance.users['bobaman@google.com'].age.should == 29
+  end
+
+  it 'should permit access to raw values' do
+    instance = @user_list_parser.new({
+      "users" => {
+        "bobaman@google.com" => {
+          "name" => "Bob Aman",
+          "age" => 29
+        }
+      }
+    })
+    instance.users['bobaman@google.com', true].should == {
+      "name" => "Bob Aman",
+      "age" => 29
+    }
+  end
+
+  it 'should alter output structure via generated mutators' do
+    instance = @user_list_parser.new
+    instance.users = {}
+    instance.users["bobaman@google.com"] = @person_parser.new
+    instance.users["bobaman@google.com"].name = "Bob Aman"
+    instance.users["bobaman@google.com"].age = 29
+    instance.to_hash.should == {
+      "users" => {
+        "bobaman@google.com" => {
+          "name" => "Bob Aman",
+          "age" => 29
+        }
+      }
+    }
+  end
+
+  it 'should allow raw assignment' do
+    instance = @user_list_parser.new
+    instance.users = {}
+    instance.users["bobaman@google.com", true] = {
+      "name" => "Bob Aman",
+      "age" => 29
+    }
+    instance.to_hash.should == {
+      "users" => {
+        "bobaman@google.com" => {
+          "name" => "Bob Aman",
+          "age" => 29
+        }
+      }
+    }
+  end
+
+  it 'should be coerceable to a Hash value' do
+    instance = @user_list_parser.new({
+      "users" => {
+        "bobaman@google.com" => {
+          "name" => "Bob Aman",
+          "age" => 29
+        }
+      }
+    })
+    instance.to_hash.should == {
+      "users" => {
+        "bobaman@google.com" => {
+          "name" => "Bob Aman",
+          "age" => 29
+        }
+      }
+    }
+  end
+
+  it 'should convert to a JSON string' do
+    instance = @user_list_parser.new({
+      "users" => {
+        "bobaman@google.com" => {
+          "name" => "Bob Aman",
+          "age" => 29
+        }
+      }
+    })
+    instance.to_json.should == (
+      '{"users":{"bobaman@google.com":{"name":"Bob Aman","age":29}}}'
+    )
+  end
+end
+
 describe AutoParse::Instance, 'with the positive schema' do
   before do
     @positive_uri = Addressable::URI.new(
@@ -661,6 +839,21 @@ describe AutoParse::Instance, 'with the card schema' do
     @card_parser.uri.should === @card_uri
   end
 
+  it 'should allow nested objects to be accessed in raw' do
+    instance = @card_parser.new({
+      "givenName" => "Robert",
+      "familyName" => "Aman",
+      "org" => {
+        "organizationName" => "Google, Inc.",
+        "organizationUnit" => "Developer Relations"
+      }
+    })
+    instance['org', true].should == {
+      "organizationName" => "Google, Inc.",
+      "organizationUnit" => "Developer Relations"
+    }
+  end
+
   it 'should have the correct URI for anonymous nested objects' do
     instance = @card_parser.new({
       "givenName" => "Robert",

data/spec/data/user-list.json

@@ -0,0 +1,12 @@
+{
+  "description": "A mapping of users.",
+  "type": "object",
+  "properties": {
+    "users": {
+      "type": "object",
+      "additionalProperties": {
+        "$ref": "person.json"
+      }
+    }
+  }
+}

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: autoparse
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 19
+  prerelease: 
   segments: 
   - 0
-  - 2
   - 3
-  version: 0.2.3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Bob Aman
@@ -14,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-21 00:00:00 +03:00
-default_executable: 
+date: 2011-11-10 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: addressable
@@ -25,6 +25,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 2
         - 2
@@ -40,6 +41,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 11
         segments: 
         - 1
         - 4
@@ -55,6 +57,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 37
         segments: 
         - 0
         - 9
@@ -70,6 +73,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 57
         segments: 
         - 0
         - 8
@@ -85,6 +89,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 23
         segments: 
         - 2
         - 6
@@ -100,6 +105,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 23
         segments: 
         - 0
         - 3
@@ -115,6 +121,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 23
         segments: 
         - 1
         - 1
@@ -154,6 +161,7 @@ files:
 - spec/data/person.json
 - spec/data/positive.json
 - spec/data/schema.json
+- spec/data/user-list.json
 - spec/spec.opts
 - spec/spec_helper.rb
 - tasks/clobber.rake
@@ -169,7 +177,6 @@ files:
 - LICENSE
 - Rakefile
 - README.md
-has_rdoc: true
 homepage: http://autoparse.rubyforge.org/
 licenses: []
 
@@ -184,6 +191,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -192,13 +200,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: autoparse
-rubygems_version: 1.3.7
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: A parsing system based on JSON Schema.