jekyll-recker 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7c17927e227e392e2bf48faf7e623e463ab8ef3647f83ddbca8217980bbb511
-  data.tar.gz: e59bab85cee9f9c5e5d2aedbf4a3978df4f68bc0b06657a31e5e45b7f37f0ac4
+  metadata.gz: fd8510af30e4a225fa87cd6d3ba197cd38517634947897ca60ccfccc80055dbd
+  data.tar.gz: 94e7fee9f82e53e73658cadee253f7dcb592404c81cf785dd74b86772dbd9052
 SHA512:
-  metadata.gz: bf113a841c5986758ab082aadcdd094d5db6ffbdfe8d53e877b3a37093f3a457cb2b44431b8d0b5b41dde677d0912f1d0e72422e90831089485058f3f96acbd7
-  data.tar.gz: 17758558184be22b37e0fae164c77226e8d5cee64d4884367ddbbc1566348cf7f1a56634a68ec09a37d5d464398e052364cc0ad5b36ffba1b63a66f7fcc41099
+  metadata.gz: 892465a9e44dd0317193f1f927fab37e50e88648c7360eadd314bc8eb36ace26449ed0c18c7b5e88e2c1f17c2f12daf3d06e770877db231c6d2d8719a25bee89
+  data.tar.gz: 3a742c9c17d0079d309f40da244b7db9c7df5b49c7ee76598e4b84364abdfd13ea08605f05213562a2306b0f6982722a49c831f43ba4df55cc221535951857c2

data/README.md

@@ -0,0 +1,106 @@
+# jekyll-recker
+
+This is the jekyll plugin I use for [my personal website].  The source
+code is available on [github].
+
+## Installation
+
+Add `jekyll-recker` to the `jekyll_plugins` group in your `Gemfile`.
+
+    group :jekyll_plugins do
+      gem 'jekyll-recker'
+    end
+
+Then add the plugin to jekyll site's `config.yml` file.
+
+    pugins:
+      - jekyll-recker
+
+If you'd like to make your site look like mine too, set the theme in
+`config.yml` too.
+
+    theme: jekyll-recker
+
+## Usage
+
+### Share
+
+Use the `share` jekyll command to post a link to your latest published
+blog post to any or all of the configured Shares.
+
+    # TODO: example of `be jekyll share`
+
+Perform a test run with the `--dry` flag.
+
+    # TODO: example of `be jekyll share --dry`
+
+Send to all configured shares, or just pick one of them.
+
+    $ jekyll share slack
+	$ jekyll share twitter
+
+#### Slack
+
+Send the latest published post to a slack channel.
+
+![example slack]
+
+Configure the slack share in `_config.yml`.
+
+    recker:
+      slack:
+        myteam:
+          channel: '#blogs'
+          username: 'blogbot'
+          emoji: ':robot:'
+          webhook_cmd: cat ~/.secrets/slack-webhook.txt
+
+Use the `webhook_cmd` option to shell out to `gpg` or another CLI
+password manager.  Alternatively, you can supply the private incoming
+webhook using an environment variable.
+
+    export SLACK_MYTEAM_WEBHOOK="https://.../"  # SLACK_ + MyTeam.upcase + _WEBHOOK
+
+Multiple teams are supported as well.
+
+    recker:
+      slack:
+        MyTeamA:
+          channel: '#blogs'
+          username: 'blogbot'
+          emoji: ':robot:'
+        MyTeamB:
+          channel: '#blogs'
+          username: 'blogbot'
+          emoji: ':robot:'
+        MyTeamC:
+          channel: '#blogs'
+          username: 'blogbot'
+          emoji: ':robot:'
+
+#### Twitter
+
+Send a tweet with a link to the latest published post.
+
+![example tweet]
+
+Configure the tweet share in `_config.yml`.
+
+    recker:
+      twitter:
+        access_token_secret_cmd: pass twitter/reckerbot/access-token-secret
+        access_token_cmd: pass twitter/reckerbot/access-token
+        consumer_api_key_cmd: pass twitter/reckerbot/consumer-api-key
+        consumer_api_secret_cmd: pass twitter/reckerbot/consumer-api-secret-key
+
+Alternatively, ensure these environment variables are set.
+
+    export ACCESS_TOKEN_SECRET="..."
+    export ACCESS_TOKEN="..."
+    export CONSUMER_API_KEY="..."
+    export CONSUMER_API_SECRET="..."
+
+[example slack]: screenshots/example-slack.png
+[example tweet]: screenshots/example-tweet.png
+[github]: https://www.github.com/arecker/blog
+[my personal website]: https://www.alexrecker.com

data/_includes/footer.html

