squib 0.9.0 → 0.10.0

data/spec/graphics/cairo_context_wrapper_spec.rb

@@ -32,7 +32,7 @@ describe Squib::Graphics::CairoContextWrapper do
       before(:each) do
         dbl = double(Cairo::LinearPattern)
         mtx = double(Cairo::Matrix)
-        expect(Cairo::LinearPattern).to receive(:new).with(1,2,3,4).and_return(dbl)
+        expect(Cairo::LinearPattern).to receive(:new).with(1, 2, 3, 4).and_return(dbl)
         expect(dbl).to   receive(:add_color_stop).with(0.0, 'blue')
         expect(dbl).to   receive(:add_color_stop).with(1.0, 'red')
         expect(cairo).to receive(:matrix).and_return(mtx)
@@ -40,17 +40,17 @@ describe Squib::Graphics::CairoContextWrapper do
         expect(cairo).to receive(:set_source).with(dbl)
       end
 
-      it('handles no decimals'  ) { subject.set_source_squibcolor('(1,2) (3,4) blue@0 red@1') }
-      it('handles decimals'     ) { subject.set_source_squibcolor('(1.0,2.0) (3.0,4.0) blue@0 red@1') }
+      it('handles no decimals') { subject.set_source_squibcolor('(1,2) (3,4) blue@0 red@1') }
+      it('handles decimals') { subject.set_source_squibcolor('(1.0,2.0) (3.0,4.0) blue@0 red@1') }
       it('handles no whitespace') { subject.set_source_squibcolor('(1,2)(3,4)blue@0red@1') }
-      it('handles whitespace'   ) { subject.set_source_squibcolor('  (  1  ,  2  )  ( 3  ,  4  )  blue@0   red@1   ') }
+      it('handles whitespace') { subject.set_source_squibcolor('  (  1  ,  2  )  ( 3  ,  4  )  blue@0   red@1   ') }
     end
 
     context 'regex variations for radial gradients' do
       before(:each) do
         dbl = double(Cairo::RadialPattern)
         mtx = double(Cairo::Matrix)
-        expect(Cairo::RadialPattern).to receive(:new).with(1,2,5,3,4,6).and_return(dbl)
+        expect(Cairo::RadialPattern).to receive(:new).with(1, 2, 5, 3, 4, 6).and_return(dbl)
         expect(dbl).to   receive(:add_color_stop).with(0.0, 'blue')
         expect(dbl).to   receive(:add_color_stop).with(1.0, 'red')
         expect(cairo).to receive(:matrix).and_return(mtx)
@@ -58,17 +58,17 @@ describe Squib::Graphics::CairoContextWrapper do
         expect(cairo).to receive(:set_source).with(dbl)
       end
 
-      it('handles no decimals'  ) { subject.set_source_squibcolor('(1,2,5) (3,4,6) blue@0 red@1') }
-      it('handles decimals'     ) { subject.set_source_squibcolor('(1.0,2.0,5.0) (3.0,4.0,6.0) blue@0 red@1') }
+      it('handles no decimals') { subject.set_source_squibcolor('(1,2,5) (3,4,6) blue@0 red@1') }
+      it('handles decimals') { subject.set_source_squibcolor('(1.0,2.0,5.0) (3.0,4.0,6.0) blue@0 red@1') }
       it('handles no whitespace') { subject.set_source_squibcolor('(1,2,5)(3,4,6)blue@0red@1') }
-      it('handles whitespace'   ) { subject.set_source_squibcolor('  (  1  ,  2  , 5 )  ( 3  ,  4 , 6 )  blue@0   red@1   ') }
+      it('handles whitespace') { subject.set_source_squibcolor('  (  1  ,  2  , 5 )  ( 3  ,  4 , 6 )  blue@0   red@1   ') }
     end
 
     context 'regex handles hash notation' do
       it 'on radial patterns' do
         dbl = double(Cairo::RadialPattern)
         mtx = double(Cairo::Matrix)
-        expect(Cairo::RadialPattern).to receive(:new).with(1,2,5,3,4,6).and_return(dbl)
+        expect(Cairo::RadialPattern).to receive(:new).with(1, 2, 5, 3, 4, 6).and_return(dbl)
         expect(dbl).to   receive(:add_color_stop).with(0.0, '#def')
         expect(dbl).to   receive(:add_color_stop).with(1.0, '#112233')
         expect(cairo).to receive(:matrix).and_return(mtx)
@@ -80,7 +80,7 @@ describe Squib::Graphics::CairoContextWrapper do
       it 'on linear patterns' do
         dbl = double(Cairo::LinearPattern)
         mtx = double(Cairo::Matrix)
-        expect(Cairo::LinearPattern).to receive(:new).with(1,2,3,4).and_return(dbl)
+        expect(Cairo::LinearPattern).to receive(:new).with(1, 2, 3, 4).and_return(dbl)
         expect(dbl).to   receive(:add_color_stop).with(0.0, '#def')
         expect(dbl).to   receive(:add_color_stop).with(1.0, '#112233')
         expect(cairo).to receive(:matrix).and_return(mtx)

data/spec/graphics/graphics_save_doc_spec.rb

@@ -4,7 +4,8 @@ require 'squib'
 describe Squib::Deck, '#save_pdf' do
 
   context 'typical inputs' do
-    let(:cxt) { double(Cairo::Context) }
+    let(:cxt)    { double(Cairo::Context) }
+    let(:target) { double(Cairo::PDFSurface) }
 
     def expect_card_place(x, y)
       expect(cxt).to receive(:translate).with(x, y).once
@@ -13,12 +14,12 @@ describe Squib::Deck, '#save_pdf' do
       expect(cxt).to receive(:set_source)  # place the card
                       .with(instance_of(Cairo::ImageSurface), 0, 0).once
       expect(cxt).to receive(:paint).once  # paint placed card
-      expect(cxt).to receive(:translate).with(-x,-y).once
+      expect(cxt).to receive(:translate).with(-x, -y).once
       expect(cxt).to receive(:reset_clip).once
     end
 
     before(:each) do
-      allow(Cairo::PDFSurface).to receive(:new).and_return(nil) #don't create the file
+      allow(Cairo::PDFSurface).to receive(:new).and_return(nil) # don't create the file
       allow(Cairo::Context).to    receive(:new).and_return(cxt)
       allow(cxt).to receive(:antialias=)
     end
@@ -27,7 +28,7 @@ describe Squib::Deck, '#save_pdf' do
       num_cards = 9
       deck = Squib::Deck.new(cards: 9, width: 825, height: 1125)
       expect(Squib.logger).to receive(:debug).at_least(:once)
-      expect(Squib.logger).to receive(:warn).exactly(:once) #warn about making the dir
+      expect(Squib.logger).to receive(:warn).exactly(:once) # warn about making the dir
       expect(Dir).to receive(:mkdir) {} # don't actually make the dir
       expect(cxt).to receive(:scale).with(0.24, 0.24)
 
@@ -41,6 +42,8 @@ describe Squib::Deck, '#save_pdf' do
       expect_card_place(2343, 1131)
       expect(cxt).to receive(:show_page).once
       expect_card_place(75, 75)
+      expect(cxt).to receive(:target).and_return(target)
+      expect(target).to receive(:finish).once
 
       args = { file: 'foo.pdf', dir: '_out', margin: 75, gap: 5, trim: 37 }
       deck.save_pdf(args)
@@ -51,7 +54,7 @@ describe Squib::Deck, '#save_pdf' do
       args = { range: 2..4, file: 'foo.pdf', dir: '_out', margin: 75, gap: 5, trim: 37 }
       deck = Squib::Deck.new(cards: num_cards, width: 825, height: 1125)
       expect(Squib.logger).to receive(:debug).at_least(:once)
-      expect(Squib.logger).to receive(:warn).exactly(:once) #warn about making the dir
+      expect(Squib.logger).to receive(:warn).exactly(:once) # warn about making the dir
       expect(Dir).to receive(:mkdir) {} # don't actually make the dir
       expect(cxt).to receive(:scale).with(0.24, 0.24)
 
@@ -59,6 +62,9 @@ describe Squib::Deck, '#save_pdf' do
       expect_card_place(831, 75)
       expect_card_place(1587, 75)
 
