liquid 4.0.3 → 5.4.0

data/lib/liquid/standardfilters.rb

@@ -1,56 +1,120 @@
+# frozen_string_literal: true
+
 require 'cgi'
+require 'base64'
 require 'bigdecimal'
 
 module Liquid
   module StandardFilters
+    MAX_INT = (1 << 31) - 1
     HTML_ESCAPE = {
-      '&'.freeze => '&amp;'.freeze,
-      '>'.freeze => '&gt;'.freeze,
-      '<'.freeze => '&lt;'.freeze,
-      '"'.freeze => '&quot;'.freeze,
-      "'".freeze => '&#39;'.freeze
+      '&' => '&amp;',
+      '>' => '&gt;',
+      '<' => '&lt;',
+      '"' => '&quot;',
+      "'" => '&#39;',
     }.freeze
     HTML_ESCAPE_ONCE_REGEXP = /["><']|&(?!([a-zA-Z]+|(#\d+));)/
-    STRIP_HTML_BLOCKS = Regexp.union(
-      /<script.*?<\/script>/m,
+    STRIP_HTML_BLOCKS       = Regexp.union(
+      %r{<script.*?</script>}m,
       /<!--.*?-->/m,
-      /<style.*?<\/style>/m
+      %r{<style.*?</style>}m
     )
     STRIP_HTML_TAGS = /<.*?>/m
 
-    # Return the size of an array or of an string
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category array
+    # @liquid_summary
+    #   Returns the size of a string or array.
+    # @liquid_description
+    #   The size of a string is the number of characters that the string includes. The size of an array is the number of items
+    #   in the array.
+    # @liquid_syntax variable | size
+    # @liquid_return [number]
     def size(input)
       input.respond_to?(:size) ? input.size : 0
     end
 
-    # convert an input string to DOWNCASE
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category string
+    # @liquid_summary
+    #   Converts a string to all lowercase characters.
+    # @liquid_syntax string | downcase
+    # @liquid_return [string]
     def downcase(input)
       input.to_s.downcase
     end
 
-    # convert an input string to UPCASE
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category string
+    # @liquid_summary
+    #   Converts a string to all uppercase characters.
+    # @liquid_syntax string | upcase
+    # @liquid_return [string]
     def upcase(input)
       input.to_s.upcase
     end
 
-    # capitalize words in the input centence
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category string
+    # @liquid_summary
+    #   Capitalizes the first word in a string.
+    # @liquid_syntax string | capitalize
+    # @liquid_return [string]
     def capitalize(input)
       input.to_s.capitalize
     end
 
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category string
+    # @liquid_summary
+    #   Escapes a string.
+    # @liquid_syntax string | escape
+    # @liquid_return [string]
     def escape(input)
-      CGI.escapeHTML(input.to_s).untaint unless input.nil?
+      CGI.escapeHTML(input.to_s) unless input.nil?
     end
     alias_method :h, :escape
 
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category string
+    # @liquid_summary
+    #   Escapes a string without changing characters that have already been escaped.
+    # @liquid_syntax string | escape_once
+    # @liquid_return [string]
     def escape_once(input)
       input.to_s.gsub(HTML_ESCAPE_ONCE_REGEXP, HTML_ESCAPE)
     end
 
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category string
+    # @liquid_summary
+    #   Converts any URL-unsafe characters in a string to the
+    #   [percent-encoded](https://developer.mozilla.org/en-US/docs/Glossary/percent-encoding) equivalent.
+    # @liquid_description
+    #   > Note:
+    #   > Spaces are converted to a `+` character, instead of a percent-encoded character.
+    # @liquid_syntax string | url_encode
+    # @liquid_return [string]
     def url_encode(input)
       CGI.escape(input.to_s) unless input.nil?
     end
 
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category string
+    # @liquid_summary
+    #   Decodes any [percent-encoded](https://developer.mozilla.org/en-US/docs/Glossary/percent-encoding) characters
+    #   in a string.
+    # @liquid_syntax string | url_decode
+    # @liquid_return [string]
     def url_decode(input)
       return if input.nil?
 
@@ -60,6 +124,64 @@ module Liquid
       result
     end
 
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category string
+    # @liquid_summary
+    #   Encodes a string to [Base64 format](https://developer.mozilla.org/en-US/docs/Glossary/Base64).
+    # @liquid_syntax string | base64_encode
+    # @liquid_return [string]
+    def base64_encode(input)
+      Base64.strict_encode64(input.to_s)
+    end
+
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category string
+    # @liquid_summary
+    #   Decodes a string in [Base64 format](https://developer.mozilla.org/en-US/docs/Glossary/Base64).
+    # @liquid_syntax string | base64_decode
+    # @liquid_return [string]
+    def base64_decode(input)
+      Base64.strict_decode64(input.to_s)
+    rescue ::ArgumentError
+      raise Liquid::ArgumentError, "invalid base64 provided to base64_decode"
+    end
+
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category string
+    # @liquid_summary
+    #   Encodes a string to URL-safe [Base64 format](https://developer.mozilla.org/en-US/docs/Glossary/Base64).
+    # @liquid_syntax string | base64_url_safe_encode
+    # @liquid_return [string]
+    def base64_url_safe_encode(input)
+      Base64.urlsafe_encode64(input.to_s)
+    end
+
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category string
+    # @liquid_summary
+    #   Decodes a string in URL-safe [Base64 format](https://developer.mozilla.org/en-US/docs/Glossary/Base64).
+    # @liquid_syntax string | base64_url_safe_decode
+    # @liquid_return [string]
+    def base64_url_safe_decode(input)
+      Base64.urlsafe_decode64(input.to_s)
+    rescue ::ArgumentError
+      raise Liquid::ArgumentError, "invalid base64 provided to base64_url_safe_decode"
+    end
+
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category string
+    # @liquid_summary
+    #   Returns a substring or series of array items, starting at a given 0-based index.
+    # @liquid_description
+    #   By default, the substring has a length of one character, and the array series has one array item. However, you can
+    #   provide a second parameter to specify the number of characters or array items.
+    # @liquid_syntax string | slice
+    # @liquid_return [string]
     def slice(input, offset, length = nil)
       offset = Utils.to_integer(offset)
       length = length ? Utils.to_integer(length) : 1
@@ -71,68 +193,151 @@ module Liquid
       end
     end
 
-    # Truncate a string down to x characters
-    def truncate(input, length = 50, truncate_string = "...".freeze)
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category string
+    # @liquid_summary
+    #   Truncates a string down to a given number of characters.
+    # @liquid_description
+    #   If the specified number of characters is less than the length of the string, then an ellipsis (`...`) is appended to
+    #   the truncated string. The ellipsis is included in the character count of the truncated string.
+    # @liquid_syntax string | truncate: number
+    # @liquid_return [string]
+    def truncate(input, length = 50, truncate_string = "...")
       return if input.nil?
       input_str = input.to_s
-      length = Utils.to_integer(length)
+      length    = Utils.to_integer(length)
+
       truncate_string_str = truncate_string.to_s
+
       l = length - truncate_string_str.length
       l = 0 if l < 0
-      input_str.length > length ? input_str[0...l] + truncate_string_str : input_str
+
+      input_str.length > length ? input_str[0...l].concat(truncate_string_str) : input_str
     end
 
-    def truncatewords(input, words = 15, truncate_string = "...".freeze)
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category string
+    # @liquid_summary
+    #   Truncates a string down to a given number of words.
+    # @liquid_description
+    #   If the specified number of words is less than the number of words in the string, then an ellipsis (`...`) is appended to
+    #   the truncated string.
+    #
+    #   > Caution:
+    #   > HTML tags are treated as words, so you should strip any HTML from truncated content. If you don't strip HTML, then
+    #   > closing HTML tags can be removed, which can result in unexpected behavior.
+    # @liquid_syntax string | truncatewords: number
+    # @liquid_return [string]
+    def truncatewords(input, words = 15, truncate_string = "...")
       return if input.nil?
-      wordlist = input.to_s.split
+      input = input.to_s
       words = Utils.to_integer(words)
-      l = words - 1
-      l = 0 if l < 0
-      wordlist.length > l ? wordlist[0..l].join(" ".freeze) + truncate_string.to_s : input
+      words = 1 if words <= 0
+
+      wordlist = begin
+        input.split(" ", words + 1)
+      rescue RangeError
+        raise if words + 1 < MAX_INT
+        # e.g. integer #{words} too big to convert to `int'
+        raise Liquid::ArgumentError, "integer #{words} too big for truncatewords"
+      end
+      return input if wordlist.length <= words
+
+      wordlist.pop
+      wordlist.join(" ").concat(truncate_string.to_s)
     end
 
-    # Split input string into an array of substrings separated by given pattern.
-    #
-    # Example:
-    #   <div class="summary">{{ post | split '//' | first }}</div>
-    #
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category string
+    # @liquid_summary
+    #   Splits a string into an array of substrings based on a given separator.
+    # @liquid_syntax string | split: string
+    # @liquid_return [array[string]]
     def split(input, pattern)
       input.to_s.split(pattern.to_s)
     end
 
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category string
+    # @liquid_summary
+    #   Strips all whitespace from the left and right of a string.
+    # @liquid_syntax string | strip
+    # @liquid_return [string]
     def strip(input)
       input.to_s.strip
     end
 
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category string
+    # @liquid_summary
+    #   Strips all whitespace from the left of a string.
+    # @liquid_syntax string | lstrip
+    # @liquid_return [string]
     def lstrip(input)
       input.to_s.lstrip
     end
 
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category string
+    # @liquid_summary
+    #   Strips all whitespace from the right of a string.
+    # @liquid_syntax string | rstrip
+    # @liquid_return [string]
     def rstrip(input)
       input.to_s.rstrip
     end
 
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category string
+    # @liquid_summary
+    #   Strips all HTML tags from a string.
+    # @liquid_syntax string | strip_html
+    # @liquid_return [string]
     def strip_html(input)
-      empty = ''.freeze
+      empty  = ''
       result = input.to_s.gsub(STRIP_HTML_BLOCKS, empty)
       result.gsub!(STRIP_HTML_TAGS, empty)
       result
     end
 
-    # Remove all newlines from the string
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category string
+    # @liquid_summary
+    #   Strips all newline characters (line breaks) from a string.
+    # @liquid_syntax string | strip_newlines
+    # @liquid_return [string]
     def strip_newlines(input)
-      input.to_s.gsub(/\r?\n/, ''.freeze)
-    end
-
-    # Join elements of the array with certain character between them
-    def join(input, glue = ' '.freeze)
-      InputIterator.new(input).join(glue)
-    end
-
-    # Sort elements of the array
-    # provide optional property with which to sort an array of hashes or drops
+      input.to_s.gsub(/\r?\n/, '')
+    end
+
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category array
+    # @liquid_summary
+    #   Combines all of the items in an array into a single string, separated by a space.
+    # @liquid_syntax array | join
+    # @liquid_return [string]
+    def join(input, glue = ' ')
+      InputIterator.new(input, context).join(glue)
+    end
+
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category array
+    # @liquid_summary
+    #   Sorts the items in an array in case-sensitive alphabetical, or numerical, order.
+    # @liquid_syntax array | sort
+    # @liquid_return [array[untyped]]
     def sort(input, property = nil)
-      ary = InputIterator.new(input)
+      ary = InputIterator.new(input, context)
 
       return [] if ary.empty?
 
@@ -149,10 +354,19 @@ module Liquid
       end
     end
 
-    # Sort elements of an array ignoring case if strings
-    # provide optional property with which to sort an array of hashes or drops
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category array
+    # @liquid_summary
+    #   Sorts the items in an array in case-insensitive alphabetical order.
+    # @liquid_description
+    #   > Caution:
+    #   > You shouldn't use the `sort_natural` filter to sort numerical values. When comparing items an array, each item is converted to a
+    #   > string, so sorting on numerical values can lead to unexpected results.
+    # @liquid_syntax array | sort_natural
+    # @liquid_return [array[untyped]]
     def sort_natural(input, property = nil)
-      ary = InputIterator.new(input)
+      ary = InputIterator.new(input, context)
 
       return [] if ary.empty?
 
@@ -169,58 +383,91 @@ module Liquid
       end
     end
 
-    # Filter the elements of an array to those with a certain property value.
-    # By default the target is any truthy value.
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category array
+    # @liquid_summary
+    #   Filters an array to include only items with a specific property value.
+    # @liquid_description
+    #   This requires you to provide both the property name and the associated value.
+    # @liquid_syntax array | where: string, string
+    # @liquid_return [array[untyped]]
     def where(input, property, target_value = nil)
-      ary = InputIterator.new(input)
+      ary = InputIterator.new(input, context)
 
       if ary.empty?
         []
-      elsif ary.first.respond_to?(:[]) && target_value.nil?
-        begin
-          ary.select { |item| item[property] }
+      elsif target_value.nil?
+        ary.select do |item|
+          item[property]
         rescue TypeError
           raise_property_error(property)
+        rescue NoMethodError
+          return nil unless item.respond_to?(:[])
+          raise
         end
-      elsif ary.first.respond_to?(:[])
-        begin
-          ary.select { |item| item[property] == target_value }
+      else
+        ary.select do |item|
+          item[property] == target_value
         rescue TypeError
           raise_property_error(property)
+        rescue NoMethodError
+          return nil unless item.respond_to?(:[])
+          raise
         end
       end
     end
 
-    # Remove duplicate elements from an array
-    # provide optional property with which to determine uniqueness
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category array
+    # @liquid_summary
+    #   Removes any duplicate items in an array.
+    # @liquid_syntax array | uniq
+    # @liquid_return [array[untyped]]
     def uniq(input, property = nil)
-      ary = InputIterator.new(input)
+      ary = InputIterator.new(input, context)
 
       if property.nil?
         ary.uniq
       elsif ary.empty? # The next two cases assume a non-empty array.
         []
-      elsif ary.first.respond_to?(:[])
-        begin
-          ary.uniq { |a| a[property] }
+      else
+        ary.uniq do |item|
+          item[property]
         rescue TypeError
           raise_property_error(property)
+        rescue NoMethodError
+          return nil unless item.respond_to?(:[])
+          raise
         end
       end
     end
 
-    # Reverse the elements of an array
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category array
+    # @liquid_summary
+    #   Reverses the order of the items in an array.
+    # @liquid_syntax array | reverse
+    # @liquid_return [array[untyped]]
     def reverse(input)
-      ary = InputIterator.new(input)
+      ary = InputIterator.new(input, context)
       ary.reverse
     end
 
-    # map/collect on a given property
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category array
+    # @liquid_summary
+    #   Creates an array of values from a specific property of the items in an array.
+    # @liquid_syntax array | map: string
+    # @liquid_return [array[untyped]]
     def map(input, property)
-      InputIterator.new(input).map do |e|
+      InputIterator.new(input, context).map do |e|
         e = e.call if e.is_a?(Proc)
 
-        if property == "to_liquid".freeze
+        if property == "to_liquid"
           e
         elsif e.respond_to?(:[])
           r = e[property]
@@ -231,64 +478,157 @@ module Liquid
       raise_property_error(property)
     end
 
-    # Remove nils within an array
-    # provide optional property with which to check for nil
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category array
+    # @liquid_summary
+    #   Removes any `nil` items from an array.
+    # @liquid_syntax array | compact
+    # @liquid_return [array[untyped]]
     def compact(input, property = nil)
-      ary = InputIterator.new(input)
+      ary = InputIterator.new(input, context)
 
       if property.nil?
         ary.compact
       elsif ary.empty? # The next two cases assume a non-empty array.
         []
-      elsif ary.first.respond_to?(:[])
-        begin
-          ary.reject { |a| a[property].nil? }
+      else
+        ary.reject do |item|
+          item[property].nil?
         rescue TypeError
           raise_property_error(property)
+        rescue NoMethodError
+          return nil unless item.respond_to?(:[])
+          raise
         end
       end
     end
 
-    # Replace occurrences of a string with another
-    def replace(input, string, replacement = ''.freeze)
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category string
+    # @liquid_summary
+    #   Replaces any instance of a substring inside a string with a given string.
+    # @liquid_syntax string | replace: string, string
+    # @liquid_return [string]
+    def replace(input, string, replacement = '')
       input.to_s.gsub(string.to_s, replacement.to_s)
     end
 
-    # Replace the first occurrences of a string with another
-    def replace_first(input, string, replacement = ''.freeze)
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category string
+    # @liquid_summary
+    #   Replaces the first instance of a substring inside a string with a given string.
+    # @liquid_syntax string | replace_first: string, string
+    # @liquid_return [string]
+    def replace_first(input, string, replacement = '')
       input.to_s.sub(string.to_s, replacement.to_s)
     end
 
-    # remove a substring
-    def remove(input, string)
-      input.to_s.gsub(string.to_s, ''.freeze)
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category string
+    # @liquid_summary
+    #   Replaces the last instance of a substring inside a string with a given string.
+    # @liquid_syntax string | replace_last: string, string
+    # @liquid_return [string]
+    def replace_last(input, string, replacement)
+      input = input.to_s
+      string = string.to_s
+      replacement = replacement.to_s
+
+      start_index = input.rindex(string)
+
+      return input unless start_index
+
+      output = input.dup
+      output[start_index, string.length] = replacement
+      output
     end
 
-    # remove the first occurrences of a substring
-    def remove_first(input, string)
-      input.to_s.sub(string.to_s, ''.freeze)
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category string
+    # @liquid_summary
+    #   Removes any instance of a substring inside a string.
+    # @liquid_syntax string | remove: string
+    # @liquid_return [string]
+    def remove(input, string)
+      replace(input, string, '')
     end
 
-    # add one string to another
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category string
+    # @liquid_summary
+    #   Removes the first instance of a substring inside a string.
+    # @liquid_syntax string | remove_first: string
+    # @liquid_return [string]
+    def remove_first(input, string)
+      replace_first(input, string, '')
+    end
+
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category string
+    # @liquid_summary
+    #   Removes the last instance of a substring inside a string.
+    # @liquid_syntax string | remove_last: string
+    # @liquid_return [string]
+    def remove_last(input, string)
+      replace_last(input, string, '')
+    end
+
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category string
+    # @liquid_summary
+    #   Adds a given string to the end of a string.
+    # @liquid_syntax string | append: string
+    # @liquid_return [string]
     def append(input, string)
       input.to_s + string.to_s
     end
 
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category array
+    # @liquid_summary
+    #   Concatenates (combines) two arrays.
+    # @liquid_description
+    #   > Note:
+    #   > The `concat` filter won't filter out duplicates. If you want to remove duplicates, then you need to use the
+    #   > [`uniq` filter](/api/liquid/filters#uniq).
+    # @liquid_syntax array | concat: array
+    # @liquid_return [array[untyped]]
     def concat(input, array)
       unless array.respond_to?(:to_ary)
-        raise ArgumentError.new("concat filter requires an array argument")
+        raise ArgumentError, "concat filter requires an array argument"
       end
-      InputIterator.new(input).concat(array)
+      InputIterator.new(input, context).concat(array)
     end
 
-    # prepend a string to another
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category string
+    # @liquid_summary
+    #   Adds a given string to the beginning of a string.
+    # @liquid_syntax string | prepend: string
+    # @liquid_return [string]
     def prepend(input, string)
       string.to_s + input.to_s
     end
 
-    # Add <br /> tags in front of all newlines in input string
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category string
+    # @liquid_summary
+    #   Converts newlines (`\n`) in a string to HTML line breaks (`<br>`).
+    # @liquid_syntax string | newline_to_br
+    # @liquid_return [string]
     def newline_to_br(input)
-      input.to_s.gsub(/\n/, "<br />\n".freeze)
+      input.to_s.gsub(/\r?\n/, "<br />\n")
     end
 
     # Reformat a date using Ruby's core Time#strftime( string ) -> string
@@ -325,63 +665,111 @@ module Liquid
     def date(input, format)
       return input if format.to_s.empty?
 
-      return input unless date = Utils.to_date(input)
+      return input unless (date = Utils.to_date(input))
 
       date.strftime(format.to_s)
     end
 
-    # Get the first element of the passed in array
-    #
-    # Example:
-    #    {{ product.images | first | to_img }}
-    #
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category array
+    # @liquid_summary
+    #   Returns the first item in an array.
+    # @liquid_syntax array | first
+    # @liquid_return [untyped]
     def first(array)
       array.first if array.respond_to?(:first)
     end
 
-    # Get the last element of the passed in array
-    #
-    # Example:
-    #    {{ product.images | last | to_img }}
-    #
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category array
+    # @liquid_summary
+    #   Returns the last item in an array.
+    # @liquid_syntax array | last
+    # @liquid_return [untyped]
     def last(array)
       array.last if array.respond_to?(:last)
     end
 
-    # absolute value
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category math
+    # @liquid_summary
+    #   Returns the absolute value of a number.
+    # @liquid_syntax number | abs
+    # @liquid_return [number]
     def abs(input)
       result = Utils.to_number(input).abs
       result.is_a?(BigDecimal) ? result.to_f : result
     end
 
-    # addition
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category math
+    # @liquid_summary
+    #   Adds two numbers.
+    # @liquid_syntax number | plus: number
+    # @liquid_return [number]
     def plus(input, operand)
       apply_operation(input, operand, :+)
     end
 
-    # subtraction
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category math
+    # @liquid_summary
+    #   Subtracts a given number from another number.
+    # @liquid_syntax number | minus: number
+    # @liquid_return [number]
     def minus(input, operand)
       apply_operation(input, operand, :-)
     end
 
-    # multiplication
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category math
+    # @liquid_summary
+    #   Multiplies a number by a given number.
+    # @liquid_syntax number | times: number
+    # @liquid_return [number]
     def times(input, operand)
       apply_operation(input, operand, :*)
     end
 
-    # division
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category math
+    # @liquid_summary
+    #   Divides a number by a given number.
+    # @liquid_syntax number | divided_by: number
+    # @liquid_return [number]
     def divided_by(input, operand)
       apply_operation(input, operand, :/)
     rescue ::ZeroDivisionError => e
       raise Liquid::ZeroDivisionError, e.message
     end
 
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category math
+    # @liquid_summary
+    #   Returns the remainder of dividing a number by a given number.
+    # @liquid_syntax number | modulo: number
+    # @liquid_return [number]
     def modulo(input, operand)
       apply_operation(input, operand, :%)
     rescue ::ZeroDivisionError => e
       raise Liquid::ZeroDivisionError, e.message
     end
 
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category math
+    # @liquid_summary
+    #   Rounds a number to the nearest integer.
+    # @liquid_syntax number | round
+    # @liquid_return [number]
     def round(input, n = 0)
       result = Utils.to_number(input).round(Utils.to_number(n))
       result = result.to_f if result.is_a?(BigDecimal)
@@ -391,18 +779,39 @@ module Liquid
       raise Liquid::FloatDomainError, e.message
     end
 
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category math
+    # @liquid_summary
+    #   Rounds a number up to the nearest integer.
+    # @liquid_syntax number | ceil
+    # @liquid_return [number]
     def ceil(input)
       Utils.to_number(input).ceil.to_i
     rescue ::FloatDomainError => e
       raise Liquid::FloatDomainError, e.message
     end
 
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category math
+    # @liquid_summary
+    #   Rounds a number down to the nearest integer.
+    # @liquid_syntax number | floor
+    # @liquid_return [number]
     def floor(input)
       Utils.to_number(input).floor.to_i
     rescue ::FloatDomainError => e
       raise Liquid::FloatDomainError, e.message
     end
 
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category math
+    # @liquid_summary
+    #   Limits a number to a minimum value.
+    # @liquid_syntax number | at_least
+    # @liquid_return [number]
     def at_least(input, n)
       min_value = Utils.to_number(n)
 
@@ -411,6 +820,13 @@ module Liquid
       result.is_a?(BigDecimal) ? result.to_f : result
     end
 
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category math
+    # @liquid_summary
+    #   Limits a number to a maximum value.
+    # @liquid_syntax number | at_most
+    # @liquid_return [number]
     def at_most(input, n)
       max_value = Utils.to_number(n)
 
@@ -419,18 +835,30 @@ module Liquid
       result.is_a?(BigDecimal) ? result.to_f : result
     end
 
-    def default(input, default_value = ''.freeze)
-      if !input || input.respond_to?(:empty?) && input.empty?
-        default_value
-      else
-        input
-      end
+    # @liquid_public_docs
+    # @liquid_type filter
+    # @liquid_category default
+    # @liquid_summary
+    #   Sets a default value for any variable whose value is one of the following:
+    #
+    #   - [`empty`](/api/liquid/basics#empty)
+    #   - [`false`](/api/liquid/basics#truthy-and-falsy)
+    #   - [`nil`](/api/liquid/basics#nil)
+    # @liquid_syntax variable | default: variable
+    # @liquid_return [untyped]
+    # @liquid_optional_param allow_false [boolean] Whether to use false values instead of the default.
+    def default(input, default_value = '', options = {})
+      options = {} unless options.is_a?(Hash)
+      false_check = options['allow_false'] ? input.nil? : !Liquid::Utils.to_liquid_value(input)
+      false_check || (input.respond_to?(:empty?) && input.empty?) ? default_value : input
     end
 
     private
 
+    attr_reader :context
+
     def raise_property_error(property)
-      raise Liquid::ArgumentError.new("cannot select the property '#{property}'")
+      raise Liquid::ArgumentError, "cannot select the property '#{property}'"
     end
 
     def apply_operation(input, operand, operation)
@@ -439,10 +867,16 @@ module Liquid
     end
 
     def nil_safe_compare(a, b)
-      if !a.nil? && !b.nil?
-        a <=> b
+      result = a <=> b
+
+      if result
+        result
+      elsif a.nil?
+        1
+      elsif b.nil?
+        -1
       else
-        a.nil? ? 1 : -1
+        raise Liquid::ArgumentError, "cannot sort values of incompatible types"
       end
     end
 
@@ -457,8 +891,9 @@ module Liquid
     class InputIterator
       include Enumerable
 
-      def initialize(input)
-        @input = if input.is_a?(Array)
+      def initialize(input, context)
+        @context = context
+        @input   = if input.is_a?(Array)
           input.flatten
         elsif input.is_a?(Hash)
           [input]
@@ -496,7 +931,9 @@ module Liquid
 
       def each
         @input.each do |e|
-          yield(e.respond_to?(:to_liquid) ? e.to_liquid : e)
+          e = e.respond_to?(:to_liquid) ? e.to_liquid : e
+          e.context = @context if e.respond_to?(:context=)
+          yield(e)
         end
       end
     end