RubyGems - adamh-html_render - Versions diffs - 0.0.1 - Mend

adamh-html_render 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

data/Manifest +8 -0
data/README.rdoc +55 -0
data/Rakefile +11 -0
data/html_render.gemspec +38 -0
data/lib/html_render/images.rb +47 -0
data/lib/html_render/render_batches.rb +43 -0
data/lib/html_render/renderers.rb +35 -0
data/lib/html_render.rb +3 -0
metadata +98 -0

data/Manifest ADDED Viewed

@@ -0,0 +1,8 @@
+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

data/README.rdoc ADDED Viewed

@@ -0,0 +1,55 @@
+= html_render
+html_render translates strings of HTML into PNG images.
+The procedure is anything but magical. The process amounts to:
+0. POST the HTML to a URL which translates HTML into PNG.
+0. Read in the response.
+The benefit comes when different URLs translate HTML into PNG differently.
+With logic spanning many operating systems and web browser libraries, it is
+possible to render several different PNGs for the same HTML. We can compare
+the different PNGs to determine if our HTML is exposing a browser bug.
+== Install
+  gem install adamh-html_render --source http://gems.github.com
+== Example code
+  require 'rubygems'
+  require 'html_render'
+  ff3_renderer = HTMLRender::Renderers::HTTPRenderer.new('http://localhost:20558/ff3-linux')
+  ie6_renderer = HTMLRender::Renderers::HTTPRenderer.new('http://winxp-ie6.local:20558/ie')
+  html = '<html><body>Here is my HTML!</body></html>'
+  ff3_image = ff3_renderer.render(html)
+  ie6_image = ie6_renderer.render(html)
+  if ff3_image != ie6_image
+    puts 'Images differ! Differences recorded in diff.png'
+    diff = ff3_image.difference(ie6_image)
+    File.open('diff.png', 'w') { |f| f.write(diff.to_blob) }
+  end
+== Usefulness
+Because of different text-rendering engines, different browsers and operating
+systems will almost always produce differing PNG files. The
++HTMLRender::Images::PNGImage.difference+ method produces a graphic with which
+a person can quickly determine whether the changes are significant or not.
+The intent behind this design--producing comparison images rather than using
+fuzzy image matching--is for a manual verification process: presenting a user
+with a list of rendered images so the user can quickly determine which images
+are acceptable and which indicate a bug in the HTML (or, more commonly, a bug
+in the browser which the HTML must work around). The engineering of such a
+workflow is beyond the scope of this project.
+== Dependencies
+- httpclient >=2.1.4
+- RMagick >= 2.9.1

data/Rakefile ADDED Viewed

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+Echoe.new('html_render', '0.0.1') do |p|
+  p.description = 'Make images from HTML strings'
+  p.url = 'http://adamhooper.com/eng'
+  p.author = 'Adam Hooper'
+  p.email = 'adam@adamhooper.com'
+  p.runtime_dependencies = [ 'httpclient >=2.1.4', 'rmagick >=2.9.1' ]
+end

data/html_render.gemspec ADDED Viewed

@@ -0,0 +1,38 @@
+Gem::Specification.new do |s|
+  s.name = %q{html_render}
+  s.version = "0.0.1"
+  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.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.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.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
+      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"])
+    else
+      s.add_dependency(%q<httpclient>, [">= 2.1.4"])
+      s.add_dependency(%q<rmagick>, [">= 2.9.1"])
+      s.add_dependency(%q<echoe>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<httpclient>, [">= 2.1.4"])
+    s.add_dependency(%q<rmagick>, [">= 2.9.1"])
+    s.add_dependency(%q<echoe>, [">= 0"])
+  end
+end

data/lib/html_render/images.rb ADDED Viewed

