inkcite 1.0.0

data/lib/inkcite/renderer/button.rb

@@ -0,0 +1,168 @@
+module Inkcite
+  module Renderer
+    class Button < Base
+
+      # Convenience class which makes it easy to retrieve the attributes
+      # for a button.
+      class Config
+
+        def initialize ctx, opt={}
+          @opt = opt
+          @ctx = ctx
+        end
+
+        def bgcolor
+          hex(@opt[:bgcolor] || @ctx[BUTTON_BACKGROUND_COLOR] || @ctx[Base::LINK_COLOR])
+        end
+
+        def border
+          @opt[:border] || @ctx[BUTTON_BORDER]
+        end
+
+        def border_bottom
+          "#{Renderer.px(bevel)} solid #{bevel_color}" if bevel > 0
+        end
+
+        def bevel
+          (@opt[:bevel] || @ctx[BUTTON_BEVEL]).to_i
+        end
+
+        def bevel_color
+          bc = @opt[BEVEL_COLOR] || @ctx[BUTTON_BEVEL_COLOR]
+          !bc.blank?? hex(bc) : text_shadow
+        end
+
+        def border_radius
+          (@opt[Base::BORDER_RADIUS] || @ctx[BUTTON_BORDER_RADIUS]).to_i
+        end
+
+        def color
+          hex(@opt[:color] || @ctx[BUTTON_COLOR] || Util::contrasting_text_color(bgcolor))
+        end
+
+        def float
+          @opt[:align] || @opt[:float] || @ctx[BUTTON_FLOAT]
+        end
+
+        def font
+          @opt[:font] || @ctx[BUTTON_FONT]
+        end
+
+        def font_size
+          (@opt[Base::FONT_SIZE] || @ctx[BUTTON_FONT_SIZE]).to_i
+        end
+
+        def font_weight
+          @opt[Base::FONT_WEIGHT] || @ctx[BUTTON_FONT_WEIGHT]
+        end
+
+        def height
+          (@opt[:height] || @ctx[BUTTON_HEIGHT]).to_i
+        end
+
+        def line_height
+          @opt[Base::LINE_HEIGHT] || @ctx[BUTTON_LINE_HEIGHT]
+        end
+
+        def margin_top
+          (@opt[Base::MARGIN_TOP] || @ctx[BUTTON_MARGIN_TOP]).to_i
+        end
+
+        def padding
+          (@opt[:padding] || @ctx[BUTTON_PADDING]).to_i
+        end
+
+        def text_shadow
+          ts = @opt[Base::TEXT_SHADOW] || @ctx[BUTTON_TEXT_SHADOW]
+          unless ts
+            ts = Util::brightness_value(bgcolor) > 382.5 ? Util::lighten(bgcolor, 0.25) : Util::darken(bgcolor)
+          end
+          hex(ts)
+        end
+
+        def width
+          (@opt[:width] || @ctx[BUTTON_WIDTH]).to_i
+        end
+
+        private
+
+        BEVEL_COLOR = :'bevel-color'
+
+        BUTTON_BACKGROUND_COLOR = :'button-background-color'
+        BUTTON_BEVEL = :'button-bevel'
+        BUTTON_BEVEL_COLOR = :'button-bevel-color'
+        BUTTON_BORDER = :'button-border'
+        BUTTON_BORDER_RADIUS = :'button-border-radius'
+        BUTTON_COLOR = :'button-color'
+        BUTTON_FLOAT = :'button-float'
+        BUTTON_FONT = :'button-font'
+        BUTTON_FONT_SIZE = :'button-font-size'
+        BUTTON_FONT_WEIGHT = :'button-font-weight'
+        BUTTON_HEIGHT = :'button-height'
+        BUTTON_LINE_HEIGHT = :'button-line-height'
+        BUTTON_MARGIN_TOP = :'button-margin-top'
+        BUTTON_PADDING = :'button-padding'
+        BUTTON_TEXT_SHADOW = :'button-text-shadow'
+        BUTTON_WIDTH = :'button-width'
+
+        # Convenient
+        def hex color
+          Renderer.hex(color)
+        end
+
+      end
+
+      def render tag, opt, ctx
+
+        html = ''
+
+        if tag == 'button'
+
+          id = opt[:id]
+          href = opt[:href]
+
+          cfg = Config.new(ctx, opt)
+
+          # Wrap the table in a link to make the whole thing clickable.  This works
+          # in most email clients but doesn't work in Outlook (for a change).
+          html << "{a id=\"#{id}\" href=\"#{href}\" color=\"none\"}"
+
+          # Responsive button is just a highly styled table/td combination with optional
+          # curved corners and a lower bevel (border).
+          html << "{table bgcolor=#{cfg.bgcolor}"
+          html << " padding=#{cfg.padding}" if cfg.padding > 0
+          html << " border=#{cfg.border}" if cfg.border
+          html << " border-radius=#{cfg.border_radius}" if cfg.border_radius > 0
+
+          # Need to separate borders that are collapsed by default - otherwise, the bevel
+          # renders incorrectly.
+          html << " border-bottom=\"#{cfg.border_bottom}\" border-collapse=separate" if cfg.bevel > 0
+
+          html << " margin-top=#{cfg.margin_top}" if cfg.margin_top > 0
+          html << " width=#{cfg.width}" if cfg.width > 0
+          html << " float=#{cfg.float}" if cfg.float
+          html << " mobile=\"fill\"}\n"
+          html << "{td align=center"
+          html << " height=#{cfg.height} valign=middle" if cfg.height > 0
+          html << " font=\"#{cfg.font}\""
+          html << " line-height=#{cfg.line_height}" unless cfg.line_height.blank?
+          html << " font-size=\"#{cfg.font_size}\"" if cfg.font_size > 0
+          html << " font-weight=\"#{cfg.font_weight}\"" unless cfg.font_weight.blank?
+          html << " shadow=\"#{cfg.text_shadow}\" shadow-offset=-1}"
+
+          # Second, internal link for Outlook users that makes the inside of the button
+          # clickable.
+          html << "{a id=\"#{id}\" href=\"#{href}\" color=\"#{cfg.color}\"}"
+
+        else
+
+          html << "{/a}{/td}\n{/table}{/a}"
+
+        end
+
+        html
+      end
+
+    end
+  end
+end

data/lib/inkcite/renderer/div.rb

@@ -0,0 +1,29 @@
+module Inkcite
+  module Renderer
+    class Div < Responsive
+
+      def render tag, opt, ctx
+
+        return '</div>' if tag == '/div'
+
+        div = Element.new('div')
+
+        height = opt[:height].to_i
+        div.style[:height] = px(height) if height > 0
+
+        # Text alignment - left, right, center.
+        align = opt[:align]
+        div.style[TEXT_ALIGN] = align unless none?(align)
+
+        mix_font div, opt, ctx
+
+        mix_background div, opt
+
+        mix_responsive div, opt, ctx
+
+        div.to_s
+      end
+
+    end
+  end
+end

data/lib/inkcite/renderer/element.rb

@@ -0,0 +1,82 @@
+module Inkcite
+  module Renderer
+    class Element
+
+      attr_reader :tag
+
+      def initialize tag, att={}
+
+        # The tag, attribute and in-line CSS styles.
+        @tag = tag
+        @att = att
+
+        # True if the tag self-closes as in "<img .../>"
+        @self_close = att.delete(:self_close) == true
+
+      end
+
+      def [] key
+        @att[key]
+      end
+
+      def []= key, val
+        @att[key] = val
+      end
+
+      def add_rule rule
+
+        # Mark the rule as active in case it was one of the pre-defined rules
+        # that can be activated on first use.
+        rule.activate!
+
+        # Add the rule to those that will affect this element
+        responsive_styles << rule
+
+        # Add the rule's klass to those that will be rendered in the
+        # element's HTML.
+        classes << rule.klass
+
+        rule
+      end
+
+      def classes
+        @classes ||= Set.new
+      end
+
+      def responsive_styles
+        @responsive_rules ||= []
+      end
+
+      def self_close?
+        @self_close
+      end
+
+      def style
+        @styles ||= {}
+      end
+
+      def to_s
+
+        # Convert the style hash into CSS style attribute.
+        @att[:style] = Renderer.quote(Renderer.render_styles(@styles)) unless @styles.blank?
+
+        # Convert the list of CSS classes assigned to this element into an attribute
+        self[:class] = Renderer.quote(@classes.to_a.sort.join(' ')) unless @classes.blank?
+
+        html = '<'
+        html << @tag
+
+        unless @att.empty?
+          html << ' '
+          html << Renderer.join_hash(@att)
+        end
+
+        html << ' /' if self_close?
+        html << '>'
+
+        html
+      end
+
+    end
+  end
+end

data/lib/inkcite/renderer/footnote.rb

