dom_glancy 1.0.1 → 1.1.0

data/lib/dom_glancy/change_anlyzer.rb

@@ -0,0 +1,22 @@
+module DomGlancy
+  class ChangeAnalyzer
+    attr_accessor :change_factors
+
+    def initialize(change_factors = [])
+      @change_factors = Array.new(change_factors)[0..4]
+
+      @change_factors << 0   if @change_factors.length == 0
+      @change_factors << 1   if @change_factors.length == 1
+      @change_factors << 1.2 if @change_factors.length == 2
+      @change_factors << 2   if @change_factors.length == 3
+      @change_factors << 5  if @change_factors.length == 4
+    end
+
+    def compare(element1, element2)
+      change_info = element1.change_info(element2)
+      deltas = change_info.map { |changed| (element1.send(changed.to_sym) - element2.send(changed.to_sym)).abs }
+      comparison_value = deltas.inject { |sum, n| n + n * deltas.count * @change_factors[deltas.count] }
+      comparison_value
+    end
+  end
+end

data/lib/dom_glancy/dom_glancy.rb

@@ -2,114 +2,65 @@ module DomGlancy
   class DomGlancy
     def page_map_same?(test_root)
       purge_old_files_before_test(test_root)
+      fnb = ::DomGlancy::FileNameBuilder.new(test_root)
 
-      result, msg = map_current_file(test_root)
+      result, msg = ::DomGlancy::PageMapper.new.run(test_root)
       return [result, msg]  unless result
 
       result, msg = master_file_exists?(test_root)
       return [result, msg] unless result
 
-      result, msg, current_data = read_map_file(DomGlancy.current_filename(test_root))
+      result, msg, current_data = ::DomGlancy::MapFile.new.read(fnb.current)
       return [result, msg]  unless result
 
-      result, msg, master_data = read_map_file(DomGlancy.master_filename(test_root))
+      result, msg, master_data = ::DomGlancy::MapFile.new.read(fnb.master)
       return [result, msg]  unless result
 
-      analysis_data = analyze(master_data, current_data, test_root)
+      analyzer = ::DomGlancy::Analyzer.new(master_data, current_data, test_root)
+      analysis_data = analyzer.analyze
 
-      msg = make_analysis_failure_report(analysis_data)
-      result = analysis_data[:same]
-
-      File.delete DomGlancy.current_filename(test_root) if result
-
-      [result, msg]
-    end
-
-
-    def read_map_file(filename)
-      results = [true, '', nil]
-      begin
-        results[2] = YAML::load( File.open( filename ) )
-      rescue Exception => e
-        results = [false, "Error reading data from file: #{filename}", nil]
+      unless analysis_data[:same]
+        analysis_reporter = ::DomGlancy::AnalysisReporter.new(test_root, analyzer.set_current_not_master, analyzer.set_master_not_current, analyzer.set_changed_master, analyzer.changed_element_pairs)
+        analysis_reporter.create_diff_file
       end
 
-      results
-    end
-
-    def map_current_file(test_root)
-      filename = DomGlancy.current_filename(test_root)
+      msg = console_failure_string(analysis_data)
+      result = analysis_data[:same]
 
-      result = [true, '']
-      begin
-        data = perform_mapping_operation.to_yaml
-        File.open(filename, 'w') { |file| file.write(data) }
-      rescue Exception => e
-        result = [false, "map current file error: #{e.message}"]
-      end
+      File.delete fnb.current if result
 
-      result
+      [result, msg]
     end
 
-    def resize_browser_for_scrollbar
-      original_dimensions = Capybara.current_session.driver.browser.manage.window.size
-      width = Capybara.current_session.evaluate_script('window.innerWidth - document.documentElement.clientWidth').to_i
+    private
 
-      Capybara.current_session.driver.browser.manage.window.resize_to(original_dimensions.width + width, original_dimensions.height) if width > 0
+    def console_failure_string(analysis_data)
+      return '' if analysis_data[:same]
 
