qhandout 0.2.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+Copyright (c) 2010 QWAN - Quality Without a Name
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/qhandout.rb

@@ -0,0 +1,195 @@
+require "rubygems"
+
+require "prawn"
+require "prawn/measurement_extensions"
+
+GRAY        = 'aaaaaa'
+ORCHID      = '9932CD'
+BLACK       = '000000'
+
+class Prawn::Document
+  def texts(lines, *parameters)
+    lines.each do |line|
+      text line, *parameters
+    end
+  end
+
+  def with_shadow(parameters = {})
+    shadow_color = parameters[:color] || GRAY
+    depth = parameters[:depth] || 0.5.mm
+
+    original_cursor = cursor
+    original_fill_color = fill_color
+
+    fill_color shadow_color
+
+    move_down depth
+    indent depth do
+      yield
+    end
+
+    move_cursor_to original_cursor
+    fill_color original_fill_color
+    yield
+  end
+
+  def text_with_shadow(*text_args)
+    with_shadow do
+      text *text_args
+    end
+  end
+end
+
+class Handout
+  DEFAULT_TRAINERS = [
+      ["Rob Westgeest", "Westgeest-Consultancy",
+       "Gondelstraat 2", "5017 CK  Tilburg, NL", "+31 6 45 776 328", "rob@qwan.it"],
+      ["Marc Evers", "Piecemeal Growth", "Delftseschans 18",
+       "3432 TD  Nieuwegein, NL", "+31 6 4455 0003", "marc@qwan.it"],
+      ["Willem van den Ende", "Living Software B.V.", "Spilmanstraat 25",
+       "5645 JE  Eindhoven, NL", "+31 6 4130 6965", "willem@qwan.it"]]
+
+  SERIF_FONT      = "Times-Roman"
+  COMIC_SANS_FONT = "#{Prawn::BASEDIR}/data/fonts/comicsans.ttf"
+
+
+  def self.create(parameters)
+    raise "need course name" unless parameters[:course]
+    raise "need course dates" unless parameters[:date]
+    raise "need location/client" unless parameters[:location]
+    raise "need titles and goals for tabs" unless parameters[:tabs]
+
+    handout = Handout.new parameters
+    handout.create_frontpage
+    handout.create_toc
+    handout.create_tabs
+  end
+
+  def initialize arguments = {}
+    @trainers = arguments[:trainers] || DEFAULT_TRAINERS
+    @course = arguments[:course] || ""
+    @date = arguments[:date] || ""
+    @location = arguments[:location] || ""
+    @tabs = arguments[:tabs] || [[]]
+  end
+
+  def header(pdf)
+    pdf.font COMIC_SANS_FONT
+    pdf.fill_color GRAY
+    
+    pdf.with_shadow :color => BLACK do
+      pdf.text @course, :size => 20, :align => :center
+    end
+  end
+
+  def footer(pdf, text)
+    pdf.move_cursor_to(10.mm)
+    pdf.text text, :align => :center
+  end
+
+  def new_page(pdf_file, footer_text = "")
+    Prawn::Document.generate(pdf_file, :page_size => 'A4',
+        :left_margin => 15.mm,
+        :right_margin => 15.mm,
+        :top_margin => 20.mm,
+        :bottom_margin => 15.mm
+    ) do | pdf |
+      yield pdf
+
+      footer(pdf, footer_text)
+    end
+  end
+
+  def add_trainer_info(pdf)
+    pdf.column_box([0, pdf.cursor], :columns => 3, :width => pdf.bounds.width) do
+      pdf.texts @trainers[0], :size => 11, :align => :left
+      pdf.bounds.move_past_bottom
+      pdf.texts @trainers[1], :size => 11, :align => :center
+      pdf.bounds.move_past_bottom
+      pdf.texts @trainers[2], :size => 11, :align => :right
+    end
+  end
+
+  def create_frontpage
+    footer = "(c) 2005-2012 QWAN -Quality Without a Name\nwww.qwan.it -- news@qwan.it"
+
+    new_page("frontpage.pdf", footer) do | pdf |
+      pdf.image "#{File.dirname(__FILE__)}/qwan_logo_small.png", :position => :center
+
+      pdf.font "Helvetica"
+      pdf.text "\n\n\nCourse Handout\n\n\n\n", :size => 20, :align => :center
+
+      pdf.fill_color ORCHID
+      pdf.font COMIC_SANS_FONT
+      pdf.text_with_shadow @course, :size => 36, :align => :center
+
+      pdf.fill_color BLACK
+      pdf.font "Helvetica"
+      pdf.text "\n\n\n\n\n\n#{@date}", :size => 20, :align => :center
+
+      pdf.text "#{@location}\n\n\n\n\n\n\n\n", :align => :center
+
+      add_trainer_info(pdf)
+    end
+  end
+
+  def tab_number(pdf, tab_nr)
+    pdf.bounding_box [pdf.bounds.left, pdf.bounds.top], :width => 60, :height => 60 do
+      pdf.text_with_shadow tab_nr, :size => 42
+    end
+  end
+
+  def title_and_goal(pdf, goal, title)
+    pdf.bounding_box [pdf.bounds.left + 28, pdf.bounds.top], :width => 500, :height => 60 do
+      pdf.text_with_shadow title, :size => 18
+      pdf.fill_color BLACK
+      pdf.text goal, :size => 12
+    end
+  end
+
+  def tab_entry(pdf, title, goal, tab_nr)
+    pdf.bounding_box [15.mm, pdf.cursor - 5.mm], :width => 600 do
+      pdf.font SERIF_FONT
+      pdf.fill_color ORCHID
+
+      tab_number(pdf, tab_nr)
+      title_and_goal(pdf, goal, title)
+    end
+  end
+
+  def tab_footer
+    "#{@course} / #{@date}, #{@location}"
+  end
+
+  def create_toc
+    new_page("toc.pdf", tab_footer) do | pdf |
+      header(pdf)
+
+      pdf.move_down 10.mm
+
+      @tabs.each_with_index do | (title, goal), index |
+        tab_entry(pdf, title, goal, (index + 1).to_s)
+      end
+    end
+  end
+
+  def tab(title, goal, tab_nr)
+    new_page("tab#{tab_nr}.pdf", tab_footer) do |pdf|
+      pdf.move_down 40.mm
+
+      tab_entry(pdf, title, "", tab_nr)
+
+      pdf.bounding_box [30.mm, pdf.cursor - 20.mm], :width => 140.mm do
+        pdf.fill_color BLACK
+        pdf.text goal, :size => 16
+      end
+    end
+  end
+
+  def create_tabs
+    @tabs.each_with_index do | (title, goal), index |
+      tab title, goal, (index+1).to_s
+    end
+  end
+end
+

