gryphon_nest 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6d453e21e5e415707640be17773b49c68e9cc89051e7f4414b1339a6ffc8ced
-  data.tar.gz: 62c65f5a605cee0c62b1abba8f638afe6fa7cc8f7e3f118787d2f0dcb6aa379c
+  metadata.gz: 13f76380c2a03e716f50ee3d517a0af74a5423dcea83d563106984d524368e90
+  data.tar.gz: 3bfd1e61ab10066a5a5256eca4081e6e38933dc7b6346af970b638a1eb264efe
 SHA512:
-  metadata.gz: 56bf077e811a4ab6bf7a6836f42a929fea615a1e89078d1e6c3df63d753e08ff3e9f8d82d91b1588ac26648543702aa7543d95b212b0455f55cf78a44e95c4ec
-  data.tar.gz: 73ffb7df7f94d890f6c46e82687010722e7989e3cd5e0c8dad7c5c4a878bb288cfe0b03fd4e5d449a006cd32012153675ec665442fd37508dd25e8f681b7bf46
+  metadata.gz: f1e2a37c7033667a27292820001c85e826dc86792cd7c1a8a98428659432da7b84dab599870491716eba06c08f3432687fc5668ba7aaa8f9b373e4e31137c65e
+  data.tar.gz: 55797182fcea5cba3af32c20ae18016b7ab2fb9a5653a1526e5c27fb540f973e0f27e4f2a450628ea4176d349c3fc0389f64d5b4fdff000517c227f815e0688b

data/bin/nest

@@ -3,9 +3,9 @@
 
 require 'gryphon_nest'
 require 'optparse'
-require 'sysexits'
 
 DEFAULT_PORT = 8000
