mork 0.12.0 → 0.13.2

data/spec/mork/grid_omr_spec.rb

@@ -80,7 +80,7 @@ end
 #     @grom.rm_edgy_x.should == 24
 #   end
 #   it 'returns an integer' do
-#     @grom.rm_edgy_x.should be_a Fixnum
+#     @grom.rm_edgy_x.should be_an Integer
 #   end
 # end
 
@@ -89,7 +89,7 @@ end
 #     @grom.rm_edgy_y.should == 24
 #   end
 #   it 'returns an integer' do
-#     @grom.rm_edgy_y.should be_a Fixnum
+#     @grom.rm_edgy_y.should be_an Integer
 #   end
 # end
 
@@ -98,6 +98,6 @@ end
 #     @grom.rm_max_search_area_side.should == 400
 #   end
 #   it 'returns an integer' do
-#     @grom.rm_max_search_area_side.should be_a Fixnum
+#     @grom.rm_max_search_area_side.should be_an Integer
 #   end
 # end

data/spec/mork/magicko_spec.rb

@@ -7,10 +7,6 @@ module Mork
     let(:co) { Coord.new 50}
     let(:pp) { { tl: {x: 10, y: 10}, tr: {x: 1000, y: 10}, bl: {x: 10, y: 1700}, br: {x: 1000, y: 1700}} }
 
-    it 'exists' do
-      expect(Magicko.new 1).to be_a Magicko
-    end
-
     describe '#width' do
       it 'returns the image width' do
         expect(ma.width).to eq sh.width

data/spec/mork/sheet_omr_spec.rb

@@ -3,140 +3,167 @@ require 'fileutils'
 
 module Mork
   describe SheetOMR do
-    context 'with a valid response sheet' do
-      let(:img) { sample_img 'jdoe1' }
-      let(:fn)  { File.basename(img.image_path) }
-      let(:omr) { SheetOMR.new img.image_path, layout: img.grid_path }
-      describe '#new' do
-        it 'creates a SheetOMR object' do
-          expect(omr).to be_a SheetOMR
-        end
-
-        it 'raises an error if the provided path is invalid' do
-          expect { SheetOMR.new 'non_existing_file.jpg'}.to raise_error IOError
+    context 'catching source file problems' do
+      describe 'trying to process a non existing file' do
+        it 'throws a file-not-found error' do
+          expect { SheetOMR.new 'non_existing_file.jpg'}.to raise_error Errno::ENOENT, 'No such file or directory'
         end
       end
 
-      describe '#set_choices' do
-        it 'returns true if all goes well' do
-          expect(omr.set_choices([10])).to be_truthy
+      describe 'trying to process a corrupted file' do
+        it 'throws an IO error' do
+          fn = sample_img('corrupted-pdf').image_path
+          expect { SheetOMR.new fn}.to raise_error(IOError, 'Invalid image. File may have been damaged')
         end
       end
+    end
+
+    context 'using John Doe’s reference sheet' do
+      let(:img) { sample_img 'jdoe1' }
+      let(:fn)  { File.basename(img.image_path) }
+      let(:omr) { SheetOMR.new img.image_path, layout: img.grid_path }
+
+      context 'object creation' do
+        describe '#new' do
+          it 'creates a SheetOMR object' do
+            expect(omr).to be_a SheetOMR
+          end
 
-      describe '#valid?' do
-        it 'registers correctly' do
-          expect(omr.valid?).to be_truthy
+          it 'registers the image correctly' do
+            expect(omr.valid?).to be_truthy
+          end
         end
       end
 
-      describe '#status' do
-        it 'returns the registration status for each of the four corners' do
-          expect(omr.status).to eq({ tl: :ok, tr: :ok, br: :ok, bl: :ok })
+      context 'querying and modifying the object' do
+        describe '#status' do
+          it 'returns the valid (:ok) registration status for each corner' do
+            expect(omr.status).to eq({ tl: :ok, tr: :ok, br: :ok, bl: :ok })
+          end
         end
-      end
 
