gryphon_nest 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 007cb70e7643f8a15d8272811493c561373c316ce2d5f53d61f4e933e060a6b0
-  data.tar.gz: 61b6f2910f36870f10db5783d4bbb4b8e363f12f5a8ed8d7b0a213d91fbf8725
+  metadata.gz: b2aeebe3d25d9b2d60ea272fc36fec298100385b07ba99b04baa16a775bda72b
+  data.tar.gz: 326e9baee31c24ebde9a77560222c27570727475124acf9b692f814b350d1fa7
 SHA512:
-  metadata.gz: ac43163a885e0ea4409f98707916d339753295ea1c59c64fa43aebb5b2e91077e597c46ef8db626cda1ac770c0c9f69992486db34cf76ecab2a7ff0b4751ab34
-  data.tar.gz: 5aa4d1916214adea0f0d2c857fb651e7f5b99b2368a2dad535097c8f2f6f8d5949357e0da0d6f5368af83373dd68bfffa0acd4b5ac3838982f23b61e10f26134
+  metadata.gz: d370fe1f376ca822086a5f95ab0da0e1aee9b22ba60212a9d461ebdb34bda84c8ccc24b1445c7d7e06c4548eaf7099f73ac3022419b9188d092a92b464983e8f
+  data.tar.gz: ab4796fd7bc4f3e2be4f86714dc2dbc57b1962d30ce63caa03f49bee99add7104c25e7631c14a72cbdfc2c0c280b08ee0e1118e8cfdb614ee1ff41c01963dcb5

data/lib/gryphon_nest/renderer.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'htmlbeautifier'
+require 'mustache'
+
+module GryphonNest
+  # Renders mustache templates to html
+  class Renderer
+    # @param layouts [Array]
+    def initialize
+      @layouts = {}
+    end
+
+    # @param template [String]
+    # @param layout [String]
+    # @param context [Hash]
+    # @return [String]
+    def render(template, layout, context)
+      File.open(template) do |f|
+        content = render_template(f.read, context)
+        layout = get_template_layout(layout)
+
+        unless layout.nil?
+          context[:yield] = content
+          content = render_template(layout, context)
+        end
+
+        HtmlBeautifier.beautify(content)
+      end
+    end
+
+    private
+
+    # @param content [String]
+    # @param context [Hash]
+    # @return [String]
+    def render_template(content, context)
+      Mustache.render(content, context)
+    end
+
+    # @param path [String]
+    # @return [String|null]
+    def get_template_layout(path)
+      return @layouts[path] if @layouts.key?(path)
+
+      return unless File.exist?(path)
+
+      File.open(path) do |file|
+        content = file.read
+        @layouts[path] = content
+        return content
+      end
+    end
+  end
+end

data/lib/gryphon_nest/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GryphonNest
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/gryphon_nest.rb

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
 
 require 'fileutils'
-require 'htmlbeautifier'
-require 'mustache'
 require 'pathname'
 require 'webrick'
 require 'yaml'
 
 module GryphonNest
+  autoload :Renderer, 'gryphon_nest/renderer'
   autoload :VERSION, 'gryphon_nest/version'
 
   class << self
@@ -18,6 +17,32 @@ module GryphonNest
     LAYOUT_DIR = 'layouts'
     TEMPLATE_EXT = '.mustache'
 
+    def build_website
+      raise "Content directory doesn't exist" unless Dir.exist?(CONTENT_DIR)
+
+      existing_files = []
+      if Dir.exist?(BUILD_DIR)
+        existing_files = filter_glob("#{BUILD_DIR}/**/*")
+      else
+        Dir.mkdir(BUILD_DIR)
+      end
+
+      existing_files = existing_files.difference(process_content)
+      existing_files = existing_files.difference(copy_assets)
+      cleanup(existing_files)
+    end
+
+    # @param port [Integer]
+    def serve_website(port)
+      puts "Running local server on #{port}"
+      server = WEBrick::HTTPServer.new(Port: port, DocumentRoot: BUILD_DIR)
+      # Trap ctrl c so we don't get the horrible stack trace
+      trap('INT') { server.shutdown }
+      server.start
+    end
+
+    private
+
     # @param template_name [String]
     # @return [String]
     def get_output_name(template_name)
