middleman-social_image 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fb0b030a5107566244948ab289a30177c59bd5d5754022fc32d816507b7540fe
+  data.tar.gz: 63da5dd031a4a50a2df41f05ad10816e5c0b7853a823d4a10850df693ae24ccd
+SHA512:
+  metadata.gz: 4eb79e1af1523f4fd77a616d108a8b53440c3122690a98c338cb8a164ea4262a9726b8686314b5ffa15d8b18604cd9ffb1b11f3db516f7f597146fb2823db4f9
+  data.tar.gz: 99c2d6ebaad6d2a4dbaa1e03c6ed2d903411183137b612e710ccc134bc5367c1f63a6418ddf020811679d57194302e9d807995093fcf76b89698fddf5ca7dfcd

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in middleman-social_image.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Paul McMahon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+# 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'middleman-social_image'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+You need to add the following code to your ```config.rb``` file:
+
+```ruby
+activate :social_image
+```
+
+Optionally, you can configure this extension with the following (defaults are shown):
+
+```ruby
+activate :social_image do |social_image|
+  social_image.path_to_chrome = '/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome' # Command to execute chrome
+  social_image.window_size = '1200,600' # The size of the screenshot
+  social_image.base_url = 'http://localhost:4567/' # Base URL of running middleman server
+  social_image.base_asset_dir = 'assets/images/social-images' # Where to save the generated images
+  social_image.social_image_url_pattern = %r{(/social-image)/$}  # Screenshot URLs matching this pattern
+  social_image.social_image_url_substitution, '\1.png' # When generating screenshots, replace URLs matching social_image_url_pattern with this
+end
+```
+
+Create a HTML page in your middleman app that contains the HTML you want to be rendered. The URL for this should match the social_image_url_pattern (so by default, ending with `/social-image/`).
+
+Start up the middleman server with `bundle exec middleman server`
+
+Run the `bundle exec middleman social_image` command to generate images from any URLs matching social_image_url_pattern. The image will be saved to a location matching the URL of the resource used to generate it, with the social_image_url_substitution applied, in the base_asset_dir. So with the default settings, if for instance you had created a page at `/examples/social-image/`, this image would be saved at `assets/images/social-images/examples/social-image.png`.
+
+You can now refer to this image as normal within your middleman application.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "middleman/social_image"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/middleman-social_image.rb

@@ -0,0 +1,8 @@
+require "middleman-core"
+require 'middleman-social_image/version'
+
+Middleman::Extensions.register :social_image do
+  require "middleman-social_image/extension"
+  require 'middleman-social_image/commands'
+  Middleman::SocialImage::Extension
+end

data/lib/middleman-social_image/commands.rb

@@ -0,0 +1,39 @@
+require 'middleman-cli'
+
+module Middleman
+  module Cli
+    class SocialImage < Thor::Group
+      include Thor::Actions
+
+      check_unknown_options!
+
+      namespace :social_image
+
+      def self.exit_on_failure?
+        true
+      end
+
+      def social_image
+        app = ::Middleman::Application.new do
+          config[:mode]              = :config
+          config[:watcher_disable]   = true
+        end
+        options = app.extensions[:social_image].options
+        app.sitemap.resources.each do |resource|
+          if resource.url =~ options.social_image_url_pattern
+            image_path = File.join(app.source_dir, options.base_asset_dir, resource.url.sub(options.social_image_url_pattern, options.social_image_url_substitution))
+            if File.exists?(image_path)
+              say "Image for #{resource.url} already generated, skipping."
+            else
+              FileUtils.mkdir_p(File.dirname(image_path))
+              url = File.join(options.base_url, resource.url)
+              run "#{options.path_to_chrome}  --headless --disable-gpu --screenshot=#{image_path} --window-size=#{options.window_size} #{url}"
+            end
+          end
+        end
+      end
+    end
+
+    Base.register(Middleman::Cli::SocialImage, 'social_image', 'social_image [options]', 'Generates social images.')
+  end
+end

data/lib/middleman-social_image/extension.rb

@@ -0,0 +1,11 @@
+require 'middleman-core'
+require 'middleman-social_image/commands'
+
+class Middleman::SocialImage::Extension < ::Middleman::Extension
+  option :path_to_chrome, '/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome'
+  option :window_size, '1200,600'
+  option :base_url, 'http://localhost:4567/'
+  option :base_asset_dir, 'assets/images/social-images'
+  option :social_image_url_pattern, %r{(/social-image)/$}
+  option :social_image_url_substitution, '\1.png'
+end

data/lib/middleman-social_image/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+  module SocialImage
+    VERSION = '0.0.1'.freeze
+  end
+end

data/middleman-social_image.gemspec

@@ -0,0 +1,25 @@
+require_relative 'lib/middleman-social_image/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "middleman-social_image"
+  spec.version       = Middleman::SocialImage::VERSION
+  spec.authors       = ["Paul McMahon"]
+  spec.email         = ["paul@tokyodev.com"]
+
+  spec.summary       = %q{Generate social images with Middleman.}
+  spec.homepage      = "https://github.com/pwim/middleman-social_image"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/pwim/middleman-social_image"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: middleman-social_image
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Paul McMahon
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-08 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- paul@tokyodev.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/middleman-social_image.rb
+- lib/middleman-social_image/commands.rb
+- lib/middleman-social_image/extension.rb
+- lib/middleman-social_image/version.rb
+- middleman-social_image.gemspec
+homepage: https://github.com/pwim/middleman-social_image
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/pwim/middleman-social_image
+  source_code_uri: https://github.com/pwim/middleman-social_image
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Generate social images with Middleman.
+test_files: []