mork 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9e14458c23c945d7c781c490f6e4420f65a2e23
-  data.tar.gz: dfb6fb2f60f68e6a08c52dfd1be4df0c87c084e1
+  metadata.gz: 1468b498d3b8817fa1535d1764e026c5ecb4db7f
+  data.tar.gz: 3ef072301473be4f4101594a27c60485c6ca9fdd
 SHA512:
-  metadata.gz: f955f5a1ce67ef4754b2f91c2d8a9e439c8dd48a5ba9cbea3668f9785837ec0328de253811b64130073eef4c19ab0de45a7d6e349d2a5a10ea5c6c79474fba7c
-  data.tar.gz: eee3d80c2e233fa5d369d6ec0caf620857f17cd9d145b9a246e3d0c1efa0427d0610509ca5663c0d1fea2b82092f5982f6580dd2e4acdbb0061235bfaac655f4
+  metadata.gz: 736560a4ffa1e59db099382a99440f11eff492b56fc65f02431e9e4b69d45d2f25793389d748f2cc5609524b269ae0d666ac396756194b215424f64b581a37b3
+  data.tar.gz: 810723654fd44aa7eb1acfa57687fb04e2aa368f29933c03597328ca9e14cfd45eb433b1ecd07670fc7bdbed717754a3d0a498d5d95fd304e4554d3efde2c6b6

data/README.md

