Adding for_collection to the BaseSerializer. (#884)

* Adding for_collection to the BaseSerializer.

This for_collection override takes a Lucky::Paginator argument as an
option and changes the output to have extra pagination data added in.

* Adding the pagination_serializer to the generated app.

* Earthly snapshot updates.

Author: russ

fixtures/src_template/expected/src/serializers/base_serializer.cr

@@ -6,4 +6,13 @@ abstract class BaseSerializer
       new(object, *args, **named_args)
     end
   end
+
+  def self.for_collection(collection : Enumerable, pages : Lucky::Paginator, *args, **named_args)
+    {
+      "items" => collection.map do |object|
+        new(object, *args, **named_args)
+      end,
+      "pagination" => PaginationSerializer.new(pages),
+    }
+  end
 end

fixtures/src_template/expected/src/serializers/pagination_serializer.cr

@@ -0,0 +1,15 @@
+# This is the default pagination serializer generated by Lucky.
+# Feel free to customize it in any way you like.
+class PaginationSerializer < BaseSerializer
+  def initialize(@pages : Lucky::Paginator)
+  end
+
+  def render
+    {
+      next_page:     @pages.path_to_next,
+      previous_page: @pages.path_to_previous,
+      total_items:   @pages.item_count,
+      total_pages:   @pages.total,
+    }
+  end
+end

fixtures/src_template__api_only/expected/src/serializers/base_serializer.cr

@@ -6,4 +6,13 @@ abstract class BaseSerializer
       new(object, *args, **named_args)
     end
   end
+
+  def self.for_collection(collection : Enumerable, pages : Lucky::Paginator, *args, **named_args)
+    {
+      "items" => collection.map do |object|
+        new(object, *args, **named_args)
+      end,
+      "pagination" => PaginationSerializer.new(pages),
+    }
+  end
 end

fixtures/src_template__api_only/expected/src/serializers/pagination_serializer.cr

@@ -0,0 +1,15 @@
+# This is the default pagination serializer generated by Lucky.
+# Feel free to customize it in any way you like.
+class PaginationSerializer < BaseSerializer
+  def initialize(@pages : Lucky::Paginator)
+  end
+
+  def render
+    {
+      next_page:     @pages.path_to_next,
+      previous_page: @pages.path_to_previous,
+      total_items:   @pages.item_count,
+      total_pages:   @pages.total,
+    }
+  end
+end

fixtures/src_template__generate_auth/expected/src/serializers/base_serializer.cr

@@ -6,4 +6,13 @@ abstract class BaseSerializer
       new(object, *args, **named_args)
     end
   end
+
+  def self.for_collection(collection : Enumerable, pages : Lucky::Paginator, *args, **named_args)
+    {
+      "items" => collection.map do |object|
+        new(object, *args, **named_args)
+      end,
+      "pagination" => PaginationSerializer.new(pages),
+    }
+  end
 end

fixtures/src_template__generate_auth/expected/src/serializers/pagination_serializer.cr

@@ -0,0 +1,15 @@
+# This is the default pagination serializer generated by Lucky.
+# Feel free to customize it in any way you like.
+class PaginationSerializer < BaseSerializer
+  def initialize(@pages : Lucky::Paginator)
+  end
+
+  def render
+    {
+      next_page:     @pages.path_to_next,
+      previous_page: @pages.path_to_previous,
+      total_items:   @pages.item_count,
+      total_pages:   @pages.total,
+    }
+  end
+end

fixtures/src_template__sec_tester/expected/src/serializers/base_serializer.cr

@@ -6,4 +6,13 @@ abstract class BaseSerializer
       new(object, *args, **named_args)
     end
   end
+
+  def self.for_collection(collection : Enumerable, pages : Lucky::Paginator, *args, **named_args)
+    {
+      "items" => collection.map do |object|
+        new(object, *args, **named_args)
+      end,
+      "pagination" => PaginationSerializer.new(pages),
+    }
+  end
 end

fixtures/src_template__sec_tester/expected/src/serializers/pagination_serializer.cr

@@ -0,0 +1,15 @@
+# This is the default pagination serializer generated by Lucky.
+# Feel free to customize it in any way you like.
+class PaginationSerializer < BaseSerializer
+  def initialize(@pages : Lucky::Paginator)
+  end
+
+  def render
+    {
+      next_page:     @pages.path_to_next,
+      previous_page: @pages.path_to_previous,
+      total_items:   @pages.item_count,
+      total_pages:   @pages.total,
+    }
+  end
+end

src/lucky_cli/src_template.cr

@@ -219,6 +219,9 @@ class SrcTemplate
         serializers_dir.add_file("error_serializer.cr") do |io|
           ECR.embed("#{__DIR__}/../web_app_skeleton/src/serializers/error_serializer.cr.ecr", io)
         end
+        serializers_dir.add_file("pagination_serializer.cr") do |io|
+          ECR.embed("#{__DIR__}/../web_app_skeleton/src/serializers/pagination_serializer.cr.ecr", io)
+        end
       end
     end
   end

src/web_app_skeleton/src/serializers/base_serializer.cr.ecr

@@ -6,4 +6,13 @@ abstract class BaseSerializer
       new(object, *args, **named_args)
     end
   end
+
+  def self.for_collection(collection : Enumerable, pages : Lucky::Paginator, *args, **named_args)
+    {
+      "items" => collection.map do |object|
+        new(object, *args, **named_args)
+      end,
+      "pagination" => PaginationSerializer.new(pages),
+    }
+  end
 end