jekyll-og-image 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4abcfee52f43ab5b0a56cbfb1386797c89f183ce031f610ae80c15d9fdb4152a
-  data.tar.gz: 862a6a8209e19993e5f13c9da57a7d2896a695823b8007628a28741f212796cb
+  metadata.gz: eeccdc0ae99d37ef260733506fbad4ebf5c60f925cdb2514acb91dcb346d1673
+  data.tar.gz: b8b291f97eddc6a0be9dc080d2f999be0bb027224bf5bf2953f941a89491b63a
 SHA512:
-  metadata.gz: 9867e3036591d613972c9fd86aa078aa29b79f938c63d089b017c44cce8e8c0d881852e6456bc93c19e770170eec6b535ac807f5957e55bf57c0512dbebb7554
-  data.tar.gz: 691710ca4af48c7a032f37adc1a743fff47d943c1131ffd574832d7ffc48e1c46058bd2149cbadb16735a52cb3575f2d2b42af643fa60e7ab7f8cbc84f1c6546
+  metadata.gz: b15a8205247be628cf982c6efb8f9127cd0ba2eb1d2421e7f7f702802e4960a14317612cfffa010d41972e1b2ba2671eae82f19092552f93b71003995096a21a
+  data.tar.gz: 47b2a2845a7e6bd2a25ef2f249af3fcd1e78adf9179366680e173fc0228aaa5e564be2f5935a0752b3c2c5dd8061b6b17959d7f592fa50ca08d54006baca272c

data/README.md

@@ -2,6 +2,7 @@
 
 A Jekyll plugin to automatically generate open graph images for posts.
 
+[![Gem Version](https://badge.fury.io/rb/jekyll-og-image.svg)](https://badge.fury.io/rb/jekyll-og-image)
 [![Lint](https://github.com/igor-alexandrov/jekyll-og-image/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/igor-alexandrov/jekyll-og-image/actions/workflows/lint.yml)
 [![Specs](https://github.com/igor-alexandrov/jekyll-og-image/actions/workflows/specs.yml/badge.svg?branch=main)](https://github.com/igor-alexandrov/jekyll-og-image/actions/workflows/specs.yml)
 
@@ -46,6 +47,7 @@ og_image:
 ```yaml
 og_image:
   output_dir: "assets/images/og"
+  image: "/assets/images/igor.jpeg"
   domain: "igor.works"
   border_bottom:
     width: 20

data/lib/jekyll_og_image/config.rb

@@ -5,12 +5,15 @@ require "anyway_config"
 class JekyllOgImage::Config < Anyway::Config
   attr_config output_dir: "assets/images/og"
   attr_config force: false
+  attr_config :image
   attr_config :domain
   attr_config border_bottom: {
     width: 20,
     fill: [ "#211F1F", "#F4CBB2", "#AD5C51", "#9CDAF1", "#7DBBE6" ]
   }
 
+  coerce_types image: { type: :string }
+
   coerce_types border_bottom: {
     width: { type: :integer },
     fill: { type: :string, array: true }

data/lib/jekyll_og_image/element/base.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 class JekyllOgImage::Element::Base
+  VALID_GRAVITY = %i[nw ne sw se].freeze
+
   private
 
   def hex_to_rgb(input)
@@ -13,4 +15,10 @@ class JekyllOgImage::Element::Base
       raise ArgumentError, "Unknown input #{input.inspect}"
     end
   end
+
+  def validate_gravity!
+    unless VALID_GRAVITY.include?(@gravity)
+      raise ArgumentError, "Invalid gravity: #{@gravity.inspect}"
+    end
+  end
 end

data/lib/jekyll_og_image/element/canvas.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "vips"
+
+class JekyllOgImage::Element::Canvas < JekyllOgImage::Element::Base
+  def initialize(width, height, color: "#ffffff")
+    @canvas = Vips::Image.black(width, height).ifthenelse([ 0, 0, 0 ], hex_to_rgb(color))
+  end
+
+  def image(source, **opts, &block)
+    image = JekyllOgImage::Element::Image.new(
+      @canvas, source, **opts
+    )
+
+    @canvas = image.apply(&block)
+
+    self
+  end
+
+  def text(message, **opts, &block)
+    text = JekyllOgImage::Element::Text.new(
+      @canvas, message, **opts
+    )
+
+    @canvas = text.apply(&block)
+
+    self
+  end
+
+  def border(width, position: :bottom, fill: "#000000")
+    @canvas = JekyllOgImage::Element::Border.new(
+      @canvas, width,
+      position: position,
+      fill: fill
+    ).apply
+
+    self
+  end
+
+  def save(filename)
+    @canvas.write_to_file(filename)
+  end
+end

data/lib/jekyll_og_image/element/image.rb

@@ -1,33 +1,55 @@
 # frozen_string_literal: true
 
-require "vips"
-
 class JekyllOgImage::Element::Image < JekyllOgImage::Element::Base
-  def initialize(width, height, color: "#ffffff")
-    @canvas = Vips::Image.black(width, height).ifthenelse([ 0, 0, 0 ], hex_to_rgb(color))
+  def initialize(canvas, source, gravity: :nw, width:, height:)
+    @canvas = canvas
+    @gravity = gravity
+    @source = source
+    @width = width
+    @height = height
+
+    validate_gravity!
   end
 
-  def text(message, **opts, &block)
-    text = JekyllOgImage::Element::Text.new(
-      @canvas, message, **opts
-    )
-
-    @canvas = text.apply(&block)
-
-    self
+  def apply(&block)
+    image = Vips::Image.new_from_buffer(@source, "")
+    result = block.call(@canvas, image) if block_given?
+
+    if @width && @height
+      ratio = calculate_ratio(image, @width, @height, :min)
+      image = image.resize(ratio)
+    end
+
+    x, y = result ? [ result.fetch(:x, 0), result.fetch(:y, 0) ] : [ 0, 0 ]
+
+    if gravity_nw?
+      @canvas.composite(image, :over, x: [ x ], y: [ y ]).flatten
+    elsif gravity_ne?
+      x = @canvas.width - image.width - x
+      @canvas.composite(image, :over, x: [ x ], y: [ y ]).flatten
+    elsif gravity_sw?
+      y = @canvas.height - image.height - y
+      @canvas.composite(image, :over, x: [ x ], y: [ y ]).flatten
+    elsif gravity_se?
+      x = @canvas.width - image.width - x
+      y = @canvas.height - image.height - y
+      @canvas.composite(image, :over, x: [ x ], y: [ y ]).flatten
+    end
   end
 
-  def border(width, position: :bottom, fill: "#000000")
-    @canvas = JekyllOgImage::Element::Border.new(
-      @canvas, width,
-      position: position,
-      fill: fill
-    ).apply
+  private
 
-    self
+  VALID_GRAVITY.each do |gravity|
+    define_method("gravity_#{gravity}?") do
+      @gravity == gravity
+    end
   end
 
-  def save(filename)
-    @canvas.write_to_file(filename)
+  def calculate_ratio(image, width, height, mode)
+    if mode == :min
+      [ width.to_f / image.width, height.to_f / image.height ].min
+    else
+      [ width.to_f / image.width, height.to_f / image.height ].max
+    end
   end
 end

data/lib/jekyll_og_image/element/text.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
 class JekyllOgImage::Element::Text < JekyllOgImage::Element::Base
-  VALID_GRAVITY = %i[nw ne sw se].freeze
-
   def initialize(canvas, message, gravity: :nw, width: nil, dpi: nil, color: "#000000", font: nil)
     @canvas = canvas
     @gravity = gravity
@@ -49,10 +47,4 @@ class JekyllOgImage::Element::Text < JekyllOgImage::Element::Base
       @gravity == gravity
     end
   end
-
-  def validate_gravity!
-    unless VALID_GRAVITY.include?(@gravity)
-      raise ArgumentError, "Invalid gravity: #{@gravity.inspect}"
-    end
-  end
 end

data/lib/jekyll_og_image/generator.rb

@@ -15,9 +15,10 @@ class JekyllOgImage::Generator < Jekyll::Generator
       path = File.join(site.config["source"], base_path, "#{post.data['slug']}.png")
 
       if !File.exist?(path) || JekyllOgImage.config.force?
+        Jekyll.logger.info "Jekyll Og Image:", "Generating image #{path}"
         generate_image_for_post(site, post, path)
       else
-        Jekyll.logger.info "Jekyll Og Image:", "Skipping image generation for #{post.data['title']} as it already exists."
+        Jekyll.logger.info "Jekyll Og Image:", "Skipping image generation #{path} as it already exists."
       end
 
       post.data["image"] ||= {
@@ -34,37 +35,48 @@ class JekyllOgImage::Generator < Jekyll::Generator
   def generate_image_for_post(site, post, path)
     date = post.date.strftime("%B %d, %Y")
 
-    image = JekyllOgImage::Element::Image.new(1200, 600)
+    canvas = JekyllOgImage::Element::Canvas.new(1200, 600)
       .border(JekyllOgImage.config.border_bottom["width"],
         position: :bottom,
         fill: JekyllOgImage.config.border_bottom["fill"]
       )
-      .text(post.data["title"], width: 1040, color: "#2f313d", dpi: 500, font: "Helvetica, Bold") do |_canvas, _text|
-        {
-          x: 80,
-          y: 100
-        }
-      end
-      .text(date, gravity: :sw, color: "#535358", dpi: 150, font: "Helvetica, Regular") do |_canvas, _text|
-        {
-          x: 80,
-          y: post.data["tags"].any? ? 150 : 100
-        }
-      end
+
+    if JekyllOgImage.config.image
+      canvas = canvas.image(
+        File.read(File.join(site.config["source"], JekyllOgImage.config.image)),
+        gravity: :ne,
+        width: 150,
+        height: 150
+      ) { |_canvas, _text| { x: 80, y: 100 } }
+    end
+
+    canvas = canvas.text(post.data["title"],
+      width: JekyllOgImage.config.image ? 870 : 1040,
+      color: "#2f313d",
+      dpi: 400,
+      font: "Helvetica, Bold"
+    ) { |_canvas, _text| { x: 80, y: 100 } }
+
+    canvas = canvas.text(date,
+      gravity: :sw,
+      color: "#535358",
+      dpi: 150,
+      font: "Helvetica, Regular"
+    ) { |_canvas, _text| { x: 80, y: post.data["tags"].any? ? 150 : 100 } }
 
     if post.data["tags"].any?
       tags = post.data["tags"].map { |tag| "##{tag}" }.join(" ")
 
-      image = image.text(tags, gravity: :sw, color: "#535358", dpi: 150, font: "Helvetica, Regular") do |_canvas, _text|
-        {
-          x: 80,
-          y: 100
-        }
-      end
+      canvas = canvas.text(tags,
+        gravity: :sw,
+        color: "#535358",
+        dpi: 150,
+        font: "Helvetica, Regular"
+      ) { |_canvas, _text| { x: 80, y: 100 } }
     end
 
     if JekyllOgImage.config.domain
-      image = image.text(JekyllOgImage.config.domain, gravity: :se, color: "#535358", dpi: 150, font: "Helvetica, Regular") do |_canvas, _text|
+      canvas = canvas.text(JekyllOgImage.config.domain, gravity: :se, color: "#535358", dpi: 150, font: "Helvetica, Regular") do |_canvas, _text|
         {
           x: 80,
           y: post.data["tags"].any? ? 150 : 100
@@ -72,6 +84,6 @@ class JekyllOgImage::Generator < Jekyll::Generator
       end
     end
 
-    image.save(path)
+    canvas.save(path)
   end
 end

data/lib/jekyll_og_image/version.rb

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

data/lib/jekyll_og_image.rb

@@ -25,6 +25,4 @@ end
 
 Jekyll::Hooks.register(:site, :after_init) do |site|
   JekyllOgImage.config = JekyllOgImage::Config.new(site.config["og_image"])
-
-  site.config["exclude"] << JekyllOgImage.config.output_dir
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-og-image
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4
 platform: ruby
 authors:
 - Igor Alexandrov
@@ -108,6 +108,7 @@ files:
 - lib/jekyll_og_image/config.rb
 - lib/jekyll_og_image/element/base.rb
 - lib/jekyll_og_image/element/border.rb
+- lib/jekyll_og_image/element/canvas.rb
 - lib/jekyll_og_image/element/image.rb
 - lib/jekyll_og_image/element/text.rb
 - lib/jekyll_og_image/generator.rb