dom_glancy 0.1.0

data/app/views/shared/_dom_set.html.erb

@@ -0,0 +1,35 @@
+<div id="<%= finder_id %>">
+  <% if elements.length > 0 %>
+    <table class='kr--dom'>
+      <thead>
+        <tr>
+          <th>tag</th>
+          <th>id</th>
+          <th>class(s)</th>
+          <th>top</th>
+          <th>left</th>
+          <th>width</th>
+          <th>height</th>
+          <th>visible</th>
+        </tr>
+      </thead>
+      <tbody>
+        <% reset_cycle %>
+        <% elements.each do |element| %>
+          <tr onclick="highlightElement(<%= element[:js_id] %>);" class="<%= cycle("kr-dom_row_odd", "kr-dom_row_even") %>">
+            <td><%= element['tag'] %></td>
+            <td><%= element['id'] %></td>
+            <td><%= element['class'] %></td>
+            <td><%= element['top'] %></td>
+            <td><%= element['left'] %></td>
+            <td><%= element['width'] %></td>
+            <td><%= element['height'] %></td>
+            <td><%= element['visible'] %></td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  <% else %>
+    <p>no elements found.</p>
+  <% end %>
+</div>

data/config/routes.rb

@@ -0,0 +1,17 @@
+Rails.application.routes.draw do
+  get 'dom_glancy'                 => "dom_glancy#index"
+  get 'dom_glancy/config'          => "dom_glancy#path_config"
+  get 'dom_glancy/about'           => "dom_glancy#about"
+  get 'dom_glancy/show/:diff_file' => "dom_glancy#show"
+  get 'dom_glancy/clear'           => "dom_glancy#clear"
+  post 'dom_glancy/bless'          => "dom_glancy#bless"#, :via => [:get, :post]
+
+  get 'dom_glancy/artifacts'               => "dom_glancy#artifacts"
+  get 'dom_glancy/artifacts_delete/:file'  => "dom_glancy#artifacts_delete"
+  get 'dom_glancy/artifacts_expand/:file'  => "dom_glancy#artifacts_expand"
+
+  get 'dom_glancy/make_master/:file'    => "dom_glancy#make_master"
+  get 'dom_glancy/delete_current/:file' => "dom_glancy#delete_current"
+
+  resources :dom_glancy
+end

data/dom_glancy.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dom_glancy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dom_glancy"
+  spec.version       = DomGlancy::VERSION
+  spec.authors       = ["geordie"]
+  spec.email         = ["george.speake@gmail.com"]
+  spec.description   = %q{DOM Mapping}
+  spec.summary       = %q{Map the page DOM and get some stats on it compared to a known default map.}
+  spec.homepage      = "https://github.com/QuantumGeordie/dom_glancy"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency(%q<kramdown>, ["~> 1.1.0"])
+  spec.add_dependency 'capybara'
+end

data/lib/dom_glancy/analysis.rb

@@ -0,0 +1,141 @@
+module 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(pair[0]).close_enough?(DOMElement.new(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.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] #unless element1.close_enough?(element2)
+        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(item1)
+      set2.each do |item2|
+        element2 = DOMElement.new(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 blessing_copy_string(test_root)
+    "cp #{DomGlancy.current_filename(test_root)} #{DomGlancy.master_filename(test_root)}"
+  end
+
+end

data/lib/dom_glancy/dom_glancy.rb

@@ -0,0 +1,121 @@
+module DomGlancy
+  require 'yaml'
+
+  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 = 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, master_data = read_map_file(DomGlancy.master_filename(test_root))
+    return [result, msg]  unless result
+
+    analysis_data = analyze(master_data, current_data, test_root)
+
+    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]
+    end
+
+    results
+  end
+
+  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
+  end
+
+  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
+
+  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<< "-------------------------------------"
+
+    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.diff_file_location, "#{test_root}__*__diff.yaml")
+    Dir[filename_pattern].each { |file| file.delete(file) if File.exist?(file) }
+  end
+end

data/lib/dom_glancy/element.rb

@@ -0,0 +1,92 @@
+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}
+
+    attr_accessor :id
+    attr_accessor :tag
+    attr_accessor :left
+    attr_accessor :top
+    attr_accessor :height
+    attr_accessor :width
+    attr_accessor :klass
+    attr_accessor :visible
+    attr_accessor :style
+    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'] || 15
+    end
+
+    def same_element?(anOther)
+      same = same_tag?(anOther)   &&
+             same_id?(anOther)    &&
+             same_class?(anOther)
+    end
+
+    def all_same?(anOther)
+      same = same_element?(anOther)     &&
+          similar_size?(anOther, 0)     &&
+          similar_location?(anOther, 0) &&
+          same_size?(anOther) &&
+          same_visibility?(anOther)
+    end
+
+    def close_enough?(anOther)
+      r = same_element?(anOther)                  &&
+          similar_location?(anOther, @similarity) &&
+          similar_size?(anOther, @similarity)     &&
+          same_style?(anOther)                    &&
+          same_visibility?(anOther)
+    end
+
+    def similar_size?(anOther, similarity = 0)
+      similar = (@height - anOther.height).abs <= similarity
+      similar && (@width - anOther.width).abs <= similarity
+    end
+
+    def similar_location?(anOther, similarity = 0)
+      similar = (@top - anOther.top).abs <= similarity
+      similar && (@left - anOther.left).abs <= similarity
+    end
+
+    def same_tag?(anOther)
+      @tag == anOther.tag
+    end
+
+    def same_location?(anOther)
+      (@left == anOther.left) && (@top == anOther.top)
+    end
+
+    def same_size?(anOther)
+      (@height == anOther.height) && (@width == anOther.width)
+    end
+
+    def same_class?(anOther)
+      @klass == anOther.klass
+    end
+
+    def same_id?(anOther)
+      @id == anOther.id
+    end
+
+    def same_visibility?(anOther)
+      @visible == anOther.visible
+    end
+
+    def same_style?(anOther)
+      @style == anOther.style
+    end
+
+  end
+end

