squib 0.15.3 → 0.17.0

data/lib/squib/sprues/crop_line_dash.rb

@@ -9,22 +9,22 @@ module Squib
 
       attr_reader :pattern
 
-      def initialize(value, dpi)
+      def initialize(value, dpi, cell_px)
         if value == :solid
           @pattern = nil
         elsif value == :dotted
           @pattern = [
-            Args::UnitConversion.parse('0.2mm', dpi),
-            Args::UnitConversion.parse('0.5mm', dpi)
+            Args::UnitConversion.parse('0.2mm', dpi, cell_px),
+            Args::UnitConversion.parse('0.5mm', dpi, cell_px)
           ]
         elsif value == :dashed
           @pattern = [
-            Args::UnitConversion.parse('2mm', dpi),
-            Args::UnitConversion.parse('2mm', dpi)
+            Args::UnitConversion.parse('2mm', dpi, cell_px),
+            Args::UnitConversion.parse('2mm', dpi, cell_px)
           ]
         elsif value.is_a? String
           @pattern = value.split(' ').map do |val|
-            Args::UnitConversion.parse val, dpi
+            Args::UnitConversion.parse val, dpi, cell_px
           end
         else
           raise ArgumentError, 'Unsupported dash style'

data/lib/squib/sprues/sprue.rb

@@ -18,6 +18,7 @@ module Squib
       'card_width' => nil,
       'card_height' => nil,
       'dpi' => 300,