@@ -33,51 +58,98 @@ module GryphonNest
       path.to_s
     end
 
-    # @param name [String]
-    # @param layouts [Hash]
-    # @param template_data [Hash]
-    # @return [String]
-    def get_template_layout(name, layouts, template_data)
-      if template_data.key?(:layout)
-        val = template_data[:layout]
+    # @params path [String]
+    # @return [Array]
+    def filter_glob(path)
+      Dir.glob(path).reject do |p|
+        File.directory?(p)
+      end
+    end
 
-        raise "#{name} requires layout file #{val} but it isn't a known layout" unless layouts.key?(val)
+    # @param path [String]
+    # @param content [String]
+    def save_html_file(path, content)
+      dir = File.dirname(path)
 
-        layouts[val]
-      else
-        layouts.fetch('main', '{{{yield}}}')
+      unless Dir.exist?(dir)
+        puts "Creating #{dir}"
+        Dir.mkdir(dir)
+      end
+
+      puts "Creating #{path}"
+      File.write(path, content)
+    end
+
+    # @param src [String]
+    # @param dest [String]
+    # @param layout_file [String]
+    # @param context_file [String]
+    # @return [Boolean]
+    def can_create_html_file?(src, dest, layout_file, context_file)
+      return true unless File.exist?(dest)
+
+      src_mtime = File.mtime(src)
+      dest_mtime = File.mtime(dest)
+
+      return true if src_mtime > dest_mtime
+
+      if File.exist?(layout_file)
+        layout_mtime = File.mtime(layout_file)
+        return true if layout_mtime > dest_mtime
       end
+
+      if File.exist?(context_file)
+        context_mtime = File.mtime(context_file)
+        return true if context_mtime > dest_mtime
+      end
+
+      false
     end
 
     # @param name [String]
-    # @param content [String]
-    # @param layouts [Hash]
-    # @param data [Hash]
+    # @param context [Hash]
     # @return [String]
-    def render_template(name, content, layouts, data)
-      key = File.basename(name, TEMPLATE_EXT)
-      template_data = data.fetch(key, {})
+    def get_layout_file(name, context)
+      path = Pathname.new(LAYOUT_DIR)
 
-      content = Mustache.render(content, template_data)
+      if context.key?('layout')
+        layout = context['layout']
+        path = path.join(layout)
 
-      layout = get_template_layout(name, layouts, template_data)
-      template_data[:yield] = content
-      Mustache.render(layout, template_data)
+        raise "#{name} requires layout file #{layout} but it doesn't exist or can't be read" unless File.exist?(path)
+
+        return path.to_s
+      end
+
+      path.join('main.mustache').to_s
     end
 
-    # @params path [String]
-    # @return [Array]
-    def filter_glob(path)
-      Dir.glob(path).reject do |p|
-        File.directory?(p)
+    # @param path [String]
+    # @return [Hash]
+    def read_context_file(path)
+      return {} if path == ''
+
+      return {} unless File.exist?(path)
+
+      YAML.safe_load_file(path)
+    end
+
+    # @param name [String]
+    # @return [String]
+    def get_context_file(name)
+      basename = File.basename(name, TEMPLATE_EXT)
+
+      Dir.glob("#{DATA_DIR}/#{basename}.{yaml,yml}") do |f|
+        return f
       end
+
+      ''
     end
 
-    # @param layouts [Hash]
-    # @param data [Hash]
     # @return [Array]
-    def process_content(layouts, data)
+    def process_content
       created_files = []
+      renderer = Renderer.new
 
       filter_glob("#{CONTENT_DIR}/**/*").each do |template|
         if File.extname(template) != TEMPLATE_EXT
