govuk-diff-pages 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7461d5624d6438b64b89ee14db3a51a49c6789d
-  data.tar.gz: 5575a5c4d1a74062a4d50c72dd6d29b2e2e05293
+  metadata.gz: d6e91c6499155a56c00e67d5aec312045363288b
+  data.tar.gz: 8ddb76d46f26a3f566aa880eba8d7ad7ebeeee87
 SHA512:
-  metadata.gz: 9363e7d7ef669768b36d6acea6c8a2301c3dbe0d32dfc51d83f872a803d0a66003e28ceeb13759a4ac07dba798dcc58dece2a0c394ed933a8d7c1e59e6267e41
-  data.tar.gz: abfc0131220eb9ad866edfd83f2b36e7ea958f86cbc4608be01483a9d7c2471ec46a4971c5a8e6d9057c3cdd40b725f2887c056688aad565a55c2e1434227fc3
+  metadata.gz: bc7d876b29885716acb47e807f6d5a3d867500eb6a800229df93bb7b2fa7687d276fc02c0485c8ee43a3bf199c68197c720134915fb37006ad7b08df05776a28
+  data.tar.gz: b9616840304cc3f400355ee354875e478610c5dd73c218ca0a143c40e0ac6918c67b84769c7075a743632d7f56119979891ec8be6deb56ed7218144c556edf81

data/.gitignore

@@ -31,3 +31,4 @@ config/wraith.yaml
 
 # This is a gem
 Gemfile.lock
