squib 0.18.0 → 0.19.0a

data/samples/layouts/layouts.rb

@@ -1,71 +1,71 @@
-# 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 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: '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
-  save_png prefix: 'layout_builtin_hand_'
-end
-
-# Layouts can also be specified in their own DSL method call
-# Each layout call will progressively be merged with the priors
-Squib::Deck.new do
-  use_layout file: 'custom-layout.yml'
-  use_layout file: 'custom-layout2.yml'
-  text str: 'The Title',   layout: :title # from custom-layout.yml
-  text str: 'The Subtitle', layout: :subtitle # redefined in custom-layout2.yml
-  save_png prefix: 'layout3_'
-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 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: '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
+  save_png prefix: 'layout_builtin_hand_'
+end
+
+# Layouts can also be specified in their own DSL method call
+# Each layout call will progressively be merged with the priors
+Squib::Deck.new do
+  use_layout file: 'custom-layout.yml'
+  use_layout file: 'custom-layout2.yml'
+  text str: 'The Title',   layout: :title # from custom-layout.yml
+  text str: 'The Subtitle', layout: :subtitle # redefined in custom-layout2.yml
+  save_png prefix: 'layout3_'
+end

data/samples/project/src/characters.rb

@@ -1,8 +1,8 @@
-require 'squib'
-
-Squib::Deck.new do
-  background color: :white
-  text str: "Built at #{Time.now}"
-  svg file: 'robot-golem.svg'
-  save_png prefix: 'character_'
-end
+require 'squib'
+
+Squib::Deck.new do
+  background color: :white
+  text str: "Built at #{Time.now}"
+  svg file: 'robot-golem.svg'
+  save_png prefix: 'character_'
+end

data/samples/project/src/skills.rb

@@ -1,7 +1,7 @@
-require 'squib'
-
-Squib::Deck.new do
-  background color: :white
-  text str: "Built at #{Time.now}"
-  save_png prefix: 'skill_'
-end
+require 'squib'
+
+Squib::Deck.new do
+  background color: :white
+  text str: "Built at #{Time.now}"
+  save_png prefix: 'skill_'
+end

data/samples/proofs/_tgc_proofs.rb

@@ -1,16 +1,16 @@
-require 'squib'
-
-# This sample uses a proof overlay from TheGameCrafter.com to check bleed
-Squib::Deck.new(width: 825, height: 1125, cards: 1) do
-  background color: :white
-  rect x: 38, y: 38, width: 750, height: 1050, x_radius: 38, y_radius: 38
-  rect x: 75, y: 75, width: 128, height: 128, x_radius: 25, y_radius: 25
-
-  text str: 'Mastermind', x: 220, y: 78, font: 'Arial 18'
-  text str: 3, x: 75, y: 85, width: 128, font: 'Arial 24', align: :center
-
-  # TGC proof overlay (using alpha-transparency)
-  png file: 'pokercard.png', x:0, y:0, alpha: 0.5
-
-  save_png prefix: 'tgc_sample_'
-end
+require 'squib'
+
+# This sample uses a proof overlay from TheGameCrafter.com to check bleed
+Squib::Deck.new(width: 825, height: 1125, cards: 1) do
+  background color: :white
+  rect x: 38, y: 38, width: 750, height: 1050, x_radius: 38, y_radius: 38
+  rect x: 75, y: 75, width: 128, height: 128, x_radius: 25, y_radius: 25
+
+  text str: 'Mastermind', x: 220, y: 78, font: 'Arial 18'
+  text str: 3, x: 75, y: 85, width: 128, font: 'Arial 24', align: :center
+
+  # TGC proof overlay (using alpha-transparency)
+  png file: 'pokercard.png', x:0, y:0, alpha: 0.5
+
+  save_png prefix: 'tgc_sample_'
+end

data/samples/ranges/_ranges.rb

