foresite 1.1.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 495db3b9b94366d4ec2ee21650912ce9f545ccab88a5206aebf49e6cb08cfee8
-  data.tar.gz: 1712e43ee2800c9158fb54879423693b5f764e0f7ad53565ebff9151c76e322d
+  metadata.gz: 31f026a8d80bce2b57fbe4b909cb3c6490ca50debf834de0636c7b713749fe83
+  data.tar.gz: 0b450e5e2639cb57ece5ae26810c8b467a6d91bc269ffcb1f96bb4e2f18fd716
 SHA512:
-  metadata.gz: 3079e9d70d3d1020d209251caeb1bc85b6a286d9db03bb9a29a8abfaecdbb0522f815b8680ceab129a4247388dfe2d5d8326c275f975c3b1608b83fea18b1f6d
-  data.tar.gz: e5263d34aea71db355288285d168e607fbfe30415bbc19b5eb2679bddbf48ebc255118e58b8c7bfa13ea2f1fbf24bca4e3c5136a4c62e4bbdd7d9e8e71c085fa
+  metadata.gz: 5ab2348a5bb8eb90c0707a4ace0921e586a15d7d2838d72f4841fe39165a3912c129593ca4b5075dde9b62ad94a114cf4170865fb89781d2c3ec8f40d24b4c16
+  data.tar.gz: 543c72aad677e681b17b12eae7c43a927fbe1417b98c1cf0838fc9f9b343e55ae3730308ce679cf522cf698bedc8c3cddbb56a67f713355af1768b55d54566f0

data/README.md

@@ -77,7 +77,7 @@ Some facts:
 
 `post.md.erb` is used to when running `foresite touch` for the default markdown content. It has two variables, `@title` for the post title and `@date_ymd` for the created date in ISO 8601 `YYYY-MM-DD` format. Modify to have different defaults when running `foresite touch`.
 
-`wrapper.html.erb` wraps all of your markdown. Its sole variable `@content` will be a given post's HTML (converted from markdown). For the `index.html` file, `@content` will be an list of links to all posts in reverse-chronological order. Modify to have different overall page structure, or to add `<style>` etc.
+`wrapper.html.erb` wraps all of your markdown. It has two variables, `@title` for the post title that will populate the `<title>` tag, and `@content` for a given post's HTML (converted from markdown). For the `index.html` file, `@title` will be `nil`, and `@content` will be an list of links to all posts in reverse-chronological order. Modify to have different overall page structure, or to add `<style>` etc.
 
 `_list.html.erb` is used to generate the `<ul>` list of posts on the `index.html` file. Modify to show posts in a different way.
 
@@ -103,10 +103,14 @@ In this example, the `index.html` will contain:
 
 ```html
 <ul>
-  <li>2023-01-15 <a href="2023-01-15-welcome-to-my-site.html">Welcome to my site</a></li>
+  <li>2023-01-15 <a href="post/2023-01-15-welcome-to-my-site.html">Welcome to my site</a></li>
 </ul>
 ```
 
+### 5. Watch files and build automatically
+
+Run `foresite watch` to detect changes to markdown or ERB files, build will run automatically. Useful for previewing content locally.
+
 ## Development
 
 1. Clone
@@ -123,6 +127,8 @@ Bug reports and pull requests are welcome. The goals of Foresite are:
 * Simple to use & understand
 * Minimal features
 
+Read more in the [blog post introducing Foresite](https://carlwiedemann.github.io/post/2023-01-17-introducing-foresite.html)
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/foresite/cli.rb

@@ -12,6 +12,11 @@ module Foresite
       true
     end
 
+    desc "version", "Displays version"
+    def version
+      $stdout.puts(Foresite::VERSION)
+    end
+
     desc "init", "Initializes foresite in current directory"
     long_desc <<-LONGDESC
       Initializes foresite in the current directory.
@@ -93,11 +98,12 @@ module Foresite
 
       links = markdown_paths.map do |markdown_path|
         markdown_content = File.read(markdown_path)
+        title = markdown_content.split("\n").first { |line| /^# [a-z]/i =~ line }.gsub(/^#/, "").strip
 
         filename_markdown = File.basename(markdown_path)
         html_path = Foresite.get_path_to_out_file(filename_markdown.gsub(/\.md$/, ".html"))
 
-        File.write(html_path, Foresite.render_wrapped(markdown_content))
+        File.write(html_path, Foresite.render_wrapped(title, markdown_content))
         $stdout.puts("Created #{Foresite.relative_path(html_path)}")
 
         # Extract date if it exists.
@@ -106,7 +112,7 @@ module Foresite
         {
           date_ymd: match_data.nil? ? "" : match_data[0],
           href: Foresite.relative_path(html_path),
-          title: markdown_content.split("\n").first { |line| /^# [a-z]/i =~ line }.gsub(/^#/, "").strip
+          title: title
         }
       end
 
@@ -116,5 +122,28 @@ module Foresite
 
       $stdout.puts("Created #{Foresite.relative_path(index_html_path)}")
     end
+
+    desc "watch", "Watches markdown and templates files and runs `build` when they change"
+    long_desc <<-LONGDESC
+      See `build` help for more information
+    LONGDESC
+
+    # @todo How might we test this?
+    def watch
+      dirs_to_watch = [
+        Foresite::DIRNAME_MARKDOWN,
+        Foresite::DIRNAME_ERB
+      ]
+
+      $stdout.puts("Watching #{dirs_to_watch.map { "./#{_1}" }.join(", ")} for changes... (Ctrl+C to exit)")
+
+      Filewatcher.new(dirs_to_watch).watch do |changes|
+        changes.each do |filename, event|
+          $stdout.puts("#{File.basename(filename)} #{event}")
+        end
+
+        build
+      end
+    end
   end
 end

data/lib/foresite/renderer.rb

@@ -14,7 +14,7 @@ module Foresite
       @path = path
       vars.each do |k, v|
         if k.is_a?(Symbol)
-          instance_variable_set("@#{k}".to_sym, v)
+          instance_variable_set(:"@#{k}", v)
         end
       end
     end

data/lib/foresite/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Foresite
-  VERSION = "1.1.3"
+  VERSION = "1.3.0"
 end

data/lib/foresite.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
 require "erb"
-require "thor"
+require "filewatcher"
 require "kramdown"
+require "thor"
 require "zeitwerk"
 
 loader = Zeitwerk::Loader.for_gem
@@ -82,8 +83,9 @@ module Foresite
     })
   end
 
-  def self.render_wrapped(markdown_content)
+  def self.render_wrapped(title, markdown_content)
     render_erb_file(FILENAME_WRAPPER_HTML, {
+      title: title,
       content: ::Kramdown::Document.new(markdown_content).to_html
     })
   end

data/lib/skeleton/wrapper.html.erb

@@ -1,8 +1,11 @@
+<%
+  index_title = 'Another Foresite Blog'
+-%>
 <!DOCTYPE html>
 <html lang="en">
 <head>
   <meta charset="utf-8">
-  <title>Another Foresite Blog</title>
+  <title><%= @title ? "#{@title} - #{index_title}" : index_title %></title>
   <style></style>
 </head>
 <body>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foresite
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.3.0
 platform: ruby
 authors:
 - Carl Wiedemann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-17 00:00:00.000000000 Z
+date: 2024-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: filewatcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement