jekyll-og-image 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d4faf0a2f12cf99798b8fb4fc56586ea659c37feceb3b34a7aac677fac0d43e
-  data.tar.gz: 6e7acd8ca461e1dc366255b3f01144fc3dca605eac70256ad1cc7fab135b3011
+  metadata.gz: 260918d98e574361037584e4d0d4097dd41fdcd3526386d3abfde00e2dc4b0f6
+  data.tar.gz: e0c75eec8ddb3f3911aac2ef2b45687ecc1bb036057ed183802570a82f1a4922
 SHA512:
-  metadata.gz: aeea9d6fba76f7502a090f7d35dc2f062be6b1f7c5656f8d76719eeca715776fd818bd2f88faecd07b2d709bfbb3e0efbefeaac5c5c8f81f2b50af41bbc064a9
-  data.tar.gz: c602ea3d92aca6b20ef950c1300c4b28aecdc180a1076e12b1bcc9d7a5f7eb848511085c868b3af18385b432e6f1c7f44c1921ea85823400eb734ab1356d7d79
+  metadata.gz: 16f6da984ff3821513fdfd51eb9beb06e45bfb76c4530464ebc2f7d9164985a4583ec894258580ea125aed96b9ea489acc55332adc920cfda64e7f9f4c7ec3ee
+  data.tar.gz: eb147ebfeb11d50a80370ced4b82b33c1b33730c6b087c3eddc2871b6aed570dac8014cd01f687711b4f316cdf51bb9cf37cbb8eb82b58e048bafa8f3a21bcac

data/README.md

@@ -11,7 +11,7 @@ A Jekyll plugin to automatically generate open graph images for posts.
 Add this line to your site's Gemfile:
 
 ```ruby
-  gem 'jekyll-feed'
+  gem 'jekyll-og-image'
 ```
 
 And then add this line to your site's `_config.yml`:
@@ -26,12 +26,53 @@ 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:
+
+* `collections` - An array specifying which types of collections to generate images for. Supports `"posts"`, `"pages"`, and the names of any custom collections. Default: `["posts"]`
+
+* `output_dir` – The directory where the generated images will be saved. Images will be placed in subdirectories named after their collection type (e.g., `assets/images/og/posts`, `assets/images/og/pages`). Default: `assets/images/og`
+
+* `force` – If set to `true`, the plugin will generate an image for every document, even if the document 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:
+  collections: ["posts", "pages"]
   output_dir: "assets/images/og"
   domain: "igor.works"
   border_bottom:
@@ -45,6 +86,7 @@ og_image:
 ### Multiple Colors
 
 ```yaml
+# _config.yml
 og_image:
   output_dir: "assets/images/og"
   image: "/assets/images/igor.jpeg"
@@ -64,6 +106,7 @@ og_image:
 ### Background Color and Text Color
 
 ```yaml
+# _config.yml
 og_image:
   output_dir: "/assets/og"
   image: "/assets/images/igor.jpeg"
@@ -90,11 +133,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 +145,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 +172,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

@@ -49,16 +49,24 @@ class JekyllOgImage::Configuration
     to_h == other.to_h
   end
 
+  def collections
+    @raw_config["collections"] || [ "posts" ]
+  end
+
   def output_dir
     @raw_config["output_dir"] || "assets/images/og"
   end
 
   def force?
-    @raw_config["force"] || false
+    @raw_config["force"].nil? ? false : @raw_config["force"]
   end
 
   def verbose?
-    @raw_config["verbose"] || false
+    @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

data/lib/jekyll_og_image/generator.rb

@@ -4,48 +4,93 @@ class JekyllOgImage::Generator < Jekyll::Generator
   safe true
 
   def generate(site)
-    base_path = File.join(JekyllOgImage.config.output_dir, "posts")
+    config = JekyllOgImage.config
 
-    FileUtils.mkdir_p File.join(site.config["source"], base_path)
+    config.collections.each do |type|
+      process_collection(site, type, config)
+    end
+  end
+
+  private
+
+  def process_collection(site, type, config)
+    Jekyll.logger.info "Jekyll Og Image:", "Processing type: #{type}" if config.verbose?
 
-    site.posts.docs.each do |post|
-      path = File.join(site.config["source"], base_path, "#{post.data['slug']}.png")
+    items = get_items_for_collection(site, type)
+    return if items.empty?
 
-      if !File.exist?(path) || JekyllOgImage.config.force?
-        Jekyll.logger.info "Jekyll Og Image:", "Generating image #{path}" if JekyllOgImage.config.verbose?
-        generate_image_for_post(site, post, path)
+    base_output_dir = File.join(config.output_dir, type)
+    absolute_output_dir = File.join(site.config["source"], base_output_dir)
+    FileUtils.mkdir_p absolute_output_dir
+
+    items.each do |item|
+      if item.respond_to?(:draft?) && item.draft? && config.skip_drafts?
+        Jekyll.logger.info "Jekyll Og Image:", "Skipping draft: #{item.data['title']}" if config.verbose?
+        next
+      end
+
+      fallback_basename = if item.respond_to?(:basename_without_ext)
+                            item.basename_without_ext
+                            # rubocop:disable Layout/ElseAlignment # Disabled due to RuboCop error in v3.3.0
+                          else
+                            # 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)
+      relative_image_path = File.join("/", base_output_dir, image_filename) # Use leading slash for URL
+
+      if !File.exist?(absolute_image_path) || config.force?
+        Jekyll.logger.info "Jekyll Og Image:", "Generating image #{absolute_image_path}" if config.verbose?
+        generate_image_for_document(site, item, absolute_image_path, config)
       else
