thumb_gen 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4a6f7985e73484a38bca3f7e91c25f283e99144f31481f0b42bbac46e2f5158
-  data.tar.gz: e30b3bedba0423a6adb5288b48149232a07f9d1272bf526f0a39a5bd9d34b1eb
+  metadata.gz: c3afc45cc8b694142b79f2cb82e3c03ec4e871894c218bede07a9c28f53fba77
+  data.tar.gz: 405767838d151c46427641ff2a5fa4264fa21ceec2cdf48327c2290fe9f7e24c
 SHA512:
-  metadata.gz: 401b2124f04d5852637b53e356cae18b3362ce0c9e5ad3f1a4c8d887669b511adce4f8007eec9cdb5486e0cb593066c4bb5814a9f5eb250995b31e9c20db7459
-  data.tar.gz: 242eb622589b8c449c0e1e33e429e7357b320bcc61df207e5b4a1516ae4e6e5437de735c0c72a2c0ceab38090d93313f117e329bc4431ed433dcccbebd7d5e31
+  metadata.gz: b72ee8d31e58373006a83097ae077a59af16bf5bd50740fefa353791768f1beef4f927b1ba2fe0ace9e85daa6f0e6b71c687e117c8c872a612cd7292665f0dac
+  data.tar.gz: '0814c2366fdba305f9bb14c66019baeca5e40bd7950990526525be48b0b744887c17645eddd19e612aeddb0d2ffc6485b5560394e13d8214ba3e08a4db21a358'

data/README.md

@@ -1,41 +1,50 @@
 # ThumbGen
 
-Welcome to ThumbGen, a powerful Ruby gem designed to facilitate the dynamic generation of images with customized text overlays. This tool leverages RMagick to provide robust image manipulation capabilities, making it ideal for applications needing automated graphic content creation, such as generating thumbnails, promotional banners, or personalized images.
+Welcome to ThumbGen, a powerful Ruby gem designed to generate images with customized text overlays.  
+Perfect for automating thumbnail creation, blog banners, and promotional images.
 
+---
+
+## 🖼️ Example
 
 Input Image | Output Image
 :-------------------------:|:-------------------------:
-![Input](sample_input.jpg)  |  ![Output](sample_output.jpg)
+![Input](sample_input.jpg) | ![Output](sample_output.jpg)
 
+---
 
-## Installation
+## 💎 Installation
 
-To install ThumbGen, simply add it to your application's Gemfile:
+Add to your Gemfile:
 
 ```bash
 bundle add thumb_gen
 ```
 
-Alternatively, you can install it yourself as:
-
+Or install manually:
 
 ```bash
 gem install thumb_gen
 ```
 
-## Usage
+---
 
-ThumbGen is easy to use with an intuitive API. Here's a basic example of how to generate an image with text overlays:
+## ✨ Usage
+
+You can generate an image by providing background, output path, and an array of text overlays:
 
 ```ruby
+require 'thumb_gen'
+
 output_path = 'sample_output.jpg'
 background_url = 'sample_input.jpg'
+
 texts = [
   {
     text: 'ThumbGen is a Ruby gem that simplifies the creation of article thumbnails',
     wrapped_width: 800,
+    font: 'PublicSans-Bold',
     font_size: 80,
-    style: 'bold',
     color: '#047857',
     outline_color: '#f8fafc',
     outline_width: 1,
@@ -46,8 +55,8 @@ texts = [
   {
     text: '5 min read',
     wrapped_width: 800,
+    font: 'Roboto-Italic',
     font_size: 48,
-    style: 'italic',
     color: '#09090b',
     gravity: 'southwest',
     position_x: 400,
@@ -56,34 +65,97 @@ texts = [
   {
     text: 'My Blog',
     wrapped_width: 1280,
+    font: 'Roboto-BoldItalic',
     font_size: 64,
-    style: 'bold-and-italic',
     color: '#86198f',
     gravity: 'northeast',
     position_x: 200,
     position_y: 30
   }
 ]
+
 options = {
   width: 1280,
   height: 720,
   format: 'jpg'
 }
 
-# Generate the image
 ThumbGen.generate(output_path, background_url, texts, options)
 ```
 