+*.gem

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 0.1.1
+
+- Resolves issues with configured path resolution (#9)
+
+## 0.1.0
+
+- Initial version

data/Gemfile

@@ -1,5 +1,6 @@
 source 'https://rubygems.org'
 
 gem 'wraith', git: 'git@github.com:alphagov/wraith.git', branch: 'psr'
+gem 'govuk-lint', '~> 0.8'
 
 gemspec

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Ben Lovell
+Copyright (c) 2016 Government Digital Service
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -2,7 +2,7 @@
 
 This app provides a rake task to produce visual diffs as screenshots, HTML
 diffs and textual diffs of the production GOVUK website as compared with
-staging. Viewable as browser pages or directly in the terminal. It looks a the
+staging. Viewable as browser pages or directly in the terminal. It looks at the
 10 most popular pages (this is configurable) of each document format.
 
 ## Screenshots
@@ -36,17 +36,19 @@ these pages.
 
 ### Running the application locally
 
-  bundle exec rake diff
+    bundle exec rake diff
 
 ### Checking plain-text diffs
 
-  bundle exec rake diff:text pages.yml
+    bundle exec rake diff:text pages.yml
 
 Where `pages.yml` is a YAML array of paths to compare. For example:
 
-  - government/organisations/prime-ministers-office-10-downing-street
-  - government/topical-events/budget-2016
-  - topic/competition/regulatory-appeals-references
+```
+- government/organisations/prime-ministers-office-10-downing-street
+- government/topical-events/budget-2016
+- topic/competition/regulatory-appeals-references
+```
 
 Text diffs can also specify the domains to compare using the `LEFT` and `RIGHT`
 environment variables. Defaulting to our `www-origin.staging` and
@@ -57,19 +59,19 @@ individual page files.
 
 ### Using the gem from an existing project
 
-  # Gemfile
-  gem 'govuk-diff-pages'
+    # Gemfile
+    gem 'govuk-diff-pages'
 
-  # Rakefile
-  load 'govuk/diff/pages/tasks/rakefile.rake'
+    # Rakefile
+    load 'govuk/diff/pages/tasks/rakefile.rake'
 
-  # Shell
-  bundle exec rake -T
+    # Shell
+    bundle exec rake -T
 
 ### Running the test suite
 
-  bundle exec rake
+    bundle exec rake
 
 ## Licence
 
-[MIT License](LICENCE)
+[MIT License](LICENCE.txt)

data/Rakefile

@@ -6,8 +6,6 @@ load File.dirname(__FILE__) + "/lib/govuk/diff/pages/tasks/rakefile.rake"
 RSpec::Core::RakeTask.new(:spec)
 task default: :spec
 
-RSpec::Core::RakeTask.new(:spec)
-
 task :publish_gem do
   gem = GemPublisher.publish_if_updated("govuk-diff-pages.gemspec", :rubygems)
   puts "Published #{gem}" if gem

data/govuk-diff-pages.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Ben Lovell"]
   spec.email         = ["benjamin.lovell@gmail.com"]
 
-  spec.summary       = %q{Visual and textual page diffing.}
-  spec.description   = %q{Diffs web pages both visually and textually.}
+  spec.summary       = 'Visual and textual page diffing.'
+  spec.description   = 'Diffs web pages both visually and textually.'
   spec.homepage      = "https://github.com/alphagov/govuk-diff-pages"
   spec.license       = "MIT"
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

data/jenkins.sh

@@ -0,0 +1,18 @@
+#!/bin/bash -xe
+
+# Gemfile.lock is not in source control because this is a gem
+rm -f Gemfile.lock
+
+git clean -fdx
+
+bundle install --path "${HOME}/bundles/${JOB_NAME}"
+
+if [[ ${GIT_BRANCH} != "origin/master" ]]; then
+  bundle exec govuk-lint-ruby --format clang
+fi
+
+bundle exec rake
+
+if [[ -n "$PUBLISH_GEM" ]]; then
+  bundle exec rake publish_gem
+fi

data/jenkins_branches.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+set -e
+
+VENV_PATH="${HOME}/venv/${JOB_NAME}"
+
+[ -x ${VENV_PATH}/bin/pip ] || virtualenv ${VENV_PATH}
+. ${VENV_PATH}/bin/activate
+
+pip install -q ghtools
+
+REPO="alphagov/govuk-diff-pages"
+gh-status "$REPO" "$GIT_COMMIT" pending -d "\"Build #${BUILD_NUMBER} is running on Jenkins\"" -u "$BUILD_URL" >/dev/null
+
+if ./jenkins.sh; then
+  gh-status "$REPO" "$GIT_COMMIT" success -d "\"Build #${BUILD_NUMBER} succeeded on Jenkins\"" -u "$BUILD_URL" >/dev/null
+  exit 0
+else
+  gh-status "$REPO" "$GIT_COMMIT" failure -d "\"Build #${BUILD_NUMBER} failed on Jenkins\"" -u "$BUILD_URL" >/dev/null
+  exit 1
+fi

data/lib/govuk/diff/pages.rb

@@ -19,11 +19,21 @@ module Govuk
       end
 
       def self.govuk_pages_file
-        File.expand_path(root_dir + '/../../config/govuk_pages.yml')
+        config_file 'govuk_pages.yml'
       end
 
       def self.wraith_config_file
-        File.expand_path(root_dir + '/../../config/wraith.yaml')
+        config_file 'wraith.yaml'
+      end
+
+      def self.settings_file
+        config_file 'settings.yml'
+      end
+
+    private
+
+      def self.config_file(filename)
+        File.expand_path(root_dir + "/../../config/#{filename}")
       end
     end
   end

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

@@ -16,7 +16,7 @@ module Govuk
           if path_or_hash.is_a?(Hash)
             @config = populate_config(path_or_hash)
           else
-            path_or_hash ||= "#{Govuk::Diff::Pages.root_dir}/config/settings.yml"
+            path_or_hash ||= Govuk::Diff::Pages.settings_file
             hash = YAML.load_file(path_or_hash)
             @config = populate_config(hash)
           end
@@ -43,6 +43,7 @@ module Govuk
         end
 
       private
+
         def populate_config(hash)
           config = OpenStruct.new
           hash.each do |key, value|

data/lib/govuk/diff/pages/html_diff/differ.rb

@@ -18,7 +18,7 @@ module Govuk
           def initialize(config)
             @config = config
             @template = File.read "#{Govuk::Diff::Pages.root_dir}/diff/pages/html_diff/assets/html_diff_template.erb"
-            @diff_dir = "#{Govuk::Diff::Pages.root_dir}/#{@config.html_diff.directory}"
+            @diff_dir = File.join(Govuk::Diff::Pages.root_dir, '..', '..', @config.html_diff.directory)
             reset_html_diffs_dir
             @differing_pages = {}
           end
@@ -34,6 +34,7 @@ module Govuk
           end
 
         private
+
           def reset_html_diffs_dir
             Dir.mkdir(@diff_dir) unless Dir.exist?(@diff_dir)
             FileUtils.rm Dir.glob("#{@diff_dir}/*")
@@ -47,7 +48,7 @@ module Govuk
           end
 
           def html_diff_filename(base_path)
-            "#{Govuk::Diff::Pages.root_dir}/#{@config.html_diff.directory}/#{safe_filename(base_path)}.html"
+            File.join(@diff_dir, "#{safe_filename(base_path)}.html")
           end
 
           def safe_filename(base_path)

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

@@ -22,9 +22,10 @@ module Govuk
           end
 
         private
+
           def create_gallery_page
             @result_hash = @differ.differing_pages
-            shots_dir = "#{Govuk::Diff::Pages.root_dir}/#{@config.html_diff.directory}"
+            shots_dir = File.join(Govuk::Diff::Pages.root_dir, "..", "..", @config.html_diff.directory)
             Dir.mkdir(shots_dir) unless Dir.exist?(shots_dir)
             renderer = ERB.new(@gallery_template)
             File.open("#{shots_dir}/gallery.html", "w") do |fp|

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

@@ -19,6 +19,7 @@ module Govuk
         end
 
       private
+
         def print_results
           puts "Number of pages checked: #{@num_links}"
           puts "  of which:"

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

@@ -6,7 +6,7 @@ module Govuk
       class PageIndexer
         def initialize
           @pages = []
-          @config = AppConfig.new("#{Govuk::Diff::Pages.root_dir}/config/settings.yml")
+          @config = AppConfig.new(Govuk::Diff::Pages.settings_file)
         end
 
         def run
@@ -18,6 +18,7 @@ module Govuk
         end
 
       private
+
         def get_formats
           @formats = FormatSearcher.new(@config).run
         end

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

@@ -25,6 +25,7 @@ module Govuk
         end
 
       private
+
         def top_pages_for_format(format)
           result_set = JSON.parse(result_set_for_format(format))
           extract_top_govuk_pages(result_set)

data/lib/govuk/diff/pages/tasks/rakefile.rake

@@ -4,7 +4,7 @@ namespace :diff do
   desc 'produce visual diffs'
   task visual: ['config:pre_flight_check'] do
     puts "---> Creating Visual Diffs"
-    cmd = "wraith capture #{Govuk::Diff::Pages::WRAITH_CONFIG_FILE}"
+    cmd = "wraith capture #{Govuk::Diff::Pages.wraith_config_file}"
     puts cmd
     system cmd
   end
@@ -40,7 +40,7 @@ namespace :config do
   task :pre_flight_check do
     puts "Checking required packages installed."
     dependencies_present = true
-    {imagemagick: 'convert', phantomjs: 'phantomjs'}.each do |package, binary|
+    { imagemagick: 'convert', phantomjs: 'phantomjs' }.each do |package, binary|
       print "#{package}..... "
       result = %x[ which #{binary} ]
       if result.empty?

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

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

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

@@ -25,7 +25,7 @@ module Govuk
         end
 
         def save
-          File.open(WRAITH_CONFIG_FILE, 'w') do |fp|
+          File.open(Govuk::Diff::Pages.wraith_config_file, 'w') do |fp|
             fp.puts YAML.dump(@wraith_config)
           end
         end
@@ -35,6 +35,7 @@ module Govuk
         end
 
       private
+
         def validate_hard_coded_pages
           errors = []
           @config.hard_coded_pages.to_h.each do |_key, url|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk-diff-pages
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ben Lovell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-16 00:00:00.000000000 Z
+date: 2016-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diffy
@@ -132,14 +132,16 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
+- CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - config/settings.yml
 - docs/screenshots/gallery.png
 - govuk-diff-pages.gemspec
+- jenkins.sh
+- jenkins_branches.sh
 - lib/govuk/diff/pages.rb
 - lib/govuk/diff/pages/app_config.rb
 - lib/govuk/diff/pages/format_searcher.rb