mork 0.18.1 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c871eb798a14173c833892d6cb6030e266158239058f9ef0fbb2ff359c1073f
-  data.tar.gz: 8e2ac94ee3e806455d617f959459eebe6964521c9711064e5f0c86facf9fda8f
+  metadata.gz: 8d1ff44d3b000b420e231a5ab3823293dad26ef69ec29ade174e74db32b16b9c
+  data.tar.gz: 520167a98213a49bec5820fb7d2476416197484dd93785ed861bb4998b9ca2ec
 SHA512:
-  metadata.gz: 464bb64cfe62e30bba0037b154d527a00d165b1bd71b4ffa4534bc28cace42fd86aa8455d927d6d660c218d25be92cca4292f60aa66b787af8ce9ed7bea82ba9
-  data.tar.gz: 37ab32c16c165c6c120a8addca74a6bafbe44a02d494ab80968a499dd5d44bad1b6402031c3ff8703a94b8ffbcdd8fc6afd093369b9535883aa49aa2ff2dd0e3
+  metadata.gz: 6c66b3b59d316efe183f978e7702c03608ef08208a202640648a5e76d023d54d9bd6985db7d9307d677ca5c6f85776f1264fe141f9edcebb8ecf206956f4ca49
+  data.tar.gz: 580d00362722d80ea7af5411486174f714328de9ddf936a59aa911f86525725e27c5452aaa909ea2d2bc89abd57ee6b46e7e9434f239201c7ae12ea738f06bdf

data/README.md

@@ -315,7 +315,7 @@ system 'open corrections.jpg' # this works in macOS
 
 `overlay_corrections` applies:
 
-- a green outline on the marked cell when the response is correct
+- a green outline and semitransparent green fill on the marked cell when the response is correct
 - a red outline on the expected cell and a red cross on the marked cell when the response is incorrect
 - a red outline on the expected cell when the response is blank or invalid
 

data/lib/mork/magicko.rb

@@ -18,7 +18,11 @@ module Mork
       # a default of 150 dpi seems sensible. It should not affect bitmaps.
       density = 150
       # inspect the source file
-      s1, s2, s3 = Open3.capture3 "identify -density #{density} -format '%w %h %m' #{path}"
+      identify = MiniMagick.identify
+      identify.density density
+      identify.format '%w %h %m'
+      identify << path
+      s1, s2, s3 = Open3.capture3(*identify.command)
       if s3.success?
         # parse the identify command output
         w, h, @type = s1.split(' ')
@@ -54,16 +58,17 @@ module Mork
     # (i.e. the centers of the four registration marks)
     # pp: a hash in the form of pp[:tl][:x], pp[:tl][:y], etc.
     def registered_bytes(pp)
-      read_bytes "-distort Perspective '#{pps pp}'"
+      read_bytes '-distort', 'Perspective', pps(pp)
     end
 
     # Reading from the image file the bytes from one of the four corner
     # squares encompassing each registration mark; the blur and dilation
     # manipulations may prevent registration misalignments due to stray dark pixels
     def rm_patch(c, blr=0, dlt=0)
-      b = blr==0 ? '' : " -blur #{blr*3}x#{blr}"
-      d = dlt==0 ? '' : " -morphology Dilate Octagon:#{dlt}"
-      read_bytes "-crop #{c.cropper}#{b}#{d}"
+      params = ['-crop', c.cropper]
+      params.concat ['-blur', "#{blr*3}x#{blr}"] unless blr == 0
+      params.concat ['-morphology', 'Dilate', "Octagon:#{dlt}"] unless dlt == 0
+      read_bytes(*params)
     end
 
     ##################################
@@ -76,6 +81,13 @@ module Mork
       coords.each { |c| @cmd << [:draw, shape(c, rounded)] }
     end
 
+    def highlight_green(coords, rounded)
+      return if coords.empty?
+      @cmd << [:stroke, 'none']
+      @cmd << [:fill, 'rgba(0, 255, 0, 0.3)']
+      coords.each { |c| @cmd << [:draw, shape(c, rounded)] }
+    end
+
     def outline(coords, rounded)
       outline_with_color(coords, rounded, 'green')
     end
@@ -171,10 +183,18 @@ module Mork
 
     # calling imagemagick and capturing the converted image
     # into an array of bytes
-    def read_bytes(params=nil)
-      d = @density ? "-density #{@density}" : nil
-      cmd = "magick -depth 8 #{d} #{@path} #{params} gray:-"
-      stdout, stderr, status = Open3.capture3(cmd)
+    def read_bytes(*params)
+      # MiniMagick selects `convert` on ImageMagick 6 and `magick` on
+      # ImageMagick 7. Execute its argv directly to preserve binary stdout
+      # (MiniMagick::Tool#call strips a trailing newline) and avoid a shell.
+      command = MiniMagick.convert
+      command.depth 8
+      command.density @density if @density
+      command << @path
+      command.merge!(params)
+      command << 'gray:-'
+
+      stdout, stderr, status = Open3.capture3(*command.command)
       if status.success?
         stdout.unpack('C*')
       else

