aaf-lipstick 4.2.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 51c40a77140713b3547d8b516df90c8330ee5b56
-  data.tar.gz: 439534035d5c998f865b5f37dcd04cbac9f987a3
+SHA256:
+  metadata.gz: 78d935ff8ff247803b2bf7580d5284eb3470054e5ee6875be5d024fb1d5ae6fe
+  data.tar.gz: 42d1c91bf89f1e294809718641bec4390c178366082b4aa7c362735f6d89b6da
 SHA512:
-  metadata.gz: 2a83ab4c24cdda9b10d0030ff42d2505608e41e936eec332331394a92248bd9bd74df8c15512c7b64af9f62badeda1efc48cdee5559aacb68dac4ca9ef32a242
-  data.tar.gz: 5321a107c28a281c745774a5ffd1472afa4644da7b1efa1a322b0685eac09557b0c0c848e6fb4835c211a94c03f4331ec83f6d0720f724662f252787d27343d7
+  metadata.gz: 531ff037d5f0b6fcbebe46d02eb8bba04c583f42f66a69e5e3982e161762e4906e5a8838f4bfc6bad7752d2b023d48da018985d6b55675cc5e425c7cc5e4a426
+  data.tar.gz: 20c246377c4ce1b00eb248351aebce3f1249918dbb3b8988917c4cba187c2c9c5f2f0980d239b6a33ff572da05af33935bef94d37c46aebd0e5a5ace49e646b0

data/lib/lipstick/images.rb

@@ -6,4 +6,5 @@ module Lipstick
 end
 
 require 'lipstick/images/email_banner'
+require 'lipstick/images/logo_only_email_banner'
 require 'lipstick/images/processor'

data/lib/lipstick/images/email_banner.rb

@@ -28,17 +28,22 @@ module Lipstick
     #
     # For image compositing, (x, y) is the position of the top-left corner.
     class EmailBanner
-      def initialize(image:, title:, environment:)
+      def initialize(image:, title:, environment:,
+                     background_color:, resize_to:)
         @title = title
         @environment = environment
         @image = image
+        @background_color = background_color
+        @resize_to = resize_to
       end
 
       def to_png
+        bgcolor = @background_color
+
         canvas = Magick::ImageList.new
         canvas.new_image(WIDTH, HEIGHT) do |f|
           f.format = 'PNG'
-          f.background_color = '#2A3685'
+          f.background_color = bgcolor
         end
 
         annotate_title(canvas)
@@ -90,7 +95,7 @@ module Lipstick
 
       def logo
         @logo ||= Magick::Image.read(@image.pathname.to_s).first
-                               .resize_to_fill(78, 78)
+                               .resize_to_fill(@resize_to[0], @resize_to[1])
       end
 
       def gap

