squib 0.4.0 → 0.5.0

data/lib/squib/project_template/config.yml

@@ -25,3 +25,16 @@
 # Use a SVG cairo back end, instead of an in-memory buffer
 # backend: :memory # default
 # backend: :svg    # can create scalable pdfs, but rendering done at the printer level is not as good as Cairo.
+
+# Configure what text markup uses replace characters
+# Below are the defaults
+# lsquote: "\u2018" #note that Yaml wants double quotes here to use escape chars
+# rsquote: "\u2019"
+# ldquote: "\u201C"
+# rdquote: "\u201D"
+# em_dash: "\u2014"
+# en_dash: "\u2013"
+# ellipsis: "\u2026"
+
+# We can also disallow smart quotes and only allow explicit replacements with ``LaTeX-style'' quotes.
+# smart_quotes: false

data/lib/squib/version.rb

@@ -6,5 +6,5 @@ module Squib
   # 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.4.0'
+  VERSION = '0.5.0'
 end

data/samples/config_disable_quotes.yml

@@ -0,0 +1,3 @@
+# If we want to disable smart quoting and only allow explicit quoting within markup, 
+# use this option
+smart_quotes: false

data/samples/config_text_markup.rb

@@ -0,0 +1,20 @@
+require 'squib'
+
+Squib::Deck.new(config: 'config_text_markup.yml') do
+  background color: :white
+  text str: %{"'Yaml ain't markup', he says"},
+       x: 10, y: 10, width: 300, height: 200, font: 'Serif 20',
+       markup: true, hint: :cyan
+
+  text str: "Notice also the antialiasing method.",
+       x: 320, y: 10, width: 300, height: 200, font: 'Arial Bold 20'
+
+  save_png prefix: 'config_text_'
+end
+
+Squib::Deck.new(config: 'config_disable_quotes.yml') do
+  text str: %{This has typographic sugar --- and ``explicit'' quotes --- but the quotes are "dumb"},
+       x: 10, y: 10, width: 300, height: 200, font: 'Serif 20',
+       markup: true, hint: :cyan
+  save_png prefix: 'config_disable_text_'
+end

data/samples/config_text_markup.yml

@@ -0,0 +1,9 @@
+# We can configure what characters actually get replaced by quoting them with unicode code points.
+lsquote: "\u2018" #note that Yaml wants double quotes here to use escape chars
+rsquote: "\u2019"
+ldquote: "\u201C"
+rdquote: "\u201D"
+em_dash: "\u2014"
+en_dash: "\u2013"
+ellipsis: "\u2026"
+antialias: gray

data/samples/draw_shapes.rb

@@ -15,5 +15,10 @@ Squib::Deck.new do
        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
+
   save_png prefix: 'shape_'
 end

data/samples/embed_text.rb

@@ -0,0 +1,90 @@
+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, 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 = '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

data/samples/text_options.rb

@@ -3,7 +3,7 @@ require 'squib'
 
 data = {'name' => ['Thief', 'Grifter', 'Mastermind'],
         'level' => [1,2,3]}
-longtext = "This is left-justified text.\nWhat do you know about tweetle beetles? well... \nWhen tweetle beetles fight, it's called a tweetle beetle battle. And when they battle in a puddle, it's a tweetle beetle puddle battle. AND when tweetle beetles battle with paddles in a puddle, they call it a tweetle beetle puddle paddle battle. AND... When beetles battle beetles in a puddle paddle battle and the beetle battle puddle is a puddle in a bottle... ..they call this a tweetle beetle bottle puddle paddle battle muddle. AND... When beetles fight these battles in a bottle with their paddles and the bottle's on a poodle and the poodle's eating noodles... ...they call this a muddle puddle tweetle poodle beetle noodle bottle paddle battle."
+longtext = "This is left-justified text, with newlines.\nWhat do you know about tweetle beetles? well... When tweetle beetles fight, it's called a tweetle beetle battle. And when they battle in a puddle, it's a tweetle beetle puddle battle. AND when tweetle beetles battle with paddles in a puddle, they call it a tweetle beetle puddle paddle battle. AND... When beetles battle beetles in a puddle paddle battle and the beetle battle puddle is a puddle in a bottle... ..they call this a tweetle beetle bottle puddle paddle battle muddle."
 
 Squib::Deck.new(width: 825, height: 1125, cards: 3) do
   background color: :white
@@ -23,12 +23,12 @@ Squib::Deck.new(width: 825, height: 1125, cards: 3) do
   text str: 'Font string sizes can be overridden per card.', x: 65, y: 350,
        font: 'Impact 36', font_size: [16, 20, 24]
 
-  text str: 'This text has fixed width, fixed height, center-aligned, middle-valigned, and has a red hint',
+  text str: 'This text has fixed width, fixed height, center-aligned, middle-valigned, has a red hint, and "smart quotes"',
        hint: :red,
        x: 65, y: 400,
        width: 300, height: 125,
-       align: :center, valign: 'MIDDLE', #case-insenstive strings allowed too.
-       font: 'Arial 18'
+       align: :center, valign: 'MIDDLE', # these can be specified with case-insenstive strings too
+       font: 'Serif 16', quotes: [:smart,:smart, :dumb]
 
   extents = text str: 'Ink extent return value',
        x: 65, y: 550,
@@ -41,12 +41,14 @@ Squib::Deck.new(width: 825, height: 1125, cards: 3) do
        width: ws, height: hs,
        radius: 10, stroke_color: :black
 
+  # If width & height are defined and the text will overflow the box, we can ellipsize.
   text str: "Ellipsization!\nThe ultimate question of life, the universe, and everything to life and everything is 42",
        hint: :green, font: 'Arial 22',
        x: 450, y: 400,
        width: 280, height: 180,
        ellipsize: true
 
+  # Text hints are guides for showing you how your text boxes are laid out exactly
   hint text: :cyan
   text str: 'Text hints are also globally togglable!',
         x: 65, y: 625,
@@ -60,17 +62,29 @@ Squib::Deck.new(width: 825, height: 1125, cards: 3) do
         x: 565, y: 675, angle: 0.2,
         font: 'Arial 18', hint: :red
 
+  # Text can be justified, and have newlines
   text str: longtext, font: 'Arial 16',
        x: 65, y: 700,
-       width: inches(2.25), height: inches(1),
+       width: '1.5in', height: inches(1),
        justify: true
 
-  text str: '<b>Markup</b> is also <i>quite</i> <s>easy</s> awesome',
+  # Here's how you embed images into text.
+  # Pass a block to the method call and use the given context
+  embed_text = 'Embedded icons! Take 1 :tool: and gain 2:health:. If Level 2, take 2 :tool:'
+  text(str: embed_text, font: 'Sans 18',
+       x: '1.8in', y: '2.5in', width: '0.85in',
+       align: :left, ellipsize: false) 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
+
+  text str: "<b>Markup</b> is <i>quite</i> <s>'easy'</s> <span fgcolor=\"\#ff0000\">awesome</span>. Can't beat those \"smart\" 'quotes', now with 10--20% more en-dashes --- and em-dashes --- with explicit ellipses too...",
        markup: true,
        x: 50, y: 1000,
        width: 750, height: 100,
        valign: :bottom,
-       font: 'Arial 32', hint: :cyan
+       font: 'Serif 18', hint: :cyan
+
 
   save prefix: 'text_', format: :png
 end

data/spec/api/api_text_spec.rb

@@ -6,7 +6,7 @@ describe Squib::Deck, '#text' do
   context 'fonts' do
      it "should use the default font when #text and #set_font don't specify" do
       card = instance_double(Squib::Card)
-      expect(card).to receive(:text).with('a', 'Arial 36', *([anything] * 15)).once
+      expect(card).to receive(:text).with(anything, 'a', 'Arial 36', *([anything] * 15)).once
       Squib::Deck.new do
         @cards = [card]
         text str: 'a'
@@ -15,7 +15,7 @@ describe Squib::Deck, '#text' do
 
     it "should use the #set_font when #text doesn't specify" do
       card = instance_double(Squib::Card)
-      expect(card).to receive(:text).with('a', 'Times New Roman 16', *([anything] * 15)).once
+      expect(card).to receive(:text).with(anything, 'a', 'Times New Roman 16', *([anything] * 15)).once
       Squib::Deck.new do
         @cards = [card]
         set font: 'Times New Roman 16'
@@ -25,7 +25,7 @@ describe Squib::Deck, '#text' do
 
     it 'should use the specified font no matter what' do
       card = instance_double(Squib::Card)
-      expect(card).to receive(:text).with('a', 'Arial 18', *([anything] * 15)).once
+      expect(card).to receive(:text).with(anything, 'a', 'Arial 18', *([anything] * 15)).once
       Squib::Deck.new do
         @cards = [card]
         set font: 'Times New Roman 16'

