jekyll-og-image 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d7ab3e37756339d3435bb110e3e612476888bea4ba020115ebc25e45708e9d5
-  data.tar.gz: 2940f89d8f183a158d8cb4da4a0ee5859ae1f414acf272ad5928c7302ad2f494
+  metadata.gz: 3d4faf0a2f12cf99798b8fb4fc56586ea659c37feceb3b34a7aac677fac0d43e
+  data.tar.gz: 6e7acd8ca461e1dc366255b3f01144fc3dca605eac70256ad1cc7fab135b3011
 SHA512:
-  metadata.gz: 163fc1a8a585391ab60f6e233291497275b2902a0d13e397211af6a610606ad510e33e8d98fbb153ad1ee943cd86d00e5bcf359527a52c51c05bd51b97774a4e
-  data.tar.gz: 946b88643e7b584ab44114e7fc6e94578b53ccfe156c5758b93ae93099b2e442f13edc10c23c5541215ba229fa2b76fa69af8dcb186ef777e5745fb5c48b0573
+  metadata.gz: aeea9d6fba76f7502a090f7d35dc2f062be6b1f7c5656f8d76719eeca715776fd818bd2f88faecd07b2d709bfbb3e0efbefeaac5c5c8f81f2b50af41bbc064a9
+  data.tar.gz: c602ea3d92aca6b20ef950c1300c4b28aecdc180a1076e12b1bcc9d7a5f7eb848511085c868b3af18385b432e6f1c7f44c1921ea85823400eb734ab1356d7d79

data/.rspec_status

@@ -1,7 +1,27 @@
-example_id                                     | status | run_time        |
----------------------------------------------- | ------ | --------------- |
-./spec/jekyll_og_image/config_spec.rb[1:1:1:1] | passed | 0.00069 seconds |
-./spec/jekyll_og_image/config_spec.rb[1:1:2:1] | passed | 0.00014 seconds |
-./spec/jekyll_og_image/version_spec.rb[1:1]    | passed | 0.00031 seconds |
-./spec/jekyll_og_image_spec.rb[1:1]            | passed | 0.26017 seconds |
-./spec/jekyll_og_image_spec.rb[1:2]            | passed | 0.04281 seconds |
+example_id                                              | status | run_time        |
+------------------------------------------------------- | ------ | --------------- |
+./spec/jekyll_og_image/configuration_spec.rb[1:1:1]     | passed | 0.00097 seconds |
+./spec/jekyll_og_image/configuration_spec.rb[1:1:2:1]   | passed | 0.00005 seconds |
+./spec/jekyll_og_image/configuration_spec.rb[1:2:1:1]   | passed | 0.00005 seconds |
+./spec/jekyll_og_image/configuration_spec.rb[1:2:2:1]   | passed | 0.00003 seconds |
+./spec/jekyll_og_image/configuration_spec.rb[1:3:1:1]   | passed | 0.00026 seconds |
+./spec/jekyll_og_image/configuration_spec.rb[1:3:2:1]   | passed | 0.00003 seconds |
+./spec/jekyll_og_image/configuration_spec.rb[1:4:1:1]   | passed | 0.00003 seconds |
+./spec/jekyll_og_image/configuration_spec.rb[1:4:2:1]   | passed | 0.00003 seconds |
+./spec/jekyll_og_image/configuration_spec.rb[1:5:1:1]   | passed | 0.00039 seconds |
+./spec/jekyll_og_image/configuration_spec.rb[1:5:2:1]   | passed | 0.00004 seconds |
+./spec/jekyll_og_image/configuration_spec.rb[1:6:1:1]   | passed | 0.00004 seconds |
+./spec/jekyll_og_image/configuration_spec.rb[1:6:2:1]   | passed | 0.00003 seconds |
+./spec/jekyll_og_image/configuration_spec.rb[1:7:1:1]   | passed | 0.00004 seconds |
+./spec/jekyll_og_image/configuration_spec.rb[1:7:1:2:1] | passed | 0.00005 seconds |
+./spec/jekyll_og_image/configuration_spec.rb[1:8:1:1]   | passed | 0.00004 seconds |
+./spec/jekyll_og_image/configuration_spec.rb[1:8:2:1]   | passed | 0.00006 seconds |
+./spec/jekyll_og_image/configuration_spec.rb[1:9:1:1]   | passed | 0.00004 seconds |
+./spec/jekyll_og_image/configuration_spec.rb[1:9:2:1]   | passed | 0.00003 seconds |
+./spec/jekyll_og_image/configuration_spec.rb[1:10:1:1]  | passed | 0.00003 seconds |
+./spec/jekyll_og_image/configuration_spec.rb[1:10:2:1]  | passed | 0.00003 seconds |
+./spec/jekyll_og_image/configuration_spec.rb[1:11:1:1]  | passed | 0.00003 seconds |
+./spec/jekyll_og_image/configuration_spec.rb[1:11:2:1]  | passed | 0.00003 seconds |
+./spec/jekyll_og_image/version_spec.rb[1:1]             | passed | 0.00003 seconds |
+./spec/jekyll_og_image_spec.rb[1:1]                     | passed | 0.24499 seconds |
+./spec/jekyll_og_image_spec.rb[1:2]                     | passed | 0.04171 seconds |

