paradocs 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5dc965cce0c862cdc35b68bbf6be48418885c69b
-  data.tar.gz: a0763156554745078e092b79be02d4103b906b77
+  metadata.gz: add6d55cad7f9a56bb95f6efe094afa0d9009109
+  data.tar.gz: 8c52dfc657dfb97a301f31567327e66c0dae9577
 SHA512:
-  metadata.gz: 6664235a1e30f28196a1e58c1826ec7ff22f33b10db0275998ea21eed1dbfb7f17d76de8b9d75f3a57ba0621bf309874a3d0bb2ba099b2527228bfe777ffb68c
-  data.tar.gz: 6d2658f064f28a80f148f7ababe14bb5dafdd65a46a84a3c9786cb9413d65bc6480cc4bef8c7d8cf6b8e7e52cb7f2868d53e0df40c7e1cbb265909b9f4b34876
+  metadata.gz: c042f2d0738aee92991e86fc8a98df7649c6a0bf6c383e50c0f8e69e1237293950aad9fd7aef6b61bfef76ed2348ae6631161c20ce2f44995c23b4bd65cbd444
+  data.tar.gz: 3b9ae5c9de08aa07caa7b77a0064151c221d6bfe76b1c3b62e063963ec39028dd76426744b10286ce713c68818395c466686b1111551b1c0caf7ddd497a421ee

data/lib/paradocs/field_dsl.rb

@@ -32,5 +32,13 @@ module Paradocs
     def length(opts)
       policy :length, opts
     end
+
+    def description(text)
+      meta description: text
+    end
+
+    def example(value)
+      meta example: value
+    end
   end
 end

data/lib/paradocs/version.rb

@@ -1,3 +1,3 @@
 module Paradocs
-  VERSION = "1.1.2"
+  VERSION = "1.1.3"
 end

data/spec/extensions/structures_spec.rb

@@ -19,7 +19,7 @@ describe Paradocs::Extensions::Structure do
 
       field(:data).type(:object).present.schema do
         field(:id).type(:integer).present.policy(:policy_with_error)
-        field(:name).type(:string).meta(label: "very important staff")
+        field(:name).type(:string).meta(label: "very important staff").description("Example description").example("John")
         field(:role).type(:string).declared.options(["admin", "user"]).default("user").mutates_schema! do |*|
           :test_subschema
         end
@@ -75,6 +75,8 @@ describe Paradocs::Extensions::Structure do
       expect(data_structure[:name]).to eq({
         type: :string,
         label: "very important staff",
+        description: "Example description",
+        example: "John",
         mutates_schema: true,
         block_works: true,
         json_path: "$.data.name",
@@ -140,6 +142,8 @@ describe Paradocs::Extensions::Structure do
           type: :string,
           json_path: "$.data.name",
           label: "very important staff",
+          description: "Example description",
+          example: "John",
           mutates_schema: true
         },
         "data.role" => {
@@ -177,7 +181,7 @@ describe Paradocs::Extensions::Structure do
           _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},
+          "data.name"        => {type: :string, label: "very important staff", json_path: "$.data.name", mutates_schema: true, description: "Example description", example: "John"},
           "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"},
@@ -187,7 +191,7 @@ describe Paradocs::Extensions::Structure do
           _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},
+          "data.name"        => {type: :string, label: "very important staff", json_path: "$.data.name", mutates_schema: true, description: "Example description", example: "John"},
           "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"},
@@ -212,7 +216,7 @@ describe Paradocs::Extensions::Structure do
             "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"},
+            "name"       => {type: :string, label: "very important staff", json_path: "$.data.name", mutates_schema: true, nested_name: "data.name", description: "Example description", example: "John"},
             "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"}}
@@ -232,7 +236,7 @@ describe Paradocs::Extensions::Structure do
             "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"},
+            "name"  => {type: :string, label: "very important staff", json_path: "$.data.name", mutates_schema: true, nested_name: "data.name", description: "Example description", example: "John"},
             "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"}}}

data/spec/field_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 describe Paradocs::Field do
-  let(:context)  { Paradocs::Context.new }
+  let(:context) { Paradocs::Context.new }
 
   subject { described_class.new(:a_key) }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paradocs
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors:
 - Maxim Tkachenko
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-11 00:00:00.000000000 Z
+date: 2020-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler