sprues: now with trim and trim_radius!!

Fixes #235

docs/sprues.rst

@@ -12,10 +12,6 @@ A `sprue <https://en.wikipedia.org/wiki/Sprue_(manufacturing)>`_ is a Squib feat
 
 Without using a sprue, the :doc:`/dsl/save_sheet` and :doc:`/dsl/save_sheet` will simply lay out your cards one after another with the gap and margins you specify.
 
-.. warning::
-
-  Sprues don't currently support the `trim` and `trim_radius` options. `Stay tuned <https://github.com/andymeneely/squib/issues/235>`_
-
 Using a Sprue
 -------------
 

lib/squib/graphics/save_sprue.rb

@@ -2,12 +2,11 @@ module Squib
   module Graphics
     # Helper class to generate templated sheet.
     class SaveSprue
-      def initialize(deck, tmpl, outfile)
+      def initialize(deck, tmpl, save_args)
         @deck = deck
         @tmpl = tmpl
         @page_number = 1
-        @outfile = outfile
+        @save_args = save_args #might be Args::Sheet or Args::SaveBatch
-        @rotated_delta = (@tmpl.card_width - @deck.width).abs / 2
         @overlay_lines = @tmpl.crop_lines.select do |line|
           line['overlay_on_cards']
         end
@@ -17,12 +16,9 @@ module Squib
         cc = init_cc
         cc.set_source_color(:white) # white backdrop TODO make option
         cc.paint
-        card_set = @tmpl.cards
+        slots = @tmpl.cards
-        per_sheet = card_set.size
+        per_sheet = slots.size
-        default_angle = @tmpl.card_default_rotation
+        check_oversized_card
-        if default_angle.zero?
-          default_angle = check_card_orientation
-        end
 
         draw_overlay_below_cards cc if range.size
 
@@ -31,17 +27,12 @@ module Squib
             cc = next_page_if_needed(cc, i, per_sheet)
 
             card = @deck.cards[i]
-            slot = card_set[i % per_sheet]
+            slot = slots[i % per_sheet]
-            x = slot['x']
-            y = slot['y']
-            angle = slot['rotate'] != 0 ? slot['rotate'] : default_angle
 
-            if angle != 0
+            draw_card cc, card, 
-              draw_rotated_card cc, card, x, y, angle
+                      slot['x'], slot['y'], 
-            else
+                      slot['rotate'], 
-              cc.set_source card.cairo_surface, x, y
+                      @save_args.trim[i], @save_args.trim_radius[i]
-            end
-            cc.paint
 
             bar.increment
           end
@@ -130,50 +121,40 @@ module Squib
         end
       end
 
-      def check_card_orientation
+      def check_oversized_card
-        clockwise = 1.5 * Math::PI
+        all_fit = @save_args.trim.inject(true) do |fits, trim|
-        if @deck.width <= @tmpl.card_width &&
+          fits &&
-           @deck.height <= @tmpl.card_height
+          (@deck.width - 2.0 * trim)  <= @tmpl.card_width &&
-          return 0
+          (@deck.height - 2.0 * trim) <= @tmpl.card_height
-        elsif (
-            @deck.width == @tmpl.card_height &&
-            @deck.height == @tmpl.card_width)
-          Squib.logger.warn {
-            'Rotating cards to match card orientation in template.'
-          }
-          return clockwise
         end
-
         Squib.logger.warn {
           'Card size is larger than sprue\'s expected card size. '\
           'Cards may overlap.'
-        }
+        } unless all_fit
-        return 0
       end
 
-      def draw_rotated_card(cc, card, x, y, angle)
+      def draw_card(cc, card, x, y, angle, trim, trim_radius)
+        # Compute the true size of the card after trimming
+        w = @deck.width - 2.0 * trim
+        h = @deck.height - 2.0 * trim
+
         # Normalize the angles first
+        # TODO do this in the args class
         angle = angle % (2 * Math::PI)
         angle = 2 * Math::PI - angle if angle < 0
 
-        # Determine what's the delta we need to translate our cards
-        delta_shift = @deck.width < @deck.height ? 1 : -1
-        if angle.zero? || angle == Math::PI
-          delta = 0
-        elsif angle < Math::PI
-          delta = -delta_shift * @rotated_delta
-        else
-          delta = delta_shift * @rotated_delta
-        end
-
         # Perform the actual rotation and drawing
         mat = cc.matrix # Save the transformation matrix to revert later
         cc.translate x, y
-        cc.translate @deck.width / 2, @deck.height / 2
+        cc.translate @deck.width / 2.0, @deck.height / 2.0
         cc.rotate angle
-        cc.translate(-@deck.width / 2 + delta, -@deck.height / 2 + delta)
+        cc.translate -@deck.width / 2.0, -@deck.height / 2.0
+        cc.rounded_rectangle(trim, trim, w, h, trim_radius, trim_radius) # clip
+        cc.clip
         cc.set_source card.cairo_surface, 0, 0
         cc.matrix = mat
+        cc.paint
+        cc.reset_clip
       end
     end
 
@@ -201,7 +182,7 @@ module Squib
       end
 
       def full_filename
-        @outfile.full_filename
+        @save_args.full_filename
       end
     end
 
@@ -221,7 +202,7 @@ module Squib
       end
 
       def full_filename
-        @outfile.full_filename @page_number
+        @save_args.full_filename @page_number
       end
     end
   end

samples/sprues/_advanced_sprues.rb

@@ -0,0 +1,33 @@
+require 'squib'
+
+# This is a more advanced example of Sprues
+# (mostly so we can have a torturous regression test)
+#  - Uses a custom sprue
+#  - Weird rotations
+#  - Center-positioned
+#  - Uses per-card trim and trim_radius
+#  - Multiple pages
+Squib::Deck.new(cards: 6, width: '2.2in', height: '2.1in') do
+  background color: :blue #blue never shows up! Yay clipping...
+  rect stroke_width: 5, stroke_color: :red, fill_color: :salmon
+  cut_zone margin: '0.125in',
+           stroke_width: 2, stroke_color: :purple
+
+  circle x: width/2, y: height/2, radius: 20 # midpoint
+
+  text str: (0..9).map{ |i| "Card #{i}\n\n" },
+       font: 'Sans 32', align: :center, valign: :middle,
+       height: :deck, width: :deck
+
+  # Per-card trims just for funsies
+  trims = ['0.2in'] * 9
+  trims[0] = '0.3in'
+  trims[3] = '0.4in'
+  trim_radii = ['10pt'] * 9
+  trim_radii[1] = '0.2in'
+  trim_radii[3] = '0.75in'
+  
+  save_sheet sprue: 'my_sprues/weird_sprue.yml',
+             trim: trims, trim_radius: trim_radii,
+             prefix: "advanced_sprues_"
+end

samples/sprues/my_sprues/weird_sprue.yml

@@ -0,0 +1,17 @@
+---
+sheet_width: 5in
+sheet_height: 4.5in
+card_width: 2in
+card_height: 2in
+position_reference: :center
+cards:
+- x: 1.1in
+  y: 1.1in
+- x: 3.1in
+  y: 1.1in
+  rotate: 3.14159
+- x: 1.1in
+  y: 3.1in
+- x: 3.1in
+  y: 3.1in
+  rotate: 2 # 2 radians?? ew.