data/lib/jekyll_og_image/configuration.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+# require "anyway_config"
+
+class JekyllOgImage::Configuration
+  Canvas = Data.define(:background_color, :background_image) do
+    def initialize(background_color: "#FFFFFF", background_image: nil)
+      super
+    end
+  end
+
+  Header = Data.define(:font_family, :color) do
+    def initialize(font_family: "Helvetica, Bold", color: "#2f313d")
+      super
+    end
+  end
+
+  Content = Data.define(:font_family, :color) do
+    def initialize(font_family: "Helvetica, Regular", color: "#535358")
+      super
+    end
+  end
+
+  Border = Data.define(:width, :fill) do
+    def initialize(width: 0, fill: nil)
+      fill.is_a?(Array) ? fill : [ fill ]
+      super(width: width, fill: fill)
+    end
+  end
+
+  def initialize(raw_config)
+    @raw_config = raw_config
+  end
+
+  def merge!(other)
+    config = Jekyll::Utils.deep_merge_hashes(
+      @raw_config,
+      other.to_h
+    )
+
+    self.class.new(config)
+  end
+
+  def to_h
+    @raw_config
+  end
+
+  def ==(other)
+    to_h == other.to_h
+  end
+
+  def output_dir
+    @raw_config["output_dir"] || "assets/images/og"
+  end
+
+  def force?
+    @raw_config["force"] || false
+  end
+
+  def verbose?
+    @raw_config["verbose"] || false
+  end
+
+  def canvas
+    @raw_config["canvas"] ? Canvas.new(**Jekyll::Utils.symbolize_hash_keys(@raw_config["canvas"])) : Canvas.new
+  end
+
+  def header
+    @raw_config["header"] ? Header.new(**Jekyll::Utils.symbolize_hash_keys(@raw_config["header"])) : Header.new
+  end
+
+  def content
+    @raw_config["content"] ? Content.new(**Jekyll::Utils.symbolize_hash_keys(@raw_config["content"])) : Content.new
+  end
+
+  def image
+    @raw_config["image"]
+  end
+
+  def domain
+    @raw_config["domain"]
+  end
+
+  def border_bottom
+    @raw_config["border_bottom"] ? Border.new(**Jekyll::Utils.symbolize_hash_keys(@raw_config["border_bottom"])) : nil
+  end
+
+  def margin_bottom
+    80 + (border_bottom&.width || 0)
+  end
+end

data/lib/jekyll_og_image/element/text.rb

@@ -13,13 +13,16 @@ class JekyllOgImage::Element::Text < JekyllOgImage::Element::Base
   end
 
   def apply_to(canvas, &block)
-    text = Vips::Image.text(@message,
+    params = {
       font: @font,
       width: @width,
       dpi: @dpi,
-      wrap: :word,
       align: :low
-    )
+    }
+
+    params[:wrap] = :word if wrap_supported?
+
+    text = Vips::Image.text(@message, **params)
 
     text = text
       .new_from_image(hex_to_rgb(@color))
@@ -40,4 +43,10 @@ class JekyllOgImage::Element::Text < JekyllOgImage::Element::Base
       @gravity == gravity
     end
   end
+
+  def wrap_supported?
+    # Vips::Image.text supports wrapping since vips 8.14.0
+    # https://github.com/libvips/libvips/releases/tag/v8.14.0
+    Vips.at_least_libvips?(8, 14)
+  end
 end

data/lib/jekyll_og_image/generator.rb

@@ -4,10 +4,7 @@ class JekyllOgImage::Generator < Jekyll::Generator
   safe true
 
   def generate(site)
-    base_path = File.join(
-      JekyllOgImage.config.output_dir,
-      "posts"
-    )
+    base_path = File.join(JekyllOgImage.config.output_dir, "posts")
 
     FileUtils.mkdir_p File.join(site.config["source"], base_path)
 
@@ -33,73 +30,88 @@ class JekyllOgImage::Generator < Jekyll::Generator
   private
 
   def generate_image_for_post(site, post, path)
-    date = post.date.strftime("%B %d, %Y")
+    config = JekyllOgImage.config.merge!(post.data["og_image"])
 
-    background_image = if JekyllOgImage.config.canvas["background_image"]
-      File.read(File.join(site.config["source"], JekyllOgImage.config.canvas["background_image"]))
+    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
+    canvas = add_header(canvas, post, config)
+    canvas = add_publish_date(canvas, post, config)
+    canvas = add_tags(canvas, post, config) if post.data["tags"].any?
+    canvas = add_domain(canvas, post, config) if config.domain
+
+    canvas.save(path)
+  end
+
+  def generate_canvas(site, config)
+    background_image = if config.canvas.background_image
+      File.read(File.join(site.config["source"], config.canvas.background_image))
     end
 
-    canvas = JekyllOgImage::Element::Canvas.new(1200, 600,
-      background_color: JekyllOgImage.config.canvas["background_color"],
+    JekyllOgImage::Element::Canvas.new(1200, 600,
+      background_color: config.canvas.background_color,
       background_image: background_image
     )
+  end
 
-    if JekyllOgImage.config.border_bottom
-      canvas = canvas.border(JekyllOgImage.config.border_bottom["width"],
-        position: :bottom,
-        fill: JekyllOgImage.config.border_bottom["fill"]
-      )
-    end
+  def add_border_bottom(canvas, config)
+    canvas.border(config.border_bottom.width,
+      position: :bottom,
+      fill: config.border_bottom.fill
+    )
+  end
 
-    if JekyllOgImage.config.image
-      canvas = canvas.image(
-        File.read(File.join(site.config["source"], JekyllOgImage.config.image)),
-        gravity: :ne,
-        width: 150,
-        height: 150,
-        radius: 50
-      ) { |_canvas, _text| { x: 80, y: 100 } }
-    end
+  def add_image(canvas, image)
+    canvas.image(image,
+      gravity: :ne,
+      width: 150,
+      height: 150,
+      radius: 50
+    ) { |_canvas, _text| { x: 80, y: 100 } }
+  end
 
-    canvas = canvas.text(post.data["title"],
-      width: JekyllOgImage.config.image ? 870 : 1040,
-      color: JekyllOgImage.config.header["color"],
+  def add_header(canvas, post, config)
+    canvas.text(post.data["title"],
+      width: config.image ? 870 : 1040,
+      color: config.header.color,
       dpi: 400,
-      font: JekyllOgImage.config.header["font_family"]
+      font: config.header.font_family
     ) { |_canvas, _text| { x: 80, y: 100 } }
+  end
 
-    canvas = canvas.text(date,
+  def add_publish_date(canvas, post, config)
+    date = post.date.strftime("%B %d, %Y")
+
+    canvas.text(date,
       gravity: :sw,
-      color: JekyllOgImage.config.content["color"],
+      color: config.content.color,
       dpi: 150,
-      font: JekyllOgImage.config.content["font_family"]
-    ) { |_canvas, _text| { x: 80, y: post.data["tags"].any? ? JekyllOgImage.config.margin_bottom + 50 : JekyllOgImage.config.margin_bottom } }
-
-    if post.data["tags"].any?
-      tags = post.data["tags"].map { |tag| "##{tag}" }.join(" ")
-
-      canvas = canvas.text(tags,
-        gravity: :sw,
-        color: JekyllOgImage.config.content["color"],
-        dpi: 150,
-        font: JekyllOgImage.config.content["font_family"]
-      ) { |_canvas, _text| { x: 80, y: JekyllOgImage.config.margin_bottom } }
-    end
+      font: config.content.font_family
+    ) { |_canvas, _text| { x: 80, y: post.data["tags"].any? ? config.margin_bottom + 50 : config.margin_bottom } }
+  end
 
-    if JekyllOgImage.config.domain
-      canvas = canvas.text(JekyllOgImage.config.domain,
-        gravity: :se,
-        color: JekyllOgImage.config.content["color"],
-        dpi: 150,
-        font: JekyllOgImage.config.content["font_family"]
-      ) do |_canvas, _text|
-        {
-          x: 80,
-          y: post.data["tags"].any? ? JekyllOgImage.config.margin_bottom + 50 : JekyllOgImage.config.margin_bottom
-        }
-      end
-    end
+  def add_tags(canvas, post, config)
+    tags = post.data["tags"].map { |tag| "##{tag}" }.join(" ")
 
-    canvas.save(path)
+    canvas.text(tags,
+      gravity: :sw,
+      color: config.content.color,
+      dpi: 150,
+      font: config.content.font_family
+    ) { |_canvas, _text| { x: 80, y: config.margin_bottom } }
+  end
+
+  def add_domain(canvas, post, config)
+    canvas.text(config.domain,
+      gravity: :se,
+      color: config.content.color,
+      dpi: 150,
+      font: config.content.font_family
+    ) do |_canvas, _text|
+      {
+        x: 80,
+        y: post.data["tags"].any? ? config.margin_bottom + 50 : config.margin_bottom
+      }
+    end
   end
 end

data/lib/jekyll_og_image/version.rb

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

data/lib/jekyll_og_image.rb

@@ -11,18 +11,14 @@ loader.eager_load
 
 module JekyllOgImage
   def self.config
-    @config ||= JekyllOgImage::Config.new
+    @config ||= JekyllOgImage::Configuration.new({})
   end
 
   def self.config=(config)
     @config = config
   end
-
-  def self.configure
-    yield config
-  end
 end
 
 Jekyll::Hooks.register(:site, :after_init) do |site|
-  JekyllOgImage.config = JekyllOgImage::Config.new(site.config["og_image"])
+  JekyllOgImage.config = JekyllOgImage::Configuration.new(site.config["og_image"] || {})
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-og-image
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Igor Alexandrov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-14 00:00:00.000000000 Z
+date: 2024-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll-seo-tag
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
-- !ruby/object:Gem::Dependency
-  name: anyway_config
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: ruby-vips
   requirement: !ruby/object:Gem::Requirement
@@ -106,7 +92,7 @@ files:
 - examples/4.png
 - lib/jekyll-og-image.rb
 - lib/jekyll_og_image.rb
-- lib/jekyll_og_image/config.rb
+- lib/jekyll_og_image/configuration.rb
 - lib/jekyll_og_image/element/base.rb
 - lib/jekyll_og_image/element/border.rb
 - lib/jekyll_og_image/element/canvas.rb

data/lib/jekyll_og_image/config.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-require "anyway_config"
-
-class JekyllOgImage::Config < Anyway::Config
-  attr_config output_dir: "assets/images/og"
-  attr_config force: false
-  attr_config verbose: false
-  attr_config canvas: {
-    background_color: "#FFFFFF",
-    background_image: nil
-  }
-  attr_config header: {
-    font_family: "Helvetica, Bold",
-    color: "#2f313d"
-  }
-  attr_config content: {
-    font_family: "Helvetica, Regular",
-    color: "#535358"
-  }
-  attr_config :image
-  attr_config :domain
-  attr_config :border_bottom
-
-  coerce_types canvas: {
-    background_color: { type: :string },
-    background_image: { type: :string }
-  }
-
-  coerce_types header: {
-    font_family: { type: :string },
-    color: { type: :string }
-  }
-
-  coerce_types content: {
-    font_family: { type: :string },
-    color: { type: :string }
-  }
-
-  coerce_types image: { type: :string }
-
-  coerce_types border_bottom: {
-    width: { type: :integer },
-    fill: { type: :string, array: true }
-  }
-
-  def margin_bottom
-    80 + (border_bottom&.fetch("width", 0) || 0)
-  end
-end