dom_glancy 0.1.0 → 1.0.0

data/lib/dom_glancy/dom_glancy.rb

@@ -1,121 +1,135 @@
 module DomGlancy
-  require 'yaml'
+  class DomGlancy
+    def page_map_same?(test_root)
+      purge_old_files_before_test(test_root)
 
-  def page_map_same?(test_root)
-    purge_old_files_before_test(test_root)
+      result, msg = map_current_file(test_root)
+      return [result, msg]  unless result
 
-    result, msg = map_current_file(test_root)
-    return [result, msg]  unless result
+      result, msg = master_file_exists?(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))
+      return [result, msg]  unless result
 
-    result, msg, current_data = read_map_file(DomGlancy.current_filename(test_root))
-    return [result, msg]  unless result
+      result, msg, master_data = read_map_file(DomGlancy.master_filename(test_root))
+      return [result, msg]  unless result
 
-    result, msg, master_data = read_map_file(DomGlancy.master_filename(test_root))
-    return [result, msg]  unless result
+      analysis_data = analyze(master_data, current_data, test_root)
 
-    analysis_data = analyze(master_data, current_data, test_root)
+      msg = make_analysis_failure_report(analysis_data)
+      result = analysis_data[:same]
 
-    msg = make_analysis_failure_report(analysis_data)
-    result = analysis_data[:same]
+      File.delete DomGlancy.current_filename(test_root) if result
 
-    File.delete DomGlancy.current_filename(test_root) if result
+      [result, msg]
+    end
 
-    [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]
+    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]
+      end
+
+      results
     end
 
-    results
-  end
+    def map_current_file(test_root)
+      filename = DomGlancy.current_filename(test_root)
 
-  def map_current_file(test_root)
-    filename = DomGlancy.current_filename(test_root)
+      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
 
-    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}"]
+      result
     end
 
-    result
-  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
 
-  def perform_mapping_operation
-
-    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,
-                          //"html"    : cn.innerHTML,
-                            "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
-
-    page.driver.browser.execute_script(js)
-  end
+      Capybara.current_session.driver.browser.manage.window.resize_to(original_dimensions.width + width, original_dimensions.height) if width > 0
 
-  def master_file_exists?(test_root)
-    filename = DomGlancy.master_filename(test_root)
-    result = File.exist?(filename)
-    msg = result ? '' : make_missing_master_failure_report(test_root)
-    [result, msg]
-  end
+      result = yield
 
-  def make_missing_master_failure_report(test_root)
-    msg = ["\n------- DOM Comparison Failure ------"]
-    msg << "Master file does not exist. To make a new master from"
-    msg << "the current page, use this command:"
-    msg << "\t#{blessing_copy_string(test_root)}"
-    msg<< "-------------------------------------"
+      Capybara.current_session.driver.browser.manage.window.resize_to(original_dimensions.width, original_dimensions.height) if width > 0
 
-    msg.join("\n")
-  end
+      result
+    end
 
-  def purge_old_files_before_test(test_root)
-    File.delete DomGlancy.current_filename(test_root) if File.exist?(DomGlancy.current_filename(test_root))
+    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
+    end
+
+    def master_file_exists?(test_root)
+      filename = DomGlancy.master_filename(test_root)
+      result = File.exist?(filename)
+      msg = result ? '' : make_missing_master_failure_report(test_root)
+      [result, msg]
+    end
+
+    def make_missing_master_failure_report(test_root)
+      msg = ["\n------- DOM Comparison Failure ------"]
+      msg << "Master file does not exist. To make a new master from"
+      msg << "the current page, use this command:"
+      msg << "\t#{blessing_copy_string(test_root)}"
+      msg<< "-------------------------------------"
 
-    filename_pattern = File.join(DomGlancy.diff_file_location, "#{test_root}__*__diff.yaml")
-    Dir[filename_pattern].each { |file| file.delete(file) if File.exist?(file) }
+      msg.join("\n")
+    end
+
+    def purge_old_files_before_test(test_root)
+      File.delete DomGlancy.current_filename(test_root) if File.exist?(DomGlancy.current_filename(test_root))
+
+      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) }
+    end
   end
 end

data/lib/dom_glancy/engine.rb

@@ -0,0 +1,4 @@
+module DomGlancy
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/dom_glancy/locations.rb

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

data/lib/dom_glancy/svg.rb

@@ -1,71 +1,73 @@
 module DomGlancy
+  class DomGlancy
+    def generate_svg(rectangles)
+      width, height = get_window_size_from_rectangles(rectangles)
+      s = svg_start(width, height)
 
-  def generate_svg(rectangles)
-    width, height = get_window_size_from_rectangles(rectangles)
-    s = svg_start(width, height)
+      rectangles.each do |rectangle|
+        rectangle_string = "      <rect id='#{rectangle[:js_id]}' x = '#{rectangle['left']}' y = '#{rectangle['top']}' width = '#{rectangle['width']}' height = '#{rectangle['height']}' fill = '#{rectangle[:fill]}' stroke = '#{rectangle[:stroke]}' stroke-width = '#{rectangle[:stroke_width]}' fill-opacity = '#{rectangle[:opacity]}' />\n"
+        s += rectangle_string
+      end
 
-    rectangles.each do |rectangle|
-      rectangle_string = "      <rect id='#{rectangle[:js_id]}' x = '#{rectangle['left']}' y = '#{rectangle['top']}' width = '#{rectangle['width']}' height = '#{rectangle['height']}' fill = '#{rectangle[:fill]}' stroke = '#{rectangle[:stroke]}' stroke-width = '#{rectangle[:stroke_width]}' fill-opacity = '#{rectangle[:opacity]}' />\n"
-      s += rectangle_string
+      s += svg_end
+      s += "\n"
     end
 
-    s += svg_end
-    s += "\n"
-  end
+    def get_window_size_from_rectangles(rectangles)
+      width = 0
+      height = 0
 
-  def get_window_size_from_rectangles(rectangles)
-    width = 0
-    height = 0
+      rectangles.each do |rectangle|
+        rectangle_right  = rectangle['left'].to_i + rectangle['width'].to_i
+        rectangle_bottom = rectangle['top'].to_i + rectangle['height'].to_i
+        width  = rectangle_right if rectangle_right > width
+        height = rectangle_bottom if rectangle_bottom > height
+      end
 
-    rectangles.each do |rectangle|
-      rectangle_right  = rectangle['left'].to_i + rectangle['width'].to_i
-      rectangle_bottom = rectangle['top'].to_i + rectangle['height'].to_i
-      width  = rectangle_right if rectangle_right > width
-      height = rectangle_bottom if rectangle_bottom > height
+      [width, height]
     end
 
-    [width, height]
-  end
-
-  def svg_start(width, height)
-    s = ["<?xml version='1.0' standalone='no'?>"]
-    s << "  <!DOCTYPE svg PUBLIC '-//W3C//DTD SVG 1.1//EN' 'http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd'>"
-    s << "  <svg version = '1.1' width='#{width}px' height='#{height}px' border='2px' style='background-color:#FFFFFF;border:1px solid black;'>"
-    s << ''
+    def svg_start(width, height)
+      s = ["<?xml version='1.0' standalone='no'?>"]
+      s << "  <!DOCTYPE svg PUBLIC '-//W3C//DTD SVG 1.1//EN' 'http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd'>"
+      s << "  <svg version = '1.1' width='#{width}px' height='#{height}px' border='2px' style='background-color:#FFFFFF;border:1px solid black;'>"
+      s << ''
 
-    s.join("\n")
-  end
+      s.join("\n")
+    end
 
-  def svg_end
-    s = ['  </svg>']
-    s << ''
+    def svg_end
+      s = ['  </svg>']
+      s << ''
 
-    s.join("\n")
-  end
+      s.join("\n")
+    end
 
-  def format__not_in_master
-    {
+    def format__not_in_master
+      {
         :stroke       => 'blue',
         :fill         => 'white',
         :stroke_width => '1',
         :opacity      => '0.5'
-    }
-  end
+      }
+    end
 
-  def format__not_in_current
-    {
+    def format__not_in_current
+      {
         :stroke       => 'red',
         :fill         => 'white',
         :stroke_width => '1',
         :opacity      => '0.5'
-    }
-  end
-  def format__same_but_different
-    {
+      }
+    end
+
+    def format__same_but_different
+      {
         :stroke       => 'orange',
         :fill         => 'white',
         :stroke_width => '1',
         :opacity      => '0.5'
-    }
+      }
+    end
   end
 end

data/lib/dom_glancy/version.rb

@@ -1,3 +1,3 @@
 module DomGlancy
-  VERSION = '0.1.0'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/lib/dom_glancy.rb

@@ -1,7 +1,11 @@
-require 'dom_glancy/rails/engine' if defined?(Rails)
+require 'kramdown'
+require 'capybara'
+
+require 'dom_glancy/engine' if defined?(Rails)
 require 'dom_glancy/dom_glancy'
 require 'dom_glancy/version'
 require 'dom_glancy/element'
 require 'dom_glancy/analysis'
 require 'dom_glancy/locations'
 require 'dom_glancy/svg'
+require 'dom_glancy/configuration'

data/test/selenium/mapping_test.rb

@@ -1,13 +1,13 @@
 require 'selenium_test_helper'
 
-class MappingTest < DomGlancy::SeleniumTestCase
+class MappingTest < SeleniumTestCase
 
   def test_full_mapping__same
     visit_index
 
     map_current_page_and_save_as_master('dom_glancy_index')
 
-    same, msg = page_map_same?('dom_glancy_index')
+    same, msg = @dom_glancy.page_map_same?('dom_glancy_index')
 
     assert same, msg
     assert_artifacts_on_same('dom_glancy_index')
