jekyll-blocker 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 591645b9e0b2cc0f0fd3782d5a2170f2c97e63a84920ec656c168ce15e480880
-  data.tar.gz: 98325df110ec872d1d2e29059632032f44862c4ba0466c65bad8a21f2adc0cf7
+  metadata.gz: 6c51070fc39c52b68d6128a6143082313acd82382ff23cf25b3bd453fc738a86
+  data.tar.gz: e5e7c38c7249214d34c451466b1fa1d37d1473acd1e564011af560920b99b937
 SHA512:
-  metadata.gz: b50cad9330bf30e45b2ce8b9a96a0886084b05dcfc1058f31795958c86102cf766c007c006d1f6b3e7623f74dccc17414a9ced029b233102f2999ce76075f64a
-  data.tar.gz: c2230ea2d1a449db8aa0f27c2dcd232c9e245619c6192c42b474414bb0ea77a7ffd59f92a400a682cc5d1bbfea9e252a5aa1bcccff890e43d57447b848eb978c
+  metadata.gz: fa742a641e07901bf7f3ac3b41fc6c5888b5355c977983a077872cd2398960ce73f2e2ee1ab562cf5f6d55acac9f39e04eaab94b0d28bd1ecb1e488881263bf5
+  data.tar.gz: a2558c03ea41e9e91499a0e5666234965f6e33f32101a183b9a8ee80745134b39f7be8d6b47f09ce34bfd1f602bdac9c8052b07ffc01a1b82f724c4e32a30cfb

