paradocs 1.1.3 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: add6d55cad7f9a56bb95f6efe094afa0d9009109
-  data.tar.gz: 8c52dfc657dfb97a301f31567327e66c0dae9577
+  metadata.gz: c9ed12715c0df054876f622c3dada9cc4a2d8fd5
+  data.tar.gz: bfe8c1cb2eb4aa9f15eb08349425611deccb3517
 SHA512:
-  metadata.gz: c042f2d0738aee92991e86fc8a98df7649c6a0bf6c383e50c0f8e69e1237293950aad9fd7aef6b61bfef76ed2348ae6631161c20ce2f44995c23b4bd65cbd444
-  data.tar.gz: 3b9ae5c9de08aa07caa7b77a0064151c221d6bfe76b1c3b62e063963ec39028dd76426744b10286ce713c68818395c466686b1111551b1c0caf7ddd497a421ee
+  metadata.gz: b9d827bf00b03d7766600e438d8ee16a9938ab099cd807d0d236cfb37758d104d76f26fdf713c7f39c550ce65df56c30b4dcfbeedb5fa7c5ebc93fa67c66199d
+  data.tar.gz: c4ac5998e89948246c01b6ec04d39ce5332c66da32902ac2b63a06672746dc002a91dc013372bc4cb33410a72e15c1de85bfb08aab8a17659dc9da84f4c793b5

data/lib/paradocs/extensions/payload_builder.rb

@@ -21,7 +21,8 @@ module Paradocs
           next if key.start_with?(Paradocs.config.meta_prefix) # skip all the meta fields
           ex_value = restore_one(key, value, &block)
           next if ex_value == @skip_word
-          [key, ex_value]
+          key = value[:alias] || key
+          [key.to_s, ex_value]
         end.compact.to_h
       end
 

data/lib/paradocs/extensions/structure.rb

@@ -23,8 +23,10 @@ module Paradocs
           else
             result[errors] += field.possible_errors
           end
-          result[field.key] = meta unless ignore_transparent && field.transparent?
-          yield(field.key, meta) if block_given?
+
+          field_key = field.meta_data[:alias] || field.key
+          result[field_key] = meta unless ignore_transparent && field.transparent?
+          yield(field_key, meta) if block_given?
 
           next unless field.mutates_schema?
           schema.subschemes.each do |name, subschema|
@@ -103,7 +105,8 @@ module Paradocs
     private
 
       def collect_meta(field, root)
-        json_path = root.empty? ? "$.#{field.key}" : "#{root}.#{field.key}"
+        field_key = field.meta_data[:alias] || field.key
+        json_path = root.empty? ? "$.#{field_key}" : "#{root}.#{field_key}"
         meta = field.meta_data.merge(json_path: json_path)
         sc = meta.delete(:schema)
         meta[:mutates_schema] = true if meta.delete(:mutates_schema)

data/lib/paradocs/field_dsl.rb

@@ -37,6 +37,10 @@ module Paradocs
       meta description: text
     end
 
+    def as(identifier)
+      meta alias: identifier
+    end
+
     def example(value)
       meta example: value
     end

data/lib/paradocs/schema.rb

@@ -181,7 +181,8 @@ module Paradocs
       invoke_subschemes!(val, context, flds: flds)
       flds.each_with_object({}) do |(_, field), m|
         r = field.resolve(val, context.sub(field.key))
-        m[field.key] = r.value if r.eligible?
+        key = field.meta_data[:alias] || field.key
+        m[key] = r.value if r.eligible?
       end
     end
 

data/lib/paradocs/struct.rb

@@ -57,6 +57,7 @@ module Paradocs
       # this hook is called after schema definition in DSL module
       def paradocs_after_define_schema(schema)
         schema.fields.keys.each do |key|
+          key = schema.fields[key].meta_data[:alias] || key
           define_method key do
             _graph[key]
           end

data/lib/paradocs/version.rb

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

data/paradocs.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Paradocs::VERSION
   spec.authors       = ["Maxim Tkachenko", "Ismael Celis"]
   spec.email         = ["tkachenko.maxim.w@gmail.com", "ismaelct@gmail.com"]
-  spec.description   = %q{Flexible DSL for declaring allowed parameters focused on DRY validation that gives you opportunity to generate API documentation on-the-fly.}
+  spec.description   = %q{Flexible DRY validations with API docs generation done right TLDR; parametrics on steroids.}
   spec.summary       = %q{A huge add-on for original gem mostly focused on retrieving the more metadata from declared schemas as possible.}
   spec.homepage      = "https://paradocs.readthedocs.io/en/latest"
   spec.license       = "MIT"

data/spec/extensions/payload_builder_spec.rb

@@ -22,7 +22,7 @@ describe Paradocs::Extensions::PayloadBuilder do
         end
         subschema(:fooschema) { }
         subschema(:barschema) do
