jekyll-spaceship 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8df3e5c04610d7f6ae766303a8b884e1b3bd0047f72ac489275dd26d133d392a
-  data.tar.gz: '0728453eaace46c6d88aa0395f1d17ae88c17a727aa3be9b10236c222fc3d85e'
+  metadata.gz: 38113b9fb933fde7dbf9a201839d3529f22e27687baa2c8e5768097b47eb7eef
+  data.tar.gz: acb2c8d069864444b6d15ad235c13322e9a817ebbab83e8eab9058060979c256
 SHA512:
-  metadata.gz: 1b5e65d14b80d87ebb06b9e3c5cc7c71f6d654940d58034ab314d232d5ff6614bd3b22649259d3658690b5e94b5c4e6983214a0b3e4bdd91cd03e7702901a51e
-  data.tar.gz: f7a171a023c65ceb729ade833fe7193b05000aa24483c1bd0bc6201c28df47f69d503aa2612a866aba1627fc86626f63d38b7db41b8d75a616805b14f1d71fff
+  metadata.gz: 1ae51763f919f940079fe169d7c05889a234f69a42d9369cce5858670605a3b6bb88839162d4ce95ce8cc07d8cd035228069f1bc4e189bad3ca41ee13623cc85
+  data.tar.gz: 2f5dda310b60fd8d69460299a81844aa791fd0877e7cf8d9d58556f4a8e780996aef7512924fe5786080379dc5be5a33d8f67c55de65fa7c0a2c2070283ce2f4

data/README.md

