rspec_website_helpers 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f82f1516be5db094e3e8ba76fc96c0005a7cd248
+  data.tar.gz: 4ac8ff2be8e31885eacec3150603ca870157a7eb
+SHA512:
+  metadata.gz: 22b53d94a6b77d041b510868ab8c983aa01603c69ce99f94c1dd29929b81e2458541ab7330174ac67c453d9d1bf7e689ace722c26eda60cc5a2faf2b7f92af75
+  data.tar.gz: 242925b7a7495493000d4d5b0ebb332860b6d4868088bf1a3ae307e12e4f0600826b7fd3c06c433e3c3212d39b8a89f199baba239fd8512235900428852782f3

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec_website_helpers.gemspec
+gemspec

data/README.md

@@ -0,0 +1,36 @@
+# RspecWebsiteHelpers
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rspec_website_helpers`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec_website_helpers'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec_website_helpers
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rspec_website_helpers.
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rspec_website_helpers"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rspec_website_helpers/collect_pages.rb

@@ -0,0 +1,51 @@
+require 'set'
+require 'ostruct'
+
+module RspecWebsiteHelpers
+  module CollectPages
+  end
+end
+
+def initialize_path path
+  unless @internal_pages[path]
+    @internal_pages[path]= OpenStruct.new({fragments: Set.new, referer: Set.new})
+  end
+end
+
+def collect_targets url, context = url
+
+  @internal_pages ||= {}
+  @external_uris ||= Set.new()
+
+  visit url
+
+  current_uri= Addressable::URI.parse(current_url)
+
+  $logger.info "COLLECTING targets for #{current_uri.path}"
+
+  initialize_path current_uri.path
+
+
+  local_targets = all("a").map{|a| a[:href]} \
+    .map{|href| Addressable::URI.parse(href)} \
+    .map{|t| current_uri + t } \
+    .map(&:normalize)
+
+  local_targets.each do |target|
+    if (Capybara.app_host == target.site) and (target.path.starts_with? context)
+      unless @internal_pages [target.path]
+        initialize_path target.path
+        collect_targets target, context
+      end
+      if target.fragment.present? and ! (target.fragment =~ /.+\:.+/)
+        @internal_pages[target.path][:fragments].add target.fragment
+      end
+      @internal_pages[target.path][:referer].add current_uri.path
+    else
+      @external_uris.add(target)
+    end
+  end
+end
+
+
+

data/lib/rspec_website_helpers/matchers.rb

@@ -0,0 +1,80 @@
+require 'open3'
+require 'addressable/uri'
+require 'faraday'
+require 'rspec/expectations'
+
+RSpec::Matchers.define :pass_fragments_check do |properties|
+  match do |path|
+    @fragment_path = path
+    $logger.debug path
+    visit path
+    if current_path =~ /\/$/ or current_path =~ /html$/
+      properties.fragments.each do |fragment|
+        unless fragment =~ /^n\d+$/
+          @fragment= fragment
+          $logger.info "FRAGMENT #{fragment} in #{path}"
+          page.all("##{fragment}").count == 1
+        end
+      end
+    else
+      true
+    end
+  end
+  failure_message do |path|
+    "Expected that fragment '##{@fragment}' would be found on '#{@fragment_path}' but it was not"
+  end
+end
+
+
+RSpec::Matchers.define :pass_spellcheck do |properties|
+  match do |path|
+    visit path
+    $logger.info "SPELLCHECKING visit #{path}"
+    if current_path =~ /\/$/ or current_path =~ /html$/
+      $logger.info "SPELLCHECKING: #{path}"
+      stdin, stdout, stderr, wait_thr= Open3.popen3("hunspell -d #{HUNSPELL_BASE_DICTIONARIES} -p #{HUNSPELL_DICTIONARY_FILE}  -l")
+      page.evaluate_script('$("code").remove()')
+      page.evaluate_script('$("pre").remove()')
+      page.evaluate_script('$("sup").remove()')
+      @text = page.text
+      stdin.print @text
+      stdin.close
+      @res = stdout.read
+      @res.blank?
+    else
+      true
+    end
+  end
+  failure_message do |path|
+    "Expected that #{path} would pass the spellcheck. However, it contains:\n  #{@res} \n in its text: \n#{@text}"
+  end
+end
+
+
+RSpec::Matchers.define :pass_existence_check do |properties|
+  match do |path|
+    $logger.info "PASS_EXISTENCE_CHECK #{path}"
+    @uri = Addressable::URI.parse(Capybara.app_host) + Addressable::URI.parse(path)
+    @resp= Faraday.new().get(@uri)
+    (200..299).include? @resp.status
+  end
+  failure_message do |path|
+    "Expected that getting #{path} would be OK, but it returns #{@resp.status}"
+  end
+end
+
+
+RSpec::Matchers.define :be_an_existing_uri do
+  match do |uri|
+    unless uri.site =~ /localhost/
+      $logger.info "GET check #{uri}"
+      @resp= Faraday.new(ssl: {verify: false}).get(uri)
+      (200..399).include? @resp.status
+    else
+      true
+    end
+  end
+  failure_message do |uri|
+    "Expected that getting #{uri} would be OK, but it returns #{@resp.status}"
+  end
+end

data/lib/rspec_website_helpers/test_website.rb

@@ -0,0 +1,42 @@
+shared_context :test_website do |start_path|
+
+  before :all do
+    collect_targets start_path
+    $logger.debug internal_pages: @internal_pages
+    $logger.debug external_uris: @external_uris
+  end
+
+  it "spellchecking", type: :feature do
+    aggregate_failures "for internal pages" do
+      @internal_pages.each do |path,properties|
+        expect(path).to pass_spellcheck(properties)
+      end
+    end
+  end
+
+  it "has only existing href targets", type: :feature do
+    aggregate_failures "for internal pages" do
+      @internal_pages.each do |path,properties|
+        expect(path).to pass_existence_check(properties)
+      end
+    end
+  end
+
+  it "fragment targets exist", type: :feature do
+    aggregate_failures "for internal pages" do
+      @internal_pages.each do |path,properties|
+        expect(path).to pass_fragments_check(properties)
+      end
+    end
+  end
+
+  it "points only to existing external pages", type: :feature do
+    aggregate_failures "external pages" do
+      @external_uris.each do |external_uri|
+        expect(external_uri).to be_an_existing_uri
+      end
+    end
+  end
+
+end
+

data/lib/rspec_website_helpers/version.rb

@@ -0,0 +1,3 @@
+module RspecWebsiteHelpers
+  VERSION = '0.2.0'
+end

data/lib/rspec_website_helpers.rb

@@ -0,0 +1,8 @@
+require "rspec_website_helpers/version"
+require 'active_support/all'
+require "rspec_website_helpers/collect_pages"
+require "rspec_website_helpers/matchers"
+require "rspec_website_helpers/test_website"
+
+module RspecWebsiteHelpers
+end

data/rspec_website_helpers.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec_website_helpers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec_website_helpers"
+  spec.version       = RspecWebsiteHelpers::VERSION
+  spec.authors       = ["Thomas Schank"]
+  spec.email         = ["DrTom@schank.ch"]
+
+  spec.summary       = %q{Helpers for testing websites with rspec.}
+  spec.description   = %q{Helpers for testing websites with rspec.}
+  spec.homepage      = "https://github.com/DrTom/rspec_website_helpers.git"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency 'activesupport', '>= 4.0.0', '< 5.0.0'
+  spec.add_dependency 'addressable', '>= 2', '< 3'
+  spec.add_dependency 'rspec', '>= 3.3', '< 4'
+  spec.add_dependency 'faraday'
+
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: rspec_website_helpers
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Thomas Schank
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-29 00:00:00.000000000 Z
+dependencies:
+- !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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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'
+description: Helpers for testing websites with rspec.
+email:
+- DrTom@schank.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rspec_website_helpers.rb
+- lib/rspec_website_helpers/collect_pages.rb
+- lib/rspec_website_helpers/matchers.rb
+- lib/rspec_website_helpers/test_website.rb
+- lib/rspec_website_helpers/version.rb
+- rspec_website_helpers.gemspec
+homepage: https://github.com/DrTom/rspec_website_helpers.git
+licenses: []
+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: Helpers for testing websites with rspec.
+test_files: []