jekyll-bookshop 2.0.0.pre.alpha.12 → 2.0.0.pre.alpha.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d0e9021962d6d2d9eef26d3151037110b8438ce7ef83736631cbc05f87c29d0
-  data.tar.gz: a9c525e23e1dc61a008d86755d5216e91ebbcbf64dd1331297f7ef103d3fa731
+  metadata.gz: 78a649cb45837353193db2e946291f5ad53e42eb315848f8e7668311af853d79
+  data.tar.gz: ed7e3c420e86b4c3185d59f033aeea4e1bf9b95c77fa71f7968b815992403ae0
 SHA512:
-  metadata.gz: f678a6095815f900eeff2a8810f64dfe45d10eaf03884aba0aff9d9b164cd9712029a9f0f1649b97327df5a217dc4b54548eb56b3efe5c79a4efc1b7870be006
-  data.tar.gz: dfdf1bdadfb87ad5989707ee70aaed180937defcf87c50dffbef5156f9f82fdc52ee9646e6cdc2ed627fb6778e1d7f7df561c9bd5a5cabe4643d95ca757b8a20
+  metadata.gz: 217ff3475ee4a99f5a6fae5d14c515c2a3cf9460115d72ea03325ff7391335a8158fb3ac2dd1bbae5b99332bc7c1742aeb401508378cdb12e0346e625b14e5ee
+  data.tar.gz: 5113aff8f35680efdf3d0cfe843e9faab8200535c83a5c024bb5516792a73284af77ca0980f514d26b2f6f718c91e93541778b84c1eff0ba58380b137c934ebc

data/lib/jekyll-bookshop.rb

@@ -2,204 +2,16 @@ require "jekyll"
 require "pathname"
 require "dry/inflector"
 
-module JekyllBookshop
-  class Tag < Jekyll::Tags::IncludeTag
+require_relative "jekyll-bookshop/tags/bookshop-tag"
+require_relative "jekyll-bookshop/tags/style-tag"
+require_relative "jekyll-bookshop/tags/site-data-tag"
+require_relative "jekyll-bookshop/init-styles"
+require_relative "jekyll-bookshop/filters"
 
