jekyll-og-image 1.5.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 260918d98e574361037584e4d0d4097dd41fdcd3526386d3abfde00e2dc4b0f6
-  data.tar.gz: e0c75eec8ddb3f3911aac2ef2b45687ecc1bb036057ed183802570a82f1a4922
+  metadata.gz: ea51d4a05adcc40de23c17b92e31139f154176500960782aa592864c71cbd334
+  data.tar.gz: a31cc539176deac7ad1e8fd0dea3b4fd45efd906a02d439766e8df82d80adceb
 SHA512:
-  metadata.gz: 16f6da984ff3821513fdfd51eb9beb06e45bfb76c4530464ebc2f7d9164985a4583ec894258580ea125aed96b9ea489acc55332adc920cfda64e7f9f4c7ec3ee
-  data.tar.gz: eb147ebfeb11d50a80370ced4b82b33c1b33730c6b087c3eddc2871b6aed570dac8014cd01f687711b4f316cdf51bb9cf37cbb8eb82b58e048bafa8f3a21bcac
+  metadata.gz: 5e3929c8ddee908ae78375186bacffab40da5813432d4a563ab4f61b5767b011cf69959842a0e2f05f4b6d899029d08aec3c9d531154162ef4de6cb2a4ba4c99
+  data.tar.gz: 2470a7946363160ebfebc258c5326089976b91a620d2bde2edc35c76149eec1a6d6f0d739812e8917e96b1910fa13a53c7c9e15198688207ebaef5f61a04cce2

data/.rubocop.yml

@@ -7,4 +7,7 @@ AllCops:
 
 Style/FrozenStringLiteralComment:
   Enabled: true
-  EnforcedStyle: always
+  EnforcedStyle: always
+
+Rails/RefuteMethods:
+  Enabled: false

data/README.md

@@ -22,6 +22,59 @@ plugins:
   - jekyll-og-image
 ```
 
+This plugin requires `libvips` to be installed. If you are using GitHub Pages to host your Jekyll site, don't forget to install `libvips` before running `jekyll build`. See the example below.
+
+``` yaml
+jobs:
+  build:
+    needs:
+      - lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: .ruby-version
+          bundler-cache: true
+
+      - name: Set Node.js 20.x
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20.x
+
+      - name: Run install
+        uses: borales/actions-yarn@v4
+        with:
+          cmd: install
+
+      - name: Update apt
+        env:
+          DEBIAN_FRONTEND: noninteractive
+        run: sudo apt-get update -qq
+
+      - name: Install libvips
+        env:
+          DEBIAN_FRONTEND: noninteractive
+        run: sudo apt-get install --fix-missing libvips
+
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+
+      - name: Build with Jekyll
+        run: ./bin/jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
+        env:
+          JEKYLL_ENV: production
+
+      - name: Upload artifact
+        # Automatically uploads an artifact from the './_site' directory by default
+        uses: actions/upload-pages-artifact@v3
+
+```
+
 ## Usage
 
 Jekyll OG Image works together with [jekyll-seo-tag](https://github.com/jekyll/jekyll-seo-tag) plugin. It automatically generates open graph images for posts and inserts them into the posts metadata.
@@ -44,6 +97,8 @@ The following configuration options are available:
 * `canvas` – The canvas configuration options:
   * `background_color` – The background color of the canvas. Default: `#FFFFFF`
   * `background_image` – The background image of the canvas. Default: `nil`
+  * `width` – The width of the generated image in pixels. Default: `1200`
+  * `height` – The height of the generated image in pixels. Default: `600`
 
 * `header` – The header configuration options:
   * `font_family` – The font family of the header text. Default: `Helvetica, Bold`

data/Rakefile

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require "minitest/test_task"
 
-RSpec::Core::RakeTask.new(:spec)
+Minitest::TestTask.create
 
 require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
-task default: %i[spec rubocop]
+task default: %i[test rubocop]

data/lib/jekyll_og_image/configuration.rb

@@ -3,8 +3,8 @@
 # require "anyway_config"
 
 class JekyllOgImage::Configuration
-  Canvas = Data.define(:background_color, :background_image) do
-    def initialize(background_color: "#FFFFFF", background_image: nil)
+  Canvas = Data.define(:background_color, :background_image, :width, :height) do
+    def initialize(background_color: "#FFFFFF", background_image: nil, width: 1200, height: 600)
       super
     end
   end
@@ -53,6 +53,10 @@ class JekyllOgImage::Configuration
     @raw_config["collections"] || [ "posts" ]
   end
 
+  def enabled?
+    @raw_config["enabled"].nil? ? true : @raw_config["enabled"]
+  end
+
   def output_dir
     @raw_config["output_dir"] || "assets/images/og"
   end

data/lib/jekyll_og_image/generator.rb

@@ -36,6 +36,7 @@ class JekyllOgImage::Generator < Jekyll::Generator
                             # rubocop:enable Layout/ElseAlignment
                             File.basename(item.name, File.extname(item.name))
       end
+
       slug = item.data["slug"] || Jekyll::Utils.slugify(item.data["title"] || fallback_basename)
       image_filename = "#{slug}.png"
       absolute_image_path = File.join(absolute_output_dir, image_filename)
@@ -50,8 +51,8 @@ class JekyllOgImage::Generator < Jekyll::Generator
 
       item.data["image"] ||= {
         "path" => relative_image_path,
-        "width" => 1200,
-        "height" => 600,
+        "width" => JekyllOgImage.config.canvas.width,
+        "height" => JekyllOgImage.config.canvas.height,
         "alt" => item.data["title"]
       }
     end
@@ -76,6 +77,8 @@ class JekyllOgImage::Generator < Jekyll::Generator
   def generate_image_for_document(site, item, path, base_config)
     config = base_config.merge!(item.data["og_image"] || {})
 
+    return unless config.enabled?
+
     canvas = generate_canvas(site, config)
     canvas = add_border_bottom(canvas, config) if config.border_bottom
     canvas = add_image(canvas, File.read(File.join(site.config["source"], config.image))) if config.image
@@ -93,7 +96,7 @@ class JekyllOgImage::Generator < Jekyll::Generator
       File.exist?(bg_path) ? File.read(bg_path) : nil
     end
 
-    JekyllOgImage::Element::Canvas.new(1200, 600,
+    JekyllOgImage::Element::Canvas.new(JekyllOgImage.config.canvas.width, JekyllOgImage.config.canvas.height,
       background_color: config.canvas.background_color,
       background_image: background_image
     )

data/lib/jekyll_og_image/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JekyllOgImage
-  VERSION = "1.5.0"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-og-image
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Igor Alexandrov