sitediff 0.0.2 → 1.1.1

data/lib/sitediff/webserver.rb

@@ -1,82 +1,94 @@
+# frozen_string_literal: true
+
 require 'webrick'
 
 class SiteDiff
-class Webserver
-# Simple webserver for testing purposes
-DEFAULT_PORT = 13080
-
-attr_accessor :ports
-
-# Serve a list of directories
-def initialize(start_port, dirs, opts = {})
-  start_port ||= DEFAULT_PORT
-  @ports = (start_port...(start_port + dirs.size)).to_a
-  @dirs = dirs
-  @opts = opts
-
-  setup
-  start_servers
-
-  if block_given?
-    yield self
-    kill
-  end
-end
-
-def kill
-  @threads.each { |t| t.kill }
-end
-
-def wait
-  @threads.each { |t| t.join }
-end
-
-def uris
-  ports.map { |p| "http://localhost:#{p}" }
-end
-
-protected
-def setup
-  @server_opts = {}
-  if @opts[:quiet]
-    @server_opts[:Logger] = WEBrick::Log.new(IO::NULL)
-    @server_opts[:AccessLog] = []
-  end
-end
-
-def server(opts)
-  WEBrick::HTTPServer.new(opts)
-end
-
-def start_servers
-  @threads = []
-  @dirs.each_with_index do |dir, idx|
-    @server_opts[:Port] = @ports[idx]
-    @server_opts[:DocumentRoot] = dir
-    srv = server(@server_opts)
-    @threads << Thread.new { srv.start }
+  # SiteDiff Web Server.
+  class Webserver
+    # Simple web server for testing purposes.
+    DEFAULT_PORT = 13_080
+
+    attr_accessor :ports
+
+    ##
+    # Serve a list of directories.
+    def initialize(start_port, dirs, opts = {})
+      start_port ||= DEFAULT_PORT
+      @ports = (start_port...(start_port + dirs.size)).to_a
+      @dirs = dirs
+      @opts = opts
+
+      setup
+      start_servers
+
+      if block_given?
+        yield self
+        kill
+      end
+    end
+
+    ##
+    # Kills the server.
+    def kill
+      @threads.each(&:kill)
+    end
+
+    ##
+    # Waits for the server.
+    def wait
+      @threads.each(&:join)
+    end
+
+    ##
+    # Maps URIs to defined ports and returns a list of URIs.
+    def uris
+      ports.map { |p| "http://localhost:#{p}" }
+    end
+
+    protected
+
+    def setup
+      @server_opts = {}
+      if @opts[:quiet]
+        @server_opts[:Logger] = WEBrick::Log.new(IO::NULL)
+        @server_opts[:AccessLog] = []
+      end
+    end
+
+    def server(opts)
+      WEBrick::HTTPServer.new(opts)
+    end
+
+    def start_servers
+      @threads = []
+      @dirs.each_with_index do |dir, idx|
+        @server_opts[:Port] = @ports[idx]
+        @server_opts[:DocumentRoot] = dir
+        srv = server(@server_opts)
+        @threads << Thread.new { srv.start }
+      end
+    end
+
+    public
+
+    # SiteDiff Fixture Server.
+    class FixtureServer < Webserver
+      PORT = DEFAULT_PORT + 1
+      BASE = 'spec/sites/ruby-doc.org'
+      NAMES = %w[core-1.9.3 core-2.0].freeze
+
+      def initialize(port = PORT, base = BASE, names = NAMES)
+        dirs = names.map { |n| File.join(base, n) }
+        super(port, dirs, quiet: true)
+      end
+
+      def before
+        uris.first
+      end
+
+      def after
+        uris.last
+      end
+    end
   end
 end
-
-public
-
-class FixtureServer < Webserver
-  PORT = DEFAULT_PORT + 1
-  BASE = 'spec/fixtures/ruby-doc.org'
-  NAMES = %w[core-1.9.3 core-2.0]
-
-  def initialize(port = PORT, base = BASE, names = NAMES)
-    dirs = names.map { |n| File.join(base, n) }
-    super(port, dirs, :quiet => true)
-  end
-
-  def before
-    uris.first
-  end
-  def after
-    uris.last
-  end
-end
-
-end
-end

data/lib/sitediff/webserver/resultserver.rb

@@ -1,98 +1,134 @@
+# frozen_string_literal: true
+
 require 'sitediff'
+require 'sitediff/report'
 require 'sitediff/webserver'
 require 'erb'
 
 class SiteDiff
