squib 0.2.0 → 0.3.0

data/lib/squib/input_helpers.rb

@@ -1,4 +1,5 @@
 require 'squib/constants'
+require 'squib/args/unit_conversion'
 
 module Squib
   # :nodoc:
@@ -132,7 +133,7 @@ module Squib
           if @custom_colors.key? color.to_s
             color = @custom_colors[color.to_s]
           end
-          opts[key][i] = Cairo::Color.parse(color)
+          opts[key][i] = color
         end
       end
       Squib.logger.debug {"After colorify: #{opts}"}
@@ -197,15 +198,14 @@ module Squib
     # :nodoc:
     # @api private
     def convert_units(opts, needed_params)
-      Squib::UNIT_CONVERSION_PARAMS.each_pair do |param_name, api_param|
+      UNIT_CONVERSION_PARAMS.each_pair do |param_name, api_param|
         if needed_params.include? param_name
-          opts[api_param].each_with_index do |arg, i|
-            case arg.to_s.rstrip
-            when /in$/ #ends with "in"
-              opts[api_param][i] = arg.rstrip[0..-2].to_f * @dpi
-            when /cm$/ #ends with "cm"
-              opts[api_param][i] = arg.rstrip[0..-2].to_f * @dpi * Squib::INCHES_IN_CM
+          if EXPANDING_PARAMS.include? param_name
+            opts[api_param].each_with_index do |arg, i|
+              opts[api_param][i] = Args::UnitConversion.parse(arg, @dpi)
             end
+          else #not an expanding param
+            opts[api_param] = Args::UnitConversion.parse(opts[api_param], @dpi)
           end
         end
       end

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.2.0'
+  VERSION = '0.3.0'
 end

data/samples/colors.rb

@@ -7,10 +7,31 @@ Squib::Deck.new(width: 825, height: 1125, cards: 1) do
   text color: '#f00', str: '3-hex', x: 50, y: y+=50
   text color: '#f00', str: '3-hex (alpha)', x: 50, y: y+=50
   text color: '#ff0000', str: '6-hex', x: 50, y: y+=50
-  text color: '#ff000099', str: '8-hex(alpha) *', x: 50, y: y+=50
+  text color: '#ff000099', str: '8-hex(alpha)', x: 50, y: y+=50
   text color: '#ffff00000000', str: '12-hex', x: 50, y: y+=50
   text color: '#ffff000000009999', str: '12-hex (alpha)', x: 50, y: y+=50
   text color: :burnt_orange, str: 'Symbols of constants too', x: 50, y: y+=50
+  text color: '(0,0)(400,0) blue@0.0 red@1.0', str: 'Linear gradients!', x: 50, y: y+=50
+  text color: '(200,500,10)(200,500,100) blue@0.0 red@1.0', str: 'Radial gradients!', x: 50, y: y+=50
+  # see gradients.rb sample for more on gradients
 
   save_png prefix: 'colors_'
 end
+
+# This script generates a table of the built-in constants
+Squib::Deck.new(width: 3000, height: 1500) do
+  colors = (Cairo::Color.constants - %i(HEX_RE Base RGB CMYK HSV X11))
+  colors.sort_by! {|c| Cairo::Color.parse(c).to_s}
+  x,y,w,h = 0,0,300,50
+  colors.each_with_index do |color, i|
+    rect x: x, y: y, width: w, height: h, fill_color: color
+    text str: color.to_s, x: x + 5, y: y+13, font: 'Sans Bold 16',
+         color: (Cairo::Color.parse(color).to_hsv.v > 0.9) ? '#000': '#fff'
+    y += h
+    if y > @height
+      x += w
+      y = 0
+    end
+  end
+  save_png prefix: 'color_constants_'
+end

data/samples/glass-heart.svg

