middleman-social_image 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24790c8f3ad949cc2ca924415717b87da699d84f3136d0a7c9249807f17cb3a7
-  data.tar.gz: fe114cadc47468ecc7839a261628814214158718628b659709ead92c3f14d654
+  metadata.gz: 4b33a5a00bdde76bcf00c4c872bcc525e691874adf5bd95a12d92e52f38974e4
+  data.tar.gz: 992ac18e68e3f25e9f9bd8c1ef0b3af7a253e75aef05a442b63ed6278a769323
 SHA512:
-  metadata.gz: 3858b4cbad63083aa173072fe9e316bd19f1d5bc6de862daf5e4173b9fdc979129d6807b40b73670ee9c8c34c8dfc512276ba81fc41b754c7ca14773daa223be
-  data.tar.gz: ceee24fb84151157e046dabc916c4eecaf6263ac2e6b30426e7cb153bc79d7f1c303bf1dc8d8917da617174b4341ae3d51252174203e986de26bf27572f95175
+  metadata.gz: 86ea9bb9a3bb9759e770e1633058c2390594096d182fd68b221c3e67abf0b8fa95800cce97ac0b3eb23a2dc1623cc3c89e451be6b11a12a80c0faa50bb2cff44
+  data.tar.gz: ab6aaf979d769b23ec82ee5d056fd7d6f604b7f298d088472b4ef32a824602ba58555e2f867ff53d466f93f44b978b5ca9e3b42f325c6f7fa4f2e66dbf98e668

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+Gemfile.lock

data/README.md

@@ -1,6 +1,12 @@
 # Middleman::SocialImage
 
-Use HTML and CSS to dynamically generate static images for Open Graph (Facebook, LinkedIn) and Twitter cards in a Middleman application. Image is generated by using Google Chrome in headless mode to screenshot a page served by middleman. Originally created for [tokyodev](https://www.tokyodev.com/), which lists internationally-friendly software developer jobs in Japan.
+Use HTML and CSS to generate images when building your Middleman site. The intended use case is for generating images for use with [the Open Graph protocol](https://ogp.me/), which will be included when someone shares your page on Facebook, Twitter, etc.
+
+Example of an image generated with this extension:
+
+![](https://www.tokyodev.com/2020/05/29/generating-social-images-with-static-site-generators/social-image-714b5c6e.png)
+
+For more background, see [generating social images with static site generators](https://www.tokyodev.com/2020/05/29/generating-social-images-with-static-site-generators/).
 
 ## Installation
 
@@ -26,7 +32,6 @@ Optionally, you can configure this extension with the following (defaults are sh
 activate :social_image do |social_image|
   social_image.window_size = '1200,600' # The size of the screenshot
   social_image.selector = 'body > *' # Used to test that the social image url has loaded properly. The more specific this is, the better the chance of catching errors.
-  social_image.always_generate = true # Always regenerate images. Takes a long time, but ensures any changes are reflected.
   social_image.parallel = true # Generate images in parallel.
   social_image.base_url = "http://localhost:4567/" # When building the site, fetch against this URL.
 end
@@ -42,4 +47,4 @@ end
 
 You can now refer to this image as normal within your middleman application.
 
-In preview mode, you don't need any other special setup. However, to generate the images in build, you also need to be running the preview server. While you can use `bundle exec middleman server`, using a concurrent server like puma can speed up the generation incredibly.
+In preview mode, you don't need any other special setup. However, to generate the images in build, you also need to be running the preview server. While you can use `bundle exec middleman server`, using a concurrent server like puma can speed up the generation incredibly. To do this, you'll need to [create a config.ru file](https://middlemanapp.com/basics/start-new-site/#config-ru).

data/lib/middleman-social_image/converter.rb

@@ -1,10 +1,9 @@
 require "middleman-social_image/capybara"
 class Middleman::SocialImage::Converter
-  def initialize(app, window_size, selector, always_generate, base_url)
+  def initialize(app, window_size, selector, base_url)
     @app = app
     @window_size = window_size
     @selector = selector
-    @always_generate = always_generate
     @base_url = base_url
   end
 
@@ -14,15 +13,11 @@ class Middleman::SocialImage::Converter
 
   def convert(resource)
     image_path = image_path(resource)
-    if File.exist?(image_path) && !@always_generate
-      @app.logger.debug "== social_image: skipping #{resource.path} as already in cache"
-    else
-      @app.logger.debug "== social_image: converting #{resource.path}"
-      session.visit(File.join(@base_url, resource.url))
-      raise "#{resource.url} did not contain '#{@selector}'." unless session.has_selector?(@selector)
-      FileUtils.mkdir_p(File.dirname(image_path))
-      session.save_screenshot(image_path)
-    end
+    @app.logger.debug "== social_image: converting #{resource.path}"
+    session.visit(File.join(@base_url, resource.url))
+    raise "#{resource.url} did not contain '#{@selector}'." unless session.has_selector?(@selector)
+    FileUtils.mkdir_p(File.dirname(image_path))
+    session.save_screenshot(image_path)
   end
 
   private

data/lib/middleman-social_image/extension.rb

@@ -3,7 +3,6 @@ require 'middleman-core'
 class Middleman::SocialImage::Extension < ::Middleman::Extension
   option :window_size, '1200,600'
   option :selector, "body > *"
-  option :always_generate, true
   option :parallel, true
   option :base_url, "http://localhost:4567/"
 
@@ -11,7 +10,7 @@ class Middleman::SocialImage::Extension < ::Middleman::Extension
     super
     require "middleman-social_image/converter"
     require "middleman-social_image/resource"
-    @converter = Middleman::SocialImage::Converter.new(app, options.window_size, options.selector, options.always_generate, options.base_url)
+    @converter = Middleman::SocialImage::Converter.new(app, options.window_size, options.selector, options.base_url)
   end
 
   def manipulate_resource_list(resources)

data/lib/middleman-social_image/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module SocialImage
-    VERSION = '0.0.5'.freeze
+    VERSION = '0.0.6'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-social_image
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Paul McMahon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-27 00:00:00.000000000 Z
+date: 2020-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core