From bd10b0ce763762df3d837cd069a0ddfecbe6d4b9 Mon Sep 17 00:00:00 2001
From: Matt Rogers <mattr-@github.com>
Date: Sat, 3 Aug 2019 09:38:41 -0500
Subject: [PATCH] Implement a `pop_item` filter

This is just a proxy for Array#pop in Ruby. We're using nil as a
indicator that a number was not passed. If we use 1 as the default,
Array#pop always returns an array. If the number `1` is passed in, then
we just let Array#pop always return an array.
---
 lib/jekyll/filters.rb | 11 +++++++++++
 test/test_filters.rb  | 20 ++++++++++++++++++++
 2 files changed, 31 insertions(+)

diff --git a/lib/jekyll/filters.rb b/lib/jekyll/filters.rb
index cec65ba39..248ba0ba2 100644
--- a/lib/jekyll/filters.rb
+++ b/lib/jekyll/filters.rb
@@ -257,6 +257,17 @@ module Jekyll
       new_ary
     end
 
+    def pop_item(array, num = nil)
+      return array unless array.is_a?(Array)
+
+      unless num.nil?
+        num = Liquid::Utils.to_integer(num)
+        array.pop(num)
+      else
+        array.pop
+      end
+    end
+
     def push(array, input)
       return array unless array.is_a?(Array)
 
diff --git a/test/test_filters.rb b/test/test_filters.rb
index 39ec85653..c55003529 100644
--- a/test/test_filters.rb
+++ b/test/test_filters.rb
@@ -1256,6 +1256,26 @@ class TestFilters < JekyllUnitTest
       end
     end
 
+    context "pop_item filter" do
+      should "return the last item in the array by default" do
+        assert_equal "greeting", @filter.pop_item(%w(just a friendly greeting))
+      end
+      should "have the input array retain updates" do
+        greeting = %w(just a friendly greeting)
+        @filter.pop_item(greeting)
+        assert_equal %w(just a friendly), greeting
+      end
+      should "return multiple items popped" do
+        assert_equal %w(friendly greeting), @filter.pop_item(%w(just a friendly greeting), 2)
+      end
+      should "return an array when a number is specified" do
+        assert_equal %w(greeting), @filter.pop_item(%w(just a friendly greeting), 1)
+      end
+      should "cast string inputs for numbers into actual numbers" do
+        assert_equal %w(friendly greeting), @filter.pop_item(%w(just a friendly greeting), "2")
+      end
+    end
+
     context "sample filter" do
       should "return a random item from the array" do
         input = %w(hey there bernie)