data/spec/args/typographer_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+require 'squib/args/typographer'
+
+describe Squib::Args::Typographer do
+  subject(:t) { Squib::Args::Typographer.new }
+
+  it 'does nothing on a non-quoted string' do
+    expect(t.process(%{nothing})).to eq(%{nothing})
+  end
+
+  it 'left quotes at the beginning' do
+    expect(t.process(%{"foo})).to eq(%{\u201Cfoo})
+  end
+
+  it 'left quotes in the middle of the string' do
+    expect(t.process(%{hello "foo})).to eq(%{hello \u201Cfoo})
+  end
+
+  it 'right quotes at the end' do
+    expect(t.process(%{foo"})).to eq(%{foo\u201D})
+  end
+
+  it 'handles the entire string quoted' do
+    expect(t.process(%{"foo"})).to eq(%{\u201Cfoo\u201D})
+  end
+
+  it "quotes in the middle of the string" do
+    expect(t.process(%{hello "foo" world})).to eq(%{hello \u201Cfoo\u201D world})
+  end
+
+  it "single left quotes at the beginning" do
+    expect(t.process(%{'foo})).to eq(%{\u2018foo})
+  end
+
+  it "single right quotes at the end" do
+    expect(t.process(%{foo'})).to eq(%{foo\u2019})
+  end
+
+  it "single quotes in the middle" do
+    expect(t.process(%{a 'foo' bar})).to eq(%{a \u2018foo\u2019 bar})
+  end
+
+  it "handles apostraphes" do
+    expect(t.process(%{can't})).to eq(%{can\u2019t})
+  end
+
+it "single quotes inside double quotes" do
+    expect(t.process(%{"'I can't do that', he said"})).to eq(%{\u201C\u2018I can\u2019t do that\u2019, he said\u201D})
+  end
+
+  it "replaces the straightforward ones" do
+    expect(t.process(%{``hi...'' -- ---})).to eq(%{\u201Chi\u2026\u201D \u2013 \u2014})
+  end
+
+  it "does nothing on lone quotes" do
+    expect(t.process(%{"})).to eq(%{"})
+    expect(t.process(%{'})).to eq(%{'})
+  end
+
+  it "ignores stuff in <tags>" do
+    expect(t.process(%{<span weight="bold">"can't"</span>})).to eq(%{<span weight="bold">\u201Ccan\u2019t\u201D</span>})
+  end
+
+
+  context 'configured' do
+    #TODO
+  end
+
+
+
+end

data/spec/data/samples/autoscale_font.rb.txt

@@ -17,8 +17,7 @@ cairo: save([])
 cairo: set_source_color([:black])
 cairo: translate([65, 400])
 cairo: rotate([0])
-cairo: translate([-65, -400])
-cairo: move_to([65, 400])
+cairo: move_to([0, 0])
 pango font: size=([128000])
 pango: font_description=([MockDouble])
 pango: text=(["ShortBig"])
@@ -29,9 +28,10 @@ pango: alignment=([#<Pango::Layout::Alignment center>])
 pango: justify=([false])
 pango: spacing=([0])
 cairo: update_pango_layout([MockDouble])
+cairo: move_to([0, 0])
 cairo: update_pango_layout([MockDouble])
 cairo: show_pango_layout([MockDouble])
-cairo: rounded_rectangle([65, 400, 0, 0, 0, 0])
+cairo: rounded_rectangle([0, 0, 0, 0, 0, 0])
 cairo: set_source_color([:red])
 cairo: set_line_width([2.0])
 cairo: stroke([])
@@ -40,8 +40,7 @@ cairo: save([])
 cairo: set_source_color([:black])
 cairo: translate([65, 400])
 cairo: rotate([0])
-cairo: translate([-65, -400])
-cairo: move_to([65, 400])
+cairo: move_to([0, 0])
 pango font: size=([46080])
 pango: font_description=([MockDouble])
 pango: text=(["Medium_Length_Name"])
@@ -52,9 +51,10 @@ pango: alignment=([#<Pango::Layout::Alignment center>])
 pango: justify=([false])
 pango: spacing=([0])
 cairo: update_pango_layout([MockDouble])
+cairo: move_to([0, 0])
 cairo: update_pango_layout([MockDouble])
 cairo: show_pango_layout([MockDouble])
-cairo: rounded_rectangle([65, 400, 0, 0, 0, 0])
+cairo: rounded_rectangle([0, 0, 0, 0, 0, 0])
 cairo: set_source_color([:red])
 cairo: set_line_width([2.0])
 cairo: stroke([])
@@ -63,8 +63,7 @@ cairo: save([])
 cairo: set_source_color([:black])
 cairo: translate([65, 400])
 cairo: rotate([0])
-cairo: translate([-65, -400])
-cairo: move_to([65, 400])
+cairo: move_to([0, 0])
 pango font: size=([36864])
 pango: font_description=([MockDouble])
 pango: text=(["Super_Duper_Long_Name"])
@@ -75,9 +74,10 @@ pango: alignment=([#<Pango::Layout::Alignment center>])
 pango: justify=([false])
 pango: spacing=([0])
 cairo: update_pango_layout([MockDouble])
+cairo: move_to([0, 0])
 cairo: update_pango_layout([MockDouble])
 cairo: show_pango_layout([MockDouble])
-cairo: rounded_rectangle([65, 400, 0, 0, 0, 0])
+cairo: rounded_rectangle([0, 0, 0, 0, 0, 0])
 cairo: set_source_color([:red])
 cairo: set_line_width([2.0])
 cairo: stroke([])

data/spec/data/samples/basic.rb.txt

@@ -71,8 +71,7 @@ cairo: save([])
 cairo: set_source_color([:black])
 cairo: translate([220, 78])
 cairo: rotate([0])
-cairo: translate([-220, -78])
-cairo: move_to([220, 78])
+cairo: move_to([0, 0])
 pango: font_description=([MockDouble])
 pango: text=(["Thief"])
 pango: wrap=([#<Pango::Layout::WrapMode word-char>])
@@ -81,6 +80,7 @@ pango: alignment=([#<Pango::Layout::Alignment left>])
 pango: justify=([false])
 pango: spacing=([0])
 cairo: update_pango_layout([MockDouble])
+cairo: move_to([0, 0])
 cairo: update_pango_layout([MockDouble])
 cairo: show_pango_layout([MockDouble])
 cairo: restore([])
@@ -88,8 +88,7 @@ cairo: save([])
 cairo: set_source_color([:black])
 cairo: translate([220, 78])
 cairo: rotate([0])
-cairo: translate([-220, -78])
-cairo: move_to([220, 78])
+cairo: move_to([0, 0])
 pango: font_description=([MockDouble])
 pango: text=(["Grifter"])
 pango: wrap=([#<Pango::Layout::WrapMode word-char>])
@@ -98,6 +97,7 @@ pango: alignment=([#<Pango::Layout::Alignment left>])
 pango: justify=([false])
 pango: spacing=([0])
 cairo: update_pango_layout([MockDouble])
+cairo: move_to([0, 0])
 cairo: update_pango_layout([MockDouble])
 cairo: show_pango_layout([MockDouble])
 cairo: restore([])
@@ -105,8 +105,7 @@ cairo: save([])
 cairo: set_source_color([:black])
 cairo: translate([220, 78])
 cairo: rotate([0])
-cairo: translate([-220, -78])
-cairo: move_to([220, 78])
+cairo: move_to([0, 0])
 pango: font_description=([MockDouble])
 pango: text=(["Mastermind"])
 pango: wrap=([#<Pango::Layout::WrapMode word-char>])
@@ -115,6 +114,7 @@ pango: alignment=([#<Pango::Layout::Alignment left>])
 pango: justify=([false])
 pango: spacing=([0])
 cairo: update_pango_layout([MockDouble])
+cairo: move_to([0, 0])
 cairo: update_pango_layout([MockDouble])
 cairo: show_pango_layout([MockDouble])
 cairo: restore([])
@@ -122,8 +122,7 @@ cairo: save([])
 cairo: set_source_color([:black])
 cairo: translate([75, 85])
 cairo: rotate([0])
-cairo: translate([-75, -85])
-cairo: move_to([75, 85])
+cairo: move_to([0, 0])
 pango: font_description=([MockDouble])
 pango: text=(["1"])
 pango: width=([131072])
@@ -133,6 +132,7 @@ pango: alignment=([#<Pango::Layout::Alignment center>])
 pango: justify=([false])
 pango: spacing=([0])
 cairo: update_pango_layout([MockDouble])
+cairo: move_to([0, 0])
 cairo: update_pango_layout([MockDouble])
 cairo: show_pango_layout([MockDouble])
 cairo: restore([])
@@ -140,8 +140,7 @@ cairo: save([])
 cairo: set_source_color([:black])
 cairo: translate([75, 85])
 cairo: rotate([0])
-cairo: translate([-75, -85])
-cairo: move_to([75, 85])
+cairo: move_to([0, 0])
 pango: font_description=([MockDouble])
 pango: text=(["2"])
 pango: width=([131072])
@@ -151,6 +150,7 @@ pango: alignment=([#<Pango::Layout::Alignment center>])
 pango: justify=([false])
 pango: spacing=([0])
 cairo: update_pango_layout([MockDouble])
+cairo: move_to([0, 0])
 cairo: update_pango_layout([MockDouble])
 cairo: show_pango_layout([MockDouble])
 cairo: restore([])
@@ -158,8 +158,7 @@ cairo: save([])
 cairo: set_source_color([:black])
 cairo: translate([75, 85])
 cairo: rotate([0])
-cairo: translate([-75, -85])
-cairo: move_to([75, 85])
+cairo: move_to([0, 0])
 pango: font_description=([MockDouble])
 pango: text=(["3"])
 pango: width=([131072])
@@ -169,6 +168,7 @@ pango: alignment=([#<Pango::Layout::Alignment center>])
 pango: justify=([false])
 pango: spacing=([0])
 cairo: update_pango_layout([MockDouble])
+cairo: move_to([0, 0])
 cairo: update_pango_layout([MockDouble])
 cairo: show_pango_layout([MockDouble])
 cairo: restore([])