-    # Look for includes in the built bookshop directory
-    def tag_includes_dirs(context)
-      context['site']['bookshop_component_locations'].freeze
-    end
-
-    def expand_param_templates(params, context, parent_param)
-      param_hash = {}
-      new_params = {}
-      
-      is_template = params.key?("__template") || params.key?("__template_code")
-      template = params["__template"] || params["__template_code"] || ""
-      return Liquid::Template.parse(template).render(context) if is_template
-
-      array_template = params["__array_template"] || ""
-      if params.key? "__array_template"
-          # We're adding a new root scope here and then removing it.
-          # Who knows why, but assign and capture always add to the root scope.
-          # Which is why this is hacked in, instead of using context.stack 🤷‍♂️
-          context.scopes.push({})
-          Liquid::Template.parse(array_template).render(context)
-          template_scope = context.scopes.pop()
-          template_array = template_scope[parent_param] || "";
-          unless template_array.is_a? Array
-            Jekyll.logger.warn "Bookshop:",
-                                  "#{array_template} did not evaluate to an array
-                                   as required for key #{parent_param}.__array_template"
-            template_array = []
-          end
-
-          params.delete("__array_template")
-          output_array = []
-          template_array.each do |item|
-            inflector = Dry::Inflector.new
-            singular_parent = inflector.singularize(parent_param)
-            next_scope = {}
-            next_scope[singular_parent] = item
-
-            context.push(next_scope)
-            output_array.push(expand_param_templates(params, context, ""))
-            context.pop()
-          end
-          return output_array
-      end
-
-      params.each_pair do |param, value|
-        is_template = param.end_with?("_template") || param.end_with?("_template_code")
-        if is_template
-          param_root, param_remainder = param.split('.', 2)
-          param_hash[param_root] ||= {}
-          param_hash[param_root][param_remainder] = value
-        else
-          new_params[param] = value
-        end
-      end
-      param_hash.each_pair do |param, values|
-        new_params[param] = expand_param_templates(values, context, param)
-      end
-      new_params
-    end
-
-    # Support the bind syntax, spreading an object into params
-    def parse_params(context)
-      params = super
-
-      params.each do |key, value|
-        if key == 'bind'
-          valueHash = {}.merge(value)
-          params = valueHash.merge(params)
-          next
-        end
-      end
-
-      params.delete('bind')
-      context.scopes.push({}) # Do all expansion in an ephemeral root scope
-      params = expand_param_templates(params, context, "")
-      context.scopes.pop()
-
-      params
-    end
-
-    # Map component names to the .jekyll.html files found in bookshop
-    def render(context)
-      site = context.registers[:site]
-
-      file = render_variable(context) || @file
-      is_template = file.end_with? "__template"
-
-      file = file.gsub(".__template", "")
-      cname = file.strip.split("/").last
-      file = "#{file}/#{cname}.jekyll.html"
-      validate_file_name(file)
-
-      path = locate_include_file(context, file, site.safe)
-      return unless path
-
-      add_include_to_dependency(site, path, context)
-
-      partial = load_cached_partial(path, context)
-
-      context.stack do
-        context["include"] = parse_params(context) if @params
-        begin
-          partial.render!(context)
-        rescue Liquid::Error => e
-          e.template_name = path
-          e.markup_context = "included " if e.markup_context.nil?
-          raise e
-        end
-      end
-
-    end
-  end
-
-  class StyleTag < Liquid::Tag
-    def render(context)
-      site = context.registers[:site]
-      
-      bookshop_scss_files = []
-      site.config['bookshop_base_locations']&.each do |location|
-        components_loc = Pathname.new(location + "/").cleanpath.to_s
-        scss_files = Dir.glob(components_loc + "/**/*.scss")&.collect do |scss_file|
-          scss_file.sub!(components_loc+"/", '').sub!(".scss", '')
-        end
-        bookshop_scss_files.push(*scss_files)
-      end
-
-      bookshop_scss_files = bookshop_scss_files&.collect do |file|
-        "@import '#{file}';"
-      end
-
-      output_css = if Jekyll.env == "production"
-        bookshop_scss_files.join("\n")
-      else
-"html:not([data-bookshop-hmr]) {
-#{bookshop_scss_files.join("\n")}
-}"
-      end
-
-      output_css
-    end
-  end
-
-  class Styles
-
-    # Add the paths to find bookshop's styles
-    def self.open_bookshop(site)
-      bookshop_base_locations = site.config['bookshop_locations']&.collect do |location|
-        Pathname.new("#{site.source}/#{location}/").cleanpath.to_s
-      end
-      bookshop_base_locations = bookshop_base_locations.select do |location|
-        Dir.exist?(location)
-      end
-      bookshop_component_locations = bookshop_base_locations&.collect do |location|
-        Pathname.new("#{location}/components/").cleanpath.to_s
-      end
-
-      site.config['watch_dirs'] ||= [] # Paired with CloudCannon/jekyll-watch
-      site.config['watch_dirs'].push(*bookshop_base_locations);
-
-      site.config['sass'] ||= {}
-      site.config['sass']['load_paths'] ||= []
-      site.config['sass']['load_paths'].push(*bookshop_base_locations)
-
-      site.config['bookshop_base_locations'] ||= []
-      site.config['bookshop_base_locations'].push(*bookshop_base_locations)
-
-      site.config['bookshop_component_locations'] ||= []
-      site.config['bookshop_component_locations'].push(*bookshop_component_locations)
-    end
-  end
-
-  module Filters
-    def addmods(classname, mods = {})
-      base = classname.partition(" ").first
-      mods.each do |mod|
-        if mod[1]
-          classname = "#{classname} #{base}--#{mod[0]}"
-        end
-      end
-      return classname
-    end
-
-    def addstates(classname, states = {})
-      states.each do |state|
-        if state[1]
-          classname = "#{classname} is-#{state[0]}"
-        end
-      end
-      return classname
-    end
-  end
-end
 
 Liquid::Template.register_tag("bookshop", JekyllBookshop::Tag)
 Liquid::Template.register_tag("bookshop_scss", JekyllBookshop::StyleTag)
+Liquid::Template.register_tag("bookshop_site_data", JekyllBookshop::SiteDataTag)
 
 Liquid::Template.register_filter(JekyllBookshop::Filters)
 

data/lib/jekyll-bookshop/filters.rb

@@ -0,0 +1,22 @@
+module JekyllBookshop
+  module Filters
+    def addmods(classname, mods = {})
+      base = classname.partition(" ").first
+      mods.each do |mod|
+        if mod[1]
+          classname = "#{classname} #{base}--#{mod[0]}"
+        end
+      end
+      return classname
+    end
+
+    def addstates(classname, states = {})
+      states.each do |state|
+        if state[1]
+          classname = "#{classname} is-#{state[0]}"
+        end
+      end
+      return classname
+    end
+  end
+end

data/lib/jekyll-bookshop/init-styles.rb