-      describe '#barcode' do
-        it 'returns the integer form of the barcode' do
-          expect(omr.barcode).to eq img.barcode_int
+        describe '#set_choices' do
+          it 'returns true if all goes well' do
+            expect(omr.set_choices([10])).to be_truthy
+          end
+
+          it 'raises an Argument error if the choices argument is invalid' do
+            expect { omr.set_choices('a string').to raise_error ArgumentError }
+          end
         end
       end
 
-      describe '#barcode_string' do
-        it 'returns the binary string version of the barcode' do
-          expect(omr.barcode_string).to eq img.barcode_str
+      context 'analyzing the barcode' do
+        describe '#barcode' do
+          it 'returns the integer form of the barcode' do
+            expect(omr.barcode).to eq img.barcode_int
+          end
         end
-      end
 
-      describe '#marked?' do
-        it 'returns true if the given cell was marked, false otherwise' do
-          expect(omr.marked?   0, 0).to be_truthy
-          expect(omr.marked?   0, 1).to be_falsy
-          expect(omr.marked? 119, 4).to be_truthy
-          expect(omr.marked? 119, 3).to be_falsy
+        describe '#barcode_string' do
+          it 'returns the binary string version of the barcode' do
+            expect(omr.barcode_string).to eq img.barcode_str
+          end
         end
       end
 
-      describe '#marked_choices' do
-        it 'returns an array of marked choices as position indexes' do
-          expect(omr.marked_choices ).to eq standard_mark_array(24)
+      context 'analyzing response cells' do
+        describe '#marked?' do
+          it 'returns true if the given cell was marked, false otherwise' do
+            expect(omr.marked?   0, 0).to be_truthy
+            expect(omr.marked?   0, 1).to be_falsy
+            expect(omr.marked? 119, 4).to be_truthy
+            expect(omr.marked? 119, 3).to be_falsy
+          end
         end
 
-        let(:om2) { SheetOMR.new img.image_path, layout: img.grid_path }
-        it 'returns marked choices only for existing choice cells' do
-          om2.set_choices [5, 4, 3, 2, 1]
-          expect(om2.marked_choices).to eq [[0], [1], [2], [], []]
-        end
-      end
+        describe '#marked_choices' do
+          it 'returns an array of marked choices as position indexes' do
+            expect(omr.marked_choices ).to eq standard_mark_array(24)
+          end
 
-      describe '#marked_letters' do
-        it 'returns an array of characters for the marked choices' do
-          expect(omr.marked_letters).to eq standard_mark_char_array(24)
+          it 'returns marked choices only for existing choice cells' do
+            omr.set_choices [5, 4, 3, 2, 1]
+            expect(omr.marked_choices).to eq [[0], [1], [2], [], []]
+          end
         end
-      end
 
-      it 'writes out markedness' do
-        mf = File.open('spec/out/text/marked.txt', 'w')
-        img.nitems.times do |q|
-          x = 5.times.collect do |c|
-            omr.marked?(q,c) ? '1' : '0'
+        describe '#marked_letters' do
+          it 'returns an array of characters for the marked choices' do
+            charr = img.mark_chars.split('').map { |c| [c] }
+            expect(omr.marked_letters).to eq charr
           end
-          mf.puts x.join(' ')
         end
-        mf.close
       end
 
-      context 'creating overlays' do
-        it 'registration highlighted' do
-          omr.save_registration "spec/out/registration/#{fn}"
+      context 'creating overlays and saving resulting JPEGs' do
+        it 'highlights registration' do
+          omr.save_registration "spec/out/JD-registration.jpeg"
         end
 
-        it 'highlights all choice cells' do
+        it 'highlights the barcode' do
+          omr.overlay :highlight, :barcode
+          omr.save "spec/out/JD-highlight-barcode.jpeg"
+        end
+
+        it 'highlights all requested choice cells' do
           omr.set_choices [5] * 32
           omr.overlay :highlight, :all
-          omr.save "spec/out/highlight/all-#{fn}"
+          omr.save "spec/out/JD-highlight-all.jpeg"
         end
 
         it 'highlights all possible choice cells' do
