zine 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a7ad3b9767a3c9799f9b328a1f28ca0435ca3b1b
+  data.tar.gz: ede87c6d35d6aae470c47c9df26c98259cbfe940
+SHA512:
+  metadata.gz: 6e186e86c35fab7f7bd41ac7357c11585cf3a275bdc56618c426e79c9957ea138d45ffe46eddb3fd8986fabc408114f064bb209b2f20eb90427529cbe20ce7a2
+  data.tar.gz: 2d5f1023c075f0cb4b49c1c75ff9f2828f674e13a94ecff38e380f4021f3daa6911d332830ef71d57d5087cba0b9650ff8347811061da9ee3c0d1cd114968e19

data/CHANGELOG.md

@@ -0,0 +1,241 @@
+# 100 Days Of Code - Log
+
+### Day 1: January 24, 2017
+
+**Today's Progress**:
+
+- set up the blog & repos, my first project is a static blog engine called Zine
+- set up bundler, wrote some rspec tests & got the gem to build & installed it locally
+- using Thor for the menu & as a generator for scaffold files for new blog posts is the first functional part of the gem
+
+**Thoughts:**
+
+I might push the code up every few days, not sure about that yet.
+
+**Links to work**
+
+1. [(empty) Zine repo](https://github.com/mikekreuzer/zine)
+2. [Tweet](https://twitter.com/mikekreuzer/status/823876650316111872)
+3. [Blog](https://mikekreuzer.com/blog/2017/1/100-days-of-code.html)
+
+### Day 2: January 25, 2017
+
+**Today's Progress**:
+
+- generate a (still mostly empty) new site scaffold
+- read a YAML options file
+- have a Site object pushing file names to Page objects
+
+**Thoughts:**
+
+Next up is the the meat of the blog engine - reading the YAML & Markdown, generating the folder structure & pushing text through Kramdown & ERB. That's where I'd hoped to get to tonight.
+
+**Links to work**
+
+1. [Tweet](https://twitter.com/mikekreuzer/status/824237414306627589)
+
+### Day 3: January 26, 2017
+
+**Today's Progress**:
+
+- reading the files' YAML front matter & Markdown
+- generating the folder structure from the YAML dates (& spending ages with date errors in Psych.... they need to be quoted it turns out, it did used to know that I think)
+- Kramdown
+
+**Thoughts:**
+
+Didn't get as far as the ERB templates - still have to translate my current Jade templates across, probably via the Jade's HTML output. That's for tomorrow.
+
+Big time saver today was remembering to chain bash commands:
+```bash
+gem uninstall zine -x && gem build zine.gemspec && gem install ./zine-0.1.0.gem
+```
+
+**Links to work**
+
+1. [Tweet](https://twitter.com/mikekreuzer/status/824602333359190017)
+
+### Day 4: January 27, 2017
+
+**Today's Progress**:
+
+- moved the log to the Zine repo
+- went with Slim templates instead - rendering & partials both working, yet to translate the existing templates though
+- wrote some more rspec tests, played with cucumber for a while but decided not to use it, it's a DSL too far.
+
+**Thoughts:**
+
+Couldn't resist the terse syntax of Slim. Lagging behind on the test front.
+
+**Links to work**
+
+1. [Tweet](https://twitter.com/mikekreuzer/status/824948475355762688)
+
+### Day 5: January 28, 2017
+
+**Today's Progress**:
+
+- dropped Slim, back with ERB - translation was going to take too long
+- added HTML compression, even though the difference is only around 1kb a page
+
+**Thoughts:**
+
+Simplicity rules. Terse syntax is neat, but yet another DSL is a burden.
+
+On a positive note I feel like I'm on a bit of a roll with this project now. Tags next, I think.
+
+**Links to work**
+
+1. [Tweet](https://twitter.com/mikekreuzer/status/825327843059994625)
+
+### Day 6: January 29, 2017
+
+**Today's Progress**:
+
+- ERB partials
+- working posts & tags
+- draft of the README.md file
+
+**Thoughts:**
+
+I'm occasionally missing the safety check of a compile failing when using a compiled language. Also structs in Ruby aren't the best... but those are both partly a problem of my development habits. Still thinking about Cucumber & Slim, and seeing DSLs as a cost, as a topic for a blog post. Thinking of swapping colorize for pastel too (only because of the monkey patching).
+
+Next up: the home & article list pages, pages that aren't posts like the about page, and copying across the CSS - all up that would probably represent a minimum viable product. Much less than I plan to do in the end, but enough for a first cut of the gem I think. End of week one tomorrow!
+
+**Links to work**
+
+1. [Tweet](https://twitter.com/mikekreuzer/status/825689819204300800)
+
+### Day 7: January 30, 2017
+
+**Today's Progress**:
+
+- delete added as a CLI option
+- refactoring of tags (to be continued, to swap out ERB::Util for a slug name method, I think)
+
+**Thoughts:**
+
+Might push the template and CSS folders into a layouts/default folder, in case anyone ever wants to make other layouts. Tomorrow. Busy day. One week though, nice.
+
+**Links to work**
+
+1. [Tweet](https://twitter.com/mikekreuzer/status/826045386405998594)
+
+### Day 8: January 31, 2017
+
+**Today's Progress**:
+
+- replaced Colorize with Rainbow
+- replaced ERB::Util with a slug name generator
+- added dates to tag lists
+
+**Thoughts:**
+
+Refactoring my monolithic page class tomorrow, cleaning up tags was preparation for that.
+
+**Links to work**
+
+1. [Tweet](https://twitter.com/mikekreuzer/status/826414672542732288)
+
+### Day 9: February 1, 2017
+
+**Today's Progress**:
+
+- Ripley for February
+- Ripley 0.7.1
+
+**Thoughts:**
+
+A very brief break from Zine to detour back to some Elixir coding. The March edition of Ripley could be a Zine site, in time for its first anniversary in April.
+
+**Links to work**
+
+1. [Ripley](https://mikekreuzer.github.io/Ripley/)
+2. [Ripley code](https://github.com/mikekreuzer/Ripley)
+3. [Tweet](https://twitter.com/mikekreuzer/status/826775864696147969)
+
+### Day 10: February 2, 2017
+
+**Today's Progress**:
+
+- copies files that aren't Markdown or templates to the build directory, preserving the folder structure
+- a simple WEBrick server for preview, with SSL
+
+**Thoughts:**
+
+As well as breaking up Page I'm going to have break up a monolithic Site class, these things grow like topsy. Will do that when this cold abates.
+
+**Links to work**
+
+1. [Tweet](https://twitter.com/mikekreuzer/status/827135313621311488)
+
+### Day 11: February 3, 2017
+
+**Today's Progress**:
+
+- moved yesterday's local server out of the site class
+
+**Thoughts:**
+
+Fruitlessly debugged ERB. The cold continues. Real progress when I stop coughing.
+
+**Links to work**
+
+1. [Tweet](https://twitter.com/mikekreuzer/status/827504315430367232)
+
+### Day 12: February 4, 2017
+
+**Today's Progress**:
+
+- WEBrick swapped out for Thin - WEBrick's been ridiculously slow
+- DataPage class carved out of Page
+- home & all tags index pages
+
+**Thoughts:**
+
+The index page of all the tag pages is the first bit of Zine that pushes beyond the envelope of what I'm using now. That feels good.
+
+I'm wondering how much of my memory of having speed issue with Jekyll was caused by WEBrick.
+
+Finally starting to feel better, summer colds are the pits.
+
+**Links to work**
+
+1. [Tweet](https://twitter.com/mikekreuzer/status/827857782330138628)
+
+### Day 13: February 5, 2017
+
+**Today's Progress**:
+
+- more serious site & page class refactoring
+- pages that aren't blog posts
+- started into RSS/Atom feeds, and the standard library docs are borderline nonexistent
+
+**Thoughts:**
+
+Lucky 13.
+
+RSS would round out the two week mark nicely, if I get it to work. I have escaped content, but getting CDATA in there without writing the generator myself would be nice.
+
+Two weeks to get the rough structure right, and to get something like a minimum viable product feels about right. While that would be much less than I intend to do it'd be time to start pushing code to GitHub & to release this as more than a stub of a gem. Tomorrow, maybe, with a bit of luck.
+
+**Links to work**
+
+1. [Tweet](https://twitter.com/mikekreuzer/status/828231071770632193)
+
+### Day 14: February 6, 2017
+
+**Today's Progress**:
+
+- claimed the feed content's xhtml to get it to work, will revisit & fix this with CDATA
+- started testing the engine against old blog posts
+- first code to GitHub
+- gem published
+
+**Thoughts:**
+
+Two weeks, and here's the first cut of code to GitHub & a (slightly) more than just a stub of a gem. Plenty of room to improve, but a nice start.
+
+**Links to work**
+
+To follow

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Mike Kreuzer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,82 @@
+# zine
+Yet another blog aware static site generator.
+
+## Warning: pre-release code
+
+These are the very early days of zine, expect breaking changes.
+
+## Why yet another static blog engine?
+
+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.
+
+Presented here in the hope it's of use to someone else too.
+
+## Installation
+
+Install the gem.
+
+```shell
+$ gem install zine
+```
+
+Then 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.
+
+## Day to day usage
+
+To set up a new blog post:
+
+```shell
+$ 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.
+
+Once you're done writing, build your new site:
+
+```shell
+$ zine build
+```
+
+### Halp!
+
+To see the options available:
+
+```shell
+$ zine
+```
+
+### 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
+- and a few other things
+
+## Contributing
+
+Yes please. Bug reports and pull requests are welcome on GitHub at https://github.com/mikekreuzer/zine.
+
+## Tests
+
+```shell
+bundle exec rspec spec # or your alias for that
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+[engine_list]: https://staticsitegenerators.net

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'zine'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/zine

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'zine/cli'
+Zine::CLI.start

data/lib/zine.rb

@@ -0,0 +1,156 @@
+require 'erb'
+require 'rainbow'
+require 'zine/data_page'
+require 'zine/page'
+require 'zine/feed'
+require 'zine/post'
+require 'zine/server'
+require 'zine/tag'
+require 'zine/templates'
+require 'zine/version'
+
+module Zine
+  # the site
+  class Site
+    attr_reader :options
+
+    def initialize
+      @post_array = []
+      @templates_by_name = {}
+      init_options
+      clean_option_paths
+      init_templates
+    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
+    end
+
+    def init_templates
+      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, '-'))
+      end
+    end
+
+    def build_site
+      read_post_markdown_files
+      sort_posts_by_date
+      write_posts
+      housekeeping_copy
+      write_other_markdown_pages
+      write_feed
+      preview
+    end
+
+    def clean_option_paths
+      %w(assets posts styles templates).each do |dir|
+        @options['directories'][dir] =
+          File.join @options['directories']['source'],
+                    @options['directories'][dir]
+      end
+      @options['directories']['blog'] =
+        File.join @options['directories']['build'],
+                  @options['directories']['blog']
+    end
+
+    def housekeeping_copy
+      src_dir = @options['directories']['source']
+      search = File.join src_dir, '**', '*.*'
+      dir_options = @options['directories']
+      possible = Dir.glob(search, File::FNM_DOTMATCH).reject do |found|
+        found =~ /^.+\.md$|^.+\.erb$|^\.DS_Store$|^\.$|^\.\.$'/ ||
+          File.directory?(found) || found[dir_options['posts']] ||
+          found[dir_options['templates']]
+      end
+      possible.each do |file|
+        dir = Pathname(File.dirname(file)).relative_path_from(Pathname(src_dir))
+        filename = File.basename file
+        dest = File.join @options['directories']['build'], dir
+        FileUtils.mkdir_p dest
+        FileUtils.cp file, File.join(dest, filename)
+      end
+    end
+
+    def make_template_bundle(type)
+      TemplateFiles.new(
+        if @templates_by_name.key?(type)
+          @templates_by_name[type]
+        else
+          @templates_by_name['default']
+        end,
+        @templates_by_name['header_partial'],
+        @templates_by_name['footer_partial']
+      )
+    end
+
+    def preview
+      Server.new File.absolute_path(@options['directories']['build'])
+    end
+
+    def read_post_markdown_files
+      file_name_array = Dir[File.join(@options['directories']['posts'], '*.md')]
+      file_name_array.each do |file|
+        @post_array << Zine::Post.new(file,
+                                      make_template_bundle('post'),
+                                      @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
+    end
+
+    def write_feed
+      number = @options['options']['number_items_in_RSS']
+      feed = Zine::Feed.new(@post_array.first(number), @options)
+      feed.process
+    end
+
+    def write_homepage
+      homepage_data = { build_dir: @options['directories']['build'],
+                        name: 'index', title: 'Home', post_array: [] }
+      @post_array.first(@options['options']['num_items_on_home']).each do |post|
+        homepage_data[:post_array] << { page: post.formatted_data.page,
+                                        html: post.formatted_data.html }
+      end
+      home_page = DataPage.new(homepage_data, make_template_bundle('home'),
+                               @options)
+      home_page.write
+    end
+
+    def write_other_markdown_pages
+      dir_options = @options['directories']
+      src_dir = dir_options['source']
+      search = File.join src_dir, '**', '*.md'
+      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'), @options)
+        page.process
+      end
+    end
+
+    def write_posts
+      tags_by_post = []
+      @post_array.each do |post|
+        tags_by_post << post.process
+      end
+      tags = Zine::Tag.new tags_by_post, make_template_bundle('tag'),
+                           make_template_bundle('tag_index'), @options
+      tags.write_tags
+      write_homepage
+    end
+  end
+end