zine 0.15.0 → 0.17.0

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'zine'

data/bin/zine

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 
 require 'zine/cli'

data/lib/zine/cli.rb

@@ -12,15 +12,26 @@ module Zine
   # CLI for zine
   class CLI < Thor
     include Thor::Actions
-    attr_accessor :the_site # only used in testing
+    attr_accessor :site # only used in testing
 
     no_commands do
-      def init_site
-        @the_site ||= Zine::Site.new
+      def self.exit_on_failure?
+        true
+      end
+
+      def site
+        @site ||= Zine::Site.new
       end
 
       def options
-        @the_site.options
+        site
+
+        # for v0.16.0 & a few more only
+        unless @site.options['templates'] && @site.options['templates']['atom']
+          puts "v0.16.0 changes how rss & atom works, see CHANGELOG.md if you haven't already\n\n"
+        end
+
+        @site.options
       end
     end
 
@@ -31,28 +42,28 @@ module Zine
       #    printf "%25s\#%s\t\t\t%s:%-2d\n", classname, id, file, line
       #  end
       # }
-      init_site
-      @the_site.build_site
+      site
+      @site.build_site
       puts Rainbow('Site built').green
     end
 
     desc 'force', 'Build the site, forcing writes & uploads'
     def force
-      init_site
-      @the_site.build_site_forcing_writes
+      site
+      @site.build_site_forcing_writes
       puts Rainbow('Site built').green
     end
 
     desc 'notice POST', 'Build the site, then force the one POST'
     def notice(file)
-      init_site
-      @the_site.notice(file)
+      site
+      @site.notice(file)
       puts Rainbow('Site built').green
     end
 
     desc 'nuke', 'Delete the build folder'
     def nuke
-      init_site
+      site
       FileUtils.remove_dir options['directories']['build'],
                            force: true
       puts Rainbow('Site nuked. It\'s the only way to be sure.').green
@@ -60,7 +71,7 @@ module Zine
 
     desc 'post TITLE', 'Create the file for a new blog post, titled TITLE'
     def post(name)
-      init_site
+      site
       option_dir = options['directories']
       Zine::CLI.source_root option_dir['templates']
       @date = DateTime.now
@@ -71,8 +82,8 @@ module Zine
                File.join(Dir.pwd, option_dir['posts'], file)
     end
 
-    desc 'site', 'Create the skeleton of a new site (overwriting files)'
-    def site
+    desc 'skeleton', 'Create the skeleton of a new site (overwriting files)'
+    def skeleton
       # @skeleton_dir ?
       skeleton_dir = File.join File.dirname(__FILE__), 'skeleton', '/.'
       FileUtils.cp_r skeleton_dir, Dir.pwd
@@ -81,7 +92,7 @@ module Zine
 
     desc 'style', 'Build the site\'s stylesheet'
     def style
-      init_site
+      site
       style = Zine::Style.new(options['directories'])
       style.process(File)
       puts Rainbow('Stylesheet rendered').green

data/lib/zine/data_page.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'zine/page'
 
 module Zine
@@ -5,6 +7,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'erb'
 require 'date'
 require 'htmlcompressor'
@@ -16,20 +18,18 @@ module Zine
     attr_accessor :source_file # used in zine notice --
     # PostsAndHeadlines.one_new_post
     attr_reader :dest_path, :formatted_data, :template_bundle
+
     # the meta data, passed formatted to the template
     class FormattedData
       include ERB::Util
 
-      attr_accessor :data
-      attr_accessor :footer_partial
-      attr_accessor :header_partial
-      attr_accessor :html
+      attr_accessor :data, :footer_partial, :header_partial, :html, :uri
       attr_reader   :page
-      attr_accessor :uri
 
       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,9 +56,16 @@ 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) } }
+        return unless tags
+
+        tags&.map { |tag| { name: tag, tag_slug: Page.slug(tag) } }
       end
     end
 
@@ -68,7 +75,7 @@ module Zine
 
     def initialize(md_file_name, dest, templates, site_options)
       @source_file = md_file_name
-      file_parts = File.open(md_file_name, 'r').read.split('---', 3)
+      file_parts = File.read(md_file_name).split('---', 3)
       @formatted_data = FormattedData.new(parse_yaml(file_parts[1],
                                                      md_file_name),
                                           site_options)
@@ -106,6 +113,7 @@ module Zine
         input: 'GFM',
         auto_ids: false,
         smart_quotes: %w[apos apos quot quot],
+        typographic_symbols: { hellip: '…', mdash: '—', ndash: '–' }
       ).to_html
       @raw_text = nil
     end

data/lib/zine/post.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'uri'
 
 module Zine
