mork 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd53f32c40d7947845de3d35a3a3b26c04c0e55b78ca9a78a6488fc40c951764
-  data.tar.gz: c51f347164b7c59c1c6015566855d4a28487143f1689a0a0896260047f708809
+  metadata.gz: e8f49c72fbe2291aa94e5d4c01555faa89f62fb0d1e5d188afb4352a32e202a0
+  data.tar.gz: 6500951d34d59c8c4d2c15b2a42a32b253811e08a469315b880cbb1d42282a55
 SHA512:
-  metadata.gz: 536232bd54d8a65c4e4dd3577ddb1c0991a476cb7c1acf912dcba919693aff1ddf90e1cfec0c1996c3751021d5869986287c5141da2b5f11ca71962c49ba8a26
-  data.tar.gz: 2da923c99d7bba5c1a19326d0317a55ac5bf2a8ee45b829092186823b9558e8e64ede3082d7afd6fa2e7171687b18d03663d3df0eadf6ab866214cc56fc7f910
+  metadata.gz: 99e1f1dda6522ed67b19f07eb3dd619fda3edfb6439d0ec754b72b8871066aabc23a65dc8977928632929730db4a4eb0cf98a29157d817f106e3fa76426ab118
+  data.tar.gz: 18f2350a49975b3682bc4ac334388a58b66c8cd624f4ec3722a71623932e8cdefa86bf283e084b9a2cab2195f52e43c0012b74429a3e4bdf4fa1fe30fa893c9f

data/lib/mork/grid.rb

@@ -10,7 +10,7 @@ module Mork
     # Calling Grid.new without arguments creates the default boilerplate Grid
     def initialize(options=nil)
       @params = default_grid
-      if File.exists?('layout.yml')
+      if File.exist?('layout.yml')
         @params.deeper_merge! symbolize YAML.load_file('layout.yml')
       end
       case options

data/lib/mork/magicko.rb

@@ -145,8 +145,13 @@ module Mork
     # into an array of bytes
     def read_bytes(params=nil)
       d = @density ? "-density #{@density}" : nil
-      s = "|convert -depth 8 #{d} #{@path} #{params} gray:-"
-      IO.read(s).unpack 'C*'
+      cmd = "magick -depth 8 #{d} #{@path} #{params} gray:-"
+      stdout, stderr, status = Open3.capture3(cmd)
+      if status.success?
+        stdout.unpack('C*')
+      else
+        fail IOError, "ImageMagick command failed: #{stderr}"
+      end
     end
 
     # perspective points: brings the found registration area centers to the

data/lib/mork/npatch.rb

@@ -1,15 +1,15 @@
-require 'narray'
+require 'numo/narray'
 
 module Mork
   # @private
-  # NPatch handles low-level computations on pixels by leveraging NArray
+  # NPatch handles low-level computations on pixels by leveraging Numo::NArray
   class NPatch
     # NPatch.new(source, width, height) constructs an NPatch object
     # from the `source` linear array of bytes, to be reshaped as a
     # `width` by `height` matrix
     def initialize(source, width, height)
-      @patch = NArray.float(width, height)
-      @patch[true] = source
+      # Numo::NArray uses row-major order, so we reshape and transpose
+      @patch = Numo::SFloat.cast(source).reshape(height, width).transpose
     end
 
     def average(coord)
@@ -21,8 +21,8 @@ module Mork
     end
 
     def centroid
-      xp = @patch.sum(1).to_a
-      yp = @patch.sum(0).to_a
+      xp = @patch.sum(axis: 1).to_a
+      yp = @patch.sum(axis: 0).to_a
       return xp.find_index(xp.min), yp.find_index(yp.min), @patch.stddev
     end
   end

data/lib/mork/sheet_pdf.rb

@@ -13,7 +13,7 @@ module Mork
         when Array; content
         when Hash; [content]
         when String
-          fail Errno::ENOENT unless File.exists? content
+          fail Errno::ENOENT unless File.exist? content
           symbolize YAML.load_file(content)
         end
       @grip =

