squib 0.6.0 → 0.7.0

data/lib/squib/graphics/text.rb

@@ -1,216 +1,176 @@
-require 'pango'
-require 'squib/args/typographer'
-
-module Squib
-  class Card
-
-    # :nodoc:
-    # @api private
-    def draw_text_hint(cc, x, y, layout, color)
-      color = @deck.text_hint if color.to_s.eql? 'off' and not @deck.text_hint.to_s.eql? 'off'
-      return if color.to_s.eql? 'off' or color.nil?
-      # when w,h < 0, it was never set. extents[1] are ink extents
-      w = layout.width / Pango::SCALE
-      w = layout.extents[1].width / Pango::SCALE if w < 0
-      h = layout.height / Pango::SCALE
-      h = layout.extents[1].height / Pango::SCALE if h < 0
-      cc.rounded_rectangle(0, 0, w, h, 0, 0)
-      cc.set_source_color(color)
-      cc.set_line_width(2.0)
-      cc.stroke
-    end
-
-    # :nodoc:
-    # @api private
-    def set_ellipsize!(layout, ellipsize)
-      case ellipsize.to_s.downcase
-      when 'none', 'false'
-        layout.ellipsize = Pango::Layout::ELLIPSIZE_NONE
-      when 'start'
-        layout.ellipsize = Pango::Layout::ELLIPSIZE_START
-      when 'middle'
-        layout.ellipsize = Pango::Layout::ELLIPSIZE_MIDDLE
-      when 'end', 'true'
-        layout.ellipsize = Pango::Layout::ELLIPSIZE_END
-      end
-    end
-
-    # :nodoc:
-    # @api private
-    def set_wrap!(layout, wrap)
-      case wrap.to_s.downcase
-      when 'word'
-        layout.wrap = Pango::Layout::WRAP_WORD
-      when 'char'
-        layout.wrap = Pango::Layout::WRAP_CHAR
-      when 'word_char', 'true'
-        layout.wrap = Pango::Layout::WRAP_WORD_CHAR
-      end
-    end
-
-    # :nodoc:
-    # @api private
-    def set_align!(layout, align)
-      case align.to_s.downcase
-      when 'left'
-        layout.alignment = Pango::ALIGN_LEFT
-      when 'right'
-        layout.alignment = Pango::ALIGN_RIGHT
-      when 'center'
-        layout.alignment = Pango::ALIGN_CENTER
-      end
-    end
-
-    # :nodoc:
-    # @api private
-    def compute_valign(layout, valign)
-      return 0 unless layout.height > 0
-      ink_extents = layout.extents[1]
-      case valign.to_s.downcase
-      when 'middle'
-        Pango.pixels( (layout.height - ink_extents.height) / 2)
-      when 'bottom'
-        Pango.pixels(layout.height - ink_extents.height)
-      else
-        0
-      end
-    end
-
-    def set_font_rendering_opts!(layout)
-      font_options                = Cairo::FontOptions.new
-      font_options.antialias      = Conf::ANTIALIAS_OPTS[(@deck.antialias || 'gray').downcase]
-      font_options.hint_metrics   = 'on' # TODO make this configurable
-      font_options.hint_style     = 'full' # TODO make this configurable
-      layout.context.font_options = font_options
-    end
-
-    # :nodoc:
-    # @api private
-    def set_wh!(layout, width, height)
-      layout.width  = width * Pango::SCALE unless width.nil? || width == :native
-      layout.height = height * Pango::SCALE unless height.nil? || height == :native
-    end
-
-    # :nodoc:
-    # @api private
-    def next_embed(keys, str)
-      ret     = nil
-      ret_key = nil
-      keys.each do |key|
-        i = str.index(key)
-        ret ||= i
-        unless i.nil? || i > ret
-          ret = i
-          ret_key = key
-        end
-      end
-      ret_key
-    end
-
-    # When we do embedded icons, we create a 3-character string that has a font
-    # size of zero and a letter-spacing that fits the icon we need. That gives
-    # us the wrapping behavior we need but no clutter beneath.  On most
-    # platforms, this works fine. On Linux, this creates
-    # a Cairo transformation matrix that
-    ZERO_WIDTH_CHAR_SIZE = 0 # this works on most platforms
-    # some platforms make this Pango pixels (1/1024), others a 1 pt font
-    ZERO_WIDTH_CHAR_SIZE = 1 if RbConfig::CONFIG['host_os'] === 'linux-gnu'
-
-    # :nodoc:
-    # @api private
-    def process_embeds(embed, str, layout)
-      return [] unless embed.rules.any?
-      layout.markup   = str
-      clean_str       = layout.text
-      draw_calls      = []
-      searches        = []
-      while (key = next_embed(embed.rules.keys, clean_str)) != nil
-        rule          = embed.rules[key]
-        spacing       = rule[:width] * Pango::SCALE
-        index         = clean_str.index(key)
-        index         = clean_str[0..index].bytesize #convert to byte index (bug #57)
-        str = str.sub(key, "<span size=\"#{ZERO_WIDTH_CHAR_SIZE}\">a<span letter_spacing=\"#{spacing.to_i}\">a</span>a</span>")
-        layout.markup = str
-        clean_str     = layout.text
-        searches << { index: index, rule: rule }
-      end
-      searches.each do |search|
-        rect          = layout.index_to_pos(search[:index])
-        x             = Pango.pixels(rect.x) + search[:rule][:dx]
-        y             = Pango.pixels(rect.y) + search[:rule][:dy]
-        draw_calls << {x: x, y: y, draw: search[:rule][:draw]} # defer drawing until we've valigned
-      end
-      return draw_calls
-    end
-
-    def stroke_outline!(cc, layout, stroke_width, stroke_color)
-      if stroke_width > 0
-        cc.set_source_squibcolor(stroke_color)
-        cc.set_line_width(stroke_width)
-        cc.pango_layout_path(layout)
-        cc.stroke
-      end
-    end
-
-    # :nodoc:
-    # @api private
-    def text(embed,str, font, font_size, color,
-             x, y, width, height,
-             markup, justify, wrap, ellipsize,
-             spacing, align, valign, hint, angle,
-             stroke_color, stroke_width)
-      Squib.logger.debug {"Placing '#{str}'' with font '#{font}' @ #{x}, #{y}, color: #{color}, angle: #{angle} etc."}
-      extents = nil
-      str = str.to_s
-      use_cairo do |cc|
-        cc.set_source_squibcolor(color)
-        cc.translate(x,y)
-        cc.rotate(angle)
-        cc.move_to(0, 0)
-
-        font_desc      = Pango::FontDescription.new(font)
-        font_desc.size = font_size * Pango::SCALE unless font_size.nil?
-        layout         = cc.create_pango_layout
-        layout.font_description = font_desc
-        layout.text    = str
-        if markup
-          str = @deck.typographer.process(layout.text)
-          layout.markup = str
-        end
-
-        set_font_rendering_opts!(layout)
-        set_wh!(layout, width, height)
-        set_wrap!(layout, wrap)
-        set_ellipsize!(layout, ellipsize)
-        set_align!(layout, align)
-
-        layout.justify = justify unless justify.nil?
-        layout.spacing = spacing * Pango::SCALE unless spacing.nil?
-        cc.update_pango_layout(layout)
-
-        embed_draws    = process_embeds(embed, str, layout)
-
-        vertical_start = compute_valign(layout, valign)
-        cc.move_to(0, vertical_start)
-
-        cc.update_pango_layout(layout)
-        cc.show_pango_layout(layout)
-        stroke_outline!(cc, layout, stroke_width, stroke_color)
-        begin
-          embed_draws.each { |ed| ed[:draw].call(self, ed[:x], ed[:y] + vertical_start) }
-        rescue Exception => e
-          puts "====EXCEPTION!===="
-          puts e
-          puts "If this was a non-invertible matrix error, this is a known issue with a potential workaround. Please report it at: https://github.com/andymeneely/squib/issues/55"
-          puts "=================="
-          raise e
-        end
-        draw_text_hint(cc, x, y, layout, hint)
-        extents = { width: layout.extents[1].width / Pango::SCALE,
-                    height: layout.extents[1].height / Pango::SCALE }
-      end
-      return extents
-    end
-
-  end
-end
+require 'pango'
+require 'squib/args/typographer'
+
+module Squib
+  class Card
+
+    # :nodoc:
+    # @api private
+    def draw_text_hint(cc, x, y, layout, color)
+      color = @deck.text_hint if color.to_s.eql? 'off' and not @deck.text_hint.to_s.eql? 'off'
+      return if color.to_s.eql? 'off' or color.nil?
+      # when w,h < 0, it was never set. extents[1] are ink extents
+      w = layout.width / Pango::SCALE
+      w = layout.extents[1].width / Pango::SCALE if w < 0
+      h = layout.height / Pango::SCALE
+      h = layout.extents[1].height / Pango::SCALE if h < 0
+      cc.rounded_rectangle(0, 0, w, h, 0, 0)
+      cc.set_source_color(color)
+      cc.set_line_width(2.0)
+      cc.stroke
+    end
+
+    # :nodoc:
+    # @api private
+    def compute_valign(layout, valign)
+      return 0 unless layout.height > 0
+      ink_extents = layout.extents[1]
+      case valign.to_s.downcase
+      when 'middle'
+        Pango.pixels( (layout.height - ink_extents.height) / 2)
+      when 'bottom'
+        Pango.pixels(layout.height - ink_extents.height)
+      else
+        0
+      end
+    end
+
+    def set_font_rendering_opts!(layout)
+      font_options                = Cairo::FontOptions.new
+      font_options.antialias      = Conf::ANTIALIAS_OPTS[(@deck.antialias || 'gray').downcase]
+      font_options.hint_metrics   = 'on' # TODO make this configurable
+      font_options.hint_style     = 'full' # TODO make this configurable
+      layout.context.font_options = font_options
+    end
+
+    # :nodoc:
+    # @api private
+    def set_wh!(layout, width, height)
+      layout.width  = width * Pango::SCALE unless width.nil? || width == :auto
+      layout.height = height * Pango::SCALE unless height.nil? || height == :auto
+    end
+
+    # :nodoc:
+    # @api private
+    def next_embed(keys, str)
+      ret     = nil
+      ret_key = nil
+      keys.each do |key|
+        i = str.index(key)
+        ret ||= i
+        unless i.nil? || i > ret
+          ret = i
+          ret_key = key
+        end
+      end
+      ret_key
+    end
+
+    # When we do embedded icons, we create a 3-character string that has a font
+    # size of zero and a letter-spacing that fits the icon we need. That gives
+    # us the wrapping behavior we need but no clutter beneath.  On most
+    # platforms, this works fine. On Linux, this creates
+    # a Cairo transformation matrix that
+    ZERO_WIDTH_CHAR_SIZE = 0 # this works on most platforms
+    # some platforms make this Pango pixels (1/1024), others a 1 pt font
+    ZERO_WIDTH_CHAR_SIZE = 1 if RbConfig::CONFIG['host_os'] === 'linux-gnu'
+
+    # :nodoc:
+    # @api private
+    def process_embeds(embed, str, layout)
+      return [] unless embed.rules.any?
+      layout.markup = str
+      clean_str     = layout.text
+      draw_calls    = []
+      searches      = []
+      while (key = next_embed(embed.rules.keys, clean_str)) != nil
+        rule    = embed.rules[key]
+        spacing = rule[:box].width[@index] * Pango::SCALE
+        kindex   = clean_str.index(key)
+        kindex   = clean_str[0..kindex].bytesize #convert to byte index (bug #57)
+        str = str.sub(key, "<span size=\"#{ZERO_WIDTH_CHAR_SIZE}\">a<span letter_spacing=\"#{spacing.to_i}\">a</span>a</span>")
+        layout.markup = str
+        clean_str     = layout.text
+        searches << { index: kindex, rule: rule }
+      end
+      searches.each do |search|
+        rect = layout.index_to_pos(search[:index])
+        x    = Pango.pixels(rect.x) + search[:rule][:adjust].dx[@index]
+        y    = Pango.pixels(rect.y) + search[:rule][:adjust].dy[@index]
+        draw_calls << {x: x, y: y, draw: search[:rule][:draw]} # defer drawing until we've valigned
+      end
+      return draw_calls
+    end
+
+    def stroke_outline!(cc, layout, draw)
+      if draw.stroke_width > 0
+        cc.pango_layout_path(layout)
+        cc.fancy_stroke draw
+        cc.set_source_squibcolor(draw.color)
+      end
+    end
+
+    def warn_if_ellipsized(layout)
+       if @deck.conf.warn_ellipsize? && layout.ellipsized?
+         Squib.logger.warn { "Ellipsized (too much text). Card \##{@index}. Text:  \"#{layout.text}\". \n (To disable this warning, set warn_ellipsize: false in config.yml)" }
+       end
+    end
+
+    # :nodoc:
+    # @api private
+    def text(embed, para, box, trans, draw)
+      Squib.logger.debug {"Rendering text with: \n#{para} \nat:\n #{box} \ndraw:\n #{draw} \ntransform: #{trans}"}
+      extents = nil
+      use_cairo do |cc|
+        cc.set_source_squibcolor(draw.color)
+        cc.translate(box.x, box.y)
+        cc.rotate(trans.angle)
+        cc.move_to(0, 0)
+
+        font_desc      = Pango::FontDescription.new(para.font)
+        font_desc.size = para.font_size * Pango::SCALE unless para.font_size.nil?
+        layout         = cc.create_pango_layout
+        layout.font_description = font_desc
+        layout.text    = para.str
+        if para.markup
+          para.str = @deck.typographer.process(layout.text)
+          layout.markup = para.str
+        end
+
+        set_font_rendering_opts!(layout)
+        set_wh!(layout, box.width, box.height)
+        layout.wrap      = para.wrap
+        layout.ellipsize = para.ellipsize
+        layout.alignment = para.align
+
+        layout.justify = para.justify unless para.justify.nil?
+        layout.spacing = para.spacing unless para.spacing.nil?
+
+        embed_draws    = process_embeds(embed, para.str, layout)
+
+        vertical_start = compute_valign(layout, para.valign)
+        cc.move_to(0, vertical_start) #TODO clean this up a bit
+
+        stroke_outline!(cc, layout, draw) if draw.stroke_strategy == :stroke_first
+        cc.move_to(0, vertical_start)
+        cc.show_pango_layout(layout)
+        stroke_outline!(cc, layout, draw) if draw.stroke_strategy == :fill_first
+        begin
+          embed_draws.each { |ed| ed[:draw].call(self, ed[:x], ed[:y] + vertical_start) }
+        rescue Exception => e
+          puts "====EXCEPTION!===="
+          puts e
+          puts "If this was a non-invertible matrix error, this is a known issue with a potential workaround. Please report it at: https://github.com/andymeneely/squib/issues/55"
+          puts "=================="
+          raise e
+        end
+        draw_text_hint(cc, box.x, box.y, layout, para.hint)
+        extents = { width: layout.extents[1].width / Pango::SCALE,
+                    height: layout.extents[1].height / Pango::SCALE }
+        warn_if_ellipsized layout
+      end
+      return extents
+    end
+
+  end
+end

