gryphon_nest 1.1.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 773f8de17a88d769b28ca4a19a9f7f0f1a916b865d3363262515cee758be13d3
-  data.tar.gz: e597a97c55f7f34ab8aa2498d608eb1b18e8363bb866549fa5cd514303f8ef1e
+  metadata.gz: 72b699d93837e7f59c74c2782f38526c2f6bc869d6af875bc174d13e29951560
+  data.tar.gz: 6150b1914e70d54e352d181c15750a57c524ae8271ce25de5bb976da4cb0bbf8
 SHA512:
-  metadata.gz: 70b4641bc1e84078c37edf1ba0f1c06cda9ec0252133c7a05ac52264a76789c9c8cacfca2e930c631eaa938ce325c3f1a293815685ead2ee70265060e535928c
-  data.tar.gz: 4989b444b40a22778a4b308637bca2b3630ded3ec4a87deb65ec4a231c0d3dead50f3fe5511a73d723a069907ebb85c221106b024f0b9592446003c7bddcd64a
+  metadata.gz: b60a684cf031ca5d37f3fa111e5b552def7d2041b723a8cca940a497db385111d2b54751501d60e0c22c7ef9f74cd14cdd5effef11b713c92fe4c0e590624eeb
+  data.tar.gz: 20e53c701a4bf0fa32d265d7fff95ece1a3c52eeb77439c347efd5d55a1401c2ee37ee1e2427cf575c70548220ff8640d193ef9ee5571178c06797233e3ae72b

data/bin/nest

@@ -3,6 +3,7 @@
 
 require 'gryphon_nest'
 require 'optparse'
+require 'sysexits'
 
 DEFAULT_PORT = 8000
 
@@ -10,6 +11,13 @@ options = {
   port: DEFAULT_PORT
 }
 
+# @param msg [String]
+# @param parser [OptionParser]
+def usage_error(msg, parser)
+  warn(msg, parser)
+  Sysexits.exit(:usage)
+end
+
 # @param options [Hash]
 # @return [Array]
 begin
@@ -33,19 +41,13 @@ begin
 
   command = ARGV.fetch(0, 'build')
 
-  unless %w[build serve].include?(command)
-    warn "Unknown command #{command}"
-    warn parser
-    exit(1)
-  end
+  usage_error("Unknown command #{command}", parser) unless %w[build serve].include?(command)
 
   GryphonNest.build_website
   GryphonNest.serve_website(options[:port]) if command == 'serve'
 rescue OptionParser::ParseError => e
+  usage_error(e.message, parser)
+rescue GryphonNest::NotFoundError => e
   warn e.message
-  warn parser
-  exit(1)
-rescue StandardError => e
-  warn e.message
-  exit(1)
+  Sysexits.exit(:input_missing)
 end

data/lib/gryphon_nest/file_util.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'pathname'
+
+module GryphonNest
+  class FileUtil
+    # @params path [String]
+    # @return [Array]
+    def self.glob(path)
+      files = Dir.glob(path).reject do |p|
+        File.directory?(p)
+      end
+
+      files.map do |f|
+        Pathname.new(f)
+      end
+    end
+
+    # @param junk_files [Array]
+    def self.delete(junk_files)
+      junk_files.each do |f|
+        puts "Deleting #{f}"
+        FileUtils.remove_file(f)
+      end
+    end
+
+    # @param src [Pathname]
+    # @param dest [Pathname]
+    # @return [Boolean]
+    def self.file_newer?(src, dest)
+      return true unless dest.exist?
+
+      src.mtime > dest.mtime
+    end
+
+    # @param path [Pathname]
+    # @param content [String]
+    def self.write_file(path, content)
+      dir = path.dirname
+
+      unless dir.exist?
+        puts "Creating #{dir}"
+        dir.mkdir
+      end
+
+      puts "Creating #{path}"
+      path.write(content)
+    end
+  end
+end

data/lib/gryphon_nest/not_found_error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GryphonNest
+  class NotFoundError < StandardError; end
+end

data/lib/gryphon_nest/renderer.rb

@@ -5,51 +5,35 @@ require 'mustache'
 
 module GryphonNest
   # Renders mustache templates to html
-  class Renderer
-    # @param layouts [Array]
-    def initialize
+  class Renderer < Mustache
+    # @param options [Hash]
+    def initialize(options = {})
       @layouts = {}
+      super
     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)
+    def render_file(template, context = {})
+      content = super
 
-        unless layout.nil?
-          context[:yield] = content
-          content = render_template(layout, context)
-        end
-
-        HtmlBeautifier.beautify(content)
+      if context.key?('layout')
+        context['yield'] = content
+        content = super(context['layout'], context)
       end
-    end
 