data/lib/mork/version.rb

@@ -1,3 +1,3 @@
 module Mork
-  VERSION = '0.15.0'
+  VERSION = '0.16.0'
 end

data/mork.code-workspace

@@ -0,0 +1,24 @@
+{
+  "folders": [
+    {
+      "path": "."
+    }
+  ],
+  "settings": {
+    "sqltools.connections": [
+      {
+        "mysqlOptions": {
+          "authProtocol": "default"
+        },
+        "previewLimit": 50,
+        "server": "localhost",
+        "port": 3306,
+        "driver": "MySQL",
+        "name": "HGuide",
+        "database": "hguide_development",
+        "username": "root",
+        "password": ""
+      }
+    ]
+  }
+}

data/mork.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/giuseb/mork'
   s.summary     = %q{Optical mark recognition of multiple-choice tests and surveys}
   s.description = %q{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.}
-  s.required_ruby_version = '>= 2.4.0'
+  s.required_ruby_version = '>= 3.4.0'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {spec}/*`.split("\n")
@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # dependencies:
-  s.add_dependency 'narray' ,      '~> 0.6'
+  s.add_dependency 'numo-narray' , '~> 0.9'
   s.add_dependency 'mini_magick' , '~> 4.10'
   s.add_dependency 'prawn' ,       '~> 2.2'
   s.add_dependency 'deep_merge' ,  '~> 1.2'

data/spec/mork/npatch_spec.rb

@@ -5,20 +5,20 @@ module Mork
     describe '#centroid' do
       it 'computes centers for rm0X' do
         np = make 'spec/samples/rm01.jpeg', 134, 104
-        expect(np.centroid[0]).to eq 50
-        expect(np.centroid[1]).to eq 60
+        expect(np.centroid[0]).to be_within(1).of(50)
+        expect(np.centroid[1]).to be_within(1).of(60)
         np = make 'spec/samples/rm02.jpeg', 114, 117
-        expect(np.centroid[0]).to eq 69
-        expect(np.centroid[1]).to eq 71
+        expect(np.centroid[0]).to be_within(1).of(69)
+        expect(np.centroid[1]).to be_within(1).of(71)
         np = make 'spec/samples/rm03.jpeg', 124, 105
-        expect(np.centroid[0]).to eq 71
-        expect(np.centroid[1]).to eq 61
+        expect(np.centroid[0]).to be_within(1).of(71)
+        expect(np.centroid[1]).to be_within(1).of(61)
         np = make 'spec/samples/rm04.jpeg', 144, 117
-        expect(np.centroid[0]).to eq 84
-        expect(np.centroid[1]).to eq 52
+        expect(np.centroid[0]).to be_within(1).of(84)
+        expect(np.centroid[1]).to be_within(1).of(52)
         np = make 'spec/samples/rm05.jpeg', 144, 117
-        expect(np.centroid[0]).to eq 84
-        expect(np.centroid[1]).to eq 52
+        expect(np.centroid[0]).to be_within(1).of(84)
+        expect(np.centroid[1]).to be_within(1).of(52)
       end
     end
 
@@ -37,7 +37,7 @@ module Mork
     end
 
     def make(fname, w, h)
-      b = IO.read("|convert #{fname} gray:-").unpack 'C*'
+      b = IO.read("|magick #{fname} gray:-").unpack 'C*'
       NPatch.new b, w, h
     end
 

data/spec/mork/sheet_omr_spec.rb

@@ -13,7 +13,7 @@ module Mork
       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')
+          expect { SheetOMR.new fn}.to raise_error(IOError, 'Unknown problem with image file')
         end
       end
     end
@@ -163,6 +163,152 @@ module Mork
       end
     end
 
+    context 'using Cost3' do
+      let(:img) { sample_img 'cost3' }
+      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
+
+          it 'registers the image correctly' do
+            expect(omr.valid?).to be_truthy
+          end
+        end
+      end
+      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
+
+        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
+
+      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
+
+        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
+
+      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?  99, 2).to be_truthy
+            expect(omr.marked?  99, 3).to be_falsy
+          end
+        end
+
+        describe '#marked_choices' do
+          it 'returns an array of marked choices as position indexes' do
+            omr.set_choices [5] * 100
+            expect(omr.marked_choices ).to eq [[0],[1],[1],[3],[3],[1],[0],[4],[0],[4],[1],[0],[0],[3],[4],[0],[0],[4],[2],[1],[2],[3],[1],[1],[3],[0],[1],[0],[1],[0],[3],[4],[4],[2],[2],[0],[2],[1],[2],[0],[4],[3],[3],[0],[4],[1],[4],[0],[1],[1],[2],[3],[0],[1],[4],[2],[0],[0],[2],[4],[4],[4],[1],[0],[3],[4],[2],[1],[1],[4],[0],[0],[3],[1],[1],[1],[4],[0],[1],[3],[0],[4],[1],[3],[4],[4],[0],[1],[1],[0],[1],[4],[1],[4],[3],[3],[0],[4],[4],[2]]
+          end
+
+          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], [1], [], []]
+          end
+        end
+
+        describe '#marked_letters' do
+          it 'returns an array of characters for the marked choices' do
+            omr.set_choices [5] * 100
+            charr = img.mark_chars.split('').map { |c| [c] }
+            expect(omr.marked_letters).to eq charr
+          end
+        end
+      end
+
+      context 'creating overlays and saving resulting JPEGs' do
+        it 'highlights registration' do
+          omr.save_registration "spec/out/CG-registration.jpeg"
+        end
+
+        it 'highlights the barcode' do
+          omr.overlay :highlight, :barcode
+          omr.save "spec/out/CG-highlight-barcode.jpeg"
+        end
+
+        it 'highlights all requested choice cells' do
+          omr.set_choices [5] * 32
+          omr.overlay :highlight, :all
+          omr.save "spec/out/CG-highlight-all.jpeg"
+        end
+
+        it 'highlights all possible choice cells' do
+          omr.set_choices [5] * 30 # this will be ignored
+          omr.overlay :highlight, :max
+          omr.save "spec/out/CG-highlight-max.jpeg"
+        end
+
+        it 'highlights marked cells' do
+          omr.overlay :highlight, :marked
+          omr.save "spec/out/CG-highlight-marked.jpeg"
+        end
+
+        it 'highlights marked cells (as default overlay)' do
+          omr.overlay :highlight
+          omr.save "spec/out/CG-highlight-marked-def.jpeg"
+        end
+
+        it 'highlights arbitrary cells' do
+          omr.overlay :highlight, [[1,2], [], [0,1,2,3,4], [3]]
+          omr.save "spec/out/CG-highlight-some.jpeg"
+        end
+
+        it 'highlights and crosses marked cells' do
+          omr.overlay :highlight
+          omr.overlay :check
+          omr.save "spec/out/CG-highlight-and-cross.jpeg"
+        end
+
+        it 'checks marked cells' do
+          omr.overlay :check
+          omr.save "spec/out/CG-check-marked.jpeg"
+        end
+
+        it 'outlines marked cells' do
+          omr.overlay :outline
+          omr.save "spec/out/CG-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' do
       let(:bila)  { 'CCEBEBCEEACCDCABDBEBCADEADDCCCACCACDBBDAECDDABDEEBCEEDCBAAADEEEEDCADEABCBDECCCCDDDCABBECAADADBBEEABA'.split '' }
       let(:bila0) { SheetOMR.new 'spec/samples/syst/bila0.jpg', choices: [5]*100, layout: 'spec/samples/syst/layout.yml'}

data/spec/samples/cost/layout.yml

@@ -0,0 +1,58 @@
+page_size:
+  width:   210
+  height:  297
+reg_marks:
+  margin:   10
+  radius:    3
+  crop:     20
+  offset:    3
+  blur:      2
+  dilate:    5
+header:
+  name:
+    top:     5
+    left:   15
+    width: 160
+    height:  7
+    size:   14
+  title:
+    top:    15
+    left:   15
+    width: 160
+    height: 12
+    size:   12
+  code:
+    top:    35
+    left:  130
+    width:  57
+    height: 10
+    size:   14
+    align: right
+  signature:
+    top:    30
+    left:   15
+    width: 120
+    height: 15
+    size:    7
+    box:  true
+items:
+  # threshold:     0.75
+  top:          55
+  left:         11
+  columns:       4
+  column_width: 44
+  rows:         30
+  x_spacing:     7
+  y_spacing:     7
+  cell_width:    6
+  cell_height:   5
+  max_cells:     5
+  font_size:     9
+  number_width:  8
+  number_margin: 2
+barcode:
+  bits:   40
+  left:   15
+  width:   3
+  height:  2.5
+  spacing: 4

data/spec/samples/info.yml

@@ -14,6 +14,22 @@ jdoe1:
   br:          [1178, 1704]
   bl:          [55, 1702]
 
+cost3:
+  image_path:  spec/samples/cost/cost3.jpg
+  grid_path:   spec/samples/cost/layout.yml
+  nchoices:    5
+  nitems:      100
+  barcode_int: 11886
+  barcode_str: '00000000000000000000000010111001101110'
+  width:       1240
+  height:      1754
+  mark_array:  [[0],[1],[1],[3],[3],[1],[0],[4],[0],[4],[1],[0],[0],[3],[4],[0],[0],[4],[2],[1],[2],[3],[1],[1],[3],[0],[1],[0],[1],[0],[3],[4],[4],[2],[2],[0],[2],[1],[2],[0],[4],[3],[3],[0],[4],[1],[4],[0],[1],[1],[2],[3],[0],[1],[4],[2],[0],[0],[2],[4],[4],[4],[1],[0],[3],[4],[2],[1],[1],[4],[0],[0],[3],[1],[1],[1],[4],[0],[1],[3],[0],[4],[1],[3],[4],[4],[0],[1],[1],[0],[1],[4],[1],[4],[3],[3],[0],[4],[4],[2]]
+  mark_chars:  'ABBDDBAEAEBAADEAAECBCDBBDABABADEECCACBCAEDDAEBEABBCDABECAACEEEBADECBBEAADBBBEABDAEBDEEABBABEBEDDAEEC'
+  tl:          [63, 67]
+  tr:          [1182, 68]
+  br:          [1178, 1704]
+  bl:          [55, 1702]
+
 reg-mark:
   image_path: spec/samples/reg_mark.jpg
   centroid-x: 92

metadata

@@ -1,29 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: mork
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Giuseppe Bertini
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: narray
+  name: numo-narray
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: mini_magick
   requirement: !ruby/object:Gem::Requirement
@@ -194,9 +193,8 @@ files:
 - lib/mork/sheet_omr.rb
 - lib/mork/sheet_pdf.rb
 - lib/mork/version.rb
+- mork.code-workspace
 - mork.gemspec
-- mork.sublime-project
-- mork.sublime-workspace
 - spec/mork/coord_spec.rb
 - spec/mork/grid_omr_spec.rb
 - spec/mork/grid_spec.rb
@@ -213,6 +211,8 @@ files:
 - spec/samples/boxy.yml
 - spec/samples/content.yml
 - spec/samples/corrupt.pdf
+- spec/samples/cost/cost3.jpg
+- spec/samples/cost/layout.yml
 - spec/samples/grid.yml
 - spec/samples/grid160.yml
 - spec/samples/grid_omr_layout.yml
@@ -269,7 +269,6 @@ homepage: https://github.com/giuseb/mork
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -277,15 +276,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 3.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Optical mark recognition of multiple-choice tests and surveys
 test_files: []

data/mork.sublime-project

@@ -1,9 +0,0 @@
-{
-	"folders":
-	[
-		{
-			"path": ".",
-			"folder_exclude_patterns": ["tmp", "log", "doc", ".yardoc"]
-		}
-	]
-}