yass 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 649645d7b796ba02544a816464ff18efb5fdac5c3e914f16ce39ebde71337a37
-  data.tar.gz: e6e2268d8733f20efb0f03f7b29c2a5a58e8e0deac5a0a4d796db3ca2ae78971
+  metadata.gz: 56e665858452753381b536e074b6274703fd300fa17d632db1c5ff483200534f
+  data.tar.gz: bf41608fb07a38904412bc128a3c02a5cb5688798bb3f60402f905c553b601f6
 SHA512:
-  metadata.gz: e0eae7b97dbf4cc49a7e37812f867d0734e249058f560e58067be91d69abd4c2ce3e3a4e37eb5203555bc2135fc958a7c30c80cac67e1cd6c0551e44548c0c10
-  data.tar.gz: df0d5bf462455417fed28d9725fee69bba326284e20e57532fb6a27a142363e8c91d4f670735f71d72a82a670dd2ec1a67d468829d043ef82304f336701b2690
+  metadata.gz: 1f9cd5d5c10817e729ba035c31af5afed41c5db07311b186226d48a698f8d72ee06844363fda9a1abc9e8942a07684ace5c6a6ed43404492d26b99041c6439ba
+  data.tar.gz: 24708d754b8835a1c86b5d004343cba13e6c166dfd6a1565ff4092924c31d140ff7a43db338ae07e7870c14475a524e05b37a0bbe481f079a98cc94ac1de7899

data/README.md

@@ -32,16 +32,16 @@ The built site will be placed into `dist`.
 yass build
 ```
 
-NOTE If you're building for webserverless, local viewing, and using the `skip_index` filter anywhere, use the `--no-skip-index` option.
+NOTE If you're building for webserverless, local viewing, and using the `strip_index` filter anywhere, use the `--no-strip-index` option.
 
 ```bash
-yass build --no-skip-index
+yass build --no-strip-index
 ```
 
 Use the `watch` command to continually build your site as files change.
 
 ```bash
-yass watch # also supports --no-skip-index
+yass watch # also supports --no-strip-index
 ```
 
 ## License

data/docs-src/site/helpers/index.md.liquid

@@ -16,6 +16,7 @@ An object representing the current page. Properties:
 * `filename` Name of file (e.g. *zorp.html* from *foo/bar/zorp.html*)
 * `extname` File extension (e.g. *.html* from *foo/bar/zorp.html*)
 * `filesize` Size of file in bytes
+* `published` If the file is published or not
 * Any other value defined in the file's YAML front matter
 
 {% highlight html %}
@@ -24,7 +25,7 @@ An object representing the current page. Properties:
 
 ### files
 
-Any array of all files that will be written `dist/`. Same properties as `page`.
+Any array of all (published) files that will be written `dist/`. Same properties as `page`.
 
 {% highlight html %}
 {% echo '{% assign css_files = files | where: "extname", ".css" %' %}}
@@ -69,6 +70,14 @@ Works like Liquid's built-it `where`, but accepts a regular expression.
 {% echo '{% assign posts = where_match: "path", "^posts/.+\.html$" %' %}}
 {% endhighlight %}
 
+### where_not
+
+Works like Liquid's built-it `where`, but returns object that *don't* match.
+
+{% highlight %}
+{% echo '{% assign posts = where_not: "hidden", true %' %}}
+{% endhighlight %}
+
 ## Tags
 
 ### highlight

data/docs-src/site/index.md.liquid

@@ -3,7 +3,7 @@ layout: splash
 ---
 # What is Yass?
 
-Yass is an astonishingly un-opinionated static site generator. Your sites's structure is entirely up to you: organize static assets, `.html` files, `.md` ([Markdown](https://commonmark.org/)) files, and `.liquid` ([Liquid](https://shopify.github.io/liquid/)) templates however you want under `site/`. Liquid layouts, reusable templates, and YAML front matter are supported.
+Yass is an astonishingly un-opinionated static site generator. Your sites's structure is entirely up to you: organize static assets, `.html` files, `.md` ([Markdown](https://github.github.com/gfm/)) files, and `.liquid` ([Liquid](https://shopify.github.io/liquid/)) templates however you want under `site/`. Liquid layouts, reusable templates, and YAML front matter are supported.
 
 The **one** opinion Yass holds is that **you** should decide everything. There's zero configuration and no conventions to learn!
 
@@ -43,18 +43,20 @@ $ yass build
 
 To preview your site on your computer, simply open `dist/index.html` with your browser 🤯. (This requires using relative links, but there are helpers for that.)
 
-If you're building for webserverless, local viewing, and using the `skip_index` filter anywhere, use the `--no-skip-index` option.
+If you're building for webserverless, local viewing, and using the `strip_index` filter anywhere, use the `--no-strip-index` option.
 
 {% highlight bash %}
-$ yass build --no-skip-index
+$ yass build --no-strip-index
 {% endhighlight %}
 
 The `watch` command will continuously build as you make changes in `site/`, `layouts/`, and `templates/`.
 
 {% highlight bash %}
-$ yass watch # --no-skip-index works here too
+$ yass watch # --no-strip-index works here too
 {% endhighlight %}
 
+Run `yass --help` for all options.
+
 ## Interested?
 
 Keep reading about [layouts, templates]({{ "layouts-templates/index.html" | relative | strip_index }}), and [helpers]({{ "helpers/index.html" | relative | strip_index }}), or check out the code on [Github](https://github.com/jhollinger/yass)!

data/docs-src/site/layouts-templates/index.md.liquid

@@ -1,14 +1,22 @@
 # Front Matter
 
-Any file under `site/` may prepend YAML front matter to override the auto-generated title, set a layout, or set arbitrary attributes on the page for use in Liquid.
+Any file under `site/` may prepend YAML front matter to tweak how that file is rendered. All fields are optional.
 
 {% highlight yaml %}
 ---
+# The default title is based on the filename
 title: My Title
-layout: foo
+# Override the default layout, or disable the layout with false
+layout: home
+# If this file isn't ready yet, set to false
+published: true
+
+# Arbitrary values will be available on `page` and `files`
 my_val: bar
 ---
-# File contents go here
+<!DOCTYPE html>
+<html lang="en">
+...
 {% endhighlight %}
 
 # Layouts

data/lib/yass/cli/helpers.rb

@@ -49,6 +49,7 @@ yass <command> [path/to/dir] [options]
           ).strip
           opts.on("--clean", "Remove unknown files from dist/ when bulding") { config.clean = true }
           opts.on("--dest=DIR", "Build to a different directory") { |dir| config.dest = find_path(dir, cwd: Dir.pwd) }
+          opts.on("--drafts", "Include unpublished files in build") { config.include_drafts = 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 }
@@ -63,6 +64,7 @@ yass <command> [path/to/dir] [options]
           templates: "templates",
           dest: "dist",
           clean: false,
+          include_drafts: false,
           strip_index: true,
           stdin: $stdin,
           stdout: $stdout,

data/lib/yass/config.rb

@@ -1,5 +1,5 @@
 module Yass
-  Config = Struct.new(:cwd, :src, :dest, :layouts, :templates, :clean, :strip_index, :stdin, :stdout, :stderr, :debug, keyword_init: true) do
+  Config = Struct.new(:cwd, :src, :dest, :layouts, :templates, :clean, :include_drafts, :strip_index, :stdin, :stdout, :stderr, :debug, keyword_init: true) do
     def src_dir = @src_dir ||= get_dir(src)
     def dest_dir = @dest_dir ||= get_dir(dest)
     def template_dir = @template_dir ||= get_dir(templates)
@@ -23,6 +23,7 @@ module Yass
         .reject { |path| Dir.exist? path }
         .map { |path| Pathname.new path }
         .map { |path| Source.new(self, path) }
+        .select { |source| source.published? || include_drafts }
     end
 
     def liquid_env

data/lib/yass/generator.rb

@@ -27,7 +27,7 @@ module Yass
     def generate(source, outfile, content = source.content)
       case outfile.extname
       when ".md"
-        content = Kramdown::Document.new(content).to_html
+        content = Kramdown::Document.new(content, input: "GFM").to_html
         return generate(source, outfile.sub(/\.md$/, ".html"), content)
       when ".liquid"
         template = LiquidTemplate.compile(config, source.src_path, content)

data/lib/yass/liquid_filters.rb

@@ -9,9 +9,8 @@ module Yass
     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
+      path = strip_index? ? url.sub(%r'/?index\.html([\?#][^/]*)?$', '\1') : url
+      path == "" ? "." : path
     end
 
     def match(str, regex) = Regexp.new(regex).match? str
@@ -21,6 +20,8 @@ module Yass
       objects.select { |obj| regex =~ obj[field].to_s }
     end
 
+    def where_not(objects, field, value) = objects.reject { |obj| obj[field] == value }
+
     private
 
     def strip_index? = context.registers[:source].config.strip_index

data/lib/yass/liquid_template.rb

@@ -37,6 +37,7 @@ module Yass
         "filename" => source.dest_path.basename.to_s,
         "extname" => source.dest_path.basename.extname,
         "filesize" => source.size,
+        "published" => source.published?,
       })
     end
 

data/lib/yass/source.rb

@@ -17,8 +17,8 @@ module Yass
       @size = File.stat(path).size
 
       @front_matter, @content = parse_content
-      @title = @front_matter.delete "title" if front_matter.key? "title"
-      @layout_name = @front_matter.delete "layout" if front_matter.key? "layout"
+      @title = front_matter.delete "title" if front_matter.key? "title"
+      @layout_name = front_matter.delete "layout" if front_matter.key? "layout"
     end
 
     def layout
@@ -41,6 +41,8 @@ module Yass
 
     def content = @content ||= path.read
 
+    def published? = front_matter["published"].nil? ? true : !!front_matter["published"]
+
     private
 
     def dest_filename

data/lib/yass/version.rb

@@ -1,3 +1,3 @@
 module Yass
-  VERSION = "0.7.0".freeze
+  VERSION = "0.8.0".freeze
 end

data/lib/yass.rb

@@ -1,7 +1,8 @@
 require 'pathname'
 require 'filewatcher'
+require 'liquid' # MUST be loaded before kramdown-parser-gfm for some reason
 require 'kramdown'
-require 'liquid'
+require 'kramdown-parser-gfm'
 
 module Yass
   autoload :CLI, 'yass/cli'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yass
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Jordan Hollinger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-13 00:00:00.000000000 Z
+date: 2025-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: filewatcher
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: kramdown-parser-gfm
+  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: liquid
   requirement: !ruby/object:Gem::Requirement