@@ -5,7 +7,7 @@ module Zine
   class Post < Page
     def initialize(md_file_name, templates, site_options)
       @source_file = md_file_name
-      file_parts = File.open(md_file_name, 'r').read.split('---', 3)
+      file_parts = File.read(md_file_name).split('---', 3)
       @formatted_data = FormattedData.new(parse_yaml(file_parts[1],
                                                      md_file_name),
                                           site_options)
@@ -35,7 +37,7 @@ module Zine
       @dest_dir = File.join(build_dir,
                             date.strftime('%Y'),
                             date.strftime('%-m'))
-      slg = Zine::Page.slug(page_data[:title]) + '.html'
+      slg = "#{Zine::Page.slug(page_data[:title])}.html"
       @dest_path = File.join(@dest_dir, slg)
     end
 
@@ -43,7 +45,7 @@ module Zine
       page_data = @formatted_data.page
       file_path = rel_path_from_build_dir(@dest_path).to_s
       # URI.join will expect a root directory to start...
-      @formatted_data.uri = page_data[:site_URL] + '/' + file_path
+      @formatted_data.uri = "#{page_data[:site_URL]}/#{file_path}"
       TagData.new(page_data[:tags],
                   file_path,
                   page_data[:title],

data/lib/zine/posts_and_headlines.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'zine/data_page'
 require 'zine/post'
 require 'zine/tag'
@@ -32,15 +34,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)
@@ -73,7 +114,7 @@ module Zine
           Pathname(File.absolute_path(directories['source']))
         )
         relative_path = File.dirname(relative)
-        file = File.basename(relative, '.md') + '.html'
+        file = "#{File.basename(relative, '.md')}.html"
         File.delete(File.join(directories['build'], relative_path, file))
       else
         File.delete(page[:post].dest_path)
@@ -114,7 +155,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 +233,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Zine
   # Returns an answer from the CLI
   class Query

data/lib/zine/server.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'zine/query'
 require 'rainbow'
 require 'rack'
@@ -23,7 +25,6 @@ module Zine
       motd unless upload_options['test']
       @thin.start
       possible_upload rel_path_build, upload_options
-      @thin
     end
 
     # Stop the server - only used in test
@@ -48,23 +49,23 @@ module Zine
 
     def header_rules
       [[:all,
-        { 'ETag'          => nil,
-          'Last-Modified' => (Time.now + 100**4).to_s,
+        { 'ETag' => nil,
+          'Last-Modified' => (Time.now + (100**4)).to_s,
           'Cache-Control' =>
             'no-store, no-cache, must-revalidate, post-check=0, pre-check=0',
-          'Pragma'        => 'no-cache',
-          'Expires'       => (Time.now - 100**4).to_s }]]
+          'Pragma' => 'no-cache',
+          'Expires' => (Time.now - (100**4)).to_s }]]
     end
 
     def motd
-      puts "\nPreview running on " +
-           Rainbow('http://127.0.0.1:8080/').blue.underline +
-           "\nCommand double click the URL to open, Control C to quit\n"
+      puts "Preview running at #{Rainbow('http://127.0.0.1:8080/').blue.underline}
+Control C to quit\n"
     end
 
     def possible_upload(rel_path_build, upload_options)
       return if upload_options['method'] == 'none' ||
                 (@delete_array.empty? && @upload_array.empty?)
+
       uploader = Zine::Upload.new rel_path_build, upload_options,
                                   @delete_array, @upload_array
       uploader.upload_decision Query

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

@@ -18,7 +18,7 @@
     <h3>The fine print</h3>
     <ul>
       <li>Built with <a href="https://mikekreuzer.com/projects/zine/">Zine</a></li>
-      <li>&copy; 2020<span> <%= page[:site_author] %></span></li>
+      <li>&copy; 2023<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,20 @@
-<?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] %>"/>
+<?xml version="1.0" encoding="utf-8" standalone="yes"?>
+<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

data/lib/zine/style.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'sassc'
 
 module Zine
@@ -11,7 +13,7 @@ module Zine
 
     # Write the CSS file
     def process(string_or_file_writer)
-      sass = File.open(@style_file, 'r').read
+      sass = File.read(@style_file)
       css = SassC::Engine.new(sass, style: :compressed).render
       string_or_file_writer.write @css_file, css
     end

data/lib/zine/tag.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'zine/data_page'
 
 module Zine
@@ -15,7 +17,7 @@ module Zine
     def write_tags
       @posts_by_tag.each do |tag_name, struct_array|
         sorted_array = sort_tags_by_date struct_array
