zine 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ce608b8b5c136ee23895b7ee2771cc091a4a87a
-  data.tar.gz: ca955519ffe65010a7029f3f0d43f26bdeecee19
+  metadata.gz: b554bb3eeda3a4ddc886a4b0c3c15ac6e7626215
+  data.tar.gz: 68f1a7d4d8684ac52ff79f3f617ccf68df346ea3
 SHA512:
-  metadata.gz: 39009e82432ea5260a0f1178b87c2e92dc0f8bbbd8e09051d877d1e89f83e8a8752607d700d39c3000f0fc0a5ec09b05549575977e78c0929c181c062076a9ad
-  data.tar.gz: afaa3801a74fca91ed7d743f219c75776948aa1877e0df57aa26913941292cdd7b92764770cf2d91793f3e542e165e0f41d9a4f71e4e3bfe6b462da4bcfd4413
+  metadata.gz: 276a5fc7b22ea376ec58c8ee05934ea8b31bbc015c319d8ec71dea4d4ba58758fe41044d7b3d7154198db84c0b72f4c518e0f871e3beefbb0d37ad10f8c5b26a
+  data.tar.gz: 9113788bb9fc2f0d4596782b271fb8a9c8a2f1c9bac8b9d3c230e9b974bc105d0d522cb5ce6eb5873de4164a83788e0af54c0b0d9a4f53f187946ee26bac15f2

data/CHANGELOG.md

