adeptware-lindo 0.6

data/CHANGELOG

@@ -0,0 +1,3 @@
+6/29/09 - Added scrubbing of relative asset paths [Matthew Bass]
+
+5/20/09 - Forked from vizres [Matthew Bass]

data/MIT-LICENSE

@@ -0,0 +1,16 @@
+Copyright (c) 2007-2009 Adeptware, Inc. (http://adeptware.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software
+and associated documentation files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or
+substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
+BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,81 @@
+= lindo
+
+Enables rendering of the body of an HTTP response from inside controller and
+integration tests. This makes it easy to diagnose problems when building
+assert_select statements or just sanity check the output of the test.
+
+== Installation
+  
+Install the gem directly:
+
+  sudo gem install adeptware-lindo --source=http://gems.github.com
+
+Or install the gem in your Rails project:
+
+  script/plugin install git://github.com/adeptware/lindo.git
+
+Then require lindo in your test_helper.rb or spec_helper.rb file:
+
+  require 'lindo'
+
+You may also have to extend the Lindo module from your test or spec
+helper if you use sessions in your integration tests:
+
+  session.extend Lindo
+
+== Usage
+
+Insert the vr method in your functional test immediately after an HTTP
+request has been sent:
+
+  def test_new
+    post :new
+    vr
+    assert_select "div[id=header]"
+  end
+
+vr attempts to open the response body in the default web browser. If you want
+to open the raw HTML in the default text editor instead, simply pass the :html
+symbol to the method:
+
+  def test_new
+    post :new
+    vr(:html)
+    ...
+  end
+
+By default, vr looks for an instance variable named @response and calls the #body
+method on it. If your page body is stored in a different variable, such as when
+testing a mailer, you can pass the raw HTML directly to vr and it will do the
+right thing:
+
+  def test_mailer
+    mail = Mailer.create_notification
+    vr(mail.body)
+    ...
+  end
+
+Note that to use the default web view, your Rails application must be running
+locally on port 3000. This will ensure that the page renders correctly with the
+appropriate images and stylesheets. The server doesn't need to be running if
+you use the HTML-only view.
+
+== Compatibility
+
+lindo requires OS X. Support for Windows is planned.
+
+test/spec and test/unit work fine with lindo. RSpec, however, tests views
+independently of controllers, so lindo won't work with it.
+
+== Running Unit Tests
+
+Use the rake command to run the unit tests for the plugin. The tests require
+that the Mocha gem be installed locally:
+
+  sudo gem install mocha
+
+== Resources
+
+Repository: http://github.com/adeptware/lindo/
+Blog: http://adeptware.com/blog
+Author: Adeptware, Inc.

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the lindo plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the lindo plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Lindo'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/lindo.rb

@@ -0,0 +1,45 @@
+require 'test/unit'
+require 'lindo/browser'
+
+module Lindo
+  TMP = File.join(RAILS_ROOT, "tmp", "lindo")
+  RESPONSE_TXT = File.join(TMP, "response.txt")
+  RESPONSE_HTML = File.join(TMP, "response.html")
+  ASSETS = %w(images stylesheets javascripts)
+
+  def vr(format=:web)
+    create_tmp_dir
+    copy_assets
+    if format.is_a?(Symbol)
+      case format
+        when :web  then open_from_file(@response.body, RESPONSE_HTML)
+        when :html then open_from_file(@response.body, RESPONSE_TXT)
+      end
+    else
+      open_from_file(format, RESPONSE_HTML)
+    end
+  end
+  
+  def create_tmp_dir
+    FileUtils.mkdir_p(TMP) unless File.exists?(TMP)
+  end
+  
+  def copy_assets
+    ASSETS.each do |e|
+      dir = File.join(RAILS_ROOT, "public", e)
+      FileUtils.cp_r(dir, TMP) if File.exists?(dir)
+    end
+  end
+
+  def open_from_file(data, file)
+    scrub(data)
+    File.open(file, File::CREAT|File::TRUNC|File::WRONLY) { |f| f << data }
+    Browser.open(file)
+  end
+  
+  def scrub(data)
+    ASSETS.each { |e| data.gsub!("=\"/#{e}/", "=\"#{e}/") }
+  end
+end
+
+Test::Unit::TestCase.send(:include, Lindo)

data/lib/lindo/browser.rb

@@ -0,0 +1,47 @@
+module Lindo
+  class Browser
+    class << self
+      
+      def open(url)
+        if macos?
+          `/usr/bin/open #{url}`
+        elsif windows?
+          `'C:\Program Files\Internet Explorer\IEXPLORE.EXE' #{url}`
+        elsif gnome?
+          `gnome-open #{url}`
+        elsif kde?
+          `kfmclient openURL #{url}`
+        elsif linux?
+          `firefox #{url}` #not the default browser.
+        else
+          raise "Unrecognized OS. Browser can't be found."
+        end
+      end
+      
+      def host
+        require 'rbconfig'
+        Config::CONFIG['host']
+      end
+      
+      def macos?
+        host.include?('darwin')
+      end
+      
+      def windows?
+        host.include?('mswin')
+      end
+      
+      def gnome?
+        Kernel.system("which gnome-open")
+      end
+      
+      def kde?
+        Kernel.system("which kfmclient")
+      end
+
+      def linux?
+        host.include?('linux')
+      end
+    end
+  end
+end

data/lindo.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |s|
+  s.name     = "lindo"
+  s.version  = "0.6"
+  s.date     = "2009-06-30"
+  s.summary  = "Enables rendering of the body of an HTTP response from inside a functional test."
+  s.email    = "contact@adeptware.com"
+  s.homepage = "http://github.com/adeptware/lindo"
+  s.description = "Enables rendering of the body of an HTTP response from inside a functional test. " <<
+                  "This makes it easy to diagnose problems when building assert_select statements " <<
+                  "or just sanity check the output of the test."
+  s.has_rdoc = true
+  s.authors  = ["Adeptware"]
+  s.files    = [
+    "CHANGELOG",
+    "MIT-LICENSE",
+    "Rakefile",
+		"README",
+		"lindo.gemspec",
+		"lib/lindo.rb",
+		"lib/lindo/browser.rb",
+		"test/lindo_test.rb",
+		"test/lindo/browser_test.rb"
+		]
+  s.rdoc_options = ["--main", "README"]
+  s.extra_rdoc_files = ["README"]
+end

data/test/lindo/browser_test.rb

@@ -0,0 +1,104 @@
+require 'test/unit'
+require 'rubygems'
+require 'mocha'
+
+RAILS_ROOT = '.'
+require 'lindo'
+
+class BrowserTest < Test::Unit::TestCase
+  
+  def z_test_open_on_macos # TODO
+    Browser.expects(:gnome?).returns(false)
+    Browser.expects(:kde?).returns(false)
+    Browser.expects(:macos?).returns(true)
+    Browser.expects(:system).with("open foo")
+    Browser.open("foo")
+  end
+  
+  def z_test_open_on_windows # TODO
+    Browser.expects(:gnome?).returns(false)
+    Browser.expects(:kde?).returns(false)
+    Browser.expects(:macos?).returns(false)
+    Browser.expects(:windows?).returns(true)
+    Browser.expects(:system).with("'C:\Program Files\Internet Explorer\IEXPLORE.EXE' foo")
+    Browser.open("foo")
+  end
+  
+  def z_test_open_on_kde # TODO
+    Browser.expects(:gnome?).returns(false)
+    Browser.expects(:kde?).returns(true)
+    Browser.expects(:macos?).returns(false)
+    Browser.expects(:windows?).returns(false)
+    Browser.expects(:linux?).returns(false)
+    Browser.expects(:system).with("kfmclient openURL foo")
+    Browser.open("foo")
+  end
+
+  def z_test_open_on_gnome # TODO
+    Browser.expects(:gnome?).returns(true)
+    Browser.expects(:kde?).returns(false)
+    Browser.expects(:macos?).returns(false)
+    Browser.expects(:windows?).returns(false)
+    Browser.expects(:linux?).returns(false)
+    Browser.expects(:system).with("gnome-open foo")
+    Browser.open("foo")
+  end
+
+  def z_test_open_on_gnome # TODO
+    Browser.expects(:gnome?).returns(false)
+    Browser.expects(:kde?).returns(false)
+    Browser.expects(:macos?).returns(false)
+    Browser.expects(:windows?).returns(false)
+    Browser.expects(:linux?).returns(true)
+    Browser.expects(:system).with("firefox foo")
+    Browser.open("foo")
+  end
+  
+  def test_open_with_unrecognized_os
+    Browser.expects(:gnome?).returns(false)
+    Browser.expects(:kde?).returns(false)
+    Browser.expects(:macos?).returns(false)
+    Browser.expects(:windows?).returns(false)
+    Browser.expects(:linux?).returns(false)
+    Browser.open("foo")
+    flunk "Exception should have been thrown"
+  rescue Exception => e
+    assert_equal "Unrecognized OS. Browser can't be found.", e.message
+  end
+  
+  def test_host
+    Config::CONFIG.expects(:[]).with("host").returns("foo")
+    assert_equal "foo", Browser.host
+  end
+  
+  def test_macos?
+    Browser.expects(:host).returns("darwin")
+    assert Browser.macos?
+  end
+  
+  def test_not_macos?
+    Browser.expects(:host).returns("bogus")
+    assert !Browser.macos?
+  end
+  
+  def test_windows?
+    Browser.expects(:host).returns("mswin")
+    assert Browser.windows?
+  end
+  
+  def test_not_windows?
+    Browser.expects(:host).returns("bogus")
+    assert !Browser.windows?
+  end
+  
+  def test_linux?
+    Browser.expects(:host).returns("linux")
+    assert Browser.linux?
+  end
+  
+  def test_not_linux?
+    Browser.expects(:host).returns("bogus")
+    assert !Browser.linux?
+  end
+  
+end

data/test/lindo_test.rb

@@ -0,0 +1,48 @@
+require 'test/unit'
+require 'fileutils'
+require 'rubygems'
+require 'mocha'
+require 'lindo'
+
+class LindoTest < Test::Unit::TestCase
+  
+  # class Response
+  #   attr_accessor :body
+  # end
+  # 
+  # def test_foo
+  #   response = Response.new
+  #   response.body = "<html>FOO</html>"
+  #   @response = response
+  #   vr(:html)
+  # end
+  
+  def setup
+    @response = stub(:body => "<html></html>")
+  end
+  
+  def test_vr
+    File.expects(:open).with(RESPONSE_HTML, File::CREAT|File::TRUNC|File::WRONLY)
+    Browser.expects(:open).with("./tmp/lindo/response.html")
+    vr
+  end
+  
+  def test_vr_in_web
+    File.expects(:open).with(RESPONSE_HTML, File::CREAT|File::TRUNC|File::WRONLY)
+    Browser.expects(:open).with("./tmp/lindo/response.html")
+    vr(:web)
+  end
+  
+  def test_vr_in_html
+    File.expects(:open).with(RESPONSE_TXT, File::CREAT|File::TRUNC|File::WRONLY)
+    Browser.expects(:open).with("./tmp/lindo/response.txt")
+    vr(:html)
+  end
+  
+  def test_vr_with_raw_html
+    File.expects(:open).with(RESPONSE_HTML, File::CREAT|File::TRUNC|File::WRONLY)
+    Browser.expects(:open).with("./tmp/lindo/response.html")
+    vr("<html></html>")
+  end
+  
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: adeptware-lindo
+version: !ruby/object:Gem::Version 
+  version: "0.6"
+platform: ruby
+authors: 
+- Adeptware
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-30 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Enables rendering of the body of an HTTP response from inside a functional test. This makes it easy to diagnose problems when building assert_select statements or just sanity check the output of the test.
+email: contact@adeptware.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- CHANGELOG
+- MIT-LICENSE
+- Rakefile
+- README
+- lindo.gemspec
+- lib/lindo.rb
+- lib/lindo/browser.rb
+- test/lindo_test.rb
+- test/lindo/browser_test.rb
+has_rdoc: true
+homepage: http://github.com/adeptware/lindo
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+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: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Enables rendering of the body of an HTTP response from inside a functional test.
+test_files: []
+