@@ -1,5 +1,5 @@
 <footer>
-  built with <a href="https://jekyllrb.com/">jekyll</a> using <a href="{% link README.org %}">jekyll-recker</a> v{% recker_version %}
+  built with <a href="https://jekyllrb.com/">jekyll</a> using <a href="{% link doc/index.html %}">jekyll-recker</a> v{% recker_version %}
   <br/>
   <small>&copy; copyright {{ 'now' | date: '%Y' }}, {{ site.author }}</small>
 </footer>

data/_includes/nav.html

@@ -1,8 +1,8 @@
 <nav>
   <a href="{{ site.baseurl }}/" class="{% if page.active == 'index' %}active{% endif %}">index</a>
   <a href="{% link archive.html %}" class="{% if page.active == 'archive' %}active{% endif %}">archive</a>
-  <a href="{% link stats.org %}" class="{% if page.active == 'stats' %}active{% endif %}">stats</a>
-  <a href="{% link projects.html %}" class="{% if page.active == 'projects' %}active{% endif %}">projects</a>
-  <a href="{% link contact.html %}" class="{% if page.active == 'contact' %}active{% endif %}">contact</a>
+  <a href="{% link stats.md %}" class="{% if page.active == 'stats' %}active{% endif %}">stats</a>
+  <a href="{% link projects.md %}" class="{% if page.active == 'projects' %}active{% endif %}">projects</a>
+  <a href="{% link contact.md %}" class="{% if page.active == 'contact' %}active{% endif %}">contact</a>
   <span class="float-right hide-on-mobile">{{ page.slug }}</span>
 </nav> 

data/_layouts/default.html

@@ -3,7 +3,9 @@
   <head>
     <meta charset="UTF-8"/>
     <title>{{ site.title }} | {{ page.title | default: site.description }}</title>
-    <meta name="viewport" content="width=device-width, initial-scale=1">  
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <link href="{{ site.baseurl }}/assets/open-sans.css" rel="stylesheet"/>
+    <link href="{{ site.baseurl }}/assets/inconsolata.css" rel="stylesheet"/>
     <link href="{{ site.baseurl }}/assets/jekyll-recker.css" rel="stylesheet"/>
   </head>
   <body>

data/assets/inconsolata.css

@@ -0,0 +1,27 @@
+/* vietnamese */
+@font-face {
+  font-family: 'Inconsolata';
+  font-style: normal;
+  font-weight: 400;
+  font-display: swap;
+  src: local('Inconsolata Regular'), local('Inconsolata-Regular'), url(https://fonts.gstatic.com/s/inconsolata/v18/QldKNThLqRwH-OJ1UHjlKGlW5qhExfHwNJU.woff2) format('woff2');
+  unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+1EA0-1EF9, U+20AB;
+}
+/* latin-ext */
+@font-face {
+  font-family: 'Inconsolata';
+  font-style: normal;
+  font-weight: 400;
+  font-display: swap;
+  src: local('Inconsolata Regular'), local('Inconsolata-Regular'), url(https://fonts.gstatic.com/s/inconsolata/v18/QldKNThLqRwH-OJ1UHjlKGlX5qhExfHwNJU.woff2) format('woff2');
+  unicode-range: U+0100-024F, U+0259, U+1E00-1EFF, U+2020, U+20A0-20AB, U+20AD-20CF, U+2113, U+2C60-2C7F, U+A720-A7FF;
+}
+/* latin */
+@font-face {
+  font-family: 'Inconsolata';
+  font-style: normal;
+  font-weight: 400;
+  font-display: swap;
+  src: local('Inconsolata Regular'), local('Inconsolata-Regular'), url(https://fonts.gstatic.com/s/inconsolata/v18/QldKNThLqRwH-OJ1UHjlKGlZ5qhExfHw.woff2) format('woff2');
+  unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
+}

data/assets/jekyll-recker.scss

@@ -1,7 +1,5 @@
 ---
 ---
-@import 'https://fonts.googleapis.com/css?family=Open+Sans&display=swap';
-@import 'https://fonts.googleapis.com/css?family=Inconsolata&display=swap';
 
 .float-right {
     float: right;
@@ -43,8 +41,6 @@ h1, h2, h3 {
 }
 
 header {
-    text-transform: lowercase;
-
     h1 {
 	margin-bottom: 9px;
     }

data/assets/open-sans.css

@@ -0,0 +1,63 @@
+/* cyrillic-ext */
+@font-face {
+  font-family: 'Open Sans';
+  font-style: normal;
+  font-weight: 400;
+  font-display: swap;
+  src: local('Open Sans Regular'), local('OpenSans-Regular'), url(https://fonts.gstatic.com/s/opensans/v17/mem8YaGs126MiZpBA-UFWJ0bf8pkAp6a.woff2) format('woff2');
+  unicode-range: U+0460-052F, U+1C80-1C88, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;
+}
+/* cyrillic */
+@font-face {
+  font-family: 'Open Sans';
+  font-style: normal;
+  font-weight: 400;
+  font-display: swap;
+  src: local('Open Sans Regular'), local('OpenSans-Regular'), url(https://fonts.gstatic.com/s/opensans/v17/mem8YaGs126MiZpBA-UFUZ0bf8pkAp6a.woff2) format('woff2');
+  unicode-range: U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;
+}
+/* greek-ext */
+@font-face {
+  font-family: 'Open Sans';
+  font-style: normal;
+  font-weight: 400;
+  font-display: swap;
+  src: local('Open Sans Regular'), local('OpenSans-Regular'), url(https://fonts.gstatic.com/s/opensans/v17/mem8YaGs126MiZpBA-UFWZ0bf8pkAp6a.woff2) format('woff2');
+  unicode-range: U+1F00-1FFF;
+}
+/* greek */
+@font-face {
+  font-family: 'Open Sans';
+  font-style: normal;
+  font-weight: 400;
+  font-display: swap;
+  src: local('Open Sans Regular'), local('OpenSans-Regular'), url(https://fonts.gstatic.com/s/opensans/v17/mem8YaGs126MiZpBA-UFVp0bf8pkAp6a.woff2) format('woff2');
+  unicode-range: U+0370-03FF;
+}
+/* vietnamese */
+@font-face {
+  font-family: 'Open Sans';
+  font-style: normal;
+  font-weight: 400;
+  font-display: swap;
+  src: local('Open Sans Regular'), local('OpenSans-Regular'), url(https://fonts.gstatic.com/s/opensans/v17/mem8YaGs126MiZpBA-UFWp0bf8pkAp6a.woff2) format('woff2');
+  unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+1EA0-1EF9, U+20AB;
+}
+/* latin-ext */
+@font-face {
+  font-family: 'Open Sans';
+  font-style: normal;
+  font-weight: 400;
+  font-display: swap;
+  src: local('Open Sans Regular'), local('OpenSans-Regular'), url(https://fonts.gstatic.com/s/opensans/v17/mem8YaGs126MiZpBA-UFW50bf8pkAp6a.woff2) format('woff2');
+  unicode-range: U+0100-024F, U+0259, U+1E00-1EFF, U+2020, U+20A0-20AB, U+20AD-20CF, U+2113, U+2C60-2C7F, U+A720-A7FF;
+}
+/* latin */
+@font-face {
+  font-family: 'Open Sans';
+  font-style: normal;
+  font-weight: 400;
+  font-display: swap;
+  src: local('Open Sans Regular'), local('OpenSans-Regular'), url(https://fonts.gstatic.com/s/opensans/v17/mem8YaGs126MiZpBA-UFVZ0bf8pkAg.woff2) format('woff2');
+  unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
+}

data/lib/jekyll-recker/commands/slack.rb

@@ -5,6 +5,7 @@ module Jekyll
     module Commands
       # Slack
       class Slack < Jekyll::Command
+        include LoggingMixin
         class << self
           def init_with_program(prog)
             prog.command(:slack) do |c|
@@ -13,13 +14,13 @@ module Jekyll
               c.option 'dry', '-d', '--dry', 'print message instead of posting'
               c.action do |_args, options|
                 Recker::Slack.each_in_config(dry: options['dry']) do |client|
-                  Recker.info "#{client.key}: discovering webhook"
+                  logger.info "#{client.key}: discovering webhook"
                   client.discover_webhook!
-                  Recker.info "#{client.key}: posting #{client.latest.data['title']}"
+                  logger.info "#{client.key}: posting #{client.latest.data['title']}"
                   client.post_latest!
                 end
               rescue ReckerError => e
-                Recker.abort_with e.message
+                logger.abort_with e.message
               end
             end
           end

data/lib/jekyll-recker/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Recker
     # Configuration

data/lib/jekyll-recker/stats.rb

@@ -94,7 +94,7 @@ module Jekyll
           entry_dates.slice_when do |prev, curr|
             curr != prev - 1
           end.each do |dates|
-            first, last = dates.min, dates.max
+            first, last = dates.minmax
             _streaks << [(last - first).to_i, [first, last]]
           end
           _streaks

data/lib/jekyll-recker/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Recker
-    VERSION = '1.2.2'
+    VERSION = '1.2.3'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-recker
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - Alex Recker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-04 00:00:00.000000000 Z
+date: 2020-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -52,34 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: 
 email:
 - alex@reckerfamily.com
@@ -88,7 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
-- README.org
+- README.md
 - _includes/footer.html
 - _includes/header.html
 - _includes/nav.html
@@ -96,7 +68,9 @@ files:
 - _layouts/home.html
 - _layouts/page.html
 - _layouts/post.html
+- assets/inconsolata.css
 - assets/jekyll-recker.scss
+- assets/open-sans.css
 - lib/jekyll-recker.rb
 - lib/jekyll-recker/commands.rb
 - lib/jekyll-recker/commands/share.rb

data/README.org

@@ -1,205 +0,0 @@
-#+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.  Source code
-available on [[https://github.com/arecker/blog][github]].
-
-** Installation
-
-Add =jekyll-recker= to the =jekyll_plugins= group of your =Gemfile=.
-
-#+BEGIN_SRC ruby
-  group :jekyll_plugins do
-    gem 'jekyll-recker'
-  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
-
-**** =slack=
-
-The =slack= command posts a slack message advertising the latest
-published jekyll blog post using a private incoming webhook.
-
-Configure _config.yml
-
-#+BEGIN_SRC yaml
-  # _config.yml
-  recker:
-    slack:
-      MyTeam:
-        channel: '#blogs'   # required!
-        username: 'blogbot' # required!
-        emoji: ':robot:'    # required!
-#+END_SRC
-
-Multiple teams are supported too!
-
-#+BEGIN_SRC yaml
-  # _config.yml
-  recker:
-    slack:
-      MyTeamA:
-        channel: '#blogs'   # required!
-        username: 'blogbot' # required!
-        emoji: ':robot:'    # required!
-      MyTeamB:
-        channel: '#blogs'   # required!
-        username: 'blogbot' # required!
-        emoji: ':robot:'    # required!
-      MyTeamC:
-        channel: '#blogs'   # required!
-        username: 'blogbot' # required!
-        emoji: ':robot:'    # required!
-#+END_SRC
-
-
-Supply the private webhook through an environment variable.
-
-#+BEGIN_SRC sh
-  export SLACK_MYTEAM_WEBHOOK="https://..."  # SLACK_ + <MyTeam.upcase> + _WEBHOOK
-#+END_SRC
-
-Alternatively, add the command with which to retrieve the webhook in
-_config.yml
-
-#+BEGIN_SRC yaml
-  # _config.yml
-  recker:
-    slack:
-      MyTeam:
-        webhook_cmd: cat secrets/my-teams-secret-webhook.txt
-#+END_SRC
-
-Run =bundle exec jekyll slack= to let it rip!
-
-[[assets/images/example-slack.png]]
-
-Using the =--dry= flag, you can preview the message post without
-actually posting anything.
-
-#+BEGIN_EXAMPLE
-arecker@25732-arecker:~/src/blog$ be jekyll slack --dry
-Configuration file: /Users/arecker/src/blog/_config.yml
-jekyll-recker: reckerfamily: discovering webhook 
-Configuration file: /Users/arecker/src/blog/_config.yml
-jekyll-recker: reckerfamily: posting drag racing, windshield wipers, and alex's painting tips 
-jekyll-recker: postign in dry mode, printing message 
-jekyll-recker: BEGIN MESSAGE
-Sunday, March 15 2020
-drag racing, windshield wipers, and alex's painting tips
-https://www.alexrecker.com/2020-03-15.html
-END MESSAGE 
-#+END_EXAMPLE
-
-**** =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]]
-
-Using the =--dry= flag, you can test your configuration without
-actually tweeting anything.
-
-#+BEGIN_EXAMPLE
-arecker@25732-arecker:~/src/blog$ be jekyll tweet --dry
-jekyll-recker: discovering credentials 
-Configuration file: /Users/arecker/src/blog/_config.yml
-Configuration file: /Users/arecker/src/blog/_config.yml
-jekyll-recker: tweeting drag racing, windshield wipers, and alex's painting tips 
-jekyll-recker: tweeting in dry mode, printing message 
-jekyll-recker: BEGIN TWEET
-Sunday, March 15 2020
-drag racing, windshield wipers, and alex's painting tips
-https://www.alexrecker.com/2020-03-15.html
-END TWEET 
-#+END_EXAMPLE
-
-*** Generators
-
-**** =stats=
-
-On build time, =jekyll-recker= calculates and stores the following
-stats in the =site.data.stats= object
-
-| 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.                          |
-
-Use these variables to render your own page of neat writing statistics!
-
-#+BEGIN_SRC 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