-    private
-
-    # @param content [String]
-    # @param context [Hash]
-    # @return [String]
-    def render_template(content, context)
-      Mustache.render(content, context)
+      HtmlBeautifier.beautify(content)
     end
 
-    # @param path [String]
-    # @return [String|null]
-    def get_template_layout(path)
-      return @layouts[path] if @layouts.key?(path)
-
-      return unless File.exist?(path)
+    # @param name [String]
+    # @return [String]
+    def partial(name)
+      return @layouts[name] if @layouts.key?(name)
 
-      File.open(path) do |file|
-        content = file.read
-        @layouts[path] = content
-        return content
-      end
+      content = File.read(name)
+      @layouts[name] = content
+      content
     end
   end
 end

data/lib/gryphon_nest/version.rb

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

data/lib/gryphon_nest.rb

@@ -6,7 +6,9 @@ require 'webrick'
 require 'yaml'
 
 module GryphonNest
+  autoload :NotFoundError, 'gryphon_nest/not_found_error'
   autoload :Renderer, 'gryphon_nest/renderer'
+  autoload :FileUtil, 'gryphon_nest/file_util'
   autoload :VERSION, 'gryphon_nest/version'
 
   class << self
@@ -16,20 +18,22 @@ module GryphonNest
     ASSETS_DIR = 'assets'
     LAYOUT_DIR = 'layouts'
     TEMPLATE_EXT = '.mustache'
+    DEFAULT_LAYOUT = Pathname.new("#{LAYOUT_DIR}/main.mustache")
 
+    # @raise [NotFoundError]
     def build_website
-      raise "Content directory doesn't exist" unless Dir.exist?(CONTENT_DIR)
+      raise NotFoundError, "Content directory doesn't exist" unless Dir.exist?(CONTENT_DIR)
 
       existing_files = []
       if Dir.exist?(BUILD_DIR)
-        existing_files = filter_glob("#{BUILD_DIR}/**/*")
+        existing_files = FileUtil.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)
+      FileUtil.delete(existing_files)
     end
 
     # @param port [Integer]
@@ -43,72 +47,35 @@ module GryphonNest
 
     private
 
-    # @param template_name [String]
-    # @return [String]
-    def get_output_name(template_name)
-      dir = File.dirname(template_name)
-      basename = File.basename(template_name, TEMPLATE_EXT)
+    # @param source_file [Pathname]
+    # @return [Pathname]
+    def get_output_name(source_file)
+      dir = source_file.dirname
+      basename = source_file.basename(TEMPLATE_EXT)
+      path = dir.sub(CONTENT_DIR, BUILD_DIR)
 
-      path = Pathname.new(dir)
-      path = path.sub(CONTENT_DIR, BUILD_DIR)
+      path = path.join(basename) if basename.to_s != 'index'
 
-      path = path.join(basename) if basename != 'index'
-
-      path = path.join('index.html')
-      path.to_s
-    end
-
-    # @params path [String]
-    # @return [Array]
-    def filter_glob(path)
-      Dir.glob(path).reject do |p|
-        File.directory?(p)
-      end
-    end
-
-    # @param path [String]
-    # @param content [String]
-    def save_html_file(path, content)
-      dir = File.dirname(path)
-
-      unless Dir.exist?(dir)
-        puts "Creating #{dir}"
-        Dir.mkdir(dir)
-      end
-
-      puts "Creating #{path}"
-      File.write(path, content)
+      path.join('index.html')
     end
 
-    # @param src [String]
-    # @param dest [String]
-    # @param layout_file [String]
-    # @param context_file [String]
+    # @param source_file [Pathname]
+    # @param dest_file [Pathname]
+    # @param context_file [Pathname, nil]
+    # @param layout_file [Pathname, nil]
     # @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
+    def resources_updated?(source_file, dest_file, context_file, layout_file)
+      return true if FileUtil.file_newer?(source_file, dest_file)
 
-      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
+      return true if !context_file.nil? && FileUtil.file_newer?(context_file, dest_file)
 
-      false
+      !layout_file.nil? && FileUtil.file_newer?(layout_file, dest_file)
     end
 
     # @param name [String]
     # @param context [Hash]
-    # @return [String]
+    # @return [Pathname, nil]
+    # @raise [NotFoundError]
     def get_layout_file(name, context)
       path = Pathname.new(LAYOUT_DIR)
 
@@ -116,100 +83,85 @@ module GryphonNest
         layout = context['layout']
         path = path.join(layout)
 
-        raise "#{name} requires layout file #{layout} but it doesn't exist or can't be read" unless File.exist?(path)
+        raise NotFoundError, "#{name} requires layout file #{layout} but it doesn't exist or can't be read" unless path.exist?
 
-        return path.to_s
+        return path
       end
 
