gif_countdown 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 05a548ff4d76da19d2715dd9427d7110ede683c572c09212128d250023b4f97e
+  data.tar.gz: d831c3ef65065ce5fa268d59e6da763d4ac1571597b3aeb4fd65a59f734a1988
+SHA512:
+  metadata.gz: 1e335003414fd5b0a3d4fc1ab0e2248bfc7cc49547744790fc2309ff4bde4bc0268908f9c59244b2adc000c59d7a4152fc5d03ff50e31cdcee0ff9d6e8222591
+  data.tar.gz: 5d08fe0e3dc334109e2c6e534ca5a5778bb08455ce52f55851be0c2aaa2beb5d2d496a1be258d683aff52edd874f36c97b646e091390936ddf9cd002fe3358c1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Stefan Wienert
+
+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,70 @@
+# GifCountdown
+
+Create a animated gif countdown picture using RMagick.
+
+Each frame is a second.
+
+Useful for mailings campaign / event notifications.
+
+![Example](https://raw.githubusercontent.com/zealot128/gif_countdown/main/doc/example.gif)
+
+## Usage
+
+```
+blob = GifCountdown.generate(distance_in_seconds: distance_in_seconds, duration: 5)
+```
+
+Usage in a Rails controller:
+
+```ruby
+def show
+  distance_in_seconds = (some_future_event - Time.zone.now).round
+
+  blob = GifCountdown.generate(distance_in_seconds: distance_in_seconds, duration: 10)
+  send_data blob, type: 'image/gif', disposition: 'inline'
+end
+```
+
+Make sure to build a minute cache or something, as building that images might take a couple of seconds every time!
+
+### Available Keyword Arguments:
+
+With defaults
+
+```
+distance_in_seconds: nil #Number of seconds to countdown
+width: 535
+height: 61
+fontsize: 30
+padding_x: 10
+duration: 60 # how many seconds to generate - linearily takes longer to generator
+font: 'Ubuntu' # That font must be installed on the target host that generates the image!
+```
+
+### I18n
+
+It uses "I18n" to build up the words "Days", "Hours", "Seconds", "Minutes" with plurarlization. The Gem ships with en/de.
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gif_countdown'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install gif_countdown
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,7 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'bundler/gem_tasks'

data/config/locales/gif_countdown.de.yml

@@ -0,0 +1,14 @@
+de:
+  gif_countdown:
+    days:
+      one: Tag
+      other: Tage
+    hours:
+      one: Stunde
+      other: Stunden
+    minutes:
+      one: Minute
+      other: Minuten
+    seconds:
+      one: Sekunde
+      other: Sekunden

data/config/locales/gif_countdown.en.yml

@@ -0,0 +1,15 @@
+en:
+  gif_countdown:
+    days:
+      one: day
+      other: days
+    hours:
+      one: hour
+      other: hours
+    minutes:
+      one: minute
+      other: minutes
+    seconds:
+      one: second
+      other: seconds
+

data/lib/gif_countdown.rb

@@ -0,0 +1,11 @@
+if defined?(Rails::Engine)
+  require "gif_countdown/engine"
+end
+
+require 'gif_countdown/generator'
+
+module GifCountdown
+  def self.generate(**args)
+    GifCountdown::Generator.new(**args).call
+  end
+end

data/lib/gif_countdown/engine.rb

@@ -0,0 +1,5 @@
+module GifCountdown
+  class Engine < ::Rails::Engine
+    isolate_namespace GifCountdown
+  end
+end

data/lib/gif_countdown/generator.rb

@@ -0,0 +1,101 @@
+require 'rmagick'
+
+class GifCountdown::Generator
+  attr_reader :width, :height, :fontsize, :padding_x, :font
+
+  def initialize(distance_in_seconds:, width: 535, height: 61, fontsize: 30, padding_x: 10, duration: 60, font: 'Ubuntu')
+    @distance_in_seconds = distance_in_seconds
+    @width = width
+    @height = height
+    @fontsize = fontsize
+    @padding_x = padding_x
+    @duration = duration
+    @font = font
+  end
+
+  def call
+    gif = Magick::ImageList.new
+    gif.delay = 100
+    gif.ticks_per_second = 100
+
+    @duration.times do |i|
+      image = Magick::Image.new(width, height)
+      image.delay = 100
+      annotate_with_countdown(image: image, seconds: @distance_in_seconds - i)
+      gif << image
+    end
+    gif.to_blob { self.format = 'gif' }
+  end
+
+  def pluralize(count, key)
+    I18n.t("gif_countdown.#{key}", count: count)
+  end
+
+  def annotate_with_countdown(image:, seconds:)
+    this = self
+    draw = Magick::Draw.new
+    draw.gravity = Magick::NorthGravity
+    boxwidth = (width - padding_x * 5) / 4.0
+
+    parts = seconds_to_countdown(seconds)
+
+    text_y = height / 2 + padding_x / 2
+    x = padding_x
+    image.annotate(draw, boxwidth, height / 2, x, 0, parts[:days]) {
+      self.pointsize = this.fontsize
+      self.font_family = this.font
+    }
+    image.annotate(draw, boxwidth, height / 2, x, text_y, pluralize(parts[:days], :days)) {
+      self.pointsize = (this.fontsize * 0.7).round
+      self.font_family = this.font
+    }
+
+    x = padding_x * 2 + boxwidth
+    image.annotate(draw, boxwidth, height / 2, x, 0, parts[:hours]) {
+      self.pointsize = this.fontsize
+      self.font_family = this.font
+    }
+    image.annotate(draw, boxwidth, height / 2, x, text_y, pluralize(parts[:hours], :hours)) {
+      self.pointsize = (this.fontsize * 0.7).round
+      self.font_family = this.font
+    }
+
+    x = padding_x * 3 + boxwidth * 2
+    image.annotate(draw, boxwidth, height / 2, x, 0, parts[:minutes]) {
+      self.pointsize = this.fontsize
+      self.font_family = this.font
+    }
+    image.annotate(draw, boxwidth, height / 2, x, text_y, pluralize(parts[:minutes], :minutes)) {
+      self.pointsize = (this.fontsize * 0.7).round
+      self.font_family = this.font
+    }
+
+    x = padding_x * 4 + boxwidth * 3
+    image.annotate(draw, boxwidth, height / 2, x, 0, parts[:seconds]) {
+      self.pointsize = this.fontsize
+      self.font_family = this.font
+    }
+    image.annotate(draw, boxwidth, height / 2, x, text_y, pluralize(parts[:seconds], :seconds)) {
+      self.pointsize = (this.fontsize * 0.7).round
+      self.font_family = this.font
+    }
+  end
+
+  def seconds_to_countdown(seconds)
+    days = seconds / 1.day
+    seconds -= days * 1.day.to_i
+
+    hours = seconds / 1.hour
+    seconds -= hours * 1.hour.to_i
+
+    minutes = seconds / 1.minute
+    seconds -= minutes * 1.minute.to_i
+
+    {
+      days: sprintf("%02d", days),
+      hours: sprintf("%02d", hours),
+      minutes: sprintf("%02d", minutes),
+      seconds: sprintf("%02d", seconds)
+    }
+  end
+end

data/lib/gif_countdown/version.rb

@@ -0,0 +1,3 @@
+module GifCountdown
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: gif_countdown
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stefan Wienert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: i18n
+  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: Create a countdown timer animated GIF
+email:
+- info@stefanwienert.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- config/locales/gif_countdown.de.yml
+- config/locales/gif_countdown.en.yml
+- lib/gif_countdown.rb
+- lib/gif_countdown/engine.rb
+- lib/gif_countdown/generator.rb
+- lib/gif_countdown/version.rb
+homepage: https://github.com/pludoni/gif_countdown
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Create a countdown timer animated GIF
+test_files: []