sutty-liquid 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4dca3383930eb8a0d60849434c5d1b7275dfc43c12e0f5daff9e1c2459ef0a37
-  data.tar.gz: 76380fdd27d27319f40444c8040d4618f1fc3c8cbc1039c882de30f179193c86
+  metadata.gz: 4bd8433b8f97fbe8879c39058fc087ae949633ab565d4d939065b50723b70ee3
+  data.tar.gz: 9fd4f7706057a9d200a843ee8496a02c2a2464c7a3bcd218f59646007997d08b
 SHA512:
-  metadata.gz: b3bb223e6c80aedf8719aa5ca77ea7c4645acb4082e720cc64af7d34ab2a5011df6e88610def6b973d39931623dd903006c4f2258a03b6ca8ee33e0c51306748
-  data.tar.gz: 0a0cbf68a807f2c1b6f63eac66d6b07c07cb9b3b17a5b4c569a337a986829f6582e6445076a113dd2fb99cd2ee97bebfd3ef1b1c59c8864ff6507c034568e5a3
+  metadata.gz: 4a67f0e87622f14d7cf6c00aa88fbfd4e8ac970bc33f4d47a4b9838eaec8169747dc2e6ced49057be52796097151953edc3b43f3ba3ba47b98d42dfe705cd55f
+  data.tar.gz: 48ad31dc479ed967a74c3aa73113f689959fc03a57af9a38d74fe323b00033c655f559c878c93644dc9043b6dbe577c490f8906d4fe9b7c3528b37155df561d2

data/lib/jekyll/filters/arrays.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Filters
+    module Arrays
+      # Returns one or several random items from an Array.
+      #
+      # @example
+      #   {{ site.posts | sample }}
+      #   {{ site.posts | sample: 3 }}
+      # @param input [Array]
+      # @param amount [Integer]
+      # @return [Any]
+      def sample(input, amount = 1)
+        input = [] unless array? input
+
+        input.sample(amount)
+      end
+
+      # Join arrays or append item to array
+      #
+      # @example
+      #   {% assign things = site.posts | where: "layout", "thing" %}
+      #   {% assign being = site.posts | find: "layout", "being" %}
+      #   {% assign dread = things | concat: being %}
+      #
+      # @param input [Array]
+      # @param concatenable [Array,any]
+      def join(input, concatenable)
+        input = [] unless array? input
+
+        if concatenable.is_a? Array
+          input + concatenable
+        else
+          input.dup << concatenable
+        end
+      end
+
+      # Finds the next posts in a collection, starting from current
+      # post and restarts from the beginning to always return posts.
+      #
+      # @example
+      #   {{ page | infinite_next: site.posts }}
+      # @param input [Jekyll::Document,Drop] The current post (page)
+      # @param posts [Array] An array of posts (ie. results from where filter)
+      # @param amount [Integer] Amount of posts next to current, max is posts size
+      # @return [Array<Jekyll::Document,Drop>] Array of posts
+      def infinite_next(input, posts, amount = 1)
+        posts = [] unless array? posts
+
+        liquid_input = input.to_liquid
+        liquid_posts = posts.map(&:to_liquid)
+        index = find_in_stack(liquid_input, liquid_posts)
+        liquid_posts.rotate(index).slice(1, amount) if index
+      end
+
+      # Finds the previous posts in a collection, starting from current
+      # post and restarts from the beginning to always return posts.
+      #
+      # @example
+      #   {{ page | infinite_next: site.posts }}
+      # @param input [Jekyll::Document,Drop] The current post (page)
+      # @param posts [Array<Jekyll::Document,Drop>] An array of posts (ie. results from where filter)
+      # @param amount [Integer] Amount of posts previous to current, max is posts size
+      # @return [Array<Jekyll::Document,Drop>] Array of posts
+      def infinite_prev(input, posts, amount = 1)
+        posts = [] unless array? posts
+
+        liquid_input = input.to_liquid
+        liquid_posts = posts.map(&:to_liquid)
+        index = find_in_stack(liquid_input, liquid_posts)
+        liquid_posts.rotate(index).reverse.slice(0, amount).reverse if index
+      end
+
+      # Return next post from an array or nothing if post is last.
+      #
+      # @example
+      #   {{ page | next: site.posts }}
+      # @param input [Jekyll::Document,Drop]
+      # @param posts [Array<Jekyll::Document,Drop>]
+      # @return [Drop,nil]
+      def next(input, posts)
+        posts = [] unless array? posts
+
+        liquid_input = input.to_liquid
+        liquid_posts = posts.map(&:to_liquid)
+        index = find_in_stack(liquid_input, liquid_posts)
+        liquid_posts[index + 1] if index
+      end
+
+      # Return previous post from an array, or nothing if post is the
+      # first item.
+      #
+      # @example
+      #   {{ page | prev: site.posts }}
+      #   {{ page | previous: site.posts }}
+      # @param input [Jekyll::Document,Drop]
+      # @param array [Array]
+      # @return [Drop,nil]
+      def prev(input, posts)
+        posts = [] unless array? posts
+
+        liquid_input = input.to_liquid
+        liquid_posts = posts.map(&:to_liquid)
+        index = find_in_stack(liquid_input, liquid_posts)
+        liquid_posts[index - 1] if index && index >= 0
+      end
+
+      alias_method :previous, :prev
+
+      private
+
+      # Detects if param is an array or raise an error if strict filters
+      # is enabled
+      #
+      # @param posts [Array]
+      # @return [Boolean]
+      def array?(posts)
+        posts.is_a?(Array).tap do |a|
+          next if a
+          next unless @context.strict_filters
+
+          raise Liquid::ArgumentError.new('needs an array argument')
+        end
+      end
+
+      # Find post in posts, raise an error if strict_filters is enabled
+      #
+      # @param input [Drop]
+      # @param posts [Array] array of drops
+      # @return [Integer]
+      def find_in_stack(input, posts)
+        posts.index(input).tap do |n|
+          next if n
+          next unless @context.strict_filters
+
+          title = input['title'] || input['id'] || 'no title'
+          titles = posts.map do |p|
+            p['title'] || p['id'] || 'no title'
+          end
+
+          raise Liquid::ArgumentError.new("can't find #{title} in #{titles.join(', ')}")
+        end
+      end
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::Filters::Arrays)

