jekyll-recker 0.1.0

data/README.org

@@ -0,0 +1,119 @@
+#+TITLE: jekyll-recker
+#+SLUG: jekyll-recker.html
+#+PERMALINK: jekyll-recker.html
+#+STARTUP: showall
+#+DESCRIPTION: my website's custom jekyll plugin
+
+This is the jekyll plugin for my personal website.
+
+* Installation
+
+Add =jekyll-recker= to the =jekyll_plugins= group of your =Gemfile=.
+
+#+BEGIN_SRC ruby
+  group :jekyll_plugins do
+    gem 'jekyll-recker', :git => 'https://github.com/arecker/jekyll-recker.git'
+  end
+#+END_SRC
+
+Add =jekyll-recker= to the list of plugins in jekyll's =_config.yml=.
+
+#+BEGIN_SRC yaml
+  # _config.yaml
+  plugins:
+    - jekyll-recker
+#+END_SRC
+
+Set the theme.
+
+#+BEGIN_SRC yaml
+theme: jekyll-recker
+#+END_SRC
+
+Install and enjoy.
+
+#+BEGIN_SRC sh
+bundle install
+bundle exec jekyll serve
+#+END_SRC
+
+* Usage
+
+** Commands
+
+*** =tweet=
+
+The =tweet= command tweets a link to the latest published jekyll blog
+post.
+
+Ensure the following environment variables are set,.
+
+#+BEGIN_SRC sh
+  export ACCESS_TOKEN_SECRET="..."
+  export ACCESS_TOKEN="..."
+  export CONSUMER_API_KEY="..."
+  export CONSUMER_API_SECRET="..."
+#+END_SRC
+
+Alternatively, configure which commands to run to fetch the secrets.
+
+#+BEGIN_SRC yaml
+# _config.yml
+recker:
+  twitter:
+    access_token_secret_cmd: cat secrets/access-token-secret
+    access_token_cmd: cat secrets/access-token
+    consumer_api_key_cmd: cat secrets/consumer-api-key
+    consumer_api_secret_cmd: cat secrets/consumer-api-secret-key
+#+END_SRC
+
+Run =bundle exec jekyll tweet= to let it rip!
+
+[[assets/images/example-tweet.png]]
+
+** Generators
+
+*** =stats=
+
+On build time, =jekyll-recker= calculates and stores the following
+stats in the =site.data.stats= object, which are by default rendered in a
+widget on the home page layout.
+
+[[assets/images/example-stats.png]]
+
+If you'd like, you can override the template with your own stats
+widget by providing your own =_includes/stats.html=.
+
+| Field Name      | Field Description                                    |
+|-----------------+------------------------------------------------------|
+| =posts=         | The total number of published posts.                 |
+| =words.total=   | The total number of words from all published post.   |
+| =words.average= | The average number of words for each published post. |
+| =days.days=     | Current streak of daily, consecutive posts.          |
+| =days.start=    | First day of current streak.                         |
+| =days.end=      | Last day of current streak.                          |
+
+Example:
+
+#+BEGIN_SRC html
+    <!-- _includes/stats.html -->
+
+    <table>
+      <tr>
+        <th>Total Posts</th>
+        <th>Total Words</th>
+        <th>Average Words per Post</th>
+        <th>Current Streak</th>
+        <th>First day of current streak</th>
+        <th>Last day of current streak</th>
+      </tr>
+      <tr>
+        <td>{{ site.data.stats.posts }}</td>
+        <td>{{ site.data.stats.words.total }}</td>
+        <td>{{ site.data.stats.words.average }}</td>
+        <td>{{ site.data.stats.days.days }}</td>
+        <td>{{ site.data.stats.days.start }}</td>
+        <td>{{ site.data.stats.days.end }}</td>
+      </tr>
+    </table>
+#+END_SRC

data/_includes/archive.html

@@ -0,0 +1,23 @@
+<div class="ui two column stackable grid">
+  {%- for post in site.posts -%}
+  {%- capture this_month -%}{{ post.date | date: '%B %Y' }}{%- endcapture -%}
+  {%- capture next_month -%}{{ post.previous.date | date: '%B %Y' }}{%- endcapture -%}
+  {%- if forloop.first -%}
+  <div class="center aligned column">
+    <h3 class="ui large header">{{ this_month }}</h3>
+    <div class="ui middle aligned large link list">
+      {%- endif -%}
+      <a class="item" href="{{ post.url }}">{{ post.title }}</a>
+      {%- if this_month != next_month -%}
+    </div>
+  </div>
+  <div class="center aligned column">
+    <h3 class="ui large header">{{ next_month }}</h3>
+    <div class="ui middle aligned large link list">
+      {%- endif -%}
+      {%- if forloop.last -%}
+    </div>
+  </div>
+  {%- endif -%}
+  {%- endfor -%}
+</div>