-          field(:barfield).present.type(:boolean)
+          field(:barfield).present.type(:boolean).as(:bar_field)
         end
       end
     end
@@ -32,7 +32,7 @@ describe Paradocs::Extensions::PayloadBuilder do
     allow_any_instance_of(Array).to receive(:sample) { "bar" }
     payloads = described_class.new(schema).build!
     expect(payloads.keys.sort).to eq([:barschema, :fooschema, :subschema1, :subschema2_deep_schema, :subschema2_empty])
-    expect(payloads[:barschema]).to eq({"test" => nil, "foo" => {"bar" => "bar", "barfield" => nil}})
+    expect(payloads[:barschema]).to eq({"test" => nil, "foo" => {"bar" => "bar", "bar_field" => nil}})
     expect(payloads[:fooschema]).to eq({"test" => nil, "foo" => {"bar" => "bar"}})
     expect(payloads[:subschema1]).to eq({"test" => nil, "foo"  => {"bar" => "bar"}, "subtest1" => nil})
     expect(payloads[:subschema2_deep_schema]).to eq({
@@ -57,7 +57,7 @@ describe Paradocs::Extensions::PayloadBuilder do
     end
 
     expect(payloads.keys.sort).to eq([:barschema, :fooschema, :subschema1, :subschema2_deep_schema, :subschema2_empty])
-    expect(payloads[:barschema]).to eq({"test" => nil, "foo" => {"bar" => nil, "barfield" => true}}) # barfield is change to true and bar is nil
+    expect(payloads[:barschema]).to eq({"test" => nil, "foo" => {"bar" => nil, "bar_field" => true}}) # barfield is change to true and bar is nil
     expect(payloads[:fooschema]).to eq({"test" => nil, "foo" => {"bar" => nil}}) # bar is nil
     expect(payloads[:subschema1]).to eq({"test" => nil, "foo"  => {"bar" => nil}}) # subtest is missing, bar is nil
     expect(payloads[:subschema2_deep_schema]).to eq({

data/spec/extensions/structures_spec.rb

@@ -18,7 +18,7 @@ describe Paradocs::Extensions::Structure do
       subschema(:highest_level) { field(:test).present } # no mutations on this level -> subschema ignored
 
       field(:data).type(:object).present.schema do
-        field(:id).type(:integer).present.policy(:policy_with_error)
+        field(:id).type(:integer).present.policy(:policy_with_error).as(:user_id)
         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
@@ -64,13 +64,14 @@ describe Paradocs::Extensions::Structure do
           test_field: {required: true, present: true, json_path: "$.data.test_field", nested_name: "data.test_field"}
         }
       })
-      expect(data_structure[:id]).to eq({
+      expect(data_structure[:user_id]).to eq({
         type: :integer,
         required: true,
         present: true,
         policy_with_error: {errors: [ArgumentError]},
-        json_path: "$.data.id",
-        nested_name: "data.id"
+        alias: :user_id,
+        json_path: "$.data.user_id",
+        nested_name: "data.user_id"
       })
       expect(data_structure[:name]).to eq({
         type: :string,
@@ -131,11 +132,12 @@ describe Paradocs::Extensions::Structure do
           json_path: "$.data.extra[].extra",
           policy_with_silent_error: {errors: []}
         },
-        "data.id" => {
+        "data.user_id" => {
           type: :integer,
           required: true,
           present: true,
-          json_path: "$.data.id",
+          alias: :user_id,
+          json_path: "$.data.user_id",
           policy_with_error: {errors: [ArgumentError]}
         },
         "data.name" => {
@@ -180,7 +182,7 @@ describe Paradocs::Extensions::Structure do
         subschema: {
           _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.user_id"     => {type: :integer, required: true, present: true, policy_with_error: {errors: [ArgumentError]}, alias: :user_id, json_path: "$.data.user_id"},
           "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[]"},
@@ -190,7 +192,7 @@ describe Paradocs::Extensions::Structure do
         test_subschema: {
           _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.user_id"     => {type: :integer, required: true, present: true, policy_with_error: {errors: [ArgumentError]}, alias: :user_id, json_path: "$.data.user_id"},
           "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[]"},
@@ -215,7 +217,7 @@ describe Paradocs::Extensions::Structure do
           structure: {
             "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"},
+            "user_id"    => {type: :integer, required: true, present: true, policy_with_error: {errors: [ArgumentError]}, alias: :user_id, json_path: "$.data.user_id", nested_name: "data.user_id"},
             "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",
@@ -233,11 +235,11 @@ describe Paradocs::Extensions::Structure do
           json_path: "$.data",
           nested_name: "data",
           structure: {
-            "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", description: "Example description", example: "John"},
-            "extra" => {
+            "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"},
+            "user_id" => {type: :integer, required: true, present: true, policy_with_error: {errors: [ArgumentError]}, alias: :user_id, json_path: "$.data.user_id", nested_name: "data.user_id"},
+            "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/schema_spec.rb

@@ -16,7 +16,7 @@ describe Paradocs::Schema do
 
   subject do
     described_class.new do
-      field(:title).policy(:string).present
+      field(:title).policy(:string).present.as(:article_title)
       field(:price).policy(:integer).meta(label: "A price")
       field(:status).policy(:string).options(['visible', 'hidden'])
       field(:tags).policy(:split).policy(:array)
@@ -33,8 +33,8 @@ describe Paradocs::Schema do
   describe "#structure" do
     it "represents data structure and meta data" do
       sc = subject.structure.nested
-      expect(sc[:title][:present]).to be true
-      expect(sc[:title][:type]).to eq :string
+      expect(sc[:article_title][:present]).to be true
+      expect(sc[:article_title][:type]).to eq :string
       expect(sc[:price][:type]).to eq :integer
       expect(sc[:price][:label]).to eq "A price"
       expect(sc[:variants][:type]).to eq :array
@@ -76,7 +76,7 @@ describe Paradocs::Schema do
 
     output = subject.resolve(payload).output
     expect(output).to eq({
-      title: "title",
+      article_title: "title",
       price: 100,
       status: "visible",
       tags: ["tag"],
@@ -101,7 +101,7 @@ describe Paradocs::Schema do
       variants: [{name: 'v1', sku: 'ABC', stock: '10', available_if_no_stock: true}]
     },
     {
-      title: 'iPhone 6 Plus',
+      article_title: 'iPhone 6 Plus',
       price: 100,
       status: 'visible',
       tags: ['tag1', 'tag2'],
@@ -114,7 +114,7 @@ describe Paradocs::Schema do
       variants: [{name: 'v1', available_if_no_stock: '1'}]
     },
     {
-      title: 'iPhone 6 Plus',
+      article_title: 'iPhone 6 Plus',
       variants: [{name: 'v1', stock: 1, available_if_no_stock: true}]
     })
 

data/spec/struct_spec.rb

@@ -16,13 +16,13 @@ describe Paradocs::Struct do
       include Paradocs::Struct
 
       schema do
-        field(:title).type(:string).present
+        field(:title).type(:string).present.as(:example_title)
         field(:friends).type(:array).default([]).schema friend_class
       end
     end
 
     new_instance = klass.new
-    expect(new_instance.title).to eq ''
+    expect(new_instance.example_title).to eq ''
     expect(new_instance.friends).to eq []
     expect(new_instance.valid?).to be false
     expect(new_instance.errors['$.title']).not_to be_nil
@@ -35,7 +35,7 @@ describe Paradocs::Struct do
       ]
     })
 
-    expect(instance.title).to eq 'foo'
+    expect(instance.example_title).to eq 'foo'
     expect(instance.friends.size).to eq 2
     expect(instance.friends.first.name).to eq 'Ismael'
     expect(instance.friends.first).to be_a friend_class
@@ -154,7 +154,7 @@ describe Paradocs::Struct do
       schema do
         field(:title).type(:string).present
         field(:friends).type(:array).schema do
-          field(:name).type(:string)
+          field(:name).type(:string).as(:person_name)
           field(:age).type(:integer).default(20)
         end
       end
@@ -171,8 +171,8 @@ describe Paradocs::Struct do
     expect(instance.to_h).to eq({
       title: 'foo',
       friends: [
-        {name: 'Jane', age: 20},
-        {name: 'Joe', age: 39},
+        {person_name: 'Jane', age: 20},
+        {person_name: 'Joe', age: 39},
       ]
     })
 
@@ -190,7 +190,7 @@ describe Paradocs::Struct do
       include Paradocs::Struct
 
       schema do
-        field(:title).type(:string).present
+        field(:title).type(:string).present.as(:example_title)
         field(:friends).type(:array).schema do
           field(:name).type(:string)
           field(:age).type(:integer).default(20)
@@ -213,7 +213,7 @@ describe Paradocs::Struct do
       ]
     )
 
-    expect(instance.title).to eq 'foo'
+    expect(instance.example_title).to eq 'foo'
     expect(instance.email).to eq 'email@me.com'
     expect(instance.friends.size).to eq 2
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paradocs
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.4
 platform: ruby
 authors:
 - Maxim Tkachenko
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-06 00:00:00.000000000 Z
+date: 2020-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,8 +67,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-description: Flexible DSL for declaring allowed parameters focused on DRY validation
-  that gives you opportunity to generate API documentation on-the-fly.
+description: Flexible DRY validations with API docs generation done right TLDR; parametrics
+  on steroids.
 email:
 - tkachenko.maxim.w@gmail.com
 - ismaelct@gmail.com