mork 0.17.0 → 0.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0c88481311d1eeaf37c2df7f308dbde8e72968a23cdd8a649012d1591898412
-  data.tar.gz: 90ff649618ec8c71c75e2c1b6fa09a36d0bd9016a1bc529628ab5f4027b4bf97
+  metadata.gz: 9c871eb798a14173c833892d6cb6030e266158239058f9ef0fbb2ff359c1073f
+  data.tar.gz: 8e2ac94ee3e806455d617f959459eebe6964521c9711064e5f0c86facf9fda8f
 SHA512:
-  metadata.gz: 16bbe20136a27742f2247b7ac00856e3dd1bb68349149c65ba94ab5bb06656ecf92e2400a509953251af5074bfbc1bbbd7db63b74a299e9c785db751750e4d10
-  data.tar.gz: 30b783689b3bac8dc7785fcaeac7681eb3da5f1d9f6a679a7a08be267094b918e71fc103c3ab7d69d4ac90a4de77a164e39aa4717fa047d42fa46eddc6b3c8d4
+  metadata.gz: 464bb64cfe62e30bba0037b154d527a00d165b1bd71b4ffa4534bc28cace42fd86aa8455d927d6d660c218d25be92cca4292f60aa66b787af8ce9ed7bea82ba9
+  data.tar.gz: 37ab32c16c165c6c120a8addca74a6bafbe44a02d494ab80968a499dd5d44bad1b6402031c3ff8703a94b8ffbcdd8fc6afd093369b9535883aa49aa2ff2dd0e3

data/README.md

