kawaii_text 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d80e40cb94b79f9fff495d3c7816765c4e206720292bad162957aa8e9c98e1bd
+  data.tar.gz: 418f4e89b3311c3631b54e1f60db658d8190d79e3cedbddde04221528f832f16
+SHA512:
+  metadata.gz: c08034767a155a88b13ed37f1988ccecafbcbc15f8024893e8494899e1968592726a337424ffbff4ba98f316b822f8880f222604e7ab695bdb42dae84ff2ce8e
+  data.tar.gz: edc4371c71b4bb7a39a32f163c3ead2307967dc1beadc1eb53b862a3306e9b1b856565bb7bf6f4a143fc2cbf485188e2cee21208ff28100b65a0f22f155391e1

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 1.17.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in kawaiitext.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    kawaii_text (0.1.0)
+      rmagick
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.13.0)
+    rake (10.5.0)
+    rmagick (4.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  kawaii_text!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -0,0 +1,125 @@
+# KawaiiText
+
+## What is this ?
+Its a ruby gem to render your text to an image with fancy fonts and some effects with backgrounds. Might be suitable if
+you ever had to generate these kind of things automatically for using them as cover or
+header images. It makes use of ImageMagick for all image manipulations
+
+## Why does this exist ?
+I had a need for something like this for a project of mine and wasn't able to find anything that fit my use case.
+
+## Examples
+![Simple](https://github.com/owaiswiz/kawaiitext/blob/master/examples/output/simple.png?raw=true "Simple")
+
+![Custom Background](https://github.com/owaiswiz/kawaiitext/blob/master/examples/output/custom_background.png?raw=true "Custom Background")
+
+![Custom Offset Text Layer Config](https://github.com/owaiswiz/kawaiitext/blob/master/examples/output/custom_offset_textlayer_config.png?raw=true "Custom Offset Text Layer Config")
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kawaii_text'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kawaii_text
+
+## Usage
+
+### 1. Require
+```ruby
+require "kawaii_text"
+```
+
+### 2. Basic Usage
+By default, this gem randomly picks a background image and font along with a default color and some stroke styles. The output is saved to the same directory as the script is run in a file named "output.png".
+```ruby
+KawaiiText::Generator.new(text: "Daisy in a field of roses")
+```
+#### Output
+![Simple](https://github.com/owaiswiz/kawaiitext/blob/master/examples/output/simple.png?raw=true "Simple")
+
+### 3. Advanced Usage
+The generator takes a lot of keyword arguments while initialization which can be used to modify various settings. The description of supported arguments and what they do are given below: 
+
+1. **text** (required, *string*) - Specifies the text to be rendered.
+ ```ruby
+KawaiiText::Generator.new(text: "Daisy in a field of roses")
+```
+___
+2. **font_path** (optional, *string*) - Specifies the font to be used (.ttf file). By default it randomly picks a font out of the 4 included with this library.
+```ruby
+KawaiiText::Generator.new(text: "bury a friend", font_path: "/home/owaiswiz/Roboto.ttf")
+```
+___
+3. **background_filepath** (optional, *string*) - Specifies the background file to be used. By default, a folder with 4 backgrounds included with this library is used and a random file from that folder is selected.
+```ruby
+KawaiiText::Generator.new(text: "bury a friend", backgrounds_folder: "/home/owaiswiz/images/rak.png")
+```
+___
+4. **backgrounds_folder** (optional, *string*) - Specifies the folder to be used for randomly picking a background. By default, a folder with 4 backgrounds included with this library is used. ***(Has no effect if background_filepath is specified)***.
+```ruby
+KawaiiText::Generator.new(text: "bury a friend", backgrounds_folder: "/home/owaiswiz/images")
+```
+___
+5. **supported_formats** (optional, *array of strings*) - Specifies the file types to consider while randomly picking a background from backgrounds_folder. By default its value is ["jpg", "jpeg", "png", "gif"].  ***(Has no effect if background_filepath is specified)***.
+```ruby
+KawaiiText::Generator.new(text: "bury a friend", backgrounds_folder: "/home/owaiswiz/images", supported_formats: ["png", "bmp"])
+```
+___
+6. **working_directory** (optional, *string*) - Specifies the path to the directory where output is saved. By default its value is the current directory from which you are running ruby.
+```ruby
+KawaiiText::Generator.new(text: "bury a friend", working_directory: "/home/owaiswiz/generated_images")
+```
+___
+7. **output_file_name** (optional, *string*) - Specifies the name of the output file. By default its value is "output".
+```ruby
+KawaiiText::Generator.new(text: "bury a friend", output_file_name: "uncomfortable.png")
+```
+___
+8. **primary_text_layer_config** (optional, *PrimaryTextLayerConfig*) - Configures the stroke size, stroke color and stroke fill color for the primary text layer.
+```ruby
+config = KawaiiText::PrimaryTextLayerConfig.new
+config.pointsize = 72
+config.stroke_width = 5
+config.stroke_color = "#e24906"
+config.stroke_fill_color = "#dc9f66"
+
+KawaiiText::Generator.new(text: "Jokes", primary_text_layer_config: config)
+
+```
+***Output:***
+![Custom Primary Text Layer Config](https://github.com/owaiswiz/kawaiitext/blob/master/examples/output/custom_primary_text_layer_config.png?raw=true "Custom Primary Text Layer Config")
+___
+9. **offset_text_layer_config** (optional, *OffsetTextLayerConfig*) - Configures the stroke size, stroke color and stroke fill color for the primary text layer.
+```ruby
+config = KawaiiText::OffsetTextLayerConfig.default
+config.stroke_color = "#59C3C3"
+config.stroke_fill_color = "#DCB6D5"
+config.stroke_fill_color = "none"
+config.stroke_width = 2
+KawaiiText::Generator.new text: "bury a friend", offset_text_layer_config: config
+```
+***Output:***
+![Custom Offset Text Layer Config](https://github.com/owaiswiz/kawaiitext/blob/master/examples/output/custom_offset_textlayer_config.png?raw=true "Custom Offset Text Layer Config")
+
+### Dependencies
+* Make sure you have ImageMagick installed.
+* RMagick (should be automatically installed if not available)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 tags, 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/owaiswiz/kawaiitext.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kawaii_text"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/examples.rb

@@ -0,0 +1,16 @@
+require "kawaii_text"
+
+#Simple using defaults
+KawaiiText::Generator.new text: "Daisy in a field of roses"
+
+#Custom Background
+KawaiiText::Generator.new text: "Everything I Wanted", background_filepath: "/home/owaiswiz/Projects/Ruby/kawaiitext/lib/assets/backgrounds/3.jpeg"
+
+#Custom Offset Text Layer Settings - Similar can be done for primary layer (refer usage)
+config = KawaiiText::OffsetTextLayerConfig.default
+config.stroke_color = "\"#59C3C3\""
+config.stroke_fill_color = "\"#DCB6D5\""
+config.stroke_fill_color = "\"none\""
+config.stroke_width = 2
+KawaiiText::Generator.new text: "bury a friend", offset_text_layer_config: config
+

data/kawaii_text.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "kawaii_text/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "kawaii_text"
+  spec.version       = KawaiiText::VERSION
+  spec.authors       = ["Owais"]
+  spec.email         = ["owaiswiz@gmail.com"]
+
+  spec.summary       = %q{A Ruby Library that renders text in fancy font with some effects to an image}
+  spec.homepage      = "https://github.com/owaiswiz/kawaiitext"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/owaiswiz/kawaiitext"
+    spec.metadata["changelog_uri"] = "https://github.com/owaiswiz/kawaiitext/releases"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_runtime_dependency "rmagick"
+end

data/lib/kawaii_text.rb

@@ -0,0 +1,9 @@
+require "kawaii_text/version"
+require "kawaii_text/directory_helpers"
+require "kawaii_text/text_layer_config"
+require "kawaii_text/generator"
+
+module KawaiiText
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/kawaii_text/directory_helpers.rb

@@ -0,0 +1,17 @@
+module KawaiiText
+  def self.root
+    File.dirname __dir__
+  end
+
+  def self.assets
+    File.join root, 'assets'
+  end
+
+  def self.backgrounds_dir
+    File.join assets, 'backgrounds' 
+  end
+
+  def self.fonts_dir
+    File.join assets, 'fonts' 
+  end
+end

data/lib/kawaii_text/generator.rb

@@ -0,0 +1,115 @@
+require "rmagick"
+
+module KawaiiText
+  class Generator
+    SUPPORTED_BACKGROUND_FILEFORMATS = ["jpg", "jpeg", "png", "gif"]
+    BACKGROUND_TO_TEXT_LAYER_WIDTH_RATIO = 1.15
+    BACKGROUND_TO_TEXT_LAYER_HEIGHT_RATIO = 1.05
+    PRIMARY_TEXT_LAYER_FILENAME = "primary"
+    OFFSET_TEXT_LAYER_FILENAME = "offset"
+    MERGED_TEXT_LAYER_FILENAME = "merged"
+
+    def initialize text:, font_path: nil, backgrounds_folder: nil, background_filepath: nil, supported_formats: nil, working_directory: nil, primary_text_layer_config: nil, offset_text_layer_config: nil, output_file_name: nil
+      @text = text
+      @font_path = font_path || get_random_font_from_fonts_folder
+      @backgrounds_folder = backgrounds_folder || KawaiiText.backgrounds_dir
+      @background_filepath = background_filepath
+      @working_directory = working_directory
+      @supported_formats = supported_formats || SUPPORTED_BACKGROUND_FILEFORMATS
+      @working_directory = working_directory || "."
+      @output_file_name = output_file_name || "output"
+
+      @primary_text_layer_config = primary_text_layer_config || PrimaryTextLayerConfig.default
+      @offset_text_layer_config = offset_text_layer_config || OffsetTextLayerConfig.default
+
+      @background_filepath ||= get_random_background_from_backgrounds_folder
+      @background_image = open_image @background_filepath
+
+      generate_primary_text_layer
+      generate_offset_text_layer
+      merge_text_layers
+      merge_text_and_background_layers
+      cleanup
+    end
+
+    private
+    def open_image file_path
+      Magick::ImageList.new(file_path)
+    end
+
+    def get_random_background_from_backgrounds_folder
+      files = Dir["#{@backgrounds_folder}/**/**.{#{@supported_formats.join(',')}}"]
+      files.sample
+    end
+
+    def get_random_font_from_fonts_folder
+      fonts = Dir["#{KawaiiText.fonts_dir}/**/**.{ttf,TTF}"]
+      fonts.sample
+    end
+
+    def generate_primary_text_layer 
+      generate_text_layer @primary_text_layer_config, PRIMARY_TEXT_LAYER_FILENAME
+    end
+
+    def generate_offset_text_layer 
+      generate_text_layer @offset_text_layer_config, OFFSET_TEXT_LAYER_FILENAME
+    end
+
+    def generate_text_layer text_layer_config, output_file_name
+      text_layer_width = (@background_image.columns / BACKGROUND_TO_TEXT_LAYER_WIDTH_RATIO).round
+      text_layer_height = (@background_image.rows / BACKGROUND_TO_TEXT_LAYER_HEIGHT_RATIO).round
+
+      command = ["convert"]
+      command << "-size #{text_layer_width}x#{text_layer_height}"
+      command << "-background transparent"
+      command << "-font \"#{@font_path}\"" if @font_path
+      command << "-gravity center"
+      command << "-pointsize #{text_layer_config.pointsize}"
+      command << "-strokewidth #{text_layer_config.stroke_width}"
+      command << "-stroke \"#{text_layer_config.stroke_color}\""
+      command << "-fill \"#{text_layer_config.stroke_fill_color}\""
+      command << "-interline-spacing #{text_layer_config.pointsize/2}"
+      command << "caption:\"#{@text}\""
+      command << "\"#{@working_directory}/#{output_file_name}.png\""
+
+      `#{command.join " "}`
+    end
+
+    def merge_text_layers
+      file_1_path = "#{@working_directory}/#{PRIMARY_TEXT_LAYER_FILENAME}.png" 
+      file_2_path = "#{@working_directory}/#{OFFSET_TEXT_LAYER_FILENAME}.png" 
+      file_output_path = "#{@working_directory}/#{MERGED_TEXT_LAYER_FILENAME}.png"
+      merge_images offset: "-3+4", file_1_path: file_1_path, file_2_path: file_2_path, file_output_path: file_output_path
+    end
+
+    def merge_text_and_background_layers
+      file_1_path = "#{@working_directory}/#{MERGED_TEXT_LAYER_FILENAME}.png" 
+      file_2_path = @background_filepath
+      file_output_path = "#{@working_directory}/#{@output_file_name}.png"
+      merge_images file_1_path: file_1_path, file_2_path: file_2_path, file_output_path: file_output_path
+    end
+
+    def merge_images offset: nil, file_1_path:, file_2_path:, file_output_path:
+      command = ["composite"]
+      command << "-dissolve 100"
+      command << "-gravity center"
+      command << "-geometry #{offset}" if offset
+      command << "\"#{file_1_path}\""
+      command << "\"#{file_2_path}\""
+      command << "-alpha Set"
+      command << "\"#{file_output_path}\""
+
+      `#{command.join " "}`
+    end
+
+    def cleanup
+      self.class.delete_if_exists "#{@working_directory}/#{PRIMARY_TEXT_LAYER_FILENAME}.png"
+      self.class.delete_if_exists "#{@working_directory}/#{OFFSET_TEXT_LAYER_FILENAME}.png"
+      self.class.delete_if_exists "#{@working_directory}/#{MERGED_TEXT_LAYER_FILENAME}.png"
+    end
+
+    def self.delete_if_exists file_path
+      File.delete file_path if File.exists? file_path
+    end
+  end
+end

data/lib/kawaii_text/text_layer_config.rb

@@ -0,0 +1,30 @@
+module KawaiiText
+  class TextLayerConfig 
+    attr_accessor :pointsize, :stroke_width, :stroke_color, :stroke_fill_color
+
+    def self.default
+      config = TextLayerConfig.new
+      config.pointsize = 72
+      config.stroke_width = 3
+      config.stroke_color = "none"
+      config.stroke_fill_color = "none"
+      config
+    end
+  end
+
+  class PrimaryTextLayerConfig < TextLayerConfig
+    def self.default
+      config = TextLayerConfig.default
+      config.stroke_fill_color = "white"
+      config
+    end
+  end
+
+  class OffsetTextLayerConfig < TextLayerConfig
+    def self.default
+      config = TextLayerConfig.default
+      config.stroke_color = "green"
+      config
+    end
+  end
+end

data/lib/kawaii_text/version.rb

@@ -0,0 +1,3 @@
+module KawaiiText
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: kawaii_text
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Owais
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- owaiswiz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/examples.rb
+- examples/output/custom_background.png
+- examples/output/custom_offset_textlayer_config.png
+- examples/output/custom_primary_text_layer_config.png
+- examples/output/simple.png
+- kawaii_text.gemspec
+- lib/assets/backgrounds/1.jpeg
+- lib/assets/backgrounds/2.jpeg
+- lib/assets/backgrounds/3.jpeg
+- lib/assets/backgrounds/4.jpeg
+- lib/assets/backgrounds/5.jpeg
+- lib/assets/fonts/CANDY.TTF
+- lib/assets/fonts/PlatonickNF.ttf
+- lib/assets/fonts/UndergroundNF.ttf
+- lib/assets/fonts/nauvo___.ttf
+- lib/kawaii_text.rb
+- lib/kawaii_text/directory_helpers.rb
+- lib/kawaii_text/generator.rb
+- lib/kawaii_text/text_layer_config.rb
+- lib/kawaii_text/version.rb
+homepage: https://github.com/owaiswiz/kawaiitext
+licenses: []
+metadata:
+  homepage_uri: https://github.com/owaiswiz/kawaiitext
+  source_code_uri: https://github.com/owaiswiz/kawaiitext
+  changelog_uri: https://github.com/owaiswiz/kawaiitext/releases
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: A Ruby Library that renders text in fancy font with some effects to an image
+test_files: []