jat 0.0.1 → 0.0.7

data/test/lib/jat/plugins/json_api_preloads/json_api_preloads_test.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+describe "Jat::Plugins::JsonApiPreloads" do
+  before do
+    @plugin = Jat::Plugins.find_plugin(:json_api_preloads)
+  end
+
+  it "checks json_api plugin loaded before" do
+    jat_class = Class.new(Jat)
+    error = assert_raises(Jat::Error) { jat_class.plugin @plugin }
+    assert_match(/json_api/, error.message)
+  end
+
+  it "loads other plugins" do
+    jat_class = Class.new(Jat)
+    jat_class.plugin :json_api
+
+    jat_class.expects(:plugin).with(:_preloads, foo: :bar)
+
+    @plugin.before_load(jat_class, foo: :bar)
+  end
+
+  describe "InstanceMethods" do
+    it "add .preloads method as a delegator to #{@plugin}::Preloads" do
+      jat_class = Class.new(Jat)
+      jat_class.plugin :json_api
+      jat_class.plugin @plugin
+      jat = jat_class.allocate
+
+      @plugin::Preloads.expects(:call).with(jat).returns("RES")
+
+      assert_equal "RES", jat.preloads
+    end
+  end
+end

data/test/lib/jat/plugins/json_api_preloads/lib/preloads_test.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+describe "Jat::Plugins::JsonApiPreloads::Preloads" do
+  let(:base) do
+    Class.new(Jat) do
+      plugin :json_api
+      plugin :json_api_preloads
+    end
+  end
+
+  let(:user_serializer) { Class.new(base) { type(:user) } }
+  let(:profile_serializer) { Class.new(base) { type(:profile) } }
+  let(:email_serializer) { Class.new(base) { type(:email) } }
+
+  let(:jat_user) { user_serializer.allocate }
+  let(:jat_profile) { profile_serializer.allocate }
+  let(:jat_email) { email_serializer.allocate }
+
+  let(:described_class) { Jat::Plugins::JsonApiPreloads::Preloads }
+
+  def define_map(map)
+    jat_user.expects(:map).returns(map)
+  end
+
+  it "returns empty hash when no attributes requested" do
+    define_map(user: {attributes: [], relationships: []})
+
+    result = described_class.call(jat_user)
+    assert_equal({}, result)
+  end
+
+  it "returns empty hash when no attributes with preloads requested" do
+    user_serializer.attribute :name
+    define_map(user: {attributes: [:name], relationships: []})
+
+    result = described_class.call(jat_user)
+    assert_equal({}, result)
+  end
+
+  it "returns preloads for requested attributes" do
+    user_serializer.attribute :name, preload: :profile
+    define_map(user: {attributes: [:name], relationships: []})
+
+    result = described_class.call(jat_user)
+    assert_equal({profile: {}}, result)
+  end
+
+  it "returns merged preloads for requested attributes" do
+    user_serializer.attribute :first_name, preload: :profile
+    user_serializer.attribute :phone, preload: {profile: :phones}
+    user_serializer.attribute :email, preload: {profile: :emails}
+
+    define_map(user: {attributes: %i[first_name phone email], relationships: []})
+
+    result = described_class.call(jat_user)
+    assert_equal({profile: {phones: {}, emails: {}}}, result)
+  end
+
+  it "returns no preloads and no nested preloads for relationships when specified preloads is nil" do
+    user_serializer.relationship :profile, serializer: profile_serializer, preload: nil
+    profile_serializer.attribute :email, preload: :email # should not be preloaded
+    define_map(
+      user: {attributes: [], relationships: %i[profile]},
+      profile: {attributes: %i[email], relationships: []}
+    )
+
+    result = described_class.call(jat_user)
+    assert_equal({}, result)
+  end
+
+  it "returns preloads for nested relationships joined to root when specified preloads is {} or []" do
+    [{}, []].each do |preloads|
+      user_serializer.relationship :profile, serializer: profile_serializer, preload: preloads
+      profile_serializer.attribute :email, preload: :email # should be preloaded to root
+      define_map(
+        user: {attributes: [], relationships: %i[profile]},
+        profile: {attributes: %i[email], relationships: []}
+      )
+
+      result = described_class.call(jat_user)
+      assert_equal({email: {}}, result)
+    end
+  end
+
+  it "returns preloads for relationships" do
+    user_serializer.relationship :profile, serializer: profile_serializer
+    define_map(
+      user: {attributes: [], relationships: %i[profile]},
+      profile: {attributes: [], relationships: []}
+    )
+
+    result = described_class.call(jat_user)
+    assert_equal({profile: {}}, result)
+  end
+
+  it "returns nested preloads for relationships" do
+    user_serializer.relationship :profile, serializer: profile_serializer
+    profile_serializer.attribute :email, preload: %i[confirmed_email unconfirmed_email]
+
+    define_map(
+      user: {attributes: [], relationships: %i[profile]},
+      profile: {attributes: %i[email], relationships: []}
+    )
+
+    result = described_class.call(jat_user)
+    assert_equal({profile: {confirmed_email: {}, unconfirmed_email: {}}}, result)
+  end
+
+  it "preloads nested relationships for nested relationship" do
+    user_serializer.relationship :profile, serializer: profile_serializer, preload: {company: :profile}
+    profile_serializer.attribute :email, preload: %i[confirmed_email unconfirmed_email]
+
+    define_map(
+      user: {attributes: [], relationships: %i[profile]},
+      profile: {attributes: %i[email], relationships: []}
+    )
+
+    result = described_class.call(jat_user)
+    assert_equal({company: {profile: {confirmed_email: {}, unconfirmed_email: {}}}}, result)
+  end
+
+  it "preloads nested relationships to main (!) resource" do
+    user_serializer.relationship :profile, serializer: profile_serializer, preload: {company!: :profile}
+    profile_serializer.attribute :email, preload: %i[confirmed_email unconfirmed_email]
+
+    define_map(
+      user: {attributes: [], relationships: %i[profile]},
+      profile: {attributes: %i[email], relationships: []}
+    )
+
+    result = described_class.call(jat_user)
+    assert_equal({company: {profile: {}, confirmed_email: {}, unconfirmed_email: {}}}, result)
+  end
+
+  it "does not raise error if 2 serializers with recursive preloads specified" do
+    user_serializer.relationship :profile, serializer: profile_serializer, preload: :profile
+    profile_serializer.relationship :user, serializer: user_serializer, preload: :user
+
+    define_map(
+      user: {attributes: [], relationships: %i[profile]},
+      profile: {attributes: [], relationships: %i[user]}
+    )
+
+    expected_result = {profile: {user: {}}}
+    assert_equal(expected_result, described_class.call(jat_user))
+  end
+
+  it "does not raise error if 3 serializers with recursive preloads specified" do
+    user_serializer.relationship :profile, serializer: profile_serializer, preload: :profile
+    profile_serializer.relationship :email, serializer: email_serializer, preload: :email
+    email_serializer.relationship :user, serializer: user_serializer, preload: :user
+
+    define_map(
+      user: {attributes: [], relationships: %i[profile]},
+      profile: {attributes: [], relationships: %i[email]},
+      email: {attributes: [], relationships: %i[user]}
+    )
+
+    expected_result = {profile: {email: {user: {}}}}
+    assert_equal(expected_result, described_class.call(jat_user))
+  end
+
+  it "does not raises error if 2 serializers preloads same preloads" do
+    user_serializer.relationship :profile, serializer: profile_serializer, preload: :profile
+    user_serializer.relationship :email, serializer: email_serializer, preload: :email
+    profile_serializer.relationship :email, serializer: email_serializer, preload: :email
+
+    define_map(
+      user: {attributes: [], relationships: %i[profile email]},
+      profile: {attributes: [], relationships: %i[email]},
+      email: {attributes: [], relationships: %i[]}
+    )
+
+    expected_result = {profile: {email: {}}, email: {}}
+    assert_equal(expected_result, described_class.call(jat_user))
+  end
+
+  it "merges preloads the same way regardless of order of preloads" do
+    a = Class.new(base) { type(:a) }
+    a.attribute :a1, preload: {foo: {bar: {bazz1: {}, bazz: {}}}}
+    a.attribute :a2, preload: {foo: {bar: {bazz2: {}, bazz: {last: {}}}}}
+
+    jat_a1 = a.allocate
+    jat_a2 = a.allocate
+
+    jat_a1.expects(:map).returns(a: {attributes: %i[a1 a2], relationships: %i[]})
+    jat_a2.expects(:map).returns(a: {attributes: %i[a2 a1], relationships: %i[]})
+
+    result1 = described_class.call(jat_a1)
+    result2 = described_class.call(jat_a2)
+
+    assert_equal(result2, result1)
+    assert_equal({foo: {bar: {bazz: {last: {}}, bazz1: {}, bazz2: {}}}}, result1)
+  end
+end

data/test/lib/jat/plugins/json_api_validate_params/json_api_validate_params_test.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+describe "Jat::Plugins::JsonApiValidateParams" do
+  before do
+    @plugin = Jat::Plugins.find_plugin(:json_api_validate_params)
+  end
+
+  it "checks json_api plugin loaded before" do
+    jat_class = Class.new(Jat)
+    error = assert_raises(Jat::Error) { jat_class.plugin @plugin }
+    assert_match(/json_api/, error.message)
+  end
+
+  let(:serializer) do
+    jat_class = Class.new(Jat)
+    jat_class.plugin :json_api
+    jat_class.plugin @plugin
+
+    jat_class.type "foo"
+    jat_class.attribute :foo_bar
+    jat_class.relationship :foo_bazz, serializer: jat_class
+    jat_class
+  end
+
+  let(:serializer_lower_camel_case) do
+    jat_class = Class.new(Jat)
+    jat_class.plugin :json_api
+    jat_class.plugin :json_api_lower_camel_case
+    jat_class.plugin @plugin
+
+    jat_class.type "foo"
+    jat_class.attribute :foo_bar
+    jat_class.relationship :foo_bazz, serializer: jat_class
+    jat_class
+  end
+
+  it "validates fields types" do
+    jat = serializer.new(fields: {bar: "any"})
+    error = assert_raises(Jat::JsonApiParamsError) { jat.validate }
+
+    expected_message = "Response does not have resources with type 'bar'. Existing types are: 'foo'"
+    assert_equal(expected_message, error.message)
+  end
+
+  it "validates attributes" do
+    jat = serializer.new(fields: {foo: "foo_bar,foo_baz"})
+    error = assert_raises(Jat::JsonApiParamsError) { jat.validate }
+
+    expected_message = "No attribute 'foo_baz' in resource type 'foo'. Existing attributes are: 'foo_bar', 'foo_bazz'"
+    assert_equal(expected_message, error.message)
+  end
+
+  it "validates attributes correctly when lower_camel_case plugin loaded" do
+    jat = serializer_lower_camel_case.new(fields: {foo: "fooBar,fooBaz"})
+    error = assert_raises(Jat::JsonApiParamsError) { jat.validate }
+
+    expected_message = "No attribute 'fooBaz' in resource type 'foo'. Existing attributes are: 'fooBar', 'fooBazz'"
+    assert_equal(expected_message, error.message)
+  end
+
+  it "validates includes" do
+    jat = serializer.new(include: "extra")
+    error = assert_raises(Jat::JsonApiParamsError) { jat.validate }
+    expected_message = "Type 'foo' has no included 'extra' relationship. Existing relationships are: 'foo_bazz'"
+    assert_equal(expected_message, error.message)
+  end
+
+  it "validates includes when parameter named as existing attribute (not relationship)" do
+    jat = serializer.new(include: "foo_bar")
+    error = assert_raises(Jat::JsonApiParamsError) { jat.validate }
+    expected_message = "Type 'foo' has no included 'foo_bar' relationship. Existing relationships are: 'foo_bazz'"
+    assert_equal(expected_message, error.message)
+  end
+
+  it "validates includes correctly when lower_camel_case plugin loaded" do
+    jat = serializer_lower_camel_case.new(include: "extra")
+    error = assert_raises(Jat::JsonApiParamsError) { jat.validate }
+
+    expected_message = "Type 'foo' has no included 'extra' relationship. Existing relationships are: 'fooBazz'"
+    assert_equal(expected_message, error.message)
+  end
+end

data/test/lib/jat/plugins/simple_api/lib/fields_param_parser_test.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+describe "Jat::Plugins::SimpleApi::FieldsParamParser" do
+  before do
+    Jat::Plugins.find_plugin :simple_api
+  end
+
+  let(:jat_class) do
+    ser = Class.new(Jat)
+    ser.plugin :simple_api
+    ser
+  end
+
+  def parse(str)
+    jat_class::FieldsParamParser.parse(str)
+  end
+
+  it "returns empty hash when nil provided" do
+    assert_equal({}, parse(nil))
+  end
+
+  it "returns empty hash when empty string provided" do
+    assert_equal({}, parse(""))
+  end
+
+  it "parses single field" do
+    assert_equal({id: {}}, parse("id"))
+  end
+
+  it "parses multiple fields" do
+    assert_equal({id: {}, name: {}}, parse("id, name"))
+  end
+
+  it "parses single resource with single field" do
+    assert_equal({users: {id: {}}}, parse("users(id)"))
+  end
+
+  it "parses fields started with open PAREN" do
+    assert_equal({users: {id: {}}}, parse("(users(id))"))
+  end
+
+  it "parses single resource with multiple fields" do
+    assert_equal({users: {id: {}, name: {}}}, parse("users(id,name)"))
+  end
+
+  it "parses multiple resources with fields" do
+    fields = "id,posts(title,text),news(title,text)"
+    resp = {
+      id: {},
+      posts: {title: {}, text: {}},
+      news: {title: {}, text: {}}
+    }
+
+    assert_equal(resp, parse(fields))
+  end
+
+  it "parses included resources" do
+    fields = "id,posts(title,text,comments(author(name),comment))"
+    resp = {
+      id: {},
+      posts: {
+        title: {},
+        text: {},
+        comments: {
+          author: {
+            name: {}
+          },
+          comment: {}
+        }
+      }
+    }
+
+    assert_equal(resp, parse(fields))
+  end
+end