@@ -115,6 +115,7 @@ Spaceship is a minimalistic, powerful and extremely customizable [Jekyll](https:
     - [6.1 Escape Ordered List](#escape-ordered-list)
   - [7. Emoji Usage](#7-emoji-usage)
     - [7.1 Emoji Customizing](#71-emoji-customizing)
+  - [8. Modifying Element Usage](#8-modifying-element-usage)
 - [Credits](#credits)
 - [Contributing](#contributing)
 - [License](#license)
@@ -154,6 +155,7 @@ jekyll-spaceship:
     - polyfill-processor
     - video-processor
     - emoji-processor
+    - element-processor
   mathjax-processor:
     src:  //cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML
     config:
@@ -755,6 +757,51 @@ jekyll-spaceship:
 
 See the [Gemoji](https://github.com/github/gemoji) documentation for generating image files.
 
+### 8. Modifying Element Usage
+
+It allows us to modify elements via `CSS3 selectors`. Through it you can easily
+modify the attributes of a element tag, replace the child nodes and so on, it's 
+very flexible, but here is example usage for modifying a document:
+
+```yml
+# Here is a comprehensive example
+jekyll-spaceship:
+  element-processor:
+    css:
+      - a: '<h1>Test</h1>'                     # Replace all `a` tags (String Style)
+      - ['a.link1', 'a.link2']:                # Replace all `a.link1`, `a.link2` tags (Hash Style)
+          name: img                            # Replace element tag name
+          props:                               # Replace element properties
+            title: Good image                  # Add a title attribute
+            src: ['(^.*$)', '\0?a=123']        # Add query string to src attribute by regex pattern
+            style:                             # Add style attribute (String Style)
+              color: red
+              font-size: '1.2em'
+          children:                            # Add children to the element
+            -                                  # First empty for adding after the last child node
+            - "<span>Google</span>"            # First child node (String Style)
+            -                                  # Middle empty for wrapping the children nodes
+            - name: span                       # Second child node (Hash Style)
+              props:
+                prop1: "1"                     # Custom property1
+                prop2: "2"                     # Custom property2
+                prop3: "3"                     # Custom property3
+              children:                        # Add nested chidren nodes
+                - "<span>Jekyll</span>"        # First child node (String Style)
+                - name: span                   # Second child node (Hash Style)
+                  props:                       # Modify child node (Hash Style)
+                    prop1: "a"
+                    prop2: "b"
+                    prop3: "c"
+                  children: "<b>Yap!</b>"      # Add children nodes (String Style)
+            -                                  # Last empty for adding before the first child node
+      - a.link: '<a href="//t.com">Link</a>'   # Replace all `a.link` tags (String Style)
+      - h1#title:                              # Replace `h1#title` tags (Hash Style)
+          children: I'm a title!               # Replace inner html to new text
+            
+```
+
+
 
 ## Credits
 

data/lib/jekyll-spaceship/cores/config.rb

@@ -12,7 +12,8 @@ module Jekyll::Spaceship
         'plantuml-processor',
         'polyfill-processor',
         'video-processor',
-        'emoji-processor'
+        'emoji-processor',
+        'element-processor'
       ]
     }
 
@@ -34,7 +35,7 @@ module Jekyll::Spaceship
     def self.store(section, default)
       return if @@store[section].nil?
       return @@store[section] if default.nil?
-      @@store[section] = deep_merge(@@store[section], default)
+      @@store[section] = deep_merge(default, @@store[section])
     end
 
     def self.load(filename = '_config.yml')

data/lib/jekyll-spaceship/processors/element-processor.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+require 'nokogiri'
+
+module Jekyll::Spaceship
+  class ElementProcessor < Processor
+    priority :lowest
+
+    def self.config
+      { 'css' => [] }
+    end
+
+    def on_handle_html(content)
+      return content if config['css'].size.zero?
+
+      # use nokogiri to parse html content
+      doc = Nokogiri::HTML(content)
+
+      # handle each css pattern
+      config['css'].each do |data|
+        data.each do |key, val|
+          key = [key] if key.kind_of? String
+          key.each do |pattern|
+            nodes = doc.css(pattern)
+            nodes.each do |element|
+              handle_css_pattern({
+                :doc => doc,
+                :element => element,
+                :data => val
+              })
+            end
+            self.handled = true
+          end
+        end
+      end
+
+      doc.to_html
+    end
+
+    def handle_css_pattern(data)
+      doc = data[:doc]
+      element = data[:element]
+      data = data[:data]
+
+      if data.kind_of? String
+        element.replace Nokogiri::HTML.fragment(data)
+      elsif data.kind_of? Hash
+        # set name
+        element.name = data['name'] unless data['name'].nil?
+
+        # set props
+        data['props']&.each do |prop, val|
+          next element.remove_attribute if val.nil?
+          if val.kind_of? Array
+            next if val.size != 2
+            v = element[prop]
+            v = '' if v.nil?
+            val = v.sub(/#{val[0]}/, val[1])
+          elsif val.kind_of? Hash
+            result = []
+            val.each { |k, v| result.push "#{k}: #{v}" }
+            val = result.join(";")
+          end
+          element.set_attribute(prop, val)
+        end
+
+        # processing children
+        return unless data.has_key?('children')
+        return element.inner_html = "" if data['children'].nil?
+        children = self.create_children({
+          :doc => doc,
+          :data => data['children']
+        })
+
+        # replace whole inner html
+        unless data['children'].kind_of? Array
+          return element.inner_html = children
+        end
+
+        if element.children.size.zero?
+          return element.inner_html = children
+        end
+
+        index = data['children'].index(nil)
+        if index.nil?
+          return element.inner_html = children
+        end
+
+        # insert to the end of children
+        if index == 0
+          return element.children.last.after(children)
+        end
+
+        # insert to the begin of children
+        rindex = data['children'].rindex { |item| !item.nil? }
+        if index == rindex + 1
+          return element.children.first.before children
+        end
+
+        # wrap the children
+        element.children.first.before children[0..index]
+        element.children.last.after children[index..children.size]
+      end
+    end
+
+    def create_children(data)
+      doc = data[:doc]
+      data = data[:data]
+      root = Nokogiri::HTML.fragment("")
+
+      data = [data] unless data.kind_of? Array
+      data.each do |child_data|
+        node = self.create_element({
+          :doc => doc,
+          :data => child_data
+        })
+        next if node.nil?
+        unless child_data['children'].nil?
+          node.children = self.create_children({
+            :doc => doc,
+            :data => child_data['children']
+          })
+        end
+        root.add_child node
+      end
+      root.children
+    end
+
+    def create_element(data)
+      doc = data[:doc]
+      data = data[:data]
+
+      return if data.nil?
+      return Nokogiri::HTML.fragment(data) if data.kind_of? String
+      return if data['name'].nil?
+
+      # create node
+      node = doc.create_element(data['name'])
+
+      # set props
+      data['props']&.each do |prop, val|
+        if val.kind_of? Hash
+          result = []
+          val.each { |k, v| result.push "#{k}: #{v}" }
+          val = result.join(";")
+        end
+        node.set_attribute(prop, val)
+      end
+      node
+    end
+  end
+end

data/lib/jekyll-spaceship/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Spaceship
-    VERSION = "0.6.3"
+    VERSION = "0.7.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-spaceship
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - jeffreytse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-13 00:00:00.000000000 Z
+date: 2020-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -137,6 +137,7 @@ files:
 - lib/jekyll-spaceship/cores/processor.rb
 - lib/jekyll-spaceship/cores/register.rb
 - lib/jekyll-spaceship/cores/type.rb
+- lib/jekyll-spaceship/processors/element-processor.rb
 - lib/jekyll-spaceship/processors/emoji-processor.rb
 - lib/jekyll-spaceship/processors/mathjax-processor.rb
 - lib/jekyll-spaceship/processors/plantuml-processor.rb