squib 0.6.0 → 0.7.0

data/samples/color_shortcuts.rb

@@ -0,0 +1,6 @@
+require 'squib'
+
+Squib::Deck.new do
+  circle color: 'black', fill_color: 'black'
+  save_png prefix: 'color_shortcuts_'
+end

data/samples/csv_import.rb

@@ -1,18 +1,18 @@
-require 'squib'
-
-Squib::Deck.new(cards: 2) do
-  background color: :white
-
-  # Outputs a hash of arrays with the header names as keys
-  data = csv file: 'sample.csv'
-  text str: data['Type'], x: 250, y: 55, font: 'Arial 54'
-  text str: data['Level'], x: 65, y: 65, font: 'Arial 72'
-
-  save format: :png, prefix: 'sample_csv_'
-
-  # You can also specify the sheet, starting at 0
-  data = xlsx file: 'sample.xlsx', sheet: 2
-end
-
-# CSV is also a Squib-module-level function, so this also works:
-data = Squib.csv file: 'sample.csv'
+require 'squib'
+
+Squib::Deck.new(cards: 2) do
+  background color: :white
+
+  # Outputs a hash of arrays with the header names as keys
+  data = csv file: 'sample.csv'
+  text str: data['Type'], x: 250, y: 55, font: 'Arial 54'
+  text str: data['Level'], x: 65, y: 65, font: 'Arial 72'
+
+  save format: :png, prefix: 'sample_csv_'
+
+  # You can also specify the sheet, starting at 0
+  data = xlsx file: 'sample.xlsx', sheet: 2
+end
+
+# CSV is also a Squib-module-level function, so this also works:
+data = Squib.csv file: 'sample.csv'

data/samples/custom-config.yml

@@ -1,5 +1,5 @@
-progress_bars: true
-text_hint: '#FF0000'
-custom_colors:
-  foo: '#ccc'
-img_dir: customconfig-imgdir
+progress_bars: true
+text_hint: '#FF0000'
+custom_colors:
+  foo: '#ccc'
+img_dir: customconfig-imgdir

data/samples/custom_config.rb

@@ -1,18 +1,18 @@
-require 'squib'
-
-Squib::Deck.new(config: 'custom-config.yml') do
-  # Custom color defined in our config
-  background color: :foo
-
-  # Hints can be turned on in the config file
-  text str: 'The Title', x: 0, y: 78, width: 825,
-       font: 'Arial 72', align: :center
-
-  # Progress bars are shown for these commands
-  # And images are taken from config-imgdir
-  png file: 'shiny-purse2.png', x: 620, y: 75
-  svg file: 'spanner2.svg', x: 620, y: 218
-  save_png prefix: 'custom-config_'
-  save_pdf file: 'custom-config-out.pdf'
-
-end
+require 'squib'
+
+Squib::Deck.new(config: 'custom-config.yml') do
+  # Custom color defined in our config
+  background color: :foo
+
+  # Hints can be turned on in the config file
+  text str: 'The Title', x: 0, y: 78, width: 825,
+       font: 'Arial 72', align: :center
+
+  # Progress bars are shown for these commands
+  # And images are taken from img_dir, not the cwd.
+  png file: 'shiny-purse2.png', x: 620, y: 75
+  svg file: 'spanner2.svg', x: 620, y: 218
+  save_png prefix: 'custom-config_'
+  save_pdf file: 'custom-config-out.pdf'
+
+end

data/samples/draw_shapes.rb

