jekyll-recker 1.2.2 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7c17927e227e392e2bf48faf7e623e463ab8ef3647f83ddbca8217980bbb511
-  data.tar.gz: e59bab85cee9f9c5e5d2aedbf4a3978df4f68bc0b06657a31e5e45b7f37f0ac4
+  metadata.gz: 853460ad6e8cc68998d94ec9b8370fcc8c91ac36e464c20bb503a430c0b61775
+  data.tar.gz: b41ff9a6f988de20e74265844092d6bda6a458f3720e9ac49c8276f07702c0e7
 SHA512:
-  metadata.gz: bf113a841c5986758ab082aadcdd094d5db6ffbdfe8d53e877b3a37093f3a457cb2b44431b8d0b5b41dde677d0912f1d0e72422e90831089485058f3f96acbd7
-  data.tar.gz: 17758558184be22b37e0fae164c77226e8d5cee64d4884367ddbbc1566348cf7f1a56634a68ec09a37d5d464398e052364cc0ad5b36ffba1b63a66f7fcc41099
+  metadata.gz: 3e8981f6cfe48b770faca2e93836c4f85994237e981cb2b767d760cc23f9decfdc4f24f800daf1b759258efd9b9ff060444034cb3d91a4534a471f5ca19306e0
+  data.tar.gz: 3d9c4aaacc354e02570cf31c18761a02b529cd6b624a389e6e8effe50db599678850e1ec19ea32e0353e33905a97e72e1e40f9060b1324ce112357473e110a03

data/README.md

@@ -0,0 +1,105 @@
+# jekyll-recker
+
+The Greatest Jekyll Plugin in the World.  For a live example, check
+out [my personal website].
+
+## 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 TWITTER_ACCESS_TOKEN_SECRET="..."
+    export TWITTER_ACCESS_TOKEN="..."
+    export TWITTER_CONSUMER_API_KEY="..."
+    export TWITTER_CONSUMER_API_SECRET="..."
+
+[example slack]: screenshots/example-slack.png
+[example tweet]: screenshots/example-tweet.png
+[my personal website]: https://www.alexrecker.com

data/_includes/figure.html

@@ -0,0 +1,14 @@
+<figure>
+  {%- if include.url %}
+  <a href="{{ include.url }}">
+  {%- endif %}
+  <img alt="{{ alt | default: include.filename }}" src="{{ site.baseurl }}assets/images/{{ include.filename }}"/>
+  {%- if include.url %}
+  </a>
+  {%- endif %}
+  {%- if include.caption %}
+  <figcaption>
+    <p>{{ include.caption }}</p>
+  </figcaption>
+  {%- endif %}
+</figure>

data/_includes/footer.html

@@ -1,5 +1,14 @@
 <footer>
-  built with <a href="https://jekyllrb.com/">jekyll</a> using <a href="{% link README.org %}">jekyll-recker</a> v{% recker_version %}
+  <nav>
+    find me on: &nbsp
+    <a href="mailto:{{ site.email }}">email</a>
+    <a href="https://www.github.com/{{ site.github_username }}">github</a>
+    <a href="https://www.twitter.com/{{ site.twitter_username }}">twitter</a>
+    <a href="{{ site.basurl }}/assets/public.gpg.asc">gpg</a>
+    <a href="https://www.linkedin.com/in/{{ site.linkedin_username }}">linkedin</a>
+    <a href="https://www.facebook.com/{{ site.facebook_username }}">facebook</a>
+  </nav>
+  built with <a href="https://jekyllrb.com/">jekyll</a> using <a href="https://www.github.com/arecker/jekyll-recker/">jekyll-recker</a> v{% recker_version %}
   <br/>
   <small>&copy; copyright {{ 'now' | date: '%Y' }}, {{ site.author }}</small>
 </footer>

data/_includes/head.html

@@ -0,0 +1,21 @@
+{%- capture title %}{{ include.title | default: page.title }}{%- endcapture %}
+{%- capture description %}{{ include.description | default: site.description }}{%- endcapture %}
+{%- capture image %}{{ include.image | default: page.image }}{%- endcapture %}
+<head>
+  <meta charset="UTF-8"/>
+  <title>{{ title }} | {{ description }}</title>
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <meta name="twitter:card" content="summary" />
+  <meta name="twitter:site" content="@{{ site.twitter_username }}" />
+  <meta name="twitter:title" content="{{ include.title }}" />
+  <meta name="twitter:description" content="{{ include.description }}" />
+  <meta property="og:url" content="{{ site.url }}{{ page.url }}" />
+  <meta property="og:type" content="article" />
+  <meta property="og:title" content="{{ title }}"/>
+  <meta property="og:description" content="{{ description }}" />
+  {%- if image %}
+  <meta name="twitter:image" content="{{ site.url }}{{ site.base_url }}/assets/images/{{ image }}"/>
+  <meta property="og:image" content="{{ site.url }}{{ site.base_url }}/assets/images/{{ image }}"/>
+  {%- endif %}
+  <link href="{{ site.baseurl }}/assets/jekyll-recker.css" rel="stylesheet"/>
+</head>

