sitediff 0.0.6 → 1.2.0

data/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "sitediff",
+  "version": "1.0.0",
+  "description": "Sitediff Javascript",
+  "main": "./sitediff/files/sitediff.js",
+  "directories": {
+    "lib": "lib"
+  },
+  "scripts": {
+    "lint": "eslint --debug ./lib/sitediff/files/*.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/evolvingweb/sitediff.git"
+  },
+  "author": "",
+  "license": "GPL-2.0-only",
+  "bugs": {
+    "url": "https://github.com/evolvingweb/sitediff/issues"
+  },
+  "homepage": "https://github.com/evolvingweb/sitediff#readme",
+  "devDependencies": {
+    "eslint": "^7.5.0"
+  }
+}

data/sitediff.gemspec

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name        = 'sitediff'
+  s.version     = '1.2.0'
+  s.required_ruby_version = '>= 3.1.2'
+  s.summary     = 'Compare two versions of a site with ease!'
+  s.description = <<DESC
+  SiteDiff makes it easy to see differences between two versions of a website. It accepts a set of paths to compare two versions of the site together with potential normalization/sanitization rules. From the provided paths and configuration SiteDiff generates an HTML report of all the status of HTML comparison between the given paths together with a readable diff-like HTML for each specified path containing the differences between the two versions of the site. It is useful tool for QAing re-deployments, site upgrades, etc.
+DESC
+  s.license     = 'GPL-2.0'
+  s.authors     = ['Alex Dergachev', 'Amir Kadivar', 'Dave Vasilevsky']
+  s.homepage    = 'https://sitediff.io/'
+  s.email       = 'alex@evolvingweb.ca'
+  s.metadata    = {
+    'source_code_uri' => 'https://github.com/evolvingweb/sitediff'
+  }
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  s.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  s.require_paths = ['lib']
+  # s.files       = Dir.glob('lib/**/*.rb') +
+  #                Dir.glob('lib/sitediff/files/*') +
+  #                Dir.glob('lib/sitediff/files/rules/*.yaml')
+  s.bindir      = 'bin'
+  s.executables = 'sitediff'
+
+  # Apparently we require pkg-config
+  s.add_dependency 'pkg-config', '~> 1.4'
+
+  s.add_dependency 'minitar', '~> 0.9'
+  s.add_dependency 'thor', '~> 1.2.1'
+  s.add_dependency 'typhoeus', '~> 1.4.0'
+
+  # A bug in rubygems can break rainbow 2.2
+  # https://github.com/bundler/bundler/issues/5357
+  s.add_dependency 'rainbow', '~> 3.1.1'
+
+  # Nokogiri 1.7 is not supported on Ruby 2.0.
+  s.add_dependency 'nokogiri', '>= 1.13.6'
+
+  # Diffy and addressable have a max version for Ruby 1.9.
+  s.add_dependency 'addressable', '>= 2.5.2', '< 2.9.0'
+  s.add_dependency 'diffy', '~> 3.4.0'
+  s.add_dependency 'webrick', '>= 1.7'
+end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: sitediff
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 1.2.0
 platform: ruby
 authors:
 - Alex Dergachev
 - Amir Kadivar
 - Dave Vasilevsky
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-04-02 00:00:00.000000000 Z
+date: 2022-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pkg-config
@@ -18,98 +18,132 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: minitar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: 1.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.1.1
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.2
+        version: 1.13.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.2
+        version: 1.13.6
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.5.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.5.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.9.0
 - !ruby/object:Gem::Dependency
   name: diffy
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.7'
 description: "  SiteDiff makes it easy to see differences between two versions of
   a website. It accepts a set of paths to compare two versions of the site together
   with potential normalization/sanitization rules. From the provided paths and configuration
@@ -123,35 +157,64 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".eslintignore"
+- ".eslintrc.json"
+- ".project"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- INSTALLATION.md
+- LICENSE
+- README.md
+- Rakefile
+- Thorfile
 - bin/sitediff
+- config/.gitkeep
+- config/sanitize_domains.example.yaml
+- config/sitediff.example.yaml
+- docker-compose.test.yml
 - lib/sitediff.rb
+- lib/sitediff/api.rb
 - lib/sitediff/cache.rb
 - lib/sitediff/cli.rb
 - lib/sitediff/config.rb
 - lib/sitediff/config/creator.rb
