squib 0.8.0 → 0.9.0

data/samples/excel.rb

@@ -1,55 +1,55 @@
-require 'squib'
-
-Squib::Deck.new(cards: 3) do
-  background color: :white
-
-  # Reads the first sheet by default (sheet 0)
-  # Outputs a hash of arrays with the header names as keys
-  data = xlsx file: 'sample.xlsx'
-
-  text str: data['Name'], x: 250, y: 55, font: 'Arial 54'
-  text str: data['Level'], x: 65, y: 65, font: 'Arial 72'
-  text str: data['Description'], x: 65, y: 600, font: 'Arial 36'
-
-  save format: :png, prefix: 'sample_excel_' #save to individual pngs
-end
-
-# xlsx is also a Squib-module-level function, so this also works:
-data      = Squib.xlsx file: 'explode_quantities.xlsx' # 2 rows...
-num_cards = data['Name'].size                          #          ...but 4 cards!
-
-Squib::Deck.new(cards: num_cards) do
-  background color: :white
-  rect # card border
-  text str: data['Name'], font: 'Arial 54'
-  save_sheet  prefix: 'sample_xlsx_qty_', columns: 4
-end
-
-
-# Here's another example, a bit more realistic. Here's what's going on:
-#   * We call xlsx from Squib directly - BEFORE Squib::Deck creation. This
-#     allows us to infer the number of cards based on the size of the "Name"
-#     field
-#   * We make use of quantity explosion. Fields named "Qty" or "Quantity"
-#     (any capitalization), or any other in the "qty_header" get expanded by the
-#     number given
-#   * We also make sure that trailing and leading whitespace is stripped
-#     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|
-  case header
-  when 'Cost'
-    "$#{value}k" # e.g. "3" becomes "$3k"
-  else
-    value # always return the original value if you didn't do anything to it
-  end
-end
-
-Squib::Deck.new(cards: resource_data['Name'].size) do
-  background color: :white
-  rect width: :deck, height: :deck
-  text str: resource_data['Name'], align: :center, width: :deck, hint: 'red'
-  text str: resource_data['Cost'], align: :right, width: :deck, hint: 'red'
-  save_sheet prefix: 'sample_excel_resources_' #save to a whole sheet
-end
+require 'squib'
+
+Squib::Deck.new(cards: 3) do
+  background color: :white
+
+  # Reads the first sheet by default (sheet 0)
+  # Outputs a hash of arrays with the header names as keys
+  data = xlsx file: 'sample.xlsx'
+
+  text str: data['Name'], x: 250, y: 55, font: 'Arial 54'
+  text str: data['Level'], x: 65, y: 65, font: 'Arial 72'
+  text str: data['Description'], x: 65, y: 600, font: 'Arial 36'
+
+  save format: :png, prefix: 'sample_excel_' #save to individual pngs
+end
+
+# xlsx is also a Squib-module-level function, so this also works:
+data      = Squib.xlsx file: 'explode_quantities.xlsx' # 2 rows...
+num_cards = data['Name'].size                          #          ...but 4 cards!
+
+Squib::Deck.new(cards: num_cards) do
+  background color: :white
+  rect # card border
+  text str: data['Name'], font: 'Arial 54'
+  save_sheet  prefix: 'sample_xlsx_qty_', columns: 4
+end
+
+
+# Here's another example, a bit more realistic. Here's what's going on:
+#   * We call xlsx from Squib directly - BEFORE Squib::Deck creation. This
+#     allows us to infer the number of cards based on the size of the "Name"
+#     field
+#   * We make use of quantity explosion. Fields named "Qty" or "Quantity"
+#     (any capitalization), or any other in the "qty_header" get expanded by the
+#     number given
+#   * We also make sure that trailing and leading whitespace is stripped
+#     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|
+  case header
+  when 'Cost'
+    "$#{value}k" # e.g. "3" becomes "$3k"
+  else
+    value # always return the original value if you didn't do anything to it
+  end
+end
+
+Squib::Deck.new(cards: resource_data['Name'].size) do
+  background color: :white
+  rect width: :deck, height: :deck
+  text str: resource_data['Name'], align: :center, width: :deck, hint: 'red'
+  text str: resource_data['Cost'], align: :right, width: :deck, hint: 'red'
+  save_sheet prefix: 'sample_excel_resources_' #save to a whole sheet
+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/images/_images.rb