-      result = yield
+      fnb = ::DomGlancy::FileNameBuilder.new(analysis_data[:test_root])
 
-      Capybara.current_session.driver.browser.manage.window.resize_to(original_dimensions.width, original_dimensions.height) if width > 0
+      msg = ["\n------- DOM Comparison Failure ------"]
+      msg << "Elements not in master: #{analysis_data[:not_in_master].count}"
+      msg << "Elements not in current: #{analysis_data[:not_in_current].count}"
+      msg << "Changed elements: #{analysis_data[:changed_element_pairs].count}"
+      msg << "Files:"
+      msg << "\tcurrent: #{fnb.current}"
+      msg << "\tmaster: #{fnb.master}"
+      msg << "\tdifference: #{fnb.diff}"
+      msg << "Bless this current data set:"
+      msg << "\t#{blessing_copy_string(analysis_data[:test_root])}"
+      msg<< "-------------------------------------"
 
-      result
+      msg.join("\n")
     end
 
-    def perform_mapping_operation
-      page_map_js = <<-JS
-        var dom_glancy = {
-
-          treeUp: function() {
-            var treeWalker = document.createTreeWalker(
-              document.body,
-              NodeFilter.SHOW_ELEMENT,
-              { acceptNode: function(node) { return NodeFilter.FILTER_ACCEPT; } },
-              false
-            );
-
-            var nodeList = [];
-
-            while(treeWalker.nextNode()){
-              var cn = treeWalker.currentNode;
-              var node_details = {
-                "height"  : cn.clientHeight,
-                "width"   : cn.clientWidth,
-                "id"      : cn.id,
-                "tag"     : cn.tagName,
-                "class"   : cn.className,
-                "top"     : cn.offsetTop,
-                "left"    : cn.offsetLeft,
-                "visible" : dom_glancy.isVisible(cn)
-              }
-              nodeList.push(node_details);
-            }
-
-            return(nodeList);
-          },
-
-          isVisible: function(elem) {
-              return elem.offsetWidth > 0 || elem.offsetHeight > 0;
-          }
-        };
-        return dom_glancy.treeUp();
-      JS
-
-      resize_browser_for_scrollbar do
-        Capybara.current_session.driver.browser.execute_script(page_map_js)
-      end
+    def blessing_copy_string(test_root)
+      fnb = ::DomGlancy::FileNameBuilder.new(test_root)
+      "cp #{fnb.current} #{fnb.master}"
     end
 
     def master_file_exists?(test_root)
-      filename = DomGlancy.master_filename(test_root)
+      filename = ::DomGlancy::FileNameBuilder.new(test_root).master
       result = File.exist?(filename)
       msg = result ? '' : make_missing_master_failure_report(test_root)
       [result, msg]
@@ -126,7 +77,8 @@ module DomGlancy
     end
 
     def purge_old_files_before_test(test_root)
-      File.delete DomGlancy.current_filename(test_root) if File.exist?(DomGlancy.current_filename(test_root))
+      old_current_file = ::DomGlancy::FileNameBuilder.new(test_root).current
+      File.delete old_current_file if File.exist?(old_current_file)
 
       filename_pattern = File.join(::DomGlancy.configuration.diff_file_location, "#{test_root}__*__diff.yaml")
       Dir[filename_pattern].each { |file| file.delete(file) if File.exist?(file) }

data/lib/dom_glancy/element.rb

@@ -1,5 +1,4 @@
 module DomGlancy
-
   class DOMElement
     ## element looks like this in archive.
     # {"id"=>"", "height"=>238, "visible"=>true, "tag"=>"DIV", "width"=>720, "class"=>"grid", "left"=>43, "top"=>14}
@@ -16,16 +15,16 @@ module DomGlancy
     attr_accessor :similarity
 
     def initialize(h = {})