data/lib/squib/layout_parser.rb

@@ -1,89 +1,91 @@
-module Squib
-  # Internal class for handling layouts
-  #@api private
-  class LayoutParser
-
-    # Load the layout file(s), if exists
-    # @api private
-    def self.load_layout(files)
-      layout = {}
-      Squib::logger.info { "  using layout(s): #{files}" }
-      Array(files).each do |file|
-        thefile = file
-        thefile = builtin(file) unless File.exists?(file)
-        if File.exists? thefile
-          yml = layout.merge(YAML.load_file(thefile) || {}) #load_file returns false on empty file
-          yml.each do |key, value|
-            layout[key] = recurse_extends(yml, key, {})
-          end
-        else
-          Squib::logger.error { "Layout file not found: #{file}. Skipping..." }
-        end
-      end
-      return layout
-    end
-
-    # Determine the file path of the built-in layout file
-    def self.builtin(file)
-      "#{File.dirname(__FILE__)}/layouts/#{file}"
-    end
-
-    # Process the extends recursively
-    # :nodoc:
-    # @api private
-    def self.recurse_extends(yml, key, visited )
-      assert_not_visited(key, visited)
-      return yml[key] unless has_extends?(yml, key)
-      return yml[key] unless parents_exist?(yml, key)
-      visited[key] = key
-      parent_keys = [yml[key]['extends']].flatten
-      h = {}
-      parent_keys.each do |parent_key|
-        from_extends = yml[key].merge(recurse_extends(yml, parent_key, visited)) do |key, child_val, parent_val|
-          if child_val.to_s.strip.start_with?('+=')
-            parent_val + child_val.sub('+=','').strip.to_f
-          elsif child_val.to_s.strip.start_with?('-=')
-            parent_val - child_val.sub('-=','').strip.to_f
-          else
-            child_val #child overrides parent when merging, no +=
-          end
-        end
-        h = h.merge(from_extends) do |key, older_sibling, younger_sibling|
-          younger_sibling #when two siblings have the same entry, the "younger" (lower one) overrides
-        end
-      end
-      return h
-    end
-
-    # Does this layout entry have an extends field?
-    # i.e. is it a base-case or will it need recursion?
-    # :nodoc:
-    # @api private
-    def self.has_extends?(yml, key)
-      !!yml[key] && yml[key].key?('extends')
-    end
-
-    # Checks if we have any absentee parents
-    # @api private
-    def self.parents_exist?(yml, key)
-      exists = true
-      Array(yml[key]['extends']).each do |parent|
-        unless yml.key?(parent)
-          exists = false unless
-          Squib.logger.error "Processing layout: '#{key}' attempts to extend a missing '#{yml[key]['extends']}'"
-        end
-      end
-      return exists
-    end
-
-    # Safeguard against malformed circular extends
-    # :nodoc:
-    # @api private
-    def self.assert_not_visited(key, visited)
-      if visited.key? key
-        raise "Invalid layout: circular extends with '#{key}'"
-      end
-    end
-
-  end
-end
+require 'yaml'
+
+module Squib
+  # Internal class for handling layouts
+  #@api private
+  class LayoutParser
+
+    # Load the layout file(s), if exists
+    # @api private
+    def self.load_layout(files)
+      layout = {}
+      Squib::logger.info { "  using layout(s): #{files}" }
+      Array(files).each do |file|
+        thefile = file
+        thefile = builtin(file) unless File.exists?(file)
+        if File.exists? thefile
+          yml = layout.merge(YAML.load_file(thefile) || {}) #load_file returns false on empty file
+          yml.each do |key, value|
+            layout[key] = recurse_extends(yml, key, {})
+          end
+        else
+          Squib::logger.error { "Layout file not found: #{file}. Skipping..." }
+        end
+      end
+      return layout
+    end
+
+    # Determine the file path of the built-in layout file
+    def self.builtin(file)
+      "#{File.dirname(__FILE__)}/layouts/#{file}"
+    end
+
+    # Process the extends recursively
+    # :nodoc:
+    # @api private
+    def self.recurse_extends(yml, key, visited )
+      assert_not_visited(key, visited)
+      return yml[key] unless has_extends?(yml, key)
+      return yml[key] unless parents_exist?(yml, key)
+      visited[key] = key
+      parent_keys = [yml[key]['extends']].flatten
+      h = {}
+      parent_keys.each do |parent_key|
+        from_extends = yml[key].merge(recurse_extends(yml, parent_key, visited)) do |key, child_val, parent_val|
+          if child_val.to_s.strip.start_with?('+=')
+            parent_val + child_val.sub('+=','').strip.to_f
+          elsif child_val.to_s.strip.start_with?('-=')
+            parent_val - child_val.sub('-=','').strip.to_f
+          else
+            child_val #child overrides parent when merging, no +=
+          end
+        end
+        h = h.merge(from_extends) do |key, older_sibling, younger_sibling|
+          younger_sibling #when two siblings have the same entry, the "younger" (lower one) overrides
+        end
+      end
+      return h
+    end
+
+    # Does this layout entry have an extends field?
+    # i.e. is it a base-case or will it need recursion?
+    # :nodoc:
+    # @api private
+    def self.has_extends?(yml, key)
+      !!yml[key] && yml[key].key?('extends')
+    end
+
+    # Checks if we have any absentee parents
+    # @api private
+    def self.parents_exist?(yml, key)
+      exists = true
+      Array(yml[key]['extends']).each do |parent|
+        unless yml.key?(parent)
+          exists = false unless
+          Squib.logger.error "Processing layout: '#{key}' attempts to extend a missing '#{yml[key]['extends']}'"
+        end
+      end
+      return exists
+    end
+
+    # Safeguard against malformed circular extends
+    # :nodoc:
+    # @api private
+    def self.assert_not_visited(key, visited)
+      if visited.key? key
+        raise "Invalid layout: circular extends with '#{key}'"
+      end
+    end
+
+  end
+end