@@ -1,35 +1,45 @@
-require 'squib'
-
-Squib::Deck.new do
-  background color: :white
-  rect x: 300, y: 300, width: 400, height: 400,
-       fill_color: :blue, stroke_color: :red, stroke_width: 50.0
-
-  circle x: 600, y: 600, radius: 75,
-         fill_color: :gray, stroke_color: :green, stroke_width: 8.0
-
-  triangle x1: 50, y1: 50,
-           x2: 150, y2: 150,
-           x3: 75, y3: 250
-
-  line x1: 50, y1: 550,
-       x2: 150, y2: 650,
-       stroke_width: 25.0
-
-  curve x1: 50,  y1: 850, cx1: 150, cy1: 700,
-        x2: 625, y2: 900, cx2: 150, cy2: 700,
-        stroke_width: 12.0, stroke_color: :cyan,
-        fill_color: :burgundy
-
-  ellipse x: 50, y: 925, width: 200, height: 100,
-          stroke_width: 5.0, stroke_color: :cyan,
-          fill_color: :burgundy
-
-  star x: 300, y: 1000, n: 5, inner_radius: 10, outer_radius: 25,
-       fill_color: :burgundy, stroke_color: :cyan, stroke_width: 3
-
-  polygon x: 500, y: 1000, n: 5, radius: 25, angle: Math::PI / 2,
-          fill_color: :burgundy, stroke_color: :cyan, stroke_width: 2
-
-  save_png prefix: 'shape_'
-end
+require 'squib'
+
+Squib::Deck.new do
+  background color: :white
+
+  rect x: 300, y: 100, width: 200, height: 50, dash: '4 2'
+
+  rect x: 300, y: 300, width: 400, height: 400,
+       fill_color: :blue, stroke_color: :red, stroke_width: 50.0,
+       join: 'bevel'
+
+  circle x: 600, y: 600, radius: 75,
+         fill_color: :gray, stroke_color: :green, stroke_width: 8.0
+
+  triangle x1: 50, y1: 50,
+           x2: 150, y2: 150,
+           x3: 75, y3: 250,
+           fill_color: :gray, stroke_color: :green, stroke_width: 3.0
+
+  line x1: 50, y1: 550,
+       x2: 150, y2: 650,
+       stroke_width: 25.0
+
+  curve x1: 50,  y1: 850, cx1: 150, cy1: 700,
+        x2: 625, y2: 900, cx2: 150, cy2: 700,
+        stroke_width: 12.0, stroke_color: :cyan,
+        fill_color: :burgundy, cap: 'round'
+
+  ellipse x: 50, y: 925, width: 200, height: 100,
+          stroke_width: 5.0, stroke_color: :cyan,
+          fill_color: :burgundy
+
+  star x: 300, y: 1000, n: 5, inner_radius: 15, outer_radius: 40,
+       fill_color: :cyan, stroke_color: :burgundy, stroke_width: 5
+
+  #default draw is fill-then-stroke. Can be changed to stroke-then-fill
+  star x: 375, y: 1000, n: 5, inner_radius: 15, outer_radius: 40,
+       fill_color: :cyan, stroke_color: :burgundy,
+       stroke_width: 5, stroke_strategy: :stroke_first
+
+  polygon x: 500, y: 1000, n: 5, radius: 25, angle: Math::PI / 2,
+          fill_color: :cyan, stroke_color: :burgundy, stroke_width: 2
+
+  save_png prefix: 'shape_'
+end

data/samples/embed_text.rb

