govuk-diff-pages 0.1.0

data/lib/govuk/diff/pages/text_diff/retriever.rb

@@ -0,0 +1,13 @@
+module Govuk
+  module Diff
+    module Pages
+      module TextDiff
+        class Retriever
+          def call(url)
+            `curl -s #{url}`
+          end
+        end
+      end
+    end
+  end
+end

data/lib/govuk/diff/pages/text_diff/runner.rb

@@ -0,0 +1,41 @@
+module Govuk
+  module Diff
+    module Pages
+      module TextDiff
+        class Runner
+          def initialize(
+            pages: Array.new,
+            differ: Differ.new,
+            retriever: Retriever.new,
+            formatter: Formatter.new,
+            renderer: Renderer.new,
+            left_domain: "www-origin.staging.publishing.service.gov.uk",
+            right_domain: "www-origin.publishing.service.gov.uk"
+          )
+            @pages     = pages
+            @differ    = differ
+            @retriever = retriever
+            @formatter = formatter
+            @renderer  = renderer
+            @left_domain  = left_domain
+            @right_domain = right_domain
+          end
+
+          def run
+            responses = @pages.inject([]) do |response, page|
+              left  = @retriever.call("https://#{@left_domain}/#{page}")
+              right = @retriever.call("https://#{@right_domain}/#{page}")
+
+              response << @differ.diff(
+                @formatter.call(left),
+                @formatter.call(right)
+              )
+            end
+
+            @renderer.call(responses)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/govuk/diff/pages/url_checker.rb

@@ -0,0 +1,36 @@
+module Govuk
+  module Diff
+    module Pages
+      class UrlChecker
+        def initialize(config)
+          @config = config
+          @govuk_regex = /^#{@config.domains.production}/
+          @parameterised_url_regex = /\?/
+          @relative_path_regex = /^\//
+        end
+
+        # returns true if non parameterised and a relative or govuk url
+        def valid?(url)
+          if url =~ @parameterised_url_regex # question mark denotes it has parameters - we don't want those
+            false
+          elsif url =~ @relative_path_regex # starts with slash - so is a path on govuk website
+            true
+          elsif url =~ @govuk_regex # gov uk full link
+            true
+          else
+            false
+          end
+        end
+
+        def normalize(url)
+          raise "Not GOVUK url: #{url}" unless valid?(url)
+          url.sub(@govuk_regex, '')
+        end
+
+        def production_url(url)
+          "#{@config.domains.production}#{normalize(url)}"
+        end
+      end
+    end
+  end
+end

data/lib/govuk/diff/pages/version.rb

@@ -0,0 +1,7 @@
+module Govuk
+  module Diff
+    module Pages
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/govuk/diff/pages/wraith_config_generator.rb

@@ -0,0 +1,79 @@
+require 'yaml'
+require 'securerandom'
+
+module Govuk
+  module Diff
+    module Pages
+      class WraithConfigGenerator
+        def initialize
+          @config = AppConfig.new
+          unless File.exist?(Govuk::Diff::Pages.govuk_pages_file)
+            raise "Cannot find file #{Govuk::Diff::Pages.govuk_pages_file}: run 'rake update_page_list' to generate."
+          end
+          @govuk_pages = YAML.load_file(Govuk::Diff::Pages.govuk_pages_file)
+          @url_checker = UrlChecker.new(@config)
+          puts "Generating wraith.yaml" if verbose?
+          validate_hard_coded_pages
+        end
+
+        def run
+          @wraith_config = @config.wraith.to_h
+          @wraith_config['paths'] = generate_path_list
+          @wraith_config['domains'] = @config.domains.to_h
+          @wraith_config['browser'] = { 'phantomjs' => 'phantomjs' }
+          @wraith_config['phantomjs_options'] = "--ssl-protocol=tlsv1 --ignore-ssl-errors=true"
+        end
+
+        def save
+          File.open(WRAITH_CONFIG_FILE, 'w') do |fp|
+            fp.puts YAML.dump(@wraith_config)
+          end
+        end
+
+        def verbose?
+          @config.verbose
+        end
+
+      private
+        def validate_hard_coded_pages
+          errors = []
+          @config.hard_coded_pages.to_h.each do |_key, url|
+            next if @url_checker.valid?(url)
+            errors << "ERROR: Invalid url specified in hard coded pages: '#{url}'"
+          end
+          print_errors_and_exit(errors) unless errors.empty?
+        end
+
+        def print_errors_and_exit(errors)
+          raise ArgumentError.new %[Invalid config:\n  #{errors.join("\n  ")}]
+        end
+
+        def generate_path_list
+          paths = generate_paths_from_govuk_pages_file
+          paths.merge(@config.hard_coded_pages.to_h)
+        end
+
+        def generate_paths_from_govuk_pages_file
+          paths = {}
+          @govuk_pages.each do |path|
+            next unless @url_checker.valid?(path)
+            normalized_path = @url_checker.normalize(path)
+            paths[keyify_path(normalized_path)] = normalized_path
+          end
+          paths
+        end
+
+        def normalize_path(path)
+          path.sub(/^#{@config.domains.production}/, '')
+        end
+
+        def keyify_path(path)
+          key = path.sub(/^\//, '').tr("/", "_")
+          # YAML DUMP doesn't work with very long keys
+          key = SecureRandom.uuid if key.size > 100
+          key
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: govuk-diff-pages
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Lovell
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gem_publisher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Diffs web pages both visually and textually.
+email:
+- benjamin.lovell@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/settings.yml
+- docs/screenshots/gallery.png
+- govuk-diff-pages.gemspec
+- lib/govuk/diff/pages.rb
+- lib/govuk/diff/pages/app_config.rb
+- lib/govuk/diff/pages/format_searcher.rb
+- lib/govuk/diff/pages/html_diff.rb
+- lib/govuk/diff/pages/html_diff/assets/gallery_template.erb
+- lib/govuk/diff/pages/html_diff/assets/html_diff_styles.css
+- lib/govuk/diff/pages/html_diff/assets/html_diff_template.erb
+- lib/govuk/diff/pages/html_diff/differ.rb
+- lib/govuk/diff/pages/html_diff/runner.rb
+- lib/govuk/diff/pages/link_checker.rb
+- lib/govuk/diff/pages/page_indexer.rb
+- lib/govuk/diff/pages/page_searcher.rb
+- lib/govuk/diff/pages/tasks/rakefile.rake
+- lib/govuk/diff/pages/text_diff.rb
+- lib/govuk/diff/pages/text_diff/differ.rb
+- lib/govuk/diff/pages/text_diff/formatter.rb
+- lib/govuk/diff/pages/text_diff/renderer.rb
+- lib/govuk/diff/pages/text_diff/retriever.rb
+- lib/govuk/diff/pages/text_diff/runner.rb
+- lib/govuk/diff/pages/url_checker.rb
+- lib/govuk/diff/pages/version.rb
+- lib/govuk/diff/pages/wraith_config_generator.rb
+homepage: https://github.com/alphagov/govuk-diff-pages
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Visual and textual page diffing.
+test_files: []