squib 0.10.0 → 0.11.0

data/lib/squib/api/settings.rb

@@ -1,20 +1,20 @@
 module Squib
   class Deck
 
-    # DSL method. See http://squib.readthedocs.org
+    # DSL method. See http://squib.readthedocs.io
     def hint(text: :off)
       conf.text_hint = text
     end
 
-    # DSL method. See http://squib.readthedocs.org
+    # DSL method. See http://squib.readthedocs.io
     def set(opts = {})
       raise 'DEPRECATED: As of v0.7 img_dir is no longer supported in "set". Use config.yml instead.' if opts.key? :img_dir
       @font = (opts[:font] == :default) ? Squib::DEFAULT_FONT : opts[:font]
     end
 
-    # DSL method. See http://squib.readthedocs.org
+    # DSL method. See http://squib.readthedocs.io
     def use_layout(file: 'layout.yml')
-      @layout = LayoutParser.load_layout(file, @layout)
+      @layout = LayoutParser.new(@dpi).load_layout(file, @layout)
     end
 
   end

data/lib/squib/api/shapes.rb

@@ -7,15 +7,16 @@ require_relative '../args/coords'
 module Squib
   class Deck
 
-    # DSL method. See http://squib.readthedocs.org
+    # DSL method. See http://squib.readthedocs.io
     def rect(opts = {})
       range = Args::CardRange.new(opts[:range], deck_size: size)
       box   = Args::Box.new(self).load!(opts, expand_by: size, layout: layout, dpi: dpi)
       draw  = Args::Draw.new(custom_colors).load!(opts, expand_by: size, layout: layout, dpi: dpi)
-      range.each { |i| @cards[i].rect(box[i], draw[i]) }
+      trans  = Args::Transform.new.load!(opts, expand_by: size, layout: layout, dpi: dpi)
+      range.each { |i| @cards[i].rect(box[i], draw[i], trans[i]) }
     end
 
-    # DSL method. See http://squib.readthedocs.org
+    # DSL method. See http://squib.readthedocs.io
     def circle(opts = {})
       range  = Args::CardRange.new(opts[:range], deck_size: size)
       coords = Args::Coords.new.load!(opts, expand_by: size, layout: layout, dpi: dpi)
@@ -23,15 +24,16 @@ module Squib
       range.each { |i| @cards[i].circle(coords[i], draw[i]) }
     end
 
-    # DSL method. See http://squib.readthedocs.org
+    # DSL method. See http://squib.readthedocs.io
     def ellipse(opts = {})
       range = Args::CardRange.new(opts[:range], deck_size: size)
       draw  = Args::Draw.new(custom_colors).load!(opts, expand_by: size, layout: layout, dpi: dpi)
       box   = Args::Box.new(self, { width: '0.25in', height: '0.25in' }).load!(opts, expand_by: size, layout: layout, dpi: dpi)
-      range.each { |i| @cards[i].ellipse(box[i], draw[i]) }
+      trans  = Args::Transform.new.load!(opts, expand_by: size, layout: layout, dpi: dpi)
+      range.each { |i| @cards[i].ellipse(box[i], draw[i], trans[i]) }
     end
 
-    # DSL method. See http://squib.readthedocs.org
+    # DSL method. See http://squib.readthedocs.io
     def grid(opts = {})
       range = Args::CardRange.new(opts[:range], deck_size: size)
       draw  = Args::Draw.new(custom_colors).load!(opts, expand_by: size, layout: layout, dpi: dpi)
@@ -39,7 +41,7 @@ module Squib
       range.each { |i| @cards[i].grid(box[i], draw[i]) }
     end
 
-    # DSL method. See http://squib.readthedocs.org
+    # DSL method. See http://squib.readthedocs.io
     def triangle(opts = {})
       range  = Args::CardRange.new(opts[:range], deck_size: size)
       draw   = Args::Draw.new(custom_colors).load!(opts, expand_by: size, layout: layout, dpi: dpi)
@@ -47,7 +49,7 @@ module Squib
       range.each { |i| @cards[i].triangle(coords[i], draw[i]) }
     end
 