@@ -0,0 +1,104 @@
+require 'squib'
+require 'squib/sample_helpers'
+
+Squib::Deck.new(width: 1000, height: 3000) do
+  draw_graph_paper width, height
+
+  sample "This a PNG.\nNo scaling is done by default." do |x, y|
+    png file: 'angler-fish.png', x: x, y: y
+  end
+
+  sample 'PNGs can be upscaled, but they will emit an antialias warning (unless you turn it off in the config.yml)' do |x,y|
+    png file: 'angler-fish.png', x: x, y: y, width: 150, height: 150
+  end
+
+  sample 'SVGs can be loaded from a file (left) or from straight XML (right). They can also be scaled to any size.' do |x,y|
+    svg file: 'robot-golem.svg', x: x, y: y, width: 100, height: 100
+    svg data: File.read('robot-golem.svg'), width: 100, height: 100,
+        x: x + 200, y: y
+  end
+
+  sample 'PNG and SVG can be auto-scaled by one side and setting the other to :scale' do |x,y|
+    svg file: 'robot-golem.svg', x: x,       y: y, width: 50,     height: :scale
+    svg file: 'robot-golem.svg', x: x + 50,  y: y, width: :scale, height: 50
+
+    png file: 'angler-fish.png', x: x + 200, y: y, width: 50,     height: :scale
+    png file: 'angler-fish.png', x: x + 250, y: y, width: :scale, height: 50
+  end
+
+  sample 'PNGs can be cropped. To work from sprite sheets, you can set crop coordinates to PNG images. Rounded corners supported too.' do |x,y|
+    png file: 'sprites.png', x: x - 50, y: y - 50          # entire sprite sheet
+    rect x: x - 50, y: y - 50, width: 100, height: 100,    # draw the crop line
+         radius: 15, dash: '3 3', stroke_color: 'red', stroke_width: 3
+    text str: '➜', font: 'Sans Bold 36', x: x + 150, y: y - 35
+    png file: 'sprites.png', x: x + 200, y: y - 50,        # just the robot golem image
+        crop_x: 0, crop_y: 0, crop_corner_radius: 15,
+        crop_width: 100, crop_height: 100
+
+    png file: 'sprites.png', x: x - 50, y: y + 50     # entire sprite sheet again
+    rect x: x + 14, y: y + 50, width: 65, height: 65, # highlight the crop
+         radius: 25, dash: '3 3', stroke_color: 'red', stroke_width: 3
+    text str: '➜', font: 'Sans Bold 36', x: x + 150, y: y + 50
+    png file: 'sprites.png', x: x + 225, y: y + 50,   # just the drakkar ship image, rotated
+        crop_x: 64, crop_y: 0, crop_corner_x_radius: 25, crop_corner_y_radius: 25,
+        crop_width: 64, crop_height: 64, angle: Math::PI / 6
+  end
+
+  sample 'SVGs can be cropped too.' do |x,y|
+    svg file: 'robot-golem.svg', x: x, y: y, width: 100, height: 100,
+        crop_x: 40, crop_y: 0, crop_width: 50, crop_height: 50
+  end
+
+  sample 'Images can be flipped about their center.' do |x,y|
+    png file: 'angler-fish.png', x: x, y: y, flip_vertical: true, flip_horizontal: true
+    svg file: 'robot-golem.svg', x: x + 200, y: y, width: 100, height: 100,
+        flip_horizontal: true
+  end
+
+  sample 'SVG can be limited to rendering to a single object if the SVG ID is set. If you look in this SVG file, the black backdrop has ID #backdrop.' do |x,y|
+    svg file: 'robot-golem.svg', id: 'backdrop', x: x, y: y, width: 100, height: 100
+  end
+
+  sample "The SVG force_id option allows use of an ID only when specified, and render nothing if empty. Useful for multiple icons in one SVG file.\nThis should show nothing." do |x,y|
+    svg file: 'robot-golem.svg', x: x, y: y,
+        force_id: true, id: '' # <-- the important parts
+  end
+
+  sample 'NOTE! If you render a single object in an SVG, its placement is still relative to the SVG document.' do |x,y|
+    svg file: 'offset.svg', x: x, y: y
+    rect x: x, y: y, width: 100, height: 100, dash: '3 1', stroke_color: 'red', stroke_width: 3
+
+    svg file: 'offset.svg', id: 'thing',  x: x + 200, y: y, width: 100, height: 100
+    rect x: x + 200, y: y, width: 100, height: 100, dash: '3 1', stroke_color: 'red', stroke_width: 3
+  end
+
+  sample 'PNGs can be blended onto each other with 15 different blending operators. Alpha transparency supported too. See http://cairographics.org/operators' do |x,y|
+    png file: 'ball.png', x: x,      y: y
+    png file: 'grit.png', x: x + 20, y: y + 20, blend: :color_burn, alpha: 0.75
+  end
+
+  sample 'Rotation is around the upper-left corner of the image. Unit is radians.' do |x,y|
+    rect x: x, y: y, width: 100, height: 100, stroke_width: 3, dash: '3 3', stroke_color: :red
+    png  x: x,  y: y, width: 100, height: 100, angle: Math::PI / 4, file: 'angler-fish.png'
+
+    rect x: x + 250, y: y, width: 100, height: 100, stroke_width: 3, dash: '3 3', stroke_color: :red
+    svg  x: x + 250, y: y, width: 100, height: 100, file: 'robot-golem.svg',
+        angle: Math::PI / 2 - 0.2
+  end
+
+  sample 'SVGs and PNGs can be used as masks for colors instead of being directly rendered.' do |x,y|
+    svg mask: '#00ff00', file: 'glass-heart.svg', x: x - 50, y: y - 50, width: 200, height: 200
+    svg mask: '(0,0)(500,0) #eee@0.0 #111@1.0', file: 'glass-heart.svg', x: x + 150, y: y - 50, width: 200, height: 200
+  end
+
+  sample 'PNG masks are based on the alpha channel. Gradient coordinates are relative to the card.' do |x,y|
+    png file: 'with-alpha.png', x: x - 50, y: y
+    png file: 'with-alpha.png', mask: :magenta, x: x + 50, y: y
+
+    mask = "(#{x+150+75}, #{y+75}, 0)(#{x+150+75}, #{y+75}, 100) #f00@0.0 #000@1.0"
+    png file: 'with-alpha.png', mask: mask, x: x + 150, y: y, width: 150, height: :scale
+  end
+
+
+  save_png prefix: '_images_', dir: '.'
+end