-      @tag        = h[:tag]        || h['tag']
-      @left       = h[:left]       || h['left']
-      @top        = h[:top]        || h['top']
-      @height     = h[:height]     || h['height']
-      @width      = h[:width]      || h['width']
-      @klass      = h[:class]      || h['class']
-      @id         = h[:id]         || h['id']
-      @style      = h[:style]      || h['style']
-      @visible    = h[:visible]    || h['visible']
-      @similarity = h[:similarity] || h['similarity'] || 0
+      @tag        = h['tag']
+      @left       = h['left']
+      @top        = h['top']
+      @height     = h['height']
+      @width      = h['width']
+      @klass      = h['class']
+      @id         = h['id']
+      @style      = h['style']
+      @visible    = h['visible']
+      @similarity = h['similarity'] || 0
     end
 
     def same_element?(anOther)
@@ -38,7 +37,7 @@ module DomGlancy
       same = same_element?(anOther)     &&
           similar_size?(anOther, 0)     &&
           similar_location?(anOther, 0) &&
-          same_size?(anOther) &&
+          same_size?(anOther)           &&
           same_visibility?(anOther)
     end
 
@@ -60,6 +59,22 @@ module DomGlancy
       similar && (@left - anOther.left).abs <= similarity
     end
 
+    def similar_top?(anOther, similarity = 0)
+      (@top - anOther.top).abs <= similarity
+    end
+
+    def similar_left?(anOther, similarity = 0)
+      (@left - anOther.left).abs <= similarity
+    end
+
+    def similar_width?(anOther, similarity = 0)
+      (@width - anOther.width).abs <= similarity
+    end
+
+    def similar_height?(anOther, similarity = 0)
+      (@height - anOther.height).abs <= similarity
+    end
+
     def same_tag?(anOther)
       @tag == anOther.tag
     end
@@ -88,5 +103,41 @@ module DomGlancy
       @style == anOther.style
     end
 
+    def similarity_level(anOther)
+      level = 0
+      if same_element?(anOther) && same_style?(anOther)
+        level += 1 if similar_location?(anOther, @similarity) and !same_location?(anOther)
+        level += 1 if similar_size?(anOther, @similarity)     and !same_size?(anOther)
+      end
+      level
+    end
+
+    def change_level(anOther)
+      change_info(anOther).length
+    end
+
+    def change_info(anOther)
+      info = []
+      if same_element?(anOther)
+        info << 'left' unless similar_left?(anOther, @similarity)
+        info << 'top' unless similar_top?(anOther, @similarity)
+        info << 'height' unless similar_height?(anOther, @similarity)
+        info << 'width' unless similar_width?(anOther, @similarity)
+      end
+      info
+    end
+
+    def to_hash
+      {
+          'id'      => @id,
+          'height'  => @height,
+          'visible' => @visible,
+          'tag'     => @tag,
+          'width'   => @width,
+          'class'   => @klass,
+          'left'    => @left,
+          'top'     => @top
+      }
+    end
   end
 end

data/lib/dom_glancy/file_name_builder.rb

@@ -0,0 +1,21 @@
+module DomGlancy
+  class FileNameBuilder
+    attr_accessor :test_root
+
+    def initialize(test_root = '')
+      @test_root = test_root
+    end
+
+    def master
+      File.join(::DomGlancy.configuration.master_file_location, "#{@test_root}_master.yaml")
+    end
+
+    def current
+      File.join(::DomGlancy.configuration.current_file_location, "#{@test_root}.yaml")
+    end
+
+    def diff
+      File.join(::DomGlancy.configuration.diff_file_location, "#{@test_root}_diff.html")
+    end
+  end
+end

data/lib/dom_glancy/map_file.rb

@@ -0,0 +1,14 @@
+module DomGlancy
+  class MapFile
+    def read(filename)
+      results = [true, '', nil]
+      begin
+        results[2] = YAML::load( File.open( filename ) )
+      rescue Exception => e
+        results = [false, "Error reading data from file: #{filename}", nil]
+      end
+
+      results
+    end
+  end
+end

data/lib/dom_glancy/page_mapper.rb