-    # DSL method. See http://squib.readthedocs.org
+    # DSL method. See http://squib.readthedocs.io
     def line(opts = {})
       range   = Args::CardRange.new(opts[:range], deck_size: size)
       draw    = Args::Draw.new(custom_colors).load!(opts, expand_by: size, layout: layout, dpi: dpi)
@@ -55,7 +57,7 @@ module Squib
       range.each { |i| @cards[i].line(coords[i], draw[i]) }
     end
 
-    # DSL method. See http://squib.readthedocs.org
+    # DSL method. See http://squib.readthedocs.io
     def curve(opts = {})
       range  = Args::CardRange.new(opts[:range], deck_size: size)
       draw   = Args::Draw.new(custom_colors).load!(opts, expand_by: size, layout: layout, dpi: dpi)
@@ -63,7 +65,7 @@ module Squib
       range.each { |i| @cards[i].curve(coords[i], draw[i]) }
     end
 
-    # DSL method. See http://squib.readthedocs.org
+    # DSL method. See http://squib.readthedocs.io
     def star(opts = {})
       range  = Args::CardRange.new(opts[:range], deck_size: size)
       draw   = Args::Draw.new(custom_colors).load!(opts, expand_by: size, layout: layout, dpi: dpi)
@@ -72,7 +74,7 @@ module Squib
       range.each { |i| @cards[i].star(coords[i], trans[i], draw[i]) }
     end
 
-    # DSL method. See http://squib.readthedocs.org
+    # DSL method. See http://squib.readthedocs.io
     def polygon(opts = {})
       range  = Args::CardRange.new(opts[:range], deck_size: size)
       draw   = Args::Draw.new(custom_colors).load!(opts, expand_by: size, layout: layout, dpi: dpi)

data/lib/squib/api/text.rb

@@ -7,7 +7,7 @@ require_relative '../args/paragraph'
 module Squib
   class Deck
 
-    # DSL method. See http://squib.readthedocs.org
+    # DSL method. See http://squib.readthedocs.io
     def text(opts = {})
       range = Args::CardRange.new(opts[:range], deck_size: size)
       para  = Args::Paragraph.new(font).load!(opts, expand_by: size, layout: layout)

data/lib/squib/api/text_embed.rb

@@ -23,21 +23,7 @@ module Squib
       @rules = {} # store an array of options for later usage
     end
 
-    # Context object for embedding an svg icon within text
-    #
-    # @option opts key [String] ('*') the string to replace with the graphic. Can be multiple letters, e.g. ':tool:'
-    # @option opts file [String] ('') file(s) to read in. If it's a single file, then it's use for every card in range. If the parameter is an Array of files, then each file is looked up for each card. If any of them are nil or '', nothing is done. See {file:README.md#Specifying_Files Specifying Files}. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
-    # @option opts id [String] (nil) if set, then only render the SVG element with the given id. Prefix '#' is optional. Note: the x-y coordinates are still relative to the SVG document's page. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
-    # @option opts force_id [Boolean] (false) if set, then this svg will not be rendered at all if the id is empty or nil. If not set, the entire SVG is rendered. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
-    # @option opts layout [String, Symbol] (nil) entry in the layout to use as defaults for this command. See {file:README.md#Custom_Layouts Custom Layouts}. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
-    # @option opts width [Integer] (:native) the width of the image rendered.
-    # @option opts height [Integer] (:native) the height the height of the image rendered.
-    # @option opts dx [Integer] (0) "delta x", or adjust the icon horizontally by x pixels
-    # @option opts dy [Integer] (0) "delta y", or adjust the icon vertically by y pixels
-    # @option opts alpha [Decimal] (1.0) the alpha-transparency percentage used to blend this image. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
-    # @option opts blend [:none, :multiply, :screen, :overlay, :darken, :lighten, :color_dodge, :color_burn, :hard_light, :soft_light, :difference, :exclusion, :hsl_hue, :hsl_saturation, :hsl_color, :hsl_luminosity] (:none) the composite blend operator used when applying this image. See Blend Modes at http://cairographics.org/operators. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
-    # @option opts angle [FixNum] (0) Rotation of the in radians. Note that this rotates around the upper-left corner, making the placement of x-y coordinates slightly tricky. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
-    # @api public
+    # DSL method. See http://squib.readthedocs.io
     def svg(opts = {})
       key   = Args::EmbedKey.new.validate_key(opts[:key])
       range = Args::CardRange.new(opts[:range], deck_size: @deck_size)