@@ -298,3 +298,174 @@ Was listening in on RubyConf_au going on in the background on Twitter all day --
 
 1. [Repo](https://github.com/mikekreuzer/zine)
 2. [Gem](https://rubygems.org/gems/zine)
+3. [Tweet](https://twitter.com/mikekreuzer/status/829677797241090050)
+
+### Day 18: February 10, 2017
+
+**Today's Progress**:
+
+- PostsAndHeadlines class extracted from Site
+- CSS preprocessing with Sass added (LibSass and SassC)
+- messing about with styles
+- some minor refactoring & doc work
+
+**Thoughts:**
+
+Now well behind with testing, will need to concentrate on that soon.
+
+**Links to work**
+
+1. [Repo](https://github.com/mikekreuzer/zine)
+2. [Tweet](https://twitter.com/mikekreuzer/status/830034964393529345)
+
+### Day 19: February 11, 2017
+
+**Today's Progress**:
+
+- watching the Markdown files for changes with Listener
+- started on incremental builds
+
+**Thoughts:**
+
+A productive evening, despite spending a lot of time breaking my brain trying to work around the Guard gem. Incremental builds are on the way (deleted files I'm still to do), then on to live reloads and SFTP uploads (I think).
+
+**Links to work**
+
+1. [Repo](https://github.com/mikekreuzer/zine)
+2. [Tweet](https://twitter.com/mikekreuzer/status/830414957745369088)
+
+### Day 20: February 12, 2017
+
+**Today's Progress**:
+
+- added SFTP uploads of the files that changed, which includes (and it warrants a line)...
+- my own homegrown (& no doubt pretty rough) SFTP version of mkdir_p
+- incremental builds handle Markdown file deletions now
+- rearranged the zine.yaml preferences file to accommodate file transfers
+- added footer links via zine.yaml, tweaking the style & templates a little
+
+**Thoughts:**
+
+Writing the remote version of mkdir_p feels good, even if the number of edge cases I'd be missing must be huge. I'm going to drop live reloads for now, too much JavaScript jiggery pokery. It's been almost been 3 weeks... Need to optimise the tag rebuilds & uploads, probably. And tests...
+
+**Links to work**
+
+1. [Repo](https://github.com/mikekreuzer/zine)
+2. [Tweet](https://twitter.com/mikekreuzer/status/830762418485633024)
+
+### Day 21: February 13, 2017
+
+**Today's Progress**:
+
+- fixed some hard wiring from yesterday
+
+**Thoughts:**
+
+Three weeks! And it looks like my router is dying. Sigh. Not much time for programming tonight.
+
+Need to adjust the ordering of the build & file watching, to catch the initial build. Want to consolidate the mkdir requests before I send duplicates over the wire, as well as the tag rebuilds.
+
+**Links to work**
+
+1. [Repo](https://github.com/mikekreuzer/zine)
+2. [Tweet](https://twitter.com/mikekreuzer/status/831116561515638785)
+
+### Day 22: February 14, 2017
+
+**Today's Progress**:
+
+- slogging  it out (so far unsuccessfully) consolidating upload paths
+
+**Thoughts:**
+
+Valentine's Day special. Router seems to have righted itself for the moment. Slow going.
+
+**Links to work**
+
+1. [Tweet](https://twitter.com/mikekreuzer/status/831478367174037506)
+
+### Day 23: February 15, 2017
+
+**Today's Progress**:
+
+- consolidate upload paths instead of sending duplicate mkdir requests via SFTP
+
+**Thoughts:**
+
+Was looking the wrong way - was looking at a folder's children, when it's its parents that matter when removing duplicate mkdir calls.
+
+**Links to work**
+
+1. [Repo](https://github.com/mikekreuzer/zine)
+2. [Tweet](https://twitter.com/mikekreuzer/status/831859701411307520)
+
+### Day 24: February 16, 2017
+
+**Today's Progress**:
+
+- file watcher extended to cover non Markdown files
+
+**Thoughts:**
+
+A brief session after a few slugfest-y nights
+
+**Links to work**
+
+1. [Repo](https://github.com/mikekreuzer/zine)
+2. [Tweet](https://twitter.com/mikekreuzer/status/832174649492463616)
+
+### Day 25: February 17, 2017
+
+**Today's Progress**:
+
+- testing real world data with my blog
+
+**Thoughts:**
+
+Exciting, looking at things I need to clean up to make this workable...
+
+**Links to work**
+
+1. [Repo](https://github.com/mikekreuzer/zine)
+2. [Tweet](https://twitter.com/mikekreuzer/status/832575013769187330)
+
+### Day 26: February 18, 2017
+
+**Today's Progress**:
+
+- start the file watcher earlier to catch the initial build in a full build,
+  meant everything was a change so everything's uploaded...
+- added an incremental build that skipped the initial writes to fix that
+- linked homepage post titles to posts
+
+**Thoughts:**
+
+Have to move some local directory writes, then I think that's probably v0.3.0. Tomorrow. Would mean uploads took a week by themselves.
+
+**Links to work**
+
+1. [Repo](https://github.com/mikekreuzer/zine)
+2. [Tweet](https://twitter.com/mikekreuzer/status/832941448307748864)
+
+## v0.3.0
+
+### Day 27: February 19, 2017
+
+**Today's Progress**:
+
+- moved the local post directory creation to the write method
+- added a minimalist version of building additional posts while build is running
+- v0.3.0
+- and tonight Zine's in use in the wild
+
+**Thoughts:**
+
+Happy to call this a new pre release version, and also happy enough to push Zine into production use. My first 'Built with Zine' blog post's going up tonight.
+
+TODO: A 'known issue' I'll deal with later: adding a post file while build is running will generate a post, but the posts & tags won't be re-ordered by date. Adding new posts during a build's not how my blogging workflow works, but it's a bug so I'll fix it.
+
+**Links to work**
+
+1. [Repo](https://github.com/mikekreuzer/zine)
+2. [Gem](https://rubygems.org/gems/zine)
+3. [Blog](https://mikekreuzer.com)

data/README.md

@@ -9,6 +9,13 @@ These are the very early days of zine, expect breaking changes.
 
 Written in a #100DaysOfCode challenge -- my [progress log's here](CHANGELOG.md). Despite the [proliferation in these things][engine_list] (450!) I still find it more comfortable to use my own tools.
 
+Distinguishing features include:
+
+- ERB templates
+- Sass stylesheets
+- fast incremental builds
+- SFTP file uploads
+
 Presented here in the hope it's of use to someone else too.
 
 ## Installation
@@ -19,13 +26,13 @@ Install the gem.
 $ gem install zine
 ```
 
-Then generate a new site scaffold, cd to a new folder and:
+To generate a new site scaffold, cd to a new folder and:
 
 ```shell
 $ zine site
 ```
 
-Then update your site's name, your name & so on in zine.yaml.
+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).
 
 ## Day to day usage
 
@@ -35,31 +42,43 @@ 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.
+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.
 
 Once you're done writing, build your new site:
 
 ```shell
-$ zine build
+$ zine build # or zine force
 ```
 
+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).
+
+## Design & development
+
+Typing <code>zine style</code> will render the Sass file into CSS. The templates are all editable, as are the files' names, which you can change in the options file.
+
 ### Halp!
 
-To see the options available:
+To see the options available type zine & hit enter:
 
 ```shell
 $ zine
+Commands:
+  zine build           # Build the site
+  zine force           # Build the site, forcing writes & uploads
+  zine help [COMMAND]  # Describe available commands or one specific command
+  zine nuke            # Delete the build folder
+  zine post TITLE      # Create the file for a new blog post, titled TITLE
+  zine site            # Create the skeleton of a new site (overwriting files)
+  zine style           # Build the site's stylesheet
+  zine version         # Show the version number
 ```
 
 ### Up next
 
 This is only a first cut at this gem, the stuff I considered a (barely) minimum viable product. Up next are:
 
-- CSS preprocessing
-- file watching
 - migration scripts from eg Jekyll? Maybe.
 - Apple News
-- SSH uploads, as well as
 - much refactoring
 - docs
 - tests, lots of tests

data/lib/zine.rb

@@ -1,12 +1,9 @@
 require 'erb'
 require 'rainbow'
-require 'zine/data_page'
 require 'zine/page'
-require 'zine/post'
+require 'zine/posts_and_headlines'
 require 'zine/server'
-require 'zine/tag'
 require 'zine/templates'
-require 'zine/version'
 
 module Zine
   # the site
@@ -14,11 +11,9 @@ module Zine
     attr_reader :options
 
     def initialize
-      @post_array = []
       @templates_by_name = {}
       init_options
       clean_option_paths
-      init_templates
     end
 
     def init_options
@@ -38,12 +33,21 @@ module Zine
     end
 
     def build_site
-      read_post_markdown_files
-      sort_posts_by_date
-      write_posts_and_headlines
+      init_templates
+      FileUtils.mkdir_p @options['directories']['build']
+      # posts_and_guard is { posts: @post_array, guard: @guard }
+      posts_and_guard = posts_and_headlines_without_writing
+      preview posts_and_guard
+    end
+
+    def build_site_forcing_writes
+      init_templates
+      FileUtils.mkdir_p @options['directories']['build']
+      # posts_and_guard is { posts: @post_array, guard: @guard }
+      posts_and_guard = write_posts_and_headlines
       housekeeping_copy
       write_other_markdown_pages
-      preview
+      preview posts_and_guard
     end
 
     def clean_option_paths
@@ -61,7 +65,7 @@ module Zine
       possible = Dir.glob(search, File::FNM_DOTMATCH).reject do |found|
         found =~ /^.+\.md$|^.+\.erb$|^\.DS_Store$|^\.$|^\.\.$'/ ||
           File.directory?(found) || found[directories['posts']] ||
-          found[directories['templates']]
+          found[directories['templates']] || found[directories['styles']]
       end
       possible.each do |file|
         dir = Pathname(File.dirname(file)).relative_path_from(Pathname(src_dir))
@@ -84,88 +88,44 @@ module Zine
       )
     end
 
-    def preview
-      Server.new File.absolute_path(@options['directories']['build'])
+    # Generate data without writing files (for incremnetal builds & uploads)
+    # returns posts & guard to use during edits under preview
+    def posts_and_headlines_without_writing
+      posts = Zine::PostsAndHeadlines.new self, @options
+      posts.writeless
     end
 
-    def read_post_markdown_files
-      file_name_array = Dir[File.join(@options['directories']['posts'], '*.md')]
-      post_name = @options['templates']['post']
-      file_name_array.each do |file|
-        @post_array << Zine::Post.new(file,
-                                      make_template_bundle(post_name),
-                                      @options)
-      end
-    end
-
-    def sort_posts_by_date
-      @post_array.sort_by! do |post|
-        post.formatted_data.page[:date_rfc3339]
-      end.reverse!
-      @post_array.freeze
+    def preview(posts_and_guard)
+      guard = posts_and_guard[:guard]
+      Server.new @options['directories']['build'], @options['upload'],
+                 guard.delete_array, guard.upload_array
     end
 
-    def headline_pages
-      dir = @options['directories']['build']
-      options = @options['options']
-      templates = @options['templates']
-      [{ build_dir: dir, name: '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: '' }]
-    end
-
-    def wrangle_headlines
-      headline_pages.each do |page|
-        write_headline page
-      end
-    end
-
-    def write_headline(page)
-      data = page
-      data[:post_array] = []
-      @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 }
-      end
-      data_page = DataPage.new(data, make_template_bundle(data[:template_name]),
-                               @options, data[:suffix])
-      data_page.write
+    def write_markdown(default_name, src_dir, file)
+      dir = Pathname(File.dirname(file)).relative_path_from(Pathname(src_dir))
+      file_name = "#{File.basename(file, '.*')}.html"
+      dest = File.join @options['directories']['build'], dir
+      FileUtils.mkdir_p dest
+      page = Zine::Page.new(file, File.join(dest, file_name),
+                            make_template_bundle(default_name), @options)
+      page.process
     end
 
+    # TODO: structure in common with housekeeping_copy
     def write_other_markdown_pages
       dir_options = @options['directories']
       src_dir = dir_options['source']
       search = File.join src_dir, '**', '*.md'
       default_name = @options['templates']['default']
       Dir[search].reject { |found| found[dir_options['posts']] }.each do |file|
-        dir = Pathname(File.dirname(file)).relative_path_from(Pathname(src_dir))
-        file_name = "#{File.basename(file, '.*')}.html"
-        dest = File.join dir_options['build'], dir
-        FileUtils.mkdir_p dest
-        page = Zine::Page.new(file, File.join(dest, file_name),
-                              make_template_bundle(default_name), @options)
-        page.process
+        write_markdown(default_name, src_dir, file)
       end
     end
 
+    # returns posts & guard to use during edits under preview
     def write_posts_and_headlines
-      tags_by_post = []
-      @post_array.each do |post|
-        tags_by_post << post.process
-      end
-      tag_name = @options['templates']['tag']
-      tag_index_name = @options['templates']['tag_index']
-      tags = Zine::Tag.new tags_by_post, make_template_bundle(tag_name),
-                           make_template_bundle(tag_index_name), @options
-      tags.write_tags
-      wrangle_headlines
+      posts = Zine::PostsAndHeadlines.new self, @options
+      posts.write
     end
   end
 end

data/lib/zine/cli.rb

@@ -3,6 +3,7 @@ require 'rainbow'
 require 'time'
 require 'yaml'
 require 'zine'
+require 'zine/style'
 require 'zine/version'
 
 module Zine
@@ -23,6 +24,13 @@ module Zine
       puts Rainbow('Site built').green
     end
 
+    desc 'force', 'Build the site, forcing writes & uploads'
+    def force
+      init_site
+      @site.build_site_forcing_writes
+      puts Rainbow('Site built').green
+    end
+
     desc 'nuke', 'Delete the build folder'
     def nuke
       init_site
@@ -50,6 +58,14 @@ module Zine
       puts Rainbow('New skeleton site created').green
     end
 
+    desc 'style', 'Build the site\'s stylesheet'
+    def style
+      init_site
+      style = Zine::Style.new(@site.options['directories'])
+      style.process
+      puts Rainbow('Stylesheet rendered').green
+    end
+
     desc 'version', 'Show the version number'
     def version
       puts VERSION