zine 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7a4c3e5fea09ab51fe7b331af07cb4fe8f1513f
-  data.tar.gz: fc16a0fa30ce65e81c5273462f29844f870a41af
+  metadata.gz: 1b288c0de3e56f4d866463af9d47a7297c324f17
+  data.tar.gz: '09a5e9eade1683838fbdea5ca5e0a0f72503e5c2'
 SHA512:
-  metadata.gz: f57f529d7167611348b10ba2e80e4f64aae423dc61e4590eb5ed6583790492471b7ca059f9aa984bb91c849d4d9db12dd213c7fe8194b2f1b1f0d61bb642daa8
-  data.tar.gz: 4993f64db9279bb07ebcc5c89efb47d09ec2cc7b2201173c671234ef79cdbf0bf1864d9738740eee4b2a7647840ab99217c4ee197dd282fa73dd845c6b6b4385
+  metadata.gz: 1212ef35301f8cda64e1af9ad1b743e21a97ead47fb4e2b980446d13ca7dab579bd99cc7305744e8e9f4bfb241983188b26d4486c6b3146a976826f07b88b5a1
+  data.tar.gz: 937adc8a6c6930d10daa8113f386f6fa5ce8683b40e0655b151cb9e48e9ebca60434d5a59bc2b300d9987b73eba46b3765341da794d49f2c9a39fe496bb6394d

data/CHANGELOG.md