@@ -47,7 +33,8 @@ module Squib
       trans = Args::Transform.new.load!(opts, expand_by: @deck_size, layout: @layout, dpi: @dpi)
       ifile = Args::InputFile.new.load!(opts, expand_by: @deck_size, layout: @layout, dpi: @dpi)
       svg_args = Args::SvgSpecial.new.load!(opts, expand_by: @deck_size, layout: @layout, dpi: @dpi)
-      rule = { type: :png, file: ifile, box: box, paint: paint, trans: trans, adjust: adjust }
+      rule = { type: :svg, file: ifile, box: box, paint: paint, trans: trans,
+               adjust: adjust, svg_args: svg_args }
       rule[:draw] = Proc.new do |card, x, y|
         i = card.index
         b = box[i]
@@ -59,19 +46,7 @@ module Squib
       @rules[key] = rule
     end
 
-    # Context object for embedding a png within text
-    #
-    # @option opts key [String] ('*') the string to replace with the graphic. Can be multiple letters, e.g. ':tool:'
-    # @option opts file [String] ('') file(s) to read in. If it's a single file, then it's use for every card in range. If the parameter is an Array of files, then each file is looked up for each card. If any of them are nil or '', nothing is done. See {file:README.md#Specifying_Files Specifying Files}. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
-    # @option opts layout [String, Symbol] (nil) entry in the layout to use as defaults for this command. See {file:README.md#Custom_Layouts Custom Layouts}. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
-    # @option opts width [Fixnum] (:native) the width of the image rendered
-    # @option opts height [Fixnum] (:native) the height of the image rendered
-    # @option opts dx [Integer] (0) "delta x", or adjust the icon horizontally by x pixels
-    # @option opts dy [Integer] (0) "delta y", or adjust the icon vertically by y pixels
-    # @option opts alpha [Decimal] (1.0) the alpha-transparency percentage used to blend this image. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
-    # @option opts blend [:none, :multiply, :screen, :overlay, :darken, :lighten, :color_dodge, :color_burn, :hard_light, :soft_light, :difference, :exclusion, :hsl_hue, :hsl_saturation, :hsl_color, :hsl_luminosity] (:none) the composite blend operator used when applying this image. See Blend Modes at http://cairographics.org/operators. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
-    # @option opts angle [FixNum] (0) Rotation of the in radians. Note that this rotates around the upper-left corner, making the placement of x-y coordinates slightly tricky. Supports Arrays, see {file:README.md#Arrays_and_Singleton_Expansion Arrays and Singleon Expansion}
-    # @api public
+    # DSL method. See http://squib.readthedocs.io
     def png(opts = {})
       key   = Args::EmbedKey.new.validate_key(opts[:key])
       range = Args::CardRange.new(opts[:range], deck_size: @deck_size)

data/lib/squib/api/units.rb

@@ -3,15 +3,20 @@ require_relative '../constants'
 module Squib
   class Deck
 
-    # DSL method. See http://squib.readthedocs.org
+    # DSL method. See http://squib.readthedocs.io
     def inches(n)
       @dpi * n.to_f
     end
 
-    # DSL method. See http://squib.readthedocs.org
+    # DSL method. See http://squib.readthedocs.io
     def cm(n)
       @dpi * Squib::INCHES_IN_CM * n.to_f
     end
 
+    # DSL method. See http://squib.readthedocs.io
+    def mm(n)
+      @dpi * Squib::INCHES_IN_CM * n.to_f / 10.0
+    end
+
   end
 end

data/lib/squib/args/arg_loader.rb

@@ -111,27 +111,15 @@ module Squib
           p_str = "@#{p}"
           p_val = instance_variable_get(p_str)
           if p_val.respond_to? :each
-            arr = p_val.map { |x| convert_unit(x, dpi) }
+            arr = p_val.map { |x| UnitConversion.parse(x, dpi) }
             instance_variable_set p_str, arr
           else
-            instance_variable_set p_str, convert_unit(p_val, dpi)
+            instance_variable_set p_str, UnitConversion.parse(p_val, dpi)
           end
         end
         self
       end
 
