gryphon_nest 4.0.1 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebc3be5da99292952a7e447920e092a23df21940c045b5b04e9c606ab41f1f90
-  data.tar.gz: '08d4e67a95b76b98ca48ab20cd4926e2227fabeafd6f6f0dc05b2c91bef2e579'
+  metadata.gz: 455e829fa2827b15a7e0641049172d907615a4aa7bf5d29adefdb3440c71743e
+  data.tar.gz: 72a8c33e211645a385fb51c0581085159361e4c7d0dd62b1c284a7eb3e37cbc0
 SHA512:
-  metadata.gz: 5166f66ccab09e8cb108b308b9e79681318f595d5faf8210cf783ccc714b2f0b3533a161c92eb92f94e102b6f9954ea7519c4da285a0330951340e8c61030bbb
-  data.tar.gz: 58566f847efb6ddbc5e782e78b12b27672fcf08f44a897b68947621620b1c01a0ccb198d79f584fd3f1c41eaf68bf371c61fc65338df73933b496010c4068118
+  metadata.gz: b9c81a97e0bccc92c99cd1e7fd512b2e63899ab73b2de58f31a0161ad67246d27c1dc7f5fa2bc253fb4961ffa8047d79b56f26a45ca3f29b98bc5f33bdcb2c2e
+  data.tar.gz: 8db1246fd5023222581c26b408c98996ea935b159b1673d4b98f9cd07802c3d53109352f0f6230711260e5a4ba1f1d6b343e144e1d2e5a9e8ddddaa422fb36c1

data/bin/nest

@@ -8,6 +8,8 @@ DEFAULT_PORT = 8000
 EXIT_FAILURE = 1
 
 options = {
+  compress: false,
+  force: false,
   port: DEFAULT_PORT,
   watch: false
 }
@@ -21,7 +23,11 @@ end
 
 begin
   parser = OptionParser.new do |opts|
-    opts.banner = 'Usage: nest [build|serve] [options]'
+    opts.banner = 'Usage: nest [build|serve|clean] [options]'
+
+    opts.on('-c', '--compress', 'Create gzipped compressed versions of each file')
+
+    opts.on('-f', '--force', 'Force (re)build all files')
 
     opts.on('-p', '--port [PORT]', Integer, 'Port to run dev server on')
 
@@ -42,15 +48,22 @@ begin
 
   command = ARGV.fetch(0, 'build')
 
-  usage_error("Unknown command #{command}", parser) unless %w[build serve].include?(command)
+  nest = GryphonNest::Nest.new(options[:force])
+  nest.compressor = GryphonNest::GzipCompressor.new if options[:compress]
 
-  nest = GryphonNest::Nest.new
-  nest.build
+  case command
+  when 'clean'
+    nest.clean
+  when 'build'
+    nest.build
+  when 'serve'
+    nest.build
 
-  if command == 'serve'
     nest.watch if options[:watch]
 
     nest.serve(options[:port])
+  else
+    usage_error("Unknown command #{command}", parser)
   end
 rescue OptionParser::ParseError => e
   usage_error(e.message, parser)

data/lib/gryphon_nest/gzip_compressor.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'zlib'
+
+module GryphonNest
+  class GzipCompressor
+    # @param file [Pathname]
+    # @return [Boolean]
+    def can_compress?(file)
+      file.size >= 20
+    end
+
+    # @param file [Pathname]
+    def compress(file)
+      compressed = "#{file}.gz"
+
+      Zlib::GzipWriter.open(compressed, Zlib::BEST_COMPRESSION) do |gz|
+        gz.mtime = file.mtime
+        gz.orig_name = file.to_s
+        gz.write IO.binread(file)
+      end
+    end
+  end
+end

data/lib/gryphon_nest/layout_file.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module GryphonNest
+  # Wrapper class for operations performed on the layout.yaml file
+  class LayoutFile
+    # @param path [Pathname]
+    def initialize(path)
+      @path = path
+      @content = nil
+      @last_mtime = Time.now
+    end
+
+    # @return [Boolean]
+    def exist?
+      @path.exist?
+    end
+
+    # @return [Time]
+    def mtime
+      @path.mtime
+    end
+
+    # @return [String]
+    def content
+      mod_time = mtime
+
+      if @content.nil? || mod_time > @last_mtime
+        @content = @path.read
+        @last_mtime = mod_time
+      end
+
+      @content
+    end
+  end
+end

data/lib/gryphon_nest/processors/mustache_processor.rb

@@ -8,8 +8,10 @@ module GryphonNest
     # Renders a Mustache template into a html file
     class MustacheProcessor
       # @param renderer [Renderers::MustacheRenderer]
