jekyll-design-tag-framework 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c354297b5c8831d0e67c5e38d9965d19dda353c454060b3cce5656e5b14f4eb6
-  data.tar.gz: ad18b193eee0b77b2b1c89885ecf9acca98666ca6b79da818d5815a5ad6dcc0f
+  metadata.gz: 4a94ceabf63164baded5ff7f0dc09e440ff0fb38dd54fbadb33652e521559212
+  data.tar.gz: 33775eeb613c688a55716404fed1b7f05712622df9e21ff03289621eae08d1ff
 SHA512:
-  metadata.gz: 58b32d723da4a965656649018db1afc07e54e648c424635cdd9dd1317d065b8e6a0ca32027ea0b3d9fcd6c1355ea015745becbdba9f60c06403c3978cd2d942e
-  data.tar.gz: d52d2950e4c50fc9af27975f130f4ee8cdc9540554171be7b2609d58fb25878919976591b71cc4c38bf91e3e6399bc402ef232b0863ad9eb4d691eedf2947c76
+  metadata.gz: 3ebf0026601255e2ff7fd700879b0cb72bd2c9a9056570d77e41ef273ebbbbbd712bb36e30043fc4686e8c58419d408f24de8e9b8cb0ec36d4571ba97b930da9
+  data.tar.gz: 62be3350b8bb8762a9d8b448e30dc1b11c4f768f42942f641b72d7c70fe29c660b8565aecaaaa5d26818bb2ef5bb910430ff51b9717af9dfef685ab15bad8e5d

data/lib/jekyll-design-tag-framework/convenience_types.rb

@@ -0,0 +1,105 @@
+require "jekyll-design-tag-framework/design_group"
+require "jekyll-design-tag-framework/design_element"
+require "jekyll-design-tag-framework/utils"
+
+module Jekyll
+  module DesignTagFramework
+    class PostGroup < DesignTagFramework::DesignGroup
+      def initialize(tag_name, text, tokens)
+        super(tag_name, text, tokens, "post_group")
+      end
+    end
+
+    class PostElement < DesignElement
+      def initialize(tag_name, text, tokens)
+        super(tag_name, text, tokens, "post_element")
+        @required_params = [ "title", "author", "url", "date" ]
+        @optional_params = [ "description", "image"]
+      end
+
+      def validate_params(params)
+        super
+        DesignTagFramework.validate_author(params["author"])
+      end
+    end
+  end
+end
+
+
+Liquid::Template.register_tag("post_group", Jekyll::DesignTagFramework::PostGroup)
+Liquid::Template.register_tag("post_element", Jekyll::DesignTagFramework::PostElement)
+
+
+module Jekyll
+  module DesignTagFramework
+    class ProjectGroup < DesignTagFramework::DesignGroup
+      def initialize(tag_name, text, tokens)
+        super(tag_name, text, tokens, "project_group")
+      end
+    end
+
+    class ProjectElement < DesignElement
+      def initialize(tag_name, text, tokens)
+        super(tag_name, text, tokens, "project_element")
+        @required_params = [ "title" ]
+        @optional_params = %w(url author image description)
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag("project_group", Jekyll::DesignTagFramework::ProjectGroup)
+Liquid::Template.register_tag("project_element", Jekyll::DesignTagFramework::ProjectElement)
+
+module Jekyll
+  module DesignTagFramework
+    class FeatureGroup < DesignTagFramework::DesignGroup
+      def initialize(tag_name, text, tokens)
+        super(tag_name, text, tokens, "feature_group")
+      end
+    end
+
+    class FeatureElement < DesignElement
+      def initialize(tag_name, text, tokens)
+        super(tag_name, text, tokens, "feature_element")
+        @required_params = [ "title" ]
+        @optional_params = [ "description", "url", "icon-path", "icon-class" ]
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag("feature_group", Jekyll::DesignTagFramework::FeatureGroup)
+Liquid::Template.register_tag("feature_element", Jekyll::DesignTagFramework::FeatureElement)
+
+module Jekyll
+  module DesignTagFramework
+    class AuthorElement < DesignElement
+      def initialize(tag_name, text, tokens)
+        super(tag_name, text, tokens, "author_element")
+        @required_params = [ "author" ]
+        @optional_params = [ "class" ]
+      end
+
+      def validate_params(params)
+        super
+        DesignTagFramework.validate_author(params["author"])
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag("author_element", Jekyll::DesignTagFramework::AuthorElement)
+
+module Jekyll
+  module DesignTagFramework
+    class AlertElement < DesignGroup
+      def initialize(tag_name, text, tokens)
+        super(tag_name, text, tokens, "alert_element")
+        @optional_params = [ "variant" ]
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag("alert_element", Jekyll::DesignTagFramework::AlertElement)

