dom_glancy 1.0.1 → 1.1.0

data/test/test_objects/test_objects.rb

@@ -595,7 +595,7 @@ module TestObjects
       YAML::load(data)
     end
   
-    def travis_local_generated_master_2
+  def travis_local_generated_master_2
       data = <<-DATA
 ---
 - height: 45
@@ -1160,11 +1160,10 @@ module TestObjects
   visible: false
       DATA
   
-      YAML::load(data)
-    end
-  
-  
-    def travis_generated_current
+    YAML::load(data)
+  end
+
+  def travis_generated_current
       data = <<-DATA
 ---
 - height: 45
@@ -2026,4 +2025,56 @@ module TestObjects
     DATA
     YAML::load(data)
   end
+
+  def mapping_json
+    "--- - id: '12'   height: 238   visible: true   tag: DIV   width: 720   class: grid   left: 43   top: 14 - id: '14'   height: 0   visible: true   tag: SPAN   width: 0   class: mm--title_text_sub   left: 71   top: 86 "
+  end
+
+  def set_1_h1_changes
+    data = <<-DATA
+---
+- height: 38
+  width: 944
+  id: ''
+  tag: H1
+  class: ''
+  top: 21
+  left: 8
+  visible: true
+- height: 38
+  width: 944
+  id: ''
+  tag: H1
+  class: ''
+  top: 291
+  left: 8
+  visible: true
+
+    DATA
+    YAML::load(data)
+  end
+
+  def set_2_h1_changes
+    data = <<-DATA
+---
+- height: 38
+  width: 1044
+  id: ''
+  tag: H1
+  class: ''
+  top: 21
+  left: 8
+  visible: true
+- height: 38
+  width: 1044
+  id: ''
+  tag: H1
+  class: ''
+  top: 291
+  left: 8
+  visible: true
+
+    DATA
+    YAML::load(data)
+  end
 end

data/test/unit/analysis_reporter_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+
+class AnalysisReporterTest < DomGlancyTestCase
+
+  def test_analysis_reporter
+    prep_locations_for_test
+
+    test_root = 'kolo_torre'
+    master_data = array_of_elements
+    current_data = array_of_elements
+    current_data << single_element_hash
+    analyzer = DomGlancy::Analyzer.new(master_data, current_data, test_root)
+    analyzer.send(:clear_results)
+
+    reporter = DomGlancy::AnalysisReporter.new(test_root, analyzer.set_current_not_master, analyzer.set_master_not_current, analyzer.set_changed_master, analyzer.changed_element_pairs)
+
+    reporter.create_diff_file
+
+    files = Dir[File.join(DomGlancy.configuration.diff_file_location, '*')]
+
+    assert_equal 5, files.length
+    assert_includes files, File.join(DomGlancy.configuration.diff_file_location, "#{test_root}__changed_master__diff.yaml")
+    assert_includes files, File.join(DomGlancy.configuration.diff_file_location, "#{test_root}__current_not_master__diff.yaml")
+    assert_includes files, File.join(DomGlancy.configuration.diff_file_location, "#{test_root}__master_not_current__diff.yaml")
+    assert_includes files, File.join(DomGlancy.configuration.diff_file_location, "#{test_root}__changed_pairs__diff.yaml")
+    assert_includes files, File.join(DomGlancy.configuration.diff_file_location, "#{test_root}_diff.html")
+  end
+end

data/test/unit/analyzer_test.rb