@@ -0,0 +1,132 @@
+module Inkcite
+  module Renderer
+    class Footnote < Base
+
+      class Instance
+
+        # Optional, unique ID assigned by the designer for this footnote
+        # so that a numeric footnote can be referenced repeatedly,
+        # non-linearly throughout the email.
+        attr_reader :id
+
+        # Symbol associated with the footnote.  Typically going to be
+        # numeric but could be a user-specified symbol - e.g. †.
+        attr_reader :symbol
+
+        # The message associated with the footnote that will be displayed
+        # when the {footnotes} tag is rendered.
+        attr_reader :text
+
+        def initialize id, symbol, text
+          @id = id
+          @symbol = symbol.to_s
+          @text = text
+        end
+
+        def number
+          @symbol.to_i
+        end
+
+        # Returns true if this footnote is numeric rather than
+        # a symbol - e.g. †
+        def numeric?
+          @symbol == @symbol.to_i.to_s
+        end
+
+        def to_s
+          "#{symbol} #{text}"
+        end
+
+      end
+
+      def render tag, opt, ctx
+
+        # Grab the optional id for this footnote.  This would only be
+        # populated if the designer intends on referencing this footnote
+        # in multiple spots.
+        id = opt[:id] || opt[:name]
+
+        # If an id was specified, check to see if an existing footnote has
+        # already been associated with this.
+        instance = ctx.footnotes.detect { |f| f.id == id } unless id.blank?
+        unless instance
+
+          # Grab the optional symbol that was specified by the designer.  If
+          # this isn't specified count the number of existing numeric footnotes
+          # and increment it for this new footnote's symbol.
+          symbol = opt[:symbol]
+          if symbol.blank?
+
+            # Grab the last numeric footnote that was specified and, assuming
+            # there is one, increment the count.  Otherwise, start the count
+            # off at one.
+            last_instance = ctx.footnotes.select(&:numeric?).last
+            symbol = last_instance.nil?? 1 : last_instance.symbol.to_i + 1
+
+          end
+
+          # Grab the text associated with this footnote.
+          text = opt[:text]
+          ctx.error("Footnote requires text attribute", { :id => id, :symbol => symbol }) if text.blank?
+
+          # Create a new Footnote instance
+          instance = Instance.new(id, symbol, text)
+
+          # Push the new footnote onto the stack.
+          ctx.footnotes << instance
+
+        end
+
+        # Allow footnotes to be defined without showing a symbol
+        hidden = opt[:hidden].to_i == 1
+        "#{instance.symbol}" unless hidden
+      end
+
+    end
+
+    class Footnotes < Base
+      def render tag, opt, ctx
+
+        # Nothing to do if footnotes are blank.
+        return if ctx.footnotes.blank?
+
+        # Check to see if a template has been provided.  Otherwise use a default one based
+        # on the format of the email.
+        tmpl = opt[:tmpl] || opt[:template]
+        if tmpl.blank?
+          tmpl = ctx.text?? "($symbol$) $text$\n\n" : "<sup>$symbol$</sup> $text$<br><br>"
+
+        elsif ctx.text?
+
+          # If there are new-lines encoded in the custom template, make sure
+          # they get converted to real new lines.
+          tmpl.gsub!('\\n', "\n")
+
+        end
+
+
+        # Symbolic footnotes (e.g. daggers) always go ahead of
+        # the numeric footnotes - cause that's the way I like it
+        # uh huh, uh huh.
+        ctx.footnotes.sort! do |f1, f2|
+
+          next 1 if f1.numeric? && !f2.numeric?
+          next -1 if !f1.numeric? && f2.numeric?
+          f1.number <=> f2.number
+
+        end
+
+        html = ''
+
+        # Iterate through each of the footnotes and render them based on the
+        # template that was provided.
+        ctx.footnotes.collect do |f|
+          html << tmpl.gsub('$symbol$', f.symbol).gsub('$text$', f.text)
+        end
+
+        html
+      end
+    end
+
+  end
+end

data/lib/inkcite/renderer/google_analytics.rb

@@ -0,0 +1,35 @@
+module Inkcite
+  module Renderer
+    class GoogleAnalytics < Base
+
+      def render tag, opt, ctx
+
+        # Google analytics only possible in a browser version of the email.
+        return nil unless ctx.browser?
+
+        tracking_code = ctx[:code] || ctx[:id] || ctx[GOOGLE_ANALYTICS]
+        return nil if tracking_code.blank?
+
+        # Push the google analytics code onto the context's inline scripts.
+        script = <<-EOS
+          (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+          (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+          m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+          })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+          ga('create', '#{tracking_code}');
+          ga('set', 'campaignName', '#{ctx.project}|#{ctx.issue.name}');
+          ga('send', 'pageview');
+        EOS
+
+        ctx.scripts << script
+
+        nil
+      end
+
+      private
+
+      GOOGLE_ANALYTICS = :'google-analytics'
+
+    end
+  end
+end