squib 0.8.0 → 0.9.0

data/lib/squib/graphics/showcase.rb

@@ -1,85 +1,85 @@
-require 'squib/graphics/cairo_context_wrapper'
-
-module Squib
-  class Deck
-
-    # So the Cairo people have said over and over again that they won't support the 3x3 matrices that would handle perspective transforms.
-    # Since our perspective transform needs are a bit simpler, we can use a "striping method" that does the job for us.
-    # It's a little bit involved, but it works well enough for limited ranges of our parameters.
-    # These were also helpful:
-    #  http://kapo-cpp.blogspot.com/2008/01/perspective-effect-using-cairo.html
-    #  http://zetcode.com/gui/pygtk/drawingII/
-    # :nodoc:
-    # @api private
-    def render_showcase(range, sheet, showcase)
-      out_width = range.size * ((@width - 2*sheet.trim) * showcase.scale * showcase.offset) + 2*sheet.margin
-      out_height = showcase.reflect_offset + (1.0 + showcase.reflect_percent) * (@height - 2*sheet.trim) + 2*sheet.margin
-      out_cc = Cairo::Context.new(Cairo::ImageSurface.new(out_width, out_height))
-      wrapper = Squib::Graphics::CairoContextWrapper.new(out_cc)
-      wrapper.set_source_squibcolor(sheet.fill_color)
-      wrapper.paint
-
-      cards = range.collect { |i| @cards[i] }
-      cards.each_with_index do |card, i|
-        trimmed = trim_rounded(card.cairo_surface, sheet.trim, sheet.trim_radius)
-        reflected = reflect(trimmed, showcase.reflect_offset, showcase.reflect_percent, showcase.reflect_strength)
-        perspectived = perspective(reflected, showcase.scale, showcase.face_right?)
-        out_cc.set_source(perspectived, sheet.margin + i * perspectived.width * showcase.offset, sheet.margin)
-        out_cc.paint
-      end
-      out_cc.target.write_to_png("#{sheet.dir}/#{sheet.file}")
-    end
-
-    # :nodoc:
-    # @api private
-    def trim_rounded(src, trim, radius)
-      trim_cc = Cairo::Context.new(Cairo::ImageSurface.new(src.width-2.0*trim, src.height-2.0*trim))
-      trim_cc.rounded_rectangle(0, 0, trim_cc.target.width, trim_cc.target.height, radius, radius)
-      trim_cc.set_source(src, -1 * trim, -1 * trim)
-      trim_cc.clip
-      trim_cc.paint
-      return trim_cc.target
-    end
-
-    # :nodoc:
-    # @api private
-    def reflect(src, roffset, rpercent, rstrength)
-      tmp_cc = Cairo::Context.new(Cairo::ImageSurface.new(src.width, src.height * (1.0 + rpercent) + roffset))
-      tmp_cc.set_source(src, 0, 0)
-      tmp_cc.paint
-      # Flip affine magic from: http://cairographics.org/matrix_transform/
-      matrix = Cairo::Matrix.new(1, 0, 0, -1, 0, 2 * src.height + roffset)
-      tmp_cc.transform(matrix) # flips the coordinate system
-      top_y    = src.height    # top of the reflection
-      bottom_y = src.height * (1.0 - rpercent) + roffset # bottom of the reflection
-      gradient = Cairo::LinearPattern.new(0,top_y, 0,bottom_y)
-      gradient.add_color_stop_rgba(0.0, 0,0,0, rstrength) # start a little reflected
-      gradient.add_color_stop_rgba(1.0, 0,0,0, 0.0)       # fade to nothing
-      tmp_cc.set_source(src, 0, 0)
-      tmp_cc.mask(gradient)
-      return tmp_cc.target
-    end
-
-    # :nodoc:
-    # @api private
-    def perspective(src, scale, face_right)
-      dest_cxt = Cairo::Context.new(Cairo::ImageSurface.new(src.width * scale, src.height))
-      in_thickness = 1 # Take strip 1 pixel-width at a time
-      out_thickness = 3 # Scale it to 3 pixels wider to cover any gaps
-      (0..src.width).step(in_thickness) do |i|
-        percentage = i / src.width.to_f
-        i = src.width - i if face_right
-        factor = scale + (percentage * (1.0 - scale)) #linear interpolation
-        dest_cxt.save
-        dest_cxt.translate 0, src.height / 2.0 * (1.0 - factor)
-        dest_cxt.scale factor * scale, factor
-        dest_cxt.set_source src, 0, 0
-        dest_cxt.rounded_rectangle i, 0, out_thickness, src.height, 0,0
-        dest_cxt.fill
-        dest_cxt.restore
-      end
-      return dest_cxt.target
-    end
-
-  end
-end
+require 'squib/graphics/cairo_context_wrapper'
+
+module Squib
+  class Deck
+
+    # So the Cairo people have said over and over again that they won't support the 3x3 matrices that would handle perspective transforms.
+    # Since our perspective transform needs are a bit simpler, we can use a "striping method" that does the job for us.
+    # It's a little bit involved, but it works well enough for limited ranges of our parameters.
+    # These were also helpful:
+    #  http://kapo-cpp.blogspot.com/2008/01/perspective-effect-using-cairo.html
+    #  http://zetcode.com/gui/pygtk/drawingII/
+    # :nodoc:
+    # @api private
+    def render_showcase(range, sheet, showcase)
+      out_width = range.size * ((@width - 2*sheet.trim) * showcase.scale * showcase.offset) + 2*sheet.margin
+      out_height = showcase.reflect_offset + (1.0 + showcase.reflect_percent) * (@height - 2*sheet.trim) + 2*sheet.margin
+      out_cc = Cairo::Context.new(Cairo::ImageSurface.new(out_width, out_height))
+      wrapper = Squib::Graphics::CairoContextWrapper.new(out_cc)
+      wrapper.set_source_squibcolor(sheet.fill_color)
+      wrapper.paint
+
+      cards = range.collect { |i| @cards[i] }
+      cards.each_with_index do |card, i|
+        trimmed = trim_rounded(card.cairo_surface, sheet.trim, sheet.trim_radius)
+        reflected = reflect(trimmed, showcase.reflect_offset, showcase.reflect_percent, showcase.reflect_strength)
+        perspectived = perspective(reflected, showcase.scale, showcase.face_right?)
+        out_cc.set_source(perspectived, sheet.margin + i * perspectived.width * showcase.offset, sheet.margin)
+        out_cc.paint
+      end
+      out_cc.target.write_to_png("#{sheet.dir}/#{sheet.file}")
+    end
+
+    # :nodoc:
+    # @api private
+    def trim_rounded(src, trim, radius)
+      trim_cc = Cairo::Context.new(Cairo::ImageSurface.new(src.width-2.0*trim, src.height-2.0*trim))
+      trim_cc.rounded_rectangle(0, 0, trim_cc.target.width, trim_cc.target.height, radius, radius)
+      trim_cc.set_source(src, -1 * trim, -1 * trim)
+      trim_cc.clip
+      trim_cc.paint
+      return trim_cc.target
+    end
+
+    # :nodoc:
+    # @api private
+    def reflect(src, roffset, rpercent, rstrength)
+      tmp_cc = Cairo::Context.new(Cairo::ImageSurface.new(src.width, src.height * (1.0 + rpercent) + roffset))
+      tmp_cc.set_source(src, 0, 0)
+      tmp_cc.paint
+      # Flip affine magic from: http://cairographics.org/matrix_transform/
+      matrix = Cairo::Matrix.new(1, 0, 0, -1, 0, 2 * src.height + roffset)
+      tmp_cc.transform(matrix) # flips the coordinate system
+      top_y    = src.height    # top of the reflection
+      bottom_y = src.height * (1.0 - rpercent) + roffset # bottom of the reflection
+      gradient = Cairo::LinearPattern.new(0,top_y, 0,bottom_y)
+      gradient.add_color_stop_rgba(0.0, 0,0,0, rstrength) # start a little reflected
+      gradient.add_color_stop_rgba(1.0, 0,0,0, 0.0)       # fade to nothing
+      tmp_cc.set_source(src, 0, 0)
+      tmp_cc.mask(gradient)
+      return tmp_cc.target
+    end
+
+    # :nodoc:
+    # @api private
+    def perspective(src, scale, face_right)
+      dest_cxt = Cairo::Context.new(Cairo::ImageSurface.new(src.width * scale, src.height))
+      in_thickness = 1 # Take strip 1 pixel-width at a time
+      out_thickness = 3 # Scale it to 3 pixels wider to cover any gaps
+      (0..src.width).step(in_thickness) do |i|
+        percentage = i / src.width.to_f
+        i = src.width - i if face_right
+        factor = scale + (percentage * (1.0 - scale)) #linear interpolation
+        dest_cxt.save
+        dest_cxt.translate 0, src.height / 2.0 * (1.0 - factor)
+        dest_cxt.scale factor * scale, factor
+        dest_cxt.set_source src, 0, 0
+        dest_cxt.rounded_rectangle i, 0, out_thickness, src.height, 0,0
+        dest_cxt.fill
+        dest_cxt.restore
+      end
+      return dest_cxt.target
+    end
+
+  end
+end

data/lib/squib/graphics/text.rb

@@ -1,176 +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 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
+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