@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   viewBox="0 0 512 512"
+   id="svg2"
+   version="1.1"
+   inkscape:version="0.91 r13725"
+   sodipodi:docname="glass-heart.svg">
+  <metadata
+     id="metadata22">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <defs
+     id="defs20" />
+  <sodipodi:namedview
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1"
+     objecttolerance="10"
+     gridtolerance="10"
+     guidetolerance="10"
+     inkscape:pageopacity="0"
+     inkscape:pageshadow="2"
+     inkscape:window-width="1920"
+     inkscape:window-height="1018"
+     id="namedview18"
+     showgrid="false"
+     inkscape:zoom="1.3037281"
+     inkscape:cx="399.78879"
+     inkscape:cy="267.43808"
+     inkscape:window-x="-8"
+     inkscape:window-y="-8"
+     inkscape:window-maximized="1"
+     inkscape:current-layer="svg2" />
+  <path
+     style="fill:#000000;stroke:#000000;stroke-width:18.68857956;stroke-opacity:1;fill-opacity:1"
+     d="M 371.24414 28.179688 C 329.86691 28.096623 287.41274 51.03218 261.00391 102.875 C 196.11155 -14.027671 24.628137 13.619783 29.029297 157.66016 C 33.157605 292.77111 183.5304 347.1093 261.00391 481.30078 C 338.40266 347.24199 496.61198 301.41271 492.29492 157.66016 C 489.89034 77.591144 431.71855 28.301089 371.24414 28.179688 z M 358.9082 49.480469 C 372.3905 49.61861 388.76091 53.818062 405.73047 62.265625 C 444.51802 81.57434 471.74936 115.76108 466.55273 138.62305 C 461.3561 161.48501 425.69966 164.36536 386.91211 145.05664 C 348.12455 125.74793 320.89517 91.56314 326.0918 68.701172 C 329.0149 55.841315 341.57382 49.302858 358.9082 49.480469 z M 148.91016 49.492188 C 159.88856 49.603754 173.21708 52.996781 187.03516 59.820312 C 218.61934 75.416956 240.79389 103.02923 236.5625 121.49609 C 232.3311 139.96294 203.29706 142.29 171.71289 126.69336 C 140.12871 111.09671 117.95416 83.482482 122.18555 65.015625 C 124.56571 54.628018 134.79506 49.348745 148.91016 49.492188 z M 263.11719 179.0332 C 373.07132 179.0332 462.20703 196.90249 462.20703 218.94727 C 462.20703 223.81036 457.86399 228.46946 449.92188 232.7793 C 411.40329 313.40731 320.36729 360.01624 263.00195 457.04297 C 206.07092 360.7538 119.55662 313.16333 78.189453 235.61133 C 84.123672 237.57886 90.694402 239.43942 97.783203 241.1875 C 76.471815 234.83175 64.027344 227.18135 64.027344 218.94727 C 64.027344 196.90249 153.16306 179.0332 263.11719 179.0332 z M 97.783203 241.1875 C 133.52789 251.84773 194.23275 258.86328 263.11719 258.86328 C 348.81534 258.86328 421.8618 248.00627 449.92188 232.7793 C 450.10835 232.38896 450.30232 232.00327 450.48633 231.61133 C 365.1295 267.11537 188.10527 263.46067 97.783203 241.1875 z "
+     id="path10" />
+</svg>

data/samples/gradients.rb