data/lib/jekyll-design-tag-framework/design_element.rb

@@ -0,0 +1,97 @@
+module Jekyll
+  module DesignTagFramework
+    class DesignElement < Liquid::Tag
+      include TemplateLoader
+      include DesignTag
+
+      VARIABLE_SYNTAX = %r!\A\s*(?:[\w.-]+)\s*\z!x.freeze
+
+      def initialize(tag_name, text, tokens, type = nil)
+        super(tag_name, text, tokens)
+        @tag_name = tag_name
+        @type = type
+        @required_params = []
+        @optional_params = []
+        if text.match(VARIABLE_SYNTAX)
+          @variable = text.strip
+        else
+          @jdt_params = ParameterParser.new(tag_name, text)
+        end
+      end
+
+      def expand_variable(context)
+        unless context[@variable]
+          raise ArgumentError, <<~MSG
+            Invalid syntax for #{@tag_name} tag:
+
+            #{@variable}
+
+            #{valid_syntax}
+
+          MSG
+        end
+
+        context[@variable]
+      end
+
+      def valid_syntax
+        example_params = @required_params
+        example_params = ["param1", "param2"] if @required_params.empty?
+        i = 1
+        example = example_params.map { |param| i += 1; "#{param}=\"#{i}\"" }.join(" ")
+        examplepst = ""
+        examplepst = " where #{example_params.map { |param| "post.#{param}"}.join(", ") } exists" unless @required_params.empty?
+        optional = "\n\nOptional parameters: #{@optional_params.join(", ")}" unless @optional_params.empty?
+        <<~MSG
+          Valid syntax:
+
+          "{% #{@tag_name} post %}" #{examplepst}
+
+          or
+
+          "{% #{@tag_name} #{example} %}"#{optional}
+        MSG
+      end
+
+      def parse(tokens); end
+
+      def render(context)
+        site = context.registers[:site]
+
+        if @jdt_params
+          params = @jdt_params.parse_params(context)
+        else
+          params =  expand_variable(context)
+        end
+
+        @type ||= @jdt_params.type
+
+        expand_author(params, site)
+        validate_params(params)
+        
+        context.stack do
+          params["classes"] = class_names
+          context["element"] = params
+
+          return Liquid::Template.parse(get_template(site).strip).render(context)
+        end
+      end
+
+      def template_name
+        return "#{@type}.html" unless @type.nil?
+
+        "design_element.html"
+      end
+
+      def template
+        "<div class=\"{{ element.classes }}\">{{ element.title }}</div>"
+      end
+
+      def class_names
+        ["design_element", @type].compact.join(" ")
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag("design_element", Jekyll::DesignTagFramework::DesignElement)

data/lib/jekyll-design-tag-framework/design_group.rb

