sutty-liquid 0.1.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80dcc3abc95fa1284a2fe605cbea560484b2d711351f60175bb3aba0cc85b2c5
-  data.tar.gz: a2d79c43e542447a4acf8146c8f80e49a68cc78582aa6f72314da55a68decdf8
+  metadata.gz: d90e4da9fe0d1b7d177e20fd9a05f825a07d3465d99b1641d79b75879d526c00
+  data.tar.gz: f467555d544fca178ba15dce7f1de53eadfcbea7a263fe91f9a6066ac92664d2
 SHA512:
-  metadata.gz: 7a843c2327f75c56684fd34873c999657b4aafcf2bc48e38b593eb0c571d9dde655109a235c309a949e9dd7b705b968476433b423660179e7bcc3ddb2623c0d4
-  data.tar.gz: 7686d8f2e1317a112a2d86cb479789d2b6316426e6b72eaf035fd105b9f2cc74fa1940f6693fe56184eb3fb5d466b8dea879169568e1361d91c71912ef02ca27
+  metadata.gz: 94b85e20c7c10e267e67534ab215d94539b482cc807ff7623f03d8f281463df12395cde294d00814b0b8db04897dfde6cbe0880d882982459050f7d8f53e28eb
+  data.tar.gz: 1dd71eb67a50c79a1f796ff0813968f2275e7b3fd56afe5f45234a2efc5244bb87c0da10fc90fb417547d64f72a3dbc534efa09c772dfe95eae063def69a2dd0

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,47 @@
+# 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
+
+      # 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)
+        empty = case input
+                when Integer then input.zero?
+                when Float then input.zero?
+                when TrueClass then input
+                when FalseClass then input
+                when NilClass then false
+                else input.empty?
+                end
+
+        (empty || !!input) ? value : alternative
+      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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Filters
+    module DateLocal
+      # 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]
+      # @param [String]
+      # @return [String]
+      def date_local(input, format)
+        require 'date'
+
+        input = Date.parse(input) if input.is_a? String
+
+        # Return early if we don't need to translate
+        return input.strftime(format) unless /%(|\^)[aAbBpP]/ =~ format
+
+        input.strftime translate_localization_format(input, format)
+      rescue ArgumentError
+        Jekyll.logger.warn "#{input} is not a valid Date"
+        input
+      end
+
+      private
+
+      # Adapted from the i18n gem
+      # @see {https://github.com/ruby-i18n/i18n/blob/a8f4fdcb197e56b5a698d1bc68007dd0871c03bf/lib/i18n/backend/base.rb}
+      def translate_localization_format(object, format)
+        format.to_s.gsub(/%(|\^)[aAbBpP]/) do |match|
+          case match
+          when '%a'  then i18n.dig('date', 'abbr_day_names', object.wday - 1)
+          when '%^a' then i18n.dig('date', 'abbr_day_names', object.wday - 1)&.upcase
+          when '%A'  then i18n.dig('date', 'day_names', object.wday - 1)
+          when '%^A' then i18n.dig('date', 'day_names', object.wday - 1)&.upcase
+          when '%b'  then i18n.dig('date', 'abbr_month_names', object.mon - 1)
+          when '%^b' then i18n.dig('date', 'abbr_month_names', object.mon - 1)&.upcase
+          when '%B'  then i18n.dig('date', 'month_names', object.mon - 1)
+          when '%^B' then i18n.dig('date', 'month_names', object.mon - 1)&.upcase
+          when '%p'  then i18n.dig('time', object.hour < 12 ? 'am' : 'pm')&.upcase if object.respond_to? :hour
+          when '%P'  then i18n.dig('time', object.hour < 12 ? 'am' : 'pm')&.downcase if object.respond_to? :hour
+          end
+        end
+      end
+
+      def site
+        @site ||= @context.registers[:site]
+      end
+
+      def i18n
+        @i18n ||= site.data.dig site.config['lang']
+      end
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::Filters::DateLocal)

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Filters
+    # 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
+      def numbers(input)
+        return unless input.respond_to? :gsub
+
+        input.gsub(%r{[^0-9]}, '')
+      end
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::Filters::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)
@@ -15,6 +24,7 @@ module Jekyll
         require 'uri'
 
         uri  = URI url
+        uri.host.sub! 'www.', ''
         name = %r{/@\w+} =~ uri.query ? 'mastodon' : uri.host.split('.', 2).first
 
         { 'host' => uri.host, 'name' => name, 'url' => url }.to_liquid

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,11 +1,17 @@
 # frozen_string_literal: true
 
-require_relative 'jekyll/filters/compact.rb'
-require_relative 'jekyll/filters/infinite.rb'
-require_relative 'jekyll/filters/file.rb'
-require_relative 'jekyll/filters/json.rb'
-require_relative 'jekyll/filters/sample.rb'
-require_relative 'jekyll/filters/social_network.rb'
+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/social_network'
 
-require_relative 'jekyll/filters/pry.rb'
-require_relative 'jekyll/tags/pry.rb'
+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.1.1
+  version: 0.4.1
 platform: ruby
 authors:
 - f
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-24 00:00:00.000000000 Z
+date: 2020-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -35,10 +35,15 @@ 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
@@ -75,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: Liquid filters