mork 0.0.2 → 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cf9368eb34bdddb744f80f7baa1475ba03aedeab
+  data.tar.gz: 129f95cfa8329b81154186ec175f0b14a9ba3b72
+SHA512:
+  metadata.gz: 82652798819ce990be08645e337199cc19ce8829bbda397212e958f17f6df3d865c62ab86d80eda12340250cd8f7ac09791b9c7f8a68c9ca060b13c88ff2e9c3
+  data.tar.gz: e733b22b1de5c615982da5c8725c04877654d297584a4677c5194aad2cf66c94074171abf4f7dd8a01ee82d5e62ef30c6d0c69f7b594667297ffd563cfde4a03

data/.gitignore

@@ -1,6 +1,7 @@
 *.gem
 .bundle
 Gemfile.lock
+quick.rb
 pkg/*
 tmp/*
 .rvmrc

data/.ruby-gemset

@@ -0,0 +1 @@
+mork

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p451

data/Gemfile

@@ -1,3 +1,3 @@
 source "http://rubygems.org"
-gem 'prawn', git: 'git://github.com/prawnpdf/prawn', submodules: true
+# gem 'prawn', git: 'git://github.com/prawnpdf/prawn', submodules: true
 gemspec

data/README.md

@@ -0,0 +1,49 @@
+Mork
+====
+
+A ruby [optical mark recognition](http://en.wikipedia.org/wiki/Optical_mark_recognition) (OMR) library to accomplish two tasks:
+
+1. generating [response sheets](/spec/samples/sheet1.pdf) in PDF format (for tests, surveys, etc.)
+2. capturing the responses provided on the [printed sheet](/spec/samples/sheet1.jpg) by a human with a pen or a pencil.
+
+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.
+
+- the generated PDF file is intended to be printed on regular printer paper, and the filled-out form to be acquired as a bitmap image by a normal optical scanner or camera (i.e., no specialized equipment is necessary)
+- the [response sheet](/spec/samples/sheet1.pdf) 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 choices, each marked with a capital letter (A, B, C, ...). In order to maximize contrast, choice "cells" are printed in red
+- with some restrictions, the number of columns in the response area, the numer of items, the number of choices per item, the size and shape of the choice cells can be set by the user
+- all items must fit within the allocated response area of a single sheet
+
+Installing
+----------
+
+Install the gem in your system:
+
+    $ gem install mork
+
+If you are using bundler in your project, as you should, make sure your `Gemfile` contains the following, before running `bundle install`:
+
+    source 'http://rubygems.org'
+    gem 'mork'
+
+Usage
+-----
+
+The layout of the response sheet is described in a YAML file
+
+License
+-------
+
+Copyright (c) 2013 Giuseppe Bertini
+
+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/config/grids.yml

@@ -1,28 +1,32 @@
 default:
+  # units are millimiters
   page_size:
+    # this is A4
     width:       210.0
     height:      297.0
   header:
-    name:
-      top:         3
-      left:        7.5
-      width:     120
-      size:       14
+    title:
+      top:        3
+      left:       7.5
+      width:    150
+      size:      12
     code:
       top:         3
       left:      170
       width:      25
       size:       12
-    title:
-      top:        12
-      left:       7.5
-      width:    180.0
-      size:      12
-    date:
-      top:        18
-      left:       7.5
-      width:    180.0
-      size:      12
+    name:
+      top:        15
+      left:        7.5
+      width:     112
+      size:       14
+    signature:
+      top:        15
+      left:      122
+      width:      70
+      height:     10
+      size:        7
+      box:      true
   responses:
     columns:       4
     column_width: 50.0

data/lib/mork/grid.rb

@@ -164,13 +164,29 @@ module Mork
       ]
     end
     
+    def pdf_header_padding(k)
+      [
+        1.mm,
+        pdf_header_height(k) - 1.mm
+      ]
+      
+    end
+    
     def pdf_header_width(k)
       header[k.to_s]["width"].to_f.mm
     end
 
+    def pdf_header_height(k)
+      header[k.to_s]["height"].to_f.mm
+    end
+
     def pdf_header_size(k)
       header[k.to_s]["size"].to_f
     end
+    
+    def pdf_header_boxed?(k)
+      header[k.to_s]["box"] == true
+    end
 
   private
   
@@ -251,10 +267,10 @@ module Mork
     # ==============
     def code_cell_area(i)
       {
-        x: (cx * code_cell_x(i)  ).round,
-        y: (cy * code_y          ).round,
-        w: (cx * CODE_WIDTH ).round,
-        h: (cy * CODE_HEIGHT).round
+        x: (cx * code_cell_x(i)).round,
+        y: (cy * code_y        ).round,
+        w: (cx * CODE_WIDTH    ).round,
+        h: (cy * CODE_HEIGHT   ).round
       }
     end
   

data/lib/mork/mimage_list.rb

@@ -17,6 +17,8 @@ module Mork
     end
     
     def [] (i)
+      puts "I: #{i}"
+      puts @images[i].inspect
       Mimage.new @images[i]
     end
     

data/lib/mork/sheet.rb

@@ -1,11 +1,13 @@
 module Mork
   class Sheet
-    def initialize(im, grid)
+    def initialize(im, grid=Grid.new)
       im = Mimage.new(im) if im.class == String
       raise "A new sheet requires either a Mimage or the name of the source image file" unless im.class == Mimage
-      # grid = Grid.new(grid) if grid.class == String
-      # raise "A new sheet requires either a Mimage or the name of the source image file" unless im.class == Mimage
       @grid = grid
+      # send page size to the grid, so that all later measurements can be done within the
+      # grid itself; this method assumes a 'stretch' strategy, i.e. where the image
+      # after registration has the same size in pixels as the original scanned file
+      @grid.set_page_size im.width, im.height
       @mimage = register(im)
     end
     
@@ -115,10 +117,6 @@ module Mork
     # ================
     
     def register(img)
-      # send page size to the grid, so that all later measurements can be done within the
-      # grid itself. WARNING: this method assumes a 'stretch' strategy, i.e. where the
-      # image after registration has the same size in pixels as the original scanned file
-      @grid.set_page_size img.width, img.height
       # find the XY coordinates of the 4 registration marks
       x1, y1 = reg_centroid_on(img, @grid.reg_mark_search_area(:top_left))
       x2, y2 = reg_centroid_on(img, @grid.reg_mark_search_area(:top_right))

data/lib/mork/sheet_pdf.rb

@@ -42,9 +42,18 @@ module Mork
     
     def header
       @info[:header].each do |k,v|
-        text_box v, at:    @grid.pdf_header_xy(k),
-                    width: @grid.pdf_header_width(k),
-                    size:  @grid.pdf_header_size(k) || 12
+        font_size @grid.pdf_header_size(k) do
+          if @grid.pdf_header_boxed?(k)
+            bounding_box @grid.pdf_header_xy(k), width: @grid.pdf_header_width(k), height: @grid.pdf_header_height(k) do
+              stroke_bounds
+              bounding_box @grid.pdf_header_padding(k), width: @grid.pdf_header_width(k) do
+                text v
+              end
+            end
+          else
+            text_box v, at: @grid.pdf_header_xy(k), width: @grid.pdf_header_width(k)
+          end
+        end
       end
     end
 
@@ -54,9 +63,9 @@ module Mork
         nquestions.times do |q|
           fill_color "000000"
           text_box "#{q+1}", at: @grid.pdf_qnum_xy(q),
-                             width: @grid.pdf_qnum_width,
-                             align: :right,
-                             size: Q_NUM_SIZE
+          width: @grid.pdf_qnum_width,
+          align: :right,
+          size: Q_NUM_SIZE
           stroke_color "ff0000"
           font_size CH_LETTER_SZ
           nchoices(q).times do |c|
@@ -73,7 +82,7 @@ module Mork
       render_file fn
     end
 
-  private
+    private
     def nquestions
       @info[:choices].length
     end

data/lib/mork/version.rb

@@ -1,3 +1,3 @@
 module Mork
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/mork.gemspec

@@ -17,15 +17,17 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  # specify any dependencies here; for example:
+  # dependencies:
   s.add_dependency "narray"
   s.add_dependency "rmagick"
+  s.add_dependency "prawn"
   s.add_development_dependency 'rake'
   s.add_development_dependency "rspec"
   s.add_development_dependency "cucumber"
   s.add_development_dependency "guard-rspec"
   s.add_development_dependency "guard-shell"
   s.add_development_dependency "rb-fsevent"
+  s.add_development_dependency "awesome_print"
   
   # s.add_runtime_dependency "rest-client"
 end

data/spec/mork/sheet_pdf_spec.rb

@@ -7,27 +7,39 @@ module Mork
         code: 18446744073709551615,
         choices: [5] * 100,
         header: {
-          name: "Bertini Giuseppe VR123456",
-          title: "Esame di Fondamenti Morfologici e Funzionali della Vita",
+          name: "Bertini Giuseppe VR123456 Bertini Giuseppe VR123456",
+          title: "Esame di Fondamenti Morfologici e Funzionali della Vita - 18 gennaio 2013 Esame di Fondamenti Morfologici e Funzionali della Vita - 18 gennaio 2013",
           code:  "119.27",
-          date: "18 gennaio 2013"
+          signature: "Firma"
         }
       }
       s = SheetPDF.new(Grid.new(:default), info)
       s.save("tmp/f1.pdf")
 
       info = {
-        code: 283764283738,
+        code: 17382938642823887837,
         choices: [5] * 100,
         header: {
           name: "Francesco Gagliardi VR765432",
-          title: "Esame di Fondamenti Morfologici e Funzionali della Vita",
-          code:  "119.28",
-          date: "18 gennaio 2013"
+          title: "Esame di Fondamenti Morfologici e Funzionali della Vita - 18 gennaio 2013",
+          code:  "119.28"
         }
       }
       s = SheetPDF.new(Grid.new(:default), info)
       s.save("tmp/f2.pdf")
+
+      info = {
+        code: 8928348236,
+        choices: [5] * 160,
+        header: {
+          name: "G" * 60,
+          title: "E" * 100,
+          code:  "119.28",
+          signature: "Firma"
+        }
+      }
+      s = SheetPDF.new(Grid.new(:default), info)
+      s.save("tmp/f3.pdf")
     end
   end
 end

data/spec/samples/info.yml

@@ -49,5 +49,5 @@ code_zero:
 
 two_pages:
   filename: spec/samples/two_pages.pdf
-  code_int: 18446744073709551615
+  code_int: 17382938642823887837