data/_includes/nav.html

@@ -1,8 +1,5 @@
 <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="{{ site.baseurl }}/" class="{% if page.active == 'index' %}active{% endif %}">index.html</a>
+  <a href="{{ site.basurl }}/feed.xml">feed.xml</a>
   <span class="float-right hide-on-mobile">{{ page.slug }}</span>
-</nav> 
+</nav>

data/_includes/pager.html

@@ -0,0 +1,13 @@
+<nav class="clearfix">
+  {%- if page.next -%}
+  <a href="{{ page.next.url }}">
+    ⟵ {{ page.next.slug }}
+  </a>
+  {%- endif -%}
+  {%- if page.previous -%}
+  <a class="float-right" href="{{ page.previous.url }}">
+    {{ page.previous.slug }} ⟶
+  </a>
+  {%- endif -%}
+</nav>
+

data/_layouts/home.html

@@ -1,9 +1,13 @@
----
-layout: default
----
-{% include header.html title=site.title subtitle=site.description %}
-<hr/>
-{% include nav.html %}
-<hr/>
-{{ content }}
-
+<!doctype html>
+<html lang="en">
+  {% include head.html title=site.title %}
+  <body>
+    {% include header.html title=site.title subtitle=site.description %}
+    <hr/>
+    {% include nav.html %}
+    <hr/>
+    {{ content }}
+    <hr/>
+    {% include footer.html %}
+  </body>
+</html>

data/_layouts/page.html

@@ -1,8 +1,13 @@
----
-layout: default
----
-{% include header.html title=page.title subtitle=page.description %}
-<hr/>
-{% include nav.html %}
-<hr/>
-{{ content }}
+<!doctype html>
+<html lang="en">
+  {% include head.html title=site.title %}
+  <body>
+    {% include header.html title=page.title subtitle=page.description %}
+    <hr/>
+    {% include nav.html %}
+    <hr/>
+    {{ content }}
+    <hr/>
+    {% include footer.html %}
+  </body>
+</html>

data/_layouts/post.html

@@ -1,28 +1,20 @@
----
-layout: default
----
-{% capture datestring %}{{ page.date | date: '%A, %B %d %Y' }}{% endcapture %}
-{% include header.html title=datestring subtitle=page.title %}
-<hr/>
-{% include nav.html %}
-<hr/>
-{%- if page.image -%}
-<br/>
-<figure>
-  <img alt="page.image" src="{{ site.baseurl }}assets/images/{{ page.image }}"/>
-</figure>
-<br/>
-{%- endif -%}
-{{ content }}
-<nav class="clearfix">
-  {%- if page.next -%}
-  <a href="{{ page.next.url }}">
-    ⟵ {{ page.next.slug }}
-  </a>
-  {%- endif -%}
-  {%- if page.previous -%}
-  <a class="float-right" href="{{ page.previous.url }}">
-      {{ page.previous.slug }} ⟶
-  </a>
-</nav>
-{%- endif -%}
+{%- capture datestring %}{{ page.date | uyd_date }}{% endcapture %}
+<!doctype html>
+<html lang="en">
+  {% include head.html title=datestring description=page.title %}
+  <body>
+    {% include header.html title=datestring subtitle=page.title %}
+    <hr/>
+    {% include nav.html %}
+    <hr/>
+    {%- if page.image -%}
+    <br/>
+    {% include figure.html filename=page.image %}
+    <br/>
+    {%- endif -%}
+    {{ content }}
+    {% include pager.html %}
+    <hr/>
+    {% include footer.html %}
+  </body>
+</html>

data/lib/jekyll-recker.rb

@@ -5,19 +5,17 @@ require 'jekyll'
 module Jekyll
   # Recker
   module Recker
-    require 'jekyll-recker/logger.rb'
-    require 'jekyll-recker/mixins.rb'
+    require 'jekyll_recker/mixins.rb'
 
-    require 'jekyll-recker/commands.rb'
-    require 'jekyll-recker/configuration.rb'
-    require 'jekyll-recker/error.rb'
-    require 'jekyll-recker/generators.rb'
-    require 'jekyll-recker/shell.rb'
-    require 'jekyll-recker/slack.rb'
-    require 'jekyll-recker/stats.rb'
-    require 'jekyll-recker/tags.rb'
-    require 'jekyll-recker/twitter.rb'
-    require 'jekyll-recker/version.rb'
-    require 'jekyll-recker/words.rb'
+    require 'jekyll_recker/commands.rb'
+    require 'jekyll_recker/configuration.rb'
+    require 'jekyll_recker/error.rb'
+    require 'jekyll_recker/filters.rb'
+    require 'jekyll_recker/generators.rb'
+    require 'jekyll_recker/shell.rb'
+    require 'jekyll_recker/social.rb'
+    require 'jekyll_recker/tags.rb'
+    require 'jekyll_recker/version.rb'
+    require 'jekyll_recker/words.rb'
   end
 end