@@ -85,23 +157,16 @@ module GryphonNest
           next
         end
 
-        File.open(template) do |f|
-          content = render_template(template, f.read, layouts, data)
-          content = HtmlBeautifier.beautify(content)
-          html_file = get_output_name(template)
-
-          dir = File.dirname(html_file)
+        dest_file = get_output_name(template)
+        context_file = get_context_file(template)
+        context = read_context_file(context_file)
+        layout_file = get_layout_file(template, context)
 
-          unless Dir.exist?(dir)
-            puts "Creating #{dir}"
-            Dir.mkdir(dir)
-          end
+        created_files << dest_file
+        next unless can_create_html_file?(template, dest_file, layout_file, context_file)
 
-          File.write(html_file, content)
-          puts "Creating #{html_file}"
-
-          created_files << html_file
-        end
+        content = renderer.render(template, layout_file, context)
+        save_html_file(dest_file, content)
       end
 
       created_files
@@ -128,51 +193,15 @@ module GryphonNest
 
         next unless can_copy_asset?(asset, dest)
 
+        puts "Copying #{asset} to #{dest}"
         dest_dir = File.dirname(dest)
         FileUtils.makedirs(dest_dir)
         FileUtils.copy_file(asset, dest)
-        puts "Copying #{asset} to #{dest}"
       end
 
       copied_files
     end
 
-    # @return [Hash]
-    def read_layout_files
-      return {} unless Dir.exist?(LAYOUT_DIR)
-
-      layouts = {}
-
-      Dir.glob("#{LAYOUT_DIR}/*#{TEMPLATE_EXT}") do |f|
-        key = File.basename(f, TEMPLATE_EXT)
-        layouts[key] = File.read(f)
-      end
-
-      layouts
-    end
-
-    # @param file [String]
-    # @return [Hash]
-    def read_yaml(file)
-      File.open(file) do |yaml|
-        YAML.safe_load(yaml)
-      end
-    end
-
-    # @return [Hash]
-    def read_data_files
-      return {} unless Dir.exist?(DATA_DIR)
-
-      data = {}
-
-      Dir.glob("#{DATA_DIR}/*.{yaml,yml}") do |f|
-        key = File.basename(f, '.*')
-        data[key] = read_yaml(f)
-      end
-
-      data
-    end
-
     # @param junk_files [Array]
     def cleanup(junk_files)
       junk_files.each do |f|
@@ -180,31 +209,5 @@ module GryphonNest
         FileUtils.remove_file(f)
       end
     end
-
-    def build_website
-      raise "Content directory doesn't exist" unless Dir.exist?(CONTENT_DIR)
-
-      existing_files = []
-      if Dir.exist?(BUILD_DIR)
-        existing_files = filter_glob("#{BUILD_DIR}/**/*")
-      else
-        Dir.mkdir(BUILD_DIR)
-      end
-
-      data = read_data_files
-      layouts = read_layout_files
-      existing_files = existing_files.difference(process_content(layouts, data))
-      existing_files = existing_files.difference(copy_assets)
-      cleanup(existing_files)
-    end
-
-    # @param port [Integer]
-    def serve_website(port)
-      put "Running local server on #{port}"
-      server = WEBrick::HTTPServer.new(Port: port, DocumentRoot: BUILD_DIR)
-      # Trap ctrl c so we don't get the horrible stack trace
-      trap('INT') { server.shutdown }
-      server.start
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gryphon_nest
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Christopher Birmingham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-14 00:00:00.000000000 Z
+date: 2023-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: htmlbeautifier
@@ -92,6 +92,7 @@ files:
 - LICENSE
 - bin/nest
 - lib/gryphon_nest.rb
+- lib/gryphon_nest/renderer.rb
 - lib/gryphon_nest/version.rb
 homepage: https://github.com/chrisBirmingham/gryphon_nest
 licenses: