dom_glancy 1.0.1 → 1.1.0

data/test/unit/file_name_builder_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+
+class FileNameBuilderTest < DomGlancyTestCase
+  def setup
+    locations_root = '/path/to/dom_glancy/files/'
+
+    DomGlancy.configure do |config|
+      config.master_file_location  = File.join(locations_root, 'masters')
+      config.current_file_location = File.join(locations_root, 'current')
+      config.diff_file_location    = File.join(locations_root, 'diff')
+    end
+  end
+
+  def test_filenames
+    fnb = DomGlancy::FileNameBuilder.new('test_of_the_year')
+    assert_equal '/path/to/dom_glancy/files/masters/test_of_the_year_master.yaml', fnb.master
+    assert_equal '/path/to/dom_glancy/files/current/test_of_the_year.yaml',        fnb.current
+    assert_equal '/path/to/dom_glancy/files/diff/test_of_the_year_diff.html',      fnb.diff
+  end
+
+  def test_filenames__no_test_root
+    fnb = DomGlancy::FileNameBuilder.new
+
+    assert_equal '/path/to/dom_glancy/files/masters/_master.yaml', fnb.master
+    assert_equal '/path/to/dom_glancy/files/current/.yaml', fnb.current
+    assert_equal '/path/to/dom_glancy/files/diff/_diff.html', fnb.diff
+  end
+end

data/test/unit/map_file_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+
+class MapFileTest < DomGlancyTestCase
+  require 'json'
+
+  def setup
+    prep_locations_for_test
+
+    @test_root = 'alberto_moreno'
+    @map_file  = DomGlancy::MapFile.new
+    @fnb       = DomGlancy::FileNameBuilder.new(@test_root)
+    @filename = @fnb.master
+  end
+
+  def teardown
+    delete_test_locations
+  end
+
+  def test_read__no_file
+    results = @map_file.read(@filename)
+
+    refute results[0]
+    assert_match 'Error reading data from file', results[1]
+    assert_match @filename, results[1]
+    assert_nil results[2]
+  end
+
+  def test_read
+    raw_data = array_of_elements_small
+    File.open(@filename, 'w') { |file| file.write(raw_data.to_json) }
+
+    results = @map_file.read(@filename)
+
+    assert results[0]
+    assert_equal '', results[1]
+    assert_equal 2,  results[2].count
+
+    assert_equal '12',   results[2][0]['id']
+    assert_equal 238,    results[2][0]['height']
+    assert_equal true,   results[2][0]['visible']
+    assert_equal 'DIV',  results[2][0]['tag']
+    assert_equal 720,    results[2][0]['width']
+    assert_equal 'grid', results[2][0]['class']
+    assert_equal 43,     results[2][0]['left']
+    assert_equal 14,     results[2][0]['top']
+  end
+end

data/test/unit/page_mapper_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+
+class PageMapperTest < DomGlancyTestCase
+
+  def setup
+    prep_locations_for_test
+  end
+
+  def teardown
+    delete_test_locations
+  end
+
+  def test_file_mapper_run
+    test_name = 'gram_parsons'
+
+    file_mapper = DomGlancy::PageMapper.new
+    file_mapper.stubs(:map_page).returns(mapping_json)
+    result = file_mapper.run(test_name)
+
+    assert result[0], 'Mapping result should be true to indicate successful mapping'
+    assert_equal '', result[1], 'empty string error message from a successful mapping'
+
+    files_in_current_dir = Dir[File.join(DomGlancy.configuration.current_file_location, '*')]
+    assert_equal 1, files_in_current_dir.count
+    assert_equal files_in_current_dir.first, File.join(DomGlancy.configuration.current_file_location, "#{test_name}.yaml")
+  end
+end

data/test/unit/svg_test.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+
+class SVGTest < DomGlancyTestCase
+  def test_same_elements
+    set_current_not_master = array_of_elements[0..3].to_set
+    set_master_not_current = array_of_elements[8..9].to_set
+    set_changed_master     = Set.new
+
+    assert_equal 4, set_current_not_master.length
+    assert_equal 2, set_master_not_current.length
+
+    svg = DomGlancy::SVG.new(set_current_not_master, set_master_not_current, set_changed_master)
+    rectangles = svg.send(:make_rectangles)
+
+    assert_equal 6, rectangles.length
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dom_glancy
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - geordie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-10 00:00:00.000000000 Z
+date: 2015-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,12 +87,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- app/assets/javascripts/application.js
-- app/assets/stylesheets/1236_grid.css
-- app/assets/stylesheets/720_grid.css
-- app/assets/stylesheets/986_grid.css
-- app/assets/stylesheets/dom_glancy.css
-- app/assets/stylesheets/normalize.css
 - app/controllers/dom_glancy_application_controller.rb
 - app/controllers/dom_glancy_controller.rb
 - app/views/dom_glancy/about.html.erb