-      path.join('main.mustache').to_s
+      DEFAULT_LAYOUT if DEFAULT_LAYOUT.exist?
     end
 
-    # @param path [String]
+    # @param path [Pathname, nil]
     # @return [Hash]
-    def read_context_file(path)
-      return {} if path == ''
-
-      return {} unless File.exist?(path)
+    def get_context(path)
+      return {} if path.nil?
 
       File.open(path) do |yaml|
         YAML.safe_load(yaml)
       end
     end
 
-    # @param name [String]
-    # @return [String]
+    # @param name [Pathname]
+    # @return [Pathname, nil]
     def get_context_file(name)
-      basename = File.basename(name, TEMPLATE_EXT)
+      basename = name.basename(TEMPLATE_EXT)
+      FileUtil.glob("#{DATA_DIR}/#{basename}.{yaml,yml}")[0]
+    end
 
-      Dir.glob("#{DATA_DIR}/#{basename}.{yaml,yml}") do |f|
-        return f
-      end
+    # @param renderer [Renderer]
+    # @param source_file [Pathname]
+    # @param dest_file [Pathname]
+    # @raise [NotFoundError]
+    def process_file(renderer, source_file, dest_file)
+      context_file = get_context_file(source_file)
+      context = get_context(context_file)
+      layout_file = get_layout_file(source_file.basename, context)
+      context['layout'] = layout_file unless layout_file.nil?
+
+      return unless resources_updated?(source_file, dest_file, context_file, layout_file)
 
-      ''
+      content = renderer.render_file(source_file, context)
+      FileUtil.write_file(dest_file, content)
     end
 
     # @return [Array]
+    # @raise [NotFoundError]
     def process_content
       created_files = []
-      renderer = Renderer.new
 
-      filter_glob("#{CONTENT_DIR}/**/*").each do |template|
-        if File.extname(template) != TEMPLATE_EXT
-          puts "Skipping non template file #{template}"
+      renderer = Renderer.new
+      FileUtil.glob("#{CONTENT_DIR}/**/*").each do |source_file|
+        if source_file.extname != TEMPLATE_EXT
+          warn "Skipping non template file #{source_file}"
           next
         end
 
-        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)
-
+        dest_file = get_output_name(source_file)
         created_files << dest_file
-        next unless can_create_html_file?(template, dest_file, layout_file, context_file)
-
-        content = renderer.render(template, layout_file, context)
-        save_html_file(dest_file, content)
+        process_file(renderer, source_file, dest_file)
       end
 
       created_files
     end
 
-    # @param src [String]
-    # @param dest [String]
-    # @return [Boolean]
-    def can_copy_asset?(src, dest)
-      return true unless File.exist?(dest)
-
-      File.mtime(src) > File.mtime(dest)
-    end
-
     # @return [Array]
     def copy_assets
       return [] unless Dir.exist?(ASSETS_DIR)
 
       copied_files = []
-      filter_glob("#{ASSETS_DIR}/**/*").each do |asset|
-        dest = Pathname.new(asset)
-        dest = dest.sub(ASSETS_DIR, BUILD_DIR)
-        copied_files << dest.to_s
+      FileUtil.glob("#{ASSETS_DIR}/**/*").each do |asset|
+        dest = asset.sub(ASSETS_DIR, BUILD_DIR)
+        copied_files << dest
 
-        next unless can_copy_asset?(asset, dest)
+        next unless FileUtil.file_newer?(asset, dest)
 
         puts "Copying #{asset} to #{dest}"
-        dest_dir = File.dirname(dest)
+        dest_dir = dest.dirname
         FileUtils.makedirs(dest_dir)
         FileUtils.copy_file(asset, dest)
       end
 
       copied_files
     end
-
-    # @param junk_files [Array]
-    def cleanup(junk_files)
-      junk_files.each do |f|
-        puts "Deleting #{f}"
-        FileUtils.remove_file(f)
-      end
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gryphon_nest
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Christopher Birmingham
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-22 00:00:00.000000000 Z
+date: 2023-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: htmlbeautifier
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: sysexits
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: webrick
   requirement: !ruby/object:Gem::Requirement
@@ -92,6 +106,8 @@ files:
 - LICENSE
 - bin/nest
 - lib/gryphon_nest.rb
+- lib/gryphon_nest/file_util.rb
+- lib/gryphon_nest/not_found_error.rb
 - lib/gryphon_nest/renderer.rb
 - lib/gryphon_nest/version.rb
 homepage: https://github.com/chrisBirmingham/gryphon_nest
@@ -100,7 +116,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/chrisBirmingham/gryphon_nest
   source_code_uri: https://github.com/chrisBirmingham/gryphon_nest
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -115,8 +131,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Yet another static site generator
 test_files: []