+      'cell_px' => 37.5,
       'position_reference' => :topleft,
       'rotate' => 0.0,
       'crop_line' => {
@@ -32,16 +33,17 @@ module Squib
 
     attr_reader :dpi
 
-    def initialize(template_hash, dpi)
+    def initialize(template_hash, dpi, cell_px)
       @template_hash = template_hash
       @dpi = dpi
+      @cell_px = cell_px
       @crop_line_default = @template_hash['crop_line'].select do |k, _|
         %w[style width color].include? k
       end
     end
 
     # Load the template definition file
-    def self.load(file, dpi)
+    def self.load(file, dpi, cell_px)
       yaml = {}
       thefile = file if File.exist?(file) # use custom first
       thefile = builtin(file) if File.exist?(builtin(file)) # then builtin
@@ -62,23 +64,23 @@ module Squib
       rescue ClassyHash::SchemaViolationError => e
         raise Sprues::InvalidSprueDefinition.new(thefile, e)
       end
-      Sprue.new new_hash, dpi
+      Sprue.new new_hash, dpi, cell_px
     end
 
     def sheet_width
-      Args::UnitConversion.parse @template_hash['sheet_width'], @dpi
+      Args::UnitConversion.parse @template_hash['sheet_width'], @dpi, @cell_px
     end
 
     def sheet_height
-      Args::UnitConversion.parse @template_hash['sheet_height'], @dpi
+      Args::UnitConversion.parse @template_hash['sheet_height'], @dpi, @cell_px
     end
 
     def card_width
-      Args::UnitConversion.parse @template_hash['card_width'], @dpi
+      Args::UnitConversion.parse @template_hash['card_width'], @dpi, @cell_px
     end
 
     def card_height
-      Args::UnitConversion.parse @template_hash['card_height'], @dpi
+      Args::UnitConversion.parse @template_hash['card_height'], @dpi, @cell_px
     end
 
     def card_default_rotation
@@ -113,8 +115,8 @@ module Squib
       # NOTE: There's a baseline of 0.25mm that we can 100% make sure that we
       # can overlap really thin lines on the PDF
       crop_line_width = [
-        Args::UnitConversion.parse(@template_hash['crop_line']['width'], @dpi),
-        Args::UnitConversion.parse('0.25mm', @dpi)
+        Args::UnitConversion.parse(@template_hash['crop_line']['width'], @dpi, @cell_px),
+        Args::UnitConversion.parse('0.25mm', @dpi, @cell_px)
       ].max
 
       parsed_cards = cards
@@ -149,12 +151,12 @@ module Squib
     # Parse crop line definitions from template.
     def parse_crop_line(line)
       new_line = @crop_line_default.merge line
-      new_line['width'] = Args::UnitConversion.parse(new_line['width'], @dpi)
+      new_line['width'] = Args::UnitConversion.parse(new_line['width'], @dpi, @cell_px)
       new_line['color'] = colorify new_line['color']
       new_line['style_desc'] = new_line['style']
-      new_line['style'] = Sprues::CropLineDash.new(new_line['style'], @dpi)
+      new_line['style'] = Sprues::CropLineDash.new(new_line['style'], @dpi, @cell_px)
       new_line['line'] = Sprues::CropLine.new(
-        new_line['type'], new_line['position'], sheet_width, sheet_height, @dpi
+        new_line['type'], new_line['position'], sheet_width, sheet_height, @dpi, @cell_px
       )
       new_line
     end
@@ -163,8 +165,8 @@ module Squib
     def parse_card(card)
       new_card = card.clone
 
-      x = Args::UnitConversion.parse(card['x'], @dpi)
-      y = Args::UnitConversion.parse(card['y'], @dpi)
+      x = Args::UnitConversion.parse(card['x'], @dpi, @cell_px)
+      y = Args::UnitConversion.parse(card['y'], @dpi, @cell_px)
       if @template_hash['position_reference'] == :center
         # Normalize it to a top-left positional reference
         x -= card_width / 2

data/lib/squib/system_fonts.rb

@@ -0,0 +1,17 @@
+require 'pango'
+module Squib
+
+  # List all system fonts that Cairo/Pango can see
+  # Wow this call was convoluted...
+  # Returns array of strings with the names of fonts
+  module_function def system_fonts
+    cc = Cairo::Context.new(Cairo::ImageSurface.new(0,0)) # empty image
+    cc.create_pango_layout.context.families.map {|f| f.name }
+  end
+
+  # Prints out the system fonts in sorted order
+  module_function def print_system_fonts
+    puts "== DEBUG: Squib knows about these fonts =="
+    puts system_fonts.sort
+  end
+end

data/lib/squib/version.rb

@@ -6,5 +6,6 @@ module Squib
   # Most of the time this is in the alpha of the next release.
   # e.g. v0.0.5a is on its way to becoming v0.0.5
   #
-  VERSION = '0.15.3'
+  VERSION = '0.17.0'
 end
+

data/samples/autoscale_font/_autoscale_font.rb

@@ -1,13 +1,79 @@
 require 'squib'
 
-# Here's an example of being able to scale a font
-# based on the length of individual string.
-# Handy for making minor font scales to fill text boxes.
+# Autoscaling font is handy for a bunch of things:
+#  * Picture-perfect text fitting for one-off
+#  * Rapid prototyping where you don't have to think about sizes
+#
+# We've got three options...
+#  Option 1. Use your data <--- good for picture-perfect
+#  Option 2. Use ellipsize: :autoscale <--- good for rapid prototyping
+#  Option 3. Use map ranges in your code <--- good for picture-perfect
+#                                             or other weird cases
+
+###########################
+# Option 1: Use your data #
+###########################
+# If you want to tweak the font size per-card, you can always make font_size
+# a column and map it from there. This is tedious but leads to perfectly
+# customized results
+my_data = Squib.csv data: <<~CSV
+  "Title","Font Size"
+  "Short & Big",10
+  "Medium Length & Size", 5
+  "Super duper long string here, therefore a smaller font.", 4
+CSV
+
+Squib::Deck.new(width: 300, height: 75, cards: 3) do
+  background color: :white
+  rect stroke_color: :black
+
+  text str: my_data.title, font: 'Arial',
+       font_size: my_data.font_size, # <-- key part
+       x: 10, y:10, align: :center,
+       width: 280, # <-- note how height does NOT need to be set
+       ellipsize: false,
+       hint: :red
+  save_sheet columns: 3, prefix: 'autoscale_w_data_'
+end
+
+#######################################
+# Option 2: Use ellipsize: :autoscale #
+#######################################
+# If set the height, you can set "autoscale" and it will incrementally
+# downgrade the font size until the text does not ellipsize
+#
+# Great for rapid prototyping, set-it-and-forget-it
+#
+# NOTE: You MUST set the height for this to work. Otherwise, the text will
+#       never ellipsize and Squib doesn't know when to start autoscaling
+Squib::Deck.new(width: 300, height: 75, cards: 3) do
+  background color: :white
+  rect stroke_color: :black
+  title = ['Short & Big',
+           'Medium Length & Size',
+           'Super duper long string here, therefore a smaller font.']
+
+  # Automatically scale the text down from the specified font_size to the largest size that fits
+  text str: title, font: 'Arial',
+       font_size: 15, # <-- this is the MAX font size. Scale down from here
+       ellipsize: :autoscale, # <-- key part
+       height: 50, # <-- need this to be set to something
+       width: 280, x: 10, y: 10, align: :center, valign: :middle, hint: :red
+
+  save_sheet columns: 3, prefix: 'autoscale_w_ellipsize_'
+end
+
+############################################
+# Option 3: Mapping to ranges in your code #
+############################################
+# Here's an in-between option that allows you to programmatically apply font
+# sizes. This allows you a ton of flexibility.Probably more flexibility than
+# you need, frankly. But one advantage is that you don't have to set the height
 def autoscale(str_array)
   str_array.map do | str |
     case str.length
     when 0..15
-      10.66
+      9
     when 16..20
       6
     else
@@ -16,14 +82,17 @@ def autoscale(str_array)
   end
 end
 
-Squib::Deck.new(width: 300, height: 100, cards: 3) do
+Squib::Deck.new(width: 300, height: 75, cards: 3) do
   background color: :white
-  rect
+  rect stroke_color: :black
   title = ['Short & Big',
            'Medium Length & Size',
            'Super duper long string here, therefore a smaller font.']
-  text str: title, font: 'Arial', font_size: autoscale(title),
+
+  # Scale text based on the string length
+  text str: title, font: 'Arial',
+       font_size: autoscale(title), # <-- key part
        x: 10, y:10, align: :center, width: 280, ellipsize: false, hint: :red
 
-  save_sheet columns: 3
+    save_sheet columns: 3, prefix: 'autoscale_w_range_'
 end

data/samples/colors/_switch_color.rb

@@ -1,11 +1,11 @@
-require 'squib'
+require_relative '../../lib/squib'
 
 # Choose between black and white color theme for type snake
 #   * Allow using white snake cards with black text or
 #     black snake cards with white text
 color = 'white'
 
-cards = Squib.csv file: '_switch_color_data.csv', col_sep: "\t"
+cards = Squib.csv file: '_switch_color_data.csv'
 
 Squib::Deck.new cards: cards['Type'].size do
 

data/samples/data/_excel.rb

@@ -37,7 +37,7 @@ end
 #     from each value. This is the default behavior in Squib, but the options
 #     are here just to make sure.
 
-resource_data = Squib.xlsx(file: 'sample.xlsx', sheet: 2, strip: true) do |header, value|
+resource_data = Squib.xlsx(file: 'sample.xlsx', explode: 'Qty', sheet: 2, strip: true) do |header, value|
   case header
   when 'Cost'
     "$#{value}k" # e.g. "3" becomes "$3k"

data/samples/ranges/_ranges.rb

@@ -59,6 +59,6 @@ Squib::Deck.new(width: 825, height: 1125, cards: 3) do
     end
   end
 
-  rect color: 'black' # just a border
+  rect stroke_color: 'black' # just a border
   save_sheet prefix: 'ranges_', columns: 3
 end

data/samples/saves/_save_filenames.rb

@@ -16,6 +16,10 @@ Squib::Deck.new(width: 50, height: 50, cards: 2) do
   # bar.png
   save_png prefix: ['foo', 'bar'], count_format: ''
 
+  # foo_00_bar.png
+  # foo_01_bar.png
+  save_png prefix: 'foo_', suffix: '_bar'
+
   # thief.png
   # thug.png
   data = csv data: "filename\nthief\nthug"

data/samples/saves/_save_pdf.rb

@@ -3,7 +3,7 @@ require 'squib'
 Squib::Deck.new(cards: 8) do
   background color: :gray
   rect x: 37.5, y: 37.5, width: 750, height: 1050,
-       x_radius: 37.5, y_radius: 37.5, stroke: 3.0, dash: '4 4'
+       x_radius: 37.5, y_radius: 37.5, stroke_width: 2.0, dash: '4 4'
 
    # Tests for crop marks
    save_pdf file: 'crops-default.pdf', crop_marks: true

data/samples/saves/_saves.rb

@@ -5,7 +5,7 @@ require 'squib'
 Squib::Deck.new(width: 825, height: 1125, cards: 16) do
   background color: :gray
   rect x: 38, y: 38, width: 750, height: 1050,
-       x_radius: 38, y_radius: 38, stroke: 3.0, dash: '4 4'
+       x_radius: 38, y_radius: 38, stroke_width: 2.0, dash: '4 4'
 
   text str: (1..16).to_a, x: 220, y: 78, font: 'Arial 18'
 
@@ -45,7 +45,18 @@ Squib::Deck.new(width: 825, height: 1125, cards: 16) do
 
   # Sheets can arrange left-to-right and right-to-left
   save_sheet prefix: 'save_sheet_rtl_',
+             suffix: '_with_suffix',
              range: 0..1, rtl: true,
              columns: 2, rows: 1,
              margin: 75, gap: 5, trim: 37
 end
+
+Squib::Deck.new(width: 100, height: 100, cards: 3) do
+  background color: :grey
+  text str: 'Hi', font: 'Arial 18'
+
+  # Test bug 332.
+  # When we only have 3 cards but want a 2x4 grid with lots of empty spaces.
+  # Buggy behavior was to revert to 1 row and not respect the rows arg.
+  save_sheet prefix: 'save_sheet_bug332_', rows: 2, columns: 4
+end

data/samples/shadows/_shadow.rb

@@ -0,0 +1,72 @@
+require 'squib'
+# The save_png method supports drop shadows on the final save
+# This is useful for when you want to generate images for your rulebook
+
+Squib::Deck.new(width: 100, height: 150) do
+  background color: '#abc'
+  svg file: '../spanner.svg',
+      x: 'middle - 25', y: 'middle - 25',
+      width: 50, height: 50
+
+  # Shadows off by default, i.e. shadow_radius is nil
+  # So our final dimensions are 100 - 2*15 and 150-2*15
+  save_png prefix: 'no_shadow_', trim: 15, trim_radius: 15
+
+  # Here's a nice-looking drop shadow
+  # Defaults are designed to be generally good, so I recommend just
+  # trying out a shadow_radius of 3 to 10 and see how it looks first
+  save_png prefix: 'with_shadow_', trim: 15, trim_radius: 15,
+           shadow_radius: 8,
+           shadow_offset_x: 3, shadow_offset_y: 3,  # about r / 2.5 looks good
+           shadow_trim: 2.5, # about r/ 3 looks good
+           shadow_color: '#101010aa' #tip: start the shadow color kinda transparent
+
+  # Don't want a blur? Use a radius of 0
+  save_png prefix: 'no_blur_', trim: 15, trim_radius: 15,
+           shadow_radius: 0
+
+  # Ok this next stop is crazytown, but it does give you ultimate control
+  # Remember that all Squib colors can also be gradients.
+  # They can be clunky but they do work here.
+  #   - x,y's are centered in the card itself
+  #   - stops go from fully empty to fully black
+  #   - we need to still turn on radius to get the effect
+  #   - but, this makes the upper-left corner not have a glowing effect and
+  #     have a harder edge, which (to my eye at least) feels more realistic
+  #     since the card would obscure the upper-left shadow at that angle
+  #   - this also allows you have a larger, softer blur without making it look
+  #     like it's glowing
+  #
+  # Oh just because it's easier to write we can use a ruby heredoc
+  save_png prefix: 'gradient_blur_', trim: 15, trim_radius: 15,
+           shadow_radius: 10,
+           shadow_color: <<~EOS
+              (25,25)
+              (175,175)
+              #0000@0.0
+              #000f@1.0
+           EOS
+
+  # This one looks weird I know but it's for regression testing
+  save_png prefix: 'with_shadow_test_',
+           trim: 15, trim_radius: 15, rotate: :clockwise,
+           shadow_offset_x: 5, shadow_offset_y: 25, shadow_radius: 10,
+           shadow_trim: 10,
+           shadow_color: '#123'
+end
+
+Squib::Deck.new(width:50, height: 50) do
+
+  # What if we had a transparent card but just some shapes?
+  # Like chits or something
+
+  # background defaults to fully transparent here
+
+  png file: 'doodle.png'
+
+  save_png prefix: 'transparent_bg_shadow_',
+           shadow_radius: 2,
+           shadow_offset_x: 2, shadow_offset_y: 2,
+           shadow_color: :black
+
+end

data/samples/shapes/_draw_shapes.rb

@@ -3,8 +3,8 @@ require 'squib'
 Squib::Deck.new do
   background color: :white
 
-  grid x: 10, y: 10, width: 50,  height: 50,  stroke_color: '#0066FF', stroke_width: 1.5, angle: 0.1
-  grid x: 10, y: 10, width: 200, height: 200, stroke_color: '#0066FF', stroke_width: 3, angle: 0.1
+  grid x: 10, y: 10, width: 50,  height: 50,  stroke_color: '#0066FF', stroke_width: 1.5
+  grid x: 10, y: 10, width: 200, height: 200, stroke_color: '#0066FF', stroke_width: 3
 
   rect x: 305, y: 105, width: 200, height: 50, dash: '4 2'
 

data/samples/sprues/_builtin_sprues.rb

@@ -17,5 +17,6 @@ Squib::Deck.new(width: '50mm', height: '70mm', cards: 9) do
     drivethrucards_1up.yml
   ).each do |builtin|
     save_sheet sprue: builtin, prefix: "sprue_#{builtin}_"
+    save_pdf sprue: builtin, file: "sprue_#{builtin}_"
   end
 end

data/samples/sprues/_fold_sheet.rb

@@ -22,6 +22,9 @@ Squib::Deck.new(width: '2.5in', height: '3.5in', cards: 8) do
 
   text str: strings,font: 'Sans 32', align: :center, valign: :middle,
        height: :deck, width: :deck
+       
   save_sheet prefix: 'foldable_',
-             sprue: 'letter_poker_foldable_8up.yml'
+             sprue: 'letter_poker_foldable_8up.yml' # built-in sprue
+  save_pdf file: 'foldable.pdf',
+           sprue: 'letter_poker_foldable_8up.yml' # built-in sprue
 end