-        Jekyll.logger.info "Jekyll Og Image:", "Skipping image generation #{path} as it already exists." if JekyllOgImage.config.verbose?
+        Jekyll.logger.info "Jekyll Og Image:", "Skipping image generation for #{relative_image_path} as it already exists." if config.verbose?
       end
 
-      post.data["image"] ||= {
-        "path" => File.join(base_path, "#{post.data['slug']}.png"),
+      item.data["image"] ||= {
+        "path" => relative_image_path,
         "width" => 1200,
         "height" => 600,
-        "alt" => post.data["title"]
+        "alt" => item.data["title"]
       }
     end
   end
 
-  private
+  def get_items_for_collection(site, type)
+    case type
+    when "posts"
+      site.posts.docs
+    when "pages"
+      site.pages.reject { |page| !page.html? }
+    else
+      if site.collections.key?(type)
+        site.collections[type].docs
+      else
+        Jekyll.logger.warn "Jekyll Og Image:", "Unknown collection type \"#{type}\" configured. Skipping."
+        []
+      end
+    end
+  end
 
-  def generate_image_for_post(site, post, path)
-    config = JekyllOgImage.config.merge!(post.data["og_image"])
+  def generate_image_for_document(site, item, path, base_config)
+    config = base_config.merge!(item.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
+    canvas = add_header(canvas, item, config)
+    canvas = add_publish_date(canvas, item, config)
+    canvas = add_tags(canvas, item, config) if item.data["tags"]&.any?
+    canvas = add_domain(canvas, item, 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))
+      bg_path = File.join(site.config["source"], config.canvas.background_image.gsub(/^\//, ""))
+      File.exist?(bg_path) ? File.read(bg_path) : nil
     end
 
     JekyllOgImage::Element::Canvas.new(1200, 600,
@@ -70,8 +115,9 @@ class JekyllOgImage::Generator < Jekyll::Generator
     ) { |_canvas, _text| { x: 80, y: 100 } }
   end
 
-  def add_header(canvas, post, config)
-    canvas.text(post.data["title"],
+  def add_header(canvas, item, config)
+    title = item.data["title"] || "Untitled"
+    canvas.text(title,
       width: config.image ? 870 : 1040,
       color: config.header.color,
       dpi: 400,
@@ -79,19 +125,25 @@ class JekyllOgImage::Generator < Jekyll::Generator
     ) { |_canvas, _text| { x: 80, y: 100 } }
   end
 
-  def add_publish_date(canvas, post, config)
-    date = post.date.strftime("%B %d, %Y")
+  def add_publish_date(canvas, item, config)
+    return canvas unless item.respond_to?(:date) && item.date
+
+    date = item.date.strftime("%B %d, %Y")
+    y_pos = (item.data["tags"]&.any? ? config.margin_bottom + 50 : config.margin_bottom)
 
     canvas.text(date,
       gravity: :sw,
       color: config.content.color,
       dpi: 150,
       font: config.content.font_family
-    ) { |_canvas, _text| { x: 80, y: post.data["tags"].any? ? config.margin_bottom + 50 : config.margin_bottom } }
+    ) { |_canvas, _text| { x: 80, y: y_pos } }
   end
 
-  def add_tags(canvas, post, config)
-    tags = post.data["tags"].map { |tag| "##{tag}" }.join(" ")
+  def add_tags(canvas, item, config)
+    tags_list = item.data["tags"]
+    return canvas unless tags_list.is_a?(Array) && tags_list.any?
+
+    tags = tags_list.map { |tag| "##{tag}" }.join(" ")
 
     canvas.text(tags,
       gravity: :sw,
@@ -101,17 +153,20 @@ class JekyllOgImage::Generator < Jekyll::Generator
     ) { |_canvas, _text| { x: 80, y: config.margin_bottom } }
   end
 
-  def add_domain(canvas, post, config)
+  def add_domain(canvas, item, config)
+    y_pos = if item.data["tags"]&.any?
+              config.margin_bottom + 50
+              # rubocop:disable Layout/ElseAlignment # Disabled due to RuboCop error in v3.3.0
+            else
+              # rubocop:enable Layout/ElseAlignment
+              config.margin_bottom
+    end
+
     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
+    ) { |_canvas, _text| { x: 80, y: y_pos } }
   end
 end

data/lib/jekyll_og_image/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-og-image
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Igor Alexandrov
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll-seo-tag
@@ -72,7 +71,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: 
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 email:
 - igor.alexandrov@gmail.com
 executables: []
@@ -80,7 +92,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
-- ".rspec_status"
 - ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
@@ -105,7 +116,6 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/igor-alexandrov/jekyll-og-image
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -120,8 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Jekyll plugin to generate GitHub-style open graph images
 test_files: []

data/.rspec_status

@@ -1,27 +0,0 @@
-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 |