paradocs 1.0.22

data/spec/struct_spec.rb

@@ -0,0 +1,324 @@
+require 'spec_helper'
+require 'paradocs/struct'
+
+describe Paradocs::Struct do
+  it "works" do
+    friend_class = Class.new do
+      include Paradocs::Struct
+
+      schema do
+        field(:name).type(:string).present
+        field(:age).type(:integer)
+      end
+    end
+
+    klass = Class.new do
+      include Paradocs::Struct
+
+      schema do
+        field(:title).type(:string).present
+        field(:friends).type(:array).default([]).schema friend_class
+      end
+    end
+
+    new_instance = klass.new
+    expect(new_instance.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
+
+    instance = klass.new({
+      title: 'foo',
+      friends: [
+        {name: 'Ismael', age: 40},
+        {name: 'Joe', age: 39},
+      ]
+    })
+
+    expect(instance.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
+
+    invalid_instance = klass.new({
+      friends: [
+        {name: 'Ismael', age: 40},
+        {age: 39},
+      ]
+    })
+
+    expect(invalid_instance.valid?).to be false
+    expect(invalid_instance.errors['$.title']).not_to be_nil
+    expect(invalid_instance.errors['$.friends[1].name']).not_to be_nil
+    expect(invalid_instance.friends[1].errors['$.name']).not_to be_nil
+  end
+
+  it "is inmutable by default" do
+    klass = Class.new do
+      include Paradocs::Struct
+
+      schema do
+        field(:title).type(:string).present
+        field(:friends).type(:array).default([])
+        field(:friend).type(:object)
+      end
+    end
+
+    instance = klass.new
+    expect {
+      instance.title = "foo"
+    }.to raise_error NoMethodError
+
+    expect {
+      instance.friends << 1
+    }.to raise_error RuntimeError
+  end
+
+  it "works with anonymous nested schemas" do
+    klass = Class.new do
+      include Paradocs::Struct
+
+      schema do
+        field(:title).type(:string).present
+        field(:friends).type(:array).schema do
+          field(:age).type(:integer)
+        end
+      end
+    end
+
+    instance = klass.new({
+      title: 'foo',
+      friends: [
+        {age: 10},
+        {age: 39},
+      ]
+    })
+
+    expect(instance.title).to eq 'foo'
+    expect(instance.friends.size).to eq 2
+    expect(instance.friends.first.age).to eq 10
+  end
+
+  it 'wraps nested schemas in custom class' do
+    klass = Class.new do
+      include Paradocs::Struct
+
+      def self.paradocs_build_class_for_child(key, child_schema)
+        Class.new do
+          include Paradocs::Struct
+          schema child_schema
+          def salutation
+            "my age is #{age}"
+          end
+        end
+      end
+
+      schema do
+        field(:name).type(:string).present
+        field(:friends).type(:array).schema do
+          field(:age).type(:integer)
+        end
+      end
+    end
+
+    user = klass.new(name: 'Ismael', friends: [{age: 43}])
+    expect(user.friends.first.salutation).to eq 'my age is 43'
+  end
+
+  it "wraps regular schemas in structs" do
+    friend_schema = Paradocs::Schema.new do
+      field(:name)
+    end
+
+    klass = Class.new do
+      include Paradocs::Struct
+
+      schema do
+        field(:title).type(:string).present
+        field(:friends).type(:array).schema friend_schema
+      end
+    end
+
+    instance = klass.new({
+      title: 'foo',
+      friends: [{name: 'Ismael'}]
+    })
+
+    expect(instance.friends.first.name).to eq 'Ismael'
+  end
+
+  it "#to_h" do
+    klass = Class.new do
+      include Paradocs::Struct
+
+      schema do
+        field(:title).type(:string).present
+        field(:friends).type(:array).schema do
+          field(:name).type(:string)
+          field(:age).type(:integer).default(20)
+        end
+      end
+    end
+
+    instance = klass.new({
+      title: 'foo',
+      friends: [
+        {name: 'Jane'},
+        {name: 'Joe', age: '39'},
+      ]
+    })
+
+    expect(instance.to_h).to eq({
+      title: 'foo',
+      friends: [
+        {name: 'Jane', age: 20},
+        {name: 'Joe', age: 39},
+      ]
+    })
+
+    new_instance = klass.new(instance.to_h)
+    expect(new_instance.title).to eq 'foo'
+
+    # it returns a copy so we can't break things!
+    data = new_instance.to_h
+    data[:title] = 'nope'
+    expect(new_instance.to_h[:title]).to eq 'foo'
+  end
+
+  it "works with inheritance" do
+    klass = Class.new do
+      include Paradocs::Struct
+
+      schema do
+        field(:title).type(:string).present
+        field(:friends).type(:array).schema do
+          field(:name).type(:string)
+          field(:age).type(:integer).default(20)
+        end
+      end
+    end
+
+    subclass = Class.new(klass) do
+      schema do
+        field(:email)
+      end
+    end
+
+    instance = subclass.new(
+      title: 'foo',
+      email: 'email@me.com',
+      friends: [
+        {name: 'Jane', age: 20},
+        {name: 'Joe', age: 39},
+      ]
+    )
+
+    expect(instance.title).to eq 'foo'
+    expect(instance.email).to eq 'email@me.com'
+    expect(instance.friends.size).to eq 2
+  end
+
+  it "implements deep struct equality" do
+    klass = Class.new do
+      include Paradocs::Struct
+
+      schema do
+        field(:title).type(:string).present
+        field(:friends).type(:array).schema do
+          field(:age).type(:integer)
+        end
+      end
+    end
+
+    s1 = klass.new({
+      title: 'foo',
+      friends: [
+        {age: 10},
+        {age: 39},
+      ]
+    })
+
+
+    s2 = klass.new({
+      title: 'foo',
+      friends: [
+        {age: 10},
+        {age: 39},
+      ]
+    })
+
+    s3 = klass.new({
+      title: 'foo',
+      friends: [
+        {age: 11},
+        {age: 39},
+      ]
+    })
+
+    s4 = klass.new({
+      title: 'bar',
+      friends: [
+        {age: 10},
+        {age: 39},
+      ]
+    })
+
+    expect(s1 == s2).to be true
+    expect(s1 == s3).to be false
+    expect(s1 == s4).to be false
+  end
+
+  it "#merge returns a new instance" do
+    klass = Class.new do
+      include Paradocs::Struct
+
+      schema do
+        field(:title).type(:string).present
+        field(:desc)
+        field(:friends).type(:array).schema do
+          field(:name).type(:string)
+        end
+      end
+    end
+
+    original = klass.new(
+      title: 'foo',
+      desc: 'no change',
+      friends: [{name: 'joe'}]
+    )
+
+    copy = original.merge(
+      title: 'bar',
+      friends: [{name: 'jane'}]
+    )
+
+    expect(original.title).to eq 'foo'
+    expect(original.desc).to eq 'no change'
+    expect(original.friends.first.name).to eq 'joe'
+
+    expect(copy.title).to eq 'bar'
+    expect(copy.desc).to eq 'no change'
+    expect(copy.friends.first.name).to eq 'jane'
+  end
+
+  describe '.new!' do
+    it 'raises a useful exception if invalid data' do
+      klass = Class.new do
+        include Paradocs::Struct
+
+        schema do
+          field(:title).type(:string).present
+        end
+      end
+
+      begin
+        klass.new!(title: '')
+      rescue Paradocs::InvalidStructError => e
+        expect(e.errors['$.title']).not_to be nil
+      end
+
+      valid = klass.new!(title: 'foo')
+      expect(valid.title).to eq 'foo'
+    end
+  end
+end

data/spec/subschema_spec.rb

@@ -0,0 +1,178 @@
+require 'spec_helper'
+require "paradocs/dsl"
+
+describe "schemes with subschemes" do
+  let(:validation_class) do
+    Class.new do
+      include Paradocs::DSL
+
+      schema(:request) do
+        field(:action).present.options([:update, :delete]).mutates_schema! do |action, *|
+          action == :update ? :update_schema : :generic_schema
+        end
+
+        subschema(:update_schema) do
+          field(:event).present
+        end
+
+        subschema(:generic_schema) do
+          field(:generic_field).present
+        end
+      end
+
+      def self.validate(schema_name, data)
+        schema(schema_name).resolve(data)
+      end
+    end
+  end
+
+  let(:update_request) {
+    {
+      action: :update,
+      event:  "test"
+    }
+  }
+
+  it "invokes necessary subschema based on condition" do
+    valid_result = validation_class.validate(:request, update_request)
+    expect(valid_result.output).to eq(update_request)
+    expect(valid_result.errors).to eq({})
+
+    failed_result = validation_class.validate(:request, {action: :update, generic_field: "test"})
+
+    expect(failed_result.errors).to eq({"$.event"=>["is required"]})
+    expect(failed_result.output).to eq({action: :update, event: nil})
+  end
+
+  describe "ghost fields" do
+    let(:schema) do
+      Paradocs::Schema.new do
+        mutation_by!(:error) do |value, key, *args|
+          value.nil? ? :success : :fail
+        end
+
+        subschema(:fail) do
+          field(:fail_field).present
+        end
+        subschema(:success) do
+          field(:success_field).present
+        end
+      end
+    end
+
+    it "mutates schema as expected and doesn't reflect on current schema structure" do
+      structure = {
+        _errors: [],
+        _subschemes: {
+          fail:    {_errors: [], _subschemes: {}, fail_field: {required: true, present: true, json_path: "$.fail_field", nested_name: "fail_field"}},
+          success: {_errors: [], _subschemes: {}, success_field: {required: true, present: true, json_path: "$.success_field", nested_name: "success_field"}}
+        }
+      }
+      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(
+        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(
+        error: {transparent: true, mutates_schema: true, json_path: "$.error", nested_name: "error"}
+      ))
+    end
+  end
+
+  describe "nested subschemes" do
+    let(:schema) do
+      Paradocs::Schema.new do
+        field(:action).present.options([:update, :delete]).mutates_schema! do |value, key, payload|
+          value == :update ? :update_schema : :generic_schema
+        end
+        field(:event).declared.type(:string)
+
+        subschema(:generic_schema) do
+          field(:generic_field).present
+        end
+
+        subschema(:update_schema) do
+          field(:event).present.mutates_schema! do |value, key, payload|
+            value == :go_deeper ? :very_deep_schema : :deep_update_schema
+          end
+          field(:update_field).present
+          subschema(:deep_update_schema) do
+            field(:field_from_deep_schema).required
+          end
+
+          subschema(:very_deep_schema) do
+            field(:a_hash).type(:object).present.schema do
+              field(:key).present.mutates_schema! { :draft_subschema }
+              subschema(:draft_subschema) do
+                field(:another_event).present.type(:boolean)
+              end
+            end
+          end
+        end
+      end
+    end
+
+    context "update_schema -> deep_update_schema" do
+      let(:payload) {
+        {
+          action:                 :update,
+          event:                  :must_be_present,
+          update_field:           1,
+          field_from_deep_schema: nil
+        }
+      }
+
+      it "builds schema as expected" do
+        result = schema.resolve(payload)
+        expect(result.output).to eq(payload)
+        expect(result.errors).to eq({})
+      end
+
+      it "fails when validation fails in subschemas" do
+        result = schema.resolve(payload.merge(action: :delete))
+        expect(result.output).to eq(action: :delete, event: "must_be_present", generic_field: nil)
+        expect(result.errors).to eq("$.generic_field"=>["is required"])
+      end
+
+      it "overwrites fields: subschema field overwrites parent field" do
+        payload.delete(:event)
+        result = schema.resolve(payload)
+      end
+    end
+
+    context "update_schema -> very_deep_schema -> draft_subschema" do
+      let(:payload) {
+        {
+          action:         :update,
+          event:          :go_deeper,
+          update_field:   1,
+          a_hash:       {
+            key:           :value,
+            another_event: true
+          }
+        }
+      }
+
+      it "builds schema as expected"  do
+        result = schema.resolve(payload)
+        expect(result.output).to eq(payload)
+        expect(result.errors).to eq({})
+      end
+
+      it "fails when payload doesn't suit just built schema" do
+        payload[:a_hash] = {key: :random}
+        result = schema.resolve(payload)
+        payload[:a_hash][:another_event] = nil
+        expect(result.output).to eq(payload)
+        expect(result.errors).to eq({"$.a_hash.another_event"=>["is required"]})
+      end
+    end
+  end
+end

data/spec/validators_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe 'default validators' do
+
+  def test_validator(payload, key, name, eligible, valid, *args)
+    validator = Paradocs.registry.policies[name]
+    validator = validator.new(*args) if validator.respond_to?(:new)
+    expect(validator.eligible?(payload[key], key, payload)).to eq eligible
+    expect(validator.valid?(payload[key], key, payload)).to eq valid
+  end
+
+  describe ':format' do
+    it {
+      test_validator({key: 'Foobar'}, :key, :format, true, true, /^Foo/)
+      test_validator({key: 'Foobar'}, :key, :format, true, false, /^Bar/)
+      test_validator({foo: 'Foobar'}, :key, :format, false, true, /^Foo/)
+    }
+  end
+
+  describe ':email' do
+    it {
+      test_validator({key: 'foo@bar.com'}, :key, :email, true, true)
+      test_validator({key: 'foo@'}, :key, :email, true, false)
+      test_validator({foo: 'foo@bar.com'}, :key, :email, false, true)
+    }
+  end
+
+  describe ':required' do
+    it {
+      test_validator({key: 'foo'}, :key, :required, true, true)
+      test_validator({key: ''}, :key, :required, true, true)
+      test_validator({key: nil}, :key, :required, true, true)
+      test_validator({foo: 'foo'}, :key, :required, true, false)
+    }
+  end
+
+  describe ':present' do
+    it {
+      test_validator({key: 'foo'}, :key, :present, true, true)
+      test_validator({key: ''}, :key, :present, true, false)
+      test_validator({key: nil}, :key, :present, true, false)
+      test_validator({foo: 'foo'}, :key, :present, true, false)
+    }
+  end
+
+  describe ':declared' do
+    it {
+      test_validator({key: 'foo'}, :key, :declared, true, true)
+      test_validator({key: ''}, :key, :declared, true, true)
+      test_validator({key: nil}, :key, :declared, true, true)
+      test_validator({foo: 'foo'}, :key, :declared, false, true)
+    }
+  end
+
+  describe ':options' do
+    it {
+      test_validator({key: 'b'}, :key, :options, true, true, %w(a b c))
+      test_validator({key: 'd'}, :key, :options, true, false, %w(a b c))
+      test_validator({key: ['c', 'b']}, :key, :options, true, true, %w(a b c))
+      test_validator({key: ['c', 'b', 'd']}, :key, :options, true, false, %w(a b c))
+      test_validator({foo: 'b'}, :key, :options, false, true, %w(a b c))
+    }
+  end
+
+  describe ':array' do
+    it {
+      test_validator({key: ['a', 'b']}, :key, :array, true, true)
+      test_validator({key: []}, :key, :array, true, true)
+      test_validator({key: nil}, :key, :array, true, false)
+      test_validator({key: 'hello'}, :key, :array, true, false)
+      test_validator({key: 123}, :key, :array, true, false)
+      test_validator({foo: []}, :key, :array, true, true)
+    }
+  end
+
+  describe ':object' do
+    it {
+      test_validator({key: {'a' =>'b'}}, :key, :object, true, true)
+      test_validator({key: {}}, :key, :object, true, true)
+      test_validator({key: ['a', 'b']}, :key, :object, true, false)
+      test_validator({key: nil}, :key, :object, true, false)
+      test_validator({key: 123}, :key, :object, true, false)
+      test_validator({foo: {}}, :key, :object, true, true)
+    }
+  end
+end

data/spec/whitelist_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+require "paradocs/whitelist"
+require "paradocs/dsl"
+
+describe "classes including Whitelist module" do
+  class TestWhitelist
+    include Paradocs::DSL
+    include Paradocs::Whitelist
+
+    schema(:request) do
+      field(:data).present.type(:array).schema do
+        field(:id).present.type(:string).whitelisted
+        field(:name).present.type(:string)
+        field(:empty_array).type(:array).schema do
+          field(:id).whitelisted
+        end
+        field(:subschema_1).whitelisted.mutates_schema! { |name, *| name.to_sym }
+        field(:empty_hash).type(:array).schema do
+          field(:id).whitelisted
+        end
+        field(:extra).schema do
+          field(:id).present.type(:string).whitelisted
+          field(:name).present.type(:string)
+          field(:empty_string).present.type(:string)
+        end
+
+        subschema(:subfield_1) do
+          field(:subfield_1).present.type(:boolean).whitelisted
+          field(:subschema_2).mutates_schema! { |name, *| name.to_sym }
+
+          subschema(:subfield_2) do
+            field(:subfield_2).present.type(:boolean).whitelisted
+          end
+        end
+      end
+    end
+  end
+
+  describe ".filter!" do
+    let(:schema) { TestWhitelist.schema(:request) }
+    let(:input) {
+      {
+        "unexpected" => "test",
+        from_config: "whitelisted",
+        data: [
+          "id" => 5,
+          name: nil,
+          unexpected: nil,
+          empty_array: [],
+          subschema_1: "subfield_1",
+          subfield_1: true,
+          subschema_2: "subfield_2",
+          subfield_2: true,
+          empty_hash: {},
+          "extra" => {
+            id: 6,
+            name: "name",
+            unexpected: "unexpected",
+            empty_string: ""
+          }
+        ]
+      }
+    }
+
+    before { Paradocs.config.whitelisted_keys = [:from_config]}
+
+    it "should filter not whitelisted attributes with different key's type" do
+      whitelisted = TestWhitelist.new.filter!(input, schema)
+
+      expect(whitelisted).to eq(
+        {
+          unexpected: "[FILTERED]",
+          from_config: "whitelisted",
+          data: [
+            {
+              id: 5,
+              name: "[EMPTY]",
+              unexpected: "[EMPTY]",
+              empty_array: [],
+              subschema_1: "subfield_1",
+              subfield_1: true,
+              subschema_2: "[FILTERED]",
+              subfield_2: true,
+              empty_hash: {},
+              extra: {
+                id: 6,
+                name: "[FILTERED]",
+                unexpected: "[FILTERED]",
+                empty_string: "[EMPTY]"
+              }
+            }
+          ]
+        }
+      )
+    end
+  end
+end