@@ -0,0 +1,34 @@
+require 'squib'
+
+Squib::Deck.new do
+  # Just about anywhere Squib takes in a color it can also take in a gradient too
+  # The x-y coordinates on the card itself,
+  # and then color stops are defined between 0 and 1
+  background color: '(0,0)(0,1125) #ccc@0.0 #111@1.0'
+  line stroke_color: '(0,0)(825,0) #111@1.0 #ccc@0.0',
+      x1: 0, y1: 600, x2: 825, y2: 600,
+       stroke_width: 15
+
+  # Radial gradients look like this
+  circle fill_color: '(425,400,2)(425,400,120) #ccc@0.0 #111@1.0',
+         x: 415, y: 415, radius: 100, stroke_color: '#0000'
+  triangle fill_color: '(650,400,2)(650,400,120) #ccc@0.0 #111@1.0',
+           stroke_color: '#0000',
+           x1: 650, y1: 360,
+           x2: 550, y2: 500,
+           x3: 750, y3: 500
+
+  # Gradients are also good for beveling effects:
+  rect fill_color: '(0,200)(0,600) #111@0.0 #ccc@1.0',
+       x: 30, y: 350, width: 150, height: 150,
+       radius: 15, stroke_color: '#0000'
+  rect fill_color: '(0,200)(0,600) #111@1.0 #ccc@0.0',
+       x: 40, y: 360, width: 130, height: 130,
+       radius: 15, stroke_color: '#0000'
+
+  # Alpha transparency can be used too
+  text str: 'Hello, world!', x: 75, y: 700, font: 'Sans Bold 72',
+       color: '(0,0)(825,0) #000f@0.0 #0000@1.0'
+
+  save_png prefix: 'gradient_'
+end

data/samples/load_images.rb

@@ -32,5 +32,19 @@ Squib::Deck.new(width: 825, height: 1125, cards: 1) do
   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: '(500,1000)(500,800) #333@0.0 #ccc@1.0 ',
+      file: 'glass-heart.svg',
+      x: 500, y: 800, width: 200, height: 200
+
+  # Masks are based on transparency, so this is just a square
+  png mask: :magenta, file: 'shiny-purse.png',
+      x: 650, y: 950
+
   save prefix: 'load_images_', format: :png
 end

data/samples/saves.rb

@@ -11,6 +11,11 @@ Squib::Deck.new(width: 825, height: 1125, cards: 16) do
   # Place on multiple pages over the PDF, with bleed beeing trimmed off
   save_pdf file: 'save-pdf.pdf', margin: 75, gap: 5, trim: 37
 
+  # PDFs also support arbitrary paper sizes, in pixels or any other supported units
+  save_pdf file: 'save-pdf-small.pdf',
+           width: '7in', height: '5in',
+           range: 0..1
+
   # Note that our PNGs still are not trimmed even though the pdf ones were
   save_png range: 1, prefix: 'saves_notrim_'
 

data/spec/api/api_image_spec.rb

@@ -7,7 +7,7 @@ describe Squib::Deck, 'images' do
      it 'calls Card#png, Dir, and progress bar' do
       card = instance_double(Squib::Card)
       progress = double(Squib::Progress)
-      expect(card).to receive(:png).with('foo', 0, 1, :native, :native, 0.5, :overlay, 0.75).once
+      expect(card).to receive(:png).with('foo', 0, 1, :native, :native, 0.5, :overlay, 0.75, nil).once
       expect(Dir).to receive(:chdir).with('.').and_yield.once
       expect(progress).to receive(:start).and_yield(progress).once
       expect(progress).to receive(:increment).once
@@ -23,7 +23,7 @@ describe Squib::Deck, 'images' do
      it 'calls Card#svg, Dir, and progress bar' do
       card = instance_double(Squib::Card)
       progress = double(Squib::Progress)
-      expect(card).to receive(:svg).with('foo', '#bar', 0, 1, 20, 30, 0.5, :overlay, 0.75).once
+      expect(card).to receive(:svg).with('foo', '#bar', 0, 1, 20, 30, 0.5, :overlay, 0.75, nil).once
       expect(Dir).to receive(:chdir).with('.').and_yield.once
       expect(progress).to receive(:start).and_yield(progress).once
       expect(progress).to receive(:increment).once

data/spec/args/unit_conversion_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'squib/args/unit_conversion'
+
+describe Squib::Args::UnitConversion do
+
+  it 'does nothing on just numbers'  do
+    expect(subject.parse(20)).to eq(20)
+  end
+
+  it 'strips trailing whitespace'  do
+    expect(subject.parse('1in ')).to eq(300)
+  end
+
+  it 'is ok w/internal whitesapce' do
+    expect(subject.parse('1 in')).to eq(300)
+  end
+
+  it 'does cm'                      do
+    expect(subject.parse('1cm')).to eq(118.1102361)
+  end
+
+end

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

