hyde-page-js 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad8c15a48cdb354d8445e0cc30b9d4ba2544b6afb510cd79426a42a76a8d883c
-  data.tar.gz: b367b416ff3bf8925cfe2c0eeec958111a0144a306aeab1fd030cbb330759bf1
+  metadata.gz: 17a523c022d3eb4883130d9b143285e028f4f83fcfe3011f614ab0ec25a05aef
+  data.tar.gz: b9b674f5042f528004838ab8e73a6f8840e70ae0bdb675f7991de420d715ff6f
 SHA512:
-  metadata.gz: ec5049e2ab3676ecbe9b1b606a3eaf1806aeac25d8543671219a6eb7c422b5e12fdfa732d11e730efd7e31c0afa09c396c1e04bd6c0e06f485961ced4c78ca19
-  data.tar.gz: fca64106f4a05093fc2fc3d0787b4ec115beab21482c7d4e4a4898e1a6393f78224d3b785599794eb823969f6f028978728bcee24569adeb153bede1929d564d
+  metadata.gz: 2e5799de5113ea965a1d638bf7a69eba7946fc7133d5f5d8cf4d37a13090902d7b97a703f226c749c2c44f3bb78f578cc1a514c8e11d31ceecf2dabc08bd041f
+  data.tar.gz: 203b8c566d58cebc526c8627425d6638b722003a4022b3af4d91126f64eba90696d289e808d3913fd7212f5fdb9e4c285a20131b2b313cb5166e8d2b12b4b7a1

data/lib/hyde-page-js.rb

@@ -1,11 +1,212 @@
+require 'terser'
+require 'digest'
+require 'jekyll'
+
+Jekyll::Hooks.register :pages, :pre_render do |page, payload|
+  Hyde::Page::Js.new(page).run
+end
+
 module Hyde
   module Page
     class Js
