site_health 0.1.0 → 0.2.0

data/lib/site_health/url_map.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module SiteHealth
+  # Hash-like data structure that holds URI as keys and can be accessed using
+  # an URI instance or the String representation
+  class UrlMap
+    include Enumerable
+
+    def initialize
+      @data = if block_given?
+                Hash.new { |hash, key| hash[key] = yield }
+              else
+                {}
+              end
+    end
+
+    # @yieldparam [Object] value for key
+    # @return [Enumerator] data
+    def each
+      @data.each do |key, value|
+        yield(key, value) if block_given?
+      end
+    end
+
+    # @return [Object] value for key
+    def [](key)
+      @data[key.to_s]
+    end
+
+    # Sets value for key
+    # @return [Object] value for key
+    def []=(key, value)
+      @data[key.to_s] = value
+    end
+
+    # @return [Hash] hash representation of data
+    def to_h
+      @data
+    end
+  end
+end

data/lib/site_health/version.rb

@@ -1,3 +1,12 @@
+# frozen_string_literal: true
+
 module SiteHealth
-  VERSION = "0.1.0"
+  # Patch version
+  PATCH = 0
+  # Minor version
+  MINOR = 2
+  # Major version
+  MAJOR = 0
+  # Current version
+  VERSION = [MAJOR, MINOR, PATCH].join('.').freeze
 end

data/lib/site_health/{journals/w3c_journal.rb → w3c_journal_builder.rb}

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module SiteHealth
+  # Holds WC3Validator errors/warnings data
   W3CJournal = KeyStruct.new(
     :message,
     :value,
@@ -17,8 +20,9 @@ module SiteHealth
     :skipped_string
   )
 
+  # Build a W3CJournal object
   module W3CJournalBuilder