-        data = { name: tag_name, title: 'Tags: ' + tag_name,
+        data = { name: tag_name, title: "Tags: #{tag_name}",
                  post_array: sorted_array, build_dir: @tag_dir }
         tag_page = Zine::DataPage.new(data, @templates[:tag], @options)
         tag_page.write
@@ -25,21 +27,17 @@ module Zine
 
     private
 
-    # Take an array of posts each with the tags it has, & make an array of tags,
-    # each with the posts it's in
-    def sort_tags(tags_by_post)
-      posts_by_tag = {}
-      tags_by_post.each do |post|
+    # Take an array of posts, each with an array of tags it has, &
+    # make a hash of posts each with an array of posts the tag's in
+    def sort_tags(posts)
+      tags = {}
+      posts.each do |post|
         post['tagsArray'].each do |tag|
           name = tag[:name]
-          if posts_by_tag.key?(name)
-            posts_by_tag[name] << post
-          else
-            posts_by_tag[name] = [post]
-          end
+          tags.key?(name) ? tags[name] << post : tags[name] = [post]
         end
       end
-      posts_by_tag
+      tags
     end
 
     def sort_tags_by_date(tag_array)

data/lib/zine/templates.rb

@@ -1,9 +1,9 @@
+# frozen_string_literal: true
+
 module Zine
   # Trio of templates used to create a page
   class TemplateFiles
-    attr_reader :body
-    attr_reader :footer
-    attr_reader :header
+    attr_reader :body, :footer, :header
 
     def initialize(body, header, footer)
       @body = body

data/lib/zine/upload.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rainbow'
 require 'set'
 require 'zine'
@@ -23,9 +25,11 @@ module Zine
 
     def upload_decision(query_class)
       return if @no_upload
+
       cli = query_class.new
       answer = cli.call 'Upload files? (Y/n)'
       return if answer != 'Y'
+
       puts Rainbow('Connecting...').green
       upload
     end
@@ -74,11 +78,12 @@ module Zine
     end
 
     def upload
-      if @options['method'] == 'aws'
+      case @options['method']
+      when 'aws'
         aws_upload
-      elsif @options['method'] == 'sftp'
+      when 'sftp'
         sftp_upload
-      elsif @options['method'] == 'github'
+      when 'github'
         github_upload
       else
         puts Rainbow('Unknown upload option in zine.yaml').red

data/lib/zine/uploader_aws.rb

@@ -31,8 +31,8 @@ module Zine
       delete
       deploy
       invalidate
-    rescue Aws::S3::Errors::ServiceError => err
-      puts Rainbow("S3 error: #{err}").red
+    rescue Aws::S3::Errors::ServiceError => e
+      puts Rainbow("S3 error: #{e}").red
     end
 
     private
@@ -61,10 +61,11 @@ module Zine
     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,
+        @s3.put_object(body: file,
+                       cache_control: 'max-age=86400',
                        content_type: content_type,
-                       body: file)
+                       bucket: @bucket_name,
+                       key: remote_path)
         puts "Add: #{remote_path}" if @verbose
       end
     end

data/lib/zine/uploader_github.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'octokit'
 require 'rainbow'
 require 'yaml'
@@ -29,6 +31,7 @@ module Zine
     # then .each... upload & delete - uses @build_dir to create relative paths
     def upload
       return if @no_upload
+
       @delete_file_array.each do |file_pathname|
         delete_file file_pathname
       end

data/lib/zine/uploader_sftp.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'net/ssh'
 require 'net/sftp'
 require 'rainbow'
@@ -12,6 +14,7 @@ module Zine
     def initialize(build_dir, options, credentials, delete_file_array,
                    upload_file_array)
       return unless options['method'] == 'sftp'
+
       @build_dir = build_dir
       @host = options['host']
       @path = options['path_or_repo']
@@ -67,6 +70,7 @@ module Zine
       node_array.each do |level|
         level.each do |node|
           next if node.nil?
+
           path_string = node.path_string
           mkdir_p(sftp, path_string)
           puts "mkdir_p #{path_string}" if @verbose
@@ -96,8 +100,8 @@ module Zine
 
     def mkdir_p(sftp, path)
       sftp.mkdir!(File.join(@path, path), permissions: 0o755) # drwxr-xr-x
-    rescue Net::SFTP::StatusException => error
-      raise if error.code != 4 && error.code != 11 # folder already exists
+    rescue Net::SFTP::StatusException => e
+      raise if e.code != 4 && e.code != 11 # folder already exists
     end
 
     # for each level, if a node has the same name & same path it's a duplicate

data/lib/zine/version.rb

@@ -2,5 +2,5 @@
 
 module Zine
   # The version
-  VERSION = '0.15.0'
+  VERSION = '0.17.0'
 end