data/lib/mork/sheet_omr.rb

@@ -165,10 +165,10 @@ module Mork
 
     # Applies correctness-aware overlays to the image using an answer key.
     #
-    # Correct responses receive a green outline on the marked cell. Incorrect
-    # responses receive a red outline on the expected cell and a red cross on
-    # the given cell. Blank or invalid responses receive only the red outline
-    # on the expected cell.
+    # Correct responses receive a green outline and semitransparent green fill
+    # on the marked cell. Incorrect responses receive a red outline on the
+    # expected cell and a red cross on the given cell. Blank or invalid
+    # responses receive only the red outline on the expected cell.
     #
     # @param correct_choices [Array<Integer, Array<Integer>, nil>] one entry per
     #   question. Each entry can be an integer choice index, a 1-element array
@@ -183,6 +183,7 @@ module Mork
       actual = marked_responses(marked)
 
       green_outlines = Array.new(expected.length) { [] }
+      green_highlights = Array.new(expected.length) { [] }
       red_outlines = Array.new(expected.length) { [] }
       red_crosses = Array.new(expected.length) { [] }
 
@@ -192,6 +193,7 @@ module Mork
         marked_cells = actual[question]
         if marked_cells == [choice]
           green_outlines[question] = [choice]
+          green_highlights[question] = [choice]
           next
         end
 
@@ -200,6 +202,7 @@ module Mork
       end
 
       @mim.overlay :outline_green, green_outlines
+      @mim.overlay :highlight_green, green_highlights
       @mim.overlay :outline_red, red_outlines
       @mim.overlay :check_red, red_crosses
     end

data/lib/mork/version.rb

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

data/spec/mork/magicko_spec.rb

@@ -39,6 +39,30 @@ module Mork
       end
     end
 
+    describe 'ImageMagick command selection' do
+      let(:status) { instance_double(Process::Status, success?: true) }
+
+      it 'uses ImageMagick 6 convert through MiniMagick and preserves raw bytes' do
+        magicko = ma
+        allow(MiniMagick).to receive(:imagemagick7?).and_return(false)
+        expect(Open3).to receive(:capture3).with(
+          'convert', '-depth', '8', sh.image_path, '-crop', co.cropper, 'gray:-'
+        ).and_return(["\x00\x0a\xff".b, '', status])
+
+        expect(magicko.rm_patch(co)).to eq [0, 10, 255]
+      end
+
+      it 'uses ImageMagick 7 magick through MiniMagick' do
+        magicko = ma
+        allow(MiniMagick).to receive(:imagemagick7?).and_return(true)
+        expect(Open3).to receive(:capture3).with(
+          'magick', '-depth', '8', sh.image_path, '-crop', co.cropper, 'gray:-'
+        ).and_return(["\x00".b, '', status])
+
+        expect(magicko.rm_patch(co)).to eq [0]
+      end
+    end
+
     describe 'overlay stroke width' do
       it 'defaults to the legacy 3-pixel width' do
         expect(ma.overlay_stroke_width).to eq 3
@@ -49,6 +73,14 @@ module Mork
         ma.outline [co], false
         expect(ma.instance_variable_get(:@cmd)).to include([:strokewidth, 6])
       end
+
+      it 'draws a semitransparent green fill over the cell' do
+        ma.highlight_green [co], false
+        commands = ma.instance_variable_get(:@cmd)
+        expect(commands).to include([:stroke, 'none'])
+        expect(commands).to include([:fill, 'rgba(0, 255, 0, 0.3)'])
+        expect(commands).to include([:draw, 'rectangle 0 0 50 50'])
+      end
     end
   end
 end

data/spec/mork/sheet_omr_spec.rb

@@ -167,6 +167,7 @@ module Mork
           allow(omr).to receive(:marked_choices).and_return([[1], [2], [], [3, 4]])
 
           expect(mim).to receive(:overlay).with(:outline_green, [[1], [], [], []]).ordered
+          expect(mim).to receive(:overlay).with(:highlight_green, [[1], [], [], []]).ordered
           expect(mim).to receive(:overlay).with(:outline_red, [[], [0], [2], [3]]).ordered
           expect(mim).to receive(:overlay).with(:check_red, [[], [2], [], []]).ordered
 
@@ -179,6 +180,7 @@ module Mork
           omr.set_choices [5] * 2
 
           expect(mim).to receive(:overlay).with(:outline_green, [[], []]).ordered
+          expect(mim).to receive(:overlay).with(:highlight_green, [[], []]).ordered
           expect(mim).to receive(:overlay).with(:outline_red, [[3], [1]]).ordered
           expect(mim).to receive(:overlay).with(:check_red, [[1, 2], [0]]).ordered
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mork
 version: !ruby/object:Gem::Version
-  version: 0.18.1
+  version: 0.19.0
 platform: ruby
 authors:
 - Giuseppe Bertini