ruby_marks 0.2.2 → 0.2.3

data/README.md

@@ -246,6 +246,15 @@ config.edge_level = 4
 config.threshold_level = 60  
 ```
 
+### Scan timeout 
+
+```ruby
+# Sets a timeout in seconds, to break long time scans.   
+# The default value is 0 (zero) and means there's no timeout. Any value will quit the scan and raise timed_out_watcher
+
+config.scan_timeou = 0  
+```
+
 ### Expected lines
 
 ```ruby
@@ -433,6 +442,17 @@ recognizer.add_watcher :incorrect_group_watcher do |recognizer, incorrect_expect
 end
 ```
 
+### Timed Out Watcher
+
+```ruby
+# Will execute your custom code if your scan outrun the specified timeout in configuration. It returns you recognizer 
+# object.
+
+recognizer.add_watcher :timed_out_watcher do |recognizer|
+  # place your custom code 
+end
+```
+
 Contributing
 ------------
 

data/lib/ruby_marks/config.rb

@@ -4,7 +4,7 @@ module RubyMarks
   class Config
 
     attr_accessor :intensity_percentual, :edge_level, :default_marks_options, :threshold_level, 
-                  :default_mark_width, :default_mark_height, 
+                  :default_mark_width, :default_mark_height, :scan_timeout,
                   :default_mark_width_tolerance, :default_mark_height_tolerance,
                   :default_distance_between_marks, :adjust_inconsistent_bubbles,
                   :default_expected_lines
@@ -14,7 +14,8 @@ module RubyMarks
       @recognizer = recognizer
       @threshold_level = RubyMarks.threshold_level
       @edge_level = RubyMarks.edge_level
-      
+      @scan_timeout = RubyMarks.scan_timeout
+
       @adjust_inconsistent_bubbles  = RubyMarks.adjust_inconsistent_bubbles
 
       @intensity_percentual = RubyMarks.intensity_percentual

data/lib/ruby_marks/recognizer.rb

@@ -85,7 +85,13 @@ module RubyMarks
       result = Hash.new { |hash, key| hash[key] = [] }
       result.tap do |result|
  
-        self.detect_groups unless @groups_detected
+        begin 
+          Timeout.timeout(@config.scan_timeout) do
+            self.detect_groups unless @groups_detected 
+          end        
+        rescue Timeout::Error
+          raise_watcher :timed_out_watcher
+        end       
 
         @groups.each_pair do |label, group|        
           marks = Hash.new { |hash, key| hash[key] = [] }
@@ -114,6 +120,7 @@ module RubyMarks
       incorrect_bubble_line_found = Hash.new { |hash, key| hash[key] = [] }
       bubbles_adjusted = []
       incorrect_expected_lines = false
+
       @groups.each_pair do |label, group|
         next unless group.expected_coordinates.any?
 
@@ -372,7 +379,13 @@ module RubyMarks
 
       file.tap do |file|
 
-        self.detect_groups unless @groups_detected
+        begin 
+          Timeout.timeout(@config.scan_timeout) do
+            self.detect_groups unless @groups_detected 
+          end        
+        rescue Timeout::Error
+          raise_watcher :timed_out_watcher
+        end  
 
         @groups.each_pair do |label, group|  
 

data/lib/ruby_marks/version.rb

@@ -1,3 +1,3 @@
 module RubyMarks
-  VERSION = "0.2.2".freeze
+  VERSION = "0.2.3".freeze
 end

data/lib/ruby_marks.rb

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'RMagick'
+require 'sane_timeout'
 require 'ruby_marks/version'
 require 'ruby_marks/support'
 
@@ -11,6 +12,9 @@ module RubyMarks
   mattr_accessor :threshold_level
   @@threshold_level = 60
 
+  mattr_accessor :scan_timeout
+  @@scan_timeout = 0
+
   mattr_accessor :adjust_inconsistent_bubbles
   @@adjust_inconsistent_bubbles = true
 
@@ -56,7 +60,8 @@ module RubyMarks
     :scan_mark_watcher,
     :scan_unmarked_watcher,
     :scan_multiple_marked_watcher,
-    :incorrect_group_watcher
+    :incorrect_group_watcher,
+    :timed_out_watcher
   ]
 end
 

data/test/ruby_marks/recognizer_test.rb

@@ -150,5 +150,16 @@ class RubyMarks::RecognizerTest < Test::Unit::TestCase
   end
 
 
+  def test_should_make_timeout_watcher_raise_up  
+    @recognizer.configure do |config|
+      config.scan_timeout = 1
+    end
+
+    @recognizer.add_watcher :timed_out_watcher
+
+    @recognizer.scan
+    assert @recognizer.raised_watchers.include?(:timed_out_watcher)
+  end
+
 end
  

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_marks
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
   prerelease: 
 platform: ruby
 authors: