zine 0.2.0 → 0.3.0

data/lib/zine/skeleton/source/templates/footer_partial.erb

@@ -1,11 +1,23 @@
   <footer>
-    <div class="contact">
+    <div class="column">
+      <h3>Contact me</h3>
       <p>Twitter:&nbsp;<a href="https://twitter.com/<%= page[:twitter_name] %>">@<%= page[:twitter_name] %></a></p>
     </div>
-    <div class="contact">
-      <p>&copy; 2017<span> <%= page[:site_author] %></span>
-      </p>
+    <div class="column">
+      <h3>Me elsewhere</h3>
+      <ul>
+      <% for @link in page[:links_array] %>
+        <li><a href="<%= @link['uri'] %>"><%= @link['name'] %></a></li>
+      <% end %>
+    </ul>
     </div>
+    <div class="column">
+      <h3>The fine print</h3>
+      <ul>
+        <li>Built with <a href="https://github.com/mikekreuzer/zine">Zine</a></li>
+        <li>&copy; 2017<span> <%= page[:site_author] %></span></li>
+      </ul>
+    <div>
   </footer>
   </body>
 </html>

data/lib/zine/skeleton/source/templates/home.erb

@@ -2,7 +2,7 @@
 <main>
   <section>
     <% for @post in data %>
-      <h2><%= @post[:page][:title] %></h2>
+      <h2><a href="<%= @post[:uri] %>"><%= @post[:page][:title] %></a></h2>
       <p class="date"><%= @post[:page][:date_us] %></p>
       <%= @post[:html] %>
       <div class="tags">Tags:
@@ -13,6 +13,8 @@
         </ul>
       </div>
     <% end %>
+    <h2>Previously</h2>
+    <p><a href="/articles.html">Earlier posts...</a></p>
   </section>
 </main>
 <%= footer_partial %>

data/lib/zine/skeleton/zine.yaml

@@ -1,28 +1,41 @@
 ---
 directories:
-    blog: blog
-    build: build
-    assets: assets
-    posts: posts
-    source: source
-    styles: styles
-    templates: templates
-templates:
-    articles: articles
-    default: default
-    home: home
-    new_post: new_post.erb
-    post: post
-    rss: rss
-    tag: tag
-    tag_index: tag_index
+  assets: assets
+  blog: blog
+  build: build
+  posts: posts
+  source: source
+  styles: styles
+  templates: templates
+links:
+  -
+    name: GitHub
+    uri: https://github.com/mikekreuzer
+  -
+    name: Ripley
+    uri: https://mikekreuzer.github.io/Ripley/
 options:
-    css_preprocessor: less
-    github_name: mikekreuzer
-    number_items_in_RSS: 7
-    num_items_on_home: 7
-    site_author: Mike Kreuzer
-    site_description: The scribblings of a once and future code monkey
-    site_name: Mike Kreuzer
-    site_URL: https://mikekreuzer.com
-    twitter_name: mikekreuzer
+  css_preprocessor: less
+  github_name: mikekreuzer
+  number_items_in_RSS: 7
+  num_items_on_home: 7
+  site_author: Mike Kreuzer
+  site_description: The scribblings of a once and future code monkey
+  site_name: Mike Kreuzer
+  site_URL: https://mikekreuzer.com
+  twitter_name: mikekreuzer
+templates:
+  articles: articles
+  default: default
+  home: home
+  new_post: new_post.erb
+  post: post
+  rss: rss
+  tag: tag
+  tag_index: tag_index
+upload:
+  credentials: /local/absolute/path/to/yaml/file/with/username/and/password
+  host: 127.0.0.1
+  method: none|sftp
+  path: /remote/absolute/path/to/html
+  verbose: true

data/lib/zine/style.rb

@@ -0,0 +1,19 @@
+require 'sassc'
+
+module Zine
+  # Render sass into CSS in the source directory, to be copied later
+  class Style
+    # Source & destination files
+    def initialize(directories)
+      @style_file = File.join directories['styles'], 'screen.scss'
+      @css_file = File.join directories['source'], 'screen.css'
+    end
+
+    # Write the CSS file
+    def process
+      sass = File.open(@style_file, 'r').read
+      css = SassC::Engine.new(sass, style: :compressed).render
+      File.write @css_file, css
+    end
+  end
+end

data/lib/zine/tag.rb

@@ -8,6 +8,7 @@ module Zine
       @posts_by_tag = sort_tags tags_by_post
       @templates = { tag: tag_templates, tag_index: tag_index_templates }
       @tag_dir = File.join @options['directories']['build'], 'tags'
+      FileUtils.remove_dir @tag_dir, force: true
       FileUtils.mkdir_p @tag_dir
     end
 

data/lib/zine/upload.rb