data/_includes/nav.html

@@ -0,0 +1,15 @@
+<div class="ui container">
+  <h1 class="ui massive dividing header">
+    {{ include.title }}
+    <div class="sub header">
+      {{ include.subtitle }}
+    </div>
+  </h1>
+  <div class="ui huge breadcrumb">
+    <a href="{{ site.baseurl}}/" class="section">
+      <i class="home icon"></i>
+    </a>
+    <i class="right angle icon divider"></i>
+    <div class="active section">{{ include.slug }}</div>
+  </div>
+</div>

data/_includes/pager.html

@@ -0,0 +1,10 @@
+{%- if page.next -%}
+<a href="{{ page.next.url }}" class="ui basic left floated button">
+  <i class="angle left icon"></i> {{ page.next.slug }}
+</a>
+{%- endif -%}
+{%- if page.previous -%}
+<a href="{{ page.previous.url }}" class="ui basic right floated button">
+  {{ page.previous.slug }} <i class="angle right icon"></i>
+</a>
+{%- endif -%}

data/_includes/stats.html

@@ -0,0 +1,36 @@
+<div class="ui center aligned four small statistics">
+  <div class="ui small statistic">
+    <div class="value">
+      {{ site.data.stats.words.total }}
+    </div>
+    <div class="label">
+      Total Words
+    </div>
+  </div>
+  <div class="ui small statistic">
+    <div class="value">
+      {{ site.data.stats.words.average }}
+    </div>
+    <div class="label">
+      Ave. Words per post
+    </div>
+  </div>
+  <div class="ui small statistic">
+    <div class="value">
+      {{ site.data.stats.posts }}
+    </div>
+    <div class="label">
+      Posts
+    </div>
+  </div>
+  <div class="ui small statistic">
+    <div class="value">
+      {{ site.data.stats.days.days }}
+    </div>
+    <div class="label">
+      Consecutive Days
+    </div>
+  </div>
+</div>
+
+

data/_layouts/default.html

@@ -0,0 +1,37 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/semantic-ui/2.4.1/semantic.min.css" integrity="sha256-9mbkOfVho3ZPXfM7W8sV2SndrGDuh7wuyLjtsWeTI1Q=" crossorigin="anonymous" />
+    <link href="/assets/jekyll-recker.css" rel="stylesheet"/>
+    <title>
+      {{ site.title }} | {% if page.title != nil %}{{ page.title }}{% else %}{{ site.description }}{% endif %}
+    </title>    
+  </head>
+  <body>
+    <div class="ui container">
+      {{ content }}
+    </div>
+    <div class="ui vertical footer segment">
+      <div class="ui center aligned container">
+	<div class="ui horizontal large divided link list">
+	  <div class="ui buttons">
+	    <a class="ui circular rss basic button" href="/feed.xml"><i class="rss icon"></i></a>
+	    <a class="ui circular email basic button" href="mailto:{{ site.email }}"><i class="envelope icon"></i></a>
+	    <a class="ui circular twitter basic button" href="https://www.twitter.com/{{ site.twitter_username }}"><i class="twitter icon"></i></a>
+	    <a class="ui circular github basic button" href="https://www.github.com/{{ site.github_username }}"><i class="github icon"></i></a>
+	  </div>
+	</div>
+      </div>
+      <div class="ui center aligned container">
+	<div class="ui centered mini">
+	  <p>
+	    powered by <a title="Jekyll is a simple, blog-aware, static site generator." href="http://jekyllrb.com/">jekyll</a> &
+	    <a title="Alex Recker's custom jekyll plugin" href="{{ site.baseurl }}{% link README.org %}">jekyll-recker</a> v{% recker_version %}
+	  </p>
+	</div>
+      </div>
+    </div>
+  </body>
+</html>

data/_layouts/home.html

@@ -0,0 +1,21 @@
+---
+layout: default
+---
+<div class="ui container">
+  {%- include nav.html slug="index.html" title=site.title subtitle=site.description %}
+  <div class="ui text container center aligned">
+    {{ content }}
+  </div>
+  <br/>
+  <div class="ui container center aligned segment">
+    {% include stats.html %}  
+  </div>
+  <br/>
+  <div class="ui container">
+    <img class="ui fluid image" src="{{ site.baseurl }}assets/images/words.png">
+  </div>
+  <br/>
+  <div class="ui container">
+    {% include archive.html %}
+  </div>
+</div>

