yass 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2403483776bfafa63a1b62961f516a4419905c8392e4d76eb79fd48503bbd91
-  data.tar.gz: cc86724e2ae2474080e88f0e58aef30a8bb052875ffe8593d33a6db6c81bd89a
+  metadata.gz: 73f51cc4416ff0b4de87b02a74f586f0896ad4ee1bf7f1825d19076229fc528a
+  data.tar.gz: 3da6e3a3b8ea3e0a6e45edaef4813f8ec83ada084daac8bfe6f83cf624b083d8
 SHA512:
-  metadata.gz: b6d05f3567714a26ae05fc8b9ec8f9bf61eef897293e504b2745bb81e36c99470eff39f6a12be73081d4d27a1016ee32ebc73f7128cb8cb224735bf88bcccb07
-  data.tar.gz: '0814026244474ee279a5f8c45886bdeebece7da03d6c6523c798adaac2a3980ff038139f8603f388adac3cff061e7584598348e1f60ef4b2d1fa4b309bf298c4'
+  metadata.gz: a1760594401b2db23db4bc0b1fe8333b9d7b77ede41291ee5ace23c3a407d432b5360941570bb13eb1ea3f61f37f7c3d36e2d6da856561b0278e418380b37e00
+  data.tar.gz: 2911add8f4767f6aedd2ceb6c2708d966d05961161671d0eedc735f28ae6147379b6da142c7d6fce3162c9ee94cca4cd29d20bbe0f3275104dfdba85bd16710a

data/README.md

@@ -22,7 +22,7 @@ $ yass init blog
 Creating blog/layouts/default.html.liquid
 Creating blog/site/assets/highlight-default.css
 Creating blog/site/assets/highlight.min.js
-Creating blog/site/index.default.html.liquid
+Creating blog/site/index.html.liquid
 Creating blog/templates/css_links.liquid
 Creating blog/templates/js_scripts.liquid
 $ cd blog
@@ -36,16 +36,16 @@ The built site will be placed into `dist`.
 yass build
 ```
 
-If you're building for local viewing, use the `--local` option. It ensures any generated URLs ending in `/` have `.index.html` appended.
+NOTE If you're building for webserverless, local viewing, and using the `skip_index` filter anywhere, use the `--no-skip-index` option.
 
 ```bash
-yass build --local
+yass build --no-skip-index
 ```
 
 Use the `watch` command to continually build your site as files change.
 
 ```bash
