peek-a-view 0.0.3 → 0.0.4

data/README.md

@@ -1,7 +1,5 @@
 # PeekAView
 
-Experimental software ahead! Use with caution, if at all.
-
 ## What?
 
 This gem provides a Rails engine adds functionality to an application
@@ -56,4 +54,47 @@ Start your rails application and point your browser at
 If everything went well, you see a list of links to your views.
 
 
+## Checking & Reporting
+
+Peek-a-View includes a few Rake tasks and their support code for
+checking the stubbed views with. Currently supported are
+
+* the HTML5 validator from http://validator.nu/
+* YSlow
+
+The checkers are available through these tasks
+
+    rake peek-a-view:check         # Run all checks
+    rake peek-a-view:check:html    # Check view markup with validator.nu
+    rake peek-a-view:check:speed   # Check views with YSlow and generate reports
+    rake peek-a-view:report        # Run all checks and generate reports
+    rake peek-a-view:report:html   # Check view markup with validator.nu and generate reports
+    rake peek-a-view:report:speed  # Check views with YSlow and generate reports
+
+Checks write their output to the console, reports generate xUnit-style (aka surefire)
+reports in reports/html_validator and reports/yslow respectively.
+
+These tasks have dependencies that are not explicitly declared for this gems.
+This is to avoid dragging in gems for task that you may not want to use.
+
+### Requirements for HTML5 checking/reporting
+
+HTML5 checks require at instance of Validator.nu to be available at
+http://localhost:8888/ or whatever URI the environment variable HTML_VALIDATOR
+contains.
+
+You can obtain the sources for the validator from
+http://about.validator.nu/#src
+
+
+### YSlow
+
+YSlow runs as a JavaScript in the headless browser PhantomJS.
+A version of the YSlow script itself is packaged with this gem.
+To use it, you need to install PhantomJS
+
+http://code.google.com/p/phantomjs/
+
+
+
 This project rocks and uses MIT-LICENSE.

data/lib/peek_a_view/tools/checker.rb

@@ -15,13 +15,6 @@ module PeekAView
 
       protected
 
-      def print_hash(out, title, hash)
-        out.puts title
-        hash.each do |k, v|
-          out.puts "#{k}: #{v}"
-        end
-      end
-
       def report_dir
         raise NotImplementedError,
               "report_dir must be overridden in subclasses of #{self.class}."

data/lib/peek_a_view/tools/html_validator.rb

@@ -21,16 +21,28 @@ module PeekAView
       end
 
       def check(uri)
-        @validator.validate_uri(uri)
+        results = validate(uri)
+        puts "Valid: #{results.is_valid?}"
+        puts
+        puts 'Errors'
+        puts results.errors.map(&:message)
+        puts
+        puts 'Warnings'
+        puts results.warnings.map(&:message)
+        puts
       end
 
       def report(uri)
-        results = check(uri)
+        results = validate(uri)
         write_report(uri, results)
       end
 
       private
 
+      def validate(uri)
+        @validator.validate_uri(uri)
+      end
+
       def write_report(uri, results)
         xml = Builder::XmlMarkup.new(indent: 2)
         xml.instruct!

data/lib/peek_a_view/tools/yslow.rb

@@ -16,7 +16,7 @@ module PeekAView
       private
 
       def yslow_script
-        File.join(PeekAView::Engine.config.root, 'tools', 'yslow.js')
+        File.join(PeekAView::Engine.config.root, 'vendor', 'yslow.js')
       end
 
       def report_dir

data/lib/peek_a_view/version.rb

@@ -1,3 +1,3 @@
 module PeekAView
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/tasks/peek_a_view.rake

@@ -28,6 +28,17 @@ namespace 'peek-a-view' do
     end
   end
 
+  task :init_html_validator do
+    require 'peek_a_view/tools/html_validator'
+
+    validator_uri = ENV['HTML_VALIDATOR'] || 'http://localhost:8888/'
+    @html_validator     = PeekAView::Tools::HtmlValidator.new(
+      validator_uri: validator_uri,
+      prefix:        @index_uri,
+      encoding:      Rails.configuration.encoding
+    )
+  end
+
   desc "List views served by Peek-a-View"
   task :list => :prepare do
     require 'peek_a_view/tools'
@@ -49,23 +60,47 @@ namespace 'peek-a-view' do
     end
 
     desc "Check view markup with validator.nu"
-    task :html => :prepare do
-      require 'peek_a_view/tools/html_validator'
+    task :html => [:prepare, :init_html_validator] do
+      @view_uris.each do |uri|
+        puts "-" * 70
+        puts "Validation results for #{uri}"
+        @html_validator.check(uri)
+      end
+    end
+
+    desc "Check views with YSlow and generate reports"
+    task :speed => :prepare do
+      require 'peek_a_view/tools/yslow'
+
+      yslow = PeekAView::Tools::YSlow.new(prefix: @index_uri)
+
+      @view_uris.each do |uri|
+        yslow.check(uri)
+      end
+    end
+  end
+
+
+  desc "Run all checks and generate reports"
+  task :report => 'report:run'
+
+  namespace :report do
+    task :run => [:html, :speed]
+
+    task :prepare do
+      Rake::Task['peek-a-view:prepare'].invoke
+    end
 
-      validator_uri = ENV['HTML_VALIDATOR'] || 'http://localhost:8888/'
-      validator     = PeekAView::Tools::HtmlValidator.new(
-        validator_uri: validator_uri,
-        prefix:        @index_uri,
-        encoding:      Rails.configuration.encoding
-      )
-      validator.clean_reports
+    desc "Check view markup with validator.nu and generate reports"
+    task :html => [:prepare, :init_html_validator] do
+      @html_validator.clean_reports
 
       @view_uris.each do |uri|
-        validator.report(uri)
+        @html_validator.report(uri)
       end
     end
 
-    desc "Check views with YSlow"
+    desc "Check views with YSlow and generate reports"
     task :speed => :prepare do
       require 'peek_a_view/tools/yslow'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: peek-a-view
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-28 00:00:00.000000000 Z
+date: 2012-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &11362780 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +21,12 @@ dependencies:
         version: 3.2.6
   type: :runtime
   prerelease: false
-  version_requirements: *11362780
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.6
 description: Show views using stubbed data.
 email:
 - michael@schuerig.de
@@ -84,7 +89,7 @@ files:
 - test/integration/navigation_test.rb
 - test/peek-a-view_test.rb
 - test/test_helper.rb
-- tools/yslow.js
+- vendor/yslow.js
 homepage: ''
 licenses:
 - MIT
@@ -100,7 +105,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1813702072172185498
+      hash: -984046266106858959
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -109,10 +114,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1813702072172185498
+      hash: -984046266106858959
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Look at your Rails views without bothering the application