-      VERSION = "0.1.0"
+      VERSION = "0.3.0"
+    end
+
+    class GeneratedJsFile < Jekyll::StaticFile
+      attr_accessor :file_contents
+      attr_reader :generator
+
+      def initialize(site, dir, name)
+        @site = site
+        @dir = dir
+        @name = name
+        @relative_path = File.join(*[@dir, @name].compact)
+        @extname = File.extname(@name)
+        @type = @collection&.label&.to_sym
+        @generator = "hyde-page-js"
+      end
+
+      def write(dest)
+        dest_path = destination(dest)
+        return false if File.exist?(dest_path)
+
+        FileUtils.mkdir_p(File.dirname(dest_path))
+        FileUtils.rm(dest_path) if File.exist?(dest_path)
+
+        File.open(dest_path, "w") do |output_file|
+          output_file << file_contents
+        end
+
+        true
+      end
+    end
+
+    class Js
+      @@config = {
+        "source" => "assets/js",
+        "destination" => "assets/js",
+        "minify" => true,
+        "enable" => true,
+        "keep_files" => true,
+        "dev_mode" => false
+      }
+
+      def initialize(page)
+        @page = page
+        @site = page.site
+        @config = fetch_config
+        @site.data['_hyde_pages_cache'] ||= {}
+
+        if keep_files? && !dev_mode?
+          @site.config.fetch("keep_files").push(destination)
+        end
+      end
+
+      def run
+        js = fetch_js(@page)
+        layout = fetch_layout(fetch_layout_name(@page))
+        results = parent_layout_js(layout, js).reverse
+        return if results.empty?
+
+        lookup_name = names_to_key(results)
+        return unless @site.data['_hyde_pages_cache'].fetch(lookup_name, nil).nil?
+
+        data = concatenate_files(results)
+        return if data == ""
+
+        data = minify(data)
+        return if data == ""
+
+        generated_file = generate_file(results, data)
+
+        # file already exists, so skip writing out the data to disk
+        return unless @site.static_files.find { |static_file| static_file.name == generated_file.name }.nil?
+
+        # place file data into the new file
+        generated_file.file_contents = data
+
+        # assign static file to list for jekyll to render
+        @site.static_files << generated_file
+
+        # assign to site.data.js_files for liquid output
+        add_to_urls(generated_file.url)
+
+        # add to cache
+        @site.data['_hyde_pages_cache'][lookup_name] = data
+      end
+
+      private
+
+      def names_to_key(names)
+        names.join('-')
+      end
+
+      def add_to_urls(url)
+        @site.data['js_files'] ||= []
+        @site.data['js_files'].push(url)
+      end
+
+      def fetch_config
+        @@config.merge(@site.config.fetch("hyde_page_js", {}))
+      end
+
+      def keep_files?
+        @config.fetch("keep_files") == true
+      end
+
+      def dev_mode?
+        @config.fetch("dev_mode") == true
+      end
+
+      def minify?
+        @config.fetch("minify") == true
+      end
+
+      def destination
+        @config.fetch("destination")
+      end
+
+      def source
+        @config.fetch("source")
+      end
+
+      def qualified_source
+        File.join(*[@site.source, source].compact)
+      end
+
+      def fetch_layout_name(obj_with_data, default = nil)
+        obj_with_data.data.fetch('layout', default)
+      end
+
+      def fetch_js(obj_with_data, default = [])
+        obj_with_data.data.fetch('js', []).reverse
+      end
+
+      def fetch_layout(layout_name, default = nil)
+        @site.layouts.fetch(layout_name, default)
+      end
+
+      def mangle?
+        if dev_mode?
+          false
+        elsif minify?
+          true
+        end
+      end
+
+      def parent_layout_js(layout, js)
+        if layout.nil?
+          return js.uniq.compact
+        end
+
+        layout_name = fetch_layout_name(layout)
+        parent_layout = fetch_layout(layout_name)
+        js = js.concat(fetch_js(layout))
+
+        parent_layout_js(parent_layout, js)
+      end
+
+      def concatenate_files(files, data = [])
+        files.each do |file_name|
+          # tmp page required to handle anything with frontmatter/yaml header
+          tmp_page = Jekyll::PageWithoutAFile.new(@site, nil, source, file_name)
+          path = File.join([qualified_source, file_name])
+
+          begin
+            tmp_page.content = File.read(path)
+            data.push(Jekyll::Renderer.new(@site, tmp_page).run)
+          rescue
+            Jekyll.logger.warn("Page JS Warning:", "Unable to find #{path}")
+          end
+        end
+
+        data.join("\n")
+      end
+
+      def minify(data)
+        return data unless minify?
+
+        converter_config = {mangle: mangle?, output: {comments: :copyright}}
+        js_converter = Terser.new(converter_config)
+        js_converter.compile(data)
+      end
+
+      def generate_file(files, data)
+        file_name = generate_file_name(files, data)
+        Hyde::Page::GeneratedJsFile.new(@site, source, file_name)
+      end
+
+      def generate_file_name(files, data, prefix: nil)
+        file_names = [prefix]
+
+        if dev_mode?
+          files.each { |file| file_names.push(file.gsub(".js", "")) }
+        end
+
+        file_names.push(Digest::MD5.hexdigest(data)[0, 6])
+
+        file_names.compact.join("-") + ".js"
+      end
     end
   end
 end
-
-# require_relative "hyde/renderer.rb"
-# require_relative "hyde/page/css.rb"
-# require_relative "hyde/page/generated_page_css_file.rb"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hyde-page-js
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Gregory Daynes
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-25 00:00:00.000000000 Z
+date: 2023-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -37,7 +37,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -52,9 +52,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/hyde-page-js.rb
-- lib/hyde/page/css.rb
-- lib/hyde/page/generated_page_css_file.rb
-- lib/hyde/renderer.rb
 homepage: https://github.com/gregdaynes/hyde-page-js
 licenses:
 - MIT
@@ -74,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Plugin for jekyll to enable per page js files

data/lib/hyde/page/css.rb