-yass watch
+yass watch # also supports --no-skip-index
 ```
 
 ## Layouts
@@ -64,13 +64,17 @@ Layouts live in `layouts/` and will be applied to files with matching names. The
 
 If the above layout is named *page.html.liquid*, it will match any file named `*.page.html*`. Examples:
 
-  * foo.page.html
-  * foo.page.html.*
-  * foo.page.md (because *.md* converts to *.html*)
-  * foo.page.md.*
+  * `foo.page.html`
+  * `foo.page.html.*`
+  * `foo.page.md` (because *.md* converts to *.html*)
+  * `foo.page.md.*`
 
 The name of the layout (e.g. `page`) is removed from the final filename, resulting in `foo.html`.
 
+### Default layouts
+
+If you create a layout named `default.<ext>.liquid`, Yass will apply it to any `.<ext>` files without layouts. For example, a layout named `default.html.liquid` will match `foo.html` or `foo.not-a-layout.md.liquid`.
+
 ## Templates
 
 Templates live in `templates/` and can be used in any `.liquid` files.
@@ -92,12 +96,11 @@ NOTE: Liquid is pretty strict about template filenames. They must match `^[a-zA-
 An object representing the current page. Properties:
 
 * `title` A titleized version of the filename (e.g. *My File* from *my-file.html*)
-* `url` URL path to the file (note that *index.html* stripped unless the `--local` option is used)
-* `path` Same as `url` except *index.html* is never stripped
+* `src_path` Path with the original filename (e.g. *foo/bar/zorp.md.liquid*)
+* `path` URL path relative to the relative root (e.g. *foo/bar/zorp.html*)
 * `dirname` Directory file is in (e.g. *foo/bar* from *foo/bar/zorp.html*)
 * `filename` Name of file (e.g. *zorp.html* from *foo/bar/zorp.html*)
 * `extname` File extension (e.g. *.html* from *foo/bar/zorp.html*)
-* `src_path` Path with the original filename (e.g. *foo/index.md.liquid*)
 
 ### files
 
@@ -105,14 +108,20 @@ Any array of all files that will be written `dist/`. Same properties as `page`.
 
 ## Liquid filters
 
-### relative_to
+### relative
 
-Modifies a path to be relative to another path. Useful in layouts and template that need to refer to another file.
+Modifies a path to be relative to the current file. Useful in layouts and template that need to refer to other files.
 
 ```html
-<script src="{{ "assets/main.js" | relative_to: page.path }}"</script>
+<script src="{{ "assets/main.js" | relative }}"</script>
 ```
 
+If the above HTML was in `a/b/c.html.liquid`, the script source would be `../../assets/main.js`.
+
+### strip_index
+
+Removes trailing `index.html`s from URLs, on the assumption that web servers will handle that. Can be disabled with the `--no-strip-index` option (useful for development builds).
+
 ### match
 
 Returns true if the string matches the regex.
@@ -135,6 +144,16 @@ puts "Yass!"
 
 Hightlight.js CSS and JS files with common languages are included by default with `yass init`. [Download](https://highlightjs.org/download) your own versions if you want different languages or themes.
 
+### render_content
+
+Renders a template, passing the block as a variable named `content`.
+
+```html
+{% render_content "my_template", other_var: "other var" %}
+<p>This will be passed to "my_template" as "content"</p>
+{% endrender_content %}
+```
+
 ## Legal
 
 MIT License. See LICENSE for details.

data/lib/yass/cli/helpers.rb

@@ -51,7 +51,7 @@ yass <command> [options] [path/to/dir]
   Options:
           ).strip
           opts.on("--clean", "Remove unknown files from dist/ when bulding") { config.clean = true }
-          opts.on("--local", "Build in local mode (with links to /index.html's)") { config.local = true }
+          opts.on("--no-strip-index", "Disable the strip_index Liquid filter") { config.strip_index = false }
           opts.on("--debug", "Print stack traces") { config.debug = true }
           opts.on("-h", "--help", "Prints this help") { config.stdout.puts opts; exit }
         }
@@ -65,7 +65,7 @@ yass <command> [options] [path/to/dir]
           templates: "templates",
           dest: "dist",
           clean: false,
-          local: false,
+          strip_index: true,
           stdin: $stdin,
           stdout: $stdout,
           stderr: $stderr,

data/lib/yass/cli/runner.rb

@@ -38,8 +38,11 @@ module Yass
         config.stdout.puts "Watching for changes..."
         watcher = Filewatcher.new([config.src_dir, config.layout_dir, config.template_dir].map(&:to_s))
         yield watcher if block_given?
+
+        Yass::CLI::Runner.build(config, argv: argv)
         watcher.watch do |changes|
           files = changes.map { |f, _| Pathname.new(f).relative_path_from(config.root).to_s }.reject { |f| Dir.exist? f }
+          # TODO use \r?
           config.stdout.puts "Building #{files.join ", "}"
           config.clear_cache!
           Yass::CLI::Runner.build(config, argv: argv)

data/lib/yass/config.rb

@@ -1,5 +1,5 @@
 module Yass
-  Config = Struct.new(:root, :src, :dest, :layouts, :templates, :clean, :local, :stdin, :stdout, :stderr, :debug, keyword_init: true) do
+  Config = Struct.new(:root, :src, :dest, :layouts, :templates, :clean, :strip_index, :stdin, :stdout, :stderr, :debug, keyword_init: true) do
     def src_dir = root.join src
     def dest_dir = root.join dest
     def template_dir = root.join templates
@@ -31,6 +31,7 @@ module Yass
         env.file_system = Liquid::LocalFileSystem.new(template_dir.to_s, "%s.liquid")
         env.register_filter LiquidFilters
         env.register_tag 'highlight', LiquidTags::Highlight
+        env.register_tag 'render_content', LiquidTags::RenderContent
       end
     end
   end

data/lib/yass/generator.rb

@@ -11,7 +11,7 @@ module Yass
     def generate!
       dest_dirs.each { |dir| FileUtils.mkdir_p dir }
       config.sources.each do |source|