+EXIT_FAILURE = 1
 
 options = {
   port: DEFAULT_PORT
@@ -15,11 +15,9 @@ options = {
 # @param parser [OptionParser]
 def usage_error(msg, parser)
   warn(msg, parser)
-  Sysexits.exit(:usage)
+  exit(EXIT_FAILURE)
 end
 
-# @param options [Hash]
-# @return [Array]
 begin
   parser = OptionParser.new do |opts|
     opts.banner = 'Usage: nest [build|serve] [options]'
@@ -47,7 +45,7 @@ begin
   GryphonNest.serve_website(options[:port]) if command == 'serve'
 rescue OptionParser::ParseError => e
   usage_error(e.message, parser)
-rescue GryphonNest::NotFoundError => e
+rescue StandardError => e
   warn e.message
-  Sysexits.exit(:input_missing)
+  exit(EXIT_FAILURE)
 end

data/lib/gryphon_nest/errors.rb

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

data/lib/gryphon_nest/processors/asset_processor.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+module GryphonNest
+  module Processors
+    class AssetProcessor
+      # @param file [Pathname]
+      # @return [Pathname]
+      def process(file)
+        dest = dest_name(file)
+
+        if file_modified?(file, dest)
+          puts "Copying #{file} to #{dest}"
+          dest.dirname.mkpath
+          FileUtils.copy_file(file, dest)
+        end
+
+        dest
+      end
+
+      private
+
+      # @param src [Pathname]
+      # @return [Pathname]
+      def dest_name(src)
+        src.sub(CONTENT_DIR, BUILD_DIR)
+      end
+
+      # @param src [Pathname]
+      # @param des [Pathname]
+      # @return [Boolean]
+      def file_modified?(src, dest)
+        return true unless dest.exist?
+
+        src.mtime > dest.mtime
+      end
+    end
+  end
+end

data/lib/gryphon_nest/processors/mustache_processor.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module GryphonNest
+  module Processors
+    class MustacheProcessor
+      # @param renderer [Renderers::MustacheRenderer]
+      def initialize(renderer)
+        @renderer = renderer
+      end
+
+      # @param file [Pathname]
+      # @return [Pathname]
+      # @raise [Errors::YamlError]
+      def process(file)
+        dest = dest_name(file)
+        context = read_context(file)
+        content = @renderer.render_file(file, context)
+        write_file(dest, content)
+        dest
+      end
+
+      private
+
+      # @param src [Pathname]
+      # @return [Pathname]
+      def dest_name(src)
+        dir = src.dirname
+        path = dir.sub(CONTENT_DIR, BUILD_DIR)
+        basename = src.basename(TEMPLATE_EXT)
+
+        path = path.join(basename) if basename.to_s != 'index'
+
+        path.join('index.html')
+      end
+
+      # @param src [Pathname]
+      # @return [Hash]
+      # @raise [Errors::YamlError]
+      def read_context(src)
+        basename = src.basename(TEMPLATE_EXT)
+        path = "#{DATA_DIR}/#{basename}.yaml"
+        YAML.safe_load_file(path)
+      rescue IOError, Errno::ENOENT
+        {}
+      rescue Psych::SyntaxError => e
+        raise Errors::YamlError, "Encountered error while reading context file. #{e.message}"
+      end
+
+      # @param path [Pathname]
+      # @param content [String]
+      def write_file(path, content)
+        dir = path.dirname
+        dir.mkpath
+        puts "Creating #{path}"
+        path.write(content)
+      end
+    end
+  end
+end

data/lib/gryphon_nest/processors.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module GryphonNest
+  module Processors
+    autoload :AssetProcessor, 'gryphon_nest/processors/asset_processor'
+    autoload :MustacheProcessor, 'gryphon_nest/processors/mustache_processor'
+  end
+end

data/lib/gryphon_nest/renderers/mustache_renderer.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'htmlbeautifier'
+require 'mustache'
+
+module GryphonNest
+  module Renderers
+    # Renders mustache templates to html
+    class MustacheRenderer < Mustache
+      # @param template [String]
+      # @param context [Hash]
+      # @return [String]
+      def render_file(template, context = {})
+        content = super
+
+        layout ||= read_layout_file
+        unless layout.empty?
+          context['yield'] = content
+          content = render(layout, context)
+        end
+
+        HtmlBeautifier.beautify(content)
+      end
+
+      # @param name [String]
+      # @return [String]
+      def partial(name)
+        File.read(name)
+      end
+
+      private
+
+      # @return [String]
+      def read_layout_file
+        layout_file = @options['layout_file']
+        File.read(layout_file)
+      rescue IOError, Errno::ENOENT
+        ''
+      end
+    end
+  end
+end

data/lib/gryphon_nest/renderers.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module GryphonNest
+  module Renderers
+    autoload :MustacheRenderer, 'gryphon_nest/renderers/mustache_renderer'
+  end
+end

data/lib/gryphon_nest/version.rb

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

data/lib/gryphon_nest.rb

@@ -1,36 +1,34 @@
 # frozen_string_literal: true
 
-require 'fileutils'
 require 'pathname'
 require 'webrick'
-require 'yaml'
 
 module GryphonNest
-  autoload :NotFoundError, 'gryphon_nest/not_found_error'
-  autoload :Renderer, 'gryphon_nest/renderer'
+  autoload :Errors, 'gryphon_nest/errors'
+  autoload :Processors, 'gryphon_nest/processors'
+  autoload :Renderers, 'gryphon_nest/renderers'
   autoload :VERSION, 'gryphon_nest/version'
 
-  class << self
-    BUILD_DIR = '_site'
-    CONTENT_DIR = 'content'
-    DATA_DIR = 'data'
-    ASSETS_DIR = 'assets'
-    LAYOUT_DIR = 'layouts'
-    TEMPLATE_EXT = '.mustache'
+  BUILD_DIR = '_site'
+  CONTENT_DIR = 'content'
+  DATA_DIR = 'data'
+  TEMPLATE_EXT = '.mustache'
+  LAYOUT_FILE = 'layouts/main.mustache'
 
+  class << self
+    # @raise [Errors::NotFoundError]
     def build_website
-      raise NotFoundError, "Content directory doesn't exist" unless Dir.exist?(CONTENT_DIR)
+      raise Errors::NotFoundError, "Content directory doesn't exist in the current directory" unless Dir.exist?(CONTENT_DIR)
 
       existing_files = []
       if Dir.exist?(BUILD_DIR)
-        existing_files = filter_glob("#{BUILD_DIR}/**/*")
+        existing_files = 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)
+      delete_files(existing_files)
     end
 
     # @param port [Integer]
@@ -44,173 +42,37 @@ 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)
-
-      path = Pathname.new(dir)
-      path = path.sub(CONTENT_DIR, BUILD_DIR)
-
-      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)
-    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 context [Hash]
-    # @return [String]
-    def get_layout_file(name, context)
-      path = Pathname.new(LAYOUT_DIR)
-
-      if context.key?('layout')
-        layout = context['layout']
-        path = path.join(layout)
-
-        raise NotFoundError, "#{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
-
-    # @param path [String]
-    # @return [Hash]
-    def read_context_file(path)
-      return {} if path == ''
-
-      return {} unless File.exist?(path)
-
-      File.open(path) do |yaml|
-        YAML.safe_load(yaml)
-      end
-    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
-
-    # @return [Array]
+    # @return [Array<Pathname>]
     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}"