@@ -106,13 +100,23 @@ files:
 - app/views/shared/_dom_set.html.erb
 - config/routes.rb
 - dom_glancy.gemspec
+- lib/assets/javascripts/dom_glancy/dom_glancy.js
+- lib/assets/stylesheets/dom_glancy/1236_grid.css
+- lib/assets/stylesheets/dom_glancy/720_grid.css
+- lib/assets/stylesheets/dom_glancy/986_grid.css
+- lib/assets/stylesheets/dom_glancy/dom_glancy.css
+- lib/assets/stylesheets/dom_glancy/normalize.css
 - lib/dom_glancy.rb
-- lib/dom_glancy/analysis.rb
+- lib/dom_glancy/analysis_reporter.rb
+- lib/dom_glancy/analyzer.rb
+- lib/dom_glancy/change_anlyzer.rb
 - lib/dom_glancy/configuration.rb
 - lib/dom_glancy/dom_glancy.rb
 - lib/dom_glancy/element.rb
 - lib/dom_glancy/engine.rb
-- lib/dom_glancy/locations.rb
+- lib/dom_glancy/file_name_builder.rb
+- lib/dom_glancy/map_file.rb
+- lib/dom_glancy/page_mapper.rb
 - lib/dom_glancy/svg.rb
 - lib/dom_glancy/version.rb
 - test/page_objects.rb
@@ -143,12 +147,21 @@ files:
 - test/test_app/config/routes.rb
 - test/test_app/script/rails
 - test/test_helper.rb
+- test/test_helpers/artifacts_helpers.rb
 - test/test_helpers/location_helpers.rb
+- test/test_objects/options_file_1.yaml
+- test/test_objects/options_file_2.yaml
 - test/test_objects/test_objects.rb
-- test/unit/analysis_test.rb
+- test/unit/analysis_reporter_test.rb
+- test/unit/analyzer_test.rb
+- test/unit/change_analyzer_test.rb
 - test/unit/dom_glancy_test.rb
 - test/unit/element_test.rb
+- test/unit/file_name_builder_test.rb
 - test/unit/location_test.rb
+- test/unit/map_file_test.rb
+- test/unit/page_mapper_test.rb
+- test/unit/svg_test.rb
 - watchr_script.rb
 homepage: https://github.com/QuantumGeordie/dom_glancy
 licenses:
@@ -170,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Map the page DOM and get some stats on it compared to a known default map.
@@ -203,9 +216,18 @@ test_files:
 - test/test_app/config/routes.rb
 - test/test_app/script/rails
 - test/test_helper.rb
+- test/test_helpers/artifacts_helpers.rb
 - test/test_helpers/location_helpers.rb
+- test/test_objects/options_file_1.yaml
+- test/test_objects/options_file_2.yaml
 - test/test_objects/test_objects.rb
-- test/unit/analysis_test.rb
+- test/unit/analysis_reporter_test.rb
+- test/unit/analyzer_test.rb
+- test/unit/change_analyzer_test.rb
 - test/unit/dom_glancy_test.rb
 - test/unit/element_test.rb
+- test/unit/file_name_builder_test.rb
 - test/unit/location_test.rb
+- test/unit/map_file_test.rb
+- test/unit/page_mapper_test.rb
+- test/unit/svg_test.rb

data/app/assets/javascripts/application.js

@@ -1,7 +0,0 @@
-function checkByParent(aId, aChecked) {
-    var collection = document.getElementById(aId).getElementsByTagName('INPUT');
-    for (var x=0; x<collection.length; x++) {
-        if (collection[x].type.toUpperCase()=='CHECKBOX')
-            collection[x].checked = aChecked;
-    }
-}

data/lib/dom_glancy/analysis.rb

