sqed 0.3.2 → 0.4.0

data/spec/lib/sqed/boundary_finder/cross_finder_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Sqed::BoundaryFinder::CrossFinder do
   let(:image) { ImageHelpers.of_size(800, 600) }
-  let(:b) {Sqed::BoundaryFinder::CrossFinder.new(target_image: image)}
+  let(:b) {Sqed::BoundaryFinder::CrossFinder.new(image: image)}
   let(:c) {b.boundaries}
 
   specify '#boundaries returns a Sqed::Boundaries instance' do

data/spec/lib/sqed/boundary_finder/stage_finder_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Sqed::BoundaryFinder::StageFinder do 
-  let(:b) {Sqed::BoundaryFinder::StageFinder.new(target_image: ImageHelpers.cross_green )}
+  let(:b) {Sqed::BoundaryFinder::StageFinder.new(image: ImageHelpers.cross_green )}
 
   specify '#is border contains a proc' do
     expect(b.is_border.class).to eq(Proc)

data/spec/lib/sqed/boundary_finder_spec.rb

@@ -7,7 +7,7 @@ describe Sqed::BoundaryFinder do
   end
 
   context 'when initiated with an image' do
-    let(:b) {Sqed::BoundaryFinder.new(target_image: ImageHelpers.cross_green, target_layout: :vertical_offset_cross)}
+    let(:b) {Sqed::BoundaryFinder.new(image: ImageHelpers.cross_green, layout: :vertical_offset_cross)}
 
     context 'attributes' do
       specify '#image' do
@@ -20,16 +20,16 @@ describe Sqed::BoundaryFinder do
     end
   end
 
-  context '.color_boundary_finder(target_image: image)' do
+  context '.color_boundary_finder(image: image)' do
     context 'with sample_subdivision_size: 10' do
       specify 'finds the vertical dividing line in a standard cross, with border still present' do
-        center =  Sqed::BoundaryFinder.color_boundary_finder(target_image: ImageHelpers.cross_green, sample_subdivision_size: 10 )[1]
+        center =  Sqed::BoundaryFinder.color_boundary_finder(image: ImageHelpers.cross_green, sample_subdivision_size: 10 )[1]
         expect(center).to be > 492
         expect(center).to be < 504
       end
       
       specify 'finds the vertical dividing line in a right t green cross, with border still present' do
-        center =  Sqed::BoundaryFinder.color_boundary_finder(target_image: ImageHelpers.right_t_green, sample_subdivision_size: 10)[1]
+        center =  Sqed::BoundaryFinder.color_boundary_finder(image: ImageHelpers.right_t_green, sample_subdivision_size: 10)[1]
         expect(center).to be > 695
         expect(center).to be < 705 
       end
@@ -37,59 +37,59 @@ describe Sqed::BoundaryFinder do
 
     context 'with sample_subdivision_size auto set' do
       specify 'finds the vertical dividing line in a standard cross, with border still present, when more precise' do
-        center =  Sqed::BoundaryFinder.color_boundary_finder(target_image: ImageHelpers.cross_green, sample_cutoff_factor: 0.7)[1]
+        center =  Sqed::BoundaryFinder.color_boundary_finder(image: ImageHelpers.cross_green, sample_cutoff_factor: 0.7)[1]
         expect(center).to be > 492
         expect(center).to be < 504
       end
 
       specify 'finds the vertical dividing line a real image, with border still present' do
-        center =  Sqed::BoundaryFinder.color_boundary_finder(target_image: ImageHelpers.crossy_green_line_specimen)[1]
+        center =  Sqed::BoundaryFinder.color_boundary_finder(image: ImageHelpers.crossy_green_line_specimen)[1]
         expect(center).to be > 2452
         expect(center).to be < 2495 
       end
 
       specify 'finds the vertical dividing line a real image, with border still present, with 10x fewer subsamples' do
-        center =  Sqed::BoundaryFinder.color_boundary_finder(target_image: ImageHelpers.crossy_green_line_specimen, sample_subdivision_size: 100 )[1]
+        center =  Sqed::BoundaryFinder.color_boundary_finder(image: ImageHelpers.crossy_green_line_specimen, sample_subdivision_size: 100 )[1]
         expect(center).to be > 2452
         expect(center).to be < 2495 
       end
 
       specify 'finds the vertical dividing line a real image, with border still present, with 50x fewer subsamples' do
-        center =  Sqed::BoundaryFinder.color_boundary_finder(target_image: ImageHelpers.crossy_green_line_specimen, sample_subdivision_size: 500 )[1]
+        center =  Sqed::BoundaryFinder.color_boundary_finder(image: ImageHelpers.crossy_green_line_specimen, sample_subdivision_size: 500 )[1]
         expect(center).to be > 2452
         expect(center).to be < 2495 
       end
 
       specify 'FAILS to find the vertical dividing line a real image, with border still present, with 200x fewer subsamples' do
-        center =  Sqed::BoundaryFinder.color_boundary_finder(target_image: ImageHelpers.crossy_green_line_specimen, sample_subdivision_size: 2000 )
+        center =  Sqed::BoundaryFinder.color_boundary_finder(image: ImageHelpers.crossy_green_line_specimen, sample_subdivision_size: 2000 )
         expect(center).to be nil
       end
 
       specify 'finds the vertical dividing line another real image, with border still present' do
-        center = Sqed::BoundaryFinder.color_boundary_finder(target_image: ImageHelpers.greenline_image)[1]
+        center = Sqed::BoundaryFinder.color_boundary_finder(image: ImageHelpers.greenline_image)[1]
         expect(center).to be > 2445
         expect(center).to be < 2495
       end
 
       specify 'finds the vertical dividing line another real image, with border still present, and 20x fewer subsamples' do
-        center = Sqed::BoundaryFinder.color_boundary_finder(target_image: ImageHelpers.greenline_image, sample_subdivision_size: 200)[1]
+        center = Sqed::BoundaryFinder.color_boundary_finder(image: ImageHelpers.greenline_image, sample_subdivision_size: 200)[1]
         expect(center).to be > 2445
         expect(center).to be < 2495
       end
 
       specify 'finds the vertical dividing line another real image, with border still present, and 50x fewer subsamples' do
-        center = Sqed::BoundaryFinder.color_boundary_finder(target_image: ImageHelpers.greenline_image, sample_subdivision_size: 500)[1]
+        center = Sqed::BoundaryFinder.color_boundary_finder(image: ImageHelpers.greenline_image, sample_subdivision_size: 500)[1]
         expect(center).to be > 2445
         expect(center).to be < 2495
       end
 
       specify 'FAILS to find the vertical dividing line in a standard cross, with border still present, when even more precise' do
-        center =  Sqed::BoundaryFinder.color_boundary_finder(target_image: ImageHelpers.cross_green, sample_cutoff_factor: 1)
+        center =  Sqed::BoundaryFinder.color_boundary_finder(image: ImageHelpers.cross_green, sample_cutoff_factor: 1)
         expect(center).to be nil
       end
 
       specify 'finds the horizontal dividing line another real image, with border still present' do
-        center = Sqed::BoundaryFinder.color_boundary_finder(target_image: ImageHelpers.greenline_image, scan: :columns)[1]
+        center = Sqed::BoundaryFinder.color_boundary_finder(image: ImageHelpers.greenline_image, scan: :columns)[1]
         expect(center).to be > 1282
         expect(center).to be < 1332 
       end
@@ -104,33 +104,42 @@ describe Sqed::BoundaryFinder do
     end
 
     specify 'returns estimated borders if only one hit greater than samples taken' do
-      expect( Sqed::BoundaryFinder.frequency_stats(i, 15)).to eq([2,3,4])
+      expect( Sqed::BoundaryFinder.frequency_stats(i, 15)).to eq([2, 3, 4])
     end
 
     specify 'returns nil if no count is greater than samples taken' do
       expect( Sqed::BoundaryFinder.frequency_stats(i, 20)).to eq(nil)
     end
- 
 
   end
 
   context 'offset boundaries from crossy_black_line_specimen image ' do