@@ -1,64 +1,64 @@
-require 'squib'
-
-data = { 'name' => ['Thief', 'Grifter', 'Mastermind'],
-        'type' => ['Thug', 'Thinker', 'Thinker'],
-        'level' => [1, 2, 3] }
-
-Squib::Deck.new(width: 825, height: 1125, cards: 3) do
-  # Default range is :all
-  background color: :white
-  text str: data['name'], x: 250, y: 55, font: 'Arial 18'
-  text str: data['level'], x: 65, y: 40, font: 'Arial 24'
-
-  # Could be explicit about using :all, too
-  text range: :all,
-       str: data['type'], x: 40, y: 128, font: 'Arial 6',
-       width: 100, align: :center
-
-  # Ranges are inclusive, zero-based
-  text range: 0..1, str: 'Thief and Grifter only!!', x: 25, y:200
-
-  # Integers are also allowed
-  text range: 0, str: 'Thief only!', x: 25, y: 250
-
-  # Negatives go from the back of the deck
-  text range: -1, str: 'Mastermind only!', x: 25, y: 250
-  text range: -2..-1, str: 'Grifter and Mastermind only!', x: 25, y: 650
-
-  # We can use Arrays too!
-  text range: [0, 2], str: 'Thief and Mastermind only!!', x: 25, y:300
-
-  # Just about everything in Squib can be given an array that
-  # corresponds to the deck's cards. This allows for each card to be styled differently
-  # This renders three cards, with three strings that had three different colors at three different locations.
-  text str: %w(red green blue),
-       color: [:red, :green, :blue],
-       x: [40, 80, 120],
-       y: [700, 750, 800]
-
-  # Useful idiom: construct a hash from card names back to its index (ID),
-  # then use a range. No need to memorize IDs, and you can add cards easily
-  id = {} ; data['name'].each_with_index{ |name, i| id[name] = i}
-  text range: id['Thief']..id['Grifter'],
-       str: 'Thief through Grifter with id lookup!!',
-       x:25, y: 400
-
-  # Useful idiom: generate arrays from a column called 'type'
-  type = {}; data['type'].each_with_index{ |t, i| (type[t] ||= []) << i}
-  text range: type['Thinker'],
-       str: 'Only for Thinkers!',
-       x:25, y: 500
-
-  # Useful idiom: draw a different number of images for different cards
-  hearts = [nil, 1, 2] # i.e. card 0 has no hearts, card 2 has 2 hearts drawn
-  1.upto(2).each do |n|
-    range = hearts.each_index.select { |i| hearts[i] == n}
-    n.times do |i|
-      svg file: 'glass-heart.svg', range: range,
-          x: 150, y: 55 + i * 42, width: 40, height: 40
-    end
-  end
-
-  rect stroke_color: 'black' # just a border
-  save_sheet prefix: 'ranges_', columns: 3
-end
+require 'squib'
+
+data = { 'name' => ['Thief', 'Grifter', 'Mastermind'],
+        'type' => ['Thug', 'Thinker', 'Thinker'],
+        'level' => [1, 2, 3] }
+
+Squib::Deck.new(width: 825, height: 1125, cards: 3) do
+  # Default range is :all
+  background color: :white
+  text str: data['name'], x: 250, y: 55, font: 'Arial 18'
+  text str: data['level'], x: 65, y: 40, font: 'Arial 24'
+
+  # Could be explicit about using :all, too
+  text range: :all,
+       str: data['type'], x: 40, y: 128, font: 'Arial 6',
+       width: 100, align: :center
+
+  # Ranges are inclusive, zero-based
+  text range: 0..1, str: 'Thief and Grifter only!!', x: 25, y:200
+
+  # Integers are also allowed
+  text range: 0, str: 'Thief only!', x: 25, y: 250
+
+  # Negatives go from the back of the deck
+  text range: -1, str: 'Mastermind only!', x: 25, y: 250
+  text range: -2..-1, str: 'Grifter and Mastermind only!', x: 25, y: 650
+
+  # We can use Arrays too!
+  text range: [0, 2], str: 'Thief and Mastermind only!!', x: 25, y:300
+
+  # Just about everything in Squib can be given an array that
+  # corresponds to the deck's cards. This allows for each card to be styled differently
+  # This renders three cards, with three strings that had three different colors at three different locations.
+  text str: %w(red green blue),
+       color: [:red, :green, :blue],
+       x: [40, 80, 120],
+       y: [700, 750, 800]
+
+  # Useful idiom: construct a hash from card names back to its index (ID),
+  # then use a range. No need to memorize IDs, and you can add cards easily
+  id = {} ; data['name'].each_with_index{ |name, i| id[name] = i}
+  text range: id['Thief']..id['Grifter'],
+       str: 'Thief through Grifter with id lookup!!',
+       x:25, y: 400
+
+  # Useful idiom: generate arrays from a column called 'type'
+  type = {}; data['type'].each_with_index{ |t, i| (type[t] ||= []) << i}
+  text range: type['Thinker'],
+       str: 'Only for Thinkers!',
+       x:25, y: 500
+
+  # Useful idiom: draw a different number of images for different cards
+  hearts = [nil, 1, 2] # i.e. card 0 has no hearts, card 2 has 2 hearts drawn
+  1.upto(2).each do |n|
+    range = hearts.each_index.select { |i| hearts[i] == n}
+    n.times do |i|
+      svg file: 'glass-heart.svg', range: range,
+          x: 150, y: 55 + i * 42, width: 40, height: 40
+    end
+  end
+
+  rect stroke_color: 'black' # just a border
+  save_sheet prefix: 'ranges_', columns: 3
+end

