jat 0.0.3 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fdf9f1733a9d7ddcdeced1bcf6b6cbb1f53b9ffa11b8cb1592874dcc55c3bf2
-  data.tar.gz: d8982abf27a244a845ec0147a51e23946a8f6cac66c36d350aef6567253326f8
+  metadata.gz: c266d5784440b62adbb20bb09902f0134ad5e6a06245974f9b15a0557733528d
+  data.tar.gz: 989344e5918b193a2db72a863337c7209aa34ee9e1b28b7bf68f8bd9a9749b9d
 SHA512:
-  metadata.gz: f8a9be4d5e0d59922b37763de59a8833b5d3c71ac634f2c3555b6b9ab36e8a4149be04f8b33a68406616cfaeda85f49ed349fe8cc4d47bc44e0a873f0128829a
-  data.tar.gz: 9dcf9433b3d5f40e538db79e082095b54977f8ba8fd885ada3442441c98f374635956d0cd5201c654282954dd24d59e589a181338d2774855b97bd9677fa40d4
+  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
@@ -59,11 +61,30 @@ class Jat
       end
 
       def block
-        @block ||=
-          params.fetch(:block) || begin
-            key_method_name = key
-            -> { object.public_send(key_method_name) }
-          end
+        return @block if instance_variable_defined?(:@block)
+
+        current_block = params.fetch(:block)
+        current_block ||= keyword_block
+
+        @block = current_block
+      end
+
+      def value(object, context)
+        block.call(object, context)
+      end
+
+      private
+
+      def keyword_block
+        key_method_name = key
+        proc { |object| object.public_send(key_method_name) }
+      end
+
+      def check_block_valid(block)
+        return unless block
+
+        params = block.parameters
+        raise Error, "Block can have 0-2 parameters" if params.count > 2
       end
     end
 

data/lib/jat/config.rb

@@ -1,23 +1,20 @@
 # frozen_string_literal: true
 
+require "forwardable"
 require_relative "utils/enum_deep_dup"
 
 class Jat
   class Config
     module InstanceMethods
+      extend Forwardable
+
       attr_reader :opts
 
       def initialize(opts = {})
         @opts = EnumDeepDup.call(opts)
       end
 
-      def []=(key, value)
-        opts[key] = value
-      end
-
-      def [](key)
-        opts[key]
-      end
+      def_delegators :@opts, :[], :[]=, :fetch
     end
 
     module ClassMethods

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class Jat
+  module Plugins
+    module Activerecord
+      def self.plugin_name
+        :activerecord
+      end
+
+      def self.load(jat_class, **opts)
+        if jat_class.plugin_used?(:json_api)
+          jat_class.plugin :json_api_activerecord, **opts
+        elsif jat_class.plugin_used?(:simple_api)
+          jat_class.plugin :simple_api_activerecord, **opts
+        else
+          raise Error, "Please load :json_api or :simple_api plugin first"
+        end
+      end
+    end
+
+    register_plugin(Activerecord.plugin_name, Activerecord)
+  end
+end

data/lib/jat/plugins/base/base_activerecord_preloads/base_activerecord_preloads.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "./lib/preloader"
+
+class Jat
+  module Plugins
+    module BaseActiverecordPreloads
+      def self.plugin_name
+        :base_activerecord_preloads
+      end
+
+      def self.load(jat_class, **_opts)
+        jat_class.include(InstanceMethods)
+      end
+
+      module InstanceMethods
+        def to_h(object)
+          object = add_preloads(object)
+          super
+        end
+
+        private
+
+        def add_preloads(obj)
+          return obj if obj.nil? || (obj.is_a?(Array) && obj.empty?)
+
+          # preloads() method comes from simple_api_activerecord or json_api_activerecord plugin
+          preloads = preloads()
+          return obj if preloads.empty?
+
+          Preloader.preload(obj, preloads)
+        end
+      end
+    end
+
+    register_plugin(BaseActiverecordPreloads.plugin_name, BaseActiverecordPreloads)
+  end
+end

data/lib/jat/plugins/{_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)
@@ -20,6 +20,18 @@ class Jat
         extend ClassMethods
       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
+          else
+            ActiveRecord::Associations::Preloader.new.preload(records, associations)
+          end
+        end
+        # :nocov:
+      end
+
       class ActiverecordObject
         module ClassMethods
           def fit?(object)
@@ -27,11 +39,7 @@ class Jat
           end
 
           def preload(object, preloads)
-            # Reset associations that will be preloaded to fix possible bugs with
-            # ActiveRecord::Associations::Preloader
-            preloads.each_key { |key| object.association(key).reset }
-            ActiveRecord::Associations::Preloader.new.preload(object, preloads)
-
+            Loader.call([object], preloads)
             object
           end
         end
