jekyll-og-image 1.0.5 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fc4622681cf9b4953d6cbd7de3b661ebd217de44c08205656e395386b14e4c9
-  data.tar.gz: 26b864c6981a1b353de1e8e97de690870e2f2d9c531d56dac1bf97bc2efc0cde
+  metadata.gz: 3d7ab3e37756339d3435bb110e3e612476888bea4ba020115ebc25e45708e9d5
+  data.tar.gz: 2940f89d8f183a158d8cb4da4a0ee5859ae1f414acf272ad5928c7302ad2f494
 SHA512:
-  metadata.gz: 7285bbd3562d0e2fa67a1f92c639d2ffa505e73d0d6b58c705217e8e7eefbb5930b9c01fec2c5d267f3448cd012e76ed5f2748b639d62bde290d796ab87d31d8
-  data.tar.gz: beb92471fe217bc7c105fb3924940fee58031306cf628aac36ff8a4b61841ebaee406c8a85ce6aa903563fe3ca8dd489d68d0b3018f9797e77cb76da209d08ef
+  metadata.gz: 163fc1a8a585391ab60f6e233291497275b2902a0d13e397211af6a610606ad510e33e8d98fbb153ad1ee943cd86d00e5bcf359527a52c51c05bd51b97774a4e
+  data.tar.gz: 946b88643e7b584ab44114e7fc6e94578b53ccfe156c5758b93ae93099b2e442f13edc10c23c5541215ba229fa2b76fa69af8dcb186ef777e5745fb5c48b0573

data/.rspec_status

@@ -1,5 +1,7 @@
-example_id                          | status | run_time        |
------------------------------------ | ------ | --------------- |
-./spec/jekyll_og_image_spec.rb[1:1] | passed | 0.01883 seconds |
-./spec/jekyll_og_image_spec.rb[1:2] | passed | 0.31382 seconds |
-./spec/jekyll_og_image_spec.rb[1:3] | passed | 0.07861 seconds |
+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 |

data/README.md

@@ -61,6 +61,51 @@ og_image:
 
 ![Example 1](examples/1.png)
 
+### Background Color and Text Color
+
+```yaml
+og_image:
+  output_dir: "/assets/og"
+  image: "/assets/images/igor.jpeg"
+  canvas:
+    background_color: "#F9E065"
+  header:
+    font_family: "Roboto, Bold"
+    color: "#333333"
+  content:
+    font_family: "Roboto, Regular"
+    color: "#333333"
+  force: false
+  domain: "igor.works"
+  border_bottom:
+    width: 50
+    fill:
+      - "#002B7F"
+      - "#FCD116"
+      - "#CE1126"
+```
+
+![Example 3](examples/3.png)
+
+### Background Image
+
+```yaml
+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"
+  content:
+    font_family: "Roboto, Bold"
+    color: "#333333"
+  force: false
+  domain: "igor.works"
+```
+
+![Example 4](examples/4.png)
 
 
 ## Contributing

data/lib/jekyll_og_image/config.rb

@@ -5,11 +5,36 @@ 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: {
-    width: 20,
-    fill: [ "#211F1F", "#F4CBB2", "#AD5C51", "#9CDAF1", "#7DBBE6" ]
+  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 }
@@ -18,4 +43,8 @@ class JekyllOgImage::Config < Anyway::Config
     width: { type: :integer },
     fill: { type: :string, array: true }
   }
+
+  def margin_bottom
+    80 + (border_bottom&.fetch("width", 0) || 0)
+  end
 end

data/lib/jekyll_og_image/element/base.rb

@@ -22,6 +22,14 @@ class JekyllOgImage::Element::Base
     end
   end
 
+  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
+
   def composite_with_gravity(canvas, overlay, x, y)
     if gravity_nw?
       canvas.composite(overlay, :over, x: [ x ], y: [ y ]).flatten

data/lib/jekyll_og_image/element/canvas.rb

@@ -3,8 +3,19 @@
 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))
+  def initialize(width, height, background_color: "#ffffff", background_image: nil)
+    @canvas = Vips::Image.black(width, height).ifthenelse([ 0, 0, 0 ], hex_to_rgb(background_color))
+
+    if background_image
+      overlay = Vips::Image.new_from_buffer(background_image, "")
+
+      ratio = calculate_ratio(overlay, width, height, :max)
+      overlay = overlay.resize(ratio)
+
+      @canvas = @canvas.composite(overlay, :over, x: [ 0 ], y: [ 0 ]).flatten
+    end
+
+    @canvas
   end
 
   def image(source, **opts, &block)

data/lib/jekyll_og_image/element/image.rb

@@ -15,13 +15,13 @@ class JekyllOgImage::Element::Image < JekyllOgImage::Element::Base
     image = Vips::Image.new_from_buffer(@source, "")
     image = round_corners(image) if @radius
 
-    result = block.call(canvas, image) if block_given?
-
     if @width && @height
       ratio = calculate_ratio(image, @width, @height, :min)
       image = image.resize(ratio)
     end
 
+    result = block.call(canvas, image) if block_given?
+
     x, y = result ? [ result.fetch(:x, 0), result.fetch(:y, 0) ] : [ 0, 0 ]
 
     composite_with_gravity(canvas, image, x, y)
@@ -53,12 +53,4 @@ class JekyllOgImage::Element::Image < JekyllOgImage::Element::Base
     mask = Vips::Image.new_from_buffer(mask, "")
     image.bandjoin mask[3]
   end
-
-  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/generator.rb

@@ -15,10 +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}"
+        Jekyll.logger.info "Jekyll Og Image:", "Generating image #{path}" if JekyllOgImage.config.verbose?
         generate_image_for_post(site, post, path)
       else
-        Jekyll.logger.info "Jekyll Og Image:", "Skipping image generation #{path} as it already exists."
+        Jekyll.logger.info "Jekyll Og Image:", "Skipping image generation #{path} as it already exists." if JekyllOgImage.config.verbose?
       end
 
       post.data["image"] ||= {
@@ -35,11 +35,21 @@ class JekyllOgImage::Generator < Jekyll::Generator
   def generate_image_for_post(site, post, path)
     date = post.date.strftime("%B %d, %Y")
 
-    canvas = JekyllOgImage::Element::Canvas.new(1200, 600)
-      .border(JekyllOgImage.config.border_bottom["width"],
+    background_image = if JekyllOgImage.config.canvas["background_image"]
+      File.read(File.join(site.config["source"], JekyllOgImage.config.canvas["background_image"]))
+    end
+
+    canvas = JekyllOgImage::Element::Canvas.new(1200, 600,
+      background_color: JekyllOgImage.config.canvas["background_color"],
+      background_image: background_image
+    )
+
+    if JekyllOgImage.config.border_bottom
+      canvas = canvas.border(JekyllOgImage.config.border_bottom["width"],
         position: :bottom,
         fill: JekyllOgImage.config.border_bottom["fill"]
       )
+    end
 
     if JekyllOgImage.config.image
       canvas = canvas.image(
@@ -53,34 +63,39 @@ class JekyllOgImage::Generator < Jekyll::Generator
 
     canvas = canvas.text(post.data["title"],
       width: JekyllOgImage.config.image ? 870 : 1040,
-      color: "#2f313d",
+      color: JekyllOgImage.config.header["color"],
       dpi: 400,
-      font: "Helvetica, Bold"
+      font: JekyllOgImage.config.header["font_family"]
     ) { |_canvas, _text| { x: 80, y: 100 } }
 
     canvas = canvas.text(date,
       gravity: :sw,
-      color: "#535358",
+      color: JekyllOgImage.config.content["color"],
       dpi: 150,
-      font: "Helvetica, Regular"
-    ) { |_canvas, _text| { x: 80, y: post.data["tags"].any? ? 150 : 100 } }
+      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: "#535358",
+        color: JekyllOgImage.config.content["color"],
         dpi: 150,
-        font: "Helvetica, Regular"
-      ) { |_canvas, _text| { x: 80, y: 100 } }
+        font: JekyllOgImage.config.content["font_family"]
+      ) { |_canvas, _text| { x: 80, y: JekyllOgImage.config.margin_bottom } }
     end
 
     if JekyllOgImage.config.domain
-      canvas = canvas.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: JekyllOgImage.config.content["color"],
+        dpi: 150,
+        font: JekyllOgImage.config.content["font_family"]
+      ) do |_canvas, _text|
         {
           x: 80,
-          y: post.data["tags"].any? ? 150 : 100
+          y: post.data["tags"].any? ? JekyllOgImage.config.margin_bottom + 50 : JekyllOgImage.config.margin_bottom
         }
       end
     end

data/lib/jekyll_og_image/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-og-image
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.2.0
 platform: ruby
 authors:
 - Igor Alexandrov
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-06 00:00:00.000000000 Z
+date: 2024-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll-seo-tag
@@ -86,7 +86,7 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.0'
-description:
+description: 
 email:
 - igor.alexandrov@gmail.com
 executables: []
@@ -102,7 +102,8 @@ files:
 - Rakefile
 - examples/1.png
 - examples/2.png
-- jekyll-og-image.gemspec
+- examples/3.png
+- examples/4.png
 - lib/jekyll-og-image.rb
 - lib/jekyll_og_image.rb
 - lib/jekyll_og_image/config.rb
@@ -118,7 +119,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/igor-alexandrov/jekyll-og-image
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -133,8 +134,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.4
-signing_key:
+rubygems_version: 3.5.3
+signing_key: 
 specification_version: 4
 summary: Jekyll plugin to generate GitHub-style open graph images
 test_files: []

data/jekyll-og-image.gemspec

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/jekyll_og_image/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "jekyll-og-image"
-  spec.version = JekyllOgImage::VERSION
-  spec.authors = [ "Igor Alexandrov" ]
-  spec.email = [ "igor.alexandrov@gmail.com" ]
-
-  spec.summary = "Jekyll plugin to generate GitHub-style open graph images"
-  spec.homepage = "https://github.com/igor-alexandrov/jekyll-og-image"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.2.0"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
-    end
-  end
-
-  spec.require_paths = [ "lib" ]
-
-  spec.add_dependency "jekyll-seo-tag", "~> 2.8"
-  spec.add_dependency "zeitwerk", "~> 2.6"
-  spec.add_dependency "anyway_config", "~> 2.6"
-  spec.add_dependency "ruby-vips", "~> 2.2.0"
-  spec.add_runtime_dependency "jekyll", ">= 3.4", "< 5.0"
-end