jekyll-og-image 1.2.1 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a631d761ff53dd4360cc75a85dea82931684ec5feba0280c605cef0823b8a887
-  data.tar.gz: bad0176739efbab1e7e9b1bc042e63c5b9be4673b1d47bb28ebcd305c015d100
+  metadata.gz: e246a8f729a0d3597ecdbb0b9b1b15083c6e23121d2f670c9b0911a16e0465eb
+  data.tar.gz: 203d4fa8e80623c91072f9eb5b02468085cca2a8cde171d325c1068eb7ccc2a9
 SHA512:
-  metadata.gz: fb9ded5069c346291dbff870cb4925939e191c066e035d9c786886eee3cffc544f944e7bfd5f179125e7a02267c0ef7f45af061229ea817baba50fb8983a8251
-  data.tar.gz: 9cc5b84d0b130db137d68cf6b513ff285648b90818a4e83d8b84c53b2832b0aaeeb53d750903c249619506c2dc2346276282733b18c53635195854d8a8ad25f4
+  metadata.gz: 1074de3a876df6c1856e4162aa260424b2972f9ae238bbc1060a36ce73f4cc82490e1ccf6d295e25f4a5e2719e54dae7ff199d779430856515e069a336a6909b
+  data.tar.gz: d9472379c623f304ab3a0ab95fd83a79a2ba9ccdc559319d747cec9d19432d7456e6a9bd036c13fab2f76fd8c12c2624ccefa5b647e99f6bbf18faa6127254fc

data/README.md

@@ -26,11 +26,50 @@ plugins:
 
 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.
 
+## Configuration
+
+The plugin can be configured in the `_config.yml` file or in the post's front matter.
+
+The following configuration options are available:
+
+* `output_dir` – The directory where the generated images will be saved. Default: `assets/images/og`
+
+* `force` – If set to `true`, the plugin will generate an image for every post, even if the post already has an image. Default: `false`
+
+* `verbose`  – If set to `true`, the plugin will output additional information about the image generation process. Default: `false`
+
+* `skip_drafts` – If set to `true`, the plugin will skip post drafts when generating images. Default: `true`
+
+* `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`
+
+* `header` – The header configuration options:
+  * `font_family` – The font family of the header text. Default: `Helvetica, Bold`
+  * `color` – The color of the header text. Default: `#2f313d`
+
+* `content` – The content configuration options:
+  * `font_family` – The font family of the content text. Default: `Helvetica, Regular`
+  * `color` – The color of the content text. Default: `#535358`
+
+* `border_bottom` – The border bottom configuration options:
+  * `width` – The width of the border bottom. Default: `20`
+  * `fill` – The array of colors to fill the border bottom. Default: `["#000000"]`
+
+* `domain` – The domain name to use in the image. Default: `nil`
+
+* `image` – Path to the image to use as the logo. Default: `nil`
+
 ## Examples
 
+Configuration can be defined on the site level or on the post level.
+
+For a side wide level configuration, edit your `_config.yml`, for a post level configuration, edit the post's front matter.
+
 ### Single Color
 
 ```yaml
+# _config.yml
 og_image:
   output_dir: "assets/images/og"
   domain: "igor.works"
@@ -45,6 +84,7 @@ og_image:
 ### Multiple Colors
 
 ```yaml
+# _config.yml
 og_image:
   output_dir: "assets/images/og"
   image: "/assets/images/igor.jpeg"
@@ -64,6 +104,7 @@ og_image:
 ### Background Color and Text Color
 
 ```yaml
+# _config.yml
 og_image:
   output_dir: "/assets/og"
   image: "/assets/images/igor.jpeg"
@@ -90,11 +131,10 @@ og_image:
 ### Background Image
 
 ```yaml
+# _config.yml
 og_image:
   output_dir: "/assets/og"
   image: "/assets/images/igor.jpeg"
-  canvas:
-    background_image: "/assets/images/bc_3.jpg"
   header:
     font_family: "Roboto, Bold"
     color: "#333333"
@@ -103,6 +143,18 @@ og_image:
     color: "#333333"
   force: false
   domain: "igor.works"
+
+# _posts/2024-02-15-traefik-tunning-for-rails-applications-part-1.md
+---
+title: Traefik Tuning for Rails Applications (part 1)
+layout: post
+tags:
+  - Rails
+  - Traefik
+  - Kamal
+og_image:
+  canvas:
+    background_image: "/assets/images/bc_3.jpg"
 ```
 
 ![Example 4](examples/4.png)
@@ -118,4 +170,4 @@ og_image:
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/jekyll_og_image/configuration.rb

@@ -0,0 +1,95 @@
+# 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"].nil? ? false : @raw_config["force"]
+  end
+
+  def verbose?
+    @raw_config["verbose"].nil? ? false : @raw_config["verbose"]
+  end
+
+  def skip_drafts?
+    @raw_config["skip_drafts"].nil? ? true : @raw_config["skip_drafts"]
+  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/generator.rb

@@ -4,14 +4,13 @@ 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)
 
     site.posts.docs.each do |post|
+      next if post.draft? && JekyllOgImage.config.skip_drafts?
+
       path = File.join(site.config["source"], base_path, "#{post.data['slug']}.png")
 
       if !File.exist?(path) || JekyllOgImage.config.force?
@@ -33,73 +32,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"])
+
+    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
 
-    background_image = if JekyllOgImage.config.canvas["background_image"]
-      File.read(File.join(site.config["source"], JekyllOgImage.config.canvas["background_image"]))
+    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.1"
+  VERSION = "1.4.1"
 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.1
+  version: 1.4.1
 platform: ruby
 authors:
 - Igor Alexandrov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-14 00:00:00.000000000 Z
+date: 2024-06-24 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
@@ -94,7 +80,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
-- ".rspec_status"
 - ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
@@ -106,7 +91,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
@@ -134,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.11
 signing_key: 
 specification_version: 4
 summary: Jekyll plugin to generate GitHub-style open graph images

data/.rspec_status

@@ -1,7 +0,0 @@
-example_id                                     | status | run_time        |
----------------------------------------------- | ------ | --------------- |
-./spec/jekyll_og_image/config_spec.rb[1:1:1:1] | passed | 0.00046 seconds |
-./spec/jekyll_og_image/config_spec.rb[1:1:2:1] | passed | 0.00012 seconds |
-./spec/jekyll_og_image/version_spec.rb[1:1]    | passed | 0.00037 seconds |
-./spec/jekyll_og_image_spec.rb[1:1]            | passed | 0.2806 seconds  |
-./spec/jekyll_og_image_spec.rb[1:2]            | passed | 0.04456 seconds |

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