@@ -0,0 +1,146 @@
+require 'test_helper'
+
+class AnalyzerTest < DomGlancyTestCase
+
+  def test_same_elements
+    master_data = array_of_elements
+    current_data = array_of_elements
+
+    analysis = DomGlancy::Analyzer.new(master_data, current_data).analyze
+
+    assert_equal 0, analysis[:not_in_master].count,  'results of data analysis: not_in_master'
+    assert_equal 0, analysis[:not_in_current].count, 'results of data analysis: not_in_current'
+    assert analysis[:same],                          'results of data analysis.same'
+  end
+
+  def test_one_id_different
+    master_data = array_of_elements_small
+    current_data = array_of_elements_small
+    current_data.first['id'] = 'some-new-id'
+
+    analysis = DomGlancy::Analyzer.new(master_data, current_data).analyze
+
+    assert_equal 1, analysis[:not_in_master].count,  'results of data analysis: not_in_master'
+    assert_equal 1, analysis[:not_in_current].count, 'results of data analysis: not_in_current'
+    refute analysis[:same],                          'results of data analysis.same'
+  end
+
+  def test_one_new_element
+    master_data = array_of_elements
+    current_data = array_of_elements
+    current_data << single_element_hash
+
+    analysis = DomGlancy::Analyzer.new(master_data, current_data).analyze
+
+    assert_equal 1, analysis[:not_in_master].count,  'results of data analysis: not_in_master'
+    assert_equal 0, analysis[:not_in_current].count, 'results of data analysis: not_in_current'
+    refute analysis[:same],                          'results of data analysis.same'
+  end
+
+  def test_two_changed
+    master_data = array_of_elements
+    current_data = array_of_elements
+    current_data[0]['height'] = current_data[0]['height'] + 16
+    current_data[1]['width'] = current_data[1]['width'] + 25
+
+    analysis = DomGlancy::Analyzer.new(master_data, current_data).analyze
+
+    assert_equal 0, analysis[:not_in_master].count,         'results of data analysis: not_in_master'
+    assert_equal 0, analysis[:not_in_current].count,        'results of data analysis: not_in_current'
+    assert_equal 2, analysis[:changed_element_pairs].count, 'changed element pairs'
+    assert_equal 2, analysis[:changed_master].count,        'changed master elements'
+    refute analysis[:same],                                 'results of data analysis.same'
+  end
+
+  def test_one_changed_less_than_similarity_factor
+    master_data = array_of_elements
+    current_data = array_of_elements
+
+    current_data[1]['height'] = current_data[1]['height'] + 3
+
+    analysis = DomGlancy::Analyzer.new(master_data, current_data).analyze
+
+    assert_equal 0, analysis[:not_in_master].count,         'results of data analysis: not_in_master'
+    assert_equal 0, analysis[:not_in_current].count,        'results of data analysis: not_in_current'
+    assert_equal 0, analysis[:changed_element_pairs].count, 'changed element pairs'
+    assert analysis[:same],                                 'results of data analysis.same'
+  end
+
+  def test_one_changed_one_missing_one_added
+    master_data = array_of_elements
+    current_data = array_of_elements
+
+    current_data[0]['height'] = current_data[0]['height'] + 23   ## the one changed (by more than similarity factor)
+    current_data[1]['height'] = current_data[1]['height'] + 3    ## the one changed (by less than similarity factor and therefor not counted)
+    current_data.delete_at(5)                                    ## the one missing
+    current_data << single_element_hash                          ## the one added
+
+    analysis = DomGlancy::Analyzer.new(master_data, current_data).analyze
+
+    assert_equal 1, analysis[:not_in_master].count,          'results of data analysis: not_in_master'
+    assert_equal 1, analysis[:not_in_current].count, 'results of data analysis: not_in_current'
+    assert_equal 1, analysis[:changed_element_pairs].count, 'changed element pairs'
+    refute analysis[:same], 'results of data analysis.same'
+  end
+
+  def test_huge_list_of_similarly_named_elements
+    master_data  = travis_local_generated_master
+    current_data = travis_generated_current
+
+    analysis = DomGlancy::Analyzer.new(master_data, current_data).analyze
+    assert_equal 0, analysis[:not_in_master].count, 'results of data analysis: not_in_master'
+    assert_equal 0, analysis[:not_in_current].count, 'results of data analysis: not_in_current'
+    assert_equal 0, analysis[:changed_element_pairs].count, 'changed element pairs'
+    assert analysis[:same], 'results of data analysis.same'
+  end
+
+  def test_huge_another_list_of_similarly_named_elements
+    master_data  = travis_local_generated_master_2
+    current_data = travis_generated_current_2
+
+    analysis = DomGlancy::Analyzer.new(master_data, current_data).analyze
+
+    ## real difference that was found on travis with the INPUT tags being different styles/sizes if not css-styled
+    assert_equal 0, analysis[:not_in_master].count, 'results of data analysis: not_in_master'
+    assert_equal 0, analysis[:not_in_current].count, 'results of data analysis: not_in_current'
+    assert_equal 1, analysis[:changed_element_pairs].count, 'changed element pairs'
+    refute analysis[:same], 'results of data analysis.same'
+  end
+
+  def test_large_change_set
+    test_root = 'suso'
+    file_1 = File.expand_path('../../test_objects/options_file_1.yaml', __FILE__)
+    file_2 = File.expand_path('../../test_objects/options_file_2.yaml', __FILE__)
+
+    result, msg, current_data = DomGlancy::MapFile.new.read(file_1)
+    result, msg, master_data  = DomGlancy::MapFile.new.read(file_2)
+
+    analyzer = ::DomGlancy::Analyzer.new(master_data, current_data, test_root)
+
+    analysis_data = analyzer.analyze
+
+    # ap analysis_data
+
+    refute analysis_data[:same]
+    assert_equal 0,  analysis_data[:not_in_master].count,         'not master count'
+    assert_equal 39, analysis_data[:not_in_current].count,        'not current count'
+    assert_equal 47, analysis_data[:changed_element_pairs].count, 'changed element pairs count'
+    assert_equal 47, analysis_data[:changed_master].count,        'changed master count'
+  end
+
+  def test_from_changed_h1_sets
+    test_root = 'jordan_henderson'
+    master_data  = set_1_h1_changes
+    current_data = set_2_h1_changes
+
+    analyzer = ::DomGlancy::Analyzer.new(master_data, current_data, test_root)
+    analysis_data = analyzer.analyze
+
+    refute analysis_data[:same]
+    assert_equal 0, analysis_data[:not_in_master].count, 'not master count'
+    assert_equal 0, analysis_data[:not_in_current].count, 'not current count'
+    assert_equal 2, analysis_data[:changed_element_pairs].count, 'changed element pairs count'
+    assert_equal 2, analysis_data[:changed_master].count, 'changed master count'
+  end
+
+end