data/test/assert_pdf.rb

@@ -0,0 +1,21 @@
+
+module Test::Unit::Assertions
+  def assert_pdf(pdf, expected_argument)
+    raise "expected argument must be a hash" unless expected_argument.is_a?(Hash)
+    expected = expected_argument[:contains]
+    expected = [expected] if expected && expected.is_a?(String)
+    not_expected = expected_argument[:does_not_contain]
+
+    raise "missing expected text" unless expected or not_expected
+
+    assert File.exist?(pdf), "file '#{pdf}' not found"
+
+    text = `pdftotext #{pdf} -`
+
+    expected.each do |expected_text|
+      assert_match %r{#{expected_text}}, text, "pdf does not contain '#{expected_text}'"
+    end if expected
+
+    assert_no_match %r{#{not_expected}}, text, "pdf does contains '#{not_expected}'" if not_expected
+  end
+end

data/test/test_assert_pdf.rb

@@ -0,0 +1,64 @@
+require "rubygems"
+require "test/unit"
+require "test/unit/assertions"
+require "prawn"
+
+require "assert_pdf"
+
+class AssertPDFTest < Test::Unit::TestCase
+  TEST_FILE = "test.pdf"
+
+  def setup
+    Prawn::Document.generate("test.pdf") do |pdf|
+      pdf.text "www.qwan.it"
+      pdf.text "Rob"
+    end
+  end
+
+  def teardown
+    File.delete "test.pdf" if File.exist? "test.pdf"
+  end
+
+  def test_pdftotext_available
+    `pdftotext test.pdf -`
+    assert_equal 0, $?.to_i, "pdftotext not installed?"
+  end
+
+  def test_assert_non_existing_pdf_fails_test
+    assert_raises MiniTest::Assertion do
+        assert_pdf "doesnotexist.pdf", :contains => "www.qwan.it"
+    end
+  end
+
+  def test_assert_existing_pdf_passes_test
+    assert_pdf TEST_FILE, :contains => "www.qwan.it"
+  end
+
+  def test_assert_without_expected_text_raises_error
+    assert_raises RuntimeError do
+        assert_pdf TEST_FILE, "www.qwan.it"
+    end
+  end
+
+  def test_assert_text_not_in_pdf_fails
+    assert_raises MiniTest::Assertion do
+        assert_pdf TEST_FILE, :contains => "Agile"
+    end
+  end
+
+  def test_assert_multiple_texts_in_pdf_passes
+    assert_pdf TEST_FILE, :contains => ["www.qwan.it", "Rob"]
+  end
+
+  def test_assert_multiple_texts_with_one_not_existing_in_pdf_fails
+    assert_raises MiniTest::Assertion do
+      assert_pdf TEST_FILE, :contains => ["www.qwan.it", "agile"]
+    end
+  end
+
+  def test_asserting_does_non_contain_on_existing_text_fails
+    assert_raises MiniTest::Assertion do
+      assert_pdf TEST_FILE, :does_not_contain => "www.qwan.it"
+    end
+  end
+end

data/test/test_qhandout.rb

@@ -0,0 +1,70 @@
+require "test/unit"
+require "assert_pdf"
+require "qhandout"
+
+class HandoutTest < Test::Unit::TestCase
+  def setup
+    Handout.new(:course => "TDD For Dummies", :date => "10 June 2031", :location => "Utrecht").create_frontpage
+  end
+
+  def teardown
+    File.delete "frontpage.pdf" if File.exist? "FrontPage.pdf"
+  end
+
+  def test_frontpage_contains_default_trainers
+    assert_pdf "frontpage.pdf", :contains => ["Rob", "Tilburg", "Marc", "Willem"]
+  end
+
+  def test_frontpage_contains_course_dates_location_footer
+    assert_pdf "frontpage.pdf", :contains => ["TDD For Dummies", "10 June 2031", "Utrecht"]
+    assert_pdf "frontpage.pdf", :contains => ["2005-2012", "www.qwan.it"]
+  end
+end
+
+class TabsTest < Test::Unit::TestCase
+  def setup
+    @handout = Handout.new :course => "TDD For Dummies", :date => "10 & 11 June 2031", :location => "Utrecht",
+      :tabs => [["Intro", "Get to know each other"], ["RDD", "CRC"]]
+  end
+
+  def delete_if_exists(files)
+    files.each do |file|
+      File.delete file if File.exist? file
+    end
+  end
+
+  def teardown
+    delete_if_exists ["toc.pdf", "tab1.pdf", "tab2.pdf"]
+  end
+
+  def test_create_toc
+    @handout.create_toc
+
+    assert_pdf "toc.pdf", :contains => ["TDD For Dummies"]
+    assert_pdf "toc.pdf", :contains => ["1", "Intro", "Get to know each other"]
+
+    assert_pdf "toc.pdf", :contains => ["10 & 11 June 2031", "Utrecht"]
+  end
+
+  def test_create_toc_with_multiple_entries
+    @handout.create_toc
+
+    assert_pdf "toc.pdf", :contains => ["1", "Intro", "Get to know each other"]
+    assert_pdf "toc.pdf", :contains => ["2", "TDD", "CRC"]
+  end
+
+  def test_create_tab_page
+    @handout.create_tabs
+
+    assert_pdf "tab1.pdf", :contains => ["1", "Intro", "Get to know each other"]
+
+    assert_pdf "tab1.pdf", :contains => ["10 & 11 June 2031", "Utrecht"]
+  end
+
+  def test_create_multiple_tab_pages
+    @handout.create_tabs
+
+    assert_pdf "tab2.pdf", :contains => ["2", "RDD", "CRC"]
+    assert_pdf "tab2.pdf", :does_not_contain => "Intro"
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: qhandout
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Marc Evers
+- Rob Westgeest
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+description: Generate course handout toc/tabs
+email: info@qwan.it
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+files:
+- VERSION
+- lib/qhandout.rb
+- lib/qwan_logo_small.png
+- test/assert_pdf.rb
+- test/test_assert_pdf.rb
+- test/test_qhandout.rb
+- LICENSE.txt
+homepage: http://www.qwan.it
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -189504195
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Generate course handout toc/tabs
+test_files: []