-          omr.set_choices [5] * 30
-            omr.overlay :highlight, :max
-          omr.save "spec/out/highlight/max-#{fn}"
+          omr.set_choices [5] * 30 # this will be ignored
+          omr.overlay :highlight, :max
+          omr.save "spec/out/JD-highlight-max.jpeg"
         end
 
         it 'highlights marked cells' do
           omr.overlay :highlight, :marked
-          omr.save "spec/out/highlight/marked-#{fn}"
+          omr.save "spec/out/JD-highlight-marked.jpeg"
         end
 
-        it 'checks marked cells' do
-          omr.overlay :check, :marked
-          omr.save "spec/out/mark/#{fn}"
+        it 'highlights marked cells (as default overlay)' do
+          omr.overlay :highlight
+          omr.save "spec/out/JD-highlight-marked-def.jpeg"
         end
 
-        it 'checks the first 32 marked cells' do
-          omr.set_choices [5] * 32
-          omr.overlay :check, :marked
-          omr.save "spec/out/mark/part-#{fn}"
+        it 'highlights arbitrary cells' do
+          omr.overlay :highlight, [[1,2], [], [0,1,2,3,4], [3]]
+          omr.save "spec/out/JD-highlight-some.jpeg"
         end
 
-        it 'outlines arbitrary cells' do
-          omr.overlay :outline, [[1,2], [], [0,1,2,3,4], [3]]
-          omr.save "spec/out/outline/some-#{fn}"
+        it 'highlights and crosses marked cells' do
+          omr.overlay :highlight
+          omr.overlay :check
+          omr.save "spec/out/JD-highlight-and-cross.jpeg"
         end
 
-        it 'outlines and crosses marked cells' do
-          omr.overlay :outline, standard_mark_array(24)
+        it 'checks marked cells' do
           omr.overlay :check
-          omr.save "spec/out/outline/#{fn}"
+          omr.save "spec/out/JD-check-marked.jpeg"
         end
 
-        it 'highlights the barcode' do
-          omr.overlay :outline, :barcode
-          omr.save "spec/out/barcode/#{fn}"
+        it 'outlines marked cells' do
+          omr.overlay :outline
+          omr.save "spec/out/JD-outline-marked.jpeg"
+        end
+      end
+
+      context 'requesting invalid responses and choices' do
+        it 'raises an ArgumentError if the maximum number of responses is exceeded' do
+          one_too_many = [[0]] * 121
+          expect { omr.overlay(:check, one_too_many)}.to raise_error(ArgumentError)
+        end
+
+        it 'raises an ArgumentError if the maximum number of choices is exceeded' do
+          one_too_many = [[5]]
+          expect { omr.overlay(:check, one_too_many)}.to raise_error(ArgumentError)
         end
       end
     end
 
-    context 'systematic tests', exclude: true do
+    context 'systematic tests' do
       let(:bila)  { 'CCEBEBCEEACCDCABDBEBCADEADDCCCACCACDBBDAECDDABDEEBCEEDCBAAADEEEEDCADEABCBDECCCCDDDCABBECAADADBBEEABA'.split '' }
       let(:bila0) { SheetOMR.new 'spec/samples/syst/bila0.jpg', choices: [5]*100, layout: 'spec/samples/syst/layout.yml'}
       let(:bila1) { SheetOMR.new 'spec/samples/syst/bila1.jpg', choices: [5]*100, layout: 'spec/samples/syst/layout.yml'}
@@ -165,43 +192,44 @@ module Mork
       let(:barr2) { SheetOMR.new 'spec/samples/syst/barr2.jpg', choices: [5]*100, layout: 'spec/samples/syst/layout.yml'}
 
       it 'checks bila' do
