jat 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4b14981546d524f665e1d268857bd8b2caafec9af07157a1f57fd2ca8f9c83c
-  data.tar.gz: 1335c436d0e4ae1f70fb70a9ef5757610e09ce3b5a03b87ba356d31625af0ab3
+  metadata.gz: c266d5784440b62adbb20bb09902f0134ad5e6a06245974f9b15a0557733528d
+  data.tar.gz: 989344e5918b193a2db72a863337c7209aa34ee9e1b28b7bf68f8bd9a9749b9d
 SHA512:
-  metadata.gz: fcaccbe3cb5e5a27cd5700e3677886fb9966ef8ce2775bf2be6638578489747b8a488acbd3f6f7f55752323c40bc92410af1d079dfeefe2d4b41d4f768fbfbfb
-  data.tar.gz: 23a2cbda699f9e8f2a9588dc8cfb4350bbd1a1994603577bd3649a356148ad88d2bd754529bb63905aba59a993cc747c2e5ad762038fb571d5d83b1ecc6d40b4
+  metadata.gz: eba6f92cd51c734ef0583447b2300971fd4707e0e79cece169858d6551e75fba688ce6155dae9317184d423b519e1398d8f583b643174cf4d4450700d73bf3c9
+  data.tar.gz: bf14496368b37ec614f0f79b76c217df8c60a8401a54d48e30925fad6c7501fdba7533758b9b5bde24035b645aae2c204b9fc05740282a4ff23ce5e80968e529

data/lib/jat/attribute.rb

@@ -9,6 +9,8 @@ class Jat
       attr_reader :params, :opts
 
       def initialize(name:, opts: {}, block: nil)
+        check_block_valid(block)
+
         @opts = EnumDeepDup.call(opts)
         @params = EnumDeepFreeze.call(name: name, opts: @opts, block: block)
       end
@@ -61,7 +63,7 @@ class Jat
       def block
         return @block if instance_variable_defined?(:@block)
 
-        current_block = params.fetch(:block).tap { |bl| check_block_valid(bl) if bl }
+        current_block = params.fetch(:block)
         current_block ||= keyword_block
 
         @block = current_block
@@ -79,13 +81,10 @@ class Jat
       end
 
       def check_block_valid(block)
-        raise Error, "Block must be a Proc (not lambda)" if block.lambda?
+        return unless block
 
         params = block.parameters
         raise Error, "Block can have 0-2 parameters" if params.count > 2
-
-        valid_params_types = params.all? { |param| param[0] == :opt }
-        raise Error, "Block parameters must be optional and no keyword parameters" unless valid_params_types
       end
     end
 

data/lib/jat/plugins/{common/_activerecord_preloads/_activerecord_preloads.rb → base/base_activerecord_preloads/base_activerecord_preloads.rb}

@@ -4,9 +4,9 @@ require_relative "./lib/preloader"
 
 class Jat
   module Plugins
-    module ActiverecordPreloads
+    module BaseActiverecordPreloads
       def self.plugin_name
-        :_activerecord_preloads
+        :base_activerecord_preloads
       end
 
       def self.load(jat_class, **_opts)
@@ -33,6 +33,6 @@ class Jat
       end
     end
 
-    register_plugin(ActiverecordPreloads.plugin_name, ActiverecordPreloads)
+    register_plugin(BaseActiverecordPreloads.plugin_name, BaseActiverecordPreloads)
   end
 end

data/lib/jat/plugins/{common/_activerecord_preloads → base/base_activerecord_preloads}/lib/preloader.rb

@@ -2,7 +2,7 @@
 
 class Jat
   module Plugins
-    module ActiverecordPreloads
+    module BaseActiverecordPreloads
       class Preloader
         module ClassMethods
           def preload(object, preloads)
@@ -21,6 +21,7 @@ class Jat
       end
 
       class Loader
