jat 0.0.3 → 0.0.8

data/test/lib/jat/plugins/json_api_maps_cache/json_api_maps_cache_test.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+describe "Jat::Plugins::JsonApiMapsCache" do
+  before do
+    @plugin = Jat::Plugins.find_plugin(:json_api_maps_cache)
+  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 "adds config variable how many maps to store per serializer" do
+    jat_class = Class.new(Jat)
+
+    @plugin.after_load(jat_class)
+    assert_equal(100, jat_class.config[:cached_maps_count]) # default 100
+
+    @plugin.after_load(jat_class, cached_maps_count: 10) # change value via opts
+    assert_equal(10, jat_class.config[:cached_maps_count])
+  end
+
+  describe "Test maps responses" do
+    let(:jat_class) do
+      Class.new(Jat) do
+        plugin(:json_api)
+        plugin(:json_api_maps_cache)
+
+        type :foo
+
+        attribute(:attr1)
+        attribute(:attr2)
+
+        relationship(:rel1, serializer: self)
+        relationship(:rel2, serializer: self)
+      end
+    end
+
+    it "returns same maps when requested with same params" do
+      full_map1 = jat_class::Map.call(exposed: :all)
+      full_map2 = jat_class::Map.call(exposed: :all)
+
+      exposed_map1 = jat_class::Map.call(exposed: :default)
+      exposed_map2 = jat_class::Map.call(exposed: :default)
+
+      current_map1 = jat_class::Map.call(include: "rel2", fields: {foo: "attr1,rel1"})
+      current_map2 = jat_class::Map.call(include: "rel2", fields: {foo: "attr1,rel1"})
+
+      assert_same(full_map1, full_map2)
+      assert_same(exposed_map1, exposed_map2)
+      assert_same(current_map1, current_map2)
+
+      # check different maps are not same
+
+      # should not match, include is not same
+      current_map3 = jat_class::Map.call(include: "rel1", fields: {foo: "attr1,rel1"})
+      # should not match, fields are not same
+      current_map4 = jat_class::Map.call(include: "rel2", fields: {foo: "attr1,rel2"})
+
+      assert !current_map1.equal?(current_map3)
+      assert !current_map1.equal?(current_map4)
+      assert !current_map3.equal?(current_map4)
+    end
+
+    it "stores different maps keys" do
+      # key 1
+      jat_class::Map.call(exposed: :all)
+      jat_class::Map.call(exposed: :all)
+
+      # key 2
+      jat_class::Map.call(exposed: :default)
+      jat_class::Map.call(exposed: :default)
+
+      # key 3
+      jat_class::Map.call(include: "rel2", fields: {foo: "attr1,rel1"})
+      jat_class::Map.call(include: "rel2", fields: {foo: "attr1,rel1"})
+
+      # key 4
+      jat_class::Map.call(include: "rel1", fields: {foo: "attr1,rel1"})
+
+      # key 5
+      jat_class::Map.call(include: "rel2", fields: {foo: "attr1,rel2"})
+
+      assert_equal 5, jat_class::Map.maps_cache.keys.count
+    end
+
+    it "clears old results when there are too many cache keys" do
+      jat_class.config[:cached_maps_count] = 1
+
+      full_map1 = jat_class::Map.call(exposed: :all)
+      full_map2 = jat_class::Map.call(exposed: :all)
+
+      # ensure maps refer to same object
+      assert_same(full_map1, full_map2)
+
+      # replace single possible cache key with another `exposed` map
+      jat_class::Map.call(exposed: :default)
+
+      # calculate full map again, it should not match
+      full_map3 = jat_class::Map.call(exposed: :all)
+      assert !full_map1.equal?(full_map3)
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# 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(:base_preloads, foo: :bar)
+
+    @plugin.before_load(jat_class, foo: :bar)
+  end
+
+  describe "InstanceMethods" do
+    it "adds #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
+
+  describe "ClassMethods" do
+    it "adds .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
+      jat_class.expects(:new).with("CONTEXT").returns(jat)
+      @plugin::Preloads.expects(:call).with(jat).returns("RES")
+
+      assert_equal "RES", jat_class.preloads("CONTEXT")
+    end
+  end
+end

data/test/lib/jat/plugins/{_json_api_activerecord → json_api_preloads}/lib/preloads_test.rb

@@ -2,8 +2,13 @@
 
 require "test_helper"
 
-describe "Jat::Plugins::JsonApiActiverecord::Preloads" do
-  let(:base) { Class.new(Jat) { plugin :json_api, activerecord: true } }
+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) } }
@@ -13,10 +18,10 @@ describe "Jat::Plugins::JsonApiActiverecord::Preloads" do
   let(:jat_profile) { profile_serializer.allocate }
   let(:jat_email) { email_serializer.allocate }
 
-  let(:described_class) { Jat::Plugins::JsonApiActiverecord::Preloads }
+  let(:described_class) { Jat::Plugins::JsonApiPreloads::Preloads }
 
   def define_map(map)
-    jat_user.traversal_map.expects(:current).returns(map)
+    jat_user.expects(:map).returns(map)
   end
 
   it "returns empty hash when no attributes requested" do
@@ -129,7 +134,7 @@ describe "Jat::Plugins::JsonApiActiverecord::Preloads" do
     assert_equal({company: {profile: {}, confirmed_email: {}, unconfirmed_email: {}}}, result)
   end
 
-  it "raises error if with 2 serializers have recursive preloads" do
+  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
 
@@ -138,11 +143,11 @@ describe "Jat::Plugins::JsonApiActiverecord::Preloads" do
       profile: {attributes: [], relationships: %i[user]}
     )
 