data/bin/blocker

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+
+require "thor"
+require "jekyll-blocker"
+
+class BlockerCLI < Thor
+  desc "new PATH", "create a new jekyll site setup for blocker in PATH"
+  def new(path)
+    pastel = Pastel.new
+    full_path = File.expand_path(path)
+
+    if Dir.exist?(full_path)
+      if !Dir.empty?(full_path)
+        error = "The path is not empty. Cannot create new jekyll-blocker project."
+        puts pastel.red(error)
+        exit
+      end
+    else
+      FileUtils.mkdir_p(full_path)
+    end
+
+    FileUtils.cp_r(File.join(
+                     File.expand_path(
+                       File.join(__dir__, "..", "lib", "new_site")), '.'),
+                   full_path)
+
+    puts pastel.cyan("Copied Files:")
+    Dir.glob(File.join(full_path, "**", "*"), File::FNM_DOTMATCH).
+        select{|file| File.file?(file)}.
+        each do |file|
+          puts "  " + file.sub(/\A#{full_path}#{File::SEPARATOR}/, '')
+        end
+
+    Dir.chdir(full_path) do
+      puts pastel.cyan("\nBundling:")
+      puts `bundle`
+
+      puts pastel.cyan("\nMaking Git repo")
+      puts `git init`
+    end
+  end
+
+  desc "version", "jekyll-blocker version"
+  def version
+    puts JekyllBlocker::VERSION
+  end
+end
+
+BlockerCLI.start(ARGV)

data/lib/jekyll-blocker/block.rb

@@ -0,0 +1,58 @@
+module JekyllBlocker
+  class Block
+    attr_accessor :content, :data
+
+    ALLOWED_TAGS = %w(assign break capture case comment continue cycle decrement
+                      for if ifchanged increment raw tablerow unless highlight
+                      link post_url)
+
+    def initialize(content: "", data: {})
+      @content = content.instance_of?(String) ? content : ""
+      @data    = data.instance_of?(Hash) ? data : {}
+    end
+
+    def render(instance_data, context)
+      _context = Liquid::Context.new(context.environments.dup, {}, context.registers)
+
+      data.each do |key, value|
+        temp = instance_data.key?(key) ? instance_data[key] : value["value"]
+        case value["type"]
+        when "text", "richtext", "html"
+          essential_liquid_tags do
+            temp = Liquid::Template.parse(temp).render(context)
+          end
+        when "image"
+          temp['src'] = '/uploads/images/' + temp['src']
+        when "file"
+          temp = '/uploads/files/' + temp
+        when "markdown"
+          essential_liquid_tags do
+            temp = Liquid::Template.parse(temp).render(context)
+          end
+          temp = Kramdown::Document.new(temp, input: 'GFM').to_html
+        end
+        _context[key] = temp
+      end
+
+      template = Liquid::Template.parse(@content)
+      template.render(_context)
+    end
+
+    private
+
+    def essential_liquid_tags
+      removed = {}
+      Liquid::Template.tags.each do |name, klass|
+        unless ALLOWED_TAGS.include?(name)
+          removed[name] = klass
+          Liquid::Template.tags.delete(name)
+        end
+      end
+      yield
+      removed.each do |name, klass|
+        Liquid::Template.register_tag(name, Object.const_get(klass))
+      end
+    end
+  end
+end
+

data/lib/jekyll-blocker/block_collection.rb

@@ -0,0 +1,32 @@
+module JekyllBlocker
+  class BlockCollection
+    def initialize(folder)
+      @blocks = {}
+      @path = File.join(folder, "_blocker", "blocks")
+
+      paths = Dir[File.join(@path, "**", "*.{html,liquid}")]
+      paths.each { |path| load_block(path) }
+    end
+
+    def find(name)
+      @blocks[name]
+    end
+
+    private
+
+    def load_block(path)
+      file = Utilities.read_jekyll_file(path)
+
+      key = Pathname(
+              path.sub(/\A#{@path}/, '').
+                   sub(/#{File.extname(path)}\z/, '')
+            ).each_filename.to_a.join('/')
+
+      if @blocks.key? key
+        raise ValidationError, "Block '#{key}' exists in multiple extensions"
+      end
+
+      @blocks[key] = Block.new(content: file[:content], data: file[:data])
+    end
+  end
+end

data/lib/jekyll-blocker/converters.rb

@@ -0,0 +1,18 @@
+module JekyllBlocker
+  class LiquidConverter < Jekyll::Converter
+    safe true
+    priority :low
+
+    def matches(ext)
+      ext =~ /^\.liquid$/i
+    end
+
+    def output_ext(ext)
+      ".html"
+    end
+
+    def convert(content)
+      content
+    end
+  end
+end

data/lib/jekyll-blocker/errors.rb

@@ -0,0 +1,4 @@
+module JekyllBlocker
+  BlockerError    = Class.new(::StandardError)
+  ValidationError = Class.new(::StandardError)
+end

data/lib/jekyll-blocker/hooks.rb

@@ -0,0 +1,39 @@
+module JekyllBlocker
+  Jekyll::Hooks.register :site, :pre_render do |site, payload|
+    # set blocks in config
+    site.config["blocks"] = BlockCollection.new(site.source)
+
+    # set site globals
+    site.config["globals"] = {}
+    global_path = File.join(site.source, "_globals.yml")
+    if File.exist? global_path
+      globals = YAML.safe_load(File.read(global_path))
+      site.config["globals"] = globals.map{|k, v| [k, v["value"]]}.to_h
+    end
+
+    # set layout globals
+    site.layouts.each do |_, layout|
+      layout.data["globals"] = if layout.data["globals"]
+                                 layout.data["globals"].
+                                   map{|k, v| [k, v["value"]]}.
+                                   to_h
+                               else
+                                 {}
+                               end
+    end
+  end
+  Jekyll::Hooks.register :pages, :pre_render do |page, payload|
+    # set globals merged data, site and layout
+    payload["globals"] = page.site.config["globals"]
+
+    layout = page.site.layouts[page["layout"]]
+    if layout
+      payload["globals"].merge!(layout.data["globals"])
+    end
+  end
+  Jekyll::Hooks.register :posts, :pre_render do |post, payload|
+    # set globals merged data, site and layout
+    layout = post.site.layouts[post["layout"]]
+    payload["globals"] = post.site.config["globals"].merge(layout.data["globals"])
+  end
+end

data/lib/jekyll-blocker/page.rb

@@ -0,0 +1,12 @@
+module JekyllBlocker
+  class Page
+    attr_accessor :title, :description, :layout
+
+    def initialize(params)
+    end
+
+    def save
+    end
+  end
+end
+

data/lib/jekyll-blocker/page_collection.rb

@@ -0,0 +1,23 @@
+module JekyllBlocker
+  class PageCollection
+    attr_reader :pages
+
+    def initialize(path)
+      paths = Dir[File.join(path, "**", "*.{liquid,html}")].reject do |file|
+        file =~ /\A#{File.join(path, '_')}/
+      end
+
+      paths.each do |path|
+        key = file.sub(/\A#{path}/, '')
+        file = Utilities.read_jekyll_file(path)
+        @pages[key] = Page.new
+      end
+
+    end
+
+    def find(id)
+      @pages[id.to_s]
+    end
+  end
+end
+

data/lib/jekyll-blocker/tags/block_container_tag.rb

@@ -0,0 +1,33 @@
+module JekyllBlocker
+  class BlockContainerTag < Liquid::Block
+    def initialize(tag_name, params, parse_context)
+      super
+      parts = params.to_s.strip.split.compact
+      if parts.count == 1
+        @name = parts.first
+      else
+        msg = "block_container tag expects 1 argument, #{parts.count} given"
+        raise Liquid::SyntaxError, msg
+      end
+    end
+
+    def render(context)
+      blocks           = context.registers[:site].config["blocks"]
+      block_containers = context.registers[:page]["block_containers"] || {}
+      block_container = block_containers[@name] ||
+                        super.split.map do |block|
+                          { "type" => block, "fields" => {} }
+                        end
+
+
+      out = ""
+      block_container.each do |block|
+        out << blocks.find(block["type"]).render(block["fields"], context)
+      end
+      out
+    end
+  end
+end
+
+Liquid::Template.register_tag('block_container', JekyllBlocker::BlockContainerTag)
+

data/lib/jekyll-blocker/tags/block_tag.rb

@@ -0,0 +1,30 @@
+module JekyllBlocker
+  class BlockTag < Liquid::Tag
+    def initialize(tag_name, params, parse_context)
+      super
+      parts = params.to_s.strip.split.compact
+
+      if parts.count == 1
+        @name = @id = parts.first.strip
+      elsif parts.count == 2
+        @name = parts.first
+        @id = parts.last
+      else
+        raise Liquid::SyntaxError, "block tag expects 1..2 arguments, #{parts.count} given"
+      end
+    end
+
+    def render(context)
+      blocks = context.registers[:site].config["blocks"]
+      page_blocks = context.registers[:page]["blocks"] || {}
+      block  = page_blocks[@id] || { "type" => @name, "fields" => {} }
+
+      raise BlockerError unless @name == block["type"]
+
+      blocks.find(@name).render(block["fields"], context)
+    end
+  end
+end
+
+Liquid::Template.register_tag('block', JekyllBlocker::BlockTag)
+

data/lib/jekyll-blocker/tags/menu_tag.rb

@@ -0,0 +1,100 @@
+module JekyllBlocker
+  class MenuTag < Liquid::Tag
+    def initialize(tag_name, params, parse_context)
+      super
+      parts = params.to_s.strip.split.compact
+
+      if parts.count == 2
+        @name  = parts.first.strip
+        @style = parts.last.strip
+      else
+        raise Liquid::SyntaxError, "menu tag expects 2 arguments, #{parts.count} given"
+      end
+    end
+
+    def render(context)
+      @context = context
+      @style   = parse_param(@style)
+      menu     = build_menu(load_menu(@name))
+
+      if style_wrapper
+        menu = render_part(style_wrapper, { "content" => menu })
+      end
+
+      menu
+    end
+
+    private
+
+    def render_part(content, params)
+      _context = Liquid::Context.new(@context.environments.dup, {}, @context.registers)
+      params.each {|key, value| _context[key] = value}
+      template = Liquid::Template.parse(content)
+      template.render(_context)
+    end
+
+    def build_menu(menu)
+      out = ""
+      menu.each do |item|
+        url = case item["type"]
+              when "page"
+                pages = @context.registers[:site].pages
+                pages.find{|page| page["id"] == item["value"]}&.url.to_s
+              when "text"
+                item["value"]
+              when "placeholder"
+                nil
+              end
+        data = {
+          "classes" => item["classes"].to_s,
+          "url" => url,
+          "text" => item["text"].to_s
+        }
+        if item["children"].instance_of?(Array) && item["children"].any?
+          data["children"] = build_menu(item["children"])
+        end
+
+        out << render_part(style_item, data)
+      end
+      out
+    end
+
+    def parse_param(name)
+      if (name[0] == '"' && name[-1] == '"') ||
+         (name[0] == "'" && name[-1] == "'")
+        name[1..-2]
+      else
+        part = @context
+        name.split(".").each do |value|
+          part = part[value]
+        end
+        part.to_s
+      end
+    end
+
+    def style_wrapper
+      @style_wrapper ||= get_style_part("wrapper", true)
+    end
+
+    def style_item
+      @style_item ||= get_style_part("item")
+    end
+
+    def get_style_part(part, optional=false)
+      file_path = File.join("_blocker", "menu_styles", @style, "#{part}.liquid")
+
+      return if optional && !File.exist?(file_path)
+
+      File.read(file_path)
+    end
+
+    def load_menu(param)
+      name = parse_param(param)
+      file_path = File.join("_blocker", "menus", "#{name}.yml")
+      YAML.safe_load(File.read(file_path))
+    end
+  end
+end
+
+Liquid::Template.register_tag('menu', JekyllBlocker::MenuTag)
+

data/lib/jekyll-blocker/utilities.rb

@@ -0,0 +1,17 @@
+module JekyllBlocker
+  class Utilities
+    class << self
+      def read_jekyll_file(path)
+        out = { data: {}, content: File.read(path) }
+
+        if out[:content] =~ Jekyll::Document::YAML_FRONT_MATTER_REGEXP
+          out[:content] = Regexp.last_match.post_match
+          out[:data] = YAML.safe_load(Regexp.last_match(1))
+        end
+
+        out
+      end
+    end
+  end
+end
+

data/lib/jekyll-blocker/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module JekyllBlocker
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end
 

data/lib/jekyll-blocker.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
-require_relative "jekyll-blocker/version"
+# require "debug"
 
-module JekyllBlocker
-  class Error < StandardError; end
+%w(yaml uri fileutils jekyll securerandom pastel).each do |lib|
+  require lib
 end
 
+Dir[File.join(__dir__, "jekyll-blocker", "**", "*")].
+  select { |path| File.file?(path) }.
+  each { |lib| require lib }
+

data/lib/new_site/.gitignore

@@ -0,0 +1,5 @@
+_site
+.sass-cache
+.jekyll-cache
+.jekyll-metadata
+vendor

data/lib/new_site/Gemfile

@@ -0,0 +1,32 @@
+source "https://rubygems.org"
+# Hello! This is where you manage which Jekyll version is used to run.
+# When you want to use a different version, change it below, save the
+# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
+#
+#     bundle exec jekyll serve
+#
+# For Vagrant
+#     bundle exec jekyll serve -H 0.0.0.0
+#
+# This will help ensure the proper Jekyll version is running.
+# Happy Jekylling!
+gem "jekyll", "~> 4.3.2"
+
+# If you have any plugins, put them here!
+group :jekyll_plugins do
+  gem "jekyll-blocker"
+end
+
+# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
+# and associated library.
+platforms :mingw, :x64_mingw, :mswin, :jruby do
+  gem "tzinfo", ">= 1", "< 3"
+  gem "tzinfo-data"
+end
+
+# Performance-booster for watching directories on Windows
+gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
+
+# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
+# do not have a Java counterpart.
+gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]

data/lib/new_site/_blocker/blocks/example.liquid

@@ -0,0 +1,15 @@
+---
+text:
+  type: text
+  value: >-
+    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus id sapien
+    dolor. Mauris ut ante a eros euismod cursus a nec orci. Vivamus in nisl
+    rutrum, auctor urna nec, imperdiet mauris. Nunc dignissim augue blandit
+    bibendum vulputate. Nullam semper nisl sit amet tellus volutpat, nec porta
+    erat finibus. Cras lobortis, sapien ut mollis viverra, turpis orci luctus
+    erat, sed faucibus odio dolor non mi. Donec sed lorem feugiat, porta nunc
+    ac, ornare quam. Pellentesque in risus orci. Proin sit amet rhoncus eros,
+    et interdum ligula.
+---
+<p>{{ text }}</p>
+

data/lib/new_site/_blocker/blocks/header.liquid

@@ -0,0 +1,17 @@
+---
+title:
+  type: text
+  value: default h1
+subtitle:
+  type: text
+  value: >-
+    Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+    Vivamus id sapien dolor.
+    Mauris ut ante a eros euismod cursus a nec orci.
+---
+<section class="hero">
+  <div class="hero-body">
+    <h1 class="title">{{ title }}</h1>
+    <h2 class="subtitle">{{ subtitle }}</h2>
+  </div>
+</section>

data/lib/new_site/_blocker/menu_styles/full/item.liquid

@@ -0,0 +1,19 @@
+{% if children %}
+<div class="navbar-item has-dropdown is-hoverable">
+  <a class="navbar-link {{classes}} {% if page.url == url %}is-active{% endif %}" {% if url %}href="{{url}}"{% endif %}>
+    {{text}}
+  </a>
+
+  <div class="navbar-dropdown">
+    {{children}}
+  </div>
+</div>
+{% else %}
+<a
+  class="navbar-item {{classes}} {% if page.url == url %}is-active{% endif %}"
+  href="{{url}}"
+>
+  {{text}}
+</a>
+{% endif %}
+

data/lib/new_site/_blocker/menu_styles/full/wrapper.liquid

@@ -0,0 +1,19 @@
+<nav class="navbar is-dark" role="navigation" aria-label="main navigation">
+  <div class="navbar-brand">
+    <a class="navbar-item" href="/">
+      <img src="/images/logo.svg" width="112" height="28">
+    </a>
+
+    <a role="button" class="navbar-burger" aria-label="menu" aria-expanded="false" data-target="navbarMenu">
+      <span aria-hidden="true"></span>
+      <span aria-hidden="true"></span>
+      <span aria-hidden="true"></span>
+    </a>
+  </div>
+
+  <div id="navbarMenu" class="navbar-menu">
+    <div class="navbar-start">
+      {{content}}
+    </div>
+  </div>
+</nav>

data/lib/new_site/_blocker/menus/main.yml

@@ -0,0 +1,6 @@
+- text: Home
+  type: page
+  value: home
+- text: A Post
+  type: text
+  value: /jekyll/update/2023/02/03/welcome-to-jekyll.html

data/lib/new_site/_config.yml

@@ -0,0 +1,53 @@
+# Welcome to Jekyll!
+#
+# This config file is meant for settings that affect your whole blog, values
+# which you are expected to set up once and rarely edit after that. If you find
+# yourself editing this file very often, consider using Jekyll's data files
+# feature for the data you need to update frequently.
+#
+# For technical reasons, this file is *NOT* reloaded automatically when you use
+# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
+#
+# If you need help with YAML syntax, here are some quick references for you:
+# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
+# https://learnxinyminutes.com/docs/yaml/
+#
+# Site settings
+# These are used to personalize your new site. If you look in the HTML files,
+# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
+# You can create any custom variable you would like, and they will be accessible
+# in the templates via {{ site.myvariable }}.
+
+title: Your awesome title
+description: >- # this means to ignore newlines until "baseurl:"
+  Write an awesome description for your new site here. You can edit this
+  line in _config.yml. It will appear in your document head meta (for
+  Google search results) and in your feed.xml site description.
+baseurl: "" # the subpath of your site, e.g. /blog
+url: "" # the base hostname & protocol for your site, e.g. http://example.com
+
+# Build settings
+plugins:
+  - jekyll-blocker
+
+sass:
+  style: compressed
+# Exclude from processing.
+# The following items will not be processed, by default.
+# Any item listed under the `exclude:` key here will be automatically added to
+# the internal "default list".
+#
+# Excluded items can be processed by explicitly listing the directories or
+# their entries' file path in the `include:` list.
+#
+# exclude:
+#   - .sass-cache/
+#   - .jekyll-cache/
+#   - gemfiles/
+#   - Gemfile
+#   - Gemfile.lock
+#   - node_modules/
+#   - vendor/bundle/
+#   - vendor/cache/
+#   - vendor/gems/
+#   - vendor/ruby/

data/lib/new_site/_globals.yml

@@ -0,0 +1,8 @@
+site_name:
+  label: Site Name
+  type: text
+  value: Blocker
+main_menu:
+  label: Main Menu
+  type: menu
+  value: main

data/lib/new_site/_includes/footer.liquid

@@ -0,0 +1,8 @@
+<footer class="footer">
+  <div class="content has-text-centered">
+    <p>
+      © {{ globals.site_name }} {{ 'now' | date: "%Y" }}
+    </p>
+  </div>
+</footer>
+