data/samples/saves/_hand.rb

@@ -1,23 +1,23 @@
-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 33'
-
-  # 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 33'
+
+  # 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/saves/_portrait_landscape.rb

@@ -1,23 +1,23 @@
-require 'squib'
-
-# For decks with both landscape and portrait orientations,
-# we recommend using two separate decks.
-# For print-on-demand, we can rotate all of the images in the final step.
-
-# Normal cards
-Squib::Deck.new(width: 825, height: 1125) do
-  background color: '#aaa'
-
-  text str: 'This is portrait and trimmed'
-
-  save_png prefix: 'portrait_', trim: 10, trim_radius: 15
-end
-
-# Money cards are landscape
-Squib::Deck.new(width: 1125, height: 825) do
-  background color: '#aaa'
-
-  text str: 'This is landscape and trimmed', x: 15, y: 10
-
-  save_png prefix: 'landscape_', rotate: :clockwise, trim: 25, trim_radius: 15
-end
+require 'squib'
+
+# For decks with both landscape and portrait orientations,
+# we recommend using two separate decks.
+# For print-on-demand, we can rotate all of the images in the final step.
+
+# Normal cards
+Squib::Deck.new(width: 825, height: 1125) do
+  background color: '#aaa'
+
+  text str: 'This is portrait and trimmed'
+
+  save_png prefix: 'portrait_', trim: 10, trim_radius: 15
+end
+
+# Money cards are landscape
+Squib::Deck.new(width: 1125, height: 825) do
+  background color: '#aaa'
+
+  text str: 'This is landscape and trimmed', x: 15, y: 10
+
+  save_png prefix: 'landscape_', rotate: :clockwise, trim: 25, trim_radius: 15
+end

data/samples/saves/_save_filenames.rb

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

@@ -1,29 +1,29 @@
-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_width: 2.0, dash: '4 4'
-
-   # Tests for crop marks
-   save_pdf file: 'crops-default.pdf', crop_marks: true
-   save_pdf file: 'crops-gapped.pdf', crop_marks: true, trim: 37.5, gap: 20
-
-   # Test crop marks with all the bells and whistles
-   rect x: '0.3in', y: '0.4in', width: '2in', height: '2.5in'
-   save_pdf file: 'crops-custom.pdf', crop_marks: true, trim: 0, gap: 20,
-      crop_stroke_dash: '5 5', crop_stroke_color: :red, crop_stroke_width: 4.0,
-      crop_margin_left: '0.3in', crop_margin_right: '0.45in',
-      crop_margin_top:  '0.4in', crop_margin_bottom: '0.85in'
-
-   # Full crop marks
-   save_pdf file: 'crops-full.pdf', crop_marks: :full,
-      trim: 0, gap: 20,
-      crop_stroke_dash: '5 5', crop_stroke_color: :red, crop_stroke_width: 4.0,
-      crop_margin_left: '0.3in', crop_margin_right: '0.45in',
-      crop_margin_top:  '0.4in', crop_margin_bottom: '0.85in'
-
-    # Right to left printing for duplex
-    save_pdf file: 'save_pdf-crops-rtl.pdf', crop_marks: true, rtl: true
-
-end
+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_width: 2.0, dash: '4 4'
+
+   # Tests for crop marks
+   save_pdf file: 'crops-default.pdf', crop_marks: true
+   save_pdf file: 'crops-gapped.pdf', crop_marks: true, trim: 37.5, gap: 20
+
+   # Test crop marks with all the bells and whistles
+   rect x: '0.3in', y: '0.4in', width: '2in', height: '2.5in'
+   save_pdf file: 'crops-custom.pdf', crop_marks: true, trim: 0, gap: 20,
+      crop_stroke_dash: '5 5', crop_stroke_color: :red, crop_stroke_width: 4.0,
+      crop_margin_left: '0.3in', crop_margin_right: '0.45in',
+      crop_margin_top:  '0.4in', crop_margin_bottom: '0.85in'
+
+   # Full crop marks
+   save_pdf file: 'crops-full.pdf', crop_marks: :full,
+      trim: 0, gap: 20,
+      crop_stroke_dash: '5 5', crop_stroke_color: :red, crop_stroke_width: 4.0,
+      crop_margin_left: '0.3in', crop_margin_right: '0.45in',
+      crop_margin_top:  '0.4in', crop_margin_bottom: '0.85in'
+
+    # Right to left printing for duplex
+    save_pdf file: 'save_pdf-crops-rtl.pdf', crop_marks: true, rtl: true
+
+end