-    error = assert_raises(Jat::Error) { described_class.call(jat_user) }
-    assert_match(/recursive preloads/, error.message)
+    expected_result = {profile: {user: {}}}
+    assert_equal(expected_result, described_class.call(jat_user))
   end
 
-  it "raises error if 3 serializers recursive preloads" do
+  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
@@ -153,8 +158,8 @@ describe "Jat::Plugins::JsonApiActiverecord::Preloads" do
       email: {attributes: [], relationships: %i[user]}
     )
 
-    error = assert_raises(Jat::Error) { described_class.call(jat_user) }
-    assert_match(/recursive preloads/, error.message)
+    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
@@ -168,7 +173,8 @@ describe "Jat::Plugins::JsonApiActiverecord::Preloads" do
       email: {attributes: [], relationships: %i[]}
     )
 
-    described_class.call(jat_user) # should not raise
+    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
@@ -179,8 +185,8 @@ describe "Jat::Plugins::JsonApiActiverecord::Preloads" do
     jat_a1 = a.allocate
     jat_a2 = a.allocate
 
-    jat_a1.traversal_map.expects(:current).returns(a: {attributes: %i[a1 a2], relationships: %i[]})
-    jat_a2.traversal_map.expects(:current).returns(a: {attributes: %i[a2 a1], relationships: %i[]})
+    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)

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

@@ -0,0 +1,108 @@
+# 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(:base) do
+    jat_class = Class.new(Jat)
+    jat_class.plugin :json_api
+    jat_class
+  end
+
+  let(:serializer) do
+    jat_class = Class.new(base)
+    jat_class.plugin @plugin
+
+    jat_class.type "foo"
+    jat_class.attribute :foo_bar
+    jat_class.relationship :foo_bazz, serializer: foo_bazz_serializer
+    jat_class
+  end
+
+  let(:foo_bazz_serializer) do
+    jat_class = Class.new(base)
+    jat_class.type "foo_bazz"
+    jat_class.attribute :bazz
+    jat_class
+  end
+
+  let(:serializer_lower_camel_case) do
+    jat_class = Class.new(base)
+    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: foo_bazz_serializer
+    jat_class
+  end
+
+  it "returns true when provided fields present" do
+    jat = serializer.new(fields: {foo: "foo_bar,foo_bazz", foo_bazz: "bazz"})
+    assert jat.validate
+  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', 'foo_bazz'"
+    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
+
+  it "validates nested includes" do
+    jat = serializer.new(include: "foo_bazz.extra")
+    error = assert_raises(Jat::JsonApiParamsError) { jat.validate }
+
+    expected_message = "Type 'foo_bazz' has no included 'extra' relationship. Existing relationships are: ''"
+    assert_equal(expected_message, error.message)
+  end
+end

data/test/lib/jat/plugins/lower_camel_case/lower_camel_case_test.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+describe "Jat::Plugins::LowerCamelCase" do
+  it "raises error if no response plugin is loaded" do
+    new_class = Class.new(Jat)
+    err = assert_raises(Jat::Error) { new_class.plugin :lower_camel_case }
+    assert_equal "Please load :json_api or :simple_api plugin first", err.message
+  end
+
+  it "loads simple_api compatible plugin" do
+    new_class = Class.new(Jat)
+    new_class.plugin :simple_api
+    new_class.plugin :lower_camel_case
+
+    assert new_class.plugin_used?(:simple_api_lower_camel_case)
+  end
+
+  it "loads json_api compatible plugin" do
+    new_class = Class.new(Jat)
+    new_class.plugin :json_api
+    new_class.plugin :lower_camel_case
+
+    assert new_class.plugin_used?(:json_api_lower_camel_case)
+  end
+end

data/test/lib/jat/plugins/maps_cache/maps_cache_test.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+describe "Jat::Plugins::MapsCache" do
+  it "raises error if no response plugin is loaded" do
+    new_class = Class.new(Jat)
+    err = assert_raises(Jat::Error) { new_class.plugin :maps_cache }
+    assert_equal "Please load :json_api or :simple_api plugin first", err.message
+  end
+
+  it "loads simple_api compatible plugin" do
+    new_class = Class.new(Jat)
+    new_class.plugin :simple_api
+    new_class.plugin :maps_cache
+
+    assert new_class.plugin_used?(:simple_api_maps_cache)
+  end
+
+  it "loads json_api compatible plugin" do
+    new_class = Class.new(Jat)
+    new_class.plugin :json_api
+    new_class.plugin :maps_cache
+
+    assert new_class.plugin_used?(:json_api_maps_cache)
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+describe "Jat::Plugins::Preloads" do
+  it "raises error if no response plugin is loaded" do
+    new_class = Class.new(Jat)
+    err = assert_raises(Jat::Error) { new_class.plugin :preloads }
+    assert_equal "Please load :json_api or :simple_api plugin first", err.message
+  end
+
+  it "loads simple_api compatible plugin" do
+    new_class = Class.new(Jat)
+    new_class.plugin :simple_api
+    new_class.plugin :preloads
+
+    assert new_class.plugin_used?(:simple_api_preloads)
+  end
+
+  it "loads json_api compatible plugin" do
+    new_class = Class.new(Jat)
+    new_class.plugin :json_api
+    new_class.plugin :preloads
+
+    assert new_class.plugin_used?(:json_api_preloads)
+  end
+end

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

@@ -0,0 +1,87 @@
+# 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
+
+  let(:described_class) { jat_class::FieldsParamParser }
+
+  def parse(str)
+    jat_class::FieldsParamParser.parse(str)
+  end
+
+  describe ".inspect" do
+    it "returns self name" do
+      assert_equal "#{jat_class}::FieldsParamParser", described_class.inspect
+    end
+  end
+
+  describe ".parse" do
+    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
+end