sutty-liquid 0.2.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 297273ee3421e54485a3e5dcb5318f26a4c83a1be37b39b10e67d9b4d051867c
-  data.tar.gz: 340d83e54a080233772571bc1bef3d7d46a04305a8da8a7e87e1d6b7d9389b00
+  metadata.gz: 208a07a3955ffd0ba332ba272d1b7ba868aacee433bb1a71cc1af72468a4d434
+  data.tar.gz: 5c5228f00ef585c35524310a5c0b57e71292dc35890ace25ce691c7ccb6b7f10
 SHA512:
-  metadata.gz: 27f0b80e42f9236d74af8b88478507794ffdcd8b7c7f556719f77d6f3c1fd95f04df0200a1669cf187e20e22bab207832c17f164319d1386c1693e51df0b0f45
-  data.tar.gz: f2d249f94e33161195357f173f154b5327f22bb8ae5b1bd34b39c95f9a77b1a34ca27b857de889cc2d28312a51402bdb2c0a77a48b62a183c47e197196157bec
+  metadata.gz: 41efec969df4effe3e52596b0ce4c38f93cf828b4e9f3614dc644d11b838d18d841ed4e5f2bf5a3ab05a106cafeaf8985c623defdbc8fd36679e9b89d4728e7d
+  data.tar.gz: dbacfff37b6598665a29290d75f106918dc47c96c9ee36c02f4e107b15e94b828814c9af045b47e440407ef696242448cef2f9a82a08949a57c6fd8a23fe6dde

data/lib/jekyll/drops/url_drop_decorator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'jekyll/drops/url_drop'
+
+module Jekyll
+  module Drops
+    module UrlDropDecorator
+      # Permits to use layout as an URL placeholder
+      def layout
+        @obj.data['layout']
+      end
+    end
+  end
+end
+
+Jekyll::Drops::UrlDrop.include Jekyll::Drops::UrlDropDecorator

data/lib/jekyll/filters/assertion.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Filters
+    module Assertion
+      # Compares two values.
+      #
+      # Example usage:
+      #
+      # {{ item.url | equals: page.url }}
+      #
+      # @param [Any]
+      # @param [Any]
+      # @return [TrueClass|FalseClass]
+      def equals(input, comparison)
+        input == comparison
+      end
+
+      # The two values must be different
+      def not(input, comparison)
+        input != comparison
+      end
+
+      # Greater than
+      #
+      # @param [Integer|Float]
+      # @param [Integer|Float]
+      # @return [TrueClass|FalseClass]
+      def gt(input, comparison)
+        input > comparison
+      end
+
+      # Less than
+      #
+      # @param [Integer|Float]
+      # @param [Integer|Float]
+      # @return [TrueClass|FalseClass]
+      def lt(input, comparison)
+        input < comparison
+      end
+
+      # Greater than or equal
+      #
+      # @param [Integer|Float]
+      # @param [Integer|Float]
+      # @return [TrueClass|FalseClass]
+      def gte(input, comparison)
+        input >= comparison
+      end
+
+      # Less than or equal
+      #
+      # @param [Integer|Float]
+      # @param [Integer|Float]
+      # @return [TrueClass|FalseClass]
+      def lte(input, comparison)
+        input <= comparison
+      end
+
+      # Ternary operator.  If the input value is truthy, return first
+      # argument, otherwise returns the last.
+      #
+      # Example usage:
+      #
+      # {% assign active = item.url | equals: page.url %}
+      # {{ active | ternary: 'active', '' }}
+      #
+      # @param [Any]
+      # @param [Any]
+      # @param [Any]
+      # @return [Any]
+      def ternary(input, value, alternative)
+        if present(input) && input
+          value
+        else
+          alternative
+        end
+      end
+
+      # Returns the value when the input is not empty or falsey
+      #
+      # If tags have something:
+      #
+      # {{ post.tags | value_if: "some tags" }} => "some tags"
+      def value_if(input, value)
+        value if present(input) && input
+      end
+
+      # Returns the value when the input is empty or falsey
+      #
+      # If tags are empty:
+      #
+      # {{ post.tags | value_unless: "no tags" }} => nil
+      def value_unless(input, value)
+        value unless present(input) && input
+      end
+
+      # Returns the input when value is not empty and truthy
+      #
+      # {{ post.url | input_if: true }} => 'url/to/post/'
+      def input_if(input, value)
+        input if present(value) && value
+      end
+
+      # {{ post.url | input_unless: false }} => nil
+      def input_unless(input, value)
+        input unless present(value) && value
+      end
+
+      # Checks if input value is empty.
+      #
+      # {{ post.title | blank }} => false
+      def blank(input)
+        case input
+        when TrueClass then false
+        when FalseClass then true
+        when NilClass then true
+        when Integer then false
+        when Float then false
+        when Time then false
+        when String then
+          require 'fast_blank'
+          input.blank?
+        when Array then input.compact.empty?
+        when Hash then input.compact.empty?
+        else input.respond_to?(:empty?) ? input.empty? : !!input
+        end
+      end
+
+      # The opposite of blank
+      #
+      # {{ post.title | present }} => true
+      def present(input)
+        !blank(input)
+      end
+
+      # Return the input if it's not blank
+      #
+      # {{ post.title | presence }} => 'the post title'
+      def presence(input)
+        input if present input
+      end
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::Filters::Assertion)