+        # :nocov: We can check only one version of activerecord
         def self.call(records, associations)
           if ActiveRecord::VERSION::MAJOR >= 7
             ActiveRecord::Associations::Preloader.new(records: records, associations: associations).call
@@ -28,6 +29,7 @@ class Jat
             ActiveRecord::Associations::Preloader.new.preload(records, associations)
           end
         end
+        # :nocov:
       end
 
       class ActiverecordObject

data/lib/jat/plugins/{common/_lower_camel_case/_lower_camel_case.rb → base/base_lower_camel_case/base_lower_camel_case.rb}

@@ -2,9 +2,9 @@
 
 class Jat
   module Plugins
-    module LowerCamelCase
+    module BaseLowerCamelCase
       def self.plugin_name
-        :_lower_camel_case
+        :base_lower_camel_case
       end
 
       def self.load(jat_class, **_opts)
@@ -18,7 +18,7 @@ class Jat
       end
     end
 
-    register_plugin(LowerCamelCase.plugin_name, LowerCamelCase)
+    register_plugin(BaseLowerCamelCase.plugin_name, BaseLowerCamelCase)
   end
 
   class LowerCamelCaseTransformation

data/lib/jat/plugins/{common/_preloads/_preloads.rb → base/base_preloads/base_preloads.rb}

@@ -6,9 +6,9 @@ require_relative "./lib/preloads_with_path"
 # This plugin adds attribute methods #preloads, #preloads_path
 class Jat
   module Plugins
-    module Preloads
+    module BasePreloads
       def self.plugin_name
-        :_preloads
+        :base_preloads
       end
 
       def self.load(jat_class, **_opts)
@@ -58,6 +58,6 @@ class Jat
       end
     end
 
-    register_plugin(Preloads.plugin_name, Preloads)
+    register_plugin(BasePreloads.plugin_name, BasePreloads)
   end
 end

data/lib/jat/plugins/{common/_preloads → base/base_preloads}/lib/format_user_preloads.rb

@@ -2,7 +2,7 @@
 
 class Jat
   module Plugins
