aaf-lipstick 1.1.0

data/lib/lipstick/helpers/nav_helper.rb

@@ -0,0 +1,50 @@
+module Lipstick
+  module Helpers
+    module NavHelper
+      include ActionView::Helpers::TagHelper
+      include ActionView::Helpers::TextHelper
+
+      def nav_bar(&block)
+        content_tag('nav') do
+          css_class = 'ui borderless inverted menu collapsing nav parent'
+          content_tag('div', class: css_class) do
+            concat(nav_collapse_button)
+            concat(capture(&block))
+          end
+        end
+      end
+
+      def nav_collapsing_items(&block)
+        content_tag('span', class: 'collapsing nav content', &block)
+      end
+
+      def nav_item(text, url, html_opts = {})
+        html_opts[:class] = "#{html_opts[:class]} item".strip
+        content_tag('a', text, html_opts.merge(href: url))
+      end
+
+      def nav_items_right(&block)
+        content_tag('div', class: 'right menu', &block)
+      end
+
+      def nav_dropdown(title, &block)
+        content_tag('div', class: 'ui simple dropdown item') do
+          concat(content_tag('i', '', class: 'dropdown icon'))
+          concat(title)
+          concat(content_tag('div', class: 'menu', &block))
+        end
+      end
+
+      private
+
+      def nav_collapse_button
+        content_tag('div', class: 'collapsing nav button') do
+          content_tag('a', href: '#',
+                           class: 'ui icon mini black open button') do
+            content_tag('i', '', class: 'list layout icon')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lipstick/helpers/semantic_form_builder.rb

@@ -0,0 +1,2 @@
+class SemanticFormBuilder < ActionView::Helpers::FormBuilder
+end

data/lib/lipstick/images.rb

@@ -0,0 +1,7 @@
+module Lipstick
+  module Images
+  end
+end
+
+require 'lipstick/images/email_banner'
+require 'lipstick/images/processor'

data/lib/lipstick/images/email_banner.rb

@@ -0,0 +1,154 @@
+require 'rmagick'
+
+module Lipstick
+  module Images
+    # Creates an AAF standard email banner, with three elements, positioned as
+    # follows:
+    #
+    # 1. AAF Logo. Vertically centered and left-aligned within the content box,
+    #    and with a blank space to the right.
+    # 2. Application title. Vertically centered, and left-aligned to the logo's
+    #    right margin.
+    # 3. Environment string. Positioned 10 pixels below the app title, and
+    #    left-aligned to the logo's right margin.
+    #
+    # The "box" containing these three elements is horizontally centered in the
+    # resulting image.
+    #
+    # Text metrics work as follows, using "Alimony" as the example word:
+    #
+    # * (x, y) is the position of the bottom left tip of 'A'
+    # * `ascent` is the letter height from that point (i.e. the height of 'A')
+    # * `descent` is a negative value; the letter height *below* that point
+    #   (i.e. the height of the 'tail' of 'y')
+    # * `height` is greater than `(ascent - descent)`, making it useless for our
+    #   purposes here.
+    #
+    # For image compositing, (x, y) is the position of the top-left corner.
+    class EmailBanner
+      def initialize(image:, title:, environment:)
+        @title = title
+        @environment = environment
+        @image = image
+      end
+
+      def to_png
+        canvas = Magick::ImageList.new
+        canvas.new_image(WIDTH, HEIGHT) do |f|
+          f.format = 'PNG'
+          f.background_color = '#495666'
+        end
+
+        annotate_title(canvas)
+        annotate_environment(canvas)
+
+        canvas.composite!(logo, logo_x, logo_y, Magick::SrcOverCompositeOp)
+
+        canvas.to_blob
+      end
+
+      private
+
+      WIDTH = 600
+      HEIGHT = 150
+      MID_Y = HEIGHT / 2
+      private_constant :WIDTH, :HEIGHT, :MID_Y
+
+      def title_format
+        @title_format ||= Magick::Draw.new do |title|
+          title.font_family = 'Helvetica'
+          title.pointsize = 24
+          title.gravity = Magick::ForgetGravity
+          title.fill = 'white'
+        end
+      end
+
+      def environment_format
+        @environment_format ||= Magick::Draw.new do |title|
+          title.font_family = 'Helvetica'
+          title.pointsize = 20
+          title.gravity = Magick::ForgetGravity
+          title.fill = '#dd7727'
+        end
+      end
+
+      def annotate_title(canvas)
+        title_format.annotate(canvas, 0, 0, title_x, title_y, @title)
+      end
+
+      def annotate_environment(canvas)
+        environment_format.annotate(canvas, 0, 0, env_x, env_y, @environment)
+      end
+
+      def logo
+        asset = Rails.application.assets.find_asset(@image)
+        @logo ||= Magick::Image.read(asset.pathname.to_s).first
+                  .resize_to_fill(150, 80)
+      end
+
+      def gap
+        @gap ||= environment_format.get_type_metrics('AAF').width
+      end
+
+      def logo_w
+        logo.bounding_box.width
+      end
+
+      def logo_x
+        margin_x
+      end
+
+      # y position to vertically center logo
+      def logo_y
+        ((HEIGHT - logo.bounding_box.height) / 2).round
+      end
+
+      def title_metrics
+        title_format.get_type_metrics(@title)
+      end
+
+      def env_metrics
+        environment_format.get_type_metrics(@environment)
+      end
+
+      # Halve the total margin to horizontally center the whole content area.
+      def margin_x
+        # | whitespace | logo | whitespace | text | whitespace |
+        # |<---------->|
+        ((WIDTH - total_w) / 2).round
+      end
+
+      def title_x
+        # | whitespace | logo | whitespace | text | whitespace |
+        #                                    ^ this position
+        margin_x + logo_w + gap
+      end
+
+      # y position to vertically center title
+      def title_y
+        MID_Y + (title_metrics.ascent / 2).round
+      end
+
+      def env_x
+        title_x
+      end
+
+      # `ascent` is a positive value, and `descent` is a negative value. They
+      # describe the full height of the letters. See RMagick documentation.
+      def env_y
+        MID_Y + title_metrics.ascent - title_metrics.descent + 10
+      end
+
+      # Center using the largest width for aesthetics.
+      def text_w
+        [title_metrics.width, env_metrics.width].max
+      end
+
+      def total_w
+        # | whitespace | logo | whitespace | text | whitespace |
+        #              |<------------------------>|
+        logo_w + gap + text_w
+      end
+    end
+  end
+end

data/lib/lipstick/images/processor.rb

@@ -0,0 +1,27 @@
+require 'sprockets/processor'
+
+module Lipstick
+  module Images
+    class Processor < Sprockets::Processor
+      class DSL
+        def initialize(context)
+          @context = context
+        end
+
+        def run(data)
+          binding.eval(data)
+        end
+
+        def email_banner(image: 'logo.png', title:, environment:)
+          @context.depend_on_asset(image)
+          EmailBanner.new(image: image, title: title, environment: environment)
+            .to_png
+        end
+      end
+
+      def evaluate(context, _locals)
+        DSL.new(context).run(data)
+      end
+    end
+  end
+end

data/lib/lipstick/version.rb

@@ -0,0 +1,3 @@
+module Lipstick
+  VERSION = '1.1.0'
+end

metadata

@@ -0,0 +1,275 @@
+--- !ruby/object:Gem::Specification
+name: aaf-lipstick
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Shaun Mangelsdorf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !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: 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'
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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: faker
+  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: rails
+  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: tilt
+  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
+    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: capybara
+  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: simplecov
+  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: guard
+  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: guard-rspec
+  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: guard-rubocop
+  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: guard-bundler
+  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'
+description: 
+email:
+- s.mangelsdorf@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- app/assets/images/favicon.png
+- app/assets/images/logo.png
+- app/assets/javascripts/aaf-layout.js
+- app/assets/stylesheets/aaf-layout.css.scss
+- app/views/layouts/email_branding.html.erb
+- lib/aaf-lipstick.rb
+- lib/lipstick.rb
+- lib/lipstick/action_view_tilt_template.rb
+- lib/lipstick/auto_validation.rb
+- lib/lipstick/email_message.rb
+- lib/lipstick/engine.rb
+- lib/lipstick/helpers.rb
+- lib/lipstick/helpers/form_helper.rb
+- lib/lipstick/helpers/layout_helper.rb
+- lib/lipstick/helpers/nav_helper.rb
+- lib/lipstick/helpers/semantic_form_builder.rb
+- lib/lipstick/images.rb
+- lib/lipstick/images/email_banner.rb
+- lib/lipstick/images/processor.rb
+- lib/lipstick/version.rb
+homepage: https://github.com/ausaccessfed/aaf-lipstick
+licenses:
+- Apache-2.0
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A gem for applying AAF branding to our services
+test_files: []