json_schema-faker 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d295d3dfb065608b9af8b1bfcd4336ea16a7de1
-  data.tar.gz: 08969d39f4b51f7c4fc07fd0c7ec3cb9408d3995
+  metadata.gz: ca9c68a89b0e12cd2c9add27620a0e27a612bc98
+  data.tar.gz: bd0f0df87c65b0a6d4d75e25bd73567c4adcf25a
 SHA512:
-  metadata.gz: 9a3360dae5813be93b1c4aa5ac9cdd04c5c1e7c5151d90529811d4e5530c48a022c187967a2d1e92bd5d395c3660c2978dedcabbd46114d7d37d7dc3823698e3
-  data.tar.gz: b07858fa1b121b06e58d3dd27342a76e2cc03e27fde3137ffd73d6a50c1ec15a9bf0c8cb9289795d08cd4f525ae86800022a1cfce2c456478f954bef5881d312
+  metadata.gz: 1f808e04df1769456412a40050173939a44bd2c7b2ec76cf6744811eea885b98f892dd408ef6a3aec7833f58f7067d4b5441c8a5f83f92958d2c1456f3dc461f
+  data.tar.gz: c510fd256a59d6be0f120c7e740692a056336c2121d49ede8cdf498b45913e2dc9f39844d0c64dab89fa0e943f281a50d7ba8256a64f9e04dcc52ce7469e69cb

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.2.0
+
+* ENHANCEMENT
+ * support example as hint
+
 ## 0.1.1
 
 * IMPROVEMENT

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/lib/json_schema/faker.rb

@@ -24,7 +24,7 @@ module JsonSchema
 
       Configuration.logger.debug "to generate against #{@schema.inspect_schema}" if Configuration.logger
 
-      generated = strategy.call(@schema, hint: nil, position: "")
+      generated = strategy.call(@schema, hint: hint, position: "")
       Configuration.logger.debug "generated: #{generated.inspect}" if Configuration.logger
 
       generated

data/lib/json_schema/faker/strategy/simple.rb

@@ -1,7 +1,10 @@
 module JsonSchema::Faker::Strategy
   class Simple
     def call(schema, hint: nil, position:)
-      ::JsonSchema::Faker::Configuration.logger.debug "current position: #{position}" if ::JsonSchema::Faker::Configuration.logger
+      if ::JsonSchema::Faker::Configuration.logger
+        ::JsonSchema::Faker::Configuration.logger.debug "current position: #{position}"
+        ::JsonSchema::Faker::Configuration.logger.debug "current hint:     #{hint.inspect}"
+      end
 
       raise "here comes nil for schema at #{position}" unless schema
 
@@ -29,22 +32,40 @@ module JsonSchema::Faker::Strategy
     alias_method :generate, :call
 
     def generate_for_object(schema, hint: nil, position:)
+      # complete hint
+      object = if hint && hint[:example] && hint[:example].is_a?(Hash)
+        hint[:example].each.with_object({}) do |(key, value), hash|
+          if value.is_a?(Hash)
+            if schema.properties.has_key?(key)
+              hash[key] =  generate(schema.properties[key], hint: { example: hint[:example][key] }, position: "#{position}/#{key}")
+            else
+              # TODO: support pattern properties
+              hash[key] = value
+            end
+          else
+            hash[key] = value
+          end
+        end
+      else
+        {}
+      end
+
       # http://json-schema.org/latest/json-schema-validation.html#anchor53
       if schema.required
         keys   = schema.required
         required_length = schema.min_properties || keys.length
 
-        object = keys.each.with_object({}) do |key, hash|
-          hash[key] = generate(schema.properties[key], hint: hint, position: "#{position}/#{key}") # TODO: pass hint
+        (keys - object.keys).each.with_object(object) do |key, hash|
+          hash[key] = generate(schema.properties[key], hint: hint, position: "#{position}/#{key}")
         end
       else
         required_length = schema.min_properties || schema.max_properties || 0
 
-        keys = (schema.properties || {}).keys
-        keys -= (hint[:not_have_keys] || []) if hint
+        keys = (schema.properties || {}).keys - object.keys
+        keys -= hint[:not_have_keys] if hint && hint[:not_have_keys]
 
-        object = keys.first(required_length).each.with_object({}) do |key, hash|
-          hash[key] = generate(schema.properties[key], hint: hint, position: "#{position}/#{key}") # TODO: pass hint
+        keys.first(required_length).each.with_object(object) do |key, hash|
+          hash[key] = generate(schema.properties[key], hint: hint, position: "#{position}/#{key}")
         end
       end
 
@@ -86,18 +107,18 @@ module JsonSchema::Faker::Strategy
 
     def generate_by_enum(schema, hint: nil, position:)
       black_list = (hint ? hint[:not_be_values] : nil)
+      list       = black_list ? schema.enum - black_list : schema.enum
 
       if ::JsonSchema::Faker::Configuration.logger
         ::JsonSchema::Faker::Configuration.logger.info "generate by enum at #{position}"
         ::JsonSchema::Faker::Configuration.logger.debug schema.inspect_schema
         ::JsonSchema::Faker::Configuration.logger.debug "black list: #{black_list}" if black_list
+        ::JsonSchema::Faker::Configuration.logger.debug "list: #{list}"
       end
 
-      if black_list
-        (schema.enum - black_list).first
-      else
-        schema.enum.first
-      end
+      return hint[:example] if hint && hint[:example] && hint[:example] && list.include?(hint[:example])
+
+      list.first
     end
 
     def generate_by_type(schema, hint: nil, position:)
@@ -112,6 +133,8 @@ module JsonSchema::Faker::Strategy
       when "array"
         generate_for_array(schema, hint: hint, position: position)
       when "boolean"
+        return hint[:example] if hint && hint[:example] && (hint[:example] === true || hint[:example] === false)
+
         true
       when "integer", "number"
         generate_for_number(schema, hint: hint)
@@ -128,6 +151,9 @@ module JsonSchema::Faker::Strategy
     end
 
     def generate_for_array(schema, hint: nil, position:)
+      # completing each items is difficult
+      return hint[:example] if hint && hint[:example] && hint[:example].is_a?(Array)
+
       # http://json-schema.org/latest/json-schema-validation.html#anchor36
       # additionalItems items maxItems minItems uniqueItems
       length = schema.min_items || 0
@@ -146,6 +172,8 @@ module JsonSchema::Faker::Strategy
     end
 
     def generate_for_number(schema, hint: nil)
+      return hint[:example] if hint && hint[:example] && hint[:example].is_a?(Numeric)
+
       # http://json-schema.org/latest/json-schema-validation.html#anchor13
       # TODO: use hint[:not_be_values]
       min = schema.min
@@ -170,6 +198,8 @@ module JsonSchema::Faker::Strategy
     end
 
     def generate_for_string(schema, hint: nil)
+      return hint[:example] if hint && hint[:example] && hint[:example].is_a?(String)
+
       # http://json-schema.org/latest/json-schema-validation.html#anchor25
       # TODO: use hint[:not_be_values]
       # TODO: support format

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json_schema-faker
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - okitan