@@ -1,90 +1,88 @@
-require 'squib'
-
-Squib::Deck.new do
-  background color: :white
-  rect x: 0, y: 0, width: 825, height: 1125, stroke_width: 2.0
-
-  embed_text = 'Take 11 :tool: and gain 2 :health:. Take <b>2</b> :tool: <i>and gain 3 :purse: if level 2.</i>'
-  text(str: embed_text, font: 'Sans 21',
-       x: 0, y: 0, width: 180, hint: :red,
-       align: :left, ellipsize: false, justify: false) do |embed|
-    # Notice how we use dx and dy to adjust the icon to not rest directly on the baseline
-    embed.svg key: ':tool:',   width: 28, height: 28, dx:  0, dy: 4, file: 'spanner.svg'
-    embed.svg key: ':health:', width: 28, height: 28, dx: -2, dy: 4, file: 'glass-heart.svg'
-    embed.png key: ':purse:',  width: 28, height: 28, dx:  0, dy: 4, file: 'shiny-purse.png'
-  end
-
-  embed_text = 'Middle align: Take 1 :tool: and gain 2 :health:. Take 2 :tool: and gain 3 :purse:'
-  text(str: embed_text, font: 'Sans 21',
-       x: 200, y: 0, width: 180, height: 300, valign: :middle,
-       align: :left, ellipsize: false, justify: false, hint: :cyan) do |embed|
-    embed.svg key: ':tool:',   width: 28, height: 28, file: 'spanner.svg'
-    embed.svg key: ':health:', width: 28, height: 28, file: 'glass-heart.svg'
-    embed.png key: ':purse:',  width: 28, height: 28, file: 'shiny-purse.png'
-  end
-
-  embed_text = 'This :tool: aligns on the bottom properly. :purse:'
-  text(str: embed_text, font: 'Sans 21',
-       x: 400, y: 0, width: 180, height: 300, valign: :bottom,
-       align: :left, ellipsize: false, justify: false, hint: :green) do |embed|
-    embed.svg key: ':tool:',   width: 28, height: 28, file: 'spanner.svg'
-    embed.svg key: ':health:', width: 28, height: 28, file: 'glass-heart.svg'
-    embed.png key: ':purse:',  width: 28, height: 28, file: 'shiny-purse.png'
-  end
-
-  embed_text = 'Wrapping multiples: These are 1 :tool::tool::tool: and these are multiple :tool::tool: :tool::tool:'
-  text(str: embed_text, font: 'Sans 21',
-       x: 600, y: 0, width: 180, height: 300, valign: :middle,
-       align: :left, ellipsize: false, justify: false, hint: :cyan) do |embed|
-    embed.svg key: ':tool:',   width: 28, height: 28, file: 'spanner.svg'
-  end
-
-  embed_text = ':tool:Justify will :tool: work too, and :purse: with more words just for fun'
-  text(str: embed_text, font: 'Sans 21',
-       x: 0, y: 320, width: 180, height: 300, valign: :bottom,
-       align: :left, ellipsize: false, justify: true, hint: :magenta) do |embed|
-    embed.svg key: ':tool:',   width: 28, height: 28, file: 'spanner.svg'
-    embed.svg key: ':health:', width: 28, height: 28, file: 'glass-heart.svg'
-    embed.png key: ':purse:',  width: 28, height: 28, file: 'shiny-purse.png'
-  end
-
-  embed_text = 'Right-aligned works :tool: with :health: and :purse:'
-  text(str: embed_text, font: 'Sans 21',
-       x: 200, y: 320, width: 180, height: 300, valign: :bottom,
-       align: :right, ellipsize: false, justify: false, hint: :magenta) do |embed|
-    embed.svg key: ':tool:',   width: 28, height: 28, file: 'spanner.svg'
-    embed.svg key: ':health:', width: 28, height: 28, file: 'glass-heart.svg'
-    embed.png key: ':purse:',  width: 28, height: 28, file: 'shiny-purse.png'
-  end
-
-  embed_text = ':tool:Center-aligned works :tool: with :health: and :purse:'
-  text(str: embed_text, font: 'Sans 21',
-       x: 400, y: 320, width: 180, height: 300,
-       align: :center, ellipsize: false, justify: false, hint: :magenta) do |embed|
-    embed.svg key: ':tool:',   width: 28, height: 28, data: File.read('spanner.svg')
-    embed.svg key: ':health:', width: 28, height: 28, file: 'glass-heart.svg'
-    embed.png key: ':purse:',  width: 28, height: 28, file: 'shiny-purse.png'
-  end
-
-  embed_text = 'Markup --- and typography replacements --- with ":tool:" icons <i>won\'t</i> fail'
-  text(str: embed_text, font: 'Serif 18', markup: true,
-       x: 600, y: 320, width: 180, height: 300,
-       align: :center, hint: :magenta) do |embed|
-    embed.svg key: ':tool:',   width: 28, height: 28, file: 'spanner.svg'
-  end
-
-  save_png prefix: 'embed_'
-end
-
-Squib::Deck.new(cards: 3) do
-
-  embed_text = 'Take 1 :tool: and gain 2 :health:.'
-  text(str: embed_text, font: 'Sans', font_size: [18, 32, 45],
-       x: 0, y: 0, width: 180, height: 300, valign: :bottom,
-       align: :left, ellipsize: false, justify: false, hint: :cyan) do |embed|
-    embed.svg key: ':tool:',   width: 28, height: 28, file: 'spanner.svg'
-    embed.svg key: ':health:', width: 28, height: 28, file: 'glass-heart.svg'
-  end
-  save_png prefix: 'embed_multi_'
-  save_sheet prefix: 'embed_multisheet_', columns: 3
-end
+require 'squib'
+
+Squib::Deck.new do
+  background color: :white
+  rect x: 0, y: 0, width: 825, height: 1125, stroke_width: 2.0
+
+  embed_text = 'Take 11 :tool: and gain 2 :health:. Take <b>2</b> :tool: <i>and gain 3 :purse: if level 2.</i>'
+  text(str: embed_text, font: 'Sans 21',
+       x: 0, y: 0, width: 180, hint: :red,
+       align: :left, ellipsize: false, justify: false) do |embed|
+    # Notice how we use dx and dy to adjust the icon to not rest directly on the baseline
+    embed.svg key: ':tool:',   width: 28, height: 28, dx:  0, dy: 4, file: 'spanner.svg'
+    embed.svg key: ':health:', width: 28, height: 28, dx: -2, dy: 4, file: 'glass-heart.svg'
+    embed.png key: ':purse:',  width: 28, height: 28, dx:  0, dy: 4, file: 'shiny-purse.png'
+  end
+
+  embed_text = 'Middle align: Take 1 :tool: and gain 2 :health:. Take 2 :tool: and gain 3 :purse:'
+  text(str: embed_text, font: 'Sans 21',
+       x: 200, y: 0, width: 180, height: 300, valign: :middle,
+       align: :left, ellipsize: false, justify: false, hint: :cyan) do |embed|
+    embed.svg key: ':tool:',   width: 28, height: 28, file: 'spanner.svg'
+    embed.svg key: ':health:', width: 28, height: 28, file: 'glass-heart.svg'
+    embed.png key: ':purse:',  width: 28, height: 28, file: 'shiny-purse.png'
+  end
+
+  embed_text = 'This :tool: aligns on the bottom properly. :purse:'
+  text(str: embed_text, font: 'Sans 21',
+       x: 400, y: 0, width: 180, height: 300, valign: :bottom,
+       align: :left, ellipsize: false, justify: false, hint: :green) do |embed|
+    embed.svg key: ':tool:',   width: 28, height: 28, file: 'spanner.svg'
+    embed.svg key: ':health:', width: 28, height: 28, file: 'glass-heart.svg'
+    embed.png key: ':purse:',  width: 28, height: 28, file: 'shiny-purse.png'
+  end
+
+  embed_text = 'Wrapping multiples: These are 1 :tool::tool::tool: and these are multiple :tool::tool: :tool::tool:'
+  text(str: embed_text, font: 'Sans 21',
+       x: 600, y: 0, width: 180, height: 300, valign: :middle,
+       align: :left, ellipsize: false, justify: false, hint: :cyan) do |embed|
+    embed.svg key: ':tool:',   width: 28, height: 28, file: 'spanner.svg'
+  end
+
+  embed_text = ':tool:Justify will :tool: work too, and :purse: with more words just for fun'
+  text(str: embed_text, font: 'Sans 21',
+       x: 0, y: 320, width: 180, height: 300, valign: :bottom,
+       align: :left, ellipsize: false, justify: true, hint: :magenta) do |embed|
+    embed.svg key: ':tool:',   width: 28, height: 28, file: 'spanner.svg'
+    embed.svg key: ':health:', width: 28, height: 28, file: 'glass-heart.svg'
+    embed.png key: ':purse:',  width: 28, height: 28, file: 'shiny-purse.png'
+  end
+
+  embed_text = 'Right-aligned works :tool: with :health: and :purse:'
+  text(str: embed_text, font: 'Sans 21',
+       x: 200, y: 320, width: 180, height: 300, valign: :bottom,
+       align: :right, ellipsize: false, justify: false, hint: :magenta) do |embed|
+    embed.svg key: ':tool:',   width: 28, height: 28, file: 'spanner.svg'
+    embed.svg key: ':health:', width: 28, height: 28, file: 'glass-heart.svg'
+    embed.png key: ':purse:',  width: 28, height: 28, file: 'shiny-purse.png'
+  end
+
+  embed_text = ':tool:Center-aligned works :tool: with :health: and :purse:'
+  text(str: embed_text, font: 'Sans 21',
+       x: 400, y: 320, width: 180, height: 300,
+       align: :center, ellipsize: false, justify: false, hint: :magenta) do |embed|
+    embed.svg key: ':tool:',   width: 28, height: 28, data: File.read('spanner.svg')
+    embed.svg key: ':health:', width: 28, height: 28, file: 'glass-heart.svg'
+    embed.png key: ':purse:',  width: 28, height: 28, file: 'shiny-purse.png'
+  end
+
+  embed_text = 'Markup --- and typography replacements --- with ":tool:" icons <i>won\'t</i> fail'
+  text(str: embed_text, font: 'Serif 18', markup: true,
+       x: 600, y: 320, width: 180, height: 300,
+       align: :center, hint: :magenta) do |embed|
+    embed.svg key: ':tool:',   width: 28, height: 28, file: 'spanner.svg'
+  end
+
+  save_png prefix: 'embed_'
+end
+
+Squib::Deck.new(cards: 3) do
+  str = 'Take 1 :tool: and gain 2 :health:.'
+  text(str: str, font: 'Sans', font_size: [18, 26, 35],
+       x: 0, y: 0, width: 180, height: 300, valign: :bottom,
+       align: :left, ellipsize: false, justify: false, hint: :cyan) do |embed|
+    embed.svg key: ':tool:',   width: [28, 42, 56], height: [28, 42, 56], file: 'spanner.svg'
+    embed.svg key: ':health:', width: [28, 42, 56], height: [28, 42, 56], file: 'glass-heart.svg'
+  end
+  save_sheet prefix: 'embed_multisheet_', columns: 3
+end

