squib 0.8.0 → 0.9.0

data/lib/squib/sample_helpers.rb

@@ -0,0 +1,34 @@
+module Squib
+
+  # Some helper methods specifically for samples
+  #@api private
+  #:nodoc:
+  class Deck
+
+    # Draw graph paper for samples
+    def draw_graph_paper(width, height)
+      background color: 'white'
+      grid width: 50,  height: 50,  stroke_color: '#659ae9', stroke_width: 1.5
+      grid width: 200, height: 200, stroke_color: '#659ae9', stroke_width: 3, x: 50, y: 50
+      (50..height).step(200) do |y|
+        text str: "y=#{y}", x: 3, y: y - 18, font: 'Open Sans, Sans 10'
+      end
+    end
+
+    # Define a set of samples on some graph paper
+    def sample(str)
+      @sample_x ||= 100
+      @sample_y ||= 100
+      rect x: 460, y: @sample_y - 40, width: 600,
+           height: 180, fill_color: '#FFD655', stroke_color: 'black', radius: 15
+      text str: str, x: 460, y: @sample_y - 40,
+           width: 540, height: 180,
+           valign: 'middle', align: 'center',
+           font: 'Times New Roman,Serif 24'
+      yield @sample_x, @sample_y
+      @sample_y += 200
+    end
+
+  end
+
+end

data/lib/squib/version.rb

@@ -1,10 +1,10 @@
-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.8.0'
-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.9.0'
+end

data/samples/autoscale_font/_autoscale_font.rb

@@ -0,0 +1,29 @@
+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
+      32
+    when 16..20
+      18
+    else
+      12
+    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 dir: '.', columns: 3
+end

data/samples/color_shortcuts.rb

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

data/samples/csv_import.rb

@@ -1,26 +1,26 @@
-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: 'quantity_explosion.csv' # 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_csv_qty_', columns: 4
-end
+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: 'quantity_explosion.csv' # 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_csv_qty_', columns: 4
+end

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 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
+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,45 +1,48 @@
-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
+require 'squib'
+
+Squib::Deck.new do
+  background color: :white
+
+  grid x: 10, y: 10, width: 50,  height: 50,  stroke_color: '#0066FF', stroke_width: 1.5
+  grid x: 10, y: 10, width: 200, height: 200, stroke_color: '#0066FF', stroke_width: 3
+
+  rect x: 305, y: 105, 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,88 +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
-  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
+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