zine 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83a6d732e0f716bf2df642356304e6e80622736f778ff6367e3bf742a3d55f04
-  data.tar.gz: 75c284e7e74f8594372c2be764590de57a2a1072b70e989136c09130948478ea
+  metadata.gz: ec6708f393eb728e1c5683a092f37ee2008c41c292105be0587c89045f9b267a
+  data.tar.gz: c33be8fdc0d2b17ea341cd532827493491d41c665ffb21f0505dab21adfeaf27
 SHA512:
-  metadata.gz: 95a3b894f4d3cc1c03bce1509990de4185f5f7c503d694c440dd3c730bc45e49b9e01a65f60a94d5976e5cef4da77c802fdd6bc7133c3028618d8f1dc3485376
-  data.tar.gz: 5aaa407679487a1e807722e79d02f523ac0b75fa73b595e8fb2a2ece08157b1d3d6bbcca678256b40bc7327662886b48a419d7e2b377d750043a1d7a3e1bccda
+  metadata.gz: dd3359cbf10d141396f05ab17489eb44d80ff1bd6830dac029e8469a5d0a7d503d332a4892191f1240cf42813657ad10f90afed54ca19106e679710915196f9f
+  data.tar.gz: 51769bedd049eac1a94a9e94cd4c0114303e847861f7cfb38044269d3aa1f05a538c62cdb3e0289a72f1835247d64236849e36bb33586bf963cc3d4d6f312ec5

data/CHANGELOG.md

@@ -141,12 +141,20 @@
 - placeholder site, mostly in case there's ever an app: https://zine.dev
 
 # 0.14.0 - May 27, 2019
+
 - added an AWS S3 uploader
 - added AWS CloudFront invalidation
 - added zine.dev to the footer template
 - bug fix - catch carriage returns as default yes answers to the upload? question
 
+# 0.15.0 - May 26, 2020
+
+- dependency version bumps, year bump in template
+- replaced zine.dev with https://mikekreuzer.com/projects/zine/
+- other minor refactoring & doc rewrites
+
 TO DO
+
 - add canonical links to page headers, means the build order needs to change...
 - generate sitemap.xml
 - fix the SFTP error from 0.7/0.8, also likely applies to S3
@@ -154,8 +162,10 @@ TO DO
 - tests, lots of tests
 
 MAY DO
+
 - concurrent-ruby gem
 - migration scripts from eg Jekyll?
 - Apple News
 - much refactoring, frozen_string_literal, split monster classes, etc
+- replace thor with optparse
 - an app... maybe

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, changing them to suit my changing needs, for example here as I've moved between GitHub, EC2 & S3 hosts.
+Zine is an open source, command line, blog-aware, static website generator.
 
 Distinguishing features include:
 
 - ERB templates
 - Sass stylesheets
 - fast incremental builds
-- a choice of AWS S3, 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.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
 

data/lib/zine/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'thor'
 require 'rainbow'
 require 'time'
@@ -16,6 +18,10 @@ module Zine
       def init_site
         @the_site ||= Zine::Site.new
       end
+
+      def options
+        @the_site.options
+      end
     end
 
     desc 'build', 'Build the site'
@@ -47,7 +53,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 +61,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 +82,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/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://zine.dev">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; 2020<span> <%= page[:site_author] %></span></li>
     </ul>
   </div>
   </footer>

data/lib/zine/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zine
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Mike Kreuzer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-26 00:00:00.000000000 Z
+date: 2020-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,110 +16,116 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: curb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.6
+        version: 0.9.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.6
+        version: 0.9.10
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.2
+        version: 13.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.2
+        version: 13.0.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: 0.18.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: 0.18.5
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudfront
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.18'
+        version: '1.27'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.27.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.18'
+        version: '1.27'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.27.1
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.40'
+        version: '1.66'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.40'
+        version: '1.66'
 - !ruby/object:Gem::Dependency
   name: htmlcompressor
   requirement: !ruby/object:Gem::Requirement
@@ -140,54 +146,54 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.1
 - !ruby/object:Gem::Dependency
   name: kramdown-parser-gfm
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: listen
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.5
+        version: 3.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.5
+        version: 3.2.1
 - !ruby/object:Gem::Dependency
   name: net-sftp
   requirement: !ruby/object:Gem::Requirement
@@ -214,14 +220,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.18'
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -242,14 +248,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: thin
   requirement: !ruby/object:Gem::Requirement
@@ -270,20 +276,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.4
+        version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.4
+        version: 1.0.1
 description: |-
   Yet another blog aware static site generator.
   There are many like it, but this one is mine.
@@ -337,7 +343,7 @@ files:
 - lib/zine/uploader_sftp.rb
 - lib/zine/version.rb
 - lib/zine/watcher.rb
-homepage: https://zine.dev
+homepage: https://mikekreuzer.com/projects/zine/
 licenses:
 - MIT
 metadata: {}
@@ -356,7 +362,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Yet another blog aware static site generator.