paradocs 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0df2185fac7b1e70254c9531622e135c6609f309
-  data.tar.gz: 701ec92673e9044bc8a8384e251276aa7863d37e
+  metadata.gz: a2b76b24aa936e4626071a9563bb2d96626e584d
+  data.tar.gz: a562933c44070c959dd170dd704621014f4b6cd0
 SHA512:
-  metadata.gz: aa14905a01be3d1d54589aabc53fbc2f14d3a17352742a9eece1e76b324f146d94f5860ae4f59d738007e809c1fb0eb3ae95579d2a8237798e80a7a6f43ff2b9
-  data.tar.gz: 0c5fedee64178f630d403db573b2d8a4e2e4bc44b88e65df636c88aa1d9857836267d77ed34a1236036ff97bb105e37252f4948d46fcdc600850e682a5db082d
+  metadata.gz: 550d27c26a72f9f5ee9037a8072bcf40687f2554dd2822bd5c920218aa92a4c06fcd2c72b819ac479b99977028e395b4fdd32cfca4091874d1ac184e62968e2a
+  data.tar.gz: b28aa591c5c8cce7b7d19d638f9ba5ab530972ee6e83603f83eb35ab5a98f756d1b6e800a0000ebdbe87296c7f964ee261e9d2bbc430720d962433e1d3cd3160

data/docs/changelog.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## 1.1.1
+- Fixed bug with missing `errors` meta key in `Structure#all_nested` and `Structure#all_flatten` methods.
+- Fixed bug with absent `nested_name` meta key in `#Structure#all_nested` method.
+- Added opportunity to sort generated by `PayloadBuilder` payload in the way it is described in schema.
+
+## 1.1.0
+> `Schema#structure` is not comptatible with previous versions
+
+- Added `Paradocs::Extensions::StructureBuilder`. See [more](payload_builder)
+- `Parardocs::Extensions::Structure` has replaced `Paradocs::Extensions::Insides` and changed `Schema#structure` behavior
+- `Paradocs::Extensions::Structure` got more structure generation methods. See [Documentation Generation](documentation_generation)
+

data/docs/documentation_generation.md

@@ -188,12 +188,16 @@ all_nested[:subschema] # =>
     required:  true,
     present:   true,
     json_path: "$.data",
+		nested_name: "data",
     structure: {
-      "role"       => {type: :string, options: ["admin", "user"], default: "user", json_path: "$.data.role", mutates_schema: true},
-      "extra"      => {type: :array, required: true, json_path: "$.data.extra[]", structure: {"extra" => {default: false, policy_with_silent_error: {errors: []}, json_path: "$.data.extra[].extra"}}},
-      "test_field" => {required: true, present: true, json_path: "$.data.test_field"},
-      "id"         => {type: :integer, required: true, present: true, policy_with_error: {errors: [ArgumentError]}, json_path: "$.data.id"},
-      "name"       => {type: :string, label: "very important staff", json_path: "$.data.name", mutates_schema: true}
+      "role"       => {type: :string, options: ["admin", "user"], default: "user", json_path: "$.data.role", mutates_schema: true, nested_name: "data.role"},
+      "test_field" => {required: true, present: true, json_path: "$.data.test_field", nested_name: "data.test_field"},
+      "id"         => {type: :integer, required: true, present: true, policy_with_error: {errors: [ArgumentError]}, json_path: "$.data.id", nested_name: "data.id"},
+      "name"       => {type: :string, label: "very important staff", json_path: "$.data.name", mutates_schema: true, nested_name: "data.name"},
+      "extra"      => {
+        type: :array, required: true, json_path: "$.data.extra[]", nested_name: "data.extra",
+        structure: {"extra" => {default: false, policy_with_silent_error: {errors: []}, json_path: "$.data.extra[].extra", nested_name: "data.extra.extra"}}
+      }
     }
   }
 }
@@ -205,12 +209,16 @@ all_nested[:test_subschema] # =>
     required:  true,
     present:   true,
     json_path: "$.data",