@@ -0,0 +1,81 @@
+module DomGlancy
+  class PageMapper
+
+    def run(test_root)
+      filename = ::DomGlancy::FileNameBuilder.new(test_root).current
+
+      result = [true, '']
+      begin
+        data = map_page.to_yaml
+        File.open(filename, 'w') { |file| file.write(data) }
+      rescue Exception => e
+        result = [false, "map current file error: #{e.message}"]
+      end
+
+      result
+    end
+
+    private
+
+    def map_page
+      page_map_js = mapping_javascript
+      resize_browser_for_scrollbar do
+        Capybara.current_session.driver.browser.execute_script(page_map_js)
+      end
+    end
+
+    def mapping_javascript
+      <<-JS
+        var dom_glancy = {
+
+          treeUp: function() {
+            var treeWalker = document.createTreeWalker(
+              document.body,
+              NodeFilter.SHOW_ELEMENT,
+              { acceptNode: function(node) { return NodeFilter.FILTER_ACCEPT; } },
+              false
+            );
+
+            var nodeList = [];
+
+            while(treeWalker.nextNode()){
+              var cn = treeWalker.currentNode;
+              var node_details = {
+                "height"  : cn.clientHeight,
+                "width"   : cn.clientWidth,
+                "id"      : cn.id,
+                "tag"     : cn.tagName,
+                "class"   : cn.className,
+                "top"     : cn.offsetTop,
+                "left"    : cn.offsetLeft,
+                "visible" : dom_glancy.isVisible(cn)
+              }
+              nodeList.push(node_details);
+            }
+
+            return(nodeList);
+          },
+
+          isVisible: function(elem) {
+              return elem.offsetWidth > 0 || elem.offsetHeight > 0;
+          }
+        };
+        return dom_glancy.treeUp();
+      JS
+    end
+
+    def resize_browser_for_scrollbar
+      original_dimensions = Capybara.current_session.driver.browser.manage.window.size
+      width = Capybara.current_session.evaluate_script('window.innerWidth - document.documentElement.clientWidth').to_i
+
+      Capybara.current_session.driver.browser.manage.window.resize_to(original_dimensions.width + width, original_dimensions.height) if width > 0
+
+      result = yield
+
+      Capybara.current_session.driver.browser.manage.window.resize_to(original_dimensions.width, original_dimensions.height) if width > 0
+
+      result
+    end
+
+  end
+end

data/lib/dom_glancy/svg.rb

@@ -1,6 +1,20 @@
 module DomGlancy
-  class DomGlancy
-    def generate_svg(rectangles)
+  class SVG
+    @set_current_not_master
+    @set_master_not_current
+    @set_changed_master
+
+    def initialize(set_current_not_master, set_master_not_current, set_changed_master)
+      @set_current_not_master = set_current_not_master
+      @set_master_not_current = set_master_not_current
+      @set_changed_master     = set_changed_master
+    end
+
+    def generate_svg
+      add_ids
+
+      rectangles = make_rectangles
+
       width, height = get_window_size_from_rectangles(rectangles)
       s = svg_start(width, height)
 
@@ -13,6 +27,31 @@ module DomGlancy
       s += "\n"
     end
 
+    private
+
+    def add_ids
+      js_id = 0
+      @set_master_not_current.each do |item|
+        item[:js_id] = js_id
+        js_id += 1
+      end
+      @set_current_not_master.each do |item|
+        item[:js_id] = js_id
+        js_id += 1
+      end
+      @set_changed_master.each do |item|
+        item[:js_id] = js_id
+        js_id += 1
+      end
+    end
+
+    def make_rectangles
+      rectangles = @set_current_not_master.map  { |item| item.merge(format__not_in_master) }
+      rectangles << @set_master_not_current.map { |item| item.merge(format__not_in_current) }
+      rectangles << @set_changed_master.map     { |item| item.merge(format__same_but_different) }
+      rectangles.flatten!
+    end
+
     def get_window_size_from_rectangles(rectangles)
       width = 0
       height = 0