@@ -0,0 +1,47 @@
+require 'RMagick'
+require 'tempfile'
+module HTMLRender; end
+module HTMLRender::Images
+  class Base
+    def ==(other)
+      return false unless self.class === other
+      (self <=> other) == 0
+    end
+    def difference(other)
+      raise NotImplementedError
+    end
+  end
+  class PNGImage < Base
+    attr_reader :png
+    def initialize(data)
+      @png = Magick::Image.from_blob(data)[0]
+    end
+    def <=>(other)
+      (png <=> other.png) == 0
+    end
+    def difference(other)
+      raise NotImplementedError unless PNGImage === other
+      rows = [ png.rows, other.png.rows ].max
+      columns = [ png.columns, other.png.columns ].max
+      image = Magick::Image.new(columns, rows) do |info|
+        info.format = 'png'
+      end
+      image.background_color = 'black'
+      image.composite!(png, 0, 0, Magick::OverCompositeOp)
+      image.composite!(other.png, 0, 0, Magick::DifferenceCompositeOp)
+    end
+    def to_blob
+      png.to_blob
+    end
+  end
+end

data/lib/html_render/render_batches.rb ADDED Viewed

@@ -0,0 +1,43 @@
+require 'html_render/renderers'
+module HTMLRender; end
+module HTMLRender::RenderBatches
+  class HTTPRenderBatch
+    attr_reader :servers
+    # +servers+: Hash of (String) key to (String) URL to pass to
+    #            HTTPRenderer
+    def initialize(servers)
+      @servers = servers
+    end
+    # +html+: HTML to render
+    # +directory+: Directory in which to dump PNG files (one per server)
+    def render_html_to_directory(html, directory)
+      threads = create_threads(html, directory)
+      threads.each { |t| t.join }
+    end
+    private
+    def create_threads(html, dir)
+      threads = []
+      servers.each do |key, url|
+        threads << create_thread(html, url, File.join(dir, "#{key}.png"))
+      end
+      threads
+    end
+    def create_thread(html, url, filename)
+      Thread.new(html, url, filename) do |html, url, filename|
+        renderer = HTMLRender::Renderers::HTTPRenderer.new(url)
+        image = renderer.render(html)
+        File.open(filename, 'w') do |f|
+          f.write(image.to_blob)
+        end
+      end
+    end
+  end
+end

data/lib/html_render/renderers.rb ADDED Viewed

@@ -0,0 +1,35 @@
+require 'httpclient'
+require 'html_render/images'
+module HTMLRender; end
+module HTMLRender::Renderers
+  class Base
+    def render(html)
+      raise NotImplementedError
+    end
+  end
+  # Renders using an HTTP server built for the very purpose.
+  #
+  # One should POST the HTML to the given URL, and the server should
+  # respond with a PNG image.
+  class HTTPRenderer < Base
+    attr_accessor :url
+    def initialize(url)
+      @url = url
+    end
+    def render(html)
+      client = HTTPClient.new
+      response = client.post(url, html)
+      if response.status != 200
+        raise Exception.new("Unexpected HTTP server response from #{url}: #{response.inspect}")
+      end
+      HTMLRender::Images::PNGImage.new(response.content)
+    end
+  end
+end

data/lib/html_render.rb ADDED Viewed

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

metadata ADDED Viewed

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: adamh-html_render
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adam Hooper
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2009-03-06 00:00:00 -08:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  type: :runtime
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+    version:
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  type: :runtime
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.9.1
+    version:
+- !ruby/object:Gem::Dependency
+  name: echoe
+  type: :runtime
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: "0"
+    version:
+description: Make images from HTML strings
+email: adam@adamhooper.com
+executables: []
+extensions: []
+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
+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
+has_rdoc: true
+homepage: http://adamhooper.com/eng
+post_install_message:
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --title
+- Html_render
+- --main
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "1.2"
+  version:
+requirements: []
+rubyforge_project: html_render
+rubygems_version: 1.2.0
+signing_key:
+specification_version: 2
+summary: Make images from HTML strings
+test_files: []