data/test/unit/change_analyzer_test.rb

@@ -0,0 +1,72 @@
+require 'test_helper'
+
+class ChangeAnalyzerTest < DomGlancyTestCase
+
+  def test_change_calculator__initialization
+    change_analyzer = DomGlancy::ChangeAnalyzer.new
+    assert_equal 0,   change_analyzer.change_factors[0]
+    assert_equal 1,   change_analyzer.change_factors[1]
+    assert_equal 1.2, change_analyzer.change_factors[2]
+    assert_equal 2,   change_analyzer.change_factors[3]
+    assert_equal 5,   change_analyzer.change_factors[4]
+
+    change_analyzer = DomGlancy::ChangeAnalyzer.new([50, 60])
+    assert_equal 50,  change_analyzer.change_factors[0]
+    assert_equal 60,  change_analyzer.change_factors[1]
+    assert_equal 1.2, change_analyzer.change_factors[2]
+    assert_equal 2,   change_analyzer.change_factors[3]
+    assert_equal 5,   change_analyzer.change_factors[4]
+
+    change_analyzer = DomGlancy::ChangeAnalyzer.new([55, 66, 7, 8, 9, 10, 12345, -10])
+    assert_equal 55, change_analyzer.change_factors[0]
+    assert_equal 66, change_analyzer.change_factors[1]
+    assert_equal 7,  change_analyzer.change_factors[2]
+    assert_equal 8,  change_analyzer.change_factors[3]
+    assert_equal 9,  change_analyzer.change_factors[4]
+    assert_nil change_analyzer.change_factors[5]
+
+    change_analyzer.change_factors[3] = 23
+    assert_equal 55, change_analyzer.change_factors[0]
+    assert_equal 66, change_analyzer.change_factors[1]
+    assert_equal 7,  change_analyzer.change_factors[2]
+    assert_equal 23, change_analyzer.change_factors[3]
+    assert_equal 9,  change_analyzer.change_factors[4]
+    assert_nil change_analyzer.change_factors[5]
+  end
+
+  def test_change_calculator__calc
+    change_analyzer = DomGlancy::ChangeAnalyzer.new
+
+    element1 = DomGlancy::DOMElement.new(single_element_hash)
+
+    element2 = element1.dup
+    element2.top += 100
+
+    element3 = element1.dup
+    element3.width  += 25
+    element3.height += 25
+
+    element4 = element1.dup
+    element4.width  += 10
+    element4.height += 10
+    element4.top    += 10
+
+    element5 = element1.dup
+    element5.width  += 3
+    element5.height += 3
+    element5.top    += 3
+    element5.left   += 3
+
+    change_value = change_analyzer.compare(element1, element2)
+    assert_equal 100, change_value
+
+    change_value = change_analyzer.compare(element1, element3)
+    assert_equal 85.0, change_value
+
+    change_value = change_analyzer.compare(element1, element4)
+    assert_equal 70.0, change_value
+
+    change_value = change_analyzer.compare(element1, element5)
+    assert_equal 63, change_value
+  end
+end

data/test/unit/dom_glancy_test.rb