data/samples/hand.rb

@@ -1,24 +1,24 @@
-require 'squib'
-
-Squib::Deck.new(cards: 8, layout: 'playing-card.yml') do
-  background color: :cyan
-  rect x: 37, y: 37, width: 750, height: 1050, fill_color: :black, radius: 25
-  rect x: 75, y: 75, width: 675, height: 975, fill_color: :white, radius: 20
-  text str: ('A'..'Z').to_a, layout: :bonus_ul, font: 'Sans bold 100'
-
-  # Defaults are sensible
-  hand #saves to _output/hand.png
-
-  # Here's a prettier version:
-  #  - Each card is trimmed with rounded corners
-  #  - Zero radius means cards rotate about the bottom of the card
-  #  - Cards are shown in reverse order
-  hand trim: 37.5, trim_radius: 25,
-       radius: 0,
-       range: 7.downto(0),
-       file: 'hand_pretty.png'
-
-  # Tip: you can have the top card be on the left by reversing the range
-  #  angle_range: (Math::PI / 4)..(Math::PI / -4)
-end
-
+require 'squib'
+
+Squib::Deck.new(cards: 8, layout: 'playing-card.yml') do
+  background color: :cyan
+  rect x: 37, y: 37, width: 750, height: 1050, fill_color: :black, radius: 25
+  rect x: 75, y: 75, width: 675, height: 975, fill_color: :white, radius: 20
+  text str: ('A'..'Z').to_a, layout: :bonus_ul, font: 'Sans bold 100'
+
+  # Defaults are sensible
+  hand #saves to _output/hand.png
+
+  # Here's a prettier version:
+  #  - Each card is trimmed with rounded corners
+  #  - Zero radius means cards rotate about the bottom of the card
+  #  - Cards are shown in reverse order
+  hand trim: 37.5, trim_radius: 25,
+       radius: 0,
+       range: 7.downto(0),
+       file: 'hand_pretty.png'
+
+  # Tip: you can have the top card be on the left by reversing the range
+  #  angle_range: (Math::PI / 4)..(Math::PI / -4)
+end
+