@@ -0,0 +1,161 @@
+require 'net/ssh'
+require 'net/sftp'
+require 'rainbow'
+require 'set'
+
+module Zine
+  # Deploy changes to a remote host
+  # TODO: add GitHub deploys as well...
+  class Upload
+    # a folder in a path
+    Node = Struct.new(:name, :path_string)
+
+    def initialize(build_dir, options, delete_file_array, upload_file_array)
+      return unless options['method'] == 'sftp'
+
+      @build_dir = build_dir
+      @host = options['host']
+      @path = options['path']
+      @verbose = options['verbose']
+
+      cred_file = options['credentials']
+      @credentials = parse_yaml(File.open(cred_file, 'r'), cred_file)
+
+      @upload_file_array = Set.new(upload_file_array).to_a
+      @delete_file_array = Set.new(delete_file_array).to_a - @upload_file_array
+    end
+
+    def delete
+      Net::SFTP.start(@host, @credentials['username'],
+                      password: @credentials['password']) do |sftp|
+        @delete_file_array.each do |rel_file_path|
+          sftp.remove(File.join(@path, rel_file_path)).wait
+          puts "Deleted #{rel_file_path}" if @verbose
+        end
+      end
+    end
+
+    def deploy
+      Net::SFTP.start(@host, @credentials['username'],
+                      password: @credentials['password']) do |sftp|
+        deploy_directories sftp
+        deploy_files sftp
+      end
+    end
+
+    private
+
+    def break_strings_into_arrays(paths_array)
+      paths_array.map do |dir|
+        dir.to_s.split File::SEPARATOR
+      end
+    end
+
+    # make directories
+    def deploy_directories(sftp)
+      node_array = make_sparse_node_array @upload_file_array
+      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
+        end
+      end
+    end
+
+    # upload files
+    def deploy_files(sftp)
+      @upload_file_array.each do |rel_file_path|
+        sftp.upload(File.join(@build_dir, rel_file_path),
+                    File.join(@path, rel_file_path),
+                    permissions: 0o644).wait # -rw-r--r--
+        puts "Uploaded #{rel_file_path}" if @verbose
+      end
+    end
+
+    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
+    end
+
+    # make a sparse matrix as a directory tree, to make mkdir calls efficiently
+    def make_sparse_node_array(file_array)
+      paths_array = remove_filenames file_array           # remove file names
+      paths_array = Set.new(paths_array).to_a             # remove duplicates
+      paths_array = break_strings_into_arrays paths_array # to array of arrays
+      paths_array = strings_to_nodes paths_array          # ...of nodes
+      level_array = transpose paths_array                 # arrayed by level
+      remove_duplicates level_array                       # make it sparse
+    end
+
+    def parse_yaml(text, cred_file)
+      YAML.safe_load text
+    rescue Psych::Exception
+      puts Rainbow("Could not parse YAML in: #{cred_file}").red
+      { 'username' => '', 'password' => '' }
+    end
+
+    # for each level, if a node has the same name & same path it's a duplicate
+    def remove_duplicates(level_array)
+      level_array.map do |level|
+        length = level.length
+        level_copy = level
+        level.each_with_index.map do |node, index|
+          next if node.nil?
+          if index.zero?
+            node
+          elsif !level_copy[0..(index - 1)]
+                .index { |item| same(item, node) }.nil? ||
+                !level_copy[(index + 1)..(length - 1)]
+                .index { |item| same(item, node) }.nil?
+            level_copy[index] = nil
+            nil
+          else
+            node
+          end
+        end
+      end
+    end
+
+    # array of file paths to array of directory paths
+    def remove_filenames(file_array)
+      file_array.map do |file|
+        path = File.dirname file
+        if path == '.'
+          nil
+        else
+          path
+        end
+      end
+    end
+
+    # equality for a node
+    def same(first, second)
+      return false if first.nil? || second.nil?
+      first.name == second.name && first.path_string == second.path_string
+    end
+
+    # convert directory names to nodes with knowledge of their parentage
+    def strings_to_nodes(paths_array)
+      paths_array.map do |path|
+        path_string_array = path
+        path.each_with_index.map do |elem, index|
+          Node.new(elem, path_string_array[0..index].join(File::SEPARATOR))
+        end
+      end
+    end
+
+    # flip it, to get directories by level in a path, rather than by path
+    def transpose(input)
+      result = []
+      max_size = input.max_by(&:size).size
+      max_size.times do |i|
+        result[i] = Array.new(input.first.size)
+        input.each_with_index { |r, j| result[i][j] = r[i] }
+      end
+      result
+    end
+  end
+end

data/lib/zine/version.rb

@@ -1,3 +1,3 @@
 module Zine
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/lib/zine/watcher.rb

