jat 0.0.3 → 0.0.5

data/test/lib/jat/plugins/simple_api_activerecord/simple_api_activerecord_test.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+describe "Jat::Plugins::SimpleApiActiverecord" do
+  before do
+    @plugin = Jat::Plugins.find_plugin(:simple_api_activerecord)
+  end
+
+  it "checks simple_api plugin loaded before" do
+    jat_class = Class.new(Jat)
+    error = assert_raises(Jat::Error) { jat_class.plugin @plugin }
+    assert_match(/simple_api/, error.message)
+  end
+
+  it "loads other plugins in after_load" do
+    jat_class = Class.new(Jat)
+    jat_class.plugin :simple_api
+
+    jat_class.expects(:plugin).with(:_preloads, foo: :bar)
+    jat_class.expects(:plugin).with(:_activerecord_preloads, foo: :bar)
+
+    @plugin.after_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 :simple_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/simple_api_camel_lower/simple_api_camel_lower_test.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+describe "Jat::Plugins::SimpleApiLowerCamelCase" do
+  let(:jat_class) do
+    new_class = Class.new(Jat)
+    new_class.plugin(:simple_api)
+    new_class.plugin(:simple_api_lower_camel_case)
+    new_class
+  end
+
+  it "loads _lower_camel_case plugin" do
+    assert jat_class.plugin_used?(:_lower_camel_case)
+  end
+
+  it "returns attributes in lowerCamelCase case" do
+    jat_class.attribute(:foo_bar) { 1 }
+
+    response = jat_class.to_h(true)
+    assert_equal({fooBar: 1}, response)
+  end
+
+  it "accepts fields in lowerCamelCase format" do
+    jat_class.attribute(:foo_bar, exposed: false) { 1 }
+
+    response = jat_class.to_h(true, fields: "fooBar")
+    assert_equal({fooBar: 1}, response)
+  end
+
+  it "returns meta keys in lowerCamelCase format" do
+    jat_class.meta(:user_agent) { "Firefox" }
+
+    response = jat_class.to_h(nil)
+    assert_equal({meta: {userAgent: "Firefox"}}, response)
+  end
+
+  it "returns context meta keys in lowerCamelCase format" do
+    response = jat_class.to_h(nil, meta: {user_agent: "Firefox"})
+    assert_equal({meta: {userAgent: "Firefox"}}, response)
+  end
+
+  it "joins meta in lowerCamelCase format" do
+    jat_class.meta(:userAgent) { "Firefox" }
+    response = jat_class.to_h(nil, meta: {user_agent: "Firefox 2.0"})
+    assert_equal({meta: {userAgent: "Firefox 2.0"}}, response)
+  end
+end