data/_layouts/page.html

@@ -0,0 +1,10 @@
+---
+layout: default
+---
+<div class="ui container">
+  {%- include nav.html slug=page.slug title=page.title subtitle=page.description %}
+  <div class="ui container">
+    {{ content }}
+  </div>
+</div>
+

data/_layouts/post.html

@@ -0,0 +1,12 @@
+---
+layout: default
+---
+<div class="ui container">
+  {% capture datestring %}{{ page.date | date: '%A, %B %d %Y' }}{% endcapture %}
+  {%- include nav.html slug=page.slug title=datestring subtitle=page.title %}
+  <div class="ui container">
+    {{ content }}
+    {%- include pager.html %}
+  </div>
+</div>
+

data/_sass/jekyll-recker.sass

@@ -0,0 +1,15 @@
+.ui
+  .container 
+    margin: 2em
+
+.footer
+  margin-top: 50px !important
+
+p 
+  font-size: 20px
+  line-height: 160%
+  -moz-osx-font-smoothing: grayscale
+  -webkit-font-smoothing: antialiased !important
+  -moz-font-smoothing: antialiased !important
+  text-rendering: optimizelegibility !important
+  letter-spacing: .03em

data/assets/jekyll-recker.scss

@@ -0,0 +1,3 @@
+---
+---
+@import "{{ site.theme }}"

data/lib/blog/cli.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require 'commander'
+require 'fileutils'
+
+module Blog
+  # CLI
+  class CLI
+    include Commander::Methods
+
+    def logger
+      Blog::Log.logger
+    end
+
+    def config_path
+      @config_path ||= File.expand_path '~/.blog.yml'
+    end
+
+    def config
+      Blog::Config.load_from_file(config_path)
+    end
+
+    def journal
+      @journal ||= Blog::Journal.from_file(config.journal_path)
+    end
+
+    def latest
+      @latest ||= journal.public_entries.first
+    end
+
+    def build
+      logger.info "deleting #{config.site_dir.pretty_path}"
+      FileUtils.rm_rf(config.site_dir)
+      logger.info "parsing #{config.journal_path.pretty_path}"
+      journal = Blog::Journal.from_file(config.journal_path)
+      logger.info "writing #{journal.public_entries.count.pretty} public entries"
+      journal.write_public_entries! config.posts_dir
+      logger.info "building jekyll"
+      Blog::Jekyll.build(config)
+    end
+
+    def commit
+      git = Blog::Git.new(config.blog_repo)
+      git.run!
+    end
+
+    def slack
+      logger.info "fetched latest entry: #{latest.excerpt}"
+      config.slacks.each do |info|
+        Blog::Slacky.post(latest, `#{info['webhook_cmd']}`, info)
+      end
+    end
+
+    def run
+      program :name, 'blog'
+      program :version, 'v0.0.0'
+      program :description, 'script to generate and publish my blog'
+
+      default_command :all
+
+      global_option '--config FILE', String, 'path to blog.yml' do |file|
+        @config_path = file
+      end
+
+      command :build do |c|
+        c.syntax = 'build'
+        c.description = 'build jekyll site'
+        c.action do |_args, _options|
+          build
+        end
+      end
+
+      command :commit do |c|
+        c.syntax = 'commit'
+        c.description = 'commit and push new post'
+        c.action do |_args, _options|
+          commit
+        end
+      end
+
+      command :slack do |c|
+        c.syntax = 'slack'
+        c.description = 'send slack notifications'
+        c.action do |_args, _options|
+          slack
+        end
+      end
+
+      command :all do |c|
+        c.syntax = 'all'
+        c.description = 'build, commit, and slack'
+        c.action do |_args, _options|
+          build
+          commit
+          slack
+        end
+      end
+
+      run!
+    end
+  end
+end

data/lib/blog/config.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'bundler'
+require 'yaml'
+
+module Blog
+  # Config
+  class Config
+    attr_reader :data
+
+    def self.load_from_file(config_path = File.expand_path('~/.blog.yml'))
+      new(YAML.load_file(config_path) || {})
+    end
+
+    def initialize(data)
+      @data = data
+    end
+
+    def journal_path
+      File.join blog_repo, 'journal.org'
+    end
+
+    def posts_dir
+      File.join blog_repo, '_posts'
+    end
+
+    def site_dir
+      File.join(File.expand_path(blog_repo), '_site')
+    end
+
+    def blog_repo
+      Bundler.root.to_s
+    end
+
+    def stats_path
+      File.join blog_repo, '_data/stats.json'
+    end
+
+    def log_level
+      @data.fetch('log_level', 'INFO').upcase
+    end
+
+    def twitter_creds
+      twitter = @data.fetch('twitter')
+      creds = {}
+      [
+        'access_token_secret',
+        'access_token',
+        'consumer_api_key',
+        'consumer_api_secret'
+      ].each do |key|
+        creds[key] = `#{twitter.fetch(key + '_cmd')}`.strip
+      end
+      creds
+    end
+
+    def slacks
+      @data.fetch('slacks', [])
+    end
+
+    private
+
+    def missing_fields
+      required_keys.reject { |k| @data.key? k }
+    end
+  end
+end