-    before(:all) {
-      @s = Sqed.new(target_image: ImageHelpers.crossy_black_line_specimen, target_pattern: :vertical_offset_cross, boundary_color: :black)
+    before(:all) do
+      @s = Sqed.new(image: ImageHelpers.crossy_black_line_specimen, pattern: :vertical_offset_cross, boundary_color: :black)
       @s.crop_image
       @offset_boundaries = @s.boundaries.offset(@s.stage_boundary)
       true
-    }
+    end
+
+    specify 'boundaries are complete' do
+      expect(@s.boundaries.complete).to be(true)
+    end
+
+    specify 'stage_boundaries are complete' do
+      expect(@offset_boundaries.complete).to be(true)
+    end
+
+    specify 'four co-ordinates are returned' do
+      expect(@s.boundaries.coordinates.length).to eq(4)
+    end
 
-    ##**** actually fails (?!)
-    specify "offset and size should match internal found areas " do     
+    ## **** actually fails (?!)
+    specify 'offset and size should match internal found areas' do
       sbx = @s.stage_boundary.x_for(0)
       sby = @s.stage_boundary.y_for(0)
 
-      sl =  @s.boundaries.coordinates.length  # may be convenient to clone this model for other than 4 boundaries found
-      expect(sl).to eq(4)    #for offset cross pattern and valid image
-      expect(@s.boundaries.complete).to be(true)
-      expect(@offset_boundaries.complete).to be(true)
+      sl =  @s.boundaries.coordinates.length # may be convenient to clone this model for other than 4 boundaries found
+
       (0..sl - 1).each do |i|
         # check all the x/y
         expect(@offset_boundaries.x_for(i)).to eq(@s.boundaries.x_for(i) + sbx)
@@ -143,22 +152,31 @@ describe Sqed::BoundaryFinder do
     end
   end
 
-  context 'offset boundaries from black_green_line_specimen image ' do
-    before(:all) {
-      @s = Sqed.new(target_image: ImageHelpers.black_stage_green_line_specimen, target_pattern: :vertical_offset_cross)
+  context 'offset boundaries from black_green_line_specimen image' do
+    before(:all) do
+      @s = Sqed.new(image: ImageHelpers.black_stage_green_line_specimen, pattern: :vertical_offset_cross)
       @s.crop_image
       @offset_boundaries = @s.boundaries.offset(@s.stage_boundary)
-      true 
-    }
+    end
+
+    specify 'boundaries are complete' do
+      expect(@s.boundaries.complete).to be(true)
+    end
 
-    specify "offset and size should match internal found areas " do
+    specify 'stage_boundaries are complete' do
+      expect(@offset_boundaries.complete).to be(true)
+    end
+
+    specify 'three co-ordinates are returned' do
+      expect(@s.boundaries.coordinates.length).to eq(4) # for offset cross pattern and valid image
+    end
+
+    specify 'offset and size should match internal found areas' do
       sbx = @s.stage_boundary.x_for(0)
       sby = @s.stage_boundary.y_for(0)
 
       sl =  @s.boundaries.coordinates.count  # may be convenient to clone this model for other than 4 boundaries found
-      expect(sl).to eq(4)    #for offset cross pattern and valid image
-      expect(@s.boundaries.complete).to be(true)
-      expect(@offset_boundaries.complete).to be(true)
+
       (0..sl - 1).each do |i|
         # check all the x/y
         expect(@offset_boundaries.x_for(i)).to eq(@s.boundaries.x_for(i) + sbx)
@@ -169,26 +187,36 @@ describe Sqed::BoundaryFinder do
         expect(@offset_boundaries.height_for(i)).to eq(@s.boundaries.height_for(i))
       end
     end
-  end 
+  end
 
-  context 'offset boundaries from original red_line image ' do
+  context 'offset boundaries from original red_line image' do
     before(:all) {
-      @s = Sqed.new(target_image: ImageHelpers.vertical_offset_cross_red, target_pattern: :right_t, boundary_color: :red)
+      @s = Sqed.new(image: ImageHelpers.vertical_offset_cross_red, pattern: :right_t, boundary_color: :red)
       @s.crop_image
       @offset_boundaries = @s.boundaries.offset(@s.stage_boundary)
     }
 