@@ -0,0 +1,88 @@
+require 'listen'
+require 'pathname'
+
+module Zine
+  # Watch files for changes
+  class Watcher
+    attr_reader :upload_array, :delete_array
+
+    def initialize(posts_and_headlines, build_directory, source_directory)
+      @posts_and_headlines = posts_and_headlines
+      @build_directory = File.join Dir.pwd, build_directory
+      @source_directory = File.join Dir.pwd, source_directory
+      @upload_array = []
+      @delete_array = []
+    end
+
+    # Build a delete list & an upload list for SSH from changes in build,
+    # & rebuild & reload on changes in source
+    def start
+      watch_build_dir
+      watch_source_dir
+    end
+
+    private
+
+    def on_build_change(path_string_array)
+      path_string_array.each do |str|
+        rel_path = rel_path_from_build_dir str
+        @upload_array << rel_path
+      end
+    end
+
+    def on_build_delete(path_string_array)
+      path_string_array.each do |str|
+        rel_path = rel_path_from_build_dir str
+        @delete_array << rel_path
+        # @upload_array.delete rel_path
+      end
+    end
+
+    def rel_path_from_build_dir(path)
+      full = Pathname(path)
+      full.relative_path_from(Pathname(@build_directory))
+    end
+
+    # rebuild the file, and the headline files & tags
+    # TODO: moves within the watched directory won't delete the old location
+    def on_source_change(path)
+      path.each do |file|
+        if !file.nil? && (file =~ /^.+\.md$/).nil?
+          @posts_and_headlines.preview_straight_copy file
+        else
+          @posts_and_headlines.preview_rebuild file
+        end
+      end
+    end
+
+    # delete build file from posts, then posts entry
+    # rebuild the headline files... and the tags...
+    def on_source_delete(path)
+      path.each do |file|
+        if !file.nil? && (file =~ /^.+\.md$/).nil?
+          @posts_and_headlines.preview_straight_delete file
+        else
+          @posts_and_headlines.preview_delete file
+        end
+      end
+    end
+
+    def watch_build_dir
+      listener = Listen.to(@build_directory) do |modified, added, removed|
+        on_build_change modified unless modified.empty?
+        on_build_change added unless added.empty?
+        on_build_delete removed unless removed.empty?
+      end
+      listener.start
+    end
+
+    def watch_source_dir
+      listener = Listen.to(@source_directory) do |modified, added, removed|
+        on_source_change modified unless modified.empty?
+        on_source_change added unless added.empty?
+        on_source_delete removed unless removed.empty?
+      end
+      listener.start
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zine
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Mike Kreuzer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-09 00:00:00.000000000 Z
+date: 2017-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.8
 - !ruby/object:Gem::Dependency
   name: htmlcompressor
   requirement: !ruby/object:Gem::Requirement
@@ -73,6 +93,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -80,6 +103,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.1
 - !ruby/object:Gem::Dependency
   name: kramdown
   requirement: !ruby/object:Gem::Requirement
@@ -87,6 +113,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.13.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -94,6 +123,49 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.13.2
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.5
+- !ruby/object:Gem::Dependency
+  name: net-sftp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.2
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -101,6 +173,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -108,6 +183,29 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+- !ruby/object:Gem::Dependency
+  name: sassc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.2
 - !ruby/object:Gem::Dependency
   name: thin
   requirement: !ruby/object:Gem::Requirement
@@ -129,6 +227,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.19'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -136,6 +237,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.19'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.4
 description: |-
   Yet another blog aware static site generator.
   These are the very early days of zine, expect breaking changes.
@@ -157,10 +261,16 @@ files:
 - lib/zine/data_page.rb
 - lib/zine/page.rb
 - lib/zine/post.rb
+- lib/zine/posts_and_headlines.rb
 - lib/zine/server.rb
 - lib/zine/skeleton/source/about.md
+- lib/zine/skeleton/source/assets/webicon-rss-m.png
+- lib/zine/skeleton/source/assets/webicon-rss.svg
+- lib/zine/skeleton/source/assets/webicon-twitter-m.png
+- lib/zine/skeleton/source/assets/webicon-twitter.svg
 - lib/zine/skeleton/source/posts/2017-01-25-my-new-blog.md
 - lib/zine/skeleton/source/screen.css
+- lib/zine/skeleton/source/styles/screen.scss
 - lib/zine/skeleton/source/templates/articles.erb
 - lib/zine/skeleton/source/templates/default.erb
 - lib/zine/skeleton/source/templates/footer_partial.erb
@@ -172,9 +282,12 @@ files:
 - lib/zine/skeleton/source/templates/tag.erb
 - lib/zine/skeleton/source/templates/tag_index.erb
 - lib/zine/skeleton/zine.yaml
+- lib/zine/style.rb
 - lib/zine/tag.rb
 - lib/zine/templates.rb
+- lib/zine/upload.rb
 - lib/zine/version.rb
+- lib/zine/watcher.rb
 homepage: https://github.com/mikekreuzer/zine
 licenses:
 - MIT