-          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)
+      processed_files = []
+      renderer = Renderers::MustacheRenderer.new({ 'layout_file' => LAYOUT_FILE })
+      asset_processor = Processors::AssetProcessor.new
 
-        created_files << dest_file
-        next unless can_create_html_file?(template, dest_file, layout_file, context_file)
+      processors = {
+        TEMPLATE_EXT => Processors::MustacheProcessor.new(renderer)
+      }
 
-        content = renderer.render(template, layout_file, context)
-        save_html_file(dest_file, content)
+      glob("#{CONTENT_DIR}/**/*").each do |source_file|
+        processor = processors.fetch(source_file.extname, asset_processor)
+        processed_files << processor.process(source_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)
+      processed_files
     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
-
-        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)
-      end
-
-      copied_files
+    # @params path [String]
+    # @return [Array<Pathname>]
+    def glob(path)
+      Pathname.glob(path).reject(&:directory?)
     end
 
-    # @param junk_files [Array]
-    def cleanup(junk_files)
+    # @param junk_files [Array<Pathname>]
+    def delete_files(junk_files)
       junk_files.each do |f|
         puts "Deleting #{f}"
-        FileUtils.remove_file(f)
+        f.delete
       end
+      nil
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gryphon_nest
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Christopher Birmingham
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-28 00:00:00.000000000 Z
+date: 2024-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: htmlbeautifier
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: sysexits
+  name: psych
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: webrick
   requirement: !ruby/object:Gem::Requirement
@@ -106,8 +106,12 @@ files:
 - LICENSE
 - bin/nest
 - lib/gryphon_nest.rb
-- lib/gryphon_nest/not_found_error.rb
-- lib/gryphon_nest/renderer.rb
+- lib/gryphon_nest/errors.rb
+- lib/gryphon_nest/processors.rb
+- lib/gryphon_nest/processors/asset_processor.rb
+- lib/gryphon_nest/processors/mustache_processor.rb
+- lib/gryphon_nest/renderers.rb
+- lib/gryphon_nest/renderers/mustache_renderer.rb
 - lib/gryphon_nest/version.rb
 homepage: https://github.com/chrisBirmingham/gryphon_nest
 licenses:
@@ -115,7 +119,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
@@ -130,8 +134,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.2.33
+signing_key:
 specification_version: 4
 summary: Yet another static site generator
 test_files: []

data/lib/gryphon_nest/not_found_error.rb

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

data/lib/gryphon_nest/renderer.rb

@@ -1,55 +0,0 @@
-# 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