-        expect(bila0.mark_char_array.flatten).to eq(bila)
-        expect(bila1.mark_char_array.flatten).to eq(bila)
-        expect(bila2.mark_char_array.flatten).to eq(bila)
-        expect(bila3.mark_char_array.flatten).to eq(bila)
-        expect(bila4.mark_char_array.flatten).to eq(bila)
+        expect(bila0.marked_letters.flatten).to eq(bila)
+        expect(bila1.marked_letters.flatten).to eq(bila)
+        expect(bila2.marked_letters.flatten).to eq(bila)
+        expect(bila3.marked_letters.flatten).to eq(bila)
+        expect(bila4.marked_letters.flatten).to eq(bila)
       end
 
       it 'checks dald' do
-        expect(dald0.mark_char_array.flatten).to eq(dald)
-        expect(dald1.mark_char_array.flatten).to eq(dald)
-        expect(dald2.mark_char_array.flatten).to eq(dald)
-        expect(dald3.mark_char_array.flatten).to eq(dald)
-        expect(dald4.mark_char_array.flatten).to eq(dald)
+        expect(dald0.marked_letters.flatten).to eq(dald)
+        expect(dald1.marked_letters.flatten).to eq(dald)
+        expect(dald2.marked_letters.flatten).to eq(dald)
+        expect(dald3.marked_letters.flatten).to eq(dald)
+        expect(dald4.marked_letters.flatten).to eq(dald)
       end
 
       it 'checks cost' do
-        expect(cost0.mark_char_array.flatten).to eq(cost)
-        expect(cost1.mark_char_array.flatten).to eq(cost)
-        expect(cost2.mark_char_array.flatten).to eq(cost)
-        expect(cost3.mark_char_array.flatten).to eq(cost)
-        expect(cost4.mark_char_array.flatten).to eq(cost)
+        expect(cost0.marked_letters.flatten).to eq(cost)
+        expect(cost1.marked_letters.flatten).to eq(cost)
+        expect(cost2.marked_letters.flatten).to eq(cost)
+        expect(cost3.marked_letters.flatten).to eq(cost)
+      end
+
+      it 'fails to register cost4 because the BR corner is too far' do
+        expect(cost4.status).to eq({tl: :ok, tr: :ok, br: :edgy, bl: :ok})
       end
 
       it 'checks bone' do
-        expect(bone0.mark_char_array.flatten).to eq(bone)
-        expect(bone1.mark_char_array.flatten).to eq(bone)
-        expect(bone2.mark_char_array.flatten).to eq(bone)
+        expect(bone0.marked_letters.flatten).to eq(bone)
+        expect(bone1.marked_letters.flatten).to eq(bone)
+        expect(bone2.marked_letters.flatten).to eq(bone)
       end
 
       it 'checks barr' do
-        expect(barr0.mark_char_array.flatten).to eq(barr)
-        expect(barr1.mark_char_array.flatten).to eq(barr)
-        expect(barr2.mark_char_array.flatten).to eq(barr)
+        expect(barr0.marked_letters.flatten).to eq(barr)
+        expect(barr1.marked_letters.flatten).to eq(barr)
+        expect(barr2.marked_letters.flatten).to eq(barr)
       end
-
     end
-
     # context "multi-page pdf" do
     #   before(:all) do
     #     @mlist = MimageList.new('spec/samples/two_pages.pdf')
@@ -236,3 +264,14 @@ module Mork
   end
 end
 
+
+# it 'writes out markedness' do
+#   mf = File.open('spec/out/text/marked.txt', 'w')
+#   img.nitems.times do |q|
+#     x = 5.times.map do |c|
+#       omr.marked?(q,c) ? '1' : '0'
+#     end
+#     mf.puts x.join(' ')
+#   end
+#   mf.close
+# end

data/spec/mork/sheet_pdf_spec.rb

@@ -107,7 +107,7 @@ module Mork
     end
 
     it 'creates 20 PDF sheets' do
-      c = 20.times.collect do |x|
+      c = 20.times.map do |x|
         content.merge({ header: {title: "Test #{x+1}"}, barcode: x})
       end
       SheetPDF.new(c).save dest('p20')

data/spec/samples/info.yml