data/lib/jekyll_recker/commands.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Recker
+    # Commands
+    module Commands
+      # Share
+      class Share < Jekyll::Command
+        include Mixins::Logging
+
+        def self.init_with_program(prog)
+          prog.command(:share) do |c|
+            c.syntax 'share'
+            c.description 'Share latest post with each configured backend'
+            c.option 'dry', '-d', '--dry', 'perform dry run'
+            c.action { |args, opts| action(args, opts) }
+          end
+        end
+
+        def self.action(args, options)
+          args += %w[slack twitter] if args.empty?
+          Recker::Social::Slack.share(dry: options['dry']) if args.include?('slack')
+          Recker::Social::Twitter.share(dry: options['dry']) if args.include?('twitter')
+        rescue ReckerError => e
+          logger.error e.message
+          exit 1
+        end
+      end
+    end
+  end
+end

data/lib/{jekyll-recker → jekyll_recker}/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Recker
     # Configuration
@@ -10,6 +12,10 @@ module Jekyll
         jekyll.fetch('recker', {})
       end
 
+      def self.facebook
+        recker.fetch('facebook', {})
+      end
+
       def self.twitter
         recker.fetch('twitter', {})
       end

data/lib/jekyll_recker/filters.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Recker
+    # Filters
+    module Filters
+      # Converts a date object to standard Uhh Yeah Dude format.
+      def uyd_date(date)
+        date.strftime('%A, %B %d %Y')
+      end
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::Recker::Filters)

data/lib/{jekyll-recker/stats.rb → jekyll_recker/generators.rb}

@@ -1,41 +1,44 @@
 # frozen_string_literal: true
 
-require 'date'
-
 module Jekyll
   module Recker
-    # Stats
-    module Stats
-      include Jekyll::Recker::LoggingMixin
-
-      def self.crunch(site)
-        stats = {}
-        BaseCruncher.descendants.each do |cruncher_class|
-          cruncher = cruncher_class.new(site)
-          logger.info "crunching stats.#{cruncher.stats_key}"
-          stats[cruncher.stats_key] = cruncher.crunch
-        end
-        stats
-      end
-
-      # Base Cruncher
-      class BaseCruncher
+    module Generators
+      # Stats Module
+      #
+      # Functions for stats generators.
+      # @abstract
+      module Stats
+        include Mixins::Logging
         include Jekyll::Filters
-        include DescendantsMixin
 
-        def initialize(site)
-          @site = site
+        def key
+          self.class.const_get(:KEY)
         end
 
-        private
+        def generate(site)
+          @site = site
+          logger.info "crunching stats.#{key}"
+          @site.data['stats'] ||= {}
+          @site.data['stats'][key] = crunch
+        end
 
-        attr_reader :journal
+        def crunch
+          raise NotImplementedError, '#crunch not implemented!'
+        end
 
+        # Calculates the average of a list of numbers.
+        #
+        # @param [Array<Numeric>] numlist list of numbers to be averaged.
+        # @return [Numeric] rounded, calculated average of numlist.
         def average(numlist)
           calc = numlist.inject { |sum, el| sum + el }.to_f / numlist.size
           calc.round
         end
 
+        # Calculates the total of a list of numbers.
+        #
+        # @param [Array<Numeric>] numlist list of numbers to be totaled.
+        # @return [Numeric] calculated total of numlist.
         def total(numlist)
           numlist.inject(0) { |sum, x| sum + x }
         end
@@ -45,22 +48,22 @@ module Jekyll
         end
       end
 
-      # PostCountCruncher
-      class PostCountCruncher < BaseCruncher
-        def stats_key
-          'posts'
-        end
+      # Post Count Generator
+      class PostCount < Jekyll::Generator
+        include Stats
+
+        KEY = 'posts'
 
         def crunch
           entries.count.pretty
         end
       end
 
-      # WordCountCruncher
-      class WordCountCruncher < BaseCruncher
-        def stats_key
-          'words'
-        end
+      # Word Count Generator
+      class Words < Jekyll::Generator
+        include Stats
+
+        KEY = 'words'
 
         def crunch
           total_counts = entries.collect(&:content).map { |c| number_of_words(c) }
@@ -71,11 +74,11 @@ module Jekyll
         end
       end
 
-      # Streak Cruncher
-      class StreakCruncher < BaseCruncher
-        def stats_key
-          'days'
-        end
+      # Streak Count Generator
+      class Streaks < Jekyll::Generator
+        include Stats
+
+        KEY = 'days'
 
         def crunch
           streaks.take(1).map do |count, dates|
@@ -94,7 +97,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