@@ -1,131 +0,0 @@
-require 'jekyll'
-require_relative "generated_page_css_file"
-
-module Hyde
-  module Page
-    class Css
-      @@config = {
-        "asset_path" => "assets/css",
-        "file_output_path" => "assets/css",
-        "css_minify" => true,
-        "enable" => true,
-        "keep_files" => true,
-        "dev_mode" => false
-      }
-
-      def initialize(layout, info)
-        @site = info[:registers][:site]
-        @page = info[:registers][:page]
-        @data = layout.data
-        @config = @@config.merge(@site.config.dig("hyde_page_css") || {})
-
-        @qualified_asset_path = File.join(*[@site.source, @config["asset_path"]].compact)
-
-        if config("keep_files") == true && config("dev_mode") == false
-          @site.config["keep_files"].push(config("file_output_path"))
-        end
-
-        @page["css"] = if @page["css"].nil?
-          []
-        else
-          [@page["css"]]
-        end
-      end
-
-      def generate
-        return unless config("enable") == true
-        @page["css"].unshift(@data["css"])
-
-        file_groups = flatten_group(@page["css"])
-
-        css_files = []
-
-        for files in file_groups do
-          break if !files&.length
-
-          data = concatenate_files(files.compact)
-          data = minify(data)
-          next if data == ""
-
-          file = generate_file(files, data)
-          css_files << file.url
-
-          # file already exists, so skip writing out the data to disk
-          next if @site.static_files.find { |x| x.name == file.name }
-
-          # place file data into the new file
-          file.file_contents = data
-
-          # assign static file to list for jekyll to render
-          @site.static_files << file
-        end
-
-        # the recursive nature of this will sometimes have duplicate css files
-        @page["css_files"] = css_files.uniq
-      end
-
-      private
-
-      def config(*)
-        @config.dig(*)
-      end
-
-      def flatten_group(arr, acc = [])
-        return [arr] if !arr.last.is_a?(Array)
-
-        acc += [arr.first]
-        acc += flatten_group(arr.last)
-      end
-
-      def concatenate_files(files, data = "")
-        for file in files do
-          # tmp page required to handle anything with frontmatter/yaml header
-          tmp_page = Jekyll::PageWithoutAFile.new(@site, nil, config("asset_path"), file)
-          path = File.join([@qualified_asset_path, file])
-
-          begin
-            file_contents = File.read(path)
-            tmp_page.content = file_contents
-            # original jekyll renderer, not our modified version
-            data << Jekyll::Renderer.new(@site, tmp_page).run
-          rescue
-            Jekyll.logger.warn("Page CSS Warning:", "Unable to find #{path}")
-          end
-        end
-
-        data
-      end
-
-      def minify(data)
-        style = if config("dev_mode") == true
-          "expanded"
-        elsif config("css_minify") == false
-          "expanded"
-        else
-          "compressed"
-        end
-
-        converter_config = {"sass" => {"style" => style}}
-        Jekyll::Converters::Scss.new(converter_config).convert(data)
-      end
-
-      def generate_file(files, data)
-        file_name = generate_file_name(files, data)
-
-        Hyde::Page::GeneratedPageCssFile.new(@site, config("asset_path"), file_name)
-      end
-
-      def generate_file_name(files, data, prefix: nil)
-        file_names = [prefix]
-
-        if config("dev_mode")
-          files.each { |file| file_names.push(file.gsub(".css", "")) }
-        end
-
-        file_names.push(Digest::MD5.hexdigest(data)[0, 6])
-
-        file_names.compact.join("-") + ".css"
-      end
-    end
-  end
-end

data/lib/hyde/page/generated_page_css_file.rb

@@ -1,35 +0,0 @@
-module Hyde
-  module Page
-    # Alternative class for jekyll's static files
-    # this allows the creation of files without a source file
-
-    class GeneratedPageCssFile < Jekyll::StaticFile
-      attr_accessor :file_contents
-      attr_reader :generator
-
-      def initialize(site, dir, name)
-        @site = site
-        @dir = dir
-        @name = name
-        @relative_path = File.join(*[@dir, @name].compact)
-        @extname = File.extname(@name)
-        @type = @collection&.label&.to_sym
-        @generator = "hyde-page-css"
-      end
-
-      def write(dest)
-        dest_path = destination(dest)
-        return false if File.exist?(dest_path)
-
-        FileUtils.mkdir_p(File.dirname(dest_path))
-        FileUtils.rm(dest_path) if File.exist?(dest_path)
-
-        File.open(dest_path, "w") do |output_file|
-          output_file << file_contents
-        end
-
-        true
-      end
-    end
-  end
-end

data/lib/hyde/renderer.rb

@@ -1,18 +0,0 @@
-module Jekyll
-  class Renderer
-    def render_layout(output, layout, info)
-      Hyde::Page::Css.new(layout, info).generate
-
-      # TODO Would be nice to call super here instead of cloned logic from Jekyll internals
-      payload["content"] = output
-      payload["layout"] = Utils.deep_merge_hashes(layout.data, payload["layout"] || {})
-
-      render_liquid(
-        layout.content,
-        payload,
-        info,
-        layout.path
-      )
-    end
-  end
-end