data/lib/lipstick/images/logo_only_email_banner.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require 'rmagick'
+
+require 'pry'
+
+module Lipstick
+  module Images
+    # Creates a logo-only email banner, with two elements.
+    #
+    # 1. Logo, centered vertically and horizontally within the image.
+    # 2. Environment string, stamped across the logo.
+    #
+    # The math here seemed like it would be a lot simpler than the EmailBanner
+    # class, but then I went and made it all confusing by bringing trigonometry
+    # into it. I promise there was a good reason for doing it.
+    class LogoOnlyEmailBanner
+      def initialize(image:, environment:, background_color:)
+        @environment = environment.upcase
+        @image = image
+        @background_color = background_color
+      end
+
+      def to_png
+        bgcolor = @background_color
+
+        canvas = Magick::ImageList.new
+        canvas.new_image(WIDTH, HEIGHT) do |f|
+          f.format = 'PNG'
+          f.background_color = bgcolor
+        end
+
+        canvas.composite!(logo, logo_x, logo_y, Magick::SrcOverCompositeOp)
+
+        annotate_environment(canvas)
+
+        canvas.to_blob
+      end
+
+      private
+
+      WIDTH = 600
+      HEIGHT = 150
+      MID_Y = HEIGHT / 2
+      ANGLE_DEGREES = 10
+      ANGLE_RADIANS = Math::PI * ANGLE_DEGREES / 180
+      private_constant :WIDTH, :HEIGHT, :MID_Y, :ANGLE_DEGREES, :ANGLE_RADIANS
+
+      def environment_format
+        @environment_format ||= Magick::Draw.new do |title|
+          title.font_family = 'ArialB'
+          title.font_weight = 900
+          title.pointsize = 36
+          title.gravity = Magick::ForgetGravity
+          title.fill = '#bc2028'
+          title.rotation = (-1) * ANGLE_DEGREES
+        end
+      end
+
+      def blank_environment?
+        !@environment&.present?
+      end
+
+      def annotate_environment(canvas)
+        return if blank_environment?
+
+        environment_format.annotate(canvas, 0, 0, env_x, env_y, @environment)
+      end
+
+      def logo
+        @logo ||= Magick::Image.read(@image.pathname.to_s).first
+      end
+
+      def gap
+        @gap ||= environment_format.get_type_metrics('AAF').width
+      end
+
+      def logo_w
+        logo.bounding_box.width
+      end
+
+      # x position to vertically center logo
+      def logo_x
+        ((WIDTH - logo.bounding_box.width) / 2).round
+      end
+
+      # y position to vertically center logo
+      def logo_y
+        ((HEIGHT - logo.bounding_box.height) / 2).round
+      end
+
+      def env_metrics
+        return OpenStruct.new(width: 0, height: 0) if blank_environment?
+
+        environment_format.get_type_metrics(@environment)
+      end
+
+      def env_x
+        m = env_metrics
+
+        # The horizontal width of the environment text is found by:
+        # w cos(Θ) + h sin(Θ)
+        #
+        # w = text width
+        # h = text ascent
+        # Θ = angle of text rotation
+        #
+        # Contrary to the description in `EmailBanner`, since we're upper
+        # casing the environment string here, we don't need to worry about text
+        # descent.
+        w = Math.cos(ANGLE_RADIANS) * m.width +
+            Math.sin(ANGLE_RADIANS) * m.ascent
+
+        # We center that the same as for `logo_x`
+        ((WIDTH - w) / 2).round
+      end
+
+      def env_y
+        m = env_metrics
+
+        # The horizontal width of the environment text is found by:
+        # w sin(Θ) + h cos(Θ)
+        h = Math.sin(ANGLE_RADIANS) * m.width +
+          Math.cos(ANGLE_RADIANS) * m.ascent
+
+        # We use addition here instead of the usual subtraction, as the text
+        # moves in the upward direction from the position we set.
+        ((HEIGHT + h) / 2).round
+      end
+    end
+  end
+end

data/lib/lipstick/images/processor.rb

@@ -16,11 +16,28 @@ module Lipstick
         end
         # rubocop:enable Security/Eval
 
-        def email_banner(image: 'logo.png', title:, environment:)
+        def email_banner(image: 'logo.png', title:, environment:, **kwargs)
           @context.depend_on_asset(image)
           asset = @context.environment.find_asset(image)
-          EmailBanner.new(image: asset, title: title, environment: environment)
-                     .to_png
+
+          EmailBanner.new(
+            image: asset,
+            title: title,
+            environment: environment,
+            background_color: kwargs[:background_color] || '#2A3685',
+            resize_to: kwargs[:resize_to] || [78, 78]
+          ).to_png
+        end
+
+        def logo_only_email_banner(image: 'logo.png', environment:, **kwargs)
+          @context.depend_on_asset(image)
+          asset = @context.environment.find_asset(image)
+
+          LogoOnlyEmailBanner.new(
+            image: asset,
+            environment: environment,
+            background_color: kwargs[:background_color] || '#2A3685'
+          ).to_png
         end
       end
 

data/lib/lipstick/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lipstick
-  VERSION = '4.2.0'
+  VERSION = '4.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aaf-lipstick
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.3.0
 platform: ruby
 authors:
 - Shaun Mangelsdorf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-21 00:00:00.000000000 Z
+date: 2019-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
@@ -324,6 +324,7 @@ files:
 - lib/lipstick/helpers/sortable_helper.rb
 - lib/lipstick/images.rb
 - lib/lipstick/images/email_banner.rb
+- lib/lipstick/images/logo_only_email_banner.rb
 - lib/lipstick/images/processor.rb
 - lib/lipstick/sortable.rb
 - lib/lipstick/version.rb
@@ -346,8 +347,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A gem for applying AAF branding to our services