paradocs 1.0.24 → 1.1.4

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) }
 

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)
@@ -32,9 +32,9 @@ describe Paradocs::Schema do
 
   describe "#structure" do
     it "represents data structure and meta data" do
-      sc = subject.structure
-      expect(sc[:title][:present]).to be true
-      expect(sc[:title][:type]).to eq :string
+      sc = subject.structure.nested
+      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

data/spec/subschema_spec.rb

@@ -71,16 +71,16 @@ describe "schemes with subschemes" do
       result = schema.resolve({error: :here})
       expect(result.errors).to    eq({"$.fail_field"=>["is required"]})
       expect(result.output).to    eq({error: :here, fail_field: nil})
-      expect(schema.structure).to eq(structure)
-      expect(schema.structure(ignore_transparent: false)).to eq(structure.merge(
+      expect(schema.structure.nested).to eq(structure)
+      expect(schema.structure(ignore_transparent: false).nested).to eq(structure.merge(
         error: {transparent: true, mutates_schema: true, json_path: "$.error", nested_name: "error"}
       ))
 
       result = schema.resolve({})
       expect(result.errors).to eq({"$.success_field"=>["is required"]})
       expect(result.output).to eq({success_field: nil})
-      expect(schema.structure).to eq(structure)
-      expect(schema.structure(ignore_transparent: false)).to eq(structure.merge(
+      expect(schema.structure.nested).to eq(structure)
+      expect(schema.structure(ignore_transparent: false).nested).to eq(structure.merge(
         error: {transparent: true, mutates_schema: true, json_path: "$.error", nested_name: "error"}
       ))
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paradocs
 version: !ruby/object:Gem::Version
-  version: 1.0.24
+  version: 1.1.4
 platform: ruby
 authors:
 - Maxim Tkachenko
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-07 00:00:00.000000000 Z
+date: 2020-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -29,16 +29,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -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
@@ -80,6 +80,7 @@ files:
 - ".github/workflows/spec.yml"
 - ".gitignore"
 - ".gitlab-ci.yml"
+- ".readthedocs.yml"
 - ".rspec"
 - ".travis.yml"
 - Gemfile
@@ -87,12 +88,24 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- docs/changelog.md
+- docs/custom_configuration.md
+- docs/documentation_generation.md
+- docs/faq.md
+- docs/form_objects_dsl.md
+- docs/index.md
+- docs/payload_builder.md
+- docs/policies.md
+- docs/schema.md
+- docs/struct.md
+- docs/subschema.md
 - lib/paradocs.rb
 - lib/paradocs/base_policy.rb
 - lib/paradocs/context.rb
 - lib/paradocs/default_types.rb
 - lib/paradocs/dsl.rb
-- lib/paradocs/extensions/insides.rb
+- lib/paradocs/extensions/payload_builder.rb
+- lib/paradocs/extensions/structure.rb
 - lib/paradocs/field.rb
 - lib/paradocs/field_dsl.rb
 - lib/paradocs/policies.rb
@@ -103,23 +116,26 @@ files:
 - lib/paradocs/support.rb
 - lib/paradocs/version.rb
 - lib/paradocs/whitelist.rb
+- mkdocs.yml
 - paradocs.gemspec
+- requirements.txt
 - spec/custom_block_validator_spec.rb
 - spec/custom_validator.rb
 - spec/dsl_spec.rb
 - spec/expand_spec.rb
+- spec/extensions/payload_builder_spec.rb
+- spec/extensions/structures_spec.rb
 - spec/field_spec.rb
 - spec/helpers.rb
 - spec/policies_spec.rb
 - spec/schema_spec.rb
-- spec/schema_structures_spec.rb
 - spec/schema_walk_spec.rb
 - spec/spec_helper.rb
 - spec/struct_spec.rb
 - spec/subschema_spec.rb
 - spec/validators_spec.rb
 - spec/whitelist_spec.rb
-homepage: https://github.com/mtkachenk0/paradocs
+homepage: https://paradocs.readthedocs.io/en/latest
 licenses:
 - MIT
 metadata: {}
@@ -149,11 +165,12 @@ test_files:
 - spec/custom_validator.rb
 - spec/dsl_spec.rb
 - spec/expand_spec.rb
+- spec/extensions/payload_builder_spec.rb
+- spec/extensions/structures_spec.rb
 - spec/field_spec.rb
 - spec/helpers.rb
 - spec/policies_spec.rb
 - spec/schema_spec.rb
-- spec/schema_structures_spec.rb
 - spec/schema_walk_spec.rb
 - spec/spec_helper.rb
 - spec/struct_spec.rb

data/lib/paradocs/extensions/insides.rb

@@ -1,77 +0,0 @@
-module Paradocs
-  module Extensions
-    module Insides
-      def structure(ignore_transparent: true, root: "", &block)
-        flush!
-        fields.each_with_object({meta_keys[:errors] => [], meta_keys[:subschemes] => {}}) do |(_, field), obj|
-          meta, sc = collect_meta(field, root)
-          if sc
-            meta[:structure] = sc.structure(ignore_transparent: ignore_transparent, root: meta[:json_path], &block)
-            obj[meta_keys[:errors]] += meta[:structure].delete(meta_keys[:errors])
-          else
-            obj[meta_keys[:errors]] += field.possible_errors
-          end
-          obj[field.key] = meta unless ignore_transparent && field.transparent?
-          yield(field.key, meta) if block_given?
-
-          next unless field.mutates_schema?
-          subschemes.each do |name, subschema|
-            obj[meta_keys[:subschemes]][name] = subschema.structure(ignore_transparent: ignore_transparent, root: root, &block)
-            obj[meta_keys[:errors]] += obj[meta_keys[:subschemes]][name][meta_keys[:errors]]
-          end
-        end
-      end
-
-      def flatten_structure(ignore_transparent: true, root: "", &block)
-        flush!
-        fields.each_with_object({meta_keys[:errors] => [], meta_keys[:subschemes] => {}}) do |(_, field), obj|
-          meta, sc = collect_meta(field, root)
-          humanized_name = meta.delete(:nested_name)
-          obj[humanized_name] = meta unless ignore_transparent && field.transparent?
-
-          if sc
-            deep_result = sc.flatten_structure(ignore_transparent: ignore_transparent, root: meta[:json_path], &block)
-            obj[meta_keys[:errors]] += deep_result.delete(meta_keys[:errors])
-            obj[meta_keys[:subschemes]].merge!(deep_result.delete(meta_keys[:subschemes]))
-            obj.merge!(deep_result)
-          else
-            obj[meta_keys[:errors]] += field.possible_errors
-          end
-          yield(humanized_name, meta) if block_given?
-          next unless field.mutates_schema?
-          subschemes.each do |name, subschema|
-            obj[meta_keys[:subschemes]][name] ||= subschema.flatten_structure(ignore_transparent: ignore_transparent, root: root, &block)
-            obj[meta_keys[:errors]] += obj[meta_keys[:subschemes]][name][meta_keys[:errors]]
-          end
-        end
-      end
-
-      def walk(meta_key = nil, &visitor)
-        r = visit(meta_key, &visitor)
-        Results.new(r, {}, {})
-      end
-
-      def visit(meta_key = nil, &visitor)
-        fields.each_with_object({}) do |(_, field), m|
-          m[field.key] = field.visit(meta_key, &visitor)
-        end
-      end
-
-      private
-
-      def collect_meta(field, root)
-        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)
-        json_path << "[]" if meta[:type] == :array
-        meta[:nested_name] = json_path.gsub("[]", "")[2..-1]
-        [meta, sc]
-      end
-
-      def meta_keys
-        %i(errors subschemes).map! { |key| [key, "#{Paradocs.config.meta_prefix}#{key}".to_sym] }.to_h
-      end
-    end
-  end
-end

data/spec/schema_structures_spec.rb

@@ -1,169 +0,0 @@
-require 'spec_helper'
-
-describe "Schema structures generation" do
-  Paradocs.policy :policy_with_error do
-    register_error ArgumentError
-
-    validate do |*|
-      raise ArgumentError
-    end
-  end
-
-  Paradocs.policy :policy_with_silent_error do
-    register_silent_error RuntimeError
-  end
-
-  let(:schema) do
-    Paradocs::Schema.new 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(:name).type(:string).meta(label: "very important staff")
-        field(:role).type(:string).declared.options(["admin", "user"]).default("user").mutates_schema! do |*|
-          :test_subschema
-        end
-        field(:extra).type(:array).required.schema do
-          field(:extra).declared.default(false).policy(:policy_with_silent_error)
-        end
-
-        mutation_by!(:name) { :subschema }
-
-        subschema(:subschema) do
-          field(:test_field).present
-        end
-        subschema(:test_subschema) do
-          field(:test1).present
-        end
-      end
-    end
-  end
-
-
-  it "generates nested data for documentation generation" do
-    result = schema.structure { |k, meta| meta[:block_works] = true unless meta[:present] }
-    expect(result[:_subschemes]).to eq({})
-    expect(result[:_errors]).to eq([ArgumentError])
-    data_structure = result[:data].delete(:structure)
-    expect(result[:data]).to eq({
-      type: :object,
-      required: true,
-      present: true,
-      json_path: "$.data",
-      nested_name: "data",
-    })
-    expect(data_structure[:_subschemes]).to eq({
-      test_subschema: {
-        _errors: [],
-        _subschemes: {},
-        test1: {required: true, present: true, json_path: "$.data.test1", nested_name: "data.test1"}
-      },
-      subschema: {
-        _errors: [],
-        _subschemes: {},
-        test_field: {required: true, present: true, json_path: "$.data.test_field", nested_name: "data.test_field"}
-      }
-    })
-    expect(data_structure[:id]).to eq({
-      type: :integer,
-      required: true,
-      present: true,
-      policy_with_error: {errors: [ArgumentError]},
-      json_path: "$.data.id",
-      nested_name: "data.id"
-    })
-    expect(data_structure[:name]).to eq({
-      type: :string,
-      label: "very important staff",
-      mutates_schema: true,
-      block_works: true,
-      json_path: "$.data.name",
-      nested_name: "data.name"
-    })
-    expect(data_structure[:role]).to eq({
-      type: :string,
-      options: ["admin", "user"],
-      default: "user",
-      mutates_schema: true,
-      block_works: true,
-      json_path: "$.data.role",
-      nested_name: "data.role"
-    })
-    expect(data_structure[:extra]).to eq({
-      type: :array,
-      required: true,
-      block_works: true,
-      json_path: "$.data.extra[]",
-      nested_name: "data.extra",
-      structure: {
-        extra: {
-          default: false,
-          block_works: true,
-          json_path: "$.data.extra[].extra",
-          nested_name: "data.extra.extra",
-          policy_with_silent_error: {errors: []}
-        },
-        _subschemes: {}
-      }
-    })
-  end
-
-  it "generates flatten data for documentation generation" do
-    expect(schema.flatten_structure { |key, meta| meta[:block_works] = true if key.split(".").size == 1 }).to eq({
-      "data" => {
-        type: :object,
-        required: true,
-        present: true,
-        block_works: true,
-        json_path: "$.data"
-      },
-      "data.extra" => {
-        type: :array,
-        required: true,
-        json_path: "$.data.extra[]"
-      },
-      "data.extra.extra" => {
-        default: false,
-        json_path: "$.data.extra[].extra",
-        policy_with_silent_error: {errors: []}
-      },
-      "data.id" => {
-        type: :integer,
-        required: true,
-        present: true,
-        json_path: "$.data.id",
-        policy_with_error: {errors: [ArgumentError]}
-      },
-      "data.name" => {
-        type: :string,
-        json_path: "$.data.name",
-        label: "very important staff",
-        mutates_schema: true
-      },
-      "data.role" => {
-        type: :string,
-        options: ["admin", "user"],
-        default: "user",
-        json_path: "$.data.role",
-        mutates_schema: true
-      },
-      _errors: [ArgumentError],
-      _subschemes: {
-        test_subschema: {
-          _errors: [],
-          _subschemes: {},
-          "data.test1"=>{
-            required: true,
-            present: true,
-            json_path: "$.data.test1"
-          }
-        },
-        subschema: {
-          _errors: [],
-          _subschemes: {},
-          "data.test_field" => {required: true, present: true, json_path: "$.data.test_field"}
-        }
-      }
-    })
-  end
-end