-        outfile = config.dest_dir.join(source.relative_path)
+        outfile = config.dest_dir.join(source.src_path)
         if source.dynamic?
           outfile, content = generate(source, outfile)
           outfile.write content
@@ -30,7 +30,7 @@ module Yass
         content = Kramdown::Document.new(content).to_html
         return generate(source, outfile.sub(/\.md$/, ".html"), content)
       when ".liquid"
-        template = LiquidTemplate.compile(config, source.relative_path, content)
+        template = LiquidTemplate.compile(config, source.src_path, content)
         content = template.render(source)
         return generate(source, outfile.sub(/\.liquid$/, ""), content)
       else
@@ -47,8 +47,6 @@ module Yass
       (actual_files - expected_files).each { |f| FileUtils.rm f }
     end
 
-    def dest_dirs
-      config.sources.map { |s| config.dest_dir.join(s.relative_path).dirname }.uniq
-    end
+    def dest_dirs = config.sources.map { |s| s.outfile.dirname.to_s }.uniq
   end
 end

data/lib/yass/liquid_filters.rb

@@ -1,12 +1,23 @@
 module Yass
   module LiquidFilters
-    def relative_to(url, to)
-      url, to = Pathname.new(url), Pathname.new(to)
+    def relative(url)
+      url = Pathname.new(url)
+      to = context.registers[:source].dest_path
       in_root = to.dirname.to_s == "."
       updirs = in_root ? [] : to.dirname.to_s.split("/").map { ".." }
       Pathname.new([*updirs, url].join("/")).to_s
     end
 
+    def strip_index(url)
+      path = Pathname.new(url)
+      strip = path.basename.to_s == "index.html" && strip_index?
+      strip ? path.dirname.to_s : path.to_s
+    end
+
     def match(str, regex) = Regexp.new(regex).match? str
+
+    private
+
+    def strip_index? = context.registers[:source].config.strip_index
   end
 end

data/lib/yass/liquid_tags.rb

@@ -1,15 +1,23 @@
+require 'cgi'
+
 module Yass
   module LiquidTags
-    class Highlight < Liquid::Block
-      attr_reader :lang
-
-      def initialize(_tag_name, lang, _tokens)
-        super
-        @lang = lang.strip
+    # Works like `render`, but passes the block content to the template as a variable named `content`
+    class RenderContent < Liquid::Block
+      def render(context)
+        context.stack({}) do
+          context["block_content"] = super
+          r = Liquid::Render.parse("render", "#{@markup}, content: block_content", nil, @parse_context)
+          r.render_tag(context, +"")
+        end
       end
+    end
 