@@ -46,7 +54,13 @@ class Jat
           end
 
           def preload(objects, preloads)
-            objects.preload(preloads)
+            if objects.loaded?
+              array_objects = objects.to_a
+              Loader.call(array_objects, preloads)
+              objects
+            else
+              objects.preload(preloads).load
+            end
           end
         end
 
@@ -62,20 +76,12 @@ class Jat
           end
 
           def preload(objects, preloads)
-            # Reset associations that will be preloaded to fix possible bugs with
-            # ActiveRecord::Associations::Preloader
-            preloads.each_key { |key| reset_association(objects, key) }
-            ActiveRecord::Associations::Preloader.new.preload(objects, preloads)
-
+            Loader.call(objects, preloads)
             objects
           end
 
           private
 
-          def reset_association(objects, key)
-            objects.each { |object| object.association(key).reset }
-          end
-
           def same_kind?(objects)
             first_object_class = objects.first.class
             objects.all? { |object| object.instance_of?(first_object_class) }

data/lib/jat/plugins/base/base_lower_camel_case/base_lower_camel_case.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+class Jat
+  module Plugins
+    module BaseLowerCamelCase
+      def self.plugin_name
+        :base_lower_camel_case
+      end
+
+      def self.load(jat_class, **_opts)
+        jat_class::Attribute.include(AttributeInstanceMethods)
+      end
+
+      module AttributeInstanceMethods
+        def name
+          LowerCamelCaseTransformation.call(original_name)
+        end
+      end
+    end
+
+    register_plugin(BaseLowerCamelCase.plugin_name, BaseLowerCamelCase)
+  end
+
+  class LowerCamelCaseTransformation
+    SEPARATOR = "_"
+
+    def self.call(string)
+      first_word, *others = string.to_s.split(SEPARATOR)
+
+      first_word[0] = first_word[0].downcase
+      last_words = others.each(&:capitalize!).join
+
+      :"#{first_word}#{last_words}"
+    end
+  end
+end

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

@@ -6,7 +6,15 @@ 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
+        :base_preloads
+      end
+
+      def self.load(jat_class, **_opts)
+        jat_class::Attribute.include(AttributeMethods)
+      end
+
       module AttributeMethods
         NULL_PRELOADS = [nil, [].freeze].freeze
 
@@ -28,7 +36,7 @@ class Jat
         # we don't know which entity is main (:user or :profile in this example) but
         # we need to know main value to add nested preloads to it.
         # User can specify main preloaded entity by adding "!" suffix
-        # ({ user!: [:profile] } for example), othervice the latest key will be considered main.
+        # ({ user!: [:profile] } for example), otherwise the latest key will be considered main.
         def get_preloads_with_path
           preloads_provided = opts.key?(:preload)
           preloads =
@@ -43,11 +51,13 @@ class Jat
           return NULL_PRELOADS if preloads_provided && !preloads
 
           preloads = FormatUserPreloads.to_hash(preloads)
-          PreloadsWithPath.call(preloads)
+          preloads, path = PreloadsWithPath.call(preloads)
+
+          [EnumDeepFreeze.call(preloads), path.freeze]
         end
       end
     end
 
-    register_plugin(:_preloads, Preloads)
+    register_plugin(BasePreloads.plugin_name, BasePreloads)
   end
 end

data/lib/jat/plugins/{_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/{_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/cache/cache.rb

@@ -3,29 +3,37 @@
 class Jat
   module Plugins
     module Cache
+      def self.plugin_name
+        :cache
+      end
+
       def self.before_load(jat_class, **opts)
         jat_class.plugin :to_str, **opts
       end
 
+      def self.load(jat_class, **_opts)
+        jat_class.include(InstanceMethods)
+      end
+
       module InstanceMethods
         FORMAT_TO_STR = :to_str
         FORMAT_TO_H = :to_h
 
-        def to_h
+        def to_h(object)
           return super if context[:_format] == FORMAT_TO_STR
 
           context[:_format] = FORMAT_TO_H
-          cached { super }
+          cached(object) { super }
         end
 
-        def to_str
+        def to_str(object)
           context[:_format] = FORMAT_TO_STR
-          cached { super }
+          cached(object) { super }
         end
 
         private
 
-        def cached(&block)
+        def cached(object, &block)
           cache = context[:cache]
           return yield unless cache
 
@@ -34,6 +42,6 @@ class Jat
       end
     end
 
-    register_plugin(:cache, Cache)
+    register_plugin(Cache.plugin_name, Cache)
   end
 end