data/samples/intro/01_hello.rb

@@ -0,0 +1,9 @@
+require 'squib'
+
+Squib::Deck.new cards: 1 do
+  background color: 'pink'
+  rect
+  text str: 'Draw two cards.'
+  save_png prefix: 'part1_', dir: '.'
+end
+

data/samples/intro/02_options.rb

@@ -0,0 +1,15 @@
+require 'squib'
+
+Squib::Deck.new cards: 1 do
+  background color: '#252322'
+  rect fill_color: '#0B3736',
+       x: 38, y: 38, width: 750, height: 1050, radius: 38
+  text str: 'Robot Golem', font: 'True Crimes, Sans 72',
+       align: :center, x: 75, width: :deck, color: '#DFDFE1', y: 90
+  svg file: 'auto-repair.svg', x: 75, y: 75, width: 100, height: :scale
+  svg file: 'robot-golem.svg', x: 75, y: 300, width: 675, height: :scale
+  text str: 'Draw two cards', font: 'Serif 36',
+       align: :center, width: :deck, color: '#DFDFE1', y: 1000
+  save_png prefix: 'part2_', dir: '.'
+end
+

data/samples/intro/03_layout.rb

@@ -0,0 +1,12 @@
+require 'squib'
+
+Squib::Deck.new cards: 1, layout: 'part3_layout.yml' do
+  background color: '#252322'
+  rect layout: 'backdrop'
+  text str: 'Robot Golem', layout: 'title'
+  svg layout: 'drone'
+  svg file: 'robot-golem.svg', layout: 'art'
+  text str: 'Draw two cards.', layout: 'power'
+  save_png prefix: 'part3_', dir: '.'
+end
+

data/samples/intro/04_arrays.rb

@@ -0,0 +1,16 @@
+require 'squib'
+
+Squib::Deck.new cards: 2, layout: 'part3_layout.yml' do
+  background color: '#252322'
+  rect layout: 'backdrop'
+  text str: ['Robot Golem', 'Ninja'],
+       layout: 'title'
+  svg layout: ['drone', 'human']
+  svg file: ['robot-golem.svg','ninja-mask.svg'],
+      layout: 'art'
+  text str: ['Draw two cards',
+             'Use the power of another player'],
+       layout: 'power'
+  save_png prefix: 'part4_', dir: '.'
+end
+

data/samples/intro/05_excel.rb

@@ -0,0 +1,15 @@
+require 'squib'
+
+Squib::Deck.new cards: 4, layout: 'part3_layout.yml' do
+  background color: '#252322'
+  rect layout: 'backdrop'
+  data = xlsx file: 'data.xlsx'
+  text str: data['name'], layout: 'title'
+  svg layout: data['class']
+  svg file: data['art'], layout: 'art'
+  text str: data['power'], layout: 'power'
+  save_png prefix: 'part5_', dir: '.'
+  hand file: 'part5_hand.png', dir: '.', trim_radius: 38
+  showcase file: 'part5_showcase.png', dir: '.'
+end
+

data/samples/layouts.rb

@@ -1,62 +1,62 @@
-# 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
+# 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