+- lib/sitediff/config/preset.rb
 - lib/sitediff/crawler.rb
 - lib/sitediff/diff.rb
 - lib/sitediff/exception.rb
 - lib/sitediff/fetch.rb
 - lib/sitediff/files/diff.html.erb
-- lib/sitediff/files/html_report.html.erb
+- lib/sitediff/files/jquery.min.js
+- lib/sitediff/files/normalize.css
 - lib/sitediff/files/pretty_print.xsl
-- lib/sitediff/files/rules/drupal.yaml
+- lib/sitediff/files/report.html.erb
 - lib/sitediff/files/sidebyside.html.erb
 - lib/sitediff/files/sitediff.css
+- lib/sitediff/files/sitediff.js
+- lib/sitediff/presets/drupal.yaml
+- lib/sitediff/report.rb
 - lib/sitediff/result.rb
-- lib/sitediff/rules.rb
 - lib/sitediff/sanitize.rb
 - lib/sitediff/sanitize/dom_transform.rb
 - lib/sitediff/sanitize/regexp.rb
 - lib/sitediff/uriwrapper.rb
 - lib/sitediff/webserver.rb
 - lib/sitediff/webserver/resultserver.rb
-homepage: https://github.com/evolvingweb/sitediff/
+- misc/sitediff - overview report.png
+- misc/sitediff - page report.png
+- package-lock.json
+- package.json
+- sitediff.gemspec
+homepage: https://sitediff.io/
 licenses:
 - GPL-2.0
-metadata: {}
-post_install_message: 
+metadata:
+  source_code_uri: https://github.com/evolvingweb/sitediff
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -159,16 +222,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: 3.1.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Compare two versions of a site with ease!
 test_files: []

data/lib/sitediff/files/html_report.html.erb

@@ -1,66 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <!-- important: otherwise chrome will choke on non-ascii characters -->
-    <meta charset="utf-8" />
-    <style>
-      <%= SiteDiff::Diff.css %>
-    </style>
-    <title> SiteDiff Report </title>
-  </head>
-  <body>
-    <div class="sitediff">
-      <div class="legend">
-        <%
-           tags = %w[before after]
-           tags.each do |tag| %>
-             <% if tags.first != tag %> | <% end %>
-             <% notes = ['base url']
-                notes << 'cached' if cache.read_tags.include?(tag.to_sym) %>
-             <strong><%= tag %></strong> (<%= notes.join(', ') %>):
-               <a href="<%= eval(tag) %>"><%= eval(tag) %></a>
-        <% end %>
-      </div>
-      <div class="run">
-        <a href="../run/diff">Rerun diff</a>
-      </div>
-      <table class="results">
-
-        <colgroup>
-          <col class="before-col">
-          <col class="after-col">
-          <col class="both-col">
-          <col class="path-col">
-          <col class="diff-stat-col">
-        </colgroup>
-
-        <thead>
-          <tr>
-            <th> Before </th>
-            <th> After </th>
-            <th> Both </th>
-            <th> Path </th>
-            <th> Status </th>
-          </tr>
-        </thead>
-
-        <% results.each do |result| %>
-        <tr class="<%= result.status_text %>">
-          <td class="before">
-            <a href="<%= result.url(:before, before, cache) %>">[before]</a>
-          </td>
-          <td class="after">
-            <a href="<%= result.url(:after, after, cache) %>">[after]</a>
-          </td>
-          <td class="both">
-            <a href="/sidebyside<%= result.path %>">[both]</a>
-          </td>
-          <td class="path"><%= result.path %></td>
-          <td class="status"><%= result.link %></td>
-        </tr>
-        <% end %>
-
-      </table>
-    </div>
-  </body>
-</html>

data/lib/sitediff/files/rules/drupal.yaml

@@ -1,63 +0,0 @@
-sanitization:
-- title: Strip Drupal.settings
-  selector: script
-  pattern: '^(<script>)?jQuery.extend\(Drupal.settings.*$'
-- title: Strip IE CSS/JS cache IDs
-  pattern: '("[^"]*ie\d?\.(js|css))\?[a-z0-9]{6}"'
-  substitute: '\1'
-- title: Strip form build ID
-  selector: input
-  pattern: 'name="form_build_id" value="form-[-\w]{40,43}"'
-  substitute: 'name="form_build_id" value="form-DRUPAL_FORM_BUILD_ID"'
-- title: Strip view DOM ID
-  pattern: '(class="view .*) view-dom-id-[a-f0-9]{32}"'
-  substitute: '\1 view-dom-id-DRUPAL_VIEW_DOM_ID"'
-- title: Strip CSS aggregation filenames
-  selector: link[rel=stylesheet]
-  pattern: '(href="[^"]*/files/css/css_)[-\w]{40,43}\.css"'
-  substitute: '\1DRUPAL_AGGREGATED_CSS.css"'
-- title: Strip JS aggregation filenames
-  selector: script
-  pattern: '(src="[^"]*/files/js/js_)[-\w]{40,43}\.js"'
-  substitute: '\1DRUPAL_AGGREGATED_JS.js"'
-- title: Strip CSS/JS cache IDs
-  selector: style, script
-  pattern: '("[^"]*\.(js|css))\?[a-z0-9]{6}"'
-  substitute: '\1'
-- title: Strip Drupal JS version tags
-  selector: script
-  pattern: '(src="[^"]*/misc/\w+\.js)?v=\d+\.\d+"'
-  substitute: '\1'
-- title: Strip domain names from absolute URLs
-  pattern: 'http:\/\/[a-zA-Z0-9.:-]+'
-  substitute: '__domain__'
-- title: Strip form build ID
-  selector: input
-  pattern: 'autocomplete="off" data-drupal-selector="form-[-\w]{40,43}"'
-  substitute: 'autocomplete="off" data-drupal-selector="form-DRUPAL_FORM_BUILD_ID"'
-- title: Strip form build ID 2
-  selector: input
-  pattern: 'name="form_build_id" value="form-[-\w]{40,43}"'
-  substitute: 'name="form_build_id" value="form-DRUPAL_FORM_BUILD_ID"'
-- title: Strip Drupal CSS link queries
-  selector: link
-  pattern: '\.css\?(\w*)'
-  substitute: '\.css'
-- title: Strip Drupal JS link queries
-  selector: script
-  pattern: '\.js\?(\w*)'
-  substitute: '\.js'
-- title: Strip Drupal View-DOM ID
-  pattern: 'view-dom-id-\w*'
-  substitute: 'view-dom-id-_ID_'
-- title: Strip Drupal View-DOM ID 2
-  pattern: '(views?_dom_id"?:"?)\w*'
-  substitute: '\1_ID_'
-- title: Ignore Drupal CSS file names
-  selector: link
-  pattern: 'css_[-\w]{40,43}(\\|%5C)?\.css'
-  substitute: 'css__ID__.css'
-- title: Ignore Drupal JS file names
-  selector: script
-  pattern: 'js_[-\w]{40,43}\\?\.js'
-  substitute: 'js__ID__.js'

data/lib/sitediff/rules.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-require 'sitediff/sanitize/regexp'
-require 'pathname'
-require 'set'
-
-class SiteDiff
-  # Find appropriate rules for a given site
-  class Rules
-    def initialize(config, disabled = false)
-      @disabled = disabled
-      @config = config
-      find_sanitization_candidates
-      @rules = Hash.new { |h, k| h[k] = Set.new }
-    end
-
-    def find_sanitization_candidates
-      @candidates = Set.new
-
-      rules_dir = Pathname.new(__FILE__).dirname + 'files' + 'rules'
-      rules_dir.children.each do |f|
-        next unless f.file? && f.extname == '.yaml'
-
-        conf = YAML.load_file(f)
-        @candidates.merge(conf['sanitization'])
-      end
-    end
-
-    def handle_page(tag, html, doc)
-      found = find_rules(html, doc)
-      @rules[tag].merge(found)
-    end
-
-    # Yield a set of rules that seem reasonable for this HTML
-    # assumption: the YAML file is a list of regexp rules only
-    def find_rules(html, doc)
-      @candidates.select do |rule|
-        re = SiteDiff::Sanitizer::Regexp.create(rule)
-        re.applies?(html, doc)
-      end
-    end
-
-    # Find all rules from all rulesets that apply for all pages
-    def add_config
-      have_both = @rules.include?(:before)
-
-      r1, r2 = *@rules.values_at(:before, :after)
-      if have_both
-        add_section('before', r1 - r2)
-        add_section('after', r2 - r1)
-        add_section(nil, r1 & r2)
-      else
-        add_section(nil, r2)
-      end
-    end
-
-    def add_section(name, rules)
-      return if rules.empty?
-
-      conf = name ? @config[name] : @config
-      rules.each { |r| r['disabled'] = true } if @disabled
-      conf['sanitization'] = rules.to_a.sort_by { |r| r['title'] }
-    end
-  end
-end