@@ -7,6 +7,7 @@ class DomGlancyTest < DomGlancyTestCase
     @test_root = 'elbow'
     prep_locations_for_test
     make_master_test_file(@test_root, array_of_elements_small)
+    @dom_glancy = DomGlancy::DomGlancy.new
   end
 
   def teardown
@@ -15,9 +16,10 @@ class DomGlancyTest < DomGlancyTestCase
 
   def test_dom_glancy__missing_master
     this_test_root = 'not_elbow'
-    blessing_copy_string = "cp #{DomGlancy::DomGlancy.current_filename(this_test_root)} #{DomGlancy::DomGlancy.master_filename(this_test_root)}"
+    fnb = DomGlancy::FileNameBuilder.new(this_test_root)
+    blessing_copy_string = "cp #{fnb.current} #{fnb.master}"
 
-    @dom_glancy.stubs(:perform_mapping_operation).returns(array_of_elements_small)
+    ::DomGlancy::PageMapper.any_instance.stubs(:map_page).returns(array_of_elements_small)
     mapping_results = @dom_glancy.page_map_same?(this_test_root)
 
     refute mapping_results[0], 'test should fail because no master'
@@ -25,24 +27,27 @@ class DomGlancyTest < DomGlancyTestCase
     assert_match blessing_copy_string, mapping_results[1], 'blessing copy string should be in the error message'
 
     `#{blessing_copy_string}`
-    @dom_glancy.stubs(:perform_mapping_operation).returns(array_of_elements_small)
+    ::DomGlancy::PageMapper.any_instance.stubs(:map_page).returns(array_of_elements_small)
 
     mapping_results = @dom_glancy.page_map_same?(this_test_root)
     assert mapping_results[0], 'test should now pass with copied master'
   end
 
   def test_dom_glancy__pass
-    @dom_glancy.stubs(:perform_mapping_operation).returns(array_of_elements_small)
+    ::DomGlancy::PageMapper.any_instance.stubs(:map_page).returns(array_of_elements_small)
+
     mapping_results = @dom_glancy.page_map_same?(@test_root)
 
     assert mapping_results[0], mapping_results[1]
   end
 
   def test_dom_glancy__fail_one_new_element
-    blessing_copy_string = "cp #{DomGlancy::DomGlancy.current_filename(@test_root)} #{DomGlancy::DomGlancy.master_filename(@test_root)}"
+    fnb = DomGlancy::FileNameBuilder.new(@test_root)
+
+    blessing_copy_string = "cp #{fnb.current} #{fnb.master}"
 
     current_data = array_of_elements_small << single_element_hash
-    @dom_glancy.stubs(:perform_mapping_operation).returns(current_data)
+    ::DomGlancy::PageMapper.any_instance.stubs(:map_page).returns(current_data)
     mapping_results = @dom_glancy.page_map_same?(@test_root)
 
     refute mapping_results[0], 'page same results should be false'
@@ -51,14 +56,14 @@ class DomGlancyTest < DomGlancyTestCase
     assert_match 'Elements not in current: 0', mapping_results[1], 'error message contents'
     assert_match 'Changed elements: 0',        mapping_results[1], 'error message contents'
 
-    assert_match "current: #{DomGlancy::DomGlancy.current_filename(@test_root)}", mapping_results[1], 'error message contents'
-    assert_match "master: #{DomGlancy::DomGlancy.master_filename(@test_root)}",   mapping_results[1], 'error message contents'
-    assert_match "difference: #{DomGlancy::DomGlancy.diff_filename(@test_root)}", mapping_results[1], 'error message contents'
+    assert_match "current: #{fnb.current}", mapping_results[1], 'error message contents'
+    assert_match "master: #{fnb.master}",   mapping_results[1], 'error message contents'
+    assert_match "difference: #{fnb.diff}", mapping_results[1], 'error message contents'
 
     assert_match blessing_copy_string, mapping_results[1], 'blessing copy string should be in the error message'
 
     files_in_diff_location = Dir[File.join(DomGlancy.configuration.diff_file_location, '*')]
-    assert_equal 4, files_in_diff_location.count, 'the number of files in the diff location after a failure.'
+    assert_equal 5, files_in_diff_location.count, 'the number of files in the diff location after a failure.'
 
     `#{blessing_copy_string}`
 
@@ -70,7 +75,7 @@ class DomGlancyTest < DomGlancyTestCase
   end
 
   def make_master_test_file(test_root, data)