@@ -0,0 +1,30 @@
+module JekyllBookshop
+  class Styles
+
+    # Add the paths to find bookshop's styles
+    def self.open_bookshop(site)
+      bookshop_base_locations = site.config['bookshop_locations']&.collect do |location|
+        Pathname.new("#{site.source}/#{location}/").cleanpath.to_s
+      end
+      bookshop_base_locations = bookshop_base_locations.select do |location|
+        Dir.exist?(location)
+      end
+      bookshop_component_locations = bookshop_base_locations&.collect do |location|
+        Pathname.new("#{location}/components/").cleanpath.to_s
+      end
+
+      site.config['watch_dirs'] ||= [] # Paired with CloudCannon/jekyll-watch
+      site.config['watch_dirs'].push(*bookshop_base_locations);
+
+      site.config['sass'] ||= {}
+      site.config['sass']['load_paths'] ||= []
+      site.config['sass']['load_paths'].push(*bookshop_base_locations)
+
+      site.config['bookshop_base_locations'] ||= []
+      site.config['bookshop_base_locations'].push(*bookshop_base_locations)
+
+      site.config['bookshop_component_locations'] ||= []
+      site.config['bookshop_component_locations'].push(*bookshop_component_locations)
+    end
+  end
+end

data/lib/jekyll-bookshop/page-without-a-file.rb

@@ -0,0 +1,8 @@
+module JekyllBookshop
+    # Utility class to help generate files with no source file
+    class PageWithoutAFile < Jekyll::Page
+      def read_yaml(*)
+        @data ||= {}
+      end
+    end
+  end

data/lib/jekyll-bookshop/tags/bookshop-tag.rb

@@ -0,0 +1,116 @@
+module JekyllBookshop
+  class Tag < Jekyll::Tags::IncludeTag
+
+    # Look for includes in the built bookshop directory
+    def tag_includes_dirs(context)
+      context['site']['bookshop_component_locations'].freeze
+    end
+
+    def expand_param_templates(params, context, parent_param)
+      param_hash = {}
+      new_params = {}
+      
+      is_template = params.key?("__template") || params.key?("__template_code")
+      template = params["__template"] || params["__template_code"] || ""
+      return Liquid::Template.parse(template).render(context) if is_template
+
+      array_template = params["__array_template"] || ""
+      if params.key? "__array_template"
+          # We're adding a new root scope here and then removing it.
+          # Who knows why, but assign and capture always add to the root scope.
+          # Which is why this is hacked in, instead of using context.stack 🤷‍♂️
+          context.scopes.push({})
+          Liquid::Template.parse(array_template).render(context)
+          template_scope = context.scopes.pop()
+          template_array = template_scope[parent_param] || "";
+          unless template_array.is_a? Array
+            Jekyll.logger.warn "Bookshop:",
+                                  "#{array_template} did not evaluate to an array
+                                   as required for key #{parent_param}.__array_template"
+            template_array = []
+          end
+
+          params.delete("__array_template")
+          output_array = []
+          template_array.each do |item|
+            inflector = Dry::Inflector.new
+            singular_parent = inflector.singularize(parent_param)
+            next_scope = {}
+            next_scope[singular_parent] = item
+
+            context.push(next_scope)
+            output_array.push(expand_param_templates(params, context, ""))
+            context.pop()
+          end
+          return output_array
+      end
+
+      params.each_pair do |param, value|
+        is_template = param.end_with?("_template") || param.end_with?("_template_code")
+        if is_template
+          param_root, param_remainder = param.split('.', 2)
+          param_hash[param_root] ||= {}
+          param_hash[param_root][param_remainder] = value
+        else
+          new_params[param] = value
+        end
+      end
+      param_hash.each_pair do |param, values|
+        new_params[param] = expand_param_templates(values, context, param)
+      end
+      new_params
+    end
+
+    # Support the bind syntax, spreading an object into params
+    def parse_params(context)
+      params = super
+
+      params.each do |key, value|
+        if key == 'bind' && value.is_a?(Hash)
+          valueHash = {}.merge(value)
+          params = valueHash.merge(params)
+          next
+        end
+      end
+
+      params.delete('bind')
+      context.scopes.push({}) # Do all expansion in an ephemeral root scope
+      params = expand_param_templates(params, context, "")
+      context.scopes.pop()
+
+      params
+    end
+
+    # Map component names to the .jekyll.html files found in bookshop
+    def render(context)
+      site = context.registers[:site]
+
+      file = render_variable(context) || @file
+      is_template = file.end_with? "__template"
+
+      file = file.gsub(".__template", "")
+      cname = file.strip.split("/").last
+      file = "#{file}/#{cname}.jekyll.html"
+      validate_file_name(file)
+
+      path = locate_include_file(context, file, site.safe)
+      return unless path
+
+      add_include_to_dependency(site, path, context)
+
+      partial = load_cached_partial(path, context)
+
+      context.stack do
+        context["include"] = parse_params(context) if @params
+        begin
+          partial.render!(context)
+        rescue Liquid::Error => e
+          e.template_name = path
+          e.markup_context = "included " if e.markup_context.nil?
+          raise e
+        end
+      end
+
+    end
+  end
+end

