squib 0.14.1 → 0.14.2

data/samples/images/_more_load_images.rb

@@ -1,102 +1,102 @@
-require 'squib'
-
-Squib::Deck.new(width: 825, height: 1125, cards: 1, config: 'load_images_config.yml') do
-  background color: '#0b7c8e'
-  rect x: 38, y: 38, width: 750, height: 1050, x_radius: 38, y_radius: 38
-
-  png file: 'shiny-purse.png', x: 620, y: 75 # no scaling is done by default
-  svg file: 'spanner.svg', x: 620, y: 218
-
-  # Can be scaled if width and height are set
-  svg file: 'spanner.svg', x: 50, y: 50, width: 250, height: 250
-  png file: 'shiny-purse.png', x: 305, y: 50, width: 250, height: 250
-  # ...but PNGs will warn if it's an upscale, unless you disable them in config.yml
-
-  # Can be scaled using just width or height, if one of them is set to :scale
-  svg file: 'spanner.svg', x: 200, y: 350, width: 35,     height: :scale
-  svg file: 'spanner.svg', x: 200, y: 390, width: :scale, height: 35
-  png file: 'shiny-purse.png', x: 240, y: 350, width: 35,     height: :scale
-  png file: 'shiny-purse.png', x: 240, y: 390, width: :scale, height: 35
-
-  # You can also crop the loaded images, so you can work from a sprite sheet
-  png file: 'sprites.png', x: 300, y: 350  # entire sprite sheet
-  png file: 'sprites.png', x: 300, y: 425, # just the robot golem image
-      crop_x: 0, crop_y: 0, crop_corner_radius: 10,
-      crop_width: 64, crop_height: 64
-  png file: 'sprites.png', x: 400, y: 425, # just the drakkar ship image
-      crop_x: 64, crop_y: 0, crop_corner_x_radius: 25, crop_corner_y_radius: 25,
-      crop_width: 64, crop_height: 64
-  png file: 'sprites.png', x: 500, y: 415, # 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
-
-  # Cropping also works on SVGs too
-  svg file: 'spanner.svg', x: 300, y: 500, width: 64, height: 64,
-      crop_x: 32, crop_y: 32, crop_width: 32, crop_height:32
-
-  # We can flip our images too
-  png file: 'sprites.png', x: 300, y: 535, flip_vertical: true, flip_horizontal: true
-  svg file: 'spanner.svg', x: 300, y: 615, width: 64, height: 64,
-      flip_vertical: true, flip_horizontal: true
-
-  # We can also limit our rendering to a single object, if the SVG ID is set
-  svg file: 'spanner.svg', id: '#backdrop', x: 50, y: 350, width: 75, height: 75
-  # Squib prepends a #-sign if one is not specified
-  svg file: 'spanner.svg', id: 'backdrop', x: 50, y: 450, width: 125, height: 125
-
-  # We can also load SVGs as a string of XML
-  svg data: File.read('spanner.svg'), x: 50, y: 600, width: 75, height: 75
-
-  # The svg data field works nicely with modifying the SVG XML on-the-fly.
-  # To run this one, do `gem install game_icons` and uncomment the following
-  #
-  # require 'game_icons'
-  # svg data: GameIcons.get('angler-fish').recolor(fg: '#ccc', bg: '#333').string,
-  #     x: 150, y: 600, width: 75, height: 75
-  #
-  # More examples at https://github.com/andymeneely/game_icons
-  # (or `gem install game_icons`) to get & manipulate art from game-icons.net
-  # Nokogiri (already included in Squib) is also great for XML manipulation.
-
-  # WARNING! If you choose to use the SVG ID, the x-y coordinates are still
-  # relative to the SVG page. See this example in an SVG editor
-  svg file: 'offset.svg', id: 'thing', x: 0, y: 0, width: 600, height: 600
-
-  # Over 15 different blending operators are supported.
-  # See http://cairographics.org/operators
-  # Alpha transparency too
-  png file: 'ball.png', x: 50, y: 700
-  png file: 'grit.png', x: 70, y: 750, blend: :color_burn, alpha: 0.75
-
-  # Images can be rotated around their upper-left corner
-  png file: 'shiny-purse.png', x: 300, y: 700, angle: 0.0 # default (no rotate)
-  png file: 'shiny-purse.png', x: 300, y: 800, angle: Math::PI / 4
-  svg file: 'spanner.svg',     x: 300, y: 900, angle: Math::PI / 2 - 0.1
-
-  # Images can also be used as masks instead of being directly painted.
-  # This is particularly useful for switching directly over to black-and-white for printing
-  # Or, if you want the same image to be used but with different colors/gradients
-  svg mask: '#00ff00',
-      file: 'glass-heart.svg',
-      x: 500, y: 600, width: 200, height: 200
-  svg mask: '(0,0)(0,500) #ccc@0.0 #333@1.0',
-      file: 'glass-heart.svg',
-      x: 500, y: 800, width: 200, height: 200
-
-  # Masks are based on the alpha channel, so this is just a magenta square
-  png mask: :magenta, file: 'shiny-purse.png',
-      x: 650, y: 950
-
-  # Note that this method does nothing, even though it would normally fill up
-  # the card. force_id: true looks to the id field to be non-empty to render.
-  # This is useful if you have multiple different icons in one SVG file,
-  # 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
-
-  # Squib can handle incorrectly formatted svg files
-  svg file: 'bad-svg.svg'
-
-  save prefix: 'load_images_', format: :png
-end
+require 'squib'
+
+Squib::Deck.new(width: 825, height: 1125, cards: 1, config: 'load_images_config.yml') do
+  background color: '#0b7c8e'
+  rect x: 38, y: 38, width: 750, height: 1050, x_radius: 38, y_radius: 38
+
+  png file: 'shiny-purse.png', x: 620, y: 75 # no scaling is done by default
+  svg file: 'spanner.svg', x: 620, y: 218
+
+  # Can be scaled if width and height are set
+  svg file: 'spanner.svg', x: 50, y: 50, width: 250, height: 250
+  png file: 'shiny-purse.png', x: 305, y: 50, width: 250, height: 250
+  # ...but PNGs will warn if it's an upscale, unless you disable them in config.yml
+
+  # Can be scaled using just width or height, if one of them is set to :scale
+  svg file: 'spanner.svg', x: 200, y: 350, width: 35,     height: :scale
+  svg file: 'spanner.svg', x: 200, y: 390, width: :scale, height: 35
+  png file: 'shiny-purse.png', x: 240, y: 350, width: 35,     height: :scale
+  png file: 'shiny-purse.png', x: 240, y: 390, width: :scale, height: 35
+
+  # You can also crop the loaded images, so you can work from a sprite sheet
+  png file: 'sprites.png', x: 300, y: 350  # entire sprite sheet
+  png file: 'sprites.png', x: 300, y: 425, # just the robot golem image
+      crop_x: 0, crop_y: 0, crop_corner_radius: 10,
+      crop_width: 64, crop_height: 64
+  png file: 'sprites.png', x: 400, y: 425, # just the drakkar ship image
+      crop_x: 64, crop_y: 0, crop_corner_x_radius: 25, crop_corner_y_radius: 25,
+      crop_width: 64, crop_height: 64
+  png file: 'sprites.png', x: 500, y: 415, # 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
+
+  # Cropping also works on SVGs too
+  svg file: 'spanner.svg', x: 300, y: 500, width: 64, height: 64,
+      crop_x: 32, crop_y: 32, crop_width: 32, crop_height:32
+
+  # We can flip our images too
+  png file: 'sprites.png', x: 300, y: 535, flip_vertical: true, flip_horizontal: true
+  svg file: 'spanner.svg', x: 300, y: 615, width: 64, height: 64,
+      flip_vertical: true, flip_horizontal: true
+
+  # We can also limit our rendering to a single object, if the SVG ID is set
+  svg file: 'spanner.svg', id: '#backdrop', x: 50, y: 350, width: 75, height: 75
+  # Squib prepends a #-sign if one is not specified
+  svg file: 'spanner.svg', id: 'backdrop', x: 50, y: 450, width: 125, height: 125
+
+  # We can also load SVGs as a string of XML
+  svg data: File.read('spanner.svg'), x: 50, y: 600, width: 75, height: 75
+
+  # The svg data field works nicely with modifying the SVG XML on-the-fly.
+  # To run this one, do `gem install game_icons` and uncomment the following
+  #
+  # require 'game_icons'
+  # svg data: GameIcons.get('angler-fish').recolor(fg: '#ccc', bg: '#333').string,
+  #     x: 150, y: 600, width: 75, height: 75
+  #
+  # More examples at https://github.com/andymeneely/game_icons
+  # (or `gem install game_icons`) to get & manipulate art from game-icons.net
+  # Nokogiri (already included in Squib) is also great for XML manipulation.
+
+  # WARNING! If you choose to use the SVG ID, the x-y coordinates are still
+  # relative to the SVG page. See this example in an SVG editor
+  svg file: 'offset.svg', id: 'thing', x: 0, y: 0, width: 600, height: 600
+
+  # Over 15 different blending operators are supported.
+  # See http://cairographics.org/operators
+  # Alpha transparency too
+  png file: 'ball.png', x: 50, y: 700
+  png file: 'grit.png', x: 70, y: 750, blend: :color_burn, alpha: 0.75
+
+  # Images can be rotated around their upper-left corner
+  png file: 'shiny-purse.png', x: 300, y: 700, angle: 0.0 # default (no rotate)
+  png file: 'shiny-purse.png', x: 300, y: 800, angle: Math::PI / 4
+  svg file: 'spanner.svg',     x: 300, y: 900, angle: Math::PI / 2 - 0.1
+
+  # Images can also be used as masks instead of being directly painted.
+  # This is particularly useful for switching directly over to black-and-white for printing
+  # Or, if you want the same image to be used but with different colors/gradients
+  svg mask: '#00ff00',
+      file: 'glass-heart.svg',
+      x: 500, y: 600, width: 200, height: 200
+  svg mask: '(0,0)(0,500) #ccc@0.0 #333@1.0',
+      file: 'glass-heart.svg',
+      x: 500, y: 800, width: 200, height: 200
+
+  # Masks are based on the alpha channel, so this is just a magenta square
+  png mask: :magenta, file: 'shiny-purse.png',
+      x: 650, y: 950
+
+  # Note that this method does nothing, even though it would normally fill up
+  # the card. force_id: true looks to the id field to be non-empty to render.
+  # This is useful if you have multiple different icons in one SVG file,
+  # 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
+
+  # Squib can handle incorrectly formatted svg files
+  svg file: 'bad-svg.svg'
+
+  save prefix: 'load_images_', format: :png
+end