-      def render(_context)
-        %(<pre><code class="language-#{lang}">#{super}</code></pre>)
+    # Wraps the block content in HTML for Highlight.js
+    class Highlight < Liquid::Block
+      def render(context)
+        block = CGI.escapeHTML super.strip
+        %(<pre><code class="language-#{@markup.strip}">#{block}</code></pre>)
       end
     end
   end

data/lib/yass/liquid_template.rb

@@ -15,7 +15,7 @@ module Yass
     def render(source)
       vars = { "page" => file_attrs(source), "files" => files_attrs(source.config.sources) }
       vars["content"] = yield if block_given?
-      content = @template.render(vars, { strict_variables: true, strict_filters: true })
+      content = @template.render(vars, { strict_variables: true, strict_filters: true, registers: { source: source } })
       if @template.errors.any?
         source.config.stderr.puts "Errors found in #{name}:"
         source.config.stderr.puts @template.errors.map { |e| "  #{e}" }.join("\n")
@@ -28,12 +28,12 @@ module Yass
     def file_attrs(source)
       {
         "title" => source.title,
-        "url" => source.url.to_s,
         "path" => source.dest_path.to_s,
-        "src_path" => source.relative_path.to_s,
-        "dirname" => source.relative_path.dirname.to_s,
+        "src_path" => source.src_path.to_s,
+        "dirname" => source.dest_path.dirname.to_s,
         "filename" => source.dest_path.basename.to_s,
         "extname" => source.dest_path.basename.extname,
+        "filesize" => File.stat(source.path).size,
       }
     end
 

data/lib/yass/source.rb

@@ -1,29 +1,26 @@
 module Yass
   class Source
     EXT_CONVERSIONS = {"md" => "html"}.freeze
-    attr_reader :config, :path, :layout, :relative_path, :dest_path
+    attr_reader :config, :path, :layout, :src_path, :dest_path, :outfile
 
     def initialize(config, path)
       @config = config
       @path = path
-      @relative_path = path.relative_path_from config.src_dir
-      dest_filename, @layout= parse_name
-      @dest_path = relative_path.dirname.join(dest_filename)
+      @src_path = path.relative_path_from config.src_dir
+      dest_filename, @layout = parse_name
+      @dest_path = src_path.dirname.join(dest_filename)
+      @outfile = config.dest_dir.join(dest_path)
     end
 
-    def url = index? && !config.local ? dest_path.dirname : dest_path
-
     def title
       fname = dest_path.basename.sub(/\..+$/, "").to_s
-      fname = relative_path.dirname.basename.to_s if fname == "index"
+      fname = src_path.dirname.basename.to_s if fname == "index"
       fname = "Home" if fname == "."
       fname.sub(/[_-]+/, " ").split(/ +/).map(&:capitalize).join(" ")
     end
 
     def dynamic? = !!(/\.(liquid|md)(\..+)?$/ =~ path.basename.to_s || layout)
 
-    def index? = dest_path.basename.to_s == "index.html"
-
     private
 
     def parse_name

data/lib/yass/version.rb

@@ -1,3 +1,3 @@
 module Yass
-  VERSION = "0.3.0".freeze
+  VERSION = "0.5.0".freeze
 end

data/site-template/layouts/default.html.liquid

@@ -4,8 +4,7 @@
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <title>{{ page.title }}</title>
-    {% render "css_links", files: files, page: page %}
-    {% render "js_scripts", files: files, page: page %}
+    {% render "asset_tags", files: files, page: page %}
   </head>
   <body>
 {{ content }}

data/site-template/site/assets/highlight.min.css

@@ -0,0 +1,9 @@
+/*!
+  Theme: Default
+  Description: Original highlight.js style
+  Author: (c) Ivan Sagalaev <maniac@softwaremaniacs.org>
+  Maintainer: @highlightjs/core-team
+  Website: https://highlightjs.org/
+  License: see project LICENSE
+  Touched: 2021
+*/pre code.hljs{display:block;overflow-x:auto;padding:1em}code.hljs{padding:3px 5px}.hljs{background:#f3f3f3;color:#444}.hljs-comment{color:#697070}.hljs-punctuation,.hljs-tag{color:#444a}.hljs-tag .hljs-attr,.hljs-tag .hljs-name{color:#444}.hljs-attribute,.hljs-doctag,.hljs-keyword,.hljs-meta .hljs-keyword,.hljs-name,.hljs-selector-tag{font-weight:700}.hljs-deletion,.hljs-number,.hljs-quote,.hljs-selector-class,.hljs-selector-id,.hljs-string,.hljs-template-tag,.hljs-type{color:#800}.hljs-section,.hljs-title{color:#800;font-weight:700}.hljs-link,.hljs-operator,.hljs-regexp,.hljs-selector-attr,.hljs-selector-pseudo,.hljs-symbol,.hljs-template-variable,.hljs-variable{color:#ab5656}.hljs-literal{color:#695}.hljs-addition,.hljs-built_in,.hljs-bullet,.hljs-code{color:#397300}.hljs-meta{color:#1f7199}.hljs-meta .hljs-string{color:#38a}.hljs-emphasis{font-style:italic}.hljs-strong{font-weight:700}

data/site-template/templates/asset_tags.liquid

@@ -0,0 +1,9 @@
+{% assign css_files = files | where: "extname", ".css" -%}
+{% for file in css_files %}
+    <link rel="stylesheet" href="{{ file.path | relative }}">
+{% endfor %}
+
+{% assign js_files = files | where: "extname", ".js" -%}
+{% for file in js_files %}
+    <script src="{{ file.path | relative }}"></script>
+{% endfor %}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yass
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jordan Hollinger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-09 00:00:00.000000000 Z
+date: 2025-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: filewatcher
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: A dead-simple static site generator
+description: Yet Another Static Site (generator)
 email: jordan.hollinger@gmail.com
 executables:
 - yass
@@ -73,11 +73,10 @@ files:
 - lib/yass/source.rb
 - lib/yass/version.rb
 - site-template/layouts/default.html.liquid
-- site-template/site/assets/highlight-default.css
+- site-template/site/assets/highlight.min.css
 - site-template/site/assets/highlight.min.js
 - site-template/site/index.html.liquid
-- site-template/templates/css_links.liquid
-- site-template/templates/js_scripts.liquid
+- site-template/templates/asset_tags.liquid
 homepage: https://github.com/jhollinger/yass/
 licenses:
 - MIT
@@ -102,5 +101,5 @@ requirements: []
 rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
-summary: Yet Another Static Site (generator)
+summary: An astonishingly un-opinionated static site generator
 test_files: []

data/site-template/site/assets/highlight-default.css

@@ -1,117 +0,0 @@
-pre code.hljs {
-  display: block;
-  overflow-x: auto;
-  padding: 1em
-}
-code.hljs {
-  padding: 3px 5px
-}
-/*!
-  Theme: Default
-  Description: Original highlight.js style
-  Author: (c) Ivan Sagalaev <maniac@softwaremaniacs.org>
-  Maintainer: @highlightjs/core-team
-  Website: https://highlightjs.org/
-  License: see project LICENSE
-  Touched: 2021
-*/
-/*
-This is left on purpose making default.css the single file that can be lifted
-as-is from the repository directly without the need for a build step
-
-Typically this "required" baseline CSS is added by `makestuff.js` during build.
-*/
-pre code.hljs {
-  display: block;
-  overflow-x: auto;
-  padding: 1em
-}
-code.hljs {
-  padding: 3px 5px
-}
-/* end baseline CSS */
-.hljs {
-  background: #F3F3F3;
-  color: #444
-}
-/* Base color: saturation 0; */
-.hljs-subst {
-  /* default */
-  
-}
-/* purposely ignored */
-.hljs-formula,
-.hljs-attr,
-.hljs-property,
-.hljs-params {
-  
-}
-.hljs-comment {
-  color: #697070
-}
-.hljs-tag,
-.hljs-punctuation {
-  color: #444a
-}
-.hljs-tag .hljs-name,
-.hljs-tag .hljs-attr {
-  color: #444
-}
-.hljs-keyword,
-.hljs-attribute,
-.hljs-selector-tag,
-.hljs-meta .hljs-keyword,
-.hljs-doctag,
-.hljs-name {
-  font-weight: bold
-}
-/* User color: hue: 0 */
-.hljs-type,
-.hljs-string,
-.hljs-number,
-.hljs-selector-id,
-.hljs-selector-class,
-.hljs-quote,
-.hljs-template-tag,
-.hljs-deletion {
-  color: #880000
-}
-.hljs-title,
-.hljs-section {
-  color: #880000;
-  font-weight: bold
-}
-.hljs-regexp,
-.hljs-symbol,
-.hljs-variable,
-.hljs-template-variable,
-.hljs-link,
-.hljs-selector-attr,
-.hljs-operator,
-.hljs-selector-pseudo {
-  color: #ab5656
-}
-/* Language color: hue: 90; */
-.hljs-literal {
-  color: #695
-}
-.hljs-built_in,
-.hljs-bullet,
-.hljs-code,
-.hljs-addition {
-  color: #397300
-}
-/* Meta color: hue: 200 */
-.hljs-meta {
-  color: #1f7199
-}
-.hljs-meta .hljs-string {
-  color: #38a
-}
-/* Misc effects */
-.hljs-emphasis {
-  font-style: italic
-}
-.hljs-strong {
-  font-weight: bold
-}

data/site-template/templates/css_links.liquid

@@ -1,4 +0,0 @@
-{% assign css_files = files | where: "extname", ".css" -%}
-{% for file in css_files %}
-    <link rel="stylesheet" href="{{ file.url | relative_to: page.url }}">
-{% endfor %}

data/site-template/templates/js_scripts.liquid

@@ -1,4 +0,0 @@
-{% assign js_files = files | where: "extname", ".js" -%}
-{% for file in js_files %}
-    <script src="{{ file.url | relative_to: page.url }}"></script>
-{% endfor %}