@@ -1,146 +0,0 @@
-module DomGlancy
-  class DomGlancy
-    def analyze(master_data, current_data, test_root = nil)
-      output_hash = {}
-
-      master_set  = master_data.to_set
-      current_set = current_data.to_set
-
-      set_current_not_master = current_set - master_set
-      set_master_not_current = master_set  - current_set
-      set_changed_master = Set.new
-
-      changed_element_pairs = []
-      if set_master_not_current.count > 0 || set_current_not_master.count > 0
-
-        ok_pairs = pairs_that_are_close_enough(set_current_not_master, set_master_not_current)
-
-        ok_pairs.each do |item1, item2|
-          set_current_not_master.delete(item1)
-          set_master_not_current.delete(item2)
-        end
-
-        changed_element_pairs = get_set_of_same_but_different(set_current_not_master, set_master_not_current)
-
-        changed_element_pairs.each do |item1, item2|
-          set_current_not_master.delete(item1)
-          set_current_not_master.delete(item2)
-
-          set_master_not_current.delete(item1)
-          set_master_not_current.delete(item2)
-        end
-
-        changed_element_pairs.select!{ |pair| !DOMElement.new(add_similarity(pair[0])).close_enough?(DOMElement.new(add_similarity(pair[1]))) }
-        changed_element_pairs.each do |pair|
-          set_changed_master.add(pair.first)
-        end
-      end
-
-      all_same = set_current_not_master.count == 0 && set_master_not_current.count == 0 && changed_element_pairs.count == 0
-
-      create_diff_file(set_current_not_master, set_master_not_current, set_changed_master, test_root) if test_root && !all_same
-
-      output_hash[:not_in_master]  = set_current_not_master
-      output_hash[:not_in_current] = set_master_not_current
-      output_hash[:changed_element_pairs] = changed_element_pairs
-      output_hash[:same] = all_same
-      output_hash[:test_root] = test_root
-      output_hash
-    end
-
-    def make_svg(set_master_not_current, set_current_not_master, set_changed_master)
-      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
-
-      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!
-
-      generate_svg(rectangles)
-    end
-
-    def create_diff_file(set_current_not_master, set_master_not_current, set_changed_master, test_root)
-      filename = DomGlancy.diff_filename(test_root)
-      svg = make_svg(set_current_not_master, set_master_not_current, set_changed_master)
-      File.open(filename, 'w') { |file| file.write(svg) }
-      save_set_info(test_root, 'current_not_master', set_current_not_master)
-      save_set_info(test_root, 'master_not_current', set_master_not_current)
-      save_set_info(test_root, 'changed_master', set_changed_master)
-    end
-
-    def save_set_info(test_root, suffix, data_set)
-      filename = File.join(::DomGlancy.configuration.diff_file_location, "#{test_root}__#{suffix}__diff.yaml")
-
-      data_array = data_set.to_a
-
-      File.open(filename, 'w') { |file| file.write(data_array.to_yaml) }
-    end
-
-    def get_set_of_same_but_different(set1, set2)
-      same_but_different_pairs = []
-      set1.each do |item1|
-        element1 = DOMElement.new(item1)
-        set2.each do |item2|
-          element2 = DOMElement.new(item2)
-          if element1.same_element?(element2)
-            same_but_different_pairs << [item1, item2]
-          end
-        end
-      end
-      same_but_different_pairs
-    end
-
-    def pairs_that_are_close_enough(set1, set2)
-      ok_pairs = []
-      set1.each do |item1|
-        element1 = DOMElement.new(add_similarity(item1))
-        set2.each do |item2|
-          element2 = DOMElement.new(add_similarity(item2))
-          if element1.same_element?(element2) && element1.close_enough?(element2)
-            ok_pairs << [item1, item2]
-          end
-        end
-      end
-      ok_pairs
-    end
-
-    def make_analysis_failure_report(analysis_data)
-      return '' if analysis_data[:same]
-
-      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: #{DomGlancy.current_filename(analysis_data[:test_root])}"
-      msg << "\tmaster: #{DomGlancy.master_filename(analysis_data[:test_root])}"
-      msg << "\tdifference: #{DomGlancy.diff_filename(analysis_data[:test_root])}"
-      msg << "Bless this current data set:"
-      msg << "\t#{blessing_copy_string(analysis_data[:test_root])}"
-      msg<< "-------------------------------------"
-
-      msg.join("\n")
-    end
-
-    def add_similarity(element)
-      element.merge(:similarity => ::DomGlancy.configuration.similarity)
-    end
-
-
-    def blessing_copy_string(test_root)
-      "cp #{DomGlancy.current_filename(test_root)} #{DomGlancy.master_filename(test_root)}"
-    end
-  end
-end

data/lib/dom_glancy/locations.rb

@@ -1,16 +0,0 @@
-module DomGlancy
-  class DomGlancy
-
-    def self.master_filename(test_root)
-      File.join(::DomGlancy.configuration.master_file_location, "#{test_root}_master.yaml")
-    end
-
-    def self.current_filename(test_root)
-      File.join(::DomGlancy.configuration.current_file_location, "#{test_root}.yaml")
-    end
-
-    def self.diff_filename(test_root)
-      File.join(::DomGlancy.configuration.diff_file_location, "#{test_root}_diff.html")
-    end
-  end
-end

data/test/unit/analysis_test.rb

@@ -1,110 +0,0 @@
-require 'test_helper'
-
-class AnalysisTest < DomGlancyTestCase
-
-  def test_same_elements
-    master_data = array_of_elements
-    current_data = array_of_elements
-
-    analysis = @dom_glancy.analyze(master_data, current_data)
-
-    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 = @dom_glancy.analyze(master_data, current_data)
-
-    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 = @dom_glancy.analyze(master_data, current_data)
-
-    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 = @dom_glancy.analyze(master_data, current_data)
-
-    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'
-    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 = @dom_glancy.analyze(master_data, current_data)
-
-    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 = @dom_glancy.analyze(master_data, current_data)
-
-    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 = @dom_glancy.analyze(master_data, current_data)
-    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 = @dom_glancy.analyze(master_data, current_data)
-
-    ## 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
-
-end