data/lib/dom_glancy/locations.rb

@@ -0,0 +1,49 @@
+module DomGlancy
+
+  @master_file_location  = nil
+  @diff_file_location    = nil
+  @current_file_location = nil
+
+  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_file_location
+    @current_file_location
+  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/rails/engine.rb

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

data/lib/dom_glancy/svg.rb

@@ -0,0 +1,71 @@
+module DomGlancy
+
+  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
+
+    s += svg_end
+    s += "\n"
+  end
+
+  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
+
+    [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 << ''
+
+    s.join("\n")
+  end
+
+  def svg_end
+    s = ['  </svg>']
+    s << ''
+
+    s.join("\n")
+  end
+
+  def format__not_in_master
+    {
+        :stroke       => 'blue',
+        :fill         => 'white',
+        :stroke_width => '1',
+        :opacity      => '0.5'
+    }
+  end
+
+  def format__not_in_current
+    {
+        :stroke       => 'red',
+        :fill         => 'white',
+        :stroke_width => '1',
+        :opacity      => '0.5'
+    }
+  end
+  def format__same_but_different
+    {
+        :stroke       => 'orange',
+        :fill         => 'white',
+        :stroke_width => '1',
+        :opacity      => '0.5'
+    }
+  end
+end

data/lib/dom_glancy/version.rb

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

data/lib/dom_glancy.rb

@@ -0,0 +1,7 @@
+require 'dom_glancy/rails/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'

data/test/page_objects/dom_glancy/about_page.rb

@@ -0,0 +1,7 @@
+module PageObjects
+  module DomGlancy
+    class AboutPage < ViewerPage
+      path '/dom_glancy/about'
+    end
+  end
+end

data/test/page_objects/dom_glancy/artifacts_page.rb

@@ -0,0 +1,7 @@
+module PageObjects
+  module DomGlancy
+    class ArtifactsPage < ViewerPage
+      path '/dom_glancy/artifacts'
+    end
+  end
+end

data/test/page_objects/dom_glancy/config_page.rb

@@ -0,0 +1,19 @@
+module PageObjects
+  module DomGlancy
+    class ConfigPage < ViewerPage
+      path '/dom_glancy/config'
+
+      def master
+        node.find("#js-config_master").text
+      end
+
+      def current
+        node.find("#js-config_current").text
+      end
+
+      def diffs
+        node.find("#js-config_diffs").text
+      end
+    end
+  end
+end

data/test/page_objects/dom_glancy/index_page.rb

@@ -0,0 +1,9 @@
+module PageObjects
+  module DomGlancy
+    class IndexPage < ViewerPage
+      path :dom_glancy
+
+      collection :files, :locator => '#kr--files', :item_locator => '.kr--file'
+    end
+  end
+end

data/test/page_objects/dom_glancy/local_index_page.rb

@@ -0,0 +1,7 @@
+module PageObjects
+  module DomGlancy
+    class LocalIndexPage < ::AePageObjects::Document
+      path '/local'
+    end
+  end
+end

data/test/page_objects/dom_glancy/new_page.rb

@@ -0,0 +1,7 @@
+module PageObjects
+  module DomGlancy
+    class NewPage < ViewerPage
+      path '/dom_glancy/new'
+    end
+  end
+end

data/test/page_objects/dom_glancy/show_page.rb

@@ -0,0 +1,15 @@
+module PageObjects
+  module DomGlancy
+    class ShowPage < ViewerPage
+
+      collection :not_master,  :locator => "#js--not_master",  :item_locator => 'table tbody tr'
+      collection :not_current, :locator => "#js--not_current", :item_locator => 'table tbody tr'
+      collection :changed,     :locator => "#js--changed",     :item_locator => 'table tbody tr'
+
+      def bless!
+        node.click_button 'Bless these differences'
+        IndexPage.new
+      end
+    end
+  end
+end

data/test/page_objects/dom_glancy/viewer_page.rb

@@ -0,0 +1,15 @@
+module PageObjects
+  module DomGlancy
+    class ViewerPage < ::AePageObjects::Document
+      element :navigation, :is => Navigation, :locator => "#js-kr--nav"
+
+      def revision
+        node.find("#js-kr--gem_rev").text
+      end
+
+    end
+  end
+end
+
+
+