data/lib/jekyll-bookshop/tags/site-data-tag.rb

@@ -0,0 +1,53 @@
+require 'json/ext'
+require_relative '../page-without-a-file'
+
+module JekyllBookshop
+  class SiteDataTag < Liquid::Tag
+    def render(context)
+      @site = context.registers[:site]
+
+      payload_collections = {}
+      @site.collections.each_pair do |collection, items|
+        payload_collections[collection] = items.docs.map do |doc|
+          doc.data.merge(hydrate_document_fields(doc))
+        end
+      end
+
+      payload_collections["data"] = @site.data
+      output_payload = {"site" => payload_collections}.to_json
+
+      filename = "site-data"
+      generate_file(filename, output_payload)
+      "<script>window.bookshopSiteData = #{output_payload};</script>"
+    end
+
+    def hydrate_document_fields(document)
+      keys = ["content", "url", "date", "relative_path", "permalink"]
+      hydrated_doc = {}
+      keys.each {|key| hydrated_doc[key] = document.send(key)}
+      hydrate_document_excerpt(document, hydrated_doc)
+    end
+
+    def hydrate_document_excerpt(document, hydrated_doc)
+      hydrated_doc.merge!({
+        "excerpt" => document.data["excerpt"].output
+      })
+    end
+
+    def generate_file(filename, content)
+      dest = destination_json_path(filename)
+      FileUtils.mkdir_p(File.dirname(dest))
+      File.open(dest, "w") { |file| file.write(content) }
+      @site.keep_files ||= []
+      @site.keep_files << json_path(filename)
+    end
+
+    def destination_json_path(filename)
+      Jekyll.sanitized_path(@site.dest, json_path(filename))
+    end
+
+    def json_path(filename)
+      "_bookshop/#{filename}.json"
+    end
+  end
+end

data/lib/jekyll-bookshop/tags/style-tag.rb

@@ -0,0 +1,30 @@
+module JekyllBookshop
+  class StyleTag < Liquid::Tag
+    def render(context)
+      site = context.registers[:site]
+      
+      bookshop_scss_files = []
+      site.config['bookshop_base_locations']&.each do |location|
+        components_loc = Pathname.new(location + "/").cleanpath.to_s
+        scss_files = Dir.glob(components_loc + "/**/*.scss")&.collect do |scss_file|
+          scss_file.sub!(components_loc+"/", '').sub!(".scss", '')
+        end
+        bookshop_scss_files.push(*scss_files)
+      end
+      
+      bookshop_scss_files = bookshop_scss_files&.collect do |file|
+        "@import \"#{file}\";"
+      end
+      
+      output_css = if Jekyll.env == "production"
+        bookshop_scss_files.join("\n")
+      else
+        "@media all, bookshop {
+        #{bookshop_scss_files.join("\n")}
+        }"
+      end
+      
+      output_css
+    end
+  end
+end

data/lib/jekyll-bookshop/version.rb

@@ -1,3 +1,3 @@
 module JekyllBookshop
-  VERSION = "2.0.0.pre.alpha.12"
+  VERSION = "2.0.0.pre.alpha.17"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-bookshop
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre.alpha.12
+  version: 2.0.0.pre.alpha.17
 platform: ruby
 authors:
 - CloudCannon
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-14 00:00:00.000000000 Z
+date: 2021-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -58,6 +58,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/jekyll-bookshop.rb
+- lib/jekyll-bookshop/filters.rb
+- lib/jekyll-bookshop/init-styles.rb
+- lib/jekyll-bookshop/page-without-a-file.rb
+- lib/jekyll-bookshop/tags/bookshop-tag.rb
+- lib/jekyll-bookshop/tags/site-data-tag.rb
+- lib/jekyll-bookshop/tags/style-tag.rb
 - lib/jekyll-bookshop/version.rb
 homepage: https://github.com/cloudcannon/bookshop
 licenses: