squib 0.9.0 → 0.10.0

data/lib/squib/graphics/text.rb

@@ -1,5 +1,5 @@
 require 'pango'
-require 'squib/args/typographer'
+require_relative '../args/typographer'
 
 module Squib
   class Card
@@ -22,12 +22,13 @@ module Squib
 
     # :nodoc:
     # @api private
-    def compute_valign(layout, valign)
+    def compute_valign(layout, valign, embed_h)
       return 0 unless layout.height > 0
       ink_extents = layout.extents[1]
+      ink_extents.height = embed_h * Pango::SCALE if ink_extents.height == 0 # JUST embed, bug #134
       case valign.to_s.downcase
       when 'middle'
-        Pango.pixels( (layout.height - ink_extents.height) / 2)
+        Pango.pixels((layout.height - ink_extents.height) / 2)
       when 'bottom'
         Pango.pixels(layout.height - ink_extents.height)
       else
@@ -50,6 +51,12 @@ module Squib
       layout.height = height * Pango::SCALE unless height.nil? || height == :auto
     end
 
+    def max_embed_height(embed_draws)
+      embed_draws.inject(0) do |max, ed|
+        ed[:h] > max ? ed[:h] : max
+      end
+    end
+
     # :nodoc:
     # @api private
     def next_embed(keys, str)
@@ -66,15 +73,6 @@ module Squib
       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)
@@ -87,8 +85,8 @@ module Squib
         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>")
+        kindex   = clean_str[0..kindex].bytesize # byte index (bug #57)
+        str = str.sub(key, "\u0091<span letter_spacing=\"#{spacing.to_i}\">\u0091</span>\u0091")
         layout.markup = str
         clean_str     = layout.text
         searches << { index: kindex, rule: rule }
@@ -97,7 +95,9 @@ module Squib
         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
+        h    = rule[:box].height[@index]
+        draw_calls << { x: x, y: y, h: h, # defer drawing until we've valigned
+                       draw: search[:rule][:draw] }
       end
       return draw_calls
     end
@@ -131,7 +131,7 @@ module Squib
         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
+        layout.text = para.str
         if para.markup
           para.str = @deck.typographer.process(layout.text)
           layout.markup = para.str
@@ -148,8 +148,8 @@ module Squib
 
         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
+        vertical_start = compute_valign(layout, para.valign, max_embed_height(embed_draws))
+        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)
@@ -158,10 +158,10 @@ module Squib
         begin
           embed_draws.each { |ed| ed[:draw].call(self, ed[:x], ed[:y] + vertical_start) }
         rescue Exception => e
-          puts "====EXCEPTION!===="
+          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 "=================="
+          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)

data/lib/squib/layout_parser.rb

@@ -2,19 +2,19 @@ require 'yaml'
 
 module Squib
   # Internal class for handling layouts
-  #@api private
+  # @api private
   class LayoutParser
 
     # Load the layout file(s), if exists
     # @api private
-    def self.load_layout(files)
-      layout = {}
+    def self.load_layout(files, initial = {})
+      layout = initial
       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 = 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
@@ -33,7 +33,7 @@ module Squib
     # Process the extends recursively
     # :nodoc:
     # @api private
-    def self.recurse_extends(yml, key, visited )
+    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)
@@ -43,15 +43,15 @@ module Squib
       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
+            parent_val + child_val.sub('+=', '').strip.to_f
           elsif child_val.to_s.strip.start_with?('-=')
-            parent_val - child_val.sub('-=','').strip.to_f
+            parent_val - child_val.sub('-=', '').strip.to_f
           else
-            child_val #child overrides parent when merging, no +=
+            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
+          younger_sibling # when two siblings have the same entry, the "younger" (lower one) overrides
         end
       end
       return h

data/lib/squib/layouts/economy.yml