-## Development
+> Font files like `Roboto-BoldItalic.ttf` are bundled in the gem’s `fonts/` folder.  
+Use only the filename **without extension** as the `font:` value.
+
+- PublicSans-Regular
+- PublicSans-Bold
+- PublicSans-BoldItalic
+- PublicSans-Thin
+- PublicSans-ThinItalic
+- Roboto-Regular
+- Roboto-Bold
+- Roboto-BoldItalic
+- Roboto-Italic
+- Roboto-Thin
+- Roboto-ThinItalic
+- For Japanese:
+  - NotoSansJP-Regular
+  - NotoSansJP-Bold
+  - NotoSansJP-Thin
+- For Korean:
+  - NotoSansKR-Regular
+  - NotoSansKR-Bold
+  - NotoSansKR-Thin
+- For Simplified Chinese
+  - NotoSansSC-Regular
+  - NotoSansSC-Bold
+  - NotoSansSC-Thin
+
+---
+
+## 🛠 Development
+
+After cloning the repo, install dependencies:
+
+```bash
+bin/setup
+```
+
+Run tests:
+
+```bash
+rake spec
+```
+
+Try it in IRB:
+
+```bash
+bin/console
+```
+
+To install the gem locally:
+
+```bash
+bundle exec rake install
+```
+
+To release a new version:
+
+1. Update the version in `lib/thumb_gen/version.rb`
+2. Run:
+
+```bash
+bundle exec rake release
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+---
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+## 🤝 Contributing
 
-## Contributing
+Bug reports and pull requests are welcome at:  
+[https://github.com/YutoYasunaga/thumb_gen](https://github.com/YutoYasunaga/thumb_gen)
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/YutoYasunaga/thumb_gen.
+---
 
-## License
+## 📄 License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+Released under the [MIT License](https://opensource.org/licenses/MIT)

data/lib/thumb_gen/generator.rb

@@ -38,52 +38,53 @@ module ThumbGen
     # Adds text overlays to the image based on provided text configurations.
     def add_texts
       texts.each do |text|
-        draw_text(
-          background,
-          text[:text],
-          wrapped_width: wrapped_width(text[:wrapped_width]),
-          font: font(text[:style]),
-          font_size: text[:font_size] || 64,
-          font_weight: font_weight(text[:style]),
-          font_style: font_style(text[:style]),
-          color: text[:color] || '#000000',
-          outline_color: text[:outline_color],
-          outline_width: text[:outline_width] || 0,
-          gravity: gravity(text[:gravity]),
-          position_x: text[:position_x] || 0,
-          position_y: text[:position_y] || 0
-        )
+        draw_text(background, text[:text], **text_options(text))
       end
     end
 
+    def text_options(text)
+      font_family = text[:font] || 'PUblisSans-Regular'
+      {
+        wrapped_width: wrapped_width(text[:wrapped_width]),
+        font: font(font_family),
+        font_size: text[:font_size] || 64,
+        font_weight: font_weight(font_family),
+        font_style: font_style(font_family),
+        color: text[:color] || '#000000',
+        outline_color: text[:outline_color],
+        outline_width: text[:outline_width] || 0,
+        gravity: gravity(text[:gravity]),
+        position_x: text[:position_x] || 0,
+        position_y: text[:position_y] || 0
+      }
+    end
+
     # Determines the width within which text should be wrapped.
     def wrapped_width(width)
       width || background.columns
     end
 
     # Determines the font based on the style.
-    def font(style)
-      case style
-      when 'bold' then 'Arial-Bold'
-      when 'italic' then 'Arial-Italic'
-      when 'bold-and-italic' then 'Arial-Bold-Italic'
-      else 'Arial'
-      end
+    def font(font_family)
+      base = File.expand_path('../../fonts', __dir__)
+      File.join(base, "#{font_family}.ttf")
     end
 
-    # Determines the font weight based on the style.
-    def font_weight(style)
-      case style
-      when 'bold', 'bold-and-italic' then Magick::BolderWeight
-      else Magick::NormalWeight
+    # Determines the font weight based on the name.
+    def font_weight(font_family)
+      if font_family.downcase.include?('bold')
+        Magick::BolderWeight
+      else
+        Magick::NormalWeight
       end
     end
 
-    # Determines the font style based on the style.
-    def font_style(style)
-      case style
-      when 'italic', 'bold-and-italic' then Magick::ItalicStyle
-      else Magick::NormalStyle
+    # Determines the font style based on the name.
+    def font_style(font_family)
+      if font_family.downcase.include?('italic')
+        Magick::ItalicStyle
+      else
+        Magick::NormalStyle
       end
     end
 

data/lib/thumb_gen/test.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'thumb_gen/generator'
+
+module ThumbGen
+  # rubocop:disable all
+  module Test
+    def self.generate_sample
+      output_path = 'sample_output.jpg'
+      background_url = 'sample_input.jpg'
+      texts = [
+        {
+          text: 'ThumbGen is a Ruby gem that simplifies the creation of article thumbnails',
+          wrapped_width: 800,
+          font: 'PublicSans-Bold',
+          font_size: 80,
+          color: '#047857',
+          outline_color: '#f8fafc',
+          outline_width: 1,
+          gravity: 'northwest',
+          position_x: 40,
+          position_y: 120
+        },
+        {
+          text: '5 min read',
+          wrapped_width: 800,
+          font: 'Roboto-Italic',
+          font_size: 48,
+          color: '#09090b',
+          gravity: 'southwest',
+          position_x: 400,
+          position_y: 40
+        },
+        {
+          text: 'My Blog',
+          wrapped_width: 1280,
+          font: 'Roboto-BoldItalic',
+          font_size: 64,
+          color: '#86198f',
+          gravity: 'northeast',
+          position_x: 200,
+          position_y: 30
+        }
+      ]
+      options = {
+        width: 1280,
+        height: 720,
+        format: 'jpg'
+      }
+      ThumbGen::Generator.new(output_path, background_url, texts, options).generate
+    end
+  end
+  # rubocop:enable all
+end

data/lib/thumb_gen/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ThumbGen
-  VERSION = '0.1.1'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: thumb_gen
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - YutoYasunaga
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-29 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rmagick
@@ -39,9 +38,29 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- default.png
+- fonts/NotoSansJP-Bold.ttf
+- fonts/NotoSansJP-Regular.ttf
+- fonts/NotoSansJP-Thin.ttf
+- fonts/NotoSansKR-Bold.ttf
+- fonts/NotoSansKR-Regular.ttf
+- fonts/NotoSansKR-Thin.ttf
+- fonts/NotoSansSC-Bold.ttf
+- fonts/NotoSansSC-Regular.ttf
+- fonts/NotoSansSC-Thin.ttf
+- fonts/PublicSans-Bold.ttf
+- fonts/PublicSans-BoldItalic.ttf
+- fonts/PublicSans-Regular.ttf
+- fonts/PublicSans-Thin.ttf
+- fonts/PublicSans-ThinItalic.ttf
+- fonts/Roboto-Bold.ttf
+- fonts/Roboto-BoldItalic.ttf
+- fonts/Roboto-Italic.ttf
+- fonts/Roboto-Regular.ttf
+- fonts/Roboto-Thin.ttf
+- fonts/Roboto-ThinItalic.ttf
 - lib/thumb_gen.rb
 - lib/thumb_gen/generator.rb
+- lib/thumb_gen/test.rb
 - lib/thumb_gen/utils.rb
 - lib/thumb_gen/version.rb
 - sample_input.jpg
@@ -54,7 +73,6 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/YutoYasunaga/thumb_gen
   source_code_uri: https://github.com/YutoYasunaga/thumb_gen.git
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -69,8 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
-signing_key:
+rubygems_version: 3.7.0
 specification_version: 4
 summary: Auto generate customized thumbnails for articles.
 test_files: []