data/lib/jekyll/filters/compact.rb

@@ -5,6 +5,10 @@ module Jekyll
     module Compact
       # Removes nil values from an Array
       #
+      # Example usage:
+      #
+      # {{ 'tag,,tag2' | split: ',' | compact }}
+      #
       # @param [Array]
       # @return [Array]
       def compact(array)

data/lib/jekyll/filters/date_local.rb

@@ -3,7 +3,12 @@
 module Jekyll
   module Filters
     module DateLocal
-      # Translates month and day names.  This requires certain values on your _data/LANG.yml
+      # Translates month and day names.  This requires certain values on
+      # your _data/LANG.yml
+      #
+      # Example usage:
+      #
+      # {{ page.date | date_local: '%e de %B de %Y' }}
       #
       # @see {_data/es.yml}
       # @param [String|Date]

data/lib/jekyll/filters/file.rb

@@ -3,7 +3,11 @@
 module Jekyll
   module Filters
     module File
-      # File extension
+      # File extension.
+      #
+      # Example usage:
+      #
+      # {{ page.file.path | extname }}
       #
       # @param [String]
       # @return [Nil|String]

data/lib/jekyll/filters/json.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
-
 module Jekyll
   module Filters
     module Json
       # Converts an object to JSON
       #
+      # Note: Jekyll 4 has a jsonify filter now.
+      #
       # @param [Any]
       # @return [String]
       def json(object)

data/lib/jekyll/filters/menu.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Filters
+    module Menu
+      # Verifies if the given URL is an active item on the menu.
+      #
+      # Example usage:
+      #
+      # {% assign active_url = page.url | menu_active %}
+      # {% for item in site.i18n.menu.items %}
+      #   <a
+      #     href="{{ item.href }}"
+      #     class="{{ page.url | menu_active | equals: item.href | ternary: 'active', '' }}">
+      #
+      #     {{ item.title }}
+      #   </a>
+      # {% endfor %}
+      #
+      # @param [String] The URL to be verified
+      # @return [String] The item URL
+      def menu_active_item(page_url)
+        site_menu&.find do |key, value|
+          key == page_url || page_url.start_with?(key)
+        end&.last
+      end
+
+      # The menu is defined in a data file that corresponds to the site
+      # language.  This method converts the menu items into a map of URL
+      # parts and actual URLs.
+      #
+      # @see _data/es.yml
+      # @see {https://0xacab.org/sutty/jekyll/jekyll-locales}
+      # @return [Hash]
+      def site_menu
+        site = @context.registers[:site]
+        @site_menu ||= site.data.dig(site.config['locale'], 'menu', 'items')&.reduce({}) do |menu, item|
+          # If the item has a layout, we pick the first post and update
+          # the href.  We can't do the same for all posts because we
+          # wouldn't be able to cache the menu.
+          if item['layout']
+            doc = site.documents.find do |doc|
+              doc.data['layout'] == item['layout']
+            end
+
+            item['href'] = doc&.url
+          end
+
+          # Ignore empty or anchor items
+          next menu if item['href'].nil? || item['href'].empty? || item['href']&.start_with?('#')
+
+          menu[item['href']] = item['href']
+
+          item['active']&.each do |a|
+            menu[a] = item['href']
+          end
+
+          menu
+        end
+      end
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::Filters::Menu)