@@ -1,85 +1,85 @@
-#This layout inspired by popular fantasy games
-title:
-  x: 90
-  y: 90
-  width: 635
-  height: 50
-  align: center
-
-art:
-  x: 75
-  y: 150
-  width: 675
-  height: 520
-
-description:
-  x: 100
-  y: 675
-  width: 625
-  height: 275
-  valign: middle
-  align: center
-  font_size: 18
-desc: # alias
-  extends: description
-
-type:
-  x: 90
-  y: 955
-  width: 645
-  height: 50
-  align: center
-
-lower_right:
-  x: 675
-  y: 975
-  width: 75
-  height: 75
-  font_size: 18
-  valign: bottom
-  align: right
-lr: #alias
-  extends: lower_right
-
-lower_left:
-  x: 75
-  y: 975
-  width: 75
-  height: 75
-  font_size: 18
-  valign: bottom
-  align: left
-ll: # alias
-  extends: lower_left
-
-copyright:
-  x: 75
-  y: 1025
-  width: 675
-  height: 25
-  font_size: 16
-  align: center
-  valign: bottom
-#aliases for copyright
-copy:
-  extends: copyright
-credit:
-  extends: copyright
-credits:
-  extends: copyright
-
-# The "cut line", without rounded corners
-cut:
-  x: 37.5
-  y: 37.5
-  width: 750
-  height: 1050
-
-# The "safe zone" as defined by TheGameCrafter poker cards
-safe:
-  x: 75
-  y: 75
-  width: 675
-  height: 975
-  radius: 16
-  dash: 3 3
+#This layout inspired by popular fantasy games
+title:
+  x: 90
+  y: 90
+  width: 635
+  height: 50
+  align: center
+
+art:
+  x: 75
+  y: 150
+  width: 675
+  height: 520
+
+description:
+  x: 100
+  y: 675
+  width: 625
+  height: 275
+  valign: middle
+  align: center
+  font_size: 18
+desc: # alias
+  extends: description
+
+type:
+  x: 90
+  y: 955
+  width: 645
+  height: 50
+  align: center
+
+lower_right:
+  x: 675
+  y: 975
+  width: 75
+  height: 75
+  font_size: 18
+  valign: bottom
+  align: right
+lr: #alias
+  extends: lower_right
+
+lower_left:
+  x: 75
+  y: 975
+  width: 75
+  height: 75
+  font_size: 18
+  valign: bottom
+  align: left
+ll: # alias
+  extends: lower_left
+
+copyright:
+  x: 75
+  y: 1025
+  width: 675
+  height: 25
+  font_size: 16
+  align: center
+  valign: bottom
+#aliases for copyright
+copy:
+  extends: copyright
+credit:
+  extends: copyright
+credits:
+  extends: copyright
+
+# The "cut line", without rounded corners
+cut:
+  x: 37.5
+  y: 37.5
+  width: 750
+  height: 1050
+
+# The "safe zone" as defined by TheGameCrafter poker cards
+safe:
+  x: 75
+  y: 75
+  width: 675
+  height: 975
+  radius: 16
+  dash: 3 3

data/lib/squib/layouts/fantasy.yml

@@ -1,101 +1,101 @@
-#This layout inspired by popular fantasy games
-title:
-  x: 90
-  y: 90
-  width: 500
-  height: 50
-
-upper_right:
-  x: 595
-  y: 90
-  width: 135
-  height: 50
-  align: right
-ur: # alias
-  extends: upper_right
-
-art:
-  x: 75
-  y: 150
-  width: 675
-  height: 520
-
-type:
-  x: 90
-  y: 675
-  width: 500
-  height: 50
-
-type_right:
-  x: 595
-  y: 675
-  width: 135
-  height: 50
-  align: right
-tr: #alias
-  extends: type_right
-
-description:
-  x: 100
-  y: 730
-  width: 625
-  height: 275
-  valign: middle
-  align: center
-  font_size: 18
-desc: # alias
-  extends: description
-
-lower_right:
-  x: 675
-  y: 975
-  width: 75
-  height: 75
-  font_size: 18
-  valign: bottom
-  align: right
-lr: #alias
-  extends: lower_right
-
-lower_left:
-  x: 75
-  y: 975
-  width: 75
-  height: 75
-  font_size: 18
-  valign: bottom
-  align: left
-ll: # alias
-  extends: lower_left
-
-copyright:
-  x: 75
-  y: 1025
-  width: 675
-  height: 25
-  font_size: 16
-  align: center
-  valign: bottom
-#aliases for copyright
-copy:
-  extends: copyright
-credit:
-  extends: copyright
-credits:
-  extends: copyright
-
-# The "cut line", without rounded corners
-cut:
-  x: 37.5
-  y: 37.5
-  width: 750
-  height: 1050
-
-# The "safe zone" as defined by TheGameCrafter poker cards
-safe:
-  x: 75
-  y: 75
-  width: 675
-  height: 975
-  radius: 16
-  dash: 3 3
+#This layout inspired by popular fantasy games
+title:
+  x: 90
+  y: 90
+  width: 500
+  height: 50
+
+upper_right:
+  x: 595
+  y: 90
+  width: 135
+  height: 50
+  align: right
+ur: # alias
+  extends: upper_right
+
+art:
+  x: 75
+  y: 150
+  width: 675
+  height: 520
+
+type:
+  x: 90
+  y: 675
+  width: 500
+  height: 50
+
+type_right:
+  x: 595
+  y: 675
+  width: 135
+  height: 50
+  align: right
+tr: #alias
+  extends: type_right
+
+description:
+  x: 100
+  y: 730
+  width: 625
+  height: 275
+  valign: middle
+  align: center
+  font_size: 18
+desc: # alias
+  extends: description
+
+lower_right:
+  x: 675
+  y: 975
+  width: 75
+  height: 75
+  font_size: 18
+  valign: bottom
+  align: right
+lr: #alias
+  extends: lower_right
+
+lower_left:
+  x: 75
+  y: 975
+  width: 75
+  height: 75
+  font_size: 18
+  valign: bottom
+  align: left
+ll: # alias
+  extends: lower_left
+
+copyright:
+  x: 75
+  y: 1025
+  width: 675
+  height: 25
+  font_size: 16
+  align: center
+  valign: bottom
+#aliases for copyright
+copy:
+  extends: copyright
+credit:
+  extends: copyright
+credits:
+  extends: copyright
+
+# The "cut line", without rounded corners
+cut:
+  x: 37.5
+  y: 37.5
+  width: 750
+  height: 1050
+
+# The "safe zone" as defined by TheGameCrafter poker cards
+safe:
+  x: 75
+  y: 75
+  width: 675
+  height: 975
+  radius: 16
+  dash: 3 3