adamh-html_render 0.0.1 → 0.0.2

data/Manifest

@@ -5,4 +5,6 @@ lib/html_render.rb
 lib/html_render/render_batches.rb
 lib/html_render/renderers.rb
 lib/html_render/images.rb
+lib/html_render/render_test.rb
+lib/html_render/render_test/rails.rb
 Manifest

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('html_render', '0.0.1') do |p|
+Echoe.new('html_render', '0.0.2') do |p|
   p.description = 'Make images from HTML strings'
   p.url = 'http://adamhooper.com/eng'
   p.author = 'Adam Hooper'

data/html_render.gemspec

@@ -1,27 +1,29 @@
+# -*- encoding: utf-8 -*-
+
 Gem::Specification.new do |s|
   s.name = %q{html_render}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Adam Hooper"]
-  s.date = %q{2009-03-06}
+  s.date = %q{2009-04-01}
   s.description = %q{Make images from HTML strings}
   s.email = %q{adam@adamhooper.com}
-  s.extra_rdoc_files = ["README.rdoc", "lib/html_render.rb", "lib/html_render/render_batches.rb", "lib/html_render/renderers.rb", "lib/html_render/images.rb"]
-  s.files = ["README.rdoc", "Rakefile", "html_render.gemspec", "lib/html_render.rb", "lib/html_render/render_batches.rb", "lib/html_render/renderers.rb", "lib/html_render/images.rb", "Manifest"]
+  s.extra_rdoc_files = ["README.rdoc", "lib/html_render.rb", "lib/html_render/render_batches.rb", "lib/html_render/renderers.rb", "lib/html_render/images.rb", "lib/html_render/render_test.rb", "lib/html_render/render_test/rails.rb"]
+  s.files = ["README.rdoc", "Rakefile", "html_render.gemspec", "lib/html_render.rb", "lib/html_render/render_batches.rb", "lib/html_render/renderers.rb", "lib/html_render/images.rb", "lib/html_render/render_test.rb", "lib/html_render/render_test/rails.rb", "Manifest"]
   s.has_rdoc = true
   s.homepage = %q{http://adamhooper.com/eng}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Html_render", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{html_render}
-  s.rubygems_version = %q{1.2.0}
+  s.rubygems_version = %q{1.3.1}
   s.summary = %q{Make images from HTML strings}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 2
 
-    if current_version >= 3 then
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<httpclient>, [">= 2.1.4"])
       s.add_runtime_dependency(%q<rmagick>, [">= 2.9.1"])
       s.add_development_dependency(%q<echoe>, [">= 0"])

data/lib/html_render/images.rb

@@ -23,7 +23,8 @@ module HTMLRender::Images
     end
 
     def <=>(other)
-      (png <=> other.png) == 0
+      self.class.name <=> other.class.name unless PNGImage === other
+      png <=> other.png
     end
 
     def difference(other)

data/lib/html_render/render_test/rails.rb

@@ -0,0 +1,99 @@
+require 'action_controller/test_process'
+require 'action_view/test_case'
+
+require 'html_render/render_test'
+
+module HTMLRender; end
+module HTMLRender::RenderTest; end
+
+module HTMLRender::RenderTest::Rails
+  class RenderTest < HTMLRender::RenderTest::DirectoryRenderTest
+    def initialize(*args, &block)
+      super(*args, &block)
+    end
+
+    def run(*args, &block)
+      write_html_to_run_directory
+      super(*args, &block)
+    end
+
+    def html
+      @html ||= wrap_html { view.render(render_options) }
+    end
+
+    def render_options
+      {
+        template_type => template_path,
+        :locals => locals
+      }
+    end
+
+    def template_type
+      :partial
+    end
+
+    def assigns
+      {}
+    end
+
+    def locals
+      {}
+    end
+
+    # Wraps the rendered HTML to create a fully-valid XHTML 1.0 page which
+    # may be rendered.
+    #
+    # Override the +css+ or +javascript+ methods to include CSS or
+    # JavaScript in the output. (Most Rails project testing frameworks will
+    # rely upon a subclass of this RenderTest with css returning the
+    # project's entire CSS library.)
+    def wrap_html
+      <<-EOT
+      <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+      <html xmlns='http://www.w3.org/1999/xhtml'>
+        <head>
+          <title>Test</title>
+          <style type="text/css">
+            #{css}
+          </style>
+          <script type="text/javascript">
+            #{javascript}
+          </script>
+        </head>
+        <body>
+          #{yield}
+        </body>
+      </html>
+      EOT
+    end
+
+    def css
+      ""
+    end
+
+    def javascript
+      ""
+    end
+
+    private
+
+    def controller
+      returning(ActionView::TestCase::TestController.new) do |controller|
+        # Set @url so url_for() doesn't crash
+        request = controller.instance_variable_get(:@request)
+        controller.instance_variable_set(:@url, ActionController::UrlRewriter.new(request, {}))
+      end
+    end
+
+    def view
+      ActionView::Base.new(ActionController::Base.view_paths, assigns, controller)
+    end
+
+    def write_html_to_run_directory
+      last_run_html_file = File.join(run_path, 'html.html')
+      File.open(last_run_html_file, 'w') do |f|
+        f.write(html)
+      end
+    end
+  end
+end