data/lib/jekyll/filters/assertion.rb

@@ -123,7 +123,7 @@ module Jekyll
           input.blank?
         when Array then input.compact.empty?
         when Hash then input.compact.empty?
-        else input.respond_to?(:empty?) ? input.empty? : !!input
+        else input.respond_to?(:empty?) ? input.empty? : !!!input
         end
       end
 

data/lib/jekyll/filters/content.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Filters
+    module Content
+      HEADINGS = 'h1,h2,h3,h4,h5,h6'
+
+      # Add id attribute to all headings with an optional prefix.  It
+      # also creates a table of contents with unique IDs.
+      #
+      # It doesn't change pre-existing IDs.
+      #
+      # @example Render content with unique IDs
+      #   {{ content | canonicalize_headings }}
+      # @param input [String] HTML string
+      # @param prefix [nil,String] Prefix IDs with this
+      # @return [String]
+      def canonicalize_headings(input, prefix = nil)
+        @@canonicalize_headings ||= {}
+        @@canonicalize_headings[input.hash] ||=
+          begin
+            require 'nokogiri'
+
+            toc = toc(input)
+
+            html_fragment(input).tap do |html|
+              html.css(HEADINGS).each do |h|
+                id = h['id']
+
+                unless id
+                  slug = ::Jekyll::Utils.slugify(h.text, mode: 'pretty')
+                  id   = unique_id(slug, prefix, toc)
+                  h['id'] = id
+                end
+
+                toc[id] = {
+                  'level' => h.name[1].to_i,
+                  'title' => h.text,
+                  'id'    => id
+                }
+              end
+            end.to_s
+          end
+      end
+
+      # Extracts a table of contents from HTML up to a certain headings
+      # level.
+      #
+      # It returns an array of hashes with title, level and id.
+      #
+      # @example Create a table of contents
+      #   {% assign toc = content | table_of_contents: 2 %}
+      #  
+      #   {% unless toc == empty %}
+      #     {% for item in toc %}
+      #       {% assign heading = "h" | append: item.level %}
+      #       <{{ heading }}>
+      #         <a href="#{{ item.id }}">
+      #           {{ item.title }}
+      #         </a>
+      #       </{{ heading }}>
+      #     {% endfor %}
+      #   {% endunless %}
+      # @param input [String]
+      # @param max_level [Integer] All headings up to this level
+      # @param prefix [String,nil] Prefix
+      # @return [Hash]
+      def table_of_contents(input, max_level = 2, prefix = nil)
+        canonicalize_headings(input, prefix)
+
+        toc(input).select do |id, item|
+          item['level'] <= max_level
+        end.values
+      end
+
+      private
+
+      # Parses and caches an HTML5 fragment
+      #
+      # @param input [String]
+      # @return [Nokogiri::HTML5::Fragment]
+      def html_fragment(input)
+        @@html_fragment ||= {}
+        @@html_fragment[input.hash] ||= Nokogiri::HTML5.fragment(input.to_s)
+      end
+
+      # @param input [String]
+      # @return [Hash]
+      def toc(input)
+        @@toc ||= {}
+        @@toc[input.hash] ||= {}
+      end
+
+      # Apply a prefix to an ID unless it's already applied
+      #
+      # @param id [String]
+      # @param prefix [nil,String]
+      # @return [String]
+      def prefix_id(id, prefix)
+        return id if prefix.nil?
+        return id if id.start_with? "#{prefix}-"
+
+        "#{prefix}-#{id}"
+      end
+
+      # Obtains a unique ID for TOC
+      #
+      # @param id [String]
+      # @param prefix [String,nil]
+      # @param toc [Hash]
+      # @return [String]
+      def unique_id(id, prefix, toc)
+        prefixed_id = prefix_id id, prefix
+
+        return prefixed_id unless toc.key? prefixed_id
+
+        require 'securerandom'
+
+        loop do
+          unique = "#{prefixed_id}-#{SecureRandom.hex(3)}"
+
+          break unique unless toc.key? unique
+        end
+      end
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::Filters::Content)

