squib 0.14.3.pre1 → 0.16.0.pre.preview1

data/lib/squib/sprues/crop_line.rb

@@ -3,21 +3,21 @@ module Squib
     class CropLine
       attr_reader :x1, :y1, :x2, :y2
 
-      def initialize(type, position, sheet_width, sheet_height, dpi)
+      def initialize(type, position, sheet_width, sheet_height, dpi, cell_px)
         method = "parse_#{type}"
-        send method, position, sheet_width, sheet_height, dpi
+        send method, position, sheet_width, sheet_height, dpi, cell_px
       end
 
-      def parse_horizontal(position, sheet_width, _, dpi)
-        position = Args::UnitConversion.parse(position, dpi)
+      def parse_horizontal(position, sheet_width, _, dpi, cell_px)
+        position = Args::UnitConversion.parse(position, dpi, cell_px)
         @x1 = 0
         @y1 = position
         @x2 = sheet_width
         @y2 = position
       end
 
-      def parse_vertical(position, _, sheet_height, dpi)
-        position = Args::UnitConversion.parse(position, dpi)
+      def parse_vertical(position, _, sheet_height, dpi, cell_px)
+        position = Args::UnitConversion.parse(position, dpi, cell_px)
         @x1 = position
         @y1 = 0
         @x2 = position

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
@@ -175,6 +177,8 @@ module Squib
       new_card['y'] = y
       new_card['rotate'] = parse_rotate_param(
         card['rotate'] ? card['rotate'] : @template_hash['rotate'])
+      new_card['flip_vertical'] = card['flip_vertical'] == true
+      new_card['flip_horizontal'] = card['flip_horizontal'] == true
       new_card
     end
 
@@ -199,5 +203,6 @@ module Squib
         val.to_f
       end
     end
+
   end
 end

data/lib/squib/sprues/sprue_schema.rb

@@ -41,8 +41,10 @@ module Squib
           :optional, Numeric,
           ClassyHash::G.enum(:clockwise, :counterclockwise, :turnaround),
           ROTATE_REGEX
-        ]
-      }]]
+        ],
+        'flip_vertical' => [ :optional, FalseClass ],
+        'flip_horizontal' => [ :optional, FalseClass ],
+        }]]
     }.freeze
   end
 end

data/lib/squib/version.rb

@@ -6,5 +6,5 @@ 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.14.3.pre1'
+  VERSION = '0.16.0-preview1'
 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/_colors.rb

@@ -19,17 +19,23 @@ Squib::Deck.new(width: 825, height: 1125, cards: 1) do
 end
 
 # This script generates a table of the built-in constants
-Squib::Deck.new(width: 3000, height: 1500) do
+colors = (Cairo::Color.constants - %i(HEX_RE Base RGB CMYK HSV X11))
+colors.sort_by! do |c|
+  hsv = Cairo::Color.parse(c).to_hsv
+  [(hsv.hue / 16.0).to_i, hsv.value, hsv.saturation]
+end
+w, h = 300, 50
+deck_height = 4000
+deck_width = (colors.size / ((deck_height / h) + 1)) * w
+Squib::Deck.new(width: deck_width, height: deck_height) do
   background color: :white
-  colors = (Cairo::Color.constants - %i(HEX_RE Base RGB CMYK HSV X11))
-  colors.sort_by! {|c| Cairo::Color.parse(c).to_s}
-  x, y, w, h = 0, 0, 300, 50
+  x, y = 0, 0
   colors.each_with_index do |color, i|
     rect x: x, y: y, width: w, height: h, fill_color: color
     text str: color.to_s, x: x + 5, y: y + 13, font: 'Sans Bold 5',
          color: (Cairo::Color.parse(color).to_hsv.v > 0.9) ? '#000' : '#fff'
     y += h
-    if y > @height
+    if y > deck_height
       x += w
       y = 0
     end

data/samples/colors/_switch_color.rb

@@ -0,0 +1,33 @@
+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'
+
+Squib::Deck.new cards: cards['Type'].size do
+
+    background_color = cards['Type'].map do |t|
+        if color == 'black' && t == "Snake" then
+            "black"
+        else
+            "white"
+        end
+    end
+    background color: background_color
+
+    text_color = cards['Type'].map do |t|
+        if color == 'black' && t == "Snake" then
+            "white"
+        else
+            "black"
+        end
+    end
+
+    text str: cards['Text'], color: text_color
+
+    save_png prefix: '_switch_color_sample_'
+
+end

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/images/_more_load_images.rb

@@ -93,7 +93,7 @@ Squib::Deck.new(width: 825, height: 1125, cards: 1, config: 'load_images_config.
   # but sometimes want to use none.
   # e.g. id: [:attack, :defend, nil]
   svg file: 'spanner.svg', width: :deck, height: :deck,
-      force_id: true, id: '' # <-- the important part
+      force_id: true, id: nil # <-- the important part
 
   # Squib can handle incorrectly formatted svg files
   svg file: 'bad-svg.svg'

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

@@ -0,0 +1,28 @@
+require 'squib'
+
+# This demonstrates the many ways you can save file to save_png and the like
+Squib::Deck.new(width: 50, height: 50, cards: 2) do
+  background color: :white
+  text str: (0..16).to_a, font: 'Arial Bold 12'
+
+  # three digits, e.g. save_three_digits_000.png
+  save_png prefix: 'save_three_digits_', count_format: '%03d'
+
+  # foo_0.png
+  # bar_1.png
+  save_png prefix: ['foo_', 'bar_'], count_format: '%01d'
+
+  # foo.png
+  # 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"
+  save_png prefix: data.filename, count_format: ''
+
+end

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,6 +45,7 @@ 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

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'