squib 0.15.1 → 0.16.0

data/lib/squib/sprues/sprue_schema.rb

@@ -1,50 +1,50 @@
-module Squib
-  module Sprues
-    UNIT_REGEX = /^(\d*[.])?\d+(in|cm|mm)$/
-    ROTATE_REGEX = /^(\d*[.])?\d+(deg|rad)?$/
-    SCHEMA = {
-      'sheet_width' => UNIT_REGEX,
-      'sheet_height' => UNIT_REGEX,
-      'card_width' => UNIT_REGEX,
-      'card_height' => UNIT_REGEX,
-      'position_reference' => ClassyHash::G.enum(:topleft, :center),
-      'rotate' => [
-        :optional, Numeric,
-        ClassyHash::G.enum(:clockwise, :counterclockwise, :turnaround),
-        ROTATE_REGEX
-      ],
-      'crop_line' => {
-        'style' => [
-          ClassyHash::G.enum(:solid, :dotted, :dashed),
-          Sprues::CropLineDash::VALIDATION_REGEX
-        ],
-        'width' => UNIT_REGEX,
-        'color' => [String, Symbol],
-        'overlay' => ClassyHash::G.enum(
-          :on_margin, :overlay_on_cards, :beneath_cards
-        ),
-        'lines' => [[{
-          'type' => ClassyHash::G.enum(:horizontal, :vertical),
-          'position' => UNIT_REGEX,
-          'style' => [
-            :optional, ClassyHash::G.enum(:solid, :dotted, :dashed)
-          ],
-          'width' => [:optional, UNIT_REGEX],
-          'color' => [:optional, String, Symbol],
-          'overlay_on_cards' => [:optional, TrueClass]
-        }]]
-      },
-      'cards' => [[{
-        'x' => UNIT_REGEX,
-        'y' => UNIT_REGEX,
-        'rotate' => [
-          :optional, Numeric,
-          ClassyHash::G.enum(:clockwise, :counterclockwise, :turnaround),
-          ROTATE_REGEX
-        ],
-        'flip_vertical' => [ :optional, FalseClass ],
-        'flip_horizontal' => [ :optional, FalseClass ],
-        }]]
-    }.freeze
-  end
-end
+module Squib
+  module Sprues
+    UNIT_REGEX = /^(\d*[.])?\d+(in|cm|mm)$/
+    ROTATE_REGEX = /^(\d*[.])?\d+(deg|rad)?$/
+    SCHEMA = {
+      'sheet_width' => UNIT_REGEX,
+      'sheet_height' => UNIT_REGEX,
+      'card_width' => UNIT_REGEX,
+      'card_height' => UNIT_REGEX,
+      'position_reference' => ClassyHash::G.enum(:topleft, :center),
+      'rotate' => [
+        :optional, Numeric,
+        ClassyHash::G.enum(:clockwise, :counterclockwise, :turnaround),
+        ROTATE_REGEX
+      ],
+      'crop_line' => {
+        'style' => [
+          ClassyHash::G.enum(:solid, :dotted, :dashed),
+          Sprues::CropLineDash::VALIDATION_REGEX
+        ],
+        'width' => UNIT_REGEX,
+        'color' => [String, Symbol],
+        'overlay' => ClassyHash::G.enum(
+          :on_margin, :overlay_on_cards, :beneath_cards
+        ),
+        'lines' => [[{
+          'type' => ClassyHash::G.enum(:horizontal, :vertical),
+          'position' => UNIT_REGEX,
+          'style' => [
+            :optional, ClassyHash::G.enum(:solid, :dotted, :dashed)
+          ],
+          'width' => [:optional, UNIT_REGEX],
+          'color' => [:optional, String, Symbol],
+          'overlay_on_cards' => [:optional, TrueClass]
+        }]]
+      },
+      'cards' => [[{
+        'x' => UNIT_REGEX,
+        'y' => UNIT_REGEX,
+        'rotate' => [
+          :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

@@ -1,10 +1,11 @@
-module Squib
-
-  # The next version to be released.
-  # Uses semantic versioning: http://semver.org/
-  #
-  # 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.1'
-end
+module Squib
+
+  # The next version to be released.
+  # Uses semantic versioning: http://semver.org/
+  #
+  # 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.16.0'
+end
+

data/samples/autoscale_font/_autoscale_font.rb

@@ -1,29 +1,98 @@
-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.
-def autoscale(str_array)
-  str_array.map do | str |
-    case str.length
-    when 0..15
-      10.66
-    when 16..20
-      6
-    else
-      4
-    end
-  end
-end
-
-Squib::Deck.new(width: 300, height: 100, cards: 3) do
-  background color: :white
-  rect
-  title = ['Short & Big',
-           'Medium Length & Size',
-           'Super duper long string here, therefore a smaller font.']
-  text str: title, font: 'Arial', font_size: autoscale(title),
-       x: 10, y:10, align: :center, width: 280, ellipsize: false, hint: :red
-
-  save_sheet columns: 3
-end
+require 'squib'
+
+# 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
+      9
+    when 16..20
+      6
+    else
+      4
+    end
+  end
+end
+
+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.']
+
+  # 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, prefix: 'autoscale_w_range_'
+end

data/samples/backend/_backend.rb

@@ -1,26 +1,26 @@
-require 'squib'
-
-# Our SVGs are auto-saved after each step using the configuration parameters
-Squib::Deck.new(cards: 2, config: '_backend-config.yml') do
-
-  # These are all supported by the SVG backend
-  background color: :gray
-  text       str: 'Hello, world!', y: 500, width: 825, font: 'Sans bold 24', align: :center
-  rect       x: 38, y: 38, width: 750, height: 1050, x_radius: 38, y_radius: 38
-  circle     x: 100, y: 400, radius: 25
-  triangle   x1: 100, y1: 425, x2: 125, y2: 475, x3: 75, y3: 475
-  line       x1: 100, y1: 620, x2: 720, y2: 620, stroke_width: 15.0
-  svg        file: 'spanner.svg', x: 100, y: 75
-  png        file: 'shiny-purse.png', x: 250, y: 75 # raster can still be used too
-  png        file: 'shiny-purse.png', x: 250, y: 250, mask: :red # still renders as raster
-  # We can still rasterize whenever we want
-  save_png prefix: 'backend_'
-
-  showcase file: 'showcase.png', fill_color: 'white'
-
-  # And our PDFs will be vectorized .
-  save_pdf file: 'backend_vectorized.pdf', gap: 5
-
-  # This one is a known issue. Masking an SVG onto an SVG backend is still buggy.
-  # svg        file: 'glass-heart.svg', x: 100, y: 200, width: 100, height: 100, mask: :sangria
-end
+require 'squib'
+
+# Our SVGs are auto-saved after each step using the configuration parameters
+Squib::Deck.new(cards: 2, config: '_backend-config.yml') do
+
+  # These are all supported by the SVG backend
+  background color: :gray
+  text       str: 'Hello, world!', y: 500, width: 825, font: 'Sans bold 24', align: :center
+  rect       x: 38, y: 38, width: 750, height: 1050, x_radius: 38, y_radius: 38
+  circle     x: 100, y: 400, radius: 25
+  triangle   x1: 100, y1: 425, x2: 125, y2: 475, x3: 75, y3: 475
+  line       x1: 100, y1: 620, x2: 720, y2: 620, stroke_width: 15.0
+  svg        file: 'spanner.svg', x: 100, y: 75
+  png        file: 'shiny-purse.png', x: 250, y: 75 # raster can still be used too
+  png        file: 'shiny-purse.png', x: 250, y: 250, mask: :red # still renders as raster
+  # We can still rasterize whenever we want
+  save_png prefix: 'backend_'
+
+  showcase file: 'showcase.png', fill_color: 'white'
+
+  # And our PDFs will be vectorized .
+  save_pdf file: 'backend_vectorized.pdf', gap: 5
+
+  # This one is a known issue. Masking an SVG onto an SVG backend is still buggy.
+  # svg        file: 'glass-heart.svg', x: 100, y: 200, width: 100, height: 100, mask: :sangria
+end

data/samples/basic.rb

@@ -1,19 +1,19 @@
-require 'squib'
-
-data = { 'name' => ['Thief', 'Grifter', 'Mastermind'],
-        'level' => [1, 2, 3] }
-
-Squib::Deck.new(width: 825, height: 1125, cards: 3) do
-  background color: :white
-  rect x: 38, y: 38, width: 750, height: 1050, radius: 38
-  rect x: 75, y: 75, width: 128, height: 128, radius: 25
-
-  text str: data['name'], x: 220, y: 78, font: 'Arial 18'
-  text str: data['level'], x: 75, y: 85, width: 128,
-       font: 'Arial 24', align: :center
-
-  png range: [0, 2], file: 'shiny-purse.png', x: 620, y: 75
-  svg range: 1..2, file: 'spanner.svg', x: 620, y: 218
-
-  save prefix: 'basic_', format: :png
-end
+require 'squib'
+
+data = { 'name' => ['Thief', 'Grifter', 'Mastermind'],
+        'level' => [1, 2, 3] }
+
+Squib::Deck.new(width: 825, height: 1125, cards: 3) do
+  background color: :white
+  rect x: 38, y: 38, width: 750, height: 1050, radius: 38
+  rect x: 75, y: 75, width: 128, height: 128, radius: 25
+
+  text str: data['name'], x: 220, y: 78, font: 'Arial 18'
+  text str: data['level'], x: 75, y: 85, width: 128,
+       font: 'Arial 24', align: :center
+
+  png range: [0, 2], file: 'shiny-purse.png', x: 620, y: 75
+  svg range: 1..2, file: 'spanner.svg', x: 620, y: 218
+
+  save prefix: 'basic_', format: :png
+end

data/samples/build_groups/build_groups.rb

@@ -1,36 +1,36 @@
-require 'squib'
-
-Squib::Deck.new(width: 75, height: 75, cards: 2) do
-  # puts "Groups enabled by environment: #{groups.to_a}"
-
-  text str: ['A', 'B']
-
-  build :print_n_play do
-    rect
-    save_sheet prefix: 'build_groups_bw_'
-  end
-
-  build :color do
-    rect stroke_color: :red, dash: '5 5'
-    save_png prefix: 'build_groups_color_'
-  end
-
-  build :test do
-    save_png range: 0, prefix: 'build_groups_'
-  end
-
-end
-
-# Here's how you can run this on the command line:
-#
-# --- OSX/Linux (bash or similar shells) ---
-# $ ruby build_groups.rb
-# $ SQUIB_BUILD=color ruby build_groups.rb
-# $ SQUIB_BUILD=print_n_play,test ruby build_groups.rb
-#
-# --- Windows CMD ---
-# $ ruby build_groups.rb
-# $ set SQUIB_BUILD=color && ruby build_groups.rb
-# $ set SQUIB_BUILD=print_n_play,test && ruby build_groups.rb
-#
-# Or, better yet... use a Rakefile like the one provided in this gist!
+require 'squib'
+
+Squib::Deck.new(width: 75, height: 75, cards: 2) do
+  # puts "Groups enabled by environment: #{groups.to_a}"
+
+  text str: ['A', 'B']
+
+  build :print_n_play do
+    rect
+    save_sheet prefix: 'build_groups_bw_'
+  end
+
+  build :color do
+    rect stroke_color: :red, dash: '5 5'
+    save_png prefix: 'build_groups_color_'
+  end
+
+  build :test do
+    save_png range: 0, prefix: 'build_groups_'
+  end
+
+end
+
+# Here's how you can run this on the command line:
+#
+# --- OSX/Linux (bash or similar shells) ---
+# $ ruby build_groups.rb
+# $ SQUIB_BUILD=color ruby build_groups.rb
+# $ SQUIB_BUILD=print_n_play,test ruby build_groups.rb
+#
+# --- Windows CMD ---
+# $ ruby build_groups.rb
+# $ set SQUIB_BUILD=color && ruby build_groups.rb
+# $ set SQUIB_BUILD=print_n_play,test && ruby build_groups.rb
+#
+# Or, better yet... use a Rakefile like the one provided in this gist!

data/samples/colors/_colors.rb

@@ -1,44 +1,44 @@
-require 'squib'
-
-Squib::Deck.new(width: 825, height: 1125, cards: 1) do
-  background color: :white
-
-  y = 0
-  text color: '#f00', str: '3-hex', x: 50, y: y += 50
-  text color: '#f00', str: '3-hex (alpha)', x: 50, y: y += 50
-  text color: '#ff0000', str: '6-hex', x: 50, y: y += 50
-  text color: '#ff000099', str: '8-hex(alpha)', x: 50, y: y += 50
-  text color: '#ffff00000000', str: '12-hex', x: 50, y: y += 50
-  text color: '#ffff000000009999', str: '12-hex (alpha)', x: 50, y: y += 50
-  text color: :burnt_orange, str: 'Symbols of constants too', x: 50, y: y += 50
-  text color: '(0,0)(400,0) blue@0.0 red@1.0', str: 'Linear gradients!', x: 50, y: y += 50
-  text color: '(200,500,10)(200,500,100) blue@0.0 red@1.0', str: 'Radial gradients!', x: 50, y: y += 50
-  # see gradients.rb sample for more on gradients
-
-  save_png prefix: 'colors_'
-end
-
-# This script generates a table of the built-in constants
-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
-  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 > deck_height
-      x += w
-      y = 0
-    end
-  end
-  save_png prefix: 'color_constants_'
-end
+require 'squib'
+
+Squib::Deck.new(width: 825, height: 1125, cards: 1) do
+  background color: :white
+
+  y = 0
+  text color: '#f00', str: '3-hex', x: 50, y: y += 50
+  text color: '#f00', str: '3-hex (alpha)', x: 50, y: y += 50
+  text color: '#ff0000', str: '6-hex', x: 50, y: y += 50
+  text color: '#ff000099', str: '8-hex(alpha)', x: 50, y: y += 50
+  text color: '#ffff00000000', str: '12-hex', x: 50, y: y += 50
+  text color: '#ffff000000009999', str: '12-hex (alpha)', x: 50, y: y += 50
+  text color: :burnt_orange, str: 'Symbols of constants too', x: 50, y: y += 50
+  text color: '(0,0)(400,0) blue@0.0 red@1.0', str: 'Linear gradients!', x: 50, y: y += 50
+  text color: '(200,500,10)(200,500,100) blue@0.0 red@1.0', str: 'Radial gradients!', x: 50, y: y += 50
+  # see gradients.rb sample for more on gradients
+
+  save_png prefix: 'colors_'
+end
+
+# This script generates a table of the built-in constants
+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
+  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 > deck_height
+      x += w
+      y = 0
+    end
+  end
+  save_png prefix: 'color_constants_'
+end