json_schema_tools 0.0.2 → 0.0.3

data/lib/schema_tools/modules/read.rb

@@ -31,12 +31,21 @@ module SchemaTools
       # @param [String|Symbol] schema name to be read from schema path directory
       # @param [String] path
       # @return[HashWithIndifferentAccess] schema as hash
-      def read(schema, path=nil)
-        schema = schema.to_sym
-        return registry[schema] if registry[schema]
-        file_path = File.join(path || SchemaTools.schema_path, "#{schema}.json")
+      def read(schema_name, path=nil)
+        schema_name = schema_name.to_sym
+        return registry[schema_name] if registry[schema_name]
+        file_path = File.join(path || SchemaTools.schema_path, "#{schema_name}.json")
         plain_data = File.open(file_path, 'r'){|f| f.read}
-        registry[schema] = ActiveSupport::JSON.decode(plain_data).with_indifferent_access
+        schema = ActiveSupport::JSON.decode(plain_data).with_indifferent_access
+        if schema[:extends]
+          extends = schema[:extends].is_a?(Array) ? schema[:extends] : [ schema[:extends] ]
+          extends.each do |ext_name|
+            ext = read(ext_name, path)
+            # current schema props win
+            schema[:properties] = ext[:properties].merge(schema[:properties])
+          end
+        end
+        registry[ schema_name ] = schema
       end
 
       # Read all available schemas from a given path(folder) and return

data/lib/schema_tools/version.rb

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

data/spec/fixtures/address.json

@@ -1,7 +1,7 @@
 { "type":"object",
   "title": "address",
   "name": "address",
-  "description":"An address in SK is maintained within it's parent object(client, company). The first address(default_address) is used inside the address field of new documents. With multiple addresses sorting(first) is done by date, newest first. So if you add a new adddress it will be the new default one. See order and type property for details about ordering and accessing parcel work or home addresses.",
+  "description":"An address .. Example partially taken from SalesKing",
   "properties":{
     "id":{
       "description":"Unique identifier - UUID",
@@ -22,63 +22,20 @@
       "type":"string",
       "maxLength": 100
     },
-    "address2":{
-      "description": "Additional address information, like floor number",
-      "type":"string",
-      "maxLength": 100
-    },
-    "pobox":{
-      "description": "Post office box number",
-      "type":"string",
-      "maxLength": 10
-    },
     "zip":{
       "description": "Zip number of the city. Length must be between 4..10",
       "type":"string",
       "maxLength": 10
     },
-    "state":{
-      "description": "Country state of address",
-      "type":"string",
-      "maxLength": 100
-    },
     "country":{
       "description": "Country of the address.",
       "type":"string",
       "maxLength": 100
     },
-    "created_at":{
-      "description": "Date the object was created in SK. Never changes afterwards",
-      "format":"date-time",
-      "readonly":true,
-      "type":"string"
-    },
-    "updated_at":{
-      "description": "Date the object was edited in SK.",
-      "format":"date-time",
-      "readonly":true,
-      "type":"string"
-    },
     "address_type":{
       "description": "Type of the address, as seen by vCard definition. There can only be one type. Inside of SK you can use placeholders like client.parcel_address.city to access the first parcel adr(Same for work_ / home_). <br/>Besides the placeholder default_address, always returns the first address found. Sorting is done by the order(if set) else by date, newest first.",
       "enum":["work","home", "parcel"],
       "type":"string"
-    },
-    "order":{
-      "description": "Addresses are normally sorted by date, newest first. If you need to strongly rely on their sorting e.g. default_address (always first) or have multiple addresses of one type(3 parcel), use this field for all adrs. <br/>Single adrs are used in placeholders like: addresses.2.city, returning the second adr found(not necessarily one with order=2).",
-      "type":"integer"
-    },
-    "lat":{
-      "description": "Geo-Location latitude",
-      "type":"number"
-    },
-    "long":{
-      "description": "Geo-Location longitude",
-      "type":"number"
-    },
-    "_destroy":{
-      "description": "When set an existing address will be deleted. This switch is only used when addresses are passed-in nested inside their parent object(a contact).",
-      "type":"boolean"
     }
   },
   "links":[]

data/spec/fixtures/contact.json

@@ -1,4 +1,4 @@
-{"type":"object",
+{ "type":"object",
   "title": "Contact",
   "name": "contact",
   "description": "A simple contact",

data/spec/fixtures/lead.json

@@ -0,0 +1,13 @@
+{ "type":"object",
+  "title": "Lead",
+  "name": "lead",
+  "extends": "contact",
+  "description": "A lead, inherits fields from contact schema",
+  "properties":{
+    "lead_source":{
+      "description": "Where did the person come from",
+      "type":"string",
+      "maxLength": 255
+    }
+  }
+}

data/spec/schema_tools/reader_spec.rb

@@ -3,15 +3,28 @@ require 'spec_helper'
 describe SchemaTools::Reader do
 
   context 'class methods' do
+
     after :each do
       SchemaTools::Reader.registry_reset
     end
+
     it 'should read a single schema' do
       schema = SchemaTools::Reader.read(:page)
       schema[:name].should == 'page'
       schema[:properties].should_not be_empty
       SchemaTools::Reader.registry.should_not be_empty
     end
+
+    it 'should read a schema with inheritance' do
+      schema = SchemaTools::Reader.read(:lead) # extends contact
+
+      SchemaTools::Reader.registry[:contact].should_not be_empty
+      SchemaTools::Reader.registry[:lead].should_not be_empty
+
+      schema[:properties][:first_name].should_not be_empty
+      schema[:properties][:lead_source].should_not be_empty
+    end
+
   end
 
   context 'instance methods' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json_schema_tools
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -119,6 +119,7 @@ files:
 - spec/fixtures/address.json
 - spec/fixtures/client.json
 - spec/fixtures/contact.json
+- spec/fixtures/lead.json
 - spec/fixtures/page.json
 - spec/schema_tools/cleaner_spec.rb
 - spec/schema_tools/hash_spec.rb
@@ -139,7 +140,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -438392315177719693
+      hash: 1443781473730246135
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -148,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -438392315177719693
+      hash: 1443781473730246135
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24