data/samples/intro/01_hello.rb

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

data/samples/intro/02_options.rb

@@ -1,14 +1,14 @@
-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 24',
-       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 12',
-       align: :center, width: :deck, color: '#DFDFE1', y: 1000
-  save_png prefix: 'part2_'
-end
+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 24',
+       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 12',
+       align: :center, width: :deck, color: '#DFDFE1', y: 1000
+  save_png prefix: 'part2_'
+end

data/samples/intro/03_layout.rb

@@ -1,11 +1,11 @@
-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_'
-end
+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_'
+end

data/samples/intro/04_arrays.rb

@@ -1,15 +1,15 @@
-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_'
-end
+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_'
+end

data/samples/intro/05_excel.rb

@@ -1,14 +1,14 @@
-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_'
-  hand file: 'part5_hand.png', trim_radius: 38
-  showcase file: 'part5_showcase.png'
-end
+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_'
+  hand file: 'part5_hand.png', trim_radius: 38
+  showcase file: 'part5_showcase.png'
+end

data/samples/layouts/builtin_layouts.rb

@@ -1,97 +1,97 @@
-require 'squib'
-
-# This sample demonstrates the built-in layouts for Squib.
-# Each card demonstrates a different built-in layout.
-Squib::Deck.new(layout: 'fantasy.yml') do
-  background color: 'white'
-
-  set font: 'Times New Roman,Serif 10.5'
-  hint text: '#333' # show extents of text boxes to demo the layout
-
-  text str: 'fantasy.yml', layout: :title
-  text str: 'ur',          layout: :upper_right
-  text str: 'art',         layout: :art
-  text str: 'type',        layout: :type
-  text str: 'tr',          layout: :type_right
-  text str: 'description', layout: :description
-  text str: 'lr',          layout: :lower_right
-  text str: 'll',          layout: :lower_left
-  text str: 'credits',     layout: :copy
-
-  rect layout: :safe
-  rect layout: :cut
-  save_png prefix: 'layouts_builtin_fantasy_'
-end
-
-Squib::Deck.new(layout: 'economy.yml') do
-  background color: 'white'
-
-  set font: 'Times New Roman,Serif 10.5'
-  hint text: '#333' # show extents of text boxes to demo the layout
-
-  text str: 'economy.yml', layout: :title
-  text str: 'art',         layout: :art
-  text str: 'description', layout: :description
-  text str: 'type',        layout: :type
-  text str: 'lr',          layout: :lower_right
-  text str: 'll',          layout: :lower_left
-  text str: 'credits',     layout: :copy
-
-  rect layout: :safe
-  rect layout: :cut
-  save_png prefix: 'layouts_builtin_economy_'
-end
-
-Squib::Deck.new(layout: 'hand.yml') do
-  background color: 'white'
-  %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
-  save_png prefix: 'layouts_builtin_hand_'
-end
-
-Squib::Deck.new(layout: 'playing-card.yml') do
-  background color: 'white'
-  text str: "A\u2660", layout: :bonus_ul, font: 'Sans bold 33', hint: :red
-  text str: "A\u2660", layout: :bonus_lr, font: 'Sans bold 33', hint: :red
-  text str: 'artwork here', layout: :art, hint: :red
-  save_png prefix: 'layouts_builtin_playing_card_'
-end
-
-Squib::Deck.new(layout: 'tuck_box.yml', width: 2325, height: 1950) do
-  background color: 'white'
-  rect layout: :top_rect
-  rect layout: :bottom_rect
-  rect layout: :right_rect
-  rect layout: :left_rect
-  rect layout: :back_rect
-  rect layout: :front_rect
-  curve layout: :front_curve
-
-  save_png prefix: 'layouts_builtin_tuck_box_'
-end
-
-Squib::Deck.new(layout: 'party.yml') do
-  background color: 'white'
-  # hint text: :black # uncomment to see the text box boundaries
-
-  rect layout: :title_box,
-       fill_color: :deep_sky_blue, stroke_width: 0
-  text str: "A SILLY NAME",  layout: :title
-  text str: '✔',             layout: :type_icon
-  text str: 'TYPE',          layout: :type
-  text str: 'A Silly Name',  layout: :title_middle
-  rect fill_color: :black,   layout: :middle_rect
-
-  str = 'Rule or story text. Be funny ha ha ha this is a party.'
-  text str: str, layout: :rule_top
-  text str: str, layout: :rule_bottom
-
-  text str: 'Tiny text', layout: :copyright
-
-  rect layout: :safe
-  rect layout: :cut
-  save_png prefix: 'layouts_builtin_party_'
-end
+require 'squib'
+
+# This sample demonstrates the built-in layouts for Squib.
+# Each card demonstrates a different built-in layout.
+Squib::Deck.new(layout: 'fantasy.yml') do
+  background color: 'white'
+
+  set font: 'Times New Roman,Serif 10.5'
+  hint text: '#333' # show extents of text boxes to demo the layout
+
+  text str: 'fantasy.yml', layout: :title
+  text str: 'ur',          layout: :upper_right
+  text str: 'art',         layout: :art
+  text str: 'type',        layout: :type
+  text str: 'tr',          layout: :type_right
+  text str: 'description', layout: :description
+  text str: 'lr',          layout: :lower_right
+  text str: 'll',          layout: :lower_left
+  text str: 'credits',     layout: :copy
+
+  rect layout: :safe
+  rect layout: :cut
+  save_png prefix: 'layouts_builtin_fantasy_'
+end
+
+Squib::Deck.new(layout: 'economy.yml') do
+  background color: 'white'
+
+  set font: 'Times New Roman,Serif 10.5'
+  hint text: '#333' # show extents of text boxes to demo the layout
+
+  text str: 'economy.yml', layout: :title
+  text str: 'art',         layout: :art
+  text str: 'description', layout: :description
+  text str: 'type',        layout: :type
+  text str: 'lr',          layout: :lower_right
+  text str: 'll',          layout: :lower_left
+  text str: 'credits',     layout: :copy
+
+  rect layout: :safe
+  rect layout: :cut
+  save_png prefix: 'layouts_builtin_economy_'
+end
+
+Squib::Deck.new(layout: 'hand.yml') do
+  background color: 'white'
+  %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
+  save_png prefix: 'layouts_builtin_hand_'
+end
+
+Squib::Deck.new(layout: 'playing-card.yml') do
+  background color: 'white'
+  text str: "A\u2660", layout: :bonus_ul, font: 'Sans bold 33', hint: :red
+  text str: "A\u2660", layout: :bonus_lr, font: 'Sans bold 33', hint: :red
+  text str: 'artwork here', layout: :art, hint: :red
+  save_png prefix: 'layouts_builtin_playing_card_'
+end
+
+Squib::Deck.new(layout: 'tuck_box.yml', width: 2325, height: 1950) do
+  background color: 'white'
+  rect layout: :top_rect
+  rect layout: :bottom_rect
+  rect layout: :right_rect
+  rect layout: :left_rect
+  rect layout: :back_rect
+  rect layout: :front_rect
+  curve layout: :front_curve
+
+  save_png prefix: 'layouts_builtin_tuck_box_'
+end
+
+Squib::Deck.new(layout: 'party.yml') do
+  background color: 'white'
+  # hint text: :black # uncomment to see the text box boundaries
+
+  rect layout: :title_box,
+       fill_color: :deep_sky_blue, stroke_width: 0
+  text str: "A SILLY NAME",  layout: :title
+  text str: '✔',             layout: :type_icon
+  text str: 'TYPE',          layout: :type
+  text str: 'A Silly Name',  layout: :title_middle
+  rect fill_color: :black,   layout: :middle_rect
+
+  str = 'Rule or story text. Be funny ha ha ha this is a party.'
+  text str: str, layout: :rule_top
+  text str: str, layout: :rule_bottom
+
+  text str: 'Tiny text', layout: :copyright
+
+  rect layout: :safe
+  rect layout: :cut
+  save_png prefix: 'layouts_builtin_party_'
+end