+		nested_name: "data",
     structure: {
-      "role"  => {type: :string, options: ["admin", "user"], default: "user", json_path: "$.data.role", mutates_schema: true},
-      "extra" => {type: :array, required: true, json_path: "$.data.extra[]", structure: {"extra" => {default: false, policy_with_silent_error: {errors: []}, json_path: "$.data.extra[].extra"}}},
-      "test1" => {required: true, present: true, json_path: "$.data.test1"},
-      "id"    => {type: :integer, required: true, present: true, policy_with_error: {errors: [ArgumentError]}, json_path: "$.data.id"},
-      "name"  => {type: :string, label: "very important staff", json_path: "$.data.name", mutates_schema: true}
+      "role"  => {type: :string, options: ["admin", "user"], default: "user", json_path: "$.data.role", mutates_schema: true, nested_name: "data.role"},
+      "test1" => {required: true, present: true, json_path: "$.data.test1", nested_name: "data.test1"},
+      "id"    => {type: :integer, required: true, present: true, policy_with_error: {errors: [ArgumentError]}, json_path: "$.data.id", nested_name: "data.id"},
+      "name"  => {type: :string, label: "very important staff", json_path: "$.data.name", mutates_schema: true, nested_name: "data.name"},
+      "extra" => {
+        type: :array, required: true, json_path: "$.data.extra[]", nested_name: "data.extra",
+        structure: {"extra" => {default: false, policy_with_silent_error: {errors: []}, json_path: "$.data.extra[].extra", nested_name: "data.extra.extra"}}
+      }
     }
   }
 }