-    specify "offset and size should match internal found areas " do
-      sbx = @s.stage_boundary.x_for(0)  # only a single boundary
+    specify 'boundaries are complete' do
+      expect(@s.boundaries.complete).to be(true)
+    end
+
+    specify 'stage_boundaries are complete' do
+      expect(@offset_boundaries.complete).to be(true)
+    end
+
+    specify 'three co-ordinates are returned' do
+      expect(@s.boundaries.coordinates.length).to eq(3)
+    end
+
+    specify 'offset and size should match internal found areas' do
+      sbx = @s.stage_boundary.x_for(0) # only a single boundary
       sby = @s.stage_boundary.y_for(0)
       pct = 0.02
 
-      sl =  @s.boundaries.coordinates.count 
-      expect(sl).to eq(3)   
-      expect(@s.boundaries.complete).to be(true)
-      expect(@offset_boundaries.complete).to be(true)
-      expect(@s.stage_boundary.width_for(0)).to be_within(pct*800).of(800)
-      expect(@s.stage_boundary.height_for(0)).to be_within(pct*600).of(600)
+      sl =  @s.boundaries.coordinates.count
+
+      expect(@s.stage_boundary.width_for(0)).to be_within(pct * 800).of(800)
+      expect(@s.stage_boundary.height_for(0)).to be_within(pct * 600).of(600)
       (0..sl - 1).each do |i|
         # check all the x/y
         expect(@offset_boundaries.x_for(i)).to eq(@s.boundaries.x_for(i) + sbx)

data/spec/lib/sqed/extractor_spec.rb

@@ -9,15 +9,15 @@ describe Sqed::Extractor do
 
   let(:boundaries) { 
     Sqed::BoundaryFinder::CrossFinder.new(
-      target_image: image
+      image: image
     ).boundaries
   }
 
   let(:e) {
     Sqed::Extractor.new(
-      target_boundaries: boundaries,
-      target_image: image,
-      target_metadata_map: metadata_map
+      boundaries: boundaries,
+      image: image,
+      metadata_map: metadata_map
     )
   }
 

data/spec/lib/sqed/parser/ocr_spec.rb

@@ -9,8 +9,8 @@ describe Sqed::Parser::OcrParser do
     expect(p).to respond_to(:image)
   end
 
-  specify '#text returns some text' do
-    expect(p.text).to eq('README.md')
+  specify '#get_text returns some text' do
+    expect(p.get_text).to eq('README.md')
   end
 
 end 

data/spec/lib/sqed_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Sqed do
 
-  let(:s) {Sqed.new}
+  let(:s) { Sqed.new }
 
   context 'attributes' do
 
@@ -30,13 +30,18 @@ describe Sqed do
       expect(s).to respond_to(:boundaries)
     end
 
-    specify '#has_border' do
-      expect(s).to respond_to(:has_border)
+    specify '#has_border defaults to `true`' do
+      expect(s.has_border).to eq(true)
     end
 
-    specify '#boundary_color' do
-      expect(s).to respond_to(:boundary_color)
+    specify '#boundary_color defaults to :green' do
+      expect(s.boundary_color).to eq(:green)
     end
+
+    specify '#use_thumbnail defaults to `true`' do
+      expect(s.use_thumbnail).to eq(true)
+    end
+
   end
 
   context 'initialization' do 
@@ -51,10 +56,10 @@ describe Sqed do
     end
   end
 
-  # test intent is to just test wrapping functionality, see
+  # Intent is to just test wrapping functionality, see
   # other tests for specifics on finders
-  context '#crop_image (with bordered stage)' do 
-    specify 'finds a cropped image smaller than original' do 
+  context '#crop_image (with bordered stage)' do
+    specify 'finds a cropped image smaller than original' do
       s.image = ImageHelpers.test3_image
       expect(s.crop_image).to be_truthy
       expect(s.stage_image.columns < s.image.columns).to be(true)
@@ -63,7 +68,7 @@ describe Sqed do
 
     specify 'properly sets stage boundaries ' do
       s.image = ImageHelpers.cross_green
-      s.crop_image 
+      s.crop_image
       # ~ (100,94, 800, 600)
       expect(s.stage_boundary.x_for(0)).to be_within(2).of 100
       expect(s.stage_boundary.y_for(0)).to be_within(2).of 94
@@ -74,81 +79,76 @@ describe Sqed do
 
   context 'all together, without border' do
     let(:image) { ImageHelpers.frost_stage }
