zine 0.13.0 → 0.16.0

data/README.md

@@ -2,38 +2,34 @@
 
 [![Gem Version](https://badge.fury.io/rb/zine.svg)](https://badge.fury.io/rb/zine)
 
-Yet another blog aware static site generator.
-
-## Why yet another static blog engine?
-
-Despite the [proliferation in these things][engine_list] (!) I still find it more comfortable to use my own tools.
+Zine is an open source, command line, blog-aware, static website generator.
 
 Distinguishing features include:
 
 - ERB templates
 - Sass stylesheets
 - fast incremental builds
-- GitHub & SFTP file uploads
+- a choice of AWS S3, GitHub & SFTP file uploaders
 
-Presented here in the hope it's of use to someone else too.
+## How do I get it?
 
-## Installation
+Zine is a Ruby Gem, so if you have Ruby on your machine (it comes installed standard on a Mac), open Terminal & type
 
-Install the gem.
+````bash
+gem install zine
+````
 
-```shell
-$ gem install zine
-```
+And you're away.
 
-To generate a new site scaffold, cd to a new folder and:
+To generate a new scaffold site, cd to a new directory and:
 
 ```shell
 $ zine site
 ```
 
-Then update your site's name, your name & so on in zine.yaml. Pay particular care to the Upload section, if you want to use Zine as an SFTP uploader to deploy files that've changed, you'll need to edit this section to include your remote server's details, as well as the path to a YAML file with your username & password (nil for that if you're using SSH without a password).
+Then update your site's name, your name & so on in zine.yaml. Pay particular care to the Upload section, if you want to use Zine to deploy files you've changed, you'll need to edit this section to include your remote server's details, including the path to a YAML file with your credentials.
 
-## Day to day usage
+## Day to day use
 
 To set up a new blog post:
 
@@ -41,15 +37,25 @@ To set up a new blog post:
 $ zine post 'Your chosen title'
 ```
 
-Your new post will have some fields set up in the YAML front matter, feel free to edit them too. Markdown files you create outside of the posts folder will be rendered into HTML in the same relative position in the build folder.
+Your new post will have some fields set up in the YAML front matter, feel free to edit them too.
+
+You can also create other Markdown files outside of the posts folder, those will be rendered into HTML in the same relative position in the build folder. That's how the project, about etc pages on my site are made for example.
 
-Once you're done writing, build your new site:
+Type zine build before you start writing to serve up a local copy of your site that you can refresh to see what the build version will look like.
 
 ```shell
-$ zine build # or zine force
+$ zine build
 ```
 
-Build only writes files for things that have changed while it's running, so the first time you build your site you should use force -- force writes all of the files (& so also uploads them all too if you've set up uploads).
+or
+
+```shell
+$ zine force
+```
+
+Build will only watch for the things that change while it's running, so the first time you build your site you should use force -- force writes all of the files (& so also uploads them all too if you've set up uploads).
+
+Control-C in Terminal when you're done.
 
 ## Design & development
 
@@ -73,11 +79,11 @@ Commands:
   zine version         # Show the version number
 ```
 
-### Up next
-
-Many versions on this is only an early cut of this gem, the stuff I considered a (barely) minimum viable product. More to come...
+## Links
 
-A brief TODO list at the end of the change log.
+- [Github][github] - show me the code
+- [Ruby gems][rubygems] - show me the Ruby details (pick up some gems while you're there)
+- [Project site][mk] - Zine's home on the web
 
 ## Contributing
 
@@ -93,4 +99,6 @@ rake
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
-[engine_list]: https://staticsitegenerators.net
+[github]: https://github.com/mikekreuzer/zine
+[mk]: https://mikekreuzer/projects/zine/
+[rubygems]: https://rubygems.org/gems/zine

data/lib/zine/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'thor'
 require 'rainbow'
 require 'time'
@@ -13,9 +15,24 @@ module Zine
     attr_accessor :the_site # only used in testing
 
     no_commands do
+      def self.exit_on_failure?
+        true
+      end
+
       def init_site
         @the_site ||= Zine::Site.new
       end
+
+      def options
+        init_site
+
+        # for v0.16.0 only
+        unless @the_site.options['templates']['atom']
+          puts "v0.16.0 changes how rss & atom works, see CHANGELOG.md if you haven't already\n\n"
+        end
+
+        @the_site.options
+      end
     end
 
     desc 'build', 'Build the site'
@@ -47,7 +64,7 @@ module Zine
     desc 'nuke', 'Delete the build folder'
     def nuke
       init_site
-      FileUtils.remove_dir @the_site.options['directories']['build'],
+      FileUtils.remove_dir options['directories']['build'],
                            force: true
       puts Rainbow('Site nuked. It\'s the only way to be sure.').green
     end
@@ -55,7 +72,6 @@ module Zine
     desc 'post TITLE', 'Create the file for a new blog post, titled TITLE'
     def post(name)
       init_site
-      options = @the_site.options
       option_dir = options['directories']
       Zine::CLI.source_root option_dir['templates']
       @date = DateTime.now
@@ -77,7 +93,7 @@ module Zine
     desc 'style', 'Build the site\'s stylesheet'
     def style
       init_site
-      style = Zine::Style.new(@the_site.options['directories'])
+      style = Zine::Style.new(options['directories'])
       style.process(File)
       puts Rainbow('Stylesheet rendered').green
     end

data/lib/zine/data_page.rb

@@ -5,6 +5,7 @@ module Zine
   # links to other pages, eg an index page like the home page
   class DataPage < Zine::Page
     def initialize(data, templates, site_options, suffix = '.html')
+      # super(front_matter, site_opt)
       init_templates(templates)
       @formatted_data = FormattedData.new({}, site_options)
       @formatted_data.page[:title] = data[:title]

data/lib/zine/page.rb

@@ -30,6 +30,7 @@ module Zine
       def initialize(front_matter, site_opt)
         site = site_opt['options']
         @page = { date_rfc3339: front_matter['date'],
+                  date_rfc822: parse_822_date(front_matter['date']),
                   date_us: parse_date(front_matter['date']),
                   github_name: site['github_name'],
                   links_array: site_opt['links'],
@@ -56,6 +57,12 @@ module Zine
         ''
       end
 
+      def parse_822_date(front_matter_date)
+        DateTime.rfc3339(front_matter_date).rfc2822
+      rescue ArgumentError
+        ''
+      end
+
       def slugify_tags(tags)
         return unless tags && tags.any?
         tags.map { |tag| { name: tag, tag_slug: Page.slug(tag) } }

data/lib/zine/posts_and_headlines.rb

@@ -32,15 +32,54 @@ module Zine
       dir = @options['directories']['build']
       options = @options['options']
       templates = @options['templates']
-      [{ build_dir: dir, name: templates['articles'], number: @post_array.size,
-         suffix: '.html', template_name: templates['articles'],
-         title: 'Articles' },
-       { build_dir: dir, name: 'index',
-         number: options['num_items_on_home'], suffix: '.html',
-         template_name: templates['home'], title: 'Home' },
-       { build_dir: dir, name: 'rss',
-         number: options['number_items_in_RSS'], suffix: '.xml',
-         template_name: templates['rss'], title: '' }]
+      
+      headlines = []
+      if templates['home']
+        headlines <<
+          {
+            build_dir: dir,
+            name: 'index',
+            number: options['num_items_on_home'],
+            suffix: '.html',
+            template_name: templates['home'],
+            title: 'Home'
+          }
+      end
+      if templates['articles']
+        headlines <<
+          {
+            build_dir: dir,
+            name: templates['articles'],
+            number: @post_array.size,
+            suffix: '.html',
+            template_name: templates['articles'],
+            title: 'Articles'
+          }
+      end
+      if templates['rss']
+        headlines <<
+          {
+            build_dir: dir,
+            name: 'rss',
+            number: options['number_items_in_RSS'],
+            suffix: '.xml',
+            template_name: templates['rss'],
+            title: ''
+          }
+      end
+      if templates['atom']
+        headlines <<
+          {
+            build_dir: dir,
+            name: 'atom',
+            number: options['number_items_in_RSS'],
+            suffix: '.xml',
+            template_name: templates['atom'],
+            title: ''
+          }
+      end
+
+      headlines
     end
 
     def once_only(source_file)
@@ -114,7 +153,7 @@ module Zine
     def preview_straight_delete(file)
       FileUtils.rm(File.join(
                      preview_relative_equivalent(file), File.basename(file)
-      ))
+                  ))
     end
 
     # rebuild a page that's not a post - doesn't create the file structure for a
@@ -192,7 +231,7 @@ module Zine
       @post_array.first(page[:number]).each do |post|
         post_data = post.formatted_data
         data[:post_array] << { page: post_data.page, html: post_data.html,
-                               uri:  post_data.uri }
+                               uri: post_data.uri }
       end
       data_page = DataPage.new(data,
                                @site.make_template_bundle(data[:template_name]),

data/lib/zine/query.rb

@@ -3,7 +3,8 @@ module Zine
   class Query
     def call(question)
       puts question
-      $stdin.gets.chomp
+      result = $stdin.gets.chomp
+      result == '' ? 'Y' : result
     end
   end
-end
+end

data/lib/zine/skeleton/source/templates/atom.erb

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<feed xmlns="http://www.w3.org/2005/Atom"
+  xmlns:dc="http://purl.org/dc/elements/1.1/">
+  <author>
+    <name><%= page[:site_author] %></name>
+  </author>
+  <id><%= page[:site_URL] %>/atom.xml</id>
+  <title><%= page[:site_name] %></title>
+  <dc:date><%= data[0][:page][:date_rfc3339] %></dc:date>
+  <updated><%= data[0][:page][:date_rfc3339] %></updated>
+  <link href="<%= page[:site_URL] %>/atom.xml" rel="self" type="application/atom+xml"/>
+  <% for @post in data %>
+    <entry>
+      <content type="html"><![CDATA[<%= @post[:html] %>]]></content>
+      <id><%= @post[:uri] %></id>
+      <link href="<%= @post[:uri] %>"/>
+      <title><%= @post[:page][:title] %></title>
+      <updated><%= @post[:page][:date_rfc3339] %></updated>
+      <dc:date><%= @post[:page][:date_rfc3339] %></dc:date>
+    </entry>
+  <% end %>
+</feed>

data/lib/zine/skeleton/source/templates/footer_partial.erb

@@ -17,8 +17,8 @@
   <div class="column">
     <h3>The fine print</h3>
     <ul>
-      <li>Built with <a href="https://github.com/mikekreuzer/zine">Zine</a></li>
-      <li>&copy; 2019<span> <%= page[:site_author] %></span></li>
+      <li>Built with <a href="https://mikekreuzer.com/projects/zine/">Zine</a></li>
+      <li>&copy;2017-2022<span> <%= page[:site_author] %></span></li>
     </ul>
   </div>
   </footer>

data/lib/zine/skeleton/source/templates/header_partial.erb

@@ -5,7 +5,8 @@
     <meta name="viewport" content="width=device-width,user-scalable=yes">
     <meta name="description" content="<%= page[:site_description] %>">
     <title><%= page[:site_name] %> | <%= page[:title] %></title>
-    <link rel="home" href="<%= page[:site_URL] %>/rss.xml" type="application/rss+xml" title="<%= page[:site_name] %>">
+    <link rel="home alternate" href="<%= page[:site_URL] %>/atom.xml" type="application/atom+xml" title="<%= page[:site_name] %>">
+    <link rel="home alternate" href="<%= page[:site_URL] %>/rss.xml" type="application/rss+xml" title="<%= page[:site_name] %>">
     <link rel="stylesheet" href="/screen.css">
     <link rel="apple-touch-icon" href="/apple-touch-icon.png">
     <!--<link rel="canonical" href="<%= page[:uri] %>" />-->

data/lib/zine/skeleton/source/templates/rss.erb

@@ -1,21 +1,19 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<feed xmlns="http://www.w3.org/2005/Atom"
-  xmlns:dc="http://purl.org/dc/elements/1.1/">
-  <author>
-    <name><%= page[:site_author] %></name>
-  </author>
-  <id><%= page[:site_URL] %>/rss.xml</id>
-  <title><%= page[:site_name] %></title>
-  <dc:date><%= data[0][:page][:date_rfc3339] %></dc:date>
-  <updated><%= data[0][:page][:date_rfc3339] %></updated>
-  <% for @post in data %>
-    <entry>
-      <content type="html"><![CDATA[<%= @post[:html] %>]]></content>
-      <id><%= @post[:uri] %></id>
-      <link href="<%= @post[:uri] %>"/>
+<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
+<channel>
+	<title><%= page[:site_name] %></title>
+	<link><%= page[:site_URL] %>/rss.xml</link>
+	<description><%= page[:site_description] %></description>
+	<pubDate><%= data[0][:page][:date_rfc822] %></pubDate>
+  <lastBuildDate><%= data[0][:page][:date_rfc822] %></lastBuildDate>
+  <atom:link href="<%= page[:site_URL] %>/rss.xml" rel="self" type="application/rss+xml" />
+	<% for @post in data %>
+    <item>
       <title><%= @post[:page][:title] %></title>
-      <updated><%= @post[:page][:date_rfc3339] %></updated>
-      <dc:date><%= @post[:page][:date_rfc3339] %></dc:date>
-    </entry>
-  <% end %>
-</feed>
+      <link><%= @post[:uri] %></link>
+      <description><![CDATA[<%= @post[:html] %>]]></description>
+      <pubDate><%= @post[:page][:date_rfc822] %></pubDate>
+      <guid><%= @post[:uri] %></guid>
+    </item>
+	<% end %>
+</channel>
+</rss>

data/lib/zine/skeleton/zine.yaml

@@ -25,6 +25,7 @@ options:
   twitter_name: mikekreuzer
 templates:
   articles: articles
+  atom: atom
   default: default
   home: home
   new_post: new_post.erb
@@ -33,8 +34,9 @@ templates:
   tag: tag
   tag_index: tag_index
 upload:
+  cloudfront_distrib: ID or ''
   credentials: /local/absolute/path/to/yaml/file/with/username/password/or/access_token
-  host: 127.0.0.1
-  method: none|github|sftp
+  host: eg 127.0.0.1, or for AWS region:bucket_name
+  method: none|aws|github|sftp
   path_or_repo: /remote/absolute/path/to/html|fullname/repo
   verbose: true

data/lib/zine/upload.rb

@@ -1,11 +1,12 @@
 require 'rainbow'
 require 'set'
 require 'zine'
+require 'zine/uploader_aws'
 require 'zine/uploader_github'
 require 'zine/uploader_sftp'
 
 module Zine
-  # Deploy changes to a remote host, via SFTP or using the GitHub Rest API
+  # Deploy changes to a remote host, via SFTP or using the AWS or GitHub API
   class Upload
     def initialize(build_dir, options, delete_file_array, upload_file_array)
       if options['method'] == 'none'
@@ -45,6 +46,15 @@ module Zine
       exit
     end
 
+    def aws_upload
+      uploader = Zine::UploaderAWS.new(@build_dir,
+                                       @options,
+                                       @credentials,
+                                       @delete_file_array,
+                                       @upload_file_array)
+      uploader.upload
+    end
+
     def github_upload
       uploader = Zine::UploaderGitHub.new(@build_dir,
                                           @options,
@@ -64,7 +74,9 @@ module Zine
     end
 
     def upload
-      if @options['method'] == 'sftp'
+      if @options['method'] == 'aws'
+        aws_upload
+      elsif @options['method'] == 'sftp'
         sftp_upload
       elsif @options['method'] == 'github'
         github_upload

data/lib/zine/uploader_aws.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-cloudfront'
+require 'aws-sdk-s3'
+require 'rack/mime'
+require 'rainbow'
+require 'set'
+
+module Zine
+  # Deploy changes to an AWS S3 bucket and invalidate the Cloudfront cache
+  class UploaderAWS
+    def initialize(build_dir, options, credentials, delete_file_array,
+                   upload_file_array)
+      return unless options['method'] == 'aws'
+
+      @build_dir = build_dir
+      ENV['AWS_REGION'], @bucket_name = options['host'].split(':')
+      @path = options['path_or_repo']
+      @cf_distribution_id = options['cloudfront_distrib']
+
+      @verbose = options['verbose']
+      store_credentials credentials
+      @delete_file_array = Set.new(delete_file_array).to_a
+      @upload_file_array = Set.new(upload_file_array).to_a
+
+      @s3 = Aws::S3::Client.new
+      @cf = Aws::CloudFront::Client.new
+    end
+
+    def upload
+      delete
+      deploy
+      invalidate
+    rescue Aws::S3::Errors::ServiceError => err
+      puts Rainbow("S3 error: #{err}").red
+    end
+
+    private
+
+    def clean_path(path)
+      path.to_s
+          .delete_prefix('/')
+          .delete_suffix('/')
+    end
+
+    def delete
+      @delete_file_array.each do |rel_path|
+        remote_path = clean_path(rel_path)
+        @s3.delete_object(bucket: @bucket_name, key: remote_path)
+        puts "Delete: #{remote_path}" if @verbose
+      end
+    end
+
+    def deploy
+      @upload_file_array.each do |rel_path|
+        deploy_one_file(File.join(@build_dir, rel_path),
+                        clean_path(rel_path))
+      end
+    end
+
+    def deploy_one_file(local_path, remote_path)
+      File.open(local_path, 'rb') do |file|
+        content_type = Rack::Mime.mime_type(File.extname(local_path))
+        @s3.put_object(bucket: @bucket_name,
+                       key: remote_path,
+                       content_type: content_type,
+                       body: file)
+        puts "Add: #{remote_path}" if @verbose
+      end
+    end
+
+    def invalidate
+      changes = Set.new(@upload_file_array + @delete_file_array).to_a
+      return unless changes.count.positive?
+
+      puts 'Invalidating cache' if @verbose
+      string_changes = changes.map do |path|
+        path.to_s
+            .delete_prefix('/')
+            .prepend('/')
+      end
+      string_changes << '/'
+      @cf.create_invalidation(
+        distribution_id: @cf_distribution_id,
+        invalidation_batch: { paths: { quantity: string_changes.count,
+                                       items: string_changes },
+                              caller_reference: Time.now.to_i.to_s }
+      )
+    end
+
+    def store_credentials(creds)
+      ENV['AWS_ACCESS_KEY_ID'] = creds['username']
+      ENV['AWS_SECRET_ACCESS_KEY'] = creds['password']
+    end
+  end
+end

data/lib/zine/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module Zine
   # The version
-  VERSION = '0.13.0'.freeze
+  VERSION = '0.16.0'
 end

data/lib/zine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'erb'
 require 'rainbow'
 require 'zine/page'
@@ -102,10 +104,11 @@ module Zine
       # preview posts_and_guard -- no preview needed...
       return if @options['upload']['method'] == 'none' ||
                 (guard.delete_array.empty? && guard.upload_array.empty?)
-      uploader = Zine::Upload.new @options['directories']['build'],
+
+      uploader = Zine::Upload.new(@options['directories']['build'],
                                   @options['upload'],
                                   guard.delete_array,
-                                  guard.upload_array
+                                  guard.upload_array)
       uploader.upload_decision MockYes
     end
 
@@ -158,18 +161,18 @@ module Zine
     end
 
     def init_options
-      @options ||= begin
-        YAML.safe_load File.open('zine.yaml')
-      rescue ArgumentError => err
-        puts Rainbow("Could not parse YAML options: #{err.message}").red
-      end
+      @options ||= YAML.safe_load File.open('zine.yaml')
+    rescue ArgumentError => e
+      puts Rainbow("Could not parse YAML options: #{e.message}").red
     end
 
     def init_templates
+      Encoding.default_external = 'UTF-8'
       tem_array = Dir[File.join(@options['directories']['templates'], '*.erb')]
       tem_array.each do |tem|
         @templates_by_name.merge!(File.basename(tem, '.*') =>
-                                  ERB.new(File.read(tem), 0, '-'))
+          ERB.new(File.read(tem),
+                  trim_mode: '-'))
       end
     end