data/lib/sutty-liquid.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
+require_relative 'jekyll/filters/arrays'
 require_relative 'jekyll/filters/assertion'
 require_relative 'jekyll/filters/compact'
+require_relative 'jekyll/filters/content'
 require_relative 'jekyll/filters/date_local'
-require_relative 'jekyll/filters/infinite'
 require_relative 'jekyll/filters/file'
 require_relative 'jekyll/filters/json'
 require_relative 'jekyll/filters/menu'
 require_relative 'jekyll/filters/number'
-require_relative 'jekyll/filters/sample'
 require_relative 'jekyll/filters/strings'
 require_relative 'jekyll/filters/social_network'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sutty-liquid
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - f
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-21 00:00:00.000000000 Z
+date: 2022-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -80,6 +80,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: An assorment of Liquid filters and tags for Jekyll used in Sutty
 email:
 - f@sutty.nl
@@ -92,16 +120,16 @@ files:
 - LICENSE.txt
 - README.md
 - lib/jekyll/drops/url_drop_decorator.rb
+- lib/jekyll/filters/arrays.rb
 - lib/jekyll/filters/assertion.rb
 - lib/jekyll/filters/compact.rb
+- lib/jekyll/filters/content.rb
 - lib/jekyll/filters/date_local.rb
 - lib/jekyll/filters/file.rb
-- lib/jekyll/filters/infinite.rb
 - lib/jekyll/filters/json.rb
 - lib/jekyll/filters/menu.rb
 - lib/jekyll/filters/number.rb
 - lib/jekyll/filters/pry.rb
-- lib/jekyll/filters/sample.rb
 - lib/jekyll/filters/social_network.rb
 - lib/jekyll/filters/strings.rb
 - lib/jekyll/tags/pry.rb
@@ -137,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.8
+rubygems_version: 3.3.15
 signing_key:
 specification_version: 4
 summary: Liquid filters

data/lib/jekyll/filters/infinite.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module Jekyll
-  module Filters
-    module Infinite
-      # 
-      def infinite_next(input, posts, amount)
-        liquid = posts.map(&:to_liquid)
-        liquid.rotate(liquid.index(input)).slice(1, amount)
-      end
-
-      def infinite_prev(input, posts, amount)
-        liquid = posts.map(&:to_liquid)
-        liquid.rotate(liquid.index(input)).reverse.slice(0, amount).reverse
-      end
-    end
-  end
-end
-
-Liquid::Template.register_filter(Jekyll::Filters::Infinite)

data/lib/jekyll/filters/sample.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Jekyll
-  module Filters
-    module Sample
-      # Returns a random item from an Array.
-      #
-      # Example usage:
-      #
-      # {{ site.posts | sample }}
-      # {{ site.posts | sample: 3 }}
-      #
-      # @input [Array]
-      # @return [Any]
-      def sample(input, amount = 1)
-        return unless input.respond_to? :sample
-
-        input.sample(amount)
-      end
-    end
-  end
-end
-
-Liquid::Template.register_filter(Jekyll::Filters::Sample)