foresite 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f29318fc927950483a0152c49fe8e735c37ff973b4d149a51b6ce005f7f6207
-  data.tar.gz: 152396f93cb282709e9f455429a4ecaf079a4e3ba7fdb7386e18297998d359df
+  metadata.gz: 3d09961b909cc4ea9534a3110ad0dd8466c2155ba43485d4b8be8169f8089f0c
+  data.tar.gz: fb0b3d20ce4aa5d43f9c8cd120d4e4297a6af7c7ba218b57572183e7b77366df
 SHA512:
-  metadata.gz: f78b29800c68377c4d92c8da49c75cae51ae1a991b8a596bfede5e40fc2d4e592f9c07fe9f9e7d34799f87cf00648be7654cfc0bf9118ad6c9f9901615aee549
-  data.tar.gz: 5b5c3d8d13eabca810587354b17a16ac01573548f89436b3a91bd0f3b16a25a4165c42302d3684665804f8c714fe25cd8adc35b03fb16fb4b80fd96d58a6dc9c
+  metadata.gz: 0a15d6e41db517b1c78e5bd114fbc0b82ecb36b96455e52e3a327d6e6a4239f9a3ca8bfc29fc804bec753a09405609e528dfa3ab0ca4215664163a9a6465147a
+  data.tar.gz: a8d7974d9b99e3818d4c7597ebe80e2fe1241ae8e13c27cea06c420adba44fa06646a44a6da823ef854c43b3ac492c2e8eadf32c8f8a9835440f23d3db9a3e2d

data/README.md

@@ -41,6 +41,7 @@ Create a project directory for your site and run `foresite init` from within it:
     Created erb/post.md.erb
     Created erb/wrapper.html.erb
     Created erb/_list.html.erb
+    Created erb/feed.xml.erb
 
 Three subdirectories are created, along with three [ERB](https://docs.ruby-lang.org/en/3.2/ERB.html) template files.
 
@@ -52,6 +53,7 @@ Some facts:
   * `post.md.erb` is the default markdown file for every post.
   * `wrapper.html.erb` is a HTML wrapper template for every generated HTML file.
   * `_list.html.erb` is a HTML template partial for the list of posts on the `index.html` page.
+  * `feed.xml.erb` is a XML template for an RSS feed.
 
 ### 2. Write your first post
 
@@ -69,8 +71,8 @@ A single markdown file is created in the `md` subdirectory. **This file is meant
 
 Some facts:
 
-* The title is the first line formatted as H1 (mandatory).
-* Current date in YYYY-MM-DD format is the first markdown paragraph (optional).
+* The title is the first line formatted as H1.
+* Current date in YYYY-MM-DD format is the first markdown paragraph.
 * Current date and title are "slugified" for filename.
 
 ### 3. Modify templates as desired
@@ -81,6 +83,8 @@ Some facts:
 
 `_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.
 
+`feed.xml.erb` is an RSS feed, it will require a `title` as well as a `base_url` for where you host your site.
+
 ### 4. Generate HTML from markdown
 
 Run `foresite build` to create HTML in the `post` subdirectory and the `index.html` file:
@@ -88,8 +92,9 @@ Run `foresite build` to create HTML in the `post` subdirectory and the `index.ht
     $ foresite build
     Created post/2023-01-15-welcome-to-my-site.html
     Created index.html
+    Created feed.xml
 
-In this example, two HTML files are created.
+In this example, two HTML files and an XML file are created.
 
 Some facts:
 
@@ -97,7 +102,8 @@ Some facts:
 * A single `index.html` file shows a list of links to all posts in reverse-chronological order, prefixed with post date.
   * Post titles are parsed from the first H1 tag in each post markdown file.
   * Post dates are parsed from the post markdown filename.
-* Re-running `foresite build` removes and recreates all HTML files in the `post` subdirectory as well as the `index.html` file.
+* The `feed.xml` file reflects the list posts in RSS 2.0 format.
+* Re-running `foresite build` removes and recreates all HTML files in the `post` subdirectory as well as the `index.html` file and `feed.xml` file.
 
 In this example, the `index.html` will contain:
 
@@ -107,6 +113,10 @@ In this example, the `index.html` will contain:
 </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

data/lib/foresite/cli.rb

@@ -1,3 +1,5 @@
+require "date"
+
 module Foresite
   ##
   # Cli class.
@@ -12,6 +14,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.
@@ -83,6 +90,7 @@ module Foresite
       # Wipe all output files.
       Dir.glob(File.join(Foresite.get_path_to_out, "*.html")).each { File.delete(_1) }
       File.delete(Foresite.get_path_to_index_file) if File.exist?(Foresite.get_path_to_index_file)
+      File.delete(Foresite.get_path_to_feed_file) if File.exist?(Foresite.get_path_to_feed_file)
 
       markdown_paths = Dir.glob(File.join(Foresite.get_path_to_md, "*.md"))
 
@@ -101,11 +109,14 @@ module Foresite
         File.write(html_path, Foresite.render_wrapped(title, markdown_content))
         $stdout.puts("Created #{Foresite.relative_path(html_path)}")
 
-        # Extract date if it exists.
+        # Extract date.
         match_data = /\d{4}-\d{2}-\d{2}/.match(filename_markdown)
+        date_ymd = match_data[0]
+        date_822 = DateTime.strptime(date_ymd, "%F").strftime("%a, %d %b %Y %H:%M:%S %z")
 
         {
-          date_ymd: match_data.nil? ? "" : match_data[0],
+          date_ymd: date_ymd,
+          date_822: date_822,
           href: Foresite.relative_path(html_path),
           title: title
         }
@@ -114,8 +125,34 @@ module Foresite
       # Generate index file.
       index_html_path = Foresite.get_path_to_index_file
       File.write(index_html_path, Foresite.render_wrapped_index(links))
-
       $stdout.puts("Created #{Foresite.relative_path(index_html_path)}")
+
+      feed_xml_path = Foresite.get_path_to_feed_file
+      File.write(feed_xml_path, Foresite.render_feed(links, links.last[:date_822]))
+      $stdout.puts("Created #{Foresite.relative_path(feed_xml_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

@@ -12,9 +12,10 @@ module Foresite
     # @param [Hash] vars Variables for template.
     def initialize(path, vars)
       @path = path
+      @vars_original = @vars
       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.2.0"
+  VERSION = "1.4.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
@@ -16,6 +17,7 @@ module Foresite
   FILENAME_POST_MD = "post.md.erb"
   FILENAME_WRAPPER_HTML = "wrapper.html.erb"
   FILENAME_LIST_HTML = "_list.html.erb"
+  FILENAME_FEED_XML = "feed.xml.erb"
 
   ENV_ROOT = "FORESITE_ROOT"
 
@@ -67,6 +69,10 @@ module Foresite
     File.join(get_path_to_root, "index.html")
   end
 
+  def self.get_path_to_feed_file
+    File.join(get_path_to_root, "feed.xml")
+  end
+
   def self.relative_path(full_path)
     full_path.gsub(get_path_to_root, "").gsub(Regexp.new("^#{File::SEPARATOR}"), "")
   end
@@ -97,6 +103,13 @@ module Foresite
     })
   end
 
