gryphon_nest 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 007cb70e7643f8a15d8272811493c561373c316ce2d5f53d61f4e933e060a6b0
+  data.tar.gz: 61b6f2910f36870f10db5783d4bbb4b8e363f12f5a8ed8d7b0a213d91fbf8725
+SHA512:
+  metadata.gz: ac43163a885e0ea4409f98707916d339753295ea1c59c64fa43aebb5b2e91077e597c46ef8db626cda1ac770c0c9f69992486db34cf76ecab2a7ff0b4751ab34
+  data.tar.gz: 5aa4d1916214adea0f0d2c857fb651e7f5b99b2368a2dad535097c8f2f6f8d5949357e0da0d6f5368af83373dd68bfffa0acd4b5ac3838982f23b61e10f26134

data/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <http://unlicense.org/>

data/bin/nest

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'gryphon_nest'
+require 'optparse'
+
+DEFAULT_PORT = 8000
+
+options = {
+  port: DEFAULT_PORT
+}
+
+# @param options [Hash]
+# @return [Array]
+begin
+  parser = OptionParser.new do |opts|
+    opts.banner = 'Usage: nest [build|serve] [options]'
+
+    opts.on('-p', '--port [PORT]', Integer, 'Port to run dev server on')
+
+    opts.on('-h', '--help', 'Show this message') do
+      puts opts
+      exit
+    end
+
+    opts.on('-v', '--version', 'Print version') do
+      puts GryphonNest::VERSION
+      exit
+    end
+  end
+
+  parser.parse!(into: options)
+
+  command = ARGV.fetch(0, 'build')
+
+  unless %w[build serve].include?(command)
+    warn "Unknown command #{command}"
+    warn parser
+    exit(1)
+  end
+
+  GryphonNest.build_website
+  GryphonNest.serve_website(options[:port]) if command == 'serve'
+rescue OptionParser::ParseError => e
+  warn e.message
+  warn parser
+  exit(1)
+rescue StandardError => e
+  warn e.message
+  exit(1)
+end

data/lib/gryphon_nest/version.rb

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

data/lib/gryphon_nest.rb

@@ -0,0 +1,210 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'htmlbeautifier'
+require 'mustache'
+require 'pathname'
+require 'webrick'
+require 'yaml'
+
+module GryphonNest
+  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'
+
+    # @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
+
+    # @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]
+
+        raise "#{name} requires layout file #{val} but it isn't a known layout" unless layouts.key?(val)
+
+        layouts[val]
+      else
+        layouts.fetch('main', '{{{yield}}}')
+      end
+    end
+
+    # @param name [String]
+    # @param content [String]
+    # @param layouts [Hash]
+    # @param data [Hash]
+    # @return [String]
+    def render_template(name, content, layouts, data)
+      key = File.basename(name, TEMPLATE_EXT)
+      template_data = data.fetch(key, {})
+
+      content = Mustache.render(content, template_data)
+
+      layout = get_template_layout(name, layouts, template_data)
+      template_data[:yield] = content
+      Mustache.render(layout, template_data)
+    end
+
+    # @params path [String]
+    # @return [Array]
+    def filter_glob(path)
+      Dir.glob(path).reject do |p|
+        File.directory?(p)
+      end
+    end
+
+    # @param layouts [Hash]
+    # @param data [Hash]
+    # @return [Array]
+    def process_content(layouts, data)
+      created_files = []
+
+      filter_glob("#{CONTENT_DIR}/**/*").each do |template|
+        if File.extname(template) != TEMPLATE_EXT
+          puts "Skipping non template file #{template}"
+          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)
+
+          unless Dir.exist?(dir)
+            puts "Creating #{dir}"
+            Dir.mkdir(dir)
+          end
+
+          File.write(html_file, content)
+          puts "Creating #{html_file}"
+
+          created_files << html_file
+        end
+      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
+
+        next unless can_copy_asset?(asset, 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|
+        puts "Deleting #{f}"
+        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

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: gryphon_nest
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Christopher Birmingham
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: htmlbeautifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: A slightly opinionated static website generator for those who like working
+  in html and mustache
+email:
+- chris.birmingham@hotmail.co.uk
+executables:
+- nest
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- bin/nest
+- lib/gryphon_nest.rb
+- lib/gryphon_nest/version.rb
+homepage: https://github.com/chrisBirmingham/gryphon_nest
+licenses:
+- Unlicense
+metadata:
+  homepage_uri: https://github.com/chrisBirmingham/gryphon_nest
+  source_code_uri: https://github.com/chrisBirmingham/gryphon_nest
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Yet another static site generator
+test_files: []