@@ -491,3 +491,261 @@ Fixed the bug in file uploads by using .uniq on an array of hashes (which I'd pl
 1. [Repo](https://github.com/mikekreuzer/zine)
 2. [Gem](https://rubygems.org/gems/zine)
 3. [Blog](https://mikekreuzer.com)
+4. [Tweet](https://twitter.com/mikekreuzer/status/833658907054583809)
+
+### Day 29: February 21, 2017
+
+**Today's Progress**:
+
+- deleted the stock post & about files I uploaded to my blog by mistake (hmm)
+- updated dependencies: Rake & Simplecov
+- refactored Zine::Site#housekeeping_copy
+- started chipping away at RDoc, and making some methods private
+- started to get back into writing tests again
+
+
+**Thoughts:**
+
+Need to need make the stock files more obvious, or maybe have an upgrade option, not sure where to draw the line on that... everything but the initial post & the about file? Tests. Finally.
+
+**Links to work**
+
+1. [Repo](https://github.com/mikekreuzer/zine)
+2. [Tweet](https://twitter.com/mikekreuzer/status/834021891383767040)
+
+### Took the night off: February 22, 2017
+
+### Day 30: February 23, 2017
+
+**Today's Progress**:
+
+- rebased a pull request for BennyHallett/elixir-rss
+- Page tests
+
+**Thoughts:**
+
+Needed a break last night, back into it.
+
+**Links to work**
+
+1. [Repo](https://github.com/mikekreuzer/zine)
+2. [Tweet](https://twitter.com/mikekreuzer/status/834740235460177920)
+
+### Day 31: February 24, 2017
+
+**Today's Progress**:
+
+- trawling through set_trace_func call logs
+
+**Thoughts:**
+
+Looking at execution paths, to make sure they are what I think they are.
+
+**Links to work**
+
+1. [Tweet](https://twitter.com/mikekreuzer/status/835110622794661889)
+
+### Day 32: February 25, 2017
+
+**Today's Progress**:
+
+- cleaned up Server, setting headers properly
+- added curb as a development dependency, started on Server tests with tests of those headers
+- then back in on page tests... some more refactoring required
+
+**Thoughts:**
+
+Testing times. :-)
+
+**Links to work**
+
+1. [Repo](https://github.com/mikekreuzer/zine)
+2. [Tweet](https://twitter.com/mikekreuzer/status/835471172967944192)
+
+### Day 33: February 26, 2017
+
+**Today's Progress**:
+
+- added what I thought would've been the default filter to Simplecov (excluding the spec directory)
+- injecting File into the file writing methods, to make testable versions
+- rewrote some Page and Server tests
+
+**Thoughts:**
+
+Been thinking about my next project while playing around with the tests. Had originally imagined maybe three or four projects, but it seems it'll be more like two, maybe three now. I have at least a week or maybe two of writing tests till I'm willing to slow down on those, having only just started, & a project of a similar size to Zine in mind for my next gig.
+
+**Links to work**
+
+1. [Repo](https://github.com/mikekreuzer/zine)
+2. [Tweet](https://twitter.com/mikekreuzer/status/835809220020707329)
+
+### Day 34: February 27, 2017
+
+**Today's Progress**:
+
+- minor doc work
+
+**Thoughts:**
+
+Toyed with using Apple's news format... but RSS seems to work fine. Almost a night off. Almost.
+
+**Links to work**
+
+1. [Repo](https://github.com/mikekreuzer/zine)
+2. [Tweet](https://twitter.com/mikekreuzer/status/836196422722580480)
+
+### Day 35: February 28, 2017
+
+**Today's Progress**:
+
+- more tests (Style and some more of CLI)
+
+**Thoughts:**
+
+43.8% covered, supposedly. Realistically there are ten substantive classes, one of which (PostsAndHeadlines) will act as an integration test, and I've written some tests for three... so somewhere around the 33% mark is probably closer to it. Happy with that rate of progress. My memory of rspec's mocking syntax especially is very shaky, but fixing that is what this is all about.
+
+**Links to work**
+
+1. [Repo](https://github.com/mikekreuzer/zine)
+2. [Tweet](https://twitter.com/mikekreuzer/status/836554681690181632)
+
+### Day 36: March 1, 2017
+
+**Today's Progress**:
+
+- Ripley for March
+- started playing around with GitHub uploads
+
+**Thoughts:**
+
+Snuck Ripley in in my first session (the 'only just AM', 'is that the time' session)... Had hoped to be using Zine for the Ripley site for March; April for the first anniversary for sure.
+
+Overall still want the tests to catch up some more before adding new features, but the upload code needs splitting up, and that's an opportune moment to get both SFTP & Octokit in there.
+
+**Links to work**
+
+1. [Ripley](https://mikekreuzer.github.io/Ripley/)
+2. [Ripley repo](https://github.com/mikekreuzer/Ripley)
+3. [Ripley Tweet](https://twitter.com/mikekreuzer/status/836564005799915520)
+4. [Zine Tweet](https://twitter.com/mikekreuzer/status/836925144853467136)
+
+### Day 37: March 2, 2017
+
+**Today's Progress**:
+
+- more work on GitHub uploads
+
+**Thoughts:**
+
+Octokit seems to work ok, though yet to integrate it (the Upload code still needs to be split up).
+
+Having to poll each possible remote copy of a file to see if it exists, to get its sha & to call separate create or update methods is clumsy. With a small number of uploads that's still likely to be fewer calls than getting all the remote files' info to update that locally though, because I'd need to poll each remote directory for its contents.
+
+**Links to work**
+
+1. [Tweet](https://twitter.com/mikekreuzer/status/837282872876638209)
+
+### Day 38: March 3, 2017
+
+**Today's Progress**:
+
+- Ripley
+
+**Thoughts:**
+
+Started on converting Ripley over to a static site, getting the JSON data to compare locally - to get smooth navigation between months. More Ruby, in what had been an Elixir project (and before that a Go project). :-)
+
+**Links to work**
+
+1. [Tweet](https://twitter.com/mikekreuzer/status/837652254773563392)
+
+### Day 39: March 4, 2017
+
+**Today's Progress**:
+
+- more toying with making Ripley data into Zine posts
+
+**Thoughts:**
+
+Long week, short night of coding.
+
+**Links to work**
+
+1. [Tweet](https://twitter.com/mikekreuzer/status/838004709793280000)
+
+### Day 40: March 5, 2017
+
+**Today's Progress**:
+- shuffled some Upload methods
+
+**Thoughts:**
+
+Trying to wind things up by 11:30 so I can get up in the mornings is taking its toll. This is my only coding nowadays, will need to work out a way to square that circle sustainably.
+
+**Links to work**
+
+1. [Tweet](https://twitter.com/mikekreuzer/status/838365598643970050)
+
+### Day 41: March 6, 2017
+
+**Today's Progress**:
+
+- the articles page takes its name from its template
+- zine.yaml - deleted the redundant css preprocessor option
+- fixed some shouldn't-be-private method bugs
+- Ruby script added to Ripley, to generate Zine post files from the JSON
+- Ripley is now a Zine site, though this upload was via git
+
+**Thoughts:**
+
+Ripley gets (currently clumsy) navigation between months to show historical data, as well as the benefit of being a (faster to load) static site, in time for next month's first anniversary. And I got to discover all sorts of assumptions I'd made about a site living in the root directory that I'll need to translate back to the stock templates.
+
+**Links to work**
+
+1. [Ripley](https://mikekreuzer.github.io/Ripley/)
+2. [Ripley Ruby](https://github.com/mikekreuzer/Ripley/tree/master/build_table)
+3. [Zine Repo](https://github.com/mikekreuzer/zine)
+2. [Tweet](https://twitter.com/mikekreuzer/status/838740083792470016)
+
+### Day 42: March 7, 2017
+
+**Today's Progress**:
+
+- fixed root directory assumptions in templates (images, css, links, all absolute) includes a url in the sass for the moment
+- worked around some URI.join weirdness (join for files doesn't know what dots means, & for URIs expects the first param to be root)
+- some cosmetic fixes in Ripley
+- Upload class split up, into Upload and UploadSFTP
+- UploadGitHub class added
+
+**Thoughts:**
+
+Sent some time fixing the bugs I caught yesterday, pushing things live's a good integration test sometimes. :-) Happy with Ripley for now, but will improve the build process. For April I still want to link to the JSON files, have a more natural forwards/backwards navigation between months, & table styles in the RSS. Tables might be a reason to look at Apple News again.
+
+Will push that code up tomorrow when I've seen it work. Time for a blog update, it's been two weeks. Then it's back to writing tests - it's been a week already.
+
+**Links to work**
+
+1. [Repo](https://github.com/mikekreuzer/zine)
+2. [Tweet](https://twitter.com/mikekreuzer/status/839091283897405440)
+
+### Took the night off: March 8, 2017
+
+## 0.5.0
+
+### Day 43: March 9, 2017
+
+**Today's Progress**:
+
+- pushing the new upload classes
+- version bump, GitHub uploads are worth a version bump
+
+**Thoughts:**
+
+Thought about keeping the old lede para split going as an option, instead of pushing styles into the RSS (for tables).
+
+Tests have fallen to 43.33%...
+
+**Links to work**
+
+1. [Repo](https://github.com/mikekreuzer/zine)
+2. [Tweet](https://twitter.com/mikekreuzer/status/839799560339775489)

data/lib/zine.rb

@@ -8,30 +8,19 @@ require 'zine/templates'
 module Zine
   # the site
   class Site
+    # Site options read from YAML during the initialisation of the class
     attr_reader :options
 
+    # Create a new instance of Site, called by CLI#init_site
     def initialize
       @templates_by_name = {}
       init_options
       clean_option_paths
     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
-
+    # A dry run build that generates baseline data to compare changes to during
+    # editting/preview, then generate files where the source files change.
+    # Called by CLI#build
     def build_site
       init_templates
       FileUtils.mkdir_p @options['directories']['build']
@@ -40,16 +29,58 @@ module Zine
       preview posts_and_guard
     end
 
+    # Build the files of the site, generating files immeadiately, suitable for
+    # the initial build or complete rebuild.
+    # Called by CLI#force
     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
+      housekeeping
       write_other_markdown_pages
       preview posts_and_guard
     end
 
+    # Create a new instance of TemplateFiles, looking up the body template in
+    # @templates_by_name, defaults to the template named 'default'
+    #
+    # Called in PostsAndHeadlines.read_post_markdown_files,
+    # PostsAndHeadlines.one_new_post, PostsAndHeadlines.write_headline,
+    # PostsAndHeadlines.write_tags_and_headlines
+    #
+    # ==== Attributes
+    #
+    # * +type+ - The name of the template used for the body eg post
+    #
+    # ==== Eg
+    #
+    #    make_template_bundle 'post'
+    #
+    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 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 File
+    end
+
+    private
+
     def clean_option_paths
       directories = @options['directories']
       %w(assets posts styles templates).each do |dir|
@@ -58,37 +89,51 @@ module Zine
       directories['blog'] = File.join directories['build'], directories['blog']
     end
 
-    def housekeeping_copy
+    def housekeeping
       directories = @options['directories']
-      src_dir = directories['source']
-      search = File.join src_dir, '**', '*.*'
+      source_directory = directories['source']
+      search = File.join source_directory, '**', '*.*'
       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['styles']]
+        housekeeping_files_not_to_copy found, directories
       end
       possible.each do |file|
-        dir = Pathname(File.dirname(file)).relative_path_from(Pathname(src_dir))
-        filename = File.basename file
-        dest = File.join directories['build'], dir
-        FileUtils.mkdir_p dest
-        FileUtils.cp file, File.join(dest, filename)
+        housekeeping_copy(file, source_directory, directories['build'])
       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']
-      )
+    def housekeeping_files_not_to_copy(found, directories)
+      found =~ /^.+\.md$|^.+\.erb$|^\.DS_Store$|^\.$|^\.\.$'/ ||
+        File.directory?(found) ||
+        found[directories['posts']] ||
+        found[directories['templates']] ||
+        found[directories['styles']]
+    end
+
+    def housekeeping_copy(file, src_dir, build_dir)
+      dir = Pathname(File.dirname(file)).relative_path_from(Pathname(src_dir))
+      filename = File.basename file
+      dest = File.join build_dir, dir
+      FileUtils.mkdir_p dest
+      FileUtils.cp file, File.join(dest, filename)
+    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
 
-    # Generate data without writing files (for incremnetal builds & uploads)
+    # Generate data without writing files (for incremental builds & uploads)
     # returns posts & guard to use during edits under preview
     def posts_and_headlines_without_writing
       posts = Zine::PostsAndHeadlines.new self, @options
@@ -101,17 +146,6 @@ module Zine
                  guard.delete_array, guard.upload_array
     end
 
-    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']