@@ -7,27 +7,34 @@ A ruby [optical mark recognition](http://en.wikipedia.org/wiki/Optical_mark_reco
 
 ## Assumptions and limitations
 
-Mork is a low-level library, and very much work in progress. It is not, and will likely never be a complete OMR solution. While suggestions and contributions are more than welcome, for the time being several assumptions and restrictions to what the library is capable of apply.
+Mork is a low-level library, and very much work in progress. It is not, and will likely never be a complete OMR solution. While suggestions and contributions are more than welcome, for the time being several assumptions and restrictions apply.
 
 - the PDF files generated by Mork are intended to be printed on regular printer paper
 - the entire response sheet must fit into a single page
 - after collecting the responses, a filled-out form should be acquired as a JPEG, PNG, or PDF image by a normal optical scanner or camera (i.e., no specialized equipment is necessary)
 - independent of how the sheet is printed and the image is acquired, all internal processing is done on a grayscale version of the bitmap
-- the response sheet contains the following items:
+- the response sheet always contains the following items:
   - registration marks at each page corner
-  - a bar code along the bottom margin to uniquely identify the sheet
-  - a header area to print arbitrary information
   - a response area containing a list of numbered items (questions)
   - each item contains an arbitrary number of choice “cells”, each marked with a capital letter (A, B, C, ...)
   - the right edge of the response area is reserved for a column of calibration cells that must remain blank
+- in addition, the sheet may contain:
+  - a bar code along the bottom margin to uniquely identify the sheet
+  - a header area to print arbitrary information
 - it is entirely up to the user to provide parameters that produce the desired response sheet layout; in particular, making sure that the header elements and choice cells fit in the available space, as Mork does not provide any type of "sanity" check at this time
 
 ## Getting started
 
-First, make sure that ImageMagick is installed in your system. In OS X, `brew` is the preferred package manager:
+First, make sure that ImageMagick is installed in your system. Typing `convert in a terminal shell should print out a long help message. If instead you get an error, you will need to install ImageMagick.
+
+In OS X, `brew` is an excellent package manager:
 
     brew install imagemagick
 
+In a Debian-based Linux distro (e.g., Ubuntu) you would do:
+
+    sudo apt-get install imagemagick
+
 To create a small ruby project that uses Mork, `cd` into a directory of choice, then execute the following shell commands:
 
 ```
@@ -46,7 +53,7 @@ Edit the file `mork_test.rb` with the code snippets below, then execute the foll
 
 ## Generating response sheets with `SheetPDF`
 
-Response sheets are created through the `Mork::SheetPDF` class. Two pieces of information must be provided to the class constructor to produce a meaningful object:
+Response sheets are created through the `Mork::SheetPDF` class. Two pieces of information must be provided to the class constructor to produce a meaningful sheet:
 
 - **content**: what to place on the sheet, such as how many response items and choices, what to write in the header, the number to print as a barcode
 - **layout**: sizes, margins, spacing, fonts, etc., of each of the printed elements
@@ -75,11 +82,11 @@ content = {
 }
 ```
 
-These are the key-value pairs that the `content` hash should contain:
+These are the key-value pairs that the `content` hash may contain:
 
-- **barcode**: an integer number, the sheet's unique identifier
-- **choices**: an array of integers, specifiying the number of items in the test (the length of the array) and the number of choices available for each item (the array values)
-- **header**: a (sub)hash of key-value pairs defining the content of named header elements; in each pair, the key is the name of one header element, while the value is the rendered content; the actually available elements are defined in the `layout` (see below)
+- **choices**: an array of integers, specifiying the number of items in the test (the length of the array) and the number of choices available for each item (the array values); if omitted, the maximum number of items and choices per item are printed
+- **header**: optional; a (sub)hash of key-value pairs defining the content of named header elements; in each pair, the key is the name of one header element, while the value is the rendered content; the actually available elements are defined in the `layout` (see below)
+- **barcode**: optional; an integer number, the sheet's unique identifier to be printed as a binary barcode along the bottom edge of the sheet
 
 ### layout
 
@@ -96,7 +103,7 @@ reg_marks:
   offset:           2     # distance between the search area and each page border (*)
   blur:             2     # size of a gaussian blur filter to smooth overly pixelated registration marks (0 to skip) (*)
   dilate:           5     # size of a “dilate” filter to get rid of stray noise (0 to skip) (*)
-  contrast:        20     # minimum contrast between registration mark circles and the surrounding white paper
+  contrast:        20     # minimum contrast between registration mark circles and the surrounding white paper (*)
 header:           
   name:                   # ‘name’ is just a label; you can add arbitrary header elements
     top:            5     # margin relative to registration frame top side
@@ -124,7 +131,7 @@ header:
     size:            7
     box:          true    # header element will be enclosed in a box
 items:
-  threshold:         0.75 # mark detection threshold
+  threshold:         0.75 # mark detection threshold (*)
   top:              55    # response area margin, relative to reg frame
   left:             11    # response area margin, relative to reg frame
   rows:             30    # number of items per column

data/lib/mork/sheet_pdf.rb

@@ -47,13 +47,14 @@ module Mork
       # for all sheets
       line_width 0.3
       font_size @grip.item_font_size
+      ensure_presence_of_choices
       create_stamps
       make_repeaters
       # for each response sheet
       @content.each_with_index do |content, i|
         start_new_page if i>0
-        barcode content[:barcode]
-        header content[:header]
+        barcode(content[:barcode] || 0)
+        header(content[:header] || [])
         unless equal_choice_number?
           questions_and_choices ch_len[i]
         end
@@ -165,6 +166,14 @@ module Mork
       true
     end
 
+    def ensure_presence_of_choices
+      @content.each do |c|
+        if c[:choices].nil?
+          c[:choices] = [@grip.max_choices_per_question] * @grip.max_questions
+        end
+      end
+    end
+
     def ch_len
       @all_choice_lengths ||= @content.collect { |c| c[:choices] }
     end

data/lib/mork/version.rb

@@ -1,3 +1,3 @@
 module Mork
-  VERSION = '0.9.1'
+  VERSION = '0.9.2'
 end

data/spec/mork/sheet_pdf_spec.rb

@@ -85,6 +85,17 @@ module Mork
       s = SheetPDF.new([c,c,c,c,c,c,c,c,c,c,c,c,c,c,c,c,c,c,c,c])
       s.save('spec/out/pdf/p20.pdf')
     end
+
+    it 'creates a pdf with minimal content' do
+      s = SheetPDF.new({choices: [4] * 30})
+      s.save 'spec/out/pdf/mincont.pdf'
+    end
+
+    it 'creates a PDF with the maximum possible choice cells if none are specified' do
+      ct = [{}, {choices: [3]*20}]
+      s = SheetPDF.new ct
+      s.save 'spec/out/pdf/nocontent.pdf'
+    end
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mork
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Giuseppe Bertini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-14 00:00:00.000000000 Z
+date: 2016-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: narray