@@ -0,0 +1,87 @@
+module Jekyll
+  module DesignTagFramework
+    class DesignGroup < Liquid::Block
+      include TemplateLoader
+      include DesignTag
+
+      def initialize(tag_name, text, tokens, type = nil)
+        super(tag_name, text, tokens)
+        @jdt_params = ParameterParser.new(tag_name, text)
+        @type = type
+        @tag_name = tag_name
+        @parity = nil
+        @required_params = []
+        @optional_params = []
+      end
+
+      def render(context)
+        text = super
+        site = context.registers[:site]
+        page = context.registers[:page]
+        @parity = get_parity(page)
+        params = @jdt_params.parse_params(context)
+        validate_params(params)
+        @type ||= @jdt_params.type
+
+        context.stack do
+          params["classes"] = class_names
+          context["group"] = params
+          text = Liquid::Template.parse(text).render(context)
+
+          markdown_converter = site.find_converter_instance(::Jekyll::Converters::Markdown)
+
+          text = markdown_converter.convert(text)
+
+          context["content"] = text
+
+          text = Liquid::Template.parse(get_template(site).strip).render(context)
+        end
+        text
+      end
+
+      def get_parity(page)
+        if page["design_group_number"].nil?
+          page["design_group_number"] = 1
+        else
+          page["design_group_number"] += 1
+        end
+        if page["design_group_number"].even?
+          "design_group_even"
+        else
+          "design_group_odd"
+        end
+      end
+
+      def template_name
+        return "#{@type}.html" unless @type.nil?
+
+        "design_group.html"
+      end
+
+      def template
+        "<div class=\"{{ group.classes }}\">{{ content }}</div>"
+      end
+
+      def class_names
+        ["design_group", @type, @parity].compact.join(" ")
+      end
+
+      def valid_syntax
+        example_params = @required_params
+        example_params = ["param1", "param2"] if @required_params.empty?
+        i = 1
+        example = example_params.map { |param| i += 1; "#{param}=\"#{i}\"" }.join(" ")
+        optional = "\n\nOptional parameters: #{@optional_params.join(", ")}" unless @optional_params.empty?
+        <<~MSG
+          Valid syntax:
+
+          "{% #{@tag_name} #{example} %}"
+          content..
+          {% end#{@tag_name} %}#{optional}
+        MSG
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag("design_group", Jekyll::DesignTagFramework::DesignGroup)

data/lib/jekyll-design-tag-framework/design_tag.rb

@@ -0,0 +1,27 @@
+module Jekyll
+  module DesignTagFramework
+    module DesignTag
+      def expand_author(params, site)
+        author = params["author"]
+        author = site.config["author"] if author.nil?
+        if site.data["authors"].is_a?(Hash) && !params["author"].is_a?(Hash)
+          params["author"] = site.data["authors"][author]
+        end
+      end
+
+      def validate_params(params)
+        return if params.nil?
+
+        @required_params.each do |param|
+          next if params.key?(param)
+
+          raise ArgumentError, <<~MSG
+            #{param} is not defined in #{@tag_name} tag
+
+            #{valid_syntax}
+          MSG
+        end
+      end
+    end
+  end
+end

data/lib/jekyll-design-tag-framework/parameter_parser.rb

@@ -0,0 +1,58 @@
+module Jekyll
+  module DesignTagFramework
+    class ParameterParser
+      VALID_SYNTAX = %r!
+            ([\w-]+)\s*=\s*
+            (?:"([^"\\]*(?:\\.[^"\\]*)*)"|'([^'\\]*(?:\\.[^'\\]*)*)'|([\w.-]+))
+          !x.freeze
+
+      FULL_VALID_SYNTAX = %r!\A\s*(?:#{VALID_SYNTAX}(?=\s|\z)\s*)*\z!.freeze
+
+      def initialize(tag_name, raw_params)
+        @tag_name = tag_name
+        @raw_params = raw_params.strip
+
+        validate_params
+      end
+
+      def validate_params
+        unless FULL_VALID_SYNTAX.match?(@raw_params)
+          raise ArgumentError, <<~MSG
+            Invalid syntax for #{@tag_name} tag:
+
+            #{@raw_params}
+
+            Valid syntax:
+
+            #{syntax_example}
+
+          MSG
+        end
+      end
+
+      def syntax_example
+        "{% #{@tag_name} param='value' param2='value' %}"
+      end
+
+      def parse_params(context)
+        @params = {}
+        @raw_params.scan(VALID_SYNTAX) do |key, d_quoted, s_quoted, variable|
+          value = if d_quoted
+                    d_quoted.include?('\\"') ? d_quoted.gsub('\\"', '"') : d_quoted
+                  elsif s_quoted
+                    s_quoted.include?("\\'") ? s_quoted.gsub("\\'", "'") : s_quoted
+                  elsif variable
+                    context[variable]
+                  end
+          @params[key] = value
+        end
+        @params
+      end
+      
+      def type
+        @params["type"] if @params.key? "type"
+      end
+
+    end
+  end
+end

data/lib/jekyll-design-tag-framework/picture_element.rb

@@ -0,0 +1,17 @@
+module Jekyll
+  module DesignTagFramework
+    class PictureElement < DesignElement
+      def initialize(tag_name, text, tokens)
+        super(tag_name, text, tokens, "picture_element")
+        @required_params = [ "src", "alt" ]
+        @optional_params = [ "class", "height", "size-hint" ]
+      end
+
+      def template
+        "<div class=\"{{ element.classes }}\"><img src=\"{{ element.src }}\"></div>"
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag("picture_element", Jekyll::DesignTagFramework::PictureElement)

data/lib/jekyll-design-tag-framework/template_loader.rb

@@ -0,0 +1,19 @@
+module Jekyll
+  module DesignTagFramework
+    module TemplateLoader
+      def load_template(site)
+        site.includes_load_paths.each do |dir|
+          path = PathManager.join(dir, "dtf")
+          file = PathManager.join(path, template_name)
+          return File.read(file, **site.file_read_opts) if File.file?(file)
+        end
+        nil
+      end
+
+      def get_template(site)
+        t = load_template(site)
+        t || template
+      end
+    end
+  end
+end

data/lib/jekyll-design-tag-framework/utils.rb

@@ -0,0 +1,15 @@
+module Jekyll
+  module DesignTagFramework
+    def validate_author(author)
+      keys = ["name"]
+      keys.each do |key|
+        next if author.key?(key)
+        raise ArgumentError, <<~MSG
+          Author #{author} has no parameter #{key}
+        MSG
+      end
+    end
+    module_function :validate_author
+
+  end
+end

data/lib/jekyll-design-tag-framework/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module DesignTagFramework
+    VERSION = "0.0.2".freeze
+  end
+end

data/lib/jekyll-design-tag-framework.rb

@@ -0,0 +1,53 @@
+require "jekyll"
+require "shellwords"
+require "jekyll-design-tag-framework/version"
+require "jekyll-design-tag-framework/template_loader"
+require "jekyll-design-tag-framework/design_tag"
+require "jekyll-design-tag-framework/parameter_parser"
+require "jekyll-design-tag-framework/design_group"
+require "jekyll-design-tag-framework/design_element"
+require "jekyll-design-tag-framework/convenience_types"
+require "jekyll-design-tag-framework/picture_element"
+
+module Jekyll
+  module DesignTagFramework
+    module ImageAssetFilter
+      def asset_expand(input, arg, alt_extension = nil)
+        dirname = File.dirname(input)
+        extension = File.extname(input)
+        basename = File.basename(input, extension)
+        extension = alt_extension unless alt_extension.nil?
+
+        "#{dirname}/#{basename}-#{arg}#{extension}"
+      end
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::DesignTagFramework::ImageAssetFilter)
+
+
+Jekyll::Hooks.register :site, :post_write do |site|
+  # code to call after Jekyll renders a page
+  brand_config = site.config["brand"]
+  if brand_config && brand_config["image"] && site.config["generate_favicon"]
+    src_file = File.join(site.source, site.config["brand"]["image"])
+    extension = File.extname(src_file)
+    # basename = File.basename(src_file, extension)
+    unless File.exist?(src_file)
+      throw "Could not find file #{src_file}"
+    end
+
+    dst_file = File.join(site.dest, "favicon.ico")
+
+    cmd = "magick #{src_file.shellescape} -alpha off -resize 48x48 #{dst_file.shellescape}"
+    system(cmd)
+
+    dst_file = File.join(site.dest, "favicon512x512.png")
+
+    cmd = "magick #{src_file.shellescape} -resize 512x512 #{dst_file.shellescape}"
+    system(cmd)
+
+  end
+
+end

metadata

@@ -1,10 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-design-tag-framework
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Markus Sosnowski
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2025-02-03 00:00:00.000000000 Z
@@ -71,16 +72,29 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.14.0
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- lib/jekyll-design-tag-framework.rb
+- lib/jekyll-design-tag-framework/convenience_types.rb
+- lib/jekyll-design-tag-framework/design_element.rb
+- lib/jekyll-design-tag-framework/design_group.rb
+- lib/jekyll-design-tag-framework/design_tag.rb
+- lib/jekyll-design-tag-framework/parameter_parser.rb
+- lib/jekyll-design-tag-framework/picture_element.rb
+- lib/jekyll-design-tag-framework/template_loader.rb
+- lib/jekyll-design-tag-framework/utils.rb
+- lib/jekyll-design-tag-framework/version.rb
 homepage: https://design-tag-framework.github.io/jekyll-design-tag-framework/
 licenses:
 - AGPL-3.0-only
 metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -95,7 +109,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.1
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: A collection of Liquid tags for Jekyll themes and sites, to help separating
   design and content.