aaf-lipstick 4.2.0 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 51c40a77140713b3547d8b516df90c8330ee5b56
-  data.tar.gz: 439534035d5c998f865b5f37dcd04cbac9f987a3
+SHA256:
+  metadata.gz: e1169058e87d4e424cc8ce2591249b54dd0902d05eecfc17afc82999a138c953
+  data.tar.gz: df5e54e75c7bec1f17d373f4af40acf488f1827aec3212a0c6a7d98244aa082b
 SHA512:
-  metadata.gz: 2a83ab4c24cdda9b10d0030ff42d2505608e41e936eec332331394a92248bd9bd74df8c15512c7b64af9f62badeda1efc48cdee5559aacb68dac4ca9ef32a242
-  data.tar.gz: 5321a107c28a281c745774a5ffd1472afa4644da7b1efa1a322b0685eac09557b0c0c848e6fb4835c211a94c03f4331ec83f6d0720f724662f252787d27343d7
+  metadata.gz: f5be585896864525226c357e68a03d7e7068c2ad7794729c561d335a8cb0b7a11950d27d75424dfc4cc00ce125538bf5ec3fd2a32870ea008c27496a62835df0
+  data.tar.gz: 58e9d15f2b0b00990f16d07a08adffe71e5f205f5aff054542db5728bc16567e41327a0d0202616a314c8ba254dc7476cd835464493e30b914f0e586f29f1722

data/lib/lipstick/auto_validation.rb

@@ -7,8 +7,8 @@ module Lipstick
         return if base.respond_to?(:validators)
 
         raise('Lipstick::AutoValidation requires a class which responds' \
-             ' to the `validators` method. For example, as provided by' \
-             ' ActiveModel::Validations')
+              ' to the `validators` method. For example, as provided by' \
+              ' ActiveModel::Validations')
       end
 
       def lipstick_auto_validators

data/lib/lipstick/filterable.rb

@@ -10,6 +10,7 @@ module Lipstick
       attr_reader :attribute, :collation
 
       def initialize(attribute, collation)
+        super()
         @attribute = attribute
         @collation = collation
       end

data/lib/lipstick/helpers/bootstrap_form_builder.rb

@@ -27,20 +27,20 @@ class BootstrapFormBuilder < ActionView::Helpers::FormBuilder
     super
   end
 
-  def check_box(*)
+  def check_box(*, &block)
     template.content_tag('div', class: 'checkbox') do
       template.content_tag('label') do
         template.concat(super)
-        template.concat(template.capture { yield })
+        template.concat(template.capture(&block))
       end
     end
   end
 
-  def radio_button(*)
+  def radio_button(*, &block)
     template.content_tag('div', class: 'radio') do
       template.content_tag('label') do
         template.concat(super)
-        template.concat(template.capture { yield })
+        template.concat(template.capture(&block))
       end
     end
   end

data/lib/lipstick/helpers/form_helper.rb

@@ -5,34 +5,36 @@ module Lipstick
     module FormHelper
       include ActionView::Helpers::FormTagHelper
 
-      def field_block(html_opts = {})
+      def field_block(html_opts = {}, &block)
         add_css_class(html_opts, 'form-group')
-        content_tag('div', html_opts) { yield }
+        content_tag('div', html_opts, &block)
       end
 
-      def radio_button_tag(name, value, checked = false, options = {})
+      # rubocop:disable Style/OptionalBooleanParameter
+      def radio_button_tag(name, value, checked = false, options = {}, &block)
         content_tag('div', class: 'radio') do
           content_tag('label') do
             concat(super)
-            concat(capture { yield })
+            concat(capture(&block))
           end
         end
       end
+      # rubocop:enable Style/OptionalBooleanParameter
 
-      def check_box_tag(*)
+      def check_box_tag(*, &block)
         content_tag('div', class: 'checkbox') do
           content_tag('label') do
             concat(super)
-            concat(capture { yield })
+            concat(capture(&block))
           end
         end
       end
 
       alias orig_form_tag form_tag
 
-      def inline_form_tag(url_for_options = {}, options = {})
+      def inline_form_tag(url_for_options = {}, options = {}, &block)
         add_css_class(options, 'form-inline')
-        form_tag(url_for_options, options) { yield }
+        form_tag(url_for_options, options, &block)
       end
 
       def search_form_tag(filter, url: nil,
@@ -111,7 +113,7 @@ module Lipstick
       end
 
       def delete_button_tag(url, text: true, **opts)
-        action = text&.is_a?(String) ? text : 'Delete'
+        action = text.is_a?(String) ? text : 'Delete'
 
         content_tag('div', class: 'btn-group') do
           concat(delete_dropdown_opener(text && action, opts))
@@ -135,7 +137,7 @@ module Lipstick
       #     v.validate_field(:name, ...) # Validate the test_object[name] field
       #   end
       # %>
-      def validate_form(selector, sym = nil)
+      def validate_form(selector, sym = nil, &block)
         opts = {
           type: 'application/vnd.aaf.lipstick.validations+json',
           'data-target': selector,
@@ -143,7 +145,7 @@ module Lipstick
         }
 
         content_tag('script', opts) do
-          validation_json(sym) { |v| yield v }.html_safe
+          validation_json(sym, &block).html_safe
         end
       end
 

data/lib/lipstick/helpers/form_validation_builder.rb

@@ -42,9 +42,7 @@ module Lipstick
 
         return validate_with_param(target, validation, true) if opts.empty?
 
-        if opts.keys == [:param]
-          return validate_with_param(target, validation, opts[:param])
-        end
+        return validate_with_param(target, validation, opts[:param]) if opts.keys == [:param]
 
         add_rule(target, validation, opts)
       end

data/lib/lipstick/helpers/layout_helper.rb

@@ -10,11 +10,11 @@ module Lipstick
         end
       end
 
-      def aaf_footer
+      def aaf_footer(&block)
         content_tag('footer') do
           content_tag('div', class: 'footer-content') do
             concat(aaf_logo)
-            concat(capture { yield })
+            concat(capture(&block))
           end
         end
       end

data/lib/lipstick/helpers/nav_helper.rb

@@ -3,8 +3,8 @@
 module Lipstick
   module Helpers
     module NavHelper
-      def nav_bar
-        content_tag('nav', class: 'navbar shrink') { yield }
+      def nav_bar(&block)
+        content_tag('nav', class: 'navbar shrink', &block)
       end
 
       def nav_first_item(text, url)
@@ -14,10 +14,10 @@ module Lipstick
         end
       end
 
-      def nav_collapsing_items
+      def nav_collapsing_items(&block)
         attrs = { class: 'collapse navbar-collapse', id: 'aaf-nav-collapse' }
         content_tag('div', attrs) do
-          content_tag('ul', class: 'nav navbar-nav') { yield }
+          content_tag('ul', class: 'nav navbar-nav', &block)
         end
       end
 

data/lib/lipstick/helpers/sortable_helper.rb

@@ -25,13 +25,13 @@ module Lipstick
         link_to request.query_parameters.merge(sort_by: param_name,
                                                direction: opposite_direction) do
           concat("#{name} ")
-          concat(
-            content_tag('div', class: 'glyphicon') do
-              content_tag('div',
-                          class: "glyphicon-chevron-#{icon(direction)}") do
-              end
-            end
-          )
+          concat(glyphicon(direction))
+        end
+      end
+
+      def glyphicon(direction)
+        content_tag('div', class: 'glyphicon') do
+          content_tag('div', nil, class: "glyphicon-chevron-#{icon(direction)}")
         end
       end
 

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'rmagick'
-
 module Lipstick
   module Images
     # Creates an AAF standard email banner, with three elements, positioned as
@@ -28,17 +26,24 @@ 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:)
+        require 'rmagick'
+
         @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,130 @@
+# frozen_string_literal: true
+
+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:)
+        require 'rmagick'
+
+        @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(0) + h sin(0)
+        #
+        # w = text width
+        # h = text ascent
+        # 0 = 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(0) + h cos(0)
+        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(title:, environment:, image: 'logo.png', **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(environment:, image: 'logo.png', **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.6.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.6.0
 platform: ruby
 authors:
 - Shaun Mangelsdorf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-21 00:00:00.000000000 Z
+date: 2021-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
@@ -26,20 +26,6 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: kramdown
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rmagick
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -220,6 +206,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  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: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -252,22 +252,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
@@ -324,6 +318,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
@@ -339,15 +334,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A gem for applying AAF branding to our services