@@ -8,6 +8,7 @@ jdoe1:
   width:       1240
   height:      1754
   mark_array:  [[0],[1],[2],[3],[4],[0],[1],[2],[3],[4],[0],[1],[2],[3],[4],[0],[1],[2],[3],[4],[0],[1],[2],[3],[4],[0],[1],[2],[3],[4],[0],[1],[2],[3],[4],[0],[1],[2],[3],[4],[0],[1],[2],[3],[4],[0],[1],[2],[3],[4],[0],[1],[2],[3],[4],[0],[1],[2],[3],[4],[0],[1],[2],[3],[4],[0],[1],[2],[3],[4],[0],[1],[2],[3],[4],[0],[1],[2],[3],[4],[0],[1],[2],[3],[4],[0],[1],[2],[3],[4],[0],[1],[2],[3],[4],[0],[1],[2],[3],[4],[0],[1],[2],[3],[4],[0],[1],[2],[3],[4],[0],[1],[2],[3],[4],[0],[1],[2],[3],[4]]
+  mark_chars:  'ABCDEABCDEABCDEABCDEABCDEABCDEABCDEABCDEABCDEABCDEABCDEABCDEABCDEABCDEABCDEABCDEABCDEABCDEABCDEABCDEABCDEABCDEABCDEABCDE'
   tl:          [63, 67]
   tr:          [1182, 68]
   br:          [1178, 1704]
@@ -18,4 +19,5 @@ reg-mark:
   centroid-x: 92
   centroid-y: 91
 
-
+corrupted-pdf:
+  image_path: spec/samples/corrupt.pdf

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mork
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.2
 platform: ruby
 authors:
 - Giuseppe Bertini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-21 00:00:00.000000000 Z
+date: 2018-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: narray
@@ -30,140 +30,140 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '4.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '4.8'
 - !ruby/object:Gem::Dependency
   name: prawn
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: deep_merge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-shell
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '0'
 description: Optical mark recognition of multiple-choice tests and surveys. Low-level
   ruby library to generate response sheets in PDF form and to automatically score
   manually filled-out forms.
@@ -174,6 +174,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - ".yardopts"
 - Gemfile
 - Guardfile
@@ -195,6 +196,7 @@ files:
 - lib/mork/version.rb
 - mork.gemspec
 - mork.sublime-project
+- mork.sublime-workspace
 - spec/mork/coord_spec.rb
 - spec/mork/grid_omr_spec.rb
 - spec/mork/grid_spec.rb
@@ -203,19 +205,14 @@ files:
 - spec/mork/npatch_spec.rb
 - spec/mork/sheet_omr_spec.rb
 - spec/mork/sheet_pdf_spec.rb
-- spec/out/barcode/.gitignore
-- spec/out/highlight/.gitignore
-- spec/out/mark/.gitignore
-- spec/out/outline/.gitignore
 - spec/out/pdf/.gitignore
-- spec/out/registration/.gitignore
-- spec/out/text/.gitignore
 - spec/samples/angolo.jpg
 - spec/samples/angolo2.jpg
 - spec/samples/angolo3.jpg
 - spec/samples/base_layout.yml
 - spec/samples/boxy.yml
 - spec/samples/content.yml
+- spec/samples/corrupt.pdf
 - spec/samples/grid.yml
 - spec/samples/grid160.yml
 - spec/samples/grid_omr_layout.yml
@@ -225,6 +222,7 @@ files:
 - spec/samples/jdoe/JohnDoe3.jpeg
 - spec/samples/jdoe/layout.yml
 - spec/samples/layout.yml
+- spec/samples/raffa-ige.jpg
 - spec/samples/reg_mark.jpg
 - spec/samples/rm00.jpeg
 - spec/samples/rm01.jpeg
@@ -267,7 +265,6 @@ files:
 - spec/samples/syst/histo.m
 - spec/samples/syst/layout.yml
 - spec/spec_helper.rb
-- test_reg.m
 homepage: https://github.com/giuseb/mork
 licenses:
 - MIT
@@ -280,7 +277,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.9
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -288,9 +285,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Optical mark recognition of multiple-choice tests and surveys
 test_files: []
-has_rdoc: