thumb_gen 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 41d3877cca74ee8be478d2bd947ec04af23df5fce6230266c325f512a2f83552
+  data.tar.gz: 3487c8f101ea4701ee3f87343a5e7bd469b8404f9f75076e5dcd5d499c40ada4
+SHA512:
+  metadata.gz: ebbadacf1170fecd034bbe1038b49b7e99316a9f22e4d74b93e5d33af9d1e5d19c1bdc4fa677bdf364d304fae3737be87a91a209ec26c1cf9a6d4de5c6c01554
+  data.tar.gz: bddce782eb6011728bff78e2f0fb5af26e46eced0f2be241c30c08fcf2b81c49f7ea0c794e47aeb4d22767476d919995f700cf66dd2fb1f123108b3a9b90af4f

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 200
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/BlockLength:
+  Max: 50
+
+Metrics/MethodLength:
+  Max: 20

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 YutoYasunaga
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,89 @@
+# 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.
+
+
+Input Image | Output Image
+:-------------------------:|:-------------------------:
+![Input](sample_input.jpg)  |  ![Output](sample_output.jpg)
+
+
+## Installation
+
+To install ThumbGen, simply add it to your application's Gemfile:
+
+```bash
+bundle add thumb_gen
+```
+
+Alternatively, you can install it yourself as:
+
+
+```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:
+
+```ruby
+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_size: 80,
+    style: 'bold',
+    color: '#047857',
+    outline_color: '#f8fafc',
+    outline_width: 1,
+    gravity: 'northwest',
+    position_x: 40,
+    position_y: 120
+  },
+  {
+    text: '5 min read',
+    wrapped_width: 800,
+    font_size: 48,
+    style: 'italic',
+    color: '#09090b',
+    gravity: 'southwest',
+    position_x: 400,
+    position_y: 40
+  },
+  {
+    text: 'My Blog',
+    wrapped_width: 1280,
+    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
+
+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
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/YutoYasunaga/thumb_gen.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rails_best_practices/rake_task'
+require 'rspec/core/rake_task'
+
+RuboCop::RakeTask.new
+RailsBestPractices::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[rubocop rails_best_practices spec]

data/lib/thumb_gen/generator.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require 'rmagick'
+require 'thumb_gen/utils'
+
+module ThumbGen
+  class Generator
+    include Utils
+
+    attr_reader :output_path, :background_url, :texts, :options
+
+    def initialize(output_path, background_url, texts, options)
+      @output_path = output_path
+      @background_url = background_url
+      @texts = texts
+      @options = options
+    end
+
+    def generate
+      generate_image
+    end
+
+    private
+
+    # Retrieves and caches the background image.
+    def background
+      @background ||= Magick::Image.read(background_url).first
+    end
+
+    # Handles the resizing, formatting, and text addition for the image.
+    def generate_image
+      background.resize_to_fill!(options[:width], options[:height])
+      background.format = options[:format]
+      add_texts
+      background.write(output_path)
+    end
+
+    # 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
+        )
+      end
+    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
+    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
+      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
+      end
+    end
+
+    # Converts a string description to a Magick gravity constant using a hash map.
+    def gravity(str)
+      gravity_map = {
+        'northwest' => Magick::NorthWestGravity,
+        'north' => Magick::NorthGravity,
+        'northeast' => Magick::NorthEastGravity,
+        'west' => Magick::WestGravity,
+        'east' => Magick::EastGravity,
+        'southwest' => Magick::SouthWestGravity,
+        'south' => Magick::SouthGravity,
+        'southeast' => Magick::SouthEastGravity,
+        'center' => Magick::CenterGravity
+      }
+
+      # Return the corresponding gravity value or default to CenterGravity if not found
+      gravity_map[str] || Magick::CenterGravity
+    end
+  end
+end

data/lib/thumb_gen/utils.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module ThumbGen
+  module Utils
+    # Draws customized text on an image.
+    def draw_text(image, text, **opts)
+      draw = Magick::Draw.new
+      draw.font = opts[:font]
+      draw.font_weight = opts[:font_weight]
+      draw.font_style = opts[:font_style]
+      draw.pointsize = opts[:font_size]
+      draw.fill = opts[:color]
+      draw.gravity = opts[:gravity]
+      if opts[:outline_width].to_i.positive?
+        draw.stroke = opts[:outline_color]
+        draw.stroke_width = opts[:outline_width]
+      end
+
+      wrapped_text = word_wrap(text, opts[:wrapped_width], draw)
+
+      draw.annotate(
+        image,
+        0,
+        0,
+        opts[:position_x],
+        opts[:position_y],
+        wrapped_text
+      )
+    end
+
+    # Wraps text to fit within a specified width.
+    def word_wrap(text, max_width, draw)
+      lines = []
+      current_line = ''
+
+      text.split.each do |word|
+        if word_too_wide?(word, max_width, draw)
+          lines.concat(split_word_into_lines(word, max_width, draw))
+        else
+          test_line = current_line.empty? ? word : "#{current_line} #{word}"
+          if word_too_wide?(test_line, max_width, draw)
+            lines << current_line
+            current_line = word
+          else
+            current_line = test_line
+          end
+        end
+      end
+
+      lines << current_line unless current_line.empty?
+      lines.join("\n")
+    end
+
+    # Helper method to determine if the text exceeds the maximum width.
+    def word_too_wide?(text, max_width, draw)
+      draw.get_type_metrics(text).width > max_width
+    end
+
+    # Splits a single word into lines if it's too wide to fit the max width.
+    def split_word_into_lines(word, max_width, draw)
+      word.each_char.with_object(['']) do |char, segments|
+        test_segment = segments.last + char
+        if word_too_wide?(test_segment, max_width, draw)
+          segments << char
+        else
+          segments[-1] = test_segment
+        end
+      end
+    end
+  end
+end

data/lib/thumb_gen/version.rb

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

data/lib/thumb_gen.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative 'thumb_gen/version'
+require 'thumb_gen/generator'
+
+module ThumbGen
+  class Error < StandardError; end
+
+  def self.generate(output_path, background_url, texts, options)
+    Generator.new(output_path, background_url, texts, options).generate
+  end
+end

data/sig/thumb_gen.rbs

@@ -0,0 +1,4 @@
+module ThumbGen
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: thumb_gen
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- YutoYasunaga
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+description: ThumbGen is a Ruby gem that simplifies the creation of article thumbnails
+  by allowing developers to easily generate and customize thumbnails with text overlays.
+  Ideal for blogs, news sites, and any content-driven platforms.
+email:
+- yuto.yasunaga@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- default.png
+- lib/thumb_gen.rb
+- lib/thumb_gen/generator.rb
+- lib/thumb_gen/utils.rb
+- lib/thumb_gen/version.rb
+- sample_input.jpg
+- sample_output.jpg
+- sig/thumb_gen.rbs
+homepage: https://github.com/YutoYasunaga/thumb_gen
+licenses:
+- MIT
+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
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.18
+signing_key:
+specification_version: 4
+summary: Auto generate customized thumbnails for articles.
+test_files: []