dom_glancy 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4f6b85d8b3b3b443273ccd45b0d0ebc35ac1a49
-  data.tar.gz: 0e8ad79d21beace912bc8a6a656ca5a064045c83
+  metadata.gz: 3cd48c0ea852b13728e2f1248f6cb2232afc45ca
+  data.tar.gz: 564fd88c6ae4c6c780f832d14d202c326c1e6af4
 SHA512:
-  metadata.gz: 09c300f922d5983a387d2e5c68566b0e33c9596661b33f89c3c5ff4150b6975ca70e7a25554be56ddc21b935e78d45a2e0c4c79b4c3b0cf7bff6b7381695d018
-  data.tar.gz: 9f315183d832157878c0456682275ea7f059f211463179abfad71e28e065e7cea9169e09836e0a2f2ecec370aa520b6637a21a5931b74dc6047d70cf735b7efc
+  metadata.gz: d3b6b032528da837084dfad7e96af8f0e9557689ea2e7583cedfa86fecbf985d7f9e40045ab2af231015a60013ea8131391e9061a6f9835a1ba11679686fa8be
+  data.tar.gz: 8b81bfd4998db70ef47f013bbc59572c1c2c84b133db866ebde600b264dfd2ca3bbd617be5a39091f1ba480da41bfefbbb75ddc91d82c83498cda466a16f80e0

data/.travis.yml

@@ -1,9 +1,8 @@
 language: ruby
 rvm:
   - "1.9.3"
-  - "2.0.0"
-  - "2.1.0"
   - "2.1.2"
+  - "2.1.5"
 before_script:
   - export DISPLAY=:99.0
   - sh -e /etc/init.d/xvfb start
@@ -11,3 +10,5 @@ script:
   - bundle exec rake
 addons:
   firefox: "31.0"
+  code_climate:
+    repo_token: 83887755db231f4c094598500eb6044a9cc4cd0e3993fa5af7d705a6b64cfb2a

data/Gemfile

@@ -13,3 +13,7 @@ gem 'mocha'
 gem 'selenium-webdriver', '2.44.0'
 gem 'capybara', '2.2.1'
 gem 'ae_page_objects', '1.3.0'
+
+group :test do
+  gem 'codeclimate-test-reporter', require: nil
+end

data/README.md