@@ -15,7 +15,7 @@ class MappingTest < DomGlancy::SeleniumTestCase
 
   def test_mapping__no_master
     visit_index
-    same, msg = page_map_same?('poop')
+    same, msg = @dom_glancy.page_map_same?('poop')
     refute same, msg
     assert_match 'Master file does not exist', msg, 'the missing master error message'
   end
@@ -27,14 +27,14 @@ class MappingTest < DomGlancy::SeleniumTestCase
 
     add_centered_element('Back In Black')
 
-    same, msg = page_map_same?('dom_glancy_index')
+    same, msg = @dom_glancy.page_map_same?('dom_glancy_index')
 
     refute same, msg
 
     index_page = visit_index
 
     assert_equal 1, index_page.files.count, 'number of difference files'
-    assert_match 'dom_glancy_index_diff.html', index_page.files.first.text, 'file name displayed'
+    assert_match 'dom_glancy_index', index_page.files.first.text, 'file name displayed'
 
     index_page.files.first.find('a').click
     show_page = PageObjects::DomGlancy::ShowPage.new
@@ -56,21 +56,21 @@ class MappingTest < DomGlancy::SeleniumTestCase
 
     remove_about_element
 
-    same, msg = page_map_same?('dom_glancy_index')
+    same, msg = @dom_glancy.page_map_same?('dom_glancy_index')
 
     refute same, msg
 
     index_page = visit_index
 
     assert_equal 1, index_page.files.count, 'number of difference files'
-    assert_match 'dom_glancy_index_diff.html', index_page.files.first.text, 'file name displayed'
+    assert_match 'dom_glancy_index', index_page.files.first.text, 'file name displayed'
 
     index_page.files.first.find('a').click
     show_page = PageObjects::DomGlancy::ShowPage.new
 
-    assert_equal 0, show_page.not_master.count, 'elements listed as not in master'
-    assert_equal 7, show_page.not_current.count, 'elements listed as not in current'
-    assert_equal 5, show_page.changed.count, 'elements listed as changed'
+    assert_equal 0,  show_page.not_master.count,  'elements listed as not in master'
+    assert_equal 7,  show_page.not_current.count, 'elements listed as not in current'
+    assert_equal 11, show_page.changed.count,     'elements listed as changed'
 
     assert_artifacts_on_difference('dom_glancy_index')
 
@@ -83,7 +83,7 @@ class MappingTest < DomGlancy::SeleniumTestCase
 
     map_current_page_and_save_as_master('test_page')
 
-    same, msg = page_map_same?('test_page')
+    same, msg = @dom_glancy.page_map_same?('test_page')
 
     assert same, msg
 
@@ -101,7 +101,7 @@ class MappingTest < DomGlancy::SeleniumTestCase
 
     resize_browser(w, h)
 
-    same, msg = page_map_same?('test_page')
+    same, msg = @dom_glancy.page_map_same?('test_page')
 
     refute same, msg
 
@@ -111,8 +111,8 @@ class MappingTest < DomGlancy::SeleniumTestCase
   private
 
   def map_current_page_and_save_as_master(test_root)
-    map_data = perform_mapping_operation
-    File.open(DomGlancy.master_filename(test_root), 'w') { |file| file.write(map_data.to_yaml) }
+    map_data = @dom_glancy.perform_mapping_operation
+    File.open(DomGlancy::DomGlancy.master_filename(test_root), 'w') { |file| file.write(map_data.to_yaml) }
   end
 
 end

data/test/selenium/viewer_test.rb

@@ -1,26 +1,21 @@
 require 'selenium_test_helper'
 
-class ViewerTest < DomGlancy::SeleniumTestCase
+class ViewerTest < SeleniumTestCase
 
   def test_navigation
     index_page = visit_index
     config_page = index_page.navigation.config!
 
-    assert_equal DomGlancy.master_file_location.to_s, config_page.master, 'master file location'
-    assert_equal DomGlancy.current_file_location.to_s, config_page.current, 'current file location'
-    assert_equal DomGlancy.diff_file_location.to_s, config_page.diffs, 'difference file location'
+    assert_equal DomGlancy.configuration.master_file_location.to_s, config_page.master, 'master file location'
+    assert_equal DomGlancy.configuration.current_file_location.to_s, config_page.current, 'current file location'
+    assert_equal DomGlancy.configuration.diff_file_location.to_s, config_page.diffs, 'difference file location'
 
     new_page = config_page.navigation.new_page!
     assert page.has_content?('do not have a corresponding master file in the expected file location'), 'new masters page content.'
 
-    # Don't have TeamCity integration right now.
-    # artifacts_page = new_page.navigation.artifacts!
-    # assert page.has_content?('TeamCity Artifacts'), 'artifacts page needs some content.'
-
     about_page = new_page.navigation.about!
     assert page.has_content?('Add this line to your'), 'about page line from README.md'
 
     index_page = about_page.navigation.home!
   end
-
 end