+      expect(cxt).to receive(:target).and_return(target)
+      expect(target).to receive(:finish).once
+
       deck.save_pdf(args)
     end
 

data/spec/layout_parser_spec.rb

@@ -4,7 +4,7 @@ describe Squib::LayoutParser do
 
   it 'loads a normal layout with no extends' do
     layout = Squib::LayoutParser.load_layout(layout_file('no-extends.yml'))
-    expect(layout).to eq({'frame' => {
+    expect(layout).to eq({ 'frame' => {
             'x' => 38,
             'valign' => :middle,
             'str' => 'blah',
@@ -16,7 +16,7 @@ describe Squib::LayoutParser do
 
   it 'loads with a single extends' do
     layout = Squib::LayoutParser.load_layout(layout_file('single-extends.yml'))
-    expect(layout).to eq({'frame' => {
+    expect(layout).to eq({ 'frame' => {
             'x' => 38,
             'y' => 38,
             },
@@ -32,7 +32,7 @@ describe Squib::LayoutParser do
 
   it 'applies the extends regardless of order' do
     layout = Squib::LayoutParser.load_layout(layout_file('pre-extends.yml'))
-    expect(layout).to eq({'frame' => {
+    expect(layout).to eq({ 'frame' => {
             'x' => 38,
             'y' => 38,
             },
@@ -48,7 +48,7 @@ describe Squib::LayoutParser do
 
   it 'applies the single-level extends multiple times' do
     layout = Squib::LayoutParser.load_layout(layout_file('single-level-multi-extends.yml'))
-    expect(layout).to eq({'frame' => {
+    expect(layout).to eq({ 'frame' => {
             'x' => 38,
             'y' => 38,
             },
@@ -70,7 +70,7 @@ describe Squib::LayoutParser do
 
   it 'applies multiple extends in a single rule' do
     layout = Squib::LayoutParser.load_layout(layout_file('multi-extends-single-entry.yml'))
-    expect(layout).to eq({'aunt' => {
+    expect(layout).to eq({ 'aunt' => {
             'a' => 101,
             'b' => 102,
             'c' => 103,
@@ -81,7 +81,7 @@ describe Squib::LayoutParser do
             'b' => 106,
             },
           'child' => {
-            'extends' => ['uncle','aunt'],
+            'extends' => ['uncle', 'aunt'],
             'a' => 107, # my own
             'b' => 102, # from the younger aunt
             'c' => 103, # from aunt
@@ -94,7 +94,7 @@ describe Squib::LayoutParser do
 
   it 'applies multi-level extends' do
     layout = Squib::LayoutParser.load_layout(layout_file('multi-level-extends.yml'))
-    expect(layout).to eq({'frame' => {
+    expect(layout).to eq({ 'frame' => {
             'x' => 38,
             'y' => 38,
             },
@@ -179,11 +179,23 @@ describe Squib::LayoutParser do
       .with("Processing layout: 'verbal' attempts to extend a missing 'kaisersoze'")
     layout = Squib::LayoutParser.load_layout(layout_file('extends-nonexists.yml'))
     expect(layout).to eq({
-      'verbal'  => {
+      'verbal' => {
           'font_size' => 25,
           'extends' => 'kaisersoze'
         }
       })
   end
 
-end
+  it 'loads progressively on multiple calls' do
+    a = layout_file('multifile-a.yml')
+    b = layout_file('multifile-b.yml')
+    layout = Squib::LayoutParser.load_layout(a)
+    layout = Squib::LayoutParser.load_layout(b, layout)
+    expect(layout).to eq({
+        'title'    => { 'x' => 300 },
+        'subtitle' => { 'x' => 200 },
+        'desc'     => { 'x' => 400 }
+        })
+  end
+
+end

data/spec/logger_spec.rb

@@ -5,8 +5,8 @@ describe Squib.logger do
     Squib.logger = nil
     oldstdout = $stdout
     $stdout = StringIO.new
-    Squib::logger.warn "Test warn"
+    Squib::logger.warn 'Test warn'
     expect($stdout.string).to match /WARN: Test warn/
     $stdout = oldstdout
   end
-end
+end

data/spec/samples/run_samples_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 require 'squib'
 require 'pp'
 
-describe "Squib samples" do
+describe 'Squib samples' do
 
   Dir["#{samples_dir}/**/*.rb"].each do |sample|
     it "executes #{sample} with no errors", slow: true do

data/spec/samples/samples_regression_spec.rb

@@ -2,13 +2,7 @@ require 'spec_helper'
 require 'squib'
 require 'pp'
 
-describe "Squib samples" do
-  
-  around(:each) do |example|
-    Dir.chdir(samples_dir) do
-      example.run
-    end
-  end
+describe 'Squib samples' do
 
   # This test could use some explanation
   # Much of the development of Squib has been sample-driven. Every time I want
@@ -38,23 +32,24 @@ describe "Squib samples" do
   # These are samples that don't really need a regression log
       # colors.rb
       # unicode.rb
-  %w( autoscale_font.rb
+  %w(
+      autoscale_font/_autoscale_font.rb
       basic.rb
       cairo_access.rb
-      csv_import.rb
+      colors/_gradients.rb
       config_text_markup.rb
       custom_config.rb
-      draw_shapes.rb
+      data/_csv.rb
+      data/_excel.rb
       embed_text.rb
-      excel.rb
-      gradients.rb
-      hand.rb
       hello_world.rb
-      load_images.rb
-      portrait-landscape.rb
+      images/_more_load_images.rb
       ranges.rb
-      saves.rb
-      showcase.rb
+      saves/_hand.rb
+      saves/_portrait_landscape.rb
+      saves/_saves.rb
+      saves/_showcase.rb
+      shapes/_draw_shapes.rb
       text_options.rb
       tgc_proofs.rb
       units.rb
@@ -62,7 +57,10 @@ describe "Squib samples" do
     it "has not changed for #{sample}", slow: true do
       log = StringIO.new
       mock_cairo(log)
-      load sample
+      full_sample_path = File.expand_path "#{samples_dir}/#{sample}"
+      Dir.chdir(File.dirname("#{samples_dir}/#{sample}")) do
+        load full_sample_path
+      end
       # overwrite_sample(sample, log) # Use TEMPORARILY once happy with the new sample log
       test_file_str = File.open(sample_regression_file(sample), 'r:UTF-8').read
       expect(log.string).to eq(test_file_str)

data/spec/samples/sanity.rb

@@ -14,14 +14,14 @@ class Sanity
 
   def images
     images   = []
-    exp_pngs = Dir[@@EXPECTED_DIR + "/**/*.png"]
+    exp_pngs = Dir[@@EXPECTED_DIR + '/**/*.png']
     bar      = ProgressBar.create(title: 'Diffing images', total: exp_pngs.size)
     exp_pngs.each do |exp_png|
       row = []
       actual_png = @@OUTPUT_DIR + File.basename(exp_png)
-      row << "file:///" + exp_png
-      row << "file:///" + actual_png #actual
-      row << "file:///" + diff_image(exp_png, actual_png)
+      row << 'file:///' + exp_png
+      row << 'file:///' + actual_png # actual
+      row << 'file:///' + diff_image(exp_png, actual_png)
       images << row
       bar.increment
     end
@@ -30,11 +30,11 @@ class Sanity
   end
 
   def run
-    puts "Building sanity test..."
+    puts 'Building sanity test...'
     sanity_template = File.read(@@SANITY_ERB)
     process_erb(sanity_template)
-    Launchy.open("file:///" + @@SANITY_HTML)
-    puts "Done."
+    Launchy.open('file:///' + @@SANITY_HTML)
+    puts 'Done.'
   end
 
   private
@@ -51,7 +51,7 @@ class Sanity
       end
     end
     out = Cairo::ImageSurface.new(new_data.pack('c*'), exp.format, exp.width, exp.height, exp.stride)
-    out_file = @@DIFF_DIR + exp_file[exp_file.rindex("/")..-1]
+    out_file = @@DIFF_DIR + exp_file[exp_file.rindex('/')..-1]
     out.write_to_png(out_file)
     out_file
   end
@@ -67,4 +67,4 @@ class Sanity
     end
   end
 
-end
+end

data/spec/sanity/.gitignore

@@ -0,0 +1 @@
+sanity.html

data/spec/sanity/sanity.html.erb

@@ -0,0 +1,42 @@
+<!DOCTYPE html>
+<html>
+<head>
+	<meta name="viewport" content="width=device-width">
+	<meta charset="utf-8">
+	<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+	<title>Diff with CSS Example</title>
+	<style>
+		body{
+			/*background:url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAAHElEQVQYlWO4ePFiAzGY4eLFiw0MxIBRhVRRCADsljgKUbBKPgAAAABJRU5ErkJggg==) repeat;*/
+		}
+		img{
+			height: 6in;
+		}
+		.diff {
+			width: 4in;
+			height: 6in;
+			background-repeat: none, none;
+			background-size: contain, contain;
+			background-blend-mode: difference;
+			display: inline-block;
+		}
+
+	</style>
+</head>
+<body>
+
+<% images.each_with_index do |(expected, actual), i| %>
+
+	<img src="<%= expected %>"/>
+	<img src="<%= actual %>"/>
+	<style>
+		.mine<%= i %> {
+			background-image: url(<%= expected %>), url(<%= actual %>);"
+		}
+	</style>
+	<div class="diff mine<%= i %>"/>
+
+<% end %>
+
+</body>
+</html>

data/spec/sanity/sanity_test.rb

@@ -0,0 +1,42 @@
+require 'launchy'
+require 'erb'
+require 'yaml'
+
+# An pixel-by-pixel comparison of sample images for visual regression testing
+class SanityTest
+
+  @@ERB      = "#{File.expand_path(File.dirname(__FILE__))}/sanity.html.erb"
+  @@HTML     = "#{File.expand_path(File.dirname(__FILE__))}/sanity.html"
+  @@COMPARES = "#{File.expand_path(File.dirname(__FILE__))}/tests.yml"
+  @@SAMPLES  = "file:///#{File.expand_path("samples/")}"
+
+  def images
+    require 'pp'
+    comps = YAML.load_file(@@COMPARES)
+    pp comps
+    comps.each do | test, data |
+      pp data
+    end
+    [
+      ["#{@@SAMPLES}/images/_images_00_expected.png", "#{@@SAMPLES}/images/_images_00.png"]
+    ]
+  end
+
+  def run
+    puts @@SAMPLES
+    puts 'Building sanity test...'
+    process_erb(File.read(@@ERB))
+    Launchy.open('file:///' + @@HTML)
+    puts 'Done.'
+  end
+
+  private
+
+  def process_erb(sanity_template)
+    renderer = ERB.new(sanity_template)
+    File.open(@@HTML, 'w+') do |html|
+      html.write(renderer.result(binding))
+    end
+  end
+
+end

data/spec/sanity/tests.yml

@@ -0,0 +1,12 @@
+images:
+  dir: images
+  expected: _images_00_expected.png
+  actual: _images_00.png
+text:
+  dir: text
+  expected: _text_00_expected.png
+  actual: _text_00.png
+autoscale_font:
+  dir: autoscale_font
+  expected: card_00_expected.png
+  actual: card_00.png

data/spec/spec_helper.rb

@@ -2,10 +2,10 @@ require 'simplecov'
 require 'coveralls'
 # require 'byebug'
 
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
   SimpleCov::Formatter::HTMLFormatter,
   Coveralls::SimpleCov::Formatter
-]
+])
 SimpleCov.start
 
 require 'squib'
@@ -14,6 +14,8 @@ RSpec.configure do |config|
   config.mock_with :rspec do |mocks|
     mocks.verify_partial_doubles = true
   end
+  config.tty = true
+  config.color = true
 end
 
 def tmp_dir
@@ -60,17 +62,17 @@ def overwrite_sample(sample_name, log)
 end
 
 def scrub_hex(str)
-  str.gsub(/0x\w{1,8}/,'')
-     .gsub(/ptr=\w{1,8}/,'')
-     .gsub(/#<Pango::FontDescription:.*>/,'')
-     .gsub(/#<Cairo::ImageSurface:.*>/,'ImageSurface')
-     .gsub(/#<Cairo::LinearPattern:.*>/,'LinearPattern')
-     .gsub(/#<Cairo::RadialPattern:.*>/,'RadialPattern')
-     .gsub(/#<Cairo::Matrix:.*>/,'Matrix')
-     .gsub(/#<RSVG::Handle.*>/,'RSVG::Handle')
-     .gsub(/#<RSpec::Mocks::Double:.*>/,'MockDouble')
-     .gsub(/#<Double .*>/,'MockDouble')
-     .gsub(/RGB:\w{1,8}/,'RGB:')
+  str.gsub(/0x\w{1,8}/, '')
+     .gsub(/ptr=\w{1,8}/, '')
+     .gsub(/#<Pango::FontDescription:.*>/, '')
+     .gsub(/#<Cairo::ImageSurface:.*>/, 'ImageSurface')
+     .gsub(/#<Cairo::LinearPattern:.*>/, 'LinearPattern')
+     .gsub(/#<Cairo::RadialPattern:.*>/, 'RadialPattern')
+     .gsub(/#<Cairo::Matrix:.*>/, 'Matrix')
+     .gsub(/#<RSVG::Handle.*>/, 'RSVG::Handle')
+     .gsub(/#<RSpec::Mocks::Double:.*>/, 'MockDouble')
+     .gsub(/#<Double .*>/, 'MockDouble')
+     .gsub(/RGB:\w{1,8}/, 'RGB:')
 end
 
 # Build a mock cairo instance that allows basically any method
@@ -88,22 +90,22 @@ def mock_cairo(strio)
   allow(Cairo::ImageSurface).to receive(:new).and_return(surface)
   allow(surface).to receive(:width).and_return(100)
   allow(surface).to receive(:height).and_return(101)
-  allow(surface).to receive(:ink_extents).and_return([0,0,100,100])
+  allow(surface).to receive(:ink_extents).and_return([0, 0, 100, 100])
   allow(Cairo::Context).to receive(:new).and_return(cxt)
   allow(cxt).to receive(:create_pango_layout).and_return(pango)
   allow(cxt).to receive(:target).and_return(surface)
-  allow(cxt).to receive(:matrix).and_return(Cairo::Matrix.new(1,0,0,1,0,0))
+  allow(cxt).to receive(:matrix).and_return(Cairo::Matrix.new(1, 0, 0, 1, 0, 0))
   allow(pango).to receive(:height).and_return(25)
   allow(pango).to receive(:width).and_return(25)
-  allow(pango).to receive(:index_to_pos).and_return(Pango::Rectangle.new(0,0,0,0))
-  allow(pango).to receive(:extents).and_return([Pango::Rectangle.new(0,0,0,0)]*2)
+  allow(pango).to receive(:index_to_pos).and_return(Pango::Rectangle.new(0, 0, 0, 0))
+  allow(pango).to receive(:extents).and_return([Pango::Rectangle.new(0, 0, 0, 0)] * 2)
   allow(pango).to receive(:iter).and_return(iter)
   allow(pango).to receive(:alignment).and_return(Pango::Layout::Alignment::LEFT)
-  allow(pango).to receive(:text).and_return("foo")
+  allow(pango).to receive(:text).and_return('foo')
   allow(pango).to receive(:context).and_return(pango_cxt)
   allow(pango_cxt).to receive(:font_options=)
   allow(iter).to receive(:next_char!).and_return(false)
-  allow(iter).to receive(:char_extents).and_return(Pango::Rectangle.new(5,5,5,5))
+  allow(iter).to receive(:char_extents).and_return(Pango::Rectangle.new(5, 5, 5, 5))
   allow(iter).to receive(:index).and_return(1000)
   allow(Pango::FontDescription).to receive(:new).and_return(font)
   allow(Cairo::PDFSurface).to receive(:new).and_return(nil)
@@ -126,7 +128,7 @@ def mock_cairo(strio)
     allow(font).to receive(m) { |*args| strio << scrub_hex("pango font: #{m}(#{args})\n") }
   end
 
-  %w(write_to_png).each do |m|
+  %w(write_to_png finish).each do |m|
     allow(surface).to receive(m) { |*args| strio << scrub_hex("surface: #{m}(#{args})\n") }
   end