data/lib/jekyll/filters/number.rb

@@ -5,6 +5,10 @@ module Jekyll
     # Extracts numbers from a String, useful for converting phone
     # numbers to tel: links.
     #
+    # Example usage:
+    #
+    # <a href="tel:{{ page.tel | numbers }}">{{ page.tel }}</a>
+    #
     # @param [String]
     # @return [String]
     module Numbers

data/lib/jekyll/filters/pry.rb

@@ -4,6 +4,10 @@ module Jekyll
   module Filters
     module Pry
       # Pry into the input and args
+      #
+      # Example usage:
+      #
+      # {{ site.posts | pry }}
       def pry(input, *args)
         require 'pry'
 

data/lib/jekyll/filters/sample.rb

@@ -3,7 +3,11 @@
 module Jekyll
   module Filters
     module Sample
-      # Returns a random item from an Array
+      # Returns a random item from an Array.
+      #
+      # Example usage:
+      #
+      # {{ site.posts | sample }}
       #
       # @input [Array]
       # @return [Any]

data/lib/jekyll/filters/social_network.rb

@@ -7,6 +7,15 @@ module Jekyll
       # want to generate social network buttons from an undetermined
       # list of URLs.
       #
+      # Example usage:
+      #
+      # {% assign mastodon = 'https://todon.nl/@sutty' | social_network %}
+      # <a href="{{ mastodon.url }}">
+      #   <i class="fa-{{ mastodon.name }}"></i>
+      #
+      #   {{ mastodon.name | capitalize }}
+      # </a>
+      #
       # @param [String]
       # @return [Hash]
       def social_network(url)

data/lib/jekyll/filters/string.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Filters
+    module String
+      # String#start_with?
+      def start_with(input, start)
+        input.to_s.start_with? start.to_s
+      end
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::Filters::String)

data/lib/jekyll/tags/pry.rb

@@ -4,6 +4,10 @@ module Jekyll
   module Tags
     class Pry < Liquid::Tag
       # Pry into the rendering context
+      #
+      # Example usage:
+      #
+      # {% pry %}
       def render(context)
         require 'pry'
 

data/lib/sutty-liquid.rb

@@ -1,13 +1,18 @@
 # frozen_string_literal: true
 
+require_relative 'jekyll/filters/assertion'
 require_relative 'jekyll/filters/compact'
 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/string'
 require_relative 'jekyll/filters/social_network'
 
 require_relative 'jekyll/filters/pry'
 require_relative 'jekyll/tags/pry'
+
+require_relative 'jekyll/drops/url_drop_decorator'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sutty-liquid
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.6.0
 platform: ruby
 authors:
 - f
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-29 00:00:00.000000000 Z
+date: 2020-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4'
+- !ruby/object:Gem::Dependency
+  name: fast_blank
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: An assorment of Liquid filters and tags for Jekyll used in Sutty
 email:
 - f@sutty.nl
@@ -35,15 +49,19 @@ extra_rdoc_files:
 files:
 - LICENSE.txt
 - README.md
+- lib/jekyll/drops/url_drop_decorator.rb
+- lib/jekyll/filters/assertion.rb
 - lib/jekyll/filters/compact.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/string.rb
 - lib/jekyll/tags/pry.rb
 - lib/sutty-liquid.rb
 homepage: https://0xacab.org/sutty/jekyll/sutty-liquid