json-schema-generator 0.0.5 → 0.0.6

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NjRkOWJiNTNmMDM2ZmM2YzE2YmJiZWE4ZmFkNzg5MzllMGQ5Y2IyOA==
+  data.tar.gz: !binary |-
+    NDM3NWE3NTc4OTIwN2ZjNTJlMjJiYTg5YWRiMTczYTJkN2ZiOTc5NA==
+SHA512:
+  metadata.gz: !binary |-
+    ZTE3YWI4MmQ0YjAxMTNhZGMxZGJkNzRlNWZiN2Q2ODViMWQ4YjM5MjcyMWZj
+    YjE3ZmIxNjVmY2U2Yzc5MDM3M2VhMTQ4ZDlmMDYzM2NkOTUzMmQ0ZmY4YzIz
+    N2QzODUzYzhjOTRkYzlkYjFkY2NjN2NjYjMyMWRhYjVkNzQwMDk=
+  data.tar.gz: !binary |-
+    MDNlMDU2M2E5YWQ0MzdhNTVhMDA2MjQ5NTczZDZlMjQ2NDMxYjZlN2Y5NTQ0
+    MWFjY2MwZmRiOTY2NjVhMDEzNTEwN2YxMjA5YTVmN2YwZDNlMTViYTNkMGFk
+    NzFmNzM2ZTg0MDE3YzE3YjgwMDg4N2ZkNGEzYmMyZGE2MDE5ZDc=

data/README.md

@@ -48,7 +48,7 @@ JSON::SchemaGenerate has the following features or assumptions for generating "b
   * **Defaults**: Can generate default values.
   * **Descriptions**: Can generate a description indicating where the schema came from.
 * **Features/Assumptions**:
-  * **Detecting optional properties:** if you have an array of hashes, then will detect which hash keys exist in every instance of the hash and which ones only exist in some, and use this data to decide if the key is required or optional in the schema.
+  * **Detecting optional properties:** if you are using arrays (even arrays with complex nested types), the generator will use all available data to figure detect if a field is optional.
   * **Assume required:** in all other cases, I assume everything I find in the sample is required.  I believe it is better to generate a schema that is too strict than too lenient.  It is easy to review and fix false negatives, by updating the schema to mark those items as optional.  A false positive will go unnoticed and will not point you towards a solution.
   * **Detect types:** I detect objects, arrays, strings, integers, numbers and booleans.
 

data/json-schema-generator.gemspec

@@ -18,10 +18,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "jsonpath"
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "json-schema"
-  spec.add_development_dependency "jsonpath"
   spec.add_development_dependency "travis"
 end

data/lib/json/schema_generator.rb

@@ -1,4 +1,5 @@
 require 'json/schema_generator/statement_group'
+require 'json/schema_generator/brute_force_required_search'
 
 module JSON
   class SchemaGenerator
@@ -33,6 +34,8 @@ module JSON
 
     def generate raw_data
       data = JSON.load(raw_data)
+      @brute_search = BruteForceRequiredSearch.new data
+
       statement_group = StatementGroup.new
       statement_group.add "\"$schema\": \"http://json-schema.org/#{@version}/schema#\""
       statement_group.add "\"description\": \"Generated from #{@name} with shasum #{Digest::SHA1.hexdigest raw_data}\""
@@ -103,7 +106,9 @@ module JSON
     def create_hash_properties(data, required_keys)
       statement_group = StatementGroup.new "properties"
       data.collect do |k,v|
+        @brute_search.push k,v
         statement_group.add create_values k, v, required_keys
+        @brute_search.pop
       end
       statement_group
     end
@@ -124,7 +129,7 @@ module JSON
 
     def detect_required(collection)
       begin
-        required_keys = collection.map(&:keys).inject{|required,keys| required & keys }
+        required_keys = @brute_search.find_required
       rescue
         if collection.respond_to? :keys
           required_keys = collection.keys

data/lib/json/schema_generator/brute_force_required_search.rb

@@ -0,0 +1,48 @@
+require 'jsonpath'
+
+module JSON
+  class SchemaGenerator
+    class BruteForceRequiredSearch
+      def initialize(data)
+        @data = data.dup
+        @json_path = ['$']
+      end
+
+      def push(key, value)
+        if value.is_a? Array
+          @json_path.push "#{key}[*]"
+        else
+          @json_path.push key
+        end
+      end
+
+      def pop
+        @json_path.pop
+      end
+
+      def current_path
+        @json_path.join '.'
+      end
+
+      def search_path search_key
+        current_path.gsub(/\[\*\]$/, "[?(@.#{search_key})]")
+      end
+
+      def required? child_key
+        JsonPath.new(search_path(child_key)).on(@data).count == JsonPath.new(current_path).on(@data).count
+      end
+
+      def child_keys 
+        JsonPath.new(current_path).on(@data).map(&:keys).flatten.uniq
+      end
+
+      def find_required
+        required = []
+        child_keys.each do |child_key|
+          required << child_key if required? child_key
+        end
+        required
+      end
+    end
+  end
+end

data/lib/json/schema_generator/version.rb

@@ -1,5 +1,5 @@
 module JSON
   class SchemaGenerator
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

metadata

@@ -1,52 +1,46 @@
 --- !ruby/object:Gem::Specification
 name: json-schema-generator
 version: !ruby/object:Gem::Version
-  version: 0.0.5
-  prerelease: 
+  version: 0.0.6
 platform: ruby
 authors:
 - Max Lincoln
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-08 00:00:00.000000000 Z
+date: 2013-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: jsonpath
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,15 +48,13 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: json-schema
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,15 +62,13 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: jsonpath
+  name: json-schema
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -94,7 +83,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: travis
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -102,7 +90,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -126,6 +113,7 @@ files:
 - json-schema-generator.gemspec
 - lib/json-schema-generator.rb
 - lib/json/schema_generator.rb
+- lib/json/schema_generator/brute_force_required_search.rb
 - lib/json/schema_generator/statement_group.rb
 - lib/json/schema_generator/version.rb
 - lib/json/schema_generator_cli.rb
@@ -135,32 +123,25 @@ files:
 homepage: ''
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1712601133400832444
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1712601133400832444
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.1.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A very basic json-schema generator
 test_files: []