data/lib/blog/entry.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'org-ruby'
+
+module Blog
+  # Entry
+  class Entry
+    def initialize(headline)
+      @headline = headline
+    end
+
+    def title
+      date.strftime('%A, %B %-e %Y')
+    end
+
+    def subtitle
+      @subtitle ||= @headline.headline_text.split(' ').drop(2).join(' ')
+    end
+
+    alias excerpt subtitle
+
+    def tags
+      @tags ||= @headline.tags
+    end
+
+    def date
+      @date ||= Date.strptime(
+        @headline.headline_text.split(' ').take(2).join(' '),
+        '%Y-%m-%d %A'
+      )
+    end
+
+    def date_slug
+      date.strftime('%Y-%m-%d')
+    end
+
+    def public?
+      !tags.include? 'private'
+    end
+
+    def filename
+      "#{date_slug}-#{date_slug}.html.html"
+    end
+
+    def permalink
+      "https://www.alexrecker.com/#{date_slug}.html"
+    end
+
+    def body_text
+      @headline.body_lines.drop(1).collect(&:output_text).join(' ')
+    end
+
+    def body_html
+      Orgmode::Parser.new(body_text).to_html
+    end
+
+    def to_html
+      <<~HTML
+        ---
+        title: #{title}
+        excerpt: #{excerpt}
+        ---
+        #{body_html}
+      HTML
+    end
+  end
+end

data/lib/blog/git.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'git'
+
+module Blog
+  # Git
+  class Git
+    attr_reader :client
+
+    def initialize(path)
+      @client = ::Git.open(path)
+      @logger = Blog::Log.logger
+    end
+
+    def run!
+      commit!
+    end
+
+    def commit!
+      commit = '[auto] Automatic Publish'
+      @logger.info "writing commit: #{commit}"
+      @client.add
+      @client.commit(commit)
+      @logger.info 'pushing commit'
+      @client.push
+    end
+  end
+end

data/lib/blog/jekyll.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'jekyll'
+
+module Blog
+  module Jekyll
+    def self.build(config)
+      conf = ::Jekyll.configuration(
+        {
+          'source' => config.blog_repo,
+          'destination' => config.site_dir
+        }
+      )
+      ::Jekyll::Site.new(conf).process
+    end
+  end
+end

data/lib/blog/journal.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'org-ruby'
+
+module Blog
+  # Journal
+  class Journal
+    def self.from_file(path)
+      new(Orgmode::Parser.load(path))
+    end
+
+    def logger
+      Blog::Log.logger
+    end
+
+    def initialize(parser)
+      @parser = parser
+    end
+
+    def public_entries
+      @public_entries ||= all_entries.select(&:public?).sort_by(&:date).reverse
+    end
+
+    def private_entries
+      @private_entries ||= all_entries.reject(&:public?).sort_by(&:date).reverse
+    end
+
+    def write_public_entries!(dir)
+      public_entries.each do |entry|
+        target = File.join(dir, entry.filename)
+        logger.debug "writing #{entry.title} to #{target.pretty_path}"
+        File.open(target, 'w+') { |f| f.write(entry.to_html) }
+      end
+    end
+
+    def all_entries
+      entry_headlines.map { |h| Entry.new(h) }
+    end
+
+    private
+
+    def entry_headlines
+      @parser.headlines.select { |h| h.level == 3 }
+    end
+  end
+end

data/lib/blog/log.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module Blog
+  # Log
+  module Log
+    def self.logger
+      @logger ||= default_logger
+    end
+
+    def self.default_logger
+      logger = Logger.new(STDOUT)
+      logger.level = Logger::INFO
+      logger.formatter = proc do |severity, _datetime, _progname, msg|
+        "blog: #{msg}\n"
+      end
+      logger
+    end
+
+    def self.level=(setting)
+      @logger.level = case setting.upcase
+                      when 'DEBUG'
+                        Logger::DEBUG
+                      else
+                        Logger::INFO
+                      end
+    end
+  end
+end