-    filename = DomGlancy::DomGlancy.master_filename(test_root)
+    filename = DomGlancy::FileNameBuilder.new(test_root).master
     yaml_data = data.to_yaml
     File.open(filename, 'w') { |file| file.write(yaml_data) }
   end

data/test/unit/element_test.rb

@@ -21,6 +21,27 @@ class ElementTest < DomGlancyTestCase
     refute element1.same_element?(element2)
   end
 
+  def test_sameness_and_similarity__no_id
+    element_1 = DomGlancy::DOMElement.new({"id"=>"", "height"=>10, "visible"=>true, "tag"=>"SPAN", "width"=>50, "class"=>"", "left"=>71, "top"=>86, 'similarity' => DomGlancy.configuration.similarity})
+    element_2 = DomGlancy::DOMElement.new({"id"=>"", "height"=>12, "visible"=>true, "tag"=>"SPAN", "width"=>52, "class"=>"", "left"=>72, "top"=>82, 'similarity' => DomGlancy.configuration.similarity})
+    element_3 = DomGlancy::DOMElement.new({"id"=>"", "height"=>13, "visible"=>true, "tag"=>"SPAN", "width"=>54, "class"=>"", "left"=>72, "top"=>82, 'similarity' => DomGlancy.configuration.similarity})
+    element_4 = DomGlancy::DOMElement.new({"id"=>"", "height"=>14, "visible"=>true, "tag"=>"SPAN", "width"=>56, "class"=>"", "left"=>72, "top"=>82, 'similarity' => DomGlancy.configuration.similarity})
+    element_5 = DomGlancy::DOMElement.new({"id"=>"", "height"=>115, "visible"=>true, "tag"=>"SPAN", "width"=>58, "class"=>"", "left"=>72, "top"=>82, 'similarity' => DomGlancy.configuration.similarity})
+    element_6 = DomGlancy::DOMElement.new({"id"=>"", "height"=>16, "visible"=>true, "tag"=>"SPAN", "width"=>142, "class"=>"", "left"=>72, "top"=>82, 'similarity' => DomGlancy.configuration.similarity})
+
+    assert element_1.same_element?(element_2)
+    assert element_1.same_element?(element_3)
+    assert element_1.same_element?(element_4)
+    assert element_1.same_element?(element_5)
+    assert element_1.same_element?(element_6)
+
+    assert element_1.close_enough?(element_2)
+    assert element_1.close_enough?(element_3)
+    assert element_1.close_enough?(element_4)
+    refute element_1.close_enough?(element_5)
+    refute element_1.close_enough?(element_6)
+  end
+
   def test_similarity
     element1 = DomGlancy::DOMElement.new(single_element_hash.merge({'similarity' => 2}))
     element2 = DomGlancy::DOMElement.new(single_element_hash.merge({'left' => 72}))
@@ -39,6 +60,41 @@ class ElementTest < DomGlancyTestCase
     assert element1.close_enough?(element3), 'should not be close enough'
   end
 
+  def test_similarity_level
+    element1 = DomGlancy::DOMElement.new(single_element_hash.merge({'similarity' => 2}))
+    element2 = element1.dup
+
+    element2.left = element2.left.to_i + 1
+
+    assert_equal 1, element1.similarity_level(element2), 'similarity level of 1'
+
+    element2.top += 1
+    assert_equal 1, element1.similarity_level(element2), 'similarity level of 1, still'
+
+    element2.width += 1
+    assert_equal 2, element1.similarity_level(element2), 'similarity level of 2'
+  end
+
+  def test_change_level
+    element1 = DomGlancy::DOMElement.new(single_element_hash.merge({'similarity' => 2}))
+    element2 = element1.dup
+
+    element2.top = element2.top.to_i + 1
+    refute element1.all_same?(element2),     'not exactly the same'
+    assert element1.close_enough?(element2), 'should be within similarity'
+
+    element2.top += 2
+    refute element1.close_enough?(element2)
+
+    assert_equal 1, element1.change_level(element2), 'change level with one change'
+
+    element2.width += 1
+    assert_equal 1, element1.change_level(element2), 'change level with one change and one similar'
+
+    element2.width += 10
+    assert_equal 2, element1.change_level(element2), 'change level with one change and one similar'
+  end
+
   def test_changed_element__width
     element1 = DomGlancy::DOMElement.new(array_of_elements.last)
     element2 = DomGlancy::DOMElement.new(array_of_elements.last.merge("width" => 20))