-class Webserver
-class ResultServer < Webserver
-  # Display a page from the cache
-  class CacheServlet < WEBrick::HTTPServlet::AbstractServlet
-    def initialize(server, cache)
-      @cache = cache
-    end
+  class Webserver
+    # SiteDiff Result Server.
+    class ResultServer < Webserver
+      # Display a page from the cache
+      class CacheServlet < WEBrick::HTTPServlet::AbstractServlet
+        ##
+        # Creates a Cache Servlet.
+        def initialize(_server, cache)
+          @cache = cache
+        end
 
-    def do_GET(req, res)
-      path = req.path_info
-      md = %r[^/([^/]+)(/.*)$].match(path) or
-        raise WEBrick::HTTPStatus::NotFound
-      tag, path = *md.captures
-      r = @cache.get(tag.to_sym, path) or
-        raise WEBrick::HTTPStatus::NotFound
+        ##
+        # Performs a GET request.
+        def do_GET(req, res)
+          path = req.path_info
+          (md = %r{^/([^/]+)(/.*)$}.match(path)) ||
+            raise(WEBrick::HTTPStatus::NotFound)
+          tag, path = *md.captures
+          (r = @cache.get(tag.to_sym, path)) ||
+            raise(WEBrick::HTTPStatus::NotFound)
 
-      raise WEBrick::HTTPStatus[r.error_code] if r.error_code
-      raise WEBrick::HTTPStatus::InternalServerError, r.error if r.error
+          raise WEBrick::HTTPStatus[r.error_code] if r.error_code
+          raise WEBrick::HTTPStatus::InternalServerError, r.error if r.error
 
-      res['content-type'] = 'text/html'
-      res.body = r.content
-    end
-  end
+          res['content-type'] = 'text/html'
+          res.body = r.content
+        end
+      end
 
-  # Display two pages side by side
-  class SideBySideServlet < WEBrick::HTTPServlet::AbstractServlet
-    def initialize(server, cache, settings)
-      @cache = cache
-      @settings = settings
-    end
+      ##
+      # Display two pages side by side.
+      class SideBySideServlet < WEBrick::HTTPServlet::AbstractServlet
+        ##
+        # Creates a Side By Side Servlet.
+        def initialize(_server, cache, settings)
+          @cache = cache
+          @settings = settings
+        end
 
-    def urls(path)
-      %w[before after].map do |tag|
-        base = @settings[tag]
-        base = "/cache/#{tag}" if @settings['cached'].include? tag
-        base + path
-      end
-    end
+        ##
+        # Generates URLs for a given path.
+        def urls(path)
+          %w[before after].map do |tag|
+            base = @settings[tag]
+            base = "/cache/#{tag}" if @settings['cached'].include? tag
+            base + path
+          end
+        end
 
-    def do_GET(req, res)
-      path = req.path_info
-      before, after = *urls(path)
+        ##
+        # Performs a GET request.
+        def do_GET(req, res)
+          path = req.path_info
+          before, after = *urls(path)
 
-      res['content-type'] = 'text/html'
-      erb = File.join(SiteDiff::FILES_DIR, 'sidebyside.html.erb')
-      res.body = ERB.new(File.read(erb)).result(binding)
-    end
-  end
+          res['content-type'] = 'text/html'
+          erb = File.join(SiteDiff::FILES_DIR, 'sidebyside.html.erb')
+          res.body = ERB.new(File.read(erb)).result(binding)
+        end
+      end
 
-  def initialize(port, dir, opts = {})
-    @settings = YAML.load_file(File.join(dir, SiteDiff::SETTINGS_FILE))
-    @cache = opts[:cache]
-    super(port, [dir], opts)
-  end
+      ##
+      # Creates a Result Server.
+      def initialize(port, dir, opts = {})
+        unless File.exist?(File.join(dir, Report::SETTINGS_FILE))
+          raise SiteDiffException,
+                "Please run 'sitediff diff' before running 'sitediff serve'"
+        end
 
-  def server(opts)
-    dir = opts.delete(:DocumentRoot)
-    srv = super(opts)
-    srv.mount_proc('/') do |req, res|
-      res.set_redirect(WEBrick::HTTPStatus::Found,
-        "/files/#{SiteDiff::REPORT_FILE}")
-    end
+        @settings = YAML.load_file(File.join(dir, Report::SETTINGS_FILE))
+        puts @settings
+        @cache = opts[:cache]
+        super(port, [dir], opts)
+      end
 
-    srv.mount('/files', WEBrick::HTTPServlet::FileHandler, dir, true)
-    srv.mount('/cache', CacheServlet, @cache)
-    srv.mount('/sidebyside', SideBySideServlet, @cache, @settings)
-    return srv
-  end
+      ##
+      # TODO: Document what this method does.
+      def server(opts)
+        dir = opts.delete(:DocumentRoot)
+        srv = super(opts)
+        srv.mount_proc('/') do |req, res|
+          if req.path == '/'
+            res.set_redirect(WEBrick::HTTPStatus::Found,
+                             "/files/#{Report::REPORT_FILE_HTML}")
+          else
+            res.set_redirect(WEBrick::HTTPStatus::TemporaryRedirect,
+                             "#{@settings['after']}#{req.path}")
+          end
+        end
 
-  def setup
-    super
-    root = uris.first
-    puts "Serving at #{root}"
-    open_in_browser(root) if @opts[:browse]
-  end
+        srv.mount('/files', WEBrick::HTTPServlet::FileHandler, dir, true)
+        srv.mount('/cache', CacheServlet, @cache)
+        srv.mount('/sidebyside', SideBySideServlet, @cache, @settings)
+        srv
+      end
 
-  def open_in_browser(url)
-    commands = %w[xdg-open open]
-    cmd = commands.find { |c| which(c) }
-    system(cmd, url) if cmd
-    return cmd
-  end
+      ##
+      # Sets up the server.
+      def setup
+        super
+        root = uris.first
+        puts "Serving at #{root}"
+        open_in_browser(root) if @opts[:browse]
+      end
+
+      ##
+      # Opens a URL in a browser.
+      def open_in_browser(url)
+        commands = %w[xdg-open open]
+        cmd = commands.find { |c| which(c) }
+        system(cmd, url) if cmd
+        cmd
+      end
 
-  def which(cmd)
-    ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
-      file = File.join(path, cmd)
-      return file if File.executable?(file)
+      ##
+      # TODO: Document what this method does.
+      def which(cmd)
+        ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+          file = File.join(path, cmd)
+          return file if File.executable?(file)
+        end
+        nil
+      end
     end
-    return nil
   end
 end
-end
-end

metadata

@@ -1,176 +1,192 @@
 --- !ruby/object:Gem::Specification
 name: sitediff
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 1.1.1
 platform: ruby
 authors:
 - Alex Dergachev
 - Amir Kadivar
 - Dave Vasilevsky
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-05-05 00:00:00.000000000 Z
+date: 2020-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: pkg-config
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: minitar
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: diffy
+  name: thor
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.20.0
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.10.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.10.4
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: ! 'SiteDiff makes it easy to see differences between two versions of
+        version: 2.5.2
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+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
   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.
-
-'
+  re-deployments, site upgrades, etc.\n"
 email: alex@evolvingweb.ca
 executables:
 - sitediff
 extensions: []
 extra_rdoc_files: []
 files:
+- bin/sitediff
 - lib/sitediff.rb
-- lib/sitediff/crawler.rb
-- lib/sitediff/sanitize/dom_transform.rb
-- lib/sitediff/sanitize/regexp.rb
-- lib/sitediff/config/creator.rb
-- lib/sitediff/cli.rb
-- lib/sitediff/fetch.rb
-- lib/sitediff/exception.rb
+- lib/sitediff/api.rb
 - lib/sitediff/cache.rb
+- lib/sitediff/cli.rb
 - lib/sitediff/config.rb
-- lib/sitediff/uriwrapper.rb
-- lib/sitediff/result.rb
-- lib/sitediff/sanitize.rb
-- lib/sitediff/webserver/resultserver.rb
-- lib/sitediff/rules.rb
-- lib/sitediff/webserver.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/jquery.min.js
+- lib/sitediff/files/normalize.css
+- lib/sitediff/files/pretty_print.xsl
+- lib/sitediff/files/report.html.erb
 - lib/sitediff/files/sidebyside.html.erb
 - lib/sitediff/files/sitediff.css
-- lib/sitediff/files/html_report.html.erb
-- lib/sitediff/files/pretty_print.xsl
-- lib/sitediff/files/rules/drupal.yaml
-- bin/sitediff
-homepage: https://github.com/evolvingweb/sitediff/
+- lib/sitediff/files/sitediff.js
+- lib/sitediff/report.rb
+- lib/sitediff/result.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://sitediff.io/
 licenses:
-- GPL-2
-post_install_message: 
+- GPL-2.0
+metadata:
+  source_code_uri: https://github.com/evolvingweb/sitediff
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.23
-signing_key: 
-specification_version: 3
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
 summary: Compare two versions of a site with ease!
 test_files: []