@@ -1,17 +1,17 @@
 cairo: save([])
-cairo: set_source_color([#<Cairo::Color::RGB: @alpha=1.0, @red=1.0, @green=1.0, @blue=1.0>])
+cairo: set_source_color([:white])
 cairo: paint([])
 cairo: restore([])
 cairo: save([])
-cairo: set_source_color([#<Cairo::Color::RGB: @alpha=1.0, @red=1.0, @green=1.0, @blue=1.0>])
+cairo: set_source_color([:white])
 cairo: paint([])
 cairo: restore([])
 cairo: save([])
-cairo: set_source_color([#<Cairo::Color::RGB: @alpha=1.0, @red=1.0, @green=1.0, @blue=1.0>])
+cairo: set_source_color([:white])
 cairo: paint([])
 cairo: restore([])
 cairo: save([])
-cairo: set_source_color([#<Cairo::Color::RGB: @alpha=1.0, @red=0.0, @green=0.0, @blue=0.0>])
+cairo: set_source_color([:black])
 cairo: translate([65, 400])
 cairo: rotate([0])
 cairo: translate([-65, -400])
@@ -33,7 +33,7 @@ cairo: set_line_width([2.0])
 cairo: stroke([])
 cairo: restore([])
 cairo: save([])
-cairo: set_source_color([#<Cairo::Color::RGB: @alpha=1.0, @red=0.0, @green=0.0, @blue=0.0>])
+cairo: set_source_color([:black])
 cairo: translate([65, 400])
 cairo: rotate([0])
 cairo: translate([-65, -400])
@@ -55,7 +55,7 @@ cairo: set_line_width([2.0])
 cairo: stroke([])
 cairo: restore([])
 cairo: save([])
-cairo: set_source_color([#<Cairo::Color::RGB: @alpha=1.0, @red=0.0, @green=0.0, @blue=0.0>])
+cairo: set_source_color([:black])
 cairo: translate([65, 400])
 cairo: rotate([0])
 cairo: translate([-65, -400])
@@ -76,6 +76,6 @@ cairo: set_source_color([:red])
 cairo: set_line_width([2.0])
 cairo: stroke([])
 cairo: restore([])
-surface: write_to_png(["_output/autoscale_0.png"])
-surface: write_to_png(["_output/autoscale_1.png"])
-surface: write_to_png(["_output/autoscale_2.png"])
+surface: write_to_png(["_output/autoscale_00.png"])
+surface: write_to_png(["_output/autoscale_01.png"])
+surface: write_to_png(["_output/autoscale_02.png"])

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

@@ -1,71 +1,71 @@
 cairo: save([])
-cairo: set_source_color([#<Cairo::Color::RGB: @alpha=1.0, @red=1.0, @green=1.0, @blue=1.0>])
+cairo: set_source_color([:white])
 cairo: paint([])
 cairo: restore([])
 cairo: save([])
-cairo: set_source_color([#<Cairo::Color::RGB: @alpha=1.0, @red=1.0, @green=1.0, @blue=1.0>])
+cairo: set_source_color([:white])
 cairo: paint([])
 cairo: restore([])
 cairo: save([])
-cairo: set_source_color([#<Cairo::Color::RGB: @alpha=1.0, @red=1.0, @green=1.0, @blue=1.0>])
+cairo: set_source_color([:white])
 cairo: paint([])
 cairo: restore([])
 cairo: save([])
 cairo: rounded_rectangle([38, 38, 750, 1050, 38, 38])
-cairo: set_source_color([#<Cairo::Color::RGB: @alpha=1.0, @red=0.0, @green=0.0, @blue=0.0>])
+cairo: set_source_color([:black])
 cairo: set_line_width([2.0])
 cairo: stroke([])
 cairo: rounded_rectangle([38, 38, 750, 1050, 38, 38])
-cairo: set_source_color([#<Cairo::Color::RGB: @alpha=0.0, @red=0.0, @green=0.0, @blue=0.0>])
+cairo: set_source_color(["#0000"])
 cairo: fill([])
 cairo: restore([])
 cairo: save([])
 cairo: rounded_rectangle([38, 38, 750, 1050, 38, 38])
-cairo: set_source_color([#<Cairo::Color::RGB: @alpha=1.0, @red=0.0, @green=0.0, @blue=0.0>])
+cairo: set_source_color([:black])
 cairo: set_line_width([2.0])
 cairo: stroke([])
 cairo: rounded_rectangle([38, 38, 750, 1050, 38, 38])
-cairo: set_source_color([#<Cairo::Color::RGB: @alpha=0.0, @red=0.0, @green=0.0, @blue=0.0>])
+cairo: set_source_color(["#0000"])
 cairo: fill([])
 cairo: restore([])
 cairo: save([])
 cairo: rounded_rectangle([38, 38, 750, 1050, 38, 38])
-cairo: set_source_color([#<Cairo::Color::RGB: @alpha=1.0, @red=0.0, @green=0.0, @blue=0.0>])
+cairo: set_source_color([:black])
 cairo: set_line_width([2.0])
 cairo: stroke([])
 cairo: rounded_rectangle([38, 38, 750, 1050, 38, 38])
-cairo: set_source_color([#<Cairo::Color::RGB: @alpha=0.0, @red=0.0, @green=0.0, @blue=0.0>])
+cairo: set_source_color(["#0000"])
 cairo: fill([])
 cairo: restore([])
 cairo: save([])
 cairo: rounded_rectangle([75, 75, 128, 128, 25, 25])
-cairo: set_source_color([#<Cairo::Color::RGB: @alpha=1.0, @red=0.0, @green=0.0, @blue=0.0>])
+cairo: set_source_color([:black])
 cairo: set_line_width([2.0])
 cairo: stroke([])
 cairo: rounded_rectangle([75, 75, 128, 128, 25, 25])
-cairo: set_source_color([#<Cairo::Color::RGB: @alpha=0.0, @red=0.0, @green=0.0, @blue=0.0>])
+cairo: set_source_color(["#0000"])
 cairo: fill([])
 cairo: restore([])
 cairo: save([])
 cairo: rounded_rectangle([75, 75, 128, 128, 25, 25])
-cairo: set_source_color([#<Cairo::Color::RGB: @alpha=1.0, @red=0.0, @green=0.0, @blue=0.0>])
+cairo: set_source_color([:black])
 cairo: set_line_width([2.0])
 cairo: stroke([])
 cairo: rounded_rectangle([75, 75, 128, 128, 25, 25])
-cairo: set_source_color([#<Cairo::Color::RGB: @alpha=0.0, @red=0.0, @green=0.0, @blue=0.0>])
+cairo: set_source_color(["#0000"])
 cairo: fill([])
 cairo: restore([])
 cairo: save([])
 cairo: rounded_rectangle([75, 75, 128, 128, 25, 25])
-cairo: set_source_color([#<Cairo::Color::RGB: @alpha=1.0, @red=0.0, @green=0.0, @blue=0.0>])
+cairo: set_source_color([:black])
 cairo: set_line_width([2.0])
 cairo: stroke([])
 cairo: rounded_rectangle([75, 75, 128, 128, 25, 25])
-cairo: set_source_color([#<Cairo::Color::RGB: @alpha=0.0, @red=0.0, @green=0.0, @blue=0.0>])
+cairo: set_source_color(["#0000"])
 cairo: fill([])
 cairo: restore([])
 cairo: save([])
-cairo: set_source_color([#<Cairo::Color::RGB: @alpha=1.0, @red=0.0, @green=0.0, @blue=0.0>])
+cairo: set_source_color([:black])
 cairo: translate([220, 78])
 cairo: rotate([0])
 cairo: translate([-220, -78])
@@ -82,7 +82,7 @@ cairo: update_pango_layout([MockDouble])
 cairo: show_pango_layout([MockDouble])
 cairo: restore([])
 cairo: save([])
-cairo: set_source_color([#<Cairo::Color::RGB: @alpha=1.0, @red=0.0, @green=0.0, @blue=0.0>])
+cairo: set_source_color([:black])
 cairo: translate([220, 78])
 cairo: rotate([0])
 cairo: translate([-220, -78])
@@ -99,7 +99,7 @@ cairo: update_pango_layout([MockDouble])
 cairo: show_pango_layout([MockDouble])
 cairo: restore([])
 cairo: save([])
-cairo: set_source_color([#<Cairo::Color::RGB: @alpha=1.0, @red=0.0, @green=0.0, @blue=0.0>])
+cairo: set_source_color([:black])
 cairo: translate([220, 78])
 cairo: rotate([0])
 cairo: translate([-220, -78])
@@ -116,7 +116,7 @@ cairo: update_pango_layout([MockDouble])
 cairo: show_pango_layout([MockDouble])
 cairo: restore([])
 cairo: save([])
-cairo: set_source_color([#<Cairo::Color::RGB: @alpha=1.0, @red=0.0, @green=0.0, @blue=0.0>])
+cairo: set_source_color([:black])
 cairo: translate([75, 85])
 cairo: rotate([0])
 cairo: translate([-75, -85])
@@ -134,7 +134,7 @@ cairo: update_pango_layout([MockDouble])
 cairo: show_pango_layout([MockDouble])
 cairo: restore([])
 cairo: save([])
-cairo: set_source_color([#<Cairo::Color::RGB: @alpha=1.0, @red=0.0, @green=0.0, @blue=0.0>])
+cairo: set_source_color([:black])
 cairo: translate([75, 85])
 cairo: rotate([0])
 cairo: translate([-75, -85])
@@ -152,7 +152,7 @@ cairo: update_pango_layout([MockDouble])
 cairo: show_pango_layout([MockDouble])
 cairo: restore([])
 cairo: save([])
-cairo: set_source_color([#<Cairo::Color::RGB: @alpha=1.0, @red=0.0, @green=0.0, @blue=0.0>])
+cairo: set_source_color([:black])
 cairo: translate([75, 85])
 cairo: rotate([0])
 cairo: translate([-75, -85])
@@ -201,6 +201,6 @@ cairo: translate([-620, -218])
 cairo: set_source([MockDouble, 620, 218])
 cairo: paint([1.0])
 cairo: restore([])
-surface: write_to_png(["_output/basic_0.png"])
-surface: write_to_png(["_output/basic_1.png"])
-surface: write_to_png(["_output/basic_2.png"])
+surface: write_to_png(["_output/basic_00.png"])
+surface: write_to_png(["_output/basic_01.png"])
+surface: write_to_png(["_output/basic_02.png"])

data/spec/data/samples/cairo_access.rb.txt

@@ -1,9 +1,9 @@
 cairo: save([])
-cairo: set_source_color([#<Cairo::Color::RGB: @alpha=1.0, @red=1.0, @green=1.0, @blue=1.0>])
+cairo: set_source_color([:white])
 cairo: paint([])
 cairo: restore([])
 cairo: save([])
-cairo: set_source_color([#<Cairo::Color::RGB: @alpha=1.0, @red=1.0, @green=1.0, @blue=1.0>])
+cairo: set_source_color([:white])
 cairo: paint([])
 cairo: restore([])
 cairo: save([])
@@ -21,5 +21,5 @@ cairo: circle([50, 50, 50])
 cairo: set_source_color([:red])
 cairo: fill([])
 cairo: restore([])
-surface: write_to_png(["_output/cairo_access_0.png"])
-surface: write_to_png(["_output/cairo_access_1.png"])
+surface: write_to_png(["_output/cairo_access_00.png"])
+surface: write_to_png(["_output/cairo_access_01.png"])