@@ -64,6 +64,14 @@ Response sheets are created through the `Mork::SheetPDF` class. Two pieces of in
 s = SheetPDF.new content, layout
 ```
 
+Mork uses its bundled Open Sans Regular font for all text in generated PDFs.
+Prawn embeds only the glyphs used by each document, so no font needs to be
+installed on the host that creates or prints the PDF. Open Sans covers extended
+Latin, Greek, Cyrillic, and Hebrew, but it does not cover every Unicode script;
+Arabic, Indic scripts, CJK, and emoji are not supported by Mork's default font.
+The bundled font is distributed under the SIL Open Font License in
+`lib/mork/fonts/OFL.txt`.
+
 Let’s look at each argument in turn.
 
 ### content

data/lib/mork/fonts/OFL.txt

@@ -0,0 +1,88 @@
+Copyright 2020 The Open Sans Project Authors (https://github.com/googlefonts/opensans)
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font
+creation efforts of academic and linguistic communities, and to
+provide a free and open framework in which fonts may be shared and
+improved in partnership with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply to
+any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software
+components as distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to,
+deleting, or substituting -- in part or in whole -- any of the
+components of the Original Version, by changing formats or by porting
+the Font Software to a new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed,
+modify, redistribute, and sell modified and unmodified copies of the
+Font Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components, in
+Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the
+corresponding Copyright Holder. This restriction only applies to the
+primary font name as presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created using
+the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

data/lib/mork/sheet_pdf.rb

@@ -6,6 +6,11 @@ module Mork
   # Generating response sheets as PDF files.
   # See the README file for usage
   class SheetPDF < Prawn::Document
+    DEFAULT_FONT_FAMILY = 'Open Sans'
+    DEFAULT_FONT_PATH = File.expand_path('fonts/OpenSans-Regular.ttf', __dir__)
+    ITEM_TEXT_RISE_EM = 0.177
+    private_constant :DEFAULT_FONT_FAMILY, :DEFAULT_FONT_PATH, :ITEM_TEXT_RISE_EM
+
     include Extensions
     def initialize(content, layout=nil, duplex=false)
       @content =
@@ -24,6 +29,7 @@ module Mork
         else raise ArgumentError, 'Invalid initialization parameter'
         end
       super my_page_params
+      use_default_font
       @duplex = duplex
       process
     end
@@ -44,6 +50,15 @@ module Mork
     private
     ###########################################################################
 
+    def use_default_font
+      font_families.update(
+        DEFAULT_FONT_FAMILY => {
+          normal: { file: DEFAULT_FONT_PATH, subset: true }
+        }
+      )
+      font DEFAULT_FONT_FAMILY
+    end
+
     def my_page_params
       {
         page_size: @grip.page_size,
@@ -63,9 +78,7 @@ module Mork
         start_new_page if i>0
         barcode(content[:barcode] || 0)
         header(content[:header] || [])
-        unless equal_choice_number?
-          questions_and_choices ch_len[i]
-        end
+        choice_cells(ch_len[i]) unless equal_choice_number?
         start_new_page if @duplex
       end
     end
@@ -73,11 +86,9 @@ module Mork
     def make_repeaters
       pages = @duplex ? :odd : :all
 
-      if equal_choice_number?
-        repeat(pages) do
-          questions_and_choices ch_len.first
-        end
-      end
+      repeat(pages) { question_numbers }
+
+      repeat(pages) { choice_cells(ch_len.first) } if equal_choice_number?
 
       repeat(pages) do
         calibration_cell_repeater
@@ -129,14 +140,19 @@ module Mork
       end
     end
 
-    def questions_and_choices(n_ch)
-      n_ch.each_with_index do |n, i|
+    def question_numbers
+      ch_len.first.length.times do |i|
         text_box "#{i+1}",
-                 at: @grip.qnum_xy(i),
+                 at: item_text_at(@grip.qnum_xy(i)),
                  width: @grip.qnum_width,
                  height: @grip.height_of_cell,
                  align: :right,
                  valign: :center
+      end
+    end
+
+    def choice_cells(n_ch)
+      n_ch.each_with_index do |n, i|
         stamp_at "s#{n}", @grip.item_xy(i)
       end
     end
@@ -161,7 +177,7 @@ module Mork
                                    @grip.width_of_uid,
                                    @grip.height_of_uid,
                                    @grip.uround
-          text_box i, at: [offx, 0],
+          text_box i, at: item_text_at([offx, 0]),
                       width: @grip.width_of_uid,
                       height: @grip.height_of_uid,
                       align: :center,
@@ -186,19 +202,31 @@ module Mork
                                @grip.height_of_cell,
                                @grip.cround
       text_box l,
-               at:     [x,0],
+               at:     item_text_at([x, 0]),
                width:  @grip.width_of_cell,
                height: @grip.height_of_cell,
                align:  :center,
                valign: :center
     end
 
+    # Prawn vertically centers the font's full ascender box. Open Sans has a
+    # tall ascender relative to its visible capitals and digits, so raise only
+    # item text while leaving the OMR geometry unchanged.
+    def item_text_at(position)
+      [position[0], position[1] + @grip.item_font_size * ITEM_TEXT_RISE_EM]
+    end
+
     def equal_choice_number?
-      return false unless ch_len.all? { |c| c.length == ch_len[0].length }
-      ch_len[0].each_with_index do |c, i|
-        return false unless ch_len.all? { |x| c == x[i] }
+      return @equal_choice_number unless @equal_choice_number.nil?
+
+      first_choices = ch_len.first
+      return @equal_choice_number = false unless ch_len.all? { |c| c.length == first_choices.length }
+
+      first_choices.each_with_index do |c, i|
+        return @equal_choice_number = false unless ch_len.all? { |x| c == x[i] }
       end
-      true
+
+      @equal_choice_number = true
     end
 
     def ensure_presence_of_choices

data/lib/mork/version.rb

@@ -1,3 +1,3 @@
 module Mork
-  VERSION = '0.17.0'
+  VERSION = '0.18.1'
 end

data/script/bench_sheet_pdf.rb

@@ -0,0 +1,40 @@
+require 'benchmark'
+require 'mork'
+
+def build_content(pages:, unequal:)
+  Array.new(pages) do |i|
+    choices =
+      if unequal
+        Array.new(120) { |j| 1 + ((i + j) % 5) }
+      else
+        [5] * 120
+      end
+
+    {
+      barcode: i,
+      choices: choices,
+      header: { title: "Test #{i + 1}" }
+    }
+  end
+end
+
+def measure(label)
+  started_at = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+  result = yield
+  elapsed = Process.clock_gettime(Process::CLOCK_MONOTONIC) - started_at
+  [label, elapsed, result]
+end
+
+puts "ruby=#{RUBY_VERSION} prawn=#{Prawn::VERSION}"
+puts "pages\tshape\tbuild_s\trender_s\tbytes"
+
+[1, 20, 100].each do |pages|
+  [[false, 'equal'], [true, 'unequal']].each do |unequal, shape|
+    content = build_content(pages: pages, unequal: unequal)
+
+    _, build_s, pdf = measure('build') { Mork::SheetPDF.new(content) }
+    _, render_s, bytes = measure('render') { pdf.to_pdf.bytesize }
+
+    puts [pages, shape, format('%.6f', build_s), format('%.6f', render_s), bytes].join("\t")
+  end
+end

data/spec/mork/sheet_pdf_spec.rb

@@ -48,6 +48,38 @@ module Mork
       expect(sp.instance_variable_get('@content').first).to be_a Hash
     end
 
+    it 'uses the bundled Open Sans font with subsetting' do
+      pdf = SheetPDF.new({})
+
+      expect(pdf.font.family).to eq 'Open Sans'
+      expect(pdf.font.options[:subset]).to be true
+      expect(pdf.font.options[:file]).to end_with 'lib/mork/fonts/OpenSans-Regular.ttf'
+    end
+
+    it 'embeds Open Sans and renders supported Unicode across pages' do
+      content = [
+        { header: { title: 'Extended Latin: Ž; Greek: Ω' } },
+        { header: { title: 'Cyrillic: Ж; Hebrew: א' } }
+      ]
+
+      bytes = SheetPDF.new(content).to_pdf
+
+      expect(bytes).to include '/FontFile2'
+      expect(bytes).to include 'OpenSans-Regular'
+    end
+
+    it 'raises item labels without changing their OMR coordinates' do
+      pdf = SheetPDF.new({})
+      grid = pdf.instance_variable_get('@grip')
+      cell_position = grid.item_xy(0)
+
+      text_position = pdf.send(:item_text_at, cell_position)
+
+      expect(text_position[0]).to eq cell_position[0]
+      expect(text_position[1] - cell_position[1]).to be_within(0.001).of(1.593)
+      expect(grid.item_xy(0)).to eq cell_position
+    end
+
     it 'creates a minimal PDF sheet' do
       s = SheetPDF.new({})
       s.save dest 'minimal'
@@ -106,6 +138,23 @@ module Mork
       SheetPDF.new(c).save dest('uneq')
     end
 
+    it 'reuses question number repeaters for multi-page unequal batches' do
+      choices = Array.new(120) { |i| 1 + (i % 5) }
+      c = 3.times.map do |x|
+        {
+          barcode: x,
+          choices: choices.rotate(x),
+          header: { title: "Test #{x+1}" }
+        }
+      end
+
+      pdf = SheetPDF.new(c)
+
+      expect(pdf.page_count).to eq 3
+      expect(pdf.repeaters.length).to eq 2
+      expect { pdf.to_pdf }.not_to raise_error
+    end
+
     it 'creates 20 PDF sheets' do
       c = 20.times.map do |x|
         content.merge({ header: {title: "Test #{x+1}"}, barcode: x})
@@ -130,4 +179,3 @@ module Mork
     end
   end
 end
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mork
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.1
 platform: ruby
 authors:
 - Giuseppe Bertini
@@ -183,6 +183,8 @@ files:
 - lib/mork.rb
 - lib/mork/coord.rb
 - lib/mork/extensions.rb
+- lib/mork/fonts/OFL.txt
+- lib/mork/fonts/OpenSans-Regular.ttf
 - lib/mork/grid.rb
 - lib/mork/grid_const.rb
 - lib/mork/grid_omr.rb
@@ -195,6 +197,7 @@ files:
 - lib/mork/version.rb
 - mork.code-workspace
 - mork.gemspec
+- script/bench_sheet_pdf.rb
 - spec/mork/coord_spec.rb
 - spec/mork/grid_omr_spec.rb
 - spec/mork/grid_spec.rb