gryphon_nest 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72b699d93837e7f59c74c2782f38526c2f6bc869d6af875bc174d13e29951560
-  data.tar.gz: 6150b1914e70d54e352d181c15750a57c524ae8271ce25de5bb976da4cb0bbf8
+  metadata.gz: 13f76380c2a03e716f50ee3d517a0af74a5423dcea83d563106984d524368e90
+  data.tar.gz: 3bfd1e61ab10066a5a5256eca4081e6e38933dc7b6346af970b638a1eb264efe
 SHA512:
-  metadata.gz: b60a684cf031ca5d37f3fa111e5b552def7d2041b723a8cca940a497db385111d2b54751501d60e0c22c7ef9f74cd14cdd5effef11b713c92fe4c0e590624eeb
-  data.tar.gz: 20e53c701a4bf0fa32d265d7fff95ece1a3c52eeb77439c347efd5d55a1401c2ee37ee1e2427cf575c70548220ff8640d193ef9ee5571178c06797233e3ae72b
+  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.3.0'
+  VERSION = '2.0.0'
 end

data/lib/gryphon_nest.rb

@@ -1,39 +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 :FileUtil, 'gryphon_nest/file_util'
+  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'
-    DEFAULT_LAYOUT = Pathname.new("#{LAYOUT_DIR}/main.mustache")
+  BUILD_DIR = '_site'
+  CONTENT_DIR = 'content'
+  DATA_DIR = 'data'
+  TEMPLATE_EXT = '.mustache'
+  LAYOUT_FILE = 'layouts/main.mustache'
 
-    # @raise [NotFoundError]
+  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 = FileUtil.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)
-      FileUtil.delete(existing_files)
+      delete_files(existing_files)
     end
 
     # @param port [Integer]
@@ -47,121 +42,37 @@ module GryphonNest
 
     private
 
-    # @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 = path.join(basename) if basename.to_s != 'index'
-
-      path.join('index.html')
-    end
-
-    # @param source_file [Pathname]
-    # @param dest_file [Pathname]
-    # @param context_file [Pathname, nil]
-    # @param layout_file [Pathname, nil]
-    # @return [Boolean]
-    def resources_updated?(source_file, dest_file, context_file, layout_file)
-      return true if FileUtil.file_newer?(source_file, dest_file)
-
-      return true if !context_file.nil? && FileUtil.file_newer?(context_file, dest_file)
-
-      !layout_file.nil? && FileUtil.file_newer?(layout_file, dest_file)
-    end
-
-    # @param name [String]
-    # @param context [Hash]
-    # @return [Pathname, nil]
-    # @raise [NotFoundError]
-    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 path.exist?
-
-        return path
-      end
-
-      DEFAULT_LAYOUT if DEFAULT_LAYOUT.exist?
-    end
-
-    # @param path [Pathname, nil]
-    # @return [Hash]
-    def get_context(path)
-      return {} if path.nil?
-
-      File.open(path) do |yaml|
-        YAML.safe_load(yaml)
-      end
-    end
-
-    # @param name [Pathname]
-    # @return [Pathname, nil]
-    def get_context_file(name)
-      basename = name.basename(TEMPLATE_EXT)
-      FileUtil.glob("#{DATA_DIR}/#{basename}.{yaml,yml}")[0]
-    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]
+    # @return [Array<Pathname>]
     def process_content
-      created_files = []
+      processed_files = []
+      renderer = Renderers::MustacheRenderer.new({ 'layout_file' => LAYOUT_FILE })
+      asset_processor = Processors::AssetProcessor.new
 
-      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
+      processors = {
+        TEMPLATE_EXT => Processors::MustacheProcessor.new(renderer)
+      }
 
-        dest_file = get_output_name(source_file)
-        created_files << dest_file
-        process_file(renderer, source_file, dest_file)
+      glob("#{CONTENT_DIR}/**/*").each do |source_file|
+        processor = processors.fetch(source_file.extname, asset_processor)
+        processed_files << processor.process(source_file)
       end
 
-      created_files
+      processed_files
     end
 
-    # @return [Array]
-    def copy_assets
-      return [] unless Dir.exist?(ASSETS_DIR)
-
-      copied_files = []
-      FileUtil.glob("#{ASSETS_DIR}/**/*").each do |asset|
-        dest = asset.sub(ASSETS_DIR, BUILD_DIR)
-        copied_files << dest
-
-        next unless FileUtil.file_newer?(asset, dest)
+    # @params path [String]
+    # @return [Array<Pathname>]
+    def glob(path)
+      Pathname.glob(path).reject(&:directory?)
+    end
 
-        puts "Copying #{asset} to #{dest}"
-        dest_dir = dest.dirname
-        FileUtils.makedirs(dest_dir)
-        FileUtils.copy_file(asset, dest)
+    # @param junk_files [Array<Pathname>]
+    def delete_files(junk_files)
+      junk_files.each do |f|
+        puts "Deleting #{f}"
+        f.delete
       end
-
-      copied_files
+      nil
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gryphon_nest
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Christopher Birmingham
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-01 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,9 +106,12 @@ 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/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:
@@ -131,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Yet another static site generator

data/lib/gryphon_nest/file_util.rb

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

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

data/lib/gryphon_nest/renderer.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require 'htmlbeautifier'
-require 'mustache'
-
-module GryphonNest
-  # Renders mustache templates to html
-  class Renderer < Mustache
-    # @param options [Hash]
-    def initialize(options = {})
-      @layouts = {}
-      super
-    end
-
-    # @param template [String]
-    # @param context [Hash]
-    # @return [String]
-    def render_file(template, context = {})
-      content = super
-
-      if context.key?('layout')
-        context['yield'] = content
-        content = super(context['layout'], context)
-      end
-
-      HtmlBeautifier.beautify(content)
-    end
-
-    # @param name [String]
-    # @return [String]
-    def partial(name)
-      return @layouts[name] if @layouts.key?(name)
-
-      content = File.read(name)
-      @layouts[name] = content
-      content
-    end
-  end
-end