data/samples/layouts.rb

@@ -1,61 +1,62 @@
-# encoding: utf-8
-require 'squib'
-
-Squib::Deck.new(layout: 'custom-layout.yml') do
-  background color: :white
-  hint text: :cyan
-
-  # Layouts are YAML files that specify any option as a default
-  rect layout: :frame
-
-  # You can also override a given layout entry in the command
-  circle layout: :frame, x: 50, y: 50, radius: 25
-
-  # Lots of commands have the :layout option
-  text str: 'The Title', layout: :title
-
-  # Layouts also support YAML merge keys toreuse settings
-  svg file: 'spanner.svg',     layout: :icon_left
-  png file: 'shiny-purse.png', layout: :icon_middle
-  svg file: 'spanner.svg',     layout: :icon_right
-
-  # Squib has its own, richer merge key: "extends"
-  rect fill_color: :black, layout: :bonus
-  rect fill_color: :white, layout: :bonus_inner
-  text str: 'Extends!',    layout: :bonus_text
-
-  # Strings can also be used to specify a layout (e.g. from a data file)
-  text str: 'subtitle', layout: 'subtitle'
-
-  # For debugging purposes, you can always print out the loaded layout
-  #require 'pp'
-  #pp @layout
-
-  save_png prefix: 'layout_'
-end
-
-Squib::Deck.new(layout: ['custom-layout.yml', 'custom-layout2.yml']) do
-  text str: 'The Title',       layout: :title       # from custom-layout.yml
-  text str: 'The Subtitle',    layout: :subtitle    # redefined in custom-layout2.yml
-  text str: 'The Description', layout: :description # from custom-layout2.yml
-  save_png prefix: 'layout2_'
-end
-
-# Built-in layouts are easy to use and extend
-Squib::Deck.new(layout: 'playing-card.yml') do
-  text str: "A\u2660",      layout: :bonus_ul, font: 'Sans bold 100', hint: :red
-  text str: "A\u2660",      layout: :bonus_lr, font: 'Sans bold 100', hint: :red
-  text str: "artwork here", layout: :art, hint: :red
-  save_png prefix: 'layout_builtin_playing_card_'
-end
-
-# Built-in layouts are easy to use and extend
-Squib::Deck.new(layout: 'hand.yml') do
-  %w(title bonus1 bonus2 bonus3 bonus4 bonus5
-    description snark art).each do |icon|
-    text str: icon.capitalize, layout: icon,
-         hint: :red, valign: 'middle', align: 'center'
-  end
-  png file: 'pokercard.png', alpha: 0.5
-  save_png prefix: 'layout_builtin_hand_'
-end
+# encoding: utf-8
+require 'squib'
+require 'pp'
+
+Squib::Deck.new(layout: 'custom-layout.yml') do
+  background color: :white
+  hint text: :cyan
+
+  # Layouts are YAML files that specify any option as a default
+  rect layout: :frame
+
+  # You can also override a given layout entry in the command
+  circle layout: :frame, x: 50, y: 50, radius: 25
+
+  # Lots of commands have the :layout option
+  text str: 'The Title', layout: :title
+
+  # Layouts also support YAML merge keys toreuse settings
+  svg file: 'spanner.svg',     layout: :icon_left
+  png file: 'shiny-purse.png', layout: :icon_middle
+  svg file: 'spanner.svg',     layout: :icon_right
+
+  # Squib has its own, richer merge key: "extends"
+  rect fill_color: :black, layout: :bonus
+  rect fill_color: :white, layout: :bonus_inner
+  text str: 'Extends!',    layout: :bonus_text
+
+  # Strings can also be used to specify a layout (e.g. from a data file)
+  text str: 'subtitle', layout: 'subtitle'
+
+  # For debugging purposes, you can always print out the loaded layout
+  # require 'pp'
+  # pp layout
+
+  save_png prefix: 'layout_'
+end
+
+Squib::Deck.new(layout: ['custom-layout.yml', 'custom-layout2.yml']) do
+  text str: 'The Title',       layout: :title       # from custom-layout.yml
+  text str: 'The Subtitle',    layout: :subtitle    # redefined in custom-layout2.yml
+  text str: 'The Description', layout: :description # from custom-layout2.yml
+  save_png prefix: 'layout2_'
+end
+
+# Built-in layouts are easy to use and extend
+Squib::Deck.new(layout: 'playing-card.yml') do
+  text str: "A\u2660",      layout: :bonus_ul, font: 'Sans bold 100', hint: :red
+  text str: "A\u2660",      layout: :bonus_lr, font: 'Sans bold 100', hint: :red
+  text str: "artwork here", layout: :art, hint: :red
+  save_png prefix: 'layout_builtin_playing_card_'
+end
+
+# Built-in layouts are easy to use and extend
+Squib::Deck.new(layout: 'hand.yml') do
+  %w(title bonus1 bonus2 bonus3 bonus4 bonus5
+    description snark art).each do |icon|
+    text str: icon.capitalize, layout: icon,
+         hint: :red, valign: 'middle', align: 'center'
+  end
+  png file: 'pokercard.png', alpha: 0.5
+  save_png prefix: 'layout_builtin_hand_'
+end