data/test/lib/jat/plugins/simple_api/lib/map_test.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+describe "Jat::Plugins::SimpleApi::Map" do
+  before { Jat::Plugins.find_plugin(:simple_api) }
+
+  let(:base_class) { Class.new(Jat) { plugin :simple_api } }
+  let(:described_class) { a::Map }
+
+  let(:a) do
+    ser = Class.new(base_class)
+
+    ser.attribute :a1
+    ser.attribute :a2
+    ser.attribute :a3, exposed: false
+
+    ser.attribute :b, serializer: b
+    ser.attribute :c, serializer: c
+    ser.attribute :d, serializer: d, exposed: true
+    ser
+  end
+
+  let(:b) do
+    ser = Class.new(base_class)
+    ser.attribute :b1
+    ser.attribute :b2
+    ser.attribute :b3, exposed: false
+    ser
+  end
+
+  let(:c) do
+    ser = Class.new(base_class)
+    ser.attribute :c1
+    ser.attribute :c2
+    ser.attribute :c3, exposed: false
+    ser
+  end
+
+  let(:d) do
+    ser = Class.new(base_class)
+    ser.attribute :d1
+    ser.attribute :d2
+    ser.attribute :d3, exposed: false
+    ser
+  end
+
+  it "returns all attributes when {exposed: :all} provided " do
+    result = described_class.call(exposed: :all)
+    expected_result = {
+      a1: {},
+      a2: {},
+      a3: {},
+      b: {b1: {}, b2: {}, b3: {}},
+      c: {c1: {}, c2: {}, c3: {}},
+      d: {d1: {}, d2: {}, d3: {}}
+    }
+
+    assert_equal expected_result, result
+  end
+
+  it "returns exposed attributes when {exposed: :default} provided" do
+    result = described_class.call(exposed: :default)
+    expected_result = {
+      a1: {},
+      a2: {},
+      d: {d1: {}, d2: {}}
+    }
+
+    assert_equal expected_result, result
+  end
+
+  it "returns exposed attributes when no :exposed param provided" do
+    result = described_class.call({})
+    expected_result = {
+      a1: {},
+      a2: {},
+      d: {d1: {}, d2: {}}
+    }
+
+    assert_equal expected_result, result
+  end
+
+  it "returns no attributes when `{exposed: :none}` provided" do
+    result = described_class.call(exposed: :none)
+    assert_equal({}, result)
+  end
+
+  it "returns only manually exposed attributes when `{exposed: :none}` type provided" do
+    fields = "a2,a3,c(c2,c3),d(d2,d3)"
+    result = described_class.call(exposed: :none, fields: fields)
+
+    expected_result = {
+      a2: {},
+      a3: {},
+      c: {c2: {}, c3: {}},
+      d: {d2: {}, d3: {}}
+    }
+
+    assert_equal expected_result, result
+  end
+
+  it "returns combined auto-exposed and manually exposed attributes when `default` type provided" do
+    fields = "b(b3),c"
+    result = described_class.call(exposed: :default, fields: fields)
+    expected_result = {
+      a1: {},
+      a2: {},
+      b: {b1: {}, b2: {}, b3: {}},
+      c: {c1: {}, c2: {}},
+      d: {d1: {}, d2: {}}
+    }
+
+    assert_equal expected_result, result
+  end
+
+  it "raises error with informative message about recursive serialization" do
+    a.relationship :b, serializer: -> { b }, exposed: true
+    b.relationship :a, serializer: -> { a }, exposed: true
+
+    error = assert_raises(Jat::Error) { described_class.call({}) }
+    assert_includes "Recursive serialization: b -> a -> b", error.message
+  end
+
+  it "raises error with informative message about recursive serialization through 3 serializers" do
+    a.relationship :b, serializer: -> { b }, exposed: true
+    b.relationship :c, serializer: -> { c }, exposed: true
+    c.relationship :a, serializer: -> { a }, exposed: true
+
+    error = assert_raises(Jat::Error) { described_class.call({}) }
+    assert_equal "Recursive serialization: b -> c -> a -> b", error.message
+  end
+end