-      def initialize(renderer)
+      # @param layout_file [LayoutFile]
+      def initialize(renderer, layout_file)
         @renderer = renderer
+        @layout_file = layout_file
       end
 
       # @param src [Pathname]
@@ -17,8 +19,6 @@ module GryphonNest
       # @raise [Errors::YamlError]
       # @raise [Errors::ParseError]
       def process(src, dest)
-        @layout ||= read_layout_file
-
         context = read_context(src)
         content = build_output(src, context)
         write_file(dest, content)
@@ -36,11 +36,21 @@ module GryphonNest
         path.join('index.html')
       end
 
-      # @param _src [Pathname]
-      # @param _dest [Pathname]
+      # @param src [Pathname]
+      # @param dest [Pathname]
       # @return [Boolean]
-      def file_modified?(_src, _dest)
-        true
+      def file_modified?(src, dest)
+        return true unless dest.exist?
+
+        mod_time = dest.mtime
+        return true if src.mtime > mod_time
+
+        path = context_file_name(src)
+        return true if path.exist? && path.mtime > mod_time
+
+        return false unless @layout_file.exist?
+
+        @layout_file.mtime > mod_time
       end
 
       private
@@ -49,25 +59,30 @@ module GryphonNest
       # @return [Hash]
       # @raise [Errors::YamlError]
       def read_context(src)
-        path = src.sub(CONTENT_DIR, DATA_DIR).sub_ext('.yaml')
-        YAML.safe_load_file(path, symbolize_names: true)
+        YAML.safe_load_file(context_file_name(src), symbolize_names: true)
       rescue IOError, Errno::ENOENT
         {}
       rescue Psych::SyntaxError => e
         raise Errors::YamlError, "Encountered error while reading context file. Reason: #{e.message}"
       end
 
+      # @param src [Pathname]
+      # @return [Pathname]
+      def context_file_name(src)
+        src.sub(CONTENT_DIR, DATA_DIR).sub_ext('.yaml')
+      end
+
       # @param file [Pathname]
       # @param context [Hash]
       # @return [String]
       # @raise [Errors::ParseError]
       def build_output(file, context)
         content =
-          if @layout.empty?
-            @renderer.render_file(file, context)
-          else
+          if @layout_file.exist?
             context[:yield] = file.basename(TEMPLATE_EXT)
-            @renderer.render(@layout, context)
+            @renderer.render(@layout_file.content, context)
+          else
+            @renderer.render_file(file, context)
           end
 
         HtmlBeautifier.beautify(content, stop_on_errors: true)
@@ -83,13 +98,6 @@ module GryphonNest
         path.dirname.mkpath
         path.write(content)
       end
-
-      # @return [String]
-      def read_layout_file
-        File.read(LAYOUT_FILE)
-      rescue IOError, Errno::ENOENT
-        ''
-      end
     end
   end
 end

data/lib/gryphon_nest/processors.rb

@@ -12,9 +12,10 @@ module GryphonNest
       def create
         ProcessorRegistry.new do |reg|
           reg[TEMPLATE_EXT] = proc {
+            layout_file = LayoutFile.new(Pathname(LAYOUT_FILE))
             renderer = Renderers::MustacheRenderer.new
             renderer.template_path = CONTENT_DIR
-            Processors::MustacheProcessor.new(renderer)
+            Processors::MustacheProcessor.new(renderer, layout_file)
           }
 
           sass_proc = proc { Processors::SassProcessor.new }

data/lib/gryphon_nest/version.rb

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

data/lib/gryphon_nest.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
+require 'fileutils'
 require 'listen'
 require 'pathname'
 require 'webrick'
 
 module GryphonNest
   autoload :Errors, 'gryphon_nest/errors'
+  autoload :GzipCompressor, 'gryphon_nest/gzip_compressor'
+  autoload :LayoutFile, 'gryphon_nest/layout_file'
   autoload :Logging, 'gryphon_nest/logging'
   autoload :Processors, 'gryphon_nest/processors'
   autoload :Renderers, 'gryphon_nest/renderers'
@@ -18,43 +21,51 @@ module GryphonNest
   LAYOUT_FILE = 'layout.mustache'
 
   class Nest
-    def initialize
+    # @return [GzipCompressor, nil]
+    attr_writer :compressor
+
+    # @param force [Boolean]
+    def initialize(force)
       @processors = Processors.create
       @logger = Logging.create
+      @force = force
+      @compressor = nil
+      @modifications = 0
     end
 
     # @raise [Errors::NotFoundError]
     def build
-      raise Errors::NotFoundError, "Content directory doesn't exist in the current directory" unless Dir.exist?(CONTENT_DIR)
+      unless Dir.exist?(CONTENT_DIR)
+        raise Errors::NotFoundError, "Content directory doesn't exist in the current directory"
+      end
 
       Dir.mkdir(BUILD_DIR) unless Dir.exist?(BUILD_DIR)
 
-      existing_files = glob("#{BUILD_DIR}/**/*")
-      content_files = glob("#{CONTENT_DIR}/**/*")
+      existing_files = glob(BUILD_DIR, '[!.gz]')
+      content_files = glob(CONTENT_DIR)
       processed_files = content_files.collect { |src| process_file(src) }
-      existing_files.difference(processed_files).each { |file| delete_file(file) }
+      files_to_delete = existing_files.difference(processed_files)
+      files_to_delete.each { |file| delete_file(file) }
+
+      @logger.info('No changes detected') if @modifications.zero? && files_to_delete.empty?
+    end
+
+    def clean
+      FileUtils.remove_dir(BUILD_DIR, true)
+      @logger.info('Removed build dir')
     end
 
     def watch
       @logger.info('Watching for content changes')
-      Listen.to(CONTENT_DIR, relative: true) do |modified, added, removed|
-        modified.union(added).each do |file|
-          path = Pathname(file)
-          process_file(path)
-        end
 
-        removed.each do |file|
-          path = Pathname(file)
-          path = @processors[path.extname].dest_name(path)
-          delete_file(path)
-        end
-      end.start
+      # Bypass modification checks, we already know the files been changed
+      @force = true
 
-      Listen.to(DATA_DIR, relative: true) do |modified, added, removed|
-        modified.union(added, removed).each do |file|
-          path = Pathname(file)
-          process_data_file(path)
-        end
+      only = [/^#{CONTENT_DIR}/, /^#{DATA_DIR}/, /^#{LAYOUT_FILE}$/]
+      Listen.to('.', relative: true, only: only) do |modified, added, removed|
+        modified.union(added).each { |file| process_changes(file) }
+
+        removed.each { |file| process_changes(file, removal: true) }
       end.start
     end
 
@@ -75,15 +86,51 @@ module GryphonNest
       processor = @processors[src.extname]
       dest = processor.dest_name(src)
 
-      if processor.file_modified?(src, dest)
+      if @force || processor.file_modified?(src, dest)
+        @modifications += 1
         msg = File.exist?(dest) ? 'Recreating' : 'Creating'
         @logger.info("#{msg} #{dest}")
         processor.process(src, dest)
+        compress_file(dest)
       end
 
       dest
     end
 
+    # @param file [Pathname]
+    def compress_file(file)
+      return unless @compressor.is_a?(GzipCompressor)
+
+      @logger.info("Compressing #{file}")
+      unless @compressor.can_compress?(file)
+        @logger.info("Skipping #{file}")
+        return
+      end
+
+      @compressor.compress(file)
+    end
+
+    # @param src [String]
+    # @param removal [Boolean]
+    def process_changes(src, removal: false)
+      if src == LAYOUT_FILE
+        glob(CONTENT_DIR, TEMPLATE_EXT).each { |file| process_file(file) }
+      else
+        path = Pathname(src)
+
+        if src.start_with?(DATA_DIR)
+          process_data_file(path)
+        elsif removal
+          path = @processors[path.extname].dest_name(path)
+          delete_file(path)
+        else
+          process_file(path)
+        end
+      end
+    rescue StandardError => e
+      @logger.error(e.message)
+    end
+
     # @param src [Pathname]
     # @return [Pathname]
     def process_data_file(src)
@@ -94,16 +141,21 @@ module GryphonNest
       process_file(src)
     end
 
-    # @params path [String]
+    # @params base [String]
+    # @params match [String]
     # @return [Array<Pathname>]
-    def glob(path)
-      Pathname.glob(path).reject(&:directory?)
+    def glob(base, match = '')
+      Pathname.glob("#{base}/**/*#{match}").reject(&:directory?)
     end
 
     # @param file [Pathname]
     def delete_file(file)
-      @logger.info("Deleting #{file}")
-      file.delete
+      [file, Pathname("#{file}.gz")].each do |f|
+        next unless f.exist?
+
+        @logger.info("Deleting #{f}")
+        f.delete
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gryphon_nest
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.2.0
 platform: ruby
 authors:
 - Christopher Birmingham
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-22 00:00:00.000000000 Z
+date: 2025-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: htmlbeautifier
@@ -121,6 +121,8 @@ files:
 - bin/nest
 - lib/gryphon_nest.rb
 - lib/gryphon_nest/errors.rb
+- lib/gryphon_nest/gzip_compressor.rb
+- lib/gryphon_nest/layout_file.rb
 - lib/gryphon_nest/logging.rb
 - lib/gryphon_nest/processors.rb
 - lib/gryphon_nest/processors/asset_processor.rb