@@ -219,33 +227,38 @@ all_nested[:test_subschema] # =>
 ## Structure#all_flatten
 > This method returns all available combinations of schema (built on subschema) without nesting (the same way as Structure#flatten method does)
 
-Schema is the same as described in Structure#all_nested
+Schema is the same as described in `Structure#all_nested`
 ```rb
 schema.structure.all_flatten # =>
 {
   subschema: {
     _errors: [],
-    "data"             => {type: :object, required: true, present: true, json_path: "$.data"},
-    "data.id"          => {type: :integer, required: true, present: true, policy_with_error: {errors: [ArgumentError]}, json_path: "$.data.id"},
-    "data.name"        => {type: :string, label: "very important staff", json_path: "$.data.name", mutates_schema: true},
-    "data.role"        => {type: :string, options: ["admin", "user"], default: "user", json_path: "$.data.role", mutates_schema: true},
-    "data.extra"       => {type: :array, required: true, json_path: "$.data.extra[]"},
-    "data.extra.extra" => {default: false, policy_with_silent_error: {errors: []}, json_path: "$.data.extra[].extra"},
-    "data.test_field"  => {required: true, present: true, json_path: "$.data.test_field"}
+    "data"             => {type: :object, required: true, present: true, json_path: "$.data", nested_name: "data"},
+    "data.id"          => {type: :integer, required: true, present: true, policy_with_error: {errors: [ArgumentError]}, json_path: "$.data.id", nested_name: "data.id"},
+    "data.name"        => {type: :string, label: "very important staff", json_path: "$.data.name", mutates_schema: true, nested_name: "data.name"},
+    "data.role"        => {type: :string, options: ["admin", "user"], default: "user", json_path: "$.data.role", mutates_schema: true, nested_name: "data.role"},
+    "data.extra"       => {type: :array, required: true, json_path: "$.data.extra[]", nested_name: "data.extra"},
+    "data.extra.extra" => {default: false, policy_with_silent_error: {errors: []}, json_path: "$.data.extra[].extra", nested_name: "data.extra.extra"},
+    "data.test_field"  => {required: true, present: true, json_path: "$.data.test_field", nested_name: "data.test_field"}
   },
   test_subschema: {
     _errors: [],
-    "data"             => {type: :object, required: true, present: true, json_path: "$.data"},
-    "data.id"          => {type: :integer, required: true, present: true, policy_with_error: {errors: [ArgumentError]}, json_path: "$.data.id"},
-    "data.name"        => {type: :string, label: "very important staff", json_path: "$.data.name", mutates_schema: true},
-    "data.role"        => {type: :string, options: ["admin", "user"], default: "user", json_path: "$.data.role", mutates_schema: true},
-    "data.extra"       => {type: :array, required: true, json_path: "$.data.extra[]"},
-    "data.extra.extra" => {default: false, policy_with_silent_error: {errors: []}, json_path: "$.data.extra[].extra"},
-    "data.test1"       => {required: true, present: true, json_path: "$.data.test1"}
+    "data"             => {type: :object, required: true, present: true, json_path: "$.data", nested_name: "data"},
+    "data.id"          => {type: :integer, required: true, present: true, policy_with_error: {errors: [ArgumentError]}, json_path: "$.data.id", nested_name: "data.id"},
+    "data.name"        => {type: :string, label: "very important staff", json_path: "$.data.name", mutates_schema: true, nested_name: "data.name"},
+    "data.role"        => {type: :string, options: ["admin", "user"], default: "user", json_path: "$.data.role", mutates_schema: true, nested_name: "data.role"},
+    "data.extra"       => {type: :array, required: true, json_path: "$.data.extra[]", nested_name: "data.extra"},
+    "data.extra.extra" => {default: false, policy_with_silent_error: {errors: []}, json_path: "$.data.extra[].extra", nested_name: "data.extra.extra"},
+    "data.test1"       => {required: true, present: true, json_path: "$.data.test1", nested_name: "data.test1"}
   }
 }
 ```
 
+## Passing a block
+Given block to the methods above (`#flatten`, `#nested`, `#all_flatten`, `#all_nested`) will be executed for
+each field, passing you as arguments `field.key` and `field.meta`. Mutating the second argument `field.meta`
+will reflect onto returned `meta`.
+
 ## Schema#walk
 
 The `#walk` method can recursively walk a schema definition and extract meta data or field attributes.

data/docs/payload_builder.md

@@ -1,9 +1,8 @@
 # Generate examples from the Schema
 
-> Schema instance provides #example_payloads method that returns example of all possible structures.
+> `Schema` instance provides `#example_payloads` method that returns example of all possible structures.
 
-NOTE: PayloadBuilder sets nil values by default. If options are given - builder will take on of them, if default is set - builder will use it.
-> PayloadBuilder#build! method takes a block as argument that may help you adding your custom rules.
+NOTE: `PayloadBuilder` sets nil values by default. If options are given - builder will take on of them, if default is set - builder will use it.
 
 #### Example schema
 ```ruby
@@ -59,12 +58,14 @@ schema.example_payloads.to_json # =>
 ```
 
 ## Customize payload generation logic
-PayloadBuilder#build! allows passing a block that will receive the following arguments:
+`PayloadBuilder#build!` arguments:
 
-- key: Field name
-- meta: Field meta data (that includes (if provided) field types, presence data, policies and other meta data
-- example_value: Provided by generator example value.
-- skip_word: Return this argument back if you want this item to be ommitted.
+1. `sort_by_schema: true` will try to return payload in the same way as declared in the schema.
+2. `&block` will be executed for each key receiving the following arguments:
+	- `key`: Field name
+	- `meta`: Field meta data (that includes (if provided) field types, presence data, policies and other meta data
+	- `example_value`: Provided by generator example value.
+	- `skip_word`: Return this argument back if you want this item to be ommitted.
 
 ```rb
 block = Proc.new do |key, meta, example, skip_word|

data/lib/paradocs/extensions/payload_builder.rb

@@ -8,8 +8,9 @@ module Paradocs
         @skip_word  = skip_word
       end
 
-      def build!(&block)
-        structure.all_nested.map { |name, struct| [name, build_simple_structure(struct, &block)] }.to_h
+      def build!(sort_by_schema: false, &block)
+        result = structure.all_nested.map { |name, struct| [name, build_simple_structure(struct, &block)] }.to_h
+        sort_by_schema ? schema.resolve(result).output : result
       end
 
       private

data/lib/paradocs/extensions/structure.rb

@@ -45,6 +45,7 @@ module Paradocs
           struct.sort_by { |k, v| k.to_s.count(".") }.each do |key, value|
             target = obj[name]
             key, value = key.to_s, value.clone # clone the values, because we do mutation below
+            value.merge!(nested_name: key) if value.respond_to?(:merge) # it can be array (_errors)
             next target[key.to_sym] = value if key.start_with?(Paradocs.config.meta_prefix) # copy meta fields
 
             parts = key.split(".")
@@ -68,9 +69,11 @@ module Paradocs
         end
         @all_flatten = schema_structure[subschemes].each_with_object({}) do |(name, subschema), result|
           if subschema[subschemes].empty?
-             result[name] = schema_structure.merge(subschema)
-             result[name].delete(subschemes)
-             next result[name]
+            result[name] = schema_structure.merge(subschema)
+            result[name][errors] += schema_structure[errors]
+            result[name][errors].uniq!
+            result[name].delete(subschemes)
+            next result[name]
           end
 
           all_flatten(subschema).each do |sub_name, schema|

data/lib/paradocs/version.rb

@@ -1,3 +1,3 @@
 module Paradocs
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

data/mkdocs.yml

@@ -13,4 +13,5 @@ nav:
   - 'payload_builder.md'
   - 'custom_configuration.md'
   - 'faq.md'
+  - 'changelog.md'
 

data/spec/extensions/structures_spec.rb

@@ -174,7 +174,7 @@ describe Paradocs::Extensions::Structure do
     it "generates N structures, where N = number of unique combinations of applied subschemas" do
       expect(schema.structure.all_flatten).to eq({
         subschema: {
-          _errors: [],
+          _errors: [ArgumentError],
           "data"             => {type: :object, required: true, present: true, json_path: "$.data"},
           "data.id"          => {type: :integer, required: true, present: true, policy_with_error: {errors: [ArgumentError]}, json_path: "$.data.id"},
           "data.name"        => {type: :string, label: "very important staff", json_path: "$.data.name", mutates_schema: true},
@@ -184,7 +184,7 @@ describe Paradocs::Extensions::Structure do
           "data.test_field"  => {required: true, present: true, json_path: "$.data.test_field"}
         },
         test_subschema: {
-          _errors: [],
+          _errors: [ArgumentError],
           "data"             => {type: :object, required: true, present: true, json_path: "$.data"},
           "data.id"          => {type: :integer, required: true, present: true, policy_with_error: {errors: [ArgumentError]}, json_path: "$.data.id"},
           "data.name"        => {type: :string, label: "very important staff", json_path: "$.data.name", mutates_schema: true},
@@ -201,34 +201,41 @@ describe Paradocs::Extensions::Structure do
     it "generates N structures, where N = number of unique combinations of applied subschemas" do
       result = schema.structure.all_nested
       expect(result[:subschema]).to eq({
-        _errors:     [],
+        _errors:     [ArgumentError],
         "data" => {
-          type:      :object,
-          required:  true,
-          present:   true,
-          json_path: "$.data",
+          type:        :object,
+          required:    true,
+          present:     true,
+          json_path:   "$.data",
+          nested_name: "data",
           structure: {
-            "role"       => {type: :string, options: ["admin", "user"], default: "user", json_path: "$.data.role", mutates_schema: true},
-            "extra"      => {type: :array, required: true, json_path: "$.data.extra[]", structure: {"extra" => {default: false, policy_with_silent_error: {errors: []}, json_path: "$.data.extra[].extra"}}},
-            "test_field" => {required: true, present: true, json_path: "$.data.test_field"},
-            "id"         => {type: :integer, required: true, present: true, policy_with_error: {errors: [ArgumentError]}, json_path: "$.data.id"},
-            "name"       => {type: :string, label: "very important staff", json_path: "$.data.name", mutates_schema: true}
+            "role"       => {type: :string, options: ["admin", "user"], default: "user", json_path: "$.data.role", nested_name: "data.role", mutates_schema: true},
+            "test_field" => {required: true, present: true, json_path: "$.data.test_field", nested_name: "data.test_field"},
+            "id"         => {type: :integer, required: true, present: true, policy_with_error: {errors: [ArgumentError]}, json_path: "$.data.id", nested_name: "data.id"},
+            "name"       => {type: :string, label: "very important staff", json_path: "$.data.name", mutates_schema: true, nested_name: "data.name"},
+            "extra"      => {
+              type: :array, required: true, json_path: "$.data.extra[]", nested_name: "data.extra",
+              structure: {"extra" => {default: false, policy_with_silent_error: {errors: []}, json_path: "$.data.extra[].extra", nested_name: "data.extra.extra"}}
+            }
           }
         }
       })
       expect(result[:test_subschema]).to eq({
-        _errors:     [],
+        _errors:     [ArgumentError],
         "data" => {
           type:      :object,
           required:  true,
           present:   true,
           json_path: "$.data",
+          nested_name: "data",
           structure: {
-            "role"  => {type: :string, options: ["admin", "user"], default: "user", json_path: "$.data.role", mutates_schema: true},
-            "extra" => {type: :array, required: true, json_path: "$.data.extra[]", structure: {"extra" => {default: false, policy_with_silent_error: {errors: []}, json_path: "$.data.extra[].extra"}}},
-            "test1" => {required: true, present: true, json_path: "$.data.test1"},
-            "id"    => {type: :integer, required: true, present: true, policy_with_error: {errors: [ArgumentError]}, json_path: "$.data.id"},
-            "name"  => {type: :string, label: "very important staff", json_path: "$.data.name", mutates_schema: true}
+            "role"  => {type: :string, options: ["admin", "user"], default: "user", json_path: "$.data.role", nested_name: "data.role", mutates_schema: true},
+            "test1" => {required: true, present: true, json_path: "$.data.test1", nested_name: "data.test1"},
+            "id"    => {type: :integer, required: true, present: true, policy_with_error: {errors: [ArgumentError]}, json_path: "$.data.id", nested_name: "data.id"},
+            "name"  => {type: :string, label: "very important staff", json_path: "$.data.name", mutates_schema: true, nested_name: "data.name"},
+            "extra" => {
+              type: :array, required: true, json_path: "$.data.extra[]", nested_name: "data.extra",
+              structure: {"extra" => {default: false, policy_with_silent_error: {errors: []}, json_path: "$.data.extra[].extra", nested_name: "data.extra.extra"}}}
           }
         }
       })

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paradocs
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Maxim Tkachenko
@@ -88,6 +88,7 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- docs/changelog.md
 - docs/custom_configuration.md
 - docs/documentation_generation.md
 - docs/faq.md