-      def convert_unit(arg, dpi)
-        case arg.to_s.rstrip
-        when /in$/ # ends with "in"
-          arg.rstrip[0..-2].to_f * dpi
-        when /cm$/ # ends with "cm"
-          arg.rstrip[0..-2].to_f * dpi * INCHES_IN_CM
-        else
-          arg
-        end
-      end
-      module_function :convert_unit
-
     end
 
   end

data/lib/squib/args/draw.rb

@@ -59,7 +59,7 @@ module Squib
 
       def validate_dash(arg, _i)
         arg.to_s.split.collect do |x|
-          convert_unit(x, @dpi).to_f
+          UnitConversion.parse(x, @dpi).to_f
         end
       end
 

data/lib/squib/args/hand_special.rb

@@ -1,37 +1,37 @@
-require 'cairo'
-
-module Squib
-  # @api private
-  module Args
-
-    class HandSpecial
-      include ArgLoader
-
-      def initialize(card_height)
-        @card_height = card_height
-      end
-
-      def self.parameters
-        {
-          angle_range: (Math::PI / -4.0)..(Math::PI / 4),
-          radius: :auto
-        }
-      end
-
-      def self.expanding_parameters
-        [] # none of them
-      end
-
-      def self.params_with_units
-        [ :radius ]
-      end
-
-      def validate_radius(arg)
-        return 0.3 * @card_height if arg.to_s.downcase.strip == 'auto'
-        arg
-      end
-
-    end
-
-  end
-end
+require 'cairo'
+
+module Squib
+  # @api private
+  module Args
+
+    class HandSpecial
+      include ArgLoader
+
+      def initialize(card_height)
+        @card_height = card_height
+      end
+
+      def self.parameters
+        {
+          angle_range: (Math::PI / -4.0)..(Math::PI / 4),
+          radius: :auto
+        }
+      end
+
+      def self.expanding_parameters
+        [] # none of them
+      end
+
+      def self.params_with_units
+        [ :radius ]
+      end
+
+      def validate_radius(arg)
+        return 0.3 * @card_height if arg.to_s.downcase.strip == 'auto'
+        arg
+      end
+
+    end
+
+  end
+end

data/lib/squib/args/unit_conversion.rb

@@ -15,6 +15,8 @@ module Squib
           arg.rstrip[0..-2].to_f * dpi
         when /cm$/ # ends with "cm"
           arg.rstrip[0..-2].to_f * dpi * INCHES_IN_CM
+        when /mm$/ # ends with "mm"
+          arg.rstrip[0..-2].to_f * dpi * INCHES_IN_CM / 10.0
         else
           arg
         end

data/lib/squib/deck.rb

@@ -68,7 +68,7 @@ module Squib
       @width         = Args::UnitConversion.parse width, dpi
       @height        = Args::UnitConversion.parse height, dpi
       cards.times{ |i| @cards << Squib::Card.new(self, @width, @height, i) }
-      @layout = LayoutParser.load_layout(layout)
+      @layout = LayoutParser.new(dpi).load_layout(layout)
       enable_groups_from_env!
       if block_given?
         instance_eval(&block) # here we go. wheeeee!

data/lib/squib/graphics/embedding_utils.rb

@@ -0,0 +1,28 @@
+module Squib
+  class EmbeddingUtils
+
+    # Given a string and a bunch of keys, give us back a mapping of those keys
+    # to where those keys start, and where they end (in ranges)
+    #
+    # See the spec for expected outputs
+    def self.indices(str, keys)
+      map = {}
+      keys.each do |key|
+        map[key] ||= []
+        start = 0
+        while true
+          idx = str.index(key, start)
+          if idx.nil?
+            break; # done searching
+          else
+            idx_bytes = str[0..idx].bytesize - 1
+            map[key] << (idx_bytes..(idx_bytes + key.size))
+            start = idx + 1
+          end
+        end
+      end
+      return map
+    end
+
+  end
+end

data/lib/squib/graphics/shapes.rb

@@ -4,9 +4,11 @@ module Squib
 
     # :nodoc:
     # @api private
-    def rect(box, draw)
+    def rect(box, draw, trans)
       use_cairo do |cc|