+  def self.render_feed(items, date_build_822)
+    render_erb_file(FILENAME_FEED_XML, {
+      items: items.reverse,
+      date_build_822: date_build_822
+    })
+  end
+
   def self.touch_directories
     [get_path_to_md, get_path_to_out, get_path_to_erb].map do |path|
       if Dir.exist?(path)
@@ -109,7 +122,7 @@ module Foresite
   end
 
   def self.copy_templates
-    [FILENAME_POST_MD, FILENAME_WRAPPER_HTML, FILENAME_LIST_HTML].map do |filename|
+    [FILENAME_POST_MD, FILENAME_WRAPPER_HTML, FILENAME_LIST_HTML, FILENAME_FEED_XML].map do |filename|
       full_file_path = File.join(get_path_to_erb, filename)
       if File.exist?(full_file_path)
         "#{relative_path(full_file_path)} already exists"

data/lib/skeleton/feed.xml.erb

@@ -0,0 +1,23 @@
+<%
+  title = 'Another Foresite Blog'
+  base_url = 'https://example.com'
+-%>
+<rss xmlns:atom="http://www.w3.org/2005/Atom" version="2.0">
+  <channel>
+    <title><%= title %></title>
+    <link><%= base_url %>/feed.xml</link>
+    <language>en-us</language>
+    <pubDate><%= @date_build_822 %></pubDate>
+    <lastBuildDate><%= @date_build_822 %></lastBuildDate>
+    <generator>Foresite</generator>
+    <atom:link href="<%= base_url %>/feed.xml" rel="self" type="application/rss+xml"/>
+    <% @items.each do |item| -%>
+<item>
+  <title><%= item[:title] %></title>
+  <link><%= "#{base_url}/#{item[:href]}" %></link>
+  <guid><%= "#{base_url}/#{item[:href]}" %></guid>
+  <pubDate><%= item[:date_822] %></pubDate>
+</item>
+    <%- end %>
+  </channel>
+</rss>

data/lib/skeleton/wrapper.html.erb

@@ -6,6 +6,7 @@
 <head>
   <meta charset="utf-8">
   <title><%= @title ? "#{@title} - #{index_title}" : index_title %></title>
+  <link rel="alternate" type="application/rss+xml" title="<%= index_title %>" href="/feed.xml">
   <style></style>
 </head>
 <body>

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: foresite
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Carl Wiedemann
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -16,70 +15,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.7'
+- !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
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.13'
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.50'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.50'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -94,7 +107,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13'
-description:
 email:
 - carl.wiedemann@gmail.com
 executables:
@@ -111,6 +123,7 @@ files:
 - lib/foresite/renderer.rb
 - lib/foresite/version.rb
 - lib/skeleton/_list.html.erb
+- lib/skeleton/feed.xml.erb
 - lib/skeleton/post.md.erb
 - lib/skeleton/wrapper.html.erb
 homepage: https://github.com/carlwiedemann/foresite
@@ -120,7 +133,6 @@ metadata:
   homepage_uri: https://github.com/carlwiedemann/foresite
   source_code_uri: https://github.com/carlwiedemann/foresite
   changelog_uri: https://github.com/carlwiedemann/foresite/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -128,15 +140,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.3
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: An extremely minimal static site generator.
 test_files: []