-    # @param [W3CValidators::Result]
+    # @param [W3CValidators::Result] result
     # @return [W3CJournal]
     def self.build(result)
       W3CJournal.new(

data/site_health.gemspec

@@ -1,31 +1,42 @@
+# frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "site_health/version"
+require 'site_health/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "site_health"
+  spec.name          = 'site_health'
   spec.version       = SiteHealth::VERSION
-  spec.authors       = ["Jacob Burenstam"]
-  spec.email         = ["burenstam@gmail.com"]
+  spec.authors       = ['Jacob Burenstam']
+  spec.email         = ['burenstam@gmail.com']
 
-  spec.summary       = %q{Crawl a site and check various helth indicators.}
-  spec.description   = %q{Crawl a site and check various health indicators, such as: HTTP 4XX, 5XX status and valid HTML.}
-  spec.homepage      = "https://github.com/buren/site_health"
-  spec.license       = "MIT"
+  spec.summary       = 'Crawl a site and check various health indicators.'
+  spec.description   = 'Crawl a site and check various health indicators, such as: HTTP 4XX, 5XX status, valid HTML/XML/JSON. Missing image alt attributes/missing HTML title/description.'
+  spec.homepage      = 'https://github.com/buren/site_health'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "spidr", "~> 0.6"
-  spec.add_dependency "w3c_validators", "~> 1.3"
+  spec.add_dependency 'spidr', '~> 0.6'
 
-  spec.add_development_dependency "bundler", "~> 1.16.a"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "byebug"
+  # Optional runtime dependencies
+  spec.add_development_dependency 'google-api-client', '~> 0.19'
+  spec.add_development_dependency 'html-proofer', '~> 3.8'
+  spec.add_development_dependency 'w3c_validators', '~> 1.3'
+
+  # Development dependencies
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '0.14.1'
+  spec.add_development_dependency 'timecop', '~> 0.9'
+  spec.add_development_dependency 'vcr', '~> 4.0'
+  spec.add_development_dependency 'webmock', '~> 3.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: site_health
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jacob Burenstam
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-24 00:00:00.000000000 Z
+date: 2018-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spidr
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: html-proofer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: w3c_validators
   requirement: !ruby/object:Gem::Requirement
@@ -31,7 +59,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -44,14 +72,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.a
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.a
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: 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: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -81,46 +137,113 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.1
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
 description: 'Crawl a site and check various health indicators, such as: HTTP 4XX,
-  5XX status and valid HTML.'
+  5XX status, valid HTML/XML/JSON. Missing image alt attributes/missing HTML title/description.'
 email:
 - burenstam@gmail.com
-executables: []
+executables:
+- site_health
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".ruby-style-guide.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- exe/site_health
 - lib/site_health.rb
-- lib/site_health/checkers/css_page.rb
-- lib/site_health/checkers/html_page.rb
-- lib/site_health/checkers/xml_page.rb
-- lib/site_health/journals/css_journal.rb
-- lib/site_health/journals/html_journal.rb
-- lib/site_health/journals/w3c_journal.rb
-- lib/site_health/journals/xml_journal.rb
+- lib/site_health/check_data.rb
+- lib/site_health/checkers/checker.rb
+- lib/site_health/checkers/facebook_share_link.rb
+- lib/site_health/checkers/google_page_speed.rb
+- lib/site_health/checkers/html_proofer.rb
+- lib/site_health/checkers/json_syntax.rb
+- lib/site_health/checkers/missing_description.rb
+- lib/site_health/checkers/missing_title.rb
+- lib/site_health/checkers/page_not_found.rb
+- lib/site_health/checkers/redirect.rb
+- lib/site_health/checkers/w3c_css.rb
+- lib/site_health/checkers/w3c_html.rb
+- lib/site_health/checkers/xml.rb
+- lib/site_health/configuration/configuration.rb
+- lib/site_health/configuration/html_proofer_configuration.rb
+- lib/site_health/configuration/w3c_validators_configuration.rb
+- lib/site_health/event_emitter.rb
+- lib/site_health/issue.rb
+- lib/site_health/issues.rb
+- lib/site_health/issues_report.rb
 - lib/site_health/key_struct.rb
+- lib/site_health/link.rb
+- lib/site_health/null_logger.rb
+- lib/site_health/nurse.rb
+- lib/site_health/summarizers/page_size_summarizer.rb
+- lib/site_health/timer.rb
+- lib/site_health/url_map.rb
 - lib/site_health/version.rb
+- lib/site_health/w3c_journal_builder.rb
 - site_health.gemspec
 homepage: https://github.com/buren/site_health
 licenses:
@@ -142,8 +265,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Crawl a site and check various helth indicators.
+summary: Crawl a site and check various health indicators.
 test_files: []

data/lib/site_health/checkers/css_page.rb

@@ -1,36 +0,0 @@
-module SiteHealth
-  module Checkers
-    class CSSPage
-      def self.check(page)
-        new(page).check
-      end
-
-      attr_reader :page, :url
-
-      # @param [Spidr::Page] the crawled page
-      def initialize(page)
-        @page = page
-        @url = page.url
-      end
-
-      def check
-        result = check_content
-
-        CSSJournal.new(
-          url: url,
-          page: page,
-          errors: result.errors.map { |e| W3CJournalBuilder.build(e) },
-          warnings: result.warnings.map { |e| W3CJournalBuilder.build(e) }
-        )
-      end
-
-      # @return [W3CValidators::Results]
-      # @raise [W3CValidators::ValidatorUnavailable] the service is offline or returns 400 Bad Request
-      # @see https://github.com/w3c-validators/w3c_validators/issues/39 we really want to use #validate_text instead of #validate_uri but due to the linked issue thats not possible
-      def check_content
-        validator = W3CValidators::CSSValidator.new
-        validator.validate_uri(url)
-      end
-    end
-  end
-end

data/lib/site_health/checkers/html_page.rb

@@ -1,41 +0,0 @@
-module SiteHealth
-  module Checkers
-    class HTMLPage
-      def self.check(page)
-        new(page).check
-      end
-
-      attr_reader :page, :url
-
-      # @param [Spidr::Page] the crawled page
-      def initialize(page)
-        @page = page
-        @url = page.url
-      end
-
-      def check
-        result = check_content
-
-        HTMLJournal.new(
-          url: url,
-          page: page,
-          missing_title: missing_title?,
-          errors: result.errors.map { |e| W3CJournalBuilder.build(e) },
-          warnings: result.warnings.map { |e| W3CJournalBuilder.build(e) }
-        )
-      end
-
-      def missing_title?
-        page.title.to_s.strip.empty?
-      end
-
-      # @return [W3CValidators::Results]
-      # @raise [W3CValidators::ValidatorUnavailable] the service is offline or returns 400 Bad Request
-      # @see https://github.com/w3c-validators/w3c_validators/issues/39 we really want to use #validate_text instead of #validate_uri but due to the linked issue thats not possible
-      def check_content
-        validator = W3CValidators::NuValidator.new
-        validator.validate_uri(url)
-      end
-    end
-  end
-end