-    module Preloads
+    module BasePreloads
       class FormatUserPreloads
         METHODS = {
           Array => :array_to_hash,

data/lib/jat/plugins/{common/_preloads → base/base_preloads}/lib/preloads_with_path.rb

@@ -2,7 +2,7 @@
 
 class Jat
   module Plugins
-    module Preloads
+    module BasePreloads
       class PreloadsWithPath
         module ClassMethods
           BANG = "!"

data/lib/jat/plugins/json_api/lib/response_piece.rb

@@ -136,7 +136,7 @@ class Jat
 
           def get_relationship_links(rel_serializer, rel_object)
             links = rel_serializer.relationship_links
-            return FROZEN_EMPTY_HASH unless links
+            return FROZEN_EMPTY_HASH if links.empty?
 
             context[:parent_object] = object
 
@@ -148,7 +148,7 @@ class Jat
 
           def get_relationship_meta(rel_serializer, rel_object)
             meta = rel_serializer.added_relationship_meta
-            return FROZEN_EMPTY_HASH unless meta
+            return FROZEN_EMPTY_HASH if meta.empty?
 
             context[:parent_object] = object
 

data/lib/jat/plugins/json_api/plugins/json_api_activerecord/json_api_activerecord.rb

@@ -14,7 +14,7 @@ class Jat
 
       def self.load(jat_class, **opts)
         jat_class.plugin :json_api_preloads, **opts
-        jat_class.plugin :_activerecord_preloads, **opts
+        jat_class.plugin :base_activerecord_preloads, **opts
       end
     end
 

data/lib/jat/plugins/json_api/plugins/json_api_lower_camel_case/json_api_lower_camel_case.rb

@@ -10,7 +10,7 @@ class Jat
       def self.before_load(jat_class, **_opts)
         raise Error, "Please load :json_api plugin first" unless jat_class.plugin_used?(:json_api)
 
-        jat_class.plugin :_lower_camel_case
+        jat_class.plugin :base_lower_camel_case
       end
 
       def self.load(jat_class, **_opts)

data/lib/jat/plugins/json_api/plugins/json_api_preloads/json_api_preloads.rb

@@ -12,7 +12,7 @@ class Jat
       def self.before_load(jat_class, **opts)
         raise Error, "Please load :json_api plugin first" unless jat_class.plugin_used?(:json_api)
 
-        jat_class.plugin :_preloads, **opts
+        jat_class.plugin :base_preloads, **opts
       end
 
       def self.load(jat_class, **_opts)

data/lib/jat/plugins/simple_api/plugins/simple_api_activerecord/simple_api_activerecord.rb

@@ -14,7 +14,7 @@ class Jat
 
       def self.load(jat_class, **opts)
         jat_class.plugin :simple_api_preloads, **opts
-        jat_class.plugin :_activerecord_preloads, **opts
+        jat_class.plugin :base_activerecord_preloads, **opts
       end
     end
 

data/lib/jat/plugins/simple_api/plugins/simple_api_lower_camel_case/simple_api_lower_camel_case.rb

@@ -10,7 +10,7 @@ class Jat
       def self.before_load(jat_class, **_opts)
         raise Error, "Please load :simple_api plugin first" unless jat_class.plugin_used?(:simple_api)
 
-        jat_class.plugin :_lower_camel_case
+        jat_class.plugin :base_lower_camel_case
       end
 
       def self.load(jat_class, **_opts)

data/lib/jat/plugins/simple_api/plugins/simple_api_preloads/simple_api_preloads.rb

@@ -12,7 +12,7 @@ class Jat
       def self.before_load(jat_class, **opts)
         raise Error, "Please load :simple_api plugin first" unless jat_class.plugin_used?(:simple_api)
 
-        jat_class.plugin :_preloads, **opts
+        jat_class.plugin :base_preloads, **opts
       end
 
       def self.load(jat_class, **_opts)

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

@@ -79,7 +79,7 @@ class Jat
           # Assign same meta
           added_meta.each_value do |attribute|
             params = attribute.params
-            subclass.attribute(params[:name], **params[:opts], &params[:block])
+            subclass.meta(params[:name], **params[:opts], &params[:block])
           end
         end
 

data/lib/jat/plugins.rb

@@ -1,39 +1,51 @@
 # frozen_string_literal: true
 
 class Jat
+  class PluginLoadError < Error; end
+
   module Plugins
     @plugins = {}
 
-    # Register the given plugin with Jat, so that it can be loaded using
-    # `Jat.plugin` with a symbol. Should be used by plugin files. Example:
-    #
-    #     Jat::Plugins.register_plugin(:plugin_name, PluginModule)
-    def self.register_plugin(name, mod)
-      @plugins[name] = mod
-    end
+    class << self
+      # Registers given plugin to be able to load it using symbol name.
+      #
+      # Example: Jat::Plugins.register_plugin(:plugin_name, PluginModule)
+      def register_plugin(name, mod)
+        @plugins[name] = mod
+      end
 
-    # If the registered plugin already exists, use it. Otherwise, require
-    # and return it. This raises a LoadError if such a plugin doesn't exist,
-    # or a Jat::Error if it exists but it does not register itself
-    # correctly.
-    def self.find_plugin(name)
-      return name if name.is_a?(Module)
+      # If the registered plugin already exists, use it. Otherwise, require
+      # and return it. This raises a LoadError if such a plugin doesn't exist,
+      # or a Jat::Error if it exists but it does not register itself
+      # correctly.
+      def find_plugin(name)
+        return name if name.is_a?(Module)
+        return @plugins[name] if @plugins.key?(name)
 
-      begin
-        require "jat/plugins/#{name}/#{name}"
-      rescue LoadError
-        if name.start_with?("json_api")
-          require "jat/plugins/json_api/plugins/#{name}/#{name}"
-        elsif name.start_with?("simple_api")
-          require "jat/plugins/simple_api/plugins/#{name}/#{name}"
-        elsif name.start_with?("_")
-          require "jat/plugins/common/#{name}/#{name}"
-        else
-          raise
+        begin
+          require_plugin(name)
+        rescue PluginLoadError
+          if name.start_with?("json_api")
+            require_plugin(name, "/json_api/plugins")
+          elsif name.start_with?("simple_api")
+            require_plugin(name, "/simple_api/plugins")
+          elsif name.start_with?("base")
+            require_plugin(name, "/base")
+          else
+            raise
+          end
         end
+
+        @plugins[name] || raise(PluginLoadError, "Plugin '#{name}' did not register itself correctly")
       end
 
-      @plugins[name] || raise(Error, "plugin #{name} did not register itself correctly in Jat::Plugins")
+      private
+
+      def require_plugin(name, prefix = nil)
+        require "jat/plugins#{prefix}/#{name}/#{name}"
+      rescue LoadError
+        raise PluginLoadError, "Plugin '#{name}' does not exist"
+      end
     end
   end
 end

data/lib/jat.rb

@@ -1,17 +1,19 @@
 # frozen_string_literal: true
 
-require_relative "jat/attribute"
-require_relative "jat/config"
-require_relative "jat/plugins"
-
 # Main namespace
 class Jat
+  # A generic exception used by Jat.
+  class Error < StandardError; end
+
   FROZEN_EMPTY_HASH = {}.freeze
   FROZEN_EMPTY_ARRAY = [].freeze
+end
 
-  # A generic exception used by Jat.
-  class Error < StandardError; end
+require_relative "jat/attribute"
+require_relative "jat/config"
+require_relative "jat/plugins"
 
+class Jat
   @config = Config.new({plugins: []})
 
   module ClassMethods

data/test/lib/jat/attribute_test.rb

@@ -148,5 +148,13 @@ describe Jat::Attribute do
       attribute = attribute_class.new(name: "foo", opts: {key: :length})
       assert_equal 3, attribute.value([1, 2, 3], nil)
     end
+
+    it "raises error if provide block with more than 2 params" do
+      jat_class.attribute(:foo) {}
+      jat_class.attribute(:foo) { |_| }
+      jat_class.attribute(:foo) { |_, _| }
+      err = assert_raises(Jat::Error) { jat_class.attribute(:foo) { |_, _, _| } }
+      assert_equal "Block can have 0-2 parameters", err.message
+    end
   end
 end

data/test/lib/jat/plugins/activerecord/activerecord_test.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+describe "Jat::Plugins::Activerecord" do
+  it "raises error if no response plugin is loaded" do
+    new_class = Class.new(Jat)
+    err = assert_raises(Jat::Error) { new_class.plugin :activerecord }
+    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 :activerecord
+
+    assert new_class.plugin_used?(:simple_api_activerecord)
+  end
+
+  it "loads json_api compatible plugin" do
+    new_class = Class.new(Jat)
+    new_class.plugin :json_api
+    new_class.plugin :activerecord
+
+    assert new_class.plugin_used?(:json_api_activerecord)
+  end
+end

data/test/lib/jat/plugins/{_activerecord_preloads/_activerecord_preloads_test.rb → base_activerecord_preloads/base_activerecord_preloads_test.rb}

@@ -2,13 +2,13 @@
 
 require "test_helper"
 
-describe "Jat::Plugins::ActiverecordPreloads" do
+describe "Jat::Plugins::BaseActiverecordPreloads" do
   let(:jat_class) do
     api_test = api_test()
 
     Class.new(Jat) do
       include api_test
-      plugin(:_activerecord_preloads)
+      plugin(:base_activerecord_preloads)
     end
   end
 
@@ -27,7 +27,7 @@ describe "Jat::Plugins::ActiverecordPreloads" do
       jat = jat_class.new
       jat.expects(:preloads).returns(preloads)
 
-      Jat::Plugins::ActiverecordPreloads::Preloader
+      Jat::Plugins::BaseActiverecordPreloads::Preloader
         .expects(:preload)
         .with(object, preloads).returns("OBJ_WITH_PRELOADS")
 

data/test/lib/jat/plugins/{_activerecord_preloads → base_activerecord_preloads}/lib/preloader_test.rb

@@ -4,11 +4,11 @@ require "test_helper"
 require "support/activerecord"
 
 describe "Jat::Plugins::ActiverecordPreloads" do
-  before { Jat::Plugins.find_plugin(:_activerecord_preloads) }
+  before { Jat::Plugins.find_plugin(:base_activerecord_preloads) }
 
   describe "Preloader" do
     let(:described_class) { plugin::Preloader }
-    let(:plugin) { Jat::Plugins::ActiverecordPreloads }
+    let(:plugin) { Jat::Plugins::BaseActiverecordPreloads }
 
     describe ".handlers" do
       it "returns memorized array of handlers" do

data/test/lib/jat/plugins/{_camel_lower/_camel_lower_test.rb → base_lower_camel_case/base_lower_camel_case_test.rb}

@@ -2,10 +2,10 @@
 
 require "test_helper"
 
-describe "Jat::Plugins::LowerCamelCase" do
+describe "Jat::Plugins::BaseLowerCamelCase" do
   let(:jat_class) do
     new_class = Class.new(Jat)
-    new_class.plugin(:_lower_camel_case)
+    new_class.plugin(:base_lower_camel_case)
     new_class
   end
 

data/test/lib/jat/plugins/{_preloads/_preloads_test.rb → base_preloads/base_preloads_test.rb}

@@ -2,9 +2,9 @@
 
 require "test_helper"
 
-describe "Jat::Plugins::Preloads" do
+describe "Jat::Plugins::BasePreloads" do
   let(:jat_class) do
-    Class.new(Jat) { plugin(:_preloads) }
+    Class.new(Jat) { plugin(:base_preloads) }
   end
 
   def attribute(name, opts)

data/test/lib/jat/plugins/{_preloads → base_preloads}/lib/format_user_preloads_test.rb

@@ -2,10 +2,10 @@
 
 require "test_helper"
 
-describe "Jat::Plugins::Preloads::FormatUserPreloads" do
-  before { Jat::Plugins.find_plugin(:_preloads) }
+describe "Jat::Plugins::BasePreloads::FormatUserPreloads" do
+  before { Jat::Plugins.find_plugin(:base_preloads) }
 
-  let(:format) { Jat::Plugins::Preloads::FormatUserPreloads }
+  let(:format) { Jat::Plugins::BasePreloads::FormatUserPreloads }
 
   it "transforms nil to empty hash" do
     preloads = nil

data/test/lib/jat/plugins/{_preloads → base_preloads}/lib/preloads_with_path_test.rb

@@ -3,9 +3,9 @@
 require "test_helper"
 
 describe "Jat::Plugins::Preloads::PreloadsWithPath" do
-  before { Jat::Plugins.find_plugin(:_preloads) }
+  before { Jat::Plugins.find_plugin(:base_preloads) }
 
-  let(:described_class) { Jat::Plugins::Preloads::PreloadsWithPath }
+  let(:described_class) { Jat::Plugins::BasePreloads::PreloadsWithPath }
 
   it "returns provided preloads and path to last value" do
     preloads = {a: {b: {c: {}}, d: {}}, e: {}}

data/test/lib/jat/plugins/json_api/json_api_test.rb

@@ -46,7 +46,7 @@ describe "Jat::Plugins::JsonApi" do
     describe "#map" do
       it "returns map for provided context" do
         jat_class::Map.expects(:call).with("CONTEXT").returns "MAP"
-        assert_equal "MAP", jat_class.map("CONTEXT")
+        assert_equal "MAP", jat_class.new("CONTEXT").map
       end
     end
 

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

@@ -18,21 +18,29 @@ describe "Jat::Plugins::JsonApi::FieldsParamParser" do
 
   let(:described_class) { jat_class::FieldsParamParser }
 
-  it "returns empty hash when parameters not provided" do
-    result = described_class.parse(nil)
-
-    assert_equal({}, result)
+  describe ".inspect" do
+    it "returns self name" do
+      assert_equal "#{jat_class}::FieldsParamParser", described_class.inspect
+    end
   end
 
-  it "returns parsed attributes" do
-    result = described_class.parse(a: "a1,a2")
+  describe ".parse" do
+    it "returns empty hash when parameters not provided" do
+      result = described_class.parse(nil)
 
-    assert_equal({a: %i[a1 a2]}, result)
-  end
+      assert_equal({}, result)
+    end
 
-  it "validates provided attributes" do
-    jat_class.plugin :json_api_validate_params
-    error = assert_raises(Jat::Error) { described_class.parse(a: "a1,a2,a3,a4") }
-    assert_match(/a4/, error.message)
+    it "returns parsed attributes" do
+      result = described_class.parse(a: "a1,a2")
+
+      assert_equal({a: %i[a1 a2]}, result)
+    end
+
+    it "validates provided attributes" do
+      jat_class.plugin :json_api_validate_params
+      error = assert_raises(Jat::Error) { described_class.parse(a: "a1,a2,a3,a4") }
+      assert_match(/a4/, error.message)
+    end
   end
 end

data/test/lib/jat/plugins/json_api/lib/include_param_parser_test.rb

@@ -8,6 +8,7 @@ describe "Jat::Plugins::JsonApi::Params::Include" do
   let(:base_class) { Class.new(Jat) { plugin :json_api } }
   let(:a_serializer) { Class.new(base_class) }
   let(:b_serializer) { Class.new(base_class) }
+  let(:c_serializer) { Class.new(base_class) }
 
   before do
     ser = a_serializer
@@ -22,20 +23,35 @@ describe "Jat::Plugins::JsonApi::Params::Include" do
     ser = b_serializer
     ser.type :b
     ser.attribute :b1
-    ser.relationship :b2, serializer: a_serializer
-    ser.relationship :b3, serializer: a_serializer
-    ser.relationship :b4, serializer: a_serializer
+    ser.relationship :b2, serializer: c_serializer
+    ser.relationship :b3, serializer: c_serializer
+    ser.relationship :b4, serializer: c_serializer
+
+    ser = c_serializer
+    ser.type :c
+    ser.attribute :c1
+    ser.relationship :c2, serializer: a_serializer
+    ser.relationship :c3, serializer: a_serializer
+    ser.relationship :c4, serializer: a_serializer
   end
 
   let(:described_class) { a_serializer::IncludeParamParser }
 
-  it "returns empty hash when param not provided" do
-    result = described_class.parse(nil)
-    assert_equal({}, result)
+  describe ".inspect" do
+    it "returns self name" do
+      assert_equal "#{a_serializer}::IncludeParamParser", described_class.inspect
+    end
   end
 
-  it "returns typed keys" do
-    result = described_class.parse("a2.b2,a2.b3,a3.b2.a5,a4")
-    assert_equal({a: %i[a2 a3 a5 a4], b: %i[b2 b3]}, result)
+  describe ".parse" do
+    it "returns empty hash when param not provided" do
+      result = described_class.parse(nil)
+      assert_equal({}, result)
+    end
+
+    it "returns typed keys" do
+      result = described_class.parse("a2.b2.c2,a2.b2.c3,a3.b2.c4.a5,a4")
+      assert_equal({a: %i[a2 a3 a5 a4], b: %i[b2], c: %i[c2 c3 c4]}, result)
+    end
   end
 end