@@ -8,6 +8,11 @@ _you know. like taking a quick glance at the DOM, but make it sound kinda like T
 
 [![Build Status](https://travis-ci.org/QuantumGeordie/dom_glancy.svg?branch=master)](https://travis-ci.org/QuantumGeordie/dom_glancy)
 
+## Code Climate
+
+[![Code Climate](https://codeclimate.com/github/QuantumGeordie/dom_glancy/badges/gpa.svg)](https://codeclimate.com/github/QuantumGeordie/dom_glancy)
+[![Test Coverage](https://codeclimate.com/github/QuantumGeordie/dom_glancy/badges/coverage.svg)](https://codeclimate.com/github/QuantumGeordie/dom_glancy)
+
 ## Installation
 
 Add this line to your application's Gemfile in the test and development groups:

data/app/controllers/dom_glancy_controller.rb

@@ -34,8 +34,9 @@ class DomGlancyController < DomGlancyApplicationController
 
   def make_master
     test_root = params[:file]
-    src = DomGlancy::DomGlancy.current_filename(test_root)
-    dst = DomGlancy::DomGlancy.master_filename(test_root)
+    fnb = DomGlancy::FileNameBuilder.new(test_root)
+    src = fnb.current
+    dst = fnb.master
     FileUtils.cp src, dst
 
     redirect_to '/dom_glancy/new'
@@ -43,7 +44,8 @@ class DomGlancyController < DomGlancyApplicationController
 
   def delete_current
     test_root = params[:file]
-    src = DomGlancy::DomGlancy.current_filename(test_root)
+    fnb = DomGlancy::FileNameBuilder.new(test_root)
+    src = fnb.current
     FileUtils.rm_rf src
 
     redirect_to '/dom_glancy/new'
@@ -74,12 +76,6 @@ class DomGlancyController < DomGlancyApplicationController
     redirect_to dom_glancy_path
   end
 
-  def about
-    about_file = File.expand_path('../../../README.md', __FILE__)
-    raw = File.read(about_file)
-    @about = Kramdown::Document.new(raw).to_html
-  end
-
   def clear
     Dir[File.join(DomGlancy.configuration.diff_file_location, '*.yaml'), File.join(DomGlancy.configuration.diff_file_location, '*.html')].each { |f| FileUtils.rm_rf(f) }
     Dir[File.join(DomGlancy.configuration.current_file_location, '*.yaml')].each { |f| FileUtils.rm_rf(f) }
@@ -92,14 +88,15 @@ class DomGlancyController < DomGlancyApplicationController
 
     blessings.each do |blessing|
       base_test_name = blessing
+      fnb = DomGlancy::FileNameBuilder.new(base_test_name)
 
-      src_yaml = DomGlancy::DomGlancy.current_filename(base_test_name)
-      dst_yaml = DomGlancy::DomGlancy.master_filename(base_test_name)
+      src_yaml = fnb.current
+      dst_yaml = fnb.master
 
       FileUtils.cp src_yaml, dst_yaml if File.exist?(src_yaml)
 
       if params['delete_on_bless'] == 'true'
-        files_to_remove  = [DomGlancy::DomGlancy.diff_filename(base_test_name)]
+        files_to_remove  = [fnb.diff]
         files_to_remove << File.join(DomGlancy.configuration.diff_file_location, blessing + '__current_not_master__diff.yaml')
         files_to_remove << File.join(DomGlancy.configuration.diff_file_location, blessing + '__master_not_current__diff.yaml')
         files_to_remove << File.join(DomGlancy.configuration.diff_file_location, blessing + '__changed_master__diff.yaml')

data/app/views/dom_glancy/about.html.erb

@@ -1,3 +1,3 @@
 <div class="row kr--about">
-  <%= @about.html_safe %>
-</div>
+  <p>Info about Dom Glancy can be found <a href="https://github.com/QuantumGeordie/dom_glancy" class="kr">here</a> and <a href="http://quantumgeordie.github.io/dom_glancy/" class="kr">here</a>. Check it out.</p>
+</div>

data/app/views/dom_glancy/path_config.html.erb

@@ -1,8 +1,10 @@
-<h2>Path Configuration</h2>
-<table class="kr">
-  <tbody>
-  <tr><th>master</th><td id="js-config_master"><%= DomGlancy.configuration.master_file_location %></td></tr>
-  <tr><th>current</th><td id="js-config_current"><%= DomGlancy.configuration.current_file_location %></td></tr>
-  <tr><th>diff</th><td id="js-config_diffs"><%= DomGlancy.configuration.diff_file_location %></td></tr>
-  </tbody>
-</table>
+<div class="kr--about">
+  <h2>Path Configuration</h2>
+  <table class="kr">
+    <tbody>
+    <tr><th>master</th><td id="js-config_master"><%= DomGlancy.configuration.master_file_location %></td></tr>
+    <tr><th>current</th><td id="js-config_current"><%= DomGlancy.configuration.current_file_location %></td></tr>
+    <tr><th>diff</th><td id="js-config_diffs"><%= DomGlancy.configuration.diff_file_location %></td></tr>
+    </tbody>
+  </table>
+</div>

data/app/views/dom_glancy/show.html.erb

@@ -11,32 +11,17 @@
       <%= raw(contents) %>
     </td>
     <td>
-      <h2>in current dom, not master</h2>
       <% elements = YAML::load_file(File.join(DomGlancy.configuration.diff_file_location, @file_set_not_master)) %>
+      <h2><span class="hideable" id="not_master_toggle">+</span> Not in Master [<%= elements.count %>]</h2>
       <%= render :partial => "shared/dom_set", :locals => {:elements => elements, :finder_id => 'js--not_master'} %>
 
-      <h2>in master dom, not current</h2>
       <% elements = YAML::load_file(File.join(DomGlancy.configuration.diff_file_location, @file_set_not_current)) %>
+      <h2><span class="hideable" id="not_current_toggle">+</span> Not in Current [<%= elements.count %>]</h2>
       <%= render :partial => "shared/dom_set", :locals => {:elements => elements, :finder_id => 'js--not_current'} %>
 
-      <h2>changed</h2>
       <% elements = YAML::load_file(File.join(DomGlancy.configuration.diff_file_location, @file_set_changed)) %>
+      <h2><span class="hideable" id="changed_toggle">+</span> Changed [<%= elements.count %>]</h2>
       <%= render :partial => "shared/dom_set", :locals => {:elements => elements, :finder_id => 'js--changed'} %>
-
     </td>
   </tr>
 </table>
-
-<script type="text/javascript">
-  highlightElement = function(element_id) {
-    var elements = document.getElementsByTagName('rect');
-    var element = null;
-    var length = elements.length;
-
-    for (var i = 0; i < length; i++) {
-      elements[i].setAttribute("stroke-width", "1");
-    }
-    var this_element = document.getElementById(element_id);
-    this_element.setAttribute("stroke-width", "5");
-  }
-</script>

data/app/views/layouts/dom_glancy.html.erb

@@ -3,30 +3,21 @@
 <head>
   <title>DOM Glancy</title>
   <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no"/>
-  <%= javascript_include_tag 'application'
-  %>
-  <%= stylesheet_link_tag 'normalize.css', :media => 'all' %>
-  <%= stylesheet_link_tag '720_grid.css',  :media => 'screen and (min-width: 720px)' %>
-  <%= stylesheet_link_tag '986_grid.css',  :media => 'screen and (min-width: 986px)' %>
-  <%= stylesheet_link_tag '1236_grid.css', :media => 'screen and (min-width: 1236px)' %>
-  <%= stylesheet_link_tag 'dom_glancy',    :media => 'all' %>
+  <%= stylesheet_link_tag 'dom_glancy/normalize.css', :media => 'all' %>
+  <%= stylesheet_link_tag 'dom_glancy/720_grid.css',  :media => 'screen and (min-width: 720px)' %>
+  <%= stylesheet_link_tag 'dom_glancy/986_grid.css',  :media => 'screen and (min-width: 986px)' %>
+  <%= stylesheet_link_tag 'dom_glancy/1236_grid.css', :media => 'screen and (min-width: 1236px)' %>
+  <%= stylesheet_link_tag 'dom_glancy/dom_glancy',    :media => 'all' %>
 
   <%= csrf_meta_tags %>
 </head>
 <body>
-  <div class="grid grid_top">
-    <div class="row">
-      <h1>DOM Glancy</h1>
-    </div>
-    <div class="row">
-      <h2 class="caramel"><%= @parent_application_name %> {<span id="js-kr--gem_rev"><%= @gem_version %></span>}</h2>
-    </div>
+  <h1>DOM Glancy</h1>
+  <h2 class="caramel"><%= @parent_application_name %> {<span id="js-kr--gem_rev"><%= @gem_version %></span>}</h2>
 
-    <%= render :partial => 'shared/dom_glancy_nav' %>
+  <%= render :partial => 'shared/dom_glancy_nav' %>
 
-    <div class="row">
-      <%= yield %>
-    </div>
-  </div>
+  <%= yield %>
+  <%= javascript_include_tag 'dom_glancy/dom_glancy' %>
 </body>
 </html>

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

@@ -1,4 +1,4 @@
-<div class="row" id="js-kr--nav"></a>
+<div class="row" id="js-kr--nav">
   <a href="/dom_glancy/" class="kr"><div class="slot-0 kr--nav">home</div></a>
   <a href="/dom_glancy/new" class="kr"><div class="slot-1 kr--nav">new</div></a>
   <!--<a href="/dom_glancy/artifacts" class="kr"><div class="slot-2 kr--nav">artifacts</div></a>-->

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

@@ -1,4 +1,4 @@
-<div id="<%= finder_id %>">
+<div id="<%= finder_id %>" class="hide">
   <% if elements.length > 0 %>
     <table class='kr--dom'>
       <thead>
@@ -11,12 +11,24 @@
           <th>width</th>
           <th>height</th>
           <th>visible</th>
+          <% if finder_id == 'js--changed' %>
+            <th>was</th>
+          <% end %>
         </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") %>">
+            <% was_element = element['was'] %>
+            <% changed = [] %>
+            <% if was_element %>
+              <% changed << "height: #{was_element['height']}" unless element['height'] == was_element['height'] %>
+              <% changed << "width: #{was_element['width']}" unless element['width'] == was_element['width'] %>
+              <% changed << "top: #{was_element['top']}" unless element['top'] == was_element['top'] %>
+              <% changed << "left: #{was_element['left']}" unless element['left'] == was_element['left'] %>
+              <% changed << "class: #{was_element['class']}" unless element['class'] == was_element['class'] %>
+            <% end %>
             <td><%= element['tag'] %></td>
             <td><%= element['id'] %></td>
             <td><%= element['class'] %></td>
@@ -25,6 +37,9 @@
             <td><%= element['width'] %></td>
             <td><%= element['height'] %></td>
             <td><%= element['visible'] %></td>
+            <% if was_element %>
+              <td><%= changed.join(', ') %></td>
+            <% end %>
           </tr>
         <% end %>
       </tbody>
@@ -32,4 +47,4 @@
   <% else %>
     <p>no elements found.</p>
   <% end %>
-</div>
+</div>

data/lib/assets/javascripts/dom_glancy/dom_glancy.js

@@ -0,0 +1,37 @@
+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;
+  }
+}
+
+function toggleDetailSection(section_id, event) {
+    var section = document.getElementById(section_id);
+    var classes = section.classList;
+    if(classes.contains("hide"))
+    {
+        classes.remove("hide");
+        event.currentTarget.innerHTML = '-';
+    }else
+    {
+        classes.add("hide");
+        event.currentTarget.innerHTML = '+';
+    }
+}
+
+function highlightElement (element_id) {
+    var elements = document.getElementsByTagName('rect');
+    var element = null;
+    var length = elements.length;
+
+    for (var i = 0; i < length; i++) {
+        elements[i].setAttribute("stroke-width", "1");
+    }
+    var this_element = document.getElementById(element_id);
+    this_element.setAttribute("stroke-width", "5");
+}
+
+document.getElementById("changed_toggle").addEventListener("click", function(e) { toggleDetailSection('js--changed', e) });
+document.getElementById("not_master_toggle").addEventListener("click", function(e) { toggleDetailSection('js--not_master', e) });
+document.getElementById("not_current_toggle").addEventListener("click", function(e) { toggleDetailSection('js--not_current', e) });

data/{app/assets/stylesheets → lib/assets/stylesheets/dom_glancy}/dom_glancy.css

@@ -27,9 +27,11 @@ html {
 body {
   background-color: #FFFBF5;
   color: #2A2111;
-  margin-top: 0px;
+  margin: 0 0 0 20px;
 }
 
+p { max-width: 960px; }
+
 a.kr:link    { text-decoration:none; color: #A3906D; }
 a.kr:visited { text-decoration:none; color: #A3906D; }
 a.kr:hover   { text-decoration:none; color: #956C1F; }
@@ -102,15 +104,14 @@ a.kr:active  { text-decoration:none; color: #A3906D; }
     width: auto;
     min-width: 0;
     padding: 4px 4px 4px 4px;
-
 }
 
 .kr-dom_row_odd {
-    background-color: #A3906D;
+    background-color: #ffffff;
 }
 
 .kr-dom_row_even {
-    background-color: transparent;
+    background-color: #FFFBF5;
 }
 
 .kr--svg_rect_highlight {
@@ -119,6 +120,7 @@ a.kr:active  { text-decoration:none; color: #A3906D; }
 
 .kr--about {
     margin-top: 30px;
+    margin-left: 30px;
     padding: 35px;
     color: #2A2111;
     background-color: #fff;
@@ -126,6 +128,7 @@ a.kr:active  { text-decoration:none; color: #A3906D; }
     -moz-border-radius: 20px;
     -webkit-border-radius: 20px;
     border-radius: 10px; /* future proofing */
+    max-width: 960px;
 }
 
 .kr--artifacts td {
@@ -147,3 +150,31 @@ a.kr:active  { text-decoration:none; color: #A3906D; }
     border-radius: 5px;
     font-size: 75%;
 }
+
+.hide { display: none; }
+.hideable {
+    color: #956C1F;
+    cursor: pointer;
+}
+
+/* tab list */
+ul.tab_list {
+    float: left;
+    width: 100%;
+    padding: 0;
+    margin: 0;
+    list-style-type: none;
+}
+
+li.tab {
+    display: inline;
+    background-color: transparent;
+    font-size: 2em;
+    padding: 0 2em 0 2em;
+}
+
+.tab_active {
+    color: #956C1F;
+    background-color: #FFFBF5;
+    border-bottom: 4px solid #956C1F;
+}

data/lib/dom_glancy.rb

@@ -5,7 +5,11 @@ 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/analyzer'
+require 'dom_glancy/file_name_builder'
 require 'dom_glancy/svg'
 require 'dom_glancy/configuration'
+require 'dom_glancy/page_mapper'
+require 'dom_glancy/map_file'
+require 'dom_glancy/analysis_reporter'
+require 'dom_glancy/change_anlyzer'

data/lib/dom_glancy/analysis_reporter.rb

@@ -0,0 +1,39 @@
+module DomGlancy
+  class AnalysisReporter
+    @test_root
+    @set_current_not_master
+    @set_master_not_current
+    @set_changed_master
+    @changed_pairs
+
+    def initialize(test_root, set_current_not_master,set_master_not_current, set_changed_master, changed_pairs)
+      @test_root              = test_root
+      @set_current_not_master = set_current_not_master
+      @set_master_not_current = set_master_not_current
+      @set_changed_master     = set_changed_master
+      @changed_pairs          = changed_pairs
+    end
+
+    def create_diff_file
+      filename = ::DomGlancy::FileNameBuilder.new(@test_root).diff
+      svg = make_svg
+      File.open(filename, 'w') { |file| file.write(svg) }
+      save_set_info('current_not_master', @set_current_not_master)
+      save_set_info('master_not_current', @set_master_not_current)
+      save_set_info('changed_master',     @set_changed_master)
+      save_set_info('changed_pairs',      @changed_pairs)
+    end
+
+    private
+
+    def make_svg
+      svg = ::DomGlancy::SVG.new(@set_current_not_master, @set_master_not_current, @set_changed_master)
+      svg.generate_svg
+    end
+
+    def save_set_info(suffix, data_set)
+      filename = File.join(::DomGlancy.configuration.diff_file_location, "#{@test_root}__#{suffix}__diff.yaml")
+      File.open(filename, 'w') { |file| file.write(data_set.to_a.to_yaml) }
+    end
+  end
+end

data/lib/dom_glancy/analyzer.rb

@@ -0,0 +1,139 @@
+module DomGlancy
+  class Analyzer
+    attr_reader :set_current_not_master
+    attr_reader :set_master_not_current
+    attr_reader :set_changed_master
+    attr_reader :changed_element_pairs
+
+    @master_data
+    @current_data
+    @test_root
+
+    def initialize(master_data, current_data, test_root = nil)
+      @master_data  = master_data
+      @current_data = current_data
+      @test_root    = test_root
+    end
+
+    def analyze
+      clear_results
+
+      if missing_elements? || extra_elements?
+        remove_similar_elements
+        extract_changed_elements
+      end
+
+      # create_diff_file if @test_root && !all_same?
+      compile_results
+    end
+
+    private
+
+    def clear_results
+      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 = []
+    end
+
+    def compile_results
+      {
+        not_in_master:         @set_current_not_master,
+        not_in_current:        @set_master_not_current,
+        changed_element_pairs: @changed_element_pairs,
+        changed_master:        @set_changed_master,
+        test_root:             @test_root,
+        same:                  all_same?
+      }
+    end
+
+    def all_same?
+      @set_current_not_master.count == 0 && @set_master_not_current.count == 0 && @changed_element_pairs.count == 0
+    end
+
+    def missing_elements?
+      @set_master_not_current.count > 0
+    end
+
+    def extra_elements?
+      @set_current_not_master.count > 0
+    end
+
+    def remove_similar_elements
+      ok_pairs = similar_pairs(@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
+    end
+
+    def extract_changed_elements
+      @changed_element_pairs = []
+
+      @set_current_not_master.each do |item1|           # in current
+        element1 = DOMElement.new(item1)
+        changed_elements = []
+        @set_master_not_current.each do |item2|         # in master
+          element2 = DOMElement.new(item2)
+          if element1.same_element?(element2)
+            changed_elements << element2
+          end
+        end
+
+        least_changed = changed_elements[0]
+        changed_elements.each do |element|
+          change_analyzer = ChangeAnalyzer.new
+          least_changed = element if change_analyzer.compare(element1, element) < change_analyzer.compare(element1, least_changed)
+        end
+
+        @changed_element_pairs << [item1, least_changed.to_hash] if least_changed
+      end
+
+      remove_elements_from_data_sets @changed_element_pairs
+
+      @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|
+        current_element = pair[0].dup
+        master_element  = pair[1].dup
+        current_element['was'] = master_element
+        @set_changed_master.add(current_element)
+      end
+    end
+
+    def remove_elements_from_data_sets(element_pairs)
+      element_pairs.each do |element_1, element_2|
+        remove_element_from_data_sets element_1
+        remove_element_from_data_sets element_2
+      end
+    end
+
+    def remove_element_from_data_sets(element)
+      @set_current_not_master.delete element
+      @set_master_not_current.delete element
+    end
+
+    def similar_pairs(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 add_similarity(element)
+      element.merge('similarity' => ::DomGlancy.configuration.similarity)
+    end
+  end
+end