-        cc.rounded_rectangle(box.x, box.y, box.width, box.height, box.x_radius, box.y_radius)
+        cc.rotate_about(box.x, box.y, trans.angle)
+        cc.rounded_rectangle(box.x, box.y, box.width, box.height,
+                             box.x_radius, box.y_radius)
         cc.fill_n_stroke(draw)
       end
     end
@@ -27,9 +29,10 @@ module Squib
     # of the rectangle. Control points are at 1/4 and 3/4 of the side.
     # :nodoc:
     # @api private
-    def ellipse(box, draw)
+    def ellipse(box, draw, trans)
       x, y, w, h = box.x, box.y, box.width, box.height
       use_cairo do |cc|
+        cc.rotate_about(box.x, box.y, trans.angle)
         cc.move_to(x, y + 0.5 * h)       # start west
         cc.curve_to(x, y + 0.25 * h,     # west to north
                     x + 0.25 * w, y,

data/lib/squib/graphics/text.rb

@@ -1,5 +1,6 @@
 require 'pango'
 require_relative '../args/typographer'
+require_relative 'embedding_utils'
 
 module Squib
   class Card
@@ -51,55 +52,59 @@ 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)
-      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
+    # Compute the width of the carve that we need
+    def compute_carve(rule, range)
+      w = rule[:box].width[@index]
+      if w == :native
+        file = rule[:file][@index].file
+        case rule[:type]
+        when :png
+          Squib.cache_load_image(file).width.to_f / (range.size - 1)
+        when :svg
+          svg_data = rule[:svg_args].data[@index]
+          unless file.to_s.empty? || svg_data.to_s.empty?
+            Squib.logger.warn 'Both an SVG file and SVG data were specified'
+          end
+          return 0 if (file.nil? or file.eql? '') and svg_data.nil?
+          svg_data = File.read(file) if svg_data.to_s.empty?
+          RSVG::Handle.new_from_data(svg_data).width
         end
+      else
+        rule[:box].width[@index] * Pango::SCALE / (range.size - 1)
       end
-      ret_key
     end
 
-    # :nodoc:
-    # @api private
-    def process_embeds(embed, str, layout)
+    # # :nodoc:
+    # # @api private
+    def embed_images!(embed, str, layout, valign)
       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 # 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 }
+      attrs = layout.attributes || Pango::AttrList.new
+      EmbeddingUtils.indices(clean_str, embed.rules.keys).each do |key, ranges|
+        rule = embed.rules[key]
+        ranges.each do |range|
+          carve = Pango::Rectangle.new(0, 0, compute_carve(rule, range), 0)
+          att = Pango::AttrShape.new(carve, carve, rule)
+          att.start_index = range.first
+          att.end_index = range.last
+          attrs.insert(att)
+        end
       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]
-        h    = rule[:box].height[@index]
-        draw_calls << { x: x, y: y, h: h, # defer drawing until we've valigned
-                       draw: search[:rule][:draw] }
+      layout.attributes = attrs
+      layout.context.set_shape_renderer do |cxt, att, do_path|
+        unless do_path # when stroking the text
+          rule = att.data
+          x = Pango.pixels(layout.index_to_pos(att.start_index).x) +
+              rule[:adjust].dx[@index]
+          y = Pango.pixels(layout.index_to_pos(att.start_index).y) +
+                rule[:adjust].dy[@index] +
+                compute_valign(layout, valign, rule[:box].height[@index])
+          rule[:draw].call(self, x, y)
+          cxt.reset_clip
+          [cxt, att, do_path]
+        end
       end
-      return draw_calls
     end
 
     def stroke_outline!(cc, layout, draw)
@@ -146,24 +151,16 @@ module Squib
         layout.justify = para.justify unless para.justify.nil?
         layout.spacing = para.spacing unless para.spacing.nil?
 
-        embed_draws    = process_embeds(embed, para.str, layout)
+        embed_images!(embed, para.str, layout, para.valign)
 
-        vertical_start = compute_valign(layout, para.valign, max_embed_height(embed_draws))
-        cc.move_to(0, vertical_start) # TODO clean this up a bit
+        vertical_start = compute_valign(layout, para.valign, 0)
+        cc.move_to(0, vertical_start)
 
         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 }