-    let(:pattern) { :vertical_offset_cross }
-    let(:s) { Sqed.new(target_image: image, target_pattern: pattern, has_border: false)  }
+    let(:s1) { Sqed.new(image: image, pattern: :vertical_offset_cross, has_border: false) }
 
     specify '#boundaries returns a Sqed::Boundaries instance' do
-      expect(s.boundaries.class.name).to eq('Sqed::Boundaries')
+      expect(s1.boundaries.class.name).to eq('Sqed::Boundaries')
     end
 
     specify '#stage_image returns an Magick::Image' do
-      expect(s.stage_image.class.name).to eq('Magick::Image')
+      expect(s1.stage_image.class.name).to eq('Magick::Image')
     end
 
     specify '#crop_image returns an Magick::Image' do
-      expect(s.crop_image.class.name).to eq('Magick::Image')
+      expect(s1.crop_image.class.name).to eq('Magick::Image')
     end
 
     specify '#crop_image returns #stage_image' do
-      expect(s.crop_image).to eq(s.stage_image)
+      expect(s1.crop_image).to eq(s1.stage_image)
     end
 
     context '#result' do
-      let(:r) { s.result }
+      let(:rz) { s1.result }
 
       specify 'returns a Sqed::Result' do
-        expect(r.class.name).to eq('Sqed::Result')
+        expect(rz.class.name).to eq('Sqed::Result')
       end
 
-      context 'extracted data' do
-        specify 'text for an :identifier section' do
-          expect(r.text_for(:identifier)).to match('000041196')
-        end
+      specify '#text_for an :identifier section' do
+        expect(rz.text_for(:identifier)).to match('000041196')
+      end
 
-        # This originally worked, it now does not in the present settings
-        # specify 'text for an annotated_specimen section' do
-        #   expect(r.text_for(:annotated_specimen)).to match('Saucier Creek')
-        # end
+      specify '#text_for an :annotated_specimen section' do
+        expect(rz.text_for(:annotated_specimen)).to match('Saucier Creek')
+      end
 
-        specify 'text for a curator_metadata section' do
-          expect(r.text_for(:curator_metadata)).to match('Frost Entomological Museum')
-        end
+      specify '#text_for a :curator_metadata section' do
+        expect(rz.text_for(:curator_metadata)).to match('Frost Entomological Museum')
       end
     end
   end
 
   context 'all together, with border' do
     let(:image) { ImageHelpers.greenline_image }
-    let(:pattern) { :right_t }
-    let(:s) { Sqed.new(target_image: image, target_pattern: pattern, has_border: true)  }
+    let(:s2) { Sqed.new(image: image, pattern: :right_t, has_border: true) }
 
     specify '#boundaries returns a Sqed::Boundaries instance' do
-      expect(s.boundaries.class.name).to eq('Sqed::Boundaries')
+      expect(s2.boundaries.class.name).to eq('Sqed::Boundaries')
     end
 
     specify '#stage_image returns an Magick::Image' do
-      expect(s.stage_image.class.name).to eq('Magick::Image')
+      expect(s2.stage_image.class.name).to eq('Magick::Image')
     end
 
     specify '#crop_image returns an Magick::Image' do
-      expect(s.crop_image.class.name).to eq('Magick::Image')
+      expect(s2.crop_image.class.name).to eq('Magick::Image')
     end
 
     specify '#crop_image returns #stage_image' do
-      expect(s.crop_image).to eq(s.stage_image)
+      expect(s2.crop_image).to eq(s2.stage_image)
     end
 
     context '#result' do
-      let(:r) { s.result }
+      let(:r) { s2.result }
       specify 'returns a Sqed::Result' do
         expect(r.class.name).to eq('Sqed::Result')
       end
 
       context 'extracted data' do
-        # Default settings return nothing, though some combinations of this worked previosly
-        # specify 'text for an :identifier section' do
-        #   expect(r.text_for(:identifier)).to match('000085067')
-        # end
+        # Default settings return nothing, though some combinations of this worked previously
+        specify 'text for an :identifier section' do
+          expect(r.text_for(:identifier)).to match('000085067')
+        end
 
         specify 'text for a specimen section' do
           expect(r.text_for(:annotated_specimen)).to match('Aeshna')