data/lib/html_render/render_test.rb

@@ -0,0 +1,194 @@
+require 'html_render/images'
+require 'html_render/render_batches'
+
+module HTMLRender; end
+module HTMLRender::RenderTest
+  # Result of a RenderTest::run() call
+  class Result
+    # The portion of a result specific to an individual server
+    class ServerResult
+      attr_reader :server, :expected, :actual
+
+      # Initializes the ServerResult.
+      #
+      # Params:
+      #   server: name of the server
+      #   expected: Image we expected
+      #   actual: Image we got
+      def initialize(server, expected, actual)
+        @server = server
+        @expected = expected
+        @actual = actual
+      end
+
+      def pass?
+        actual == expected
+      end
+
+      def difference
+        expected.difference(actual)
+      end
+    end
+
+    def servers
+      raise NotImplementedError
+    end
+
+    def details
+      returning({}) do |h|
+        servers.each do |server|
+          h[server] = details_for(server)
+        end
+      end
+    end
+
+    # Returns the ServerResult corresponding to the given Server
+    def details_for(server)
+      raise NotImplementedError
+    end
+
+    def pass?
+      @pass ||= servers.select{|s| !details_for(s).pass?}.empty?
+    end
+  end
+
+  class DirectoryResult < Result
+    attr_reader :path
+    attr_reader :valid_path
+    attr_reader :canonical_path
+
+    def initialize(path, valid_path, canonical_path)
+      @path = path
+      @valid_path = valid_path
+      @canonical_path = canonical_path
+    end
+
+    def servers
+      @servers ||= Dir.glob(File.join(path, '*.png')).collect{ |s| s.split(/\//).last[0..-5] }.sort
+    end
+
+    def details_for(server)
+      @details_for ||= {}
+      @details_for[server] ||= ServerResult.new(
+        server,
+        expected_png_for(server),
+        actual_png_for(server)
+      )
+    end
+
+    private
+
+    # Returns the PNG we actually got for the given server name
+    def actual_png_for(server)
+      @actual_png_for ||= {}
+      @actual_png_for[server] ||= begin
+        filename = filename_of_actual_png_for(server)
+        File.open(filename) do |f|
+          HTMLRender::Images::PNGImage.new(f.read)
+        end
+      end
+    end
+
+    # Returns the PNG expected of the given server name, or nil
+    def expected_png_for(server)
+      @expected_png_for ||= {}
+      @expected_png_for[server] ||= begin
+        filename = filename_of_expected_png_for(server)
+        if filename
+          File.open(filename) do |f|
+            HTMLRender::Images::PNGImage.new(f.read)
+          end
+        end
+      end
+    end
+
+    def filename_of_actual_png_for(server)
+      # Assume it exists--otherwise, "servers" wouldn't return it
+      File.join(path, "#{server}.png")
+    end
+
+    # Returns the path to the expected PNG for the given server name, or nil
+    def filename_of_expected_png_for(server)
+      specific = File.join(valid_path, "#{server}.png")
+
+      @filename_of_expected_png_for ||= {}
+      @filename_of_expected_png_for[server] ||= case
+        when File.exist?(specific) then specific
+        when File.exist?(canonical_path) then canonical_path
+        else nil
+      end
+    end
+  end
+
+  # Tests, across browsers, that some HTML renders correctly.
+  #
+  # A DirectoryRenderTest works within a particular directory in the
+  # filesystem, and it expects the following files:
+  #
+  # - html.html
+  # - canonical.png (what we want it to look like)
+  # - valid/SERVER.png for each SYSTEM (i.e., "ff3", "winxp-ie6", etc.)
+  # - runs/20080331014523/SERVER.png (at the time "run" was called)
+  #
+  # Calling run() with a hash of servers (see
+  # HtmlRender::RenderBatches::HTTPRenderBatch) will batch-render for each
+  # server, potentially throwing a
+  # HtmlRender::Renderers::HTTPRenderer::ServerError if the render fails.
+  # It will return an HtmlRender::RenderTest::Result.
+  class DirectoryRenderTest
+    attr_reader :test_path, :run_path
+
+    def initialize(test_path, run_path, &block)
+      @test_path = test_path
+      @run_path = run_path
+
+      yield(self) if block_given?
+    end
+
+    def html
+      @html ||= File.open(html_path) do |f|
+        f.read
+      end
+    end
+
+    def run(servers_hash)
+      clear_run_directory
+
+      begin
+        batch = HTMLRender::RenderBatches::HTTPRenderBatch.new(servers_hash)
+        batch.render_html_to_directory(html, run_path)
+      rescue Exception => e
+        clear_run_directory
+        raise e
+      end
+
+      last_result
+    end
+
+    # Returns the results of the last test. If the "valid" results changed
+    # since the last time run() was called, then last_result.pass? may
+    # return a different value than before (since it will compare the
+    # previously-generated actual .png's with the newer expected .png's).
+    def last_result
+      DirectoryResult.new(run_path, valid_path, canonical_path)
+    end
+
+    private
+
+    def clear_run_directory
+      FileUtils.rm(Dir.glob(File.join(run_path, '*.png')))
+    end
+
+    def html_path
+      File.join(test_path, 'html.html')
+    end
+
+    def canonical_path
+      File.join(test_path, 'canonical.png')
+    end
+
+    def valid_path
+      File.join(test_path, 'valid')
+    end
+  end
+end

data/lib/html_render/renderers.rb

@@ -15,6 +15,8 @@ module HTMLRender::Renderers
   # One should POST the HTML to the given URL, and the server should
   # respond with a PNG image.
   class HTTPRenderer < Base
+    class ServerError < Exception; end
+
     attr_accessor :url
 
     def initialize(url)
@@ -24,9 +26,12 @@ module HTMLRender::Renderers
     def render(html)
       client = HTTPClient.new
 
-      response = client.post(url, html)
+      begin
+        response = client.post(url, html)
+      end
+
       if response.status != 200
-        raise Exception.new("Unexpected HTTP server response from #{url}: #{response.inspect}")
+        raise ServerError.new("Unexpected HTTP server response from #{url}: #{response.inspect}")
       end
 
       HTMLRender::Images::PNGImage.new(response.content)

data/lib/html_render.rb

@@ -1,3 +1,4 @@
 require 'html_render/images'
 require 'html_render/renderers'
 require 'html_render/render_batches'
+require 'html_render/render_test'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: adamh-html_render
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Adam Hooper
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-06 00:00:00 -08:00
+date: 2009-04-01 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -34,7 +34,7 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: echoe
-  type: :runtime
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -54,6 +54,8 @@ extra_rdoc_files:
 - lib/html_render/render_batches.rb
 - lib/html_render/renderers.rb
 - lib/html_render/images.rb
+- lib/html_render/render_test.rb
+- lib/html_render/render_test/rails.rb
 files: 
 - README.rdoc
 - Rakefile
@@ -62,6 +64,8 @@ files:
 - lib/html_render/render_batches.rb
 - lib/html_render/renderers.rb
 - lib/html_render/images.rb
+- lib/html_render/render_test.rb
+- lib/html_render/render_test/rails.rb
 - Manifest
 has_rdoc: true
 homepage: http://adamhooper.com/eng