data/test/lib/jat/plugins/simple_api_maps_cache/simple_api_maps_cache_test.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+describe "Jat::Plugins::SimpleApiMapsCache" do
+  before do
+    @plugin = Jat::Plugins.find_plugin(:simple_api_maps_cache)
+  end
+
+  it "checks simple_api plugin loaded before" do
+    jat_class = Class.new(Jat)
+    error = assert_raises(Jat::Error) { jat_class.plugin @plugin }
+    assert_match(/simple_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(:simple_api)
+        plugin(:simple_api_maps_cache)
+
+        attribute(:attr1)
+        attribute(:attr2)
+      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(fields: "attr1")
+      current_map2 = jat_class::Map.call(fields: "attr1")
+      current_map3 = jat_class::Map.call(fields: "attr2")
+
+      assert_same(full_map1, full_map2)
+      assert_same(exposed_map1, exposed_map2)
+      assert_same(current_map1, current_map2)
+
+      # should not match, fields are not same
+      assert !current_map1.equal?(current_map3)
+    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(fields: "attr1")
+      jat_class::Map.call(fields: "attr1")
+
+      # key 4
+      jat_class::Map.call(fields: "attr2")
+
+      # key 5
+      jat_class::Map.call(fields: "attr1,attr2")
+
+      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/simple_api_validate_params/simple_api_validate_params_test.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+describe "Jat::Plugins::SimpleApiValidateParams" do
+  before do
+    @plugin = Jat::Plugins.find_plugin(:simple_api_validate_params)
+  end
+
+  it "checks simple_api plugin loaded before" do
+    jat_class = Class.new(Jat)
+    error = assert_raises(Jat::Error) { jat_class.plugin @plugin }
+    assert_match(/simple_api/, error.message)
+  end
+
+  let(:base_serializer) do
+    jat_class = Class.new(Jat)
+    jat_class.plugin :simple_api
+    jat_class.plugin @plugin
+    jat_class
+  end
+
+  let(:serializer) do
+    jat_class = Class.new(base_serializer)
+    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(base_serializer)
+    jat_class.plugin :lower_camel_case
+
+    jat_class.attribute :foo_bar
+    jat_class.relationship :foo_bazz, serializer: jat_class
+    jat_class
+  end
+
+  it "validates fields" do
+    jat = serializer.new(fields: "foo_bar,extra")
+    error = assert_raises(Jat::SimpleApiFieldsError) { jat.validate }
+    expected_message = "Field 'extra' not exists"
+    assert_equal(expected_message, error.message)
+  end
+
+  it "validates deeply nested fields" do
+    c = Class.new(base_serializer)
+    c.attribute :c1
+    c.attribute :c2
+
+    b = Class.new(base_serializer)
+    b.attribute :b1
+    b.attribute :b2
+    b.relationship :c, serializer: c
+
+    a = Class.new(base_serializer)
+    a.attribute :a1
+    a.attribute :a2
+    a.relationship :b, serializer: b
+    a.relationship :c, serializer: c
+
+    jat = a.new(fields: "a1,a2,c(c1,c2),b(b1,b2,c(c1,c2,c3)")
+    error = assert_raises(Jat::SimpleApiFieldsError) { jat.validate }
+    expected_message = "Field 'c3' ('b.c.c3') not exists"
+    assert_equal(expected_message, error.message)
+  end
+
+  it "validates deeply nested fields about not existing relationship" do
+    c = Class.new(base_serializer)
+    c.attribute :c1
+    c.attribute :c2
+
+    b = Class.new(base_serializer)
+    b.attribute :b1
+    b.attribute :b2
+    b.relationship :c, serializer: c
+
+    a = Class.new(base_serializer)
+    a.attribute :a1
+    a.attribute :a2
+    a.relationship :b, serializer: b
+    a.relationship :c, serializer: c
+
+    jat = a.new(fields: "a1,a2,c(c1,c2),b(b1,b2,c(c1,c2(c3))")
+    error = assert_raises(Jat::SimpleApiFieldsError) { jat.validate }
+    expected_message = "Field 'c2' ('b.c.c2') is not a relationship to add 'c3' attribute"
+    assert_equal(expected_message, error.message)
+  end
+end

data/test/lib/jat/plugins/to_str/to_str_test.rb

@@ -7,7 +7,7 @@ describe "Jat::Plugins::ToStr" do
     new_class = Class.new(Jat)
     new_class.plugin(:to_str)
     new_class.class_exec do
-      def to_h
+      def to_h(object)
         {object => context}
       end
     end
@@ -34,7 +34,7 @@ describe "Jat::Plugins::ToStr" do
         new_class = Class.new(Jat)
         new_class.plugin(:to_str, to_str: ->(data) { data.inspect })
         new_class.class_exec do
-          def to_h
+          def to_h(object)
             {object => context}
           end
         end
@@ -45,7 +45,7 @@ describe "Jat::Plugins::ToStr" do
 
     describe "#to_str" do
       it "returns json string of to_h" do
-        assert_equal '{"obj":"ctx"}', jat_class.new("obj", "ctx").to_str
+        assert_equal '{"obj":"ctx"}', jat_class.new("ctx").to_str("obj")
       end
     end
   end

data/test/lib/jat_test.rb

@@ -6,19 +6,36 @@ describe Jat do
   let(:jat_class) { Class.new(Jat) }
 
   describe ".plugin" do
-    it "raises error when trying to load not a symbol or module" do
-      plugin = "TEST_PLUGIN"
-      error = assert_raises(Jat::Error) { jat_class.plugin(plugin) }
+    it "loads same plugin only once" do
+      plugin = Module.new
+      jat_class.plugin plugin
+      jat_class.plugin plugin
 
-      error_message = "Plugin class must be a Symbol or a Module, #{plugin.inspect} given"
-      assert_equal error_message, error.message
+      assert_equal [plugin], jat_class.config[:plugins]
+    end
+  end
+
+  describe ".plugin_used?" do
+    it "tells if plugin has been already used in current serializer" do
+      assert_equal false, jat_class.plugin_used?(:json_api)
+      jat_class.plugin(:json_api)
+      assert_equal true, jat_class.plugin_used?(:json_api)
+    end
+
+    it "accepts Module" do
+      plugin = Module.new
+
+      assert_equal false, jat_class.plugin_used?(plugin)
+      jat_class.plugin(plugin)
+      assert_equal true, jat_class.plugin_used?(plugin)
     end
   end
 
   describe ".config" do
-    it "returns config object" do
+    it "returns config object with default values" do
       config = jat_class.config
       assert_equal jat_class::Config, config.class
+      assert_equal({plugins: []}, config.opts)
     end
   end
 
@@ -40,11 +57,6 @@ describe Jat do
       assert_equal parent::Attribute, child::Attribute.superclass
       assert child.attributes[:foo]
     end
-
-    it "inherits presenter" do
-      child = Class.new(parent)
-      assert_equal parent::Presenter, child::Presenter.superclass
-    end
   end
 
   describe ".call" do
@@ -54,6 +66,8 @@ describe Jat do
   end
 
   describe ".to_h" do
+    let(:jat) { jat_class.allocate }
+
     it "raises error that we should add some response generation plugin" do
       error = assert_raises(Jat::Error) { jat_class.to_h(nil) }
 
@@ -61,13 +75,15 @@ describe Jat do
       assert_equal error_message, error.message
     end
 
-    it "initializes serializer instance with provided attributes" do
-      jat_class.expects(:new).with("obj", "context")
+    it "initializes serializer instance with provided context" do
+      jat.expects(:to_h).with("obj")
+      jat_class.expects(:new).with("context").returns(jat)
       jat_class.to_h("obj", "context")
     end
 
     it "adds empty hash context when context not provided" do
-      jat_class.expects(:new).with("obj", {})
+      jat.expects(:to_h).with("obj")
+      jat_class.expects(:new).with({}).returns(jat)
       jat_class.to_h("obj")
     end
   end
@@ -84,27 +100,34 @@ describe Jat do
       attribute = jat_class.attribute :foo
       assert_equal jat_class.attributes[:foo], attribute
     end
+  end
+
+  describe ".relationship" do
+    it "forces using of :serializer option" do
+      error = assert_raises(ArgumentError) { jat_class.relationship(:foo) }
+      assert_match "serializer", error.message
+    end
 
-    it "adds method to Presenter class" do
-      jat_class.attribute :foo
-      assert jat_class::Presenter.method_defined?(:foo)
+    it "adds new attribute" do
+      jat_class.relationship(:foo, serializer: jat_class)
+
+      attribute = jat_class.attributes[:foo]
+      assert_equal jat_class, attribute.serializer
     end
   end
 
   describe "#initialize" do
-    it "initializes object and context attributes" do
-      jat = jat_class.new("obj", "context")
-
-      assert_equal "obj", jat.object
+    it "initializes context" do
+      jat = jat_class.new("context")
       assert_equal "context", jat.context
     end
   end
 
   describe "#to_h" do
     it "raises error" do
-      jat = jat_class.new(nil, nil)
+      jat = jat_class.new
 
-      error = assert_raises(Jat::Error) { jat.to_h }
+      error = assert_raises(Jat::Error) { jat.to_h(nil) }
       error_message = "Method #to_h must be implemented by plugin"
       assert_equal error_message, error.message
     end
@@ -112,7 +135,7 @@ describe Jat do
 
   describe "#config" do
     it "returns self class config" do
-      jat = jat_class.new(nil, nil)
+      jat = jat_class.new
 
       assert_same jat.config, jat_class.config
     end

data/test/lib/plugin_test.rb

@@ -6,7 +6,7 @@ require "test_plugin"
 describe "plugin system" do
   describe "Jat.plugin" do
     let(:jat_class) { Class.new(Jat) }
-    let(:components) { [jat_class, jat_class::Attribute, jat_class::Config, jat_class::Presenter] }
+    let(:components) { [jat_class, jat_class::Attribute, jat_class::Config] }
 
     before do
       components.each do |component|
@@ -36,12 +36,12 @@ describe "plugin system" do
       end
     end
 
-    it "loads dependencies before loading plugin" do
+    it "calls before_load before loading plugin" do
       jat_class.plugin(TestPlugin)
       assert_equal :foo, jat_class.config[:before_load]
     end
 
-    it "after_loads after loading plugin" do
+    it "calls after_load after loading plugin" do
       jat_class.plugin(TestPlugin)
       assert_equal :plugin_foo, jat_class.config[:after_load]
     end

data/test/test_helper.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require "simplecov"
-SimpleCov.start
-
 if RUBY_VERSION >= "2.7"
   Warning[:deprecated] = true
   Warning[:experimental] = true

data/test/test_plugin.rb

@@ -5,6 +5,15 @@ module TestPlugin
     jat_class.config[:before_load] = jat_class.foo
   end
 
+  def self.load(jat_class, **_opts)
+    jat_class.extend(ClassMethods)
+    jat_class.include(InstanceMethods)
+    jat_class::Attribute.extend(AttributeClassMethods)
+    jat_class::Attribute.include(AttributeMethods)
+    jat_class::Config.extend(ConfigClassMethods)
+    jat_class::Config.include(ConfigMethods)
+  end
+
   def self.after_load(jat_class, *)
     jat_class.config[:after_load] = jat_class.foo
   end
@@ -44,16 +53,4 @@ module TestPlugin
       :plugin_foo
     end
   end
-
-  module PresenterClassMethods
-    def foo
-      :plugin_foo
-    end
-  end
-
-  module PresenterMethods
-    def foo
-      :plugin_foo
-    end
-  end
 end