rails-carrot 1.0.0

data/Manifest

@@ -0,0 +1,9 @@
+Manifest
+README
+Rakefile
+carrot.gemspec
+lib/carrot.rb
+lib/carrot/extend_server.rb
+lib/carrot/rails.rb
+lib/carrot/server.rb
+lib/carrot/util/timeout.rb

data/README

@@ -0,0 +1,81 @@
+You can use carrot with celerity, or another driver.
+
+1. gem 'carrot'
+
+2. add a celerity_helper
+
+3. Add some code in celerity_helper
+require 'database_cleaner' 
+require 'celerity'
+require 'carrot'
+
+ENV["RAILS_ENV"] = 'celerity' # You can change it with your enviroment
+require File.expand_path("../../config/environment", __FILE__)
+require 'rspec/rails'
+
+
+
+4. Three test styles
+a) Remote
+Carrot.configure do |config|
+  config.run_server = false
+  config.app_host = "www.google.com"
+end
+Carrot.register_driver(Celerity::Browser.new)
+
+b) Local
+Carrot.configure do |config|
+  config.run_server = true
+end
+Carrot.register_driver(Celerity::Browser.new)
+Carrot.boot
+
+c) Local, server with external ruby
+
+Carrot.configure do |config|
+  config.run_server = true
+  config.external_ruby = true
+  config.rails_command = "~/.rvm/gems/ruby-1.9.2-p0/bin/rails s -e celerity -p 3001"
+  config.project_path = "#{Rails.root}"
+  config.server_port = 3001
+  # config.server_debug = true
+end
+Carrot.register_driver(Celerity::Browser.new)
+Carrot.boot
+
+RSpec.configure do |config|
+   DatabaseCleaner.strategy = :truncation 
+  
+   config.before :each do 
+     @browser = Carrot.driver   # get native driver
+     DatabaseCleaner.clean 
+   end
+
+   config.after :all do
+     Carrot.shutdown            # shutdown server
+     DatabaseCleaner.clean 
+   end
+ 
+   config.use_transactional_fixtures = false
+
+end
+
+5 Test
+a) get url
+Carrot.url(path)
+eg:
+Carrot.url('/')        =>   http://host/
+Carrot.url('/hello')   =>   http://host/hello
+
+b) get native browser driver
+Carrot.driver
+
+6 FAQ
+a) Does Carrot support server with external ruby?
+Yes, but it just supports jruby run rspec and run server using external ruby. I use jruby to create native java process to run server using external ruby.
+
+If you want to use ruby to run rspec and run server using external ruby, you can create a new server class to support it or wait for my upgrade.
+
+
+
+

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('rails-carrot', '1.0.0') do |p|
+  p.description    = "Carrot can make QA test easy with any integration test gem."
+  p.url            = "http://github.com/sloanwu/carrot.git"
+  p.author         = "Sloan Wu"
+  p.email          = "sloanwu@gmail.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end

data/carrot.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{carrot}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Sloan Wu"]
+  s.date = %q{2010-11-02}
+  s.description = %q{Carrot can make QA test easy with any integration test gem.}
+  s.email = %q{sloanwu@gmail.com}
+  s.extra_rdoc_files = ["lib/carrot.rb", "lib/carrot/extend_server.rb", "lib/carrot/rails.rb", "lib/carrot/server.rb", "lib/carrot/util/timeout.rb"]
+  s.files = ["Manifest", "Rakefile", "carrot.gemspec", "lib/carrot.rb", "lib/carrot/extend_server.rb", "lib/carrot/rails.rb", "lib/carrot/server.rb", "lib/carrot/util/timeout.rb"]
+  s.homepage = %q{http://github.com/sloanwu/carrot.git}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Carrot", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{carrot}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Carrot can make QA test easy with any integration test gem.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/carrot/extend_server.rb

@@ -0,0 +1,59 @@
+require "java"
+require 'carrot/util/timeout'
+require 'uri'
+require 'net/http'
+require 'rack'
+import java.lang.Runtime
+import java.io.InputStreamReader
+import java.io.BufferedReader
+
+module Carrot
+  class ExtendServer
+    attr_accessor :server_process, :shutdown_process 
+     
+    def run()
+       Thread.new do
+          command = ["/bin/bash","-c", "cd #{Carrot.project_path} ; #{Carrot.rails_command}"].to_java(java.lang.String)
+          begin
+             @server_process = Runtime.getRuntime().exec(command);
+             if Carrot.server_debug
+               buf = BufferedReader.new(InputStreamReader.new(@server_process.get_input_stream))
+               while line = buf.readLine()
+                 puts line
+               end
+             end
+             @server_process.wait_for
+         rescue Exception => e
+            puts e
+         end
+
+       end
+      Carrot.timeout(60) { if responsive? then true else sleep(0.5) and false end }
+    end
+
+    def shutdown
+      Thread.new do
+          command = ["/bin/bash","-c", "cd #{Carrot.project_path} ; kill `cat #{Carrot.project_path}/tmp/pids/server.pid`"].to_java(java.lang.String)
+          begin
+             @shutdown_process = Runtime.getRuntime().exec(command);
+             @shutdown_process.wait_for
+             @shutdown_process.destroy
+         rescue Exception => e
+            puts e
+         end
+      end 
+    end
+
+    def responsive?
+     host = "127.0.0.1"
+     res = Net::HTTP.start(host, Carrot.server_port) { |http| http.get('/__identify__') }
+
+      unless res.nil?
+        return true 
+      end
+    rescue Errno::ECONNREFUSED, Errno::EBADF
+      return false 
+    end
+
+  end
+end

data/lib/carrot/rails.rb

@@ -0,0 +1,15 @@
+require 'carrot'
+
+Carrot.app = Rack::Builder.new do
+  map "/" do
+    if Rails.version.to_f >= 3.0
+      run Rails.application  
+    else # Rails 2
+      use Rails::Rack::Static
+      run ActionController::Dispatcher.new
+    end
+  end
+end.to_app
+
+Carrot.asset_root = Rails.root.join('public')
+

data/lib/carrot/server.rb

@@ -0,0 +1,96 @@
+require 'uri'
+require 'net/http'
+require 'rack'
+require 'carrot/util/timeout'
+require 'carrot/rails'
+
+module Carrot
+  class Server
+    class Identify
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        if env["PATH_INFO"] == "/__identify__"
+          [200, {}, @app.object_id.to_s]
+        else
+          @app.call(env)
+        end
+      end
+    end
+
+    class << self
+      def ports
+        @ports ||= {}
+      end
+    end
+
+    attr_reader :app, :port
+
+    def initialize(app)
+      @app = app
+    end
+
+    def host
+      "127.0.0.1"
+    end
+
+    def url(path)
+      if path =~ /^http/
+        path
+      else
+        (Carrot.app_host || "http://#{host}:#{Carrot.server_port || port}") + path.to_s
+      end
+    end
+
+    def responsive?
+      res = Net::HTTP.start(host, @port) { |http| http.get('/__identify__') }
+
+      if res.is_a?(Net::HTTPSuccess) or res.is_a?(Net::HTTPRedirection)
+        return res.body == @app.object_id.to_s
+      end
+    rescue Errno::ECONNREFUSED, Errno::EBADF
+      return false
+    end
+
+    def boot
+      if Carrot.external_ruby
+         require 'carrot/extend_server'
+         Carrot.external_server = ExtendServer.new
+         Carrot.external_server.run
+      elsif @app
+        @port = Carrot::Server.ports[@app.object_id]
+
+        if not @port or not responsive?
+          @port = Carrot.server_port || find_available_port
+          Carrot::Server.ports[@app.object_id] = @port
+
+          Thread.new do
+            begin
+              require 'rack/handler/thin'
+              Thin::Logging.silent = true
+              Rack::Handler::Thin.run(Identify.new(@app), :Port => @port)
+            rescue LoadError
+              require 'rack/handler/webrick'
+              Rack::Handler::WEBrick.run(Identify.new(@app), :Port => @port, :AccessLog => [], :Logger => WEBrick::Log::new(nil, 0))
+            end
+          end
+
+          Carrot.timeout(10) { if responsive? then true else sleep(0.5) and false end }
+        end
+      end
+    end
+
+
+  private
+
+    def find_available_port
+      server = TCPServer.new('127.0.0.1', 0)
+      server.addr[1]
+    ensure
+      server.close if server
+    end
+
+  end
+end

data/lib/carrot/util/timeout.rb

@@ -0,0 +1,27 @@
+module Carrot
+  class << self
+
+    ##
+    # Provides timeout similar to standard library Timeout, but avoids threads
+    #
+    def timeout(seconds = 1, driver = nil, &block)
+      start_time = Time.now
+
+      result = nil
+
+      until result
+        return result if result = yield
+
+        delay = seconds - (Time.now - start_time)
+        if delay <= 0
+          raise TimeoutError
+        end
+
+        driver && driver.wait_until(delay)
+
+        sleep(0.05)
+      end
+    end
+
+  end
+end

data/lib/carrot.rb

@@ -0,0 +1,75 @@
+require 'timeout'
+require 'nokogiri'
+require 'xpath'
+
+module Carrot
+  class CarrotError < StandardError; end
+  class DriverNotFoundError < CarrotError; end
+  class ElementNotFound < CarrotError; end
+  class UnselectNotAllowed < CarrotError; end
+  class NotSupportedByDriverError < CarrotError; end
+  class TimeoutError < CarrotError; end
+  class LocateHiddenElementError < CarrotError; end
+  class InfiniteRedirectError < TimeoutError; end
+
+  class << self
+    attr_accessor :asset_root, :app_host, :run_server, :default_host
+    attr_accessor :server_port
+    attr_accessor :driver
+    attr_accessor :app
+    attr_accessor :external_ruby, :rails_command, :project_path
+    attr_accessor :external_server, :server_debug
+
+    ##
+    #
+    # Configure Carrot to suit your needs.
+    #
+    #     Carrot.configure do |config|
+    #       config.run_server = false
+    #       config.app_host   = 'http://www.google.com'
+    #     end
+    #
+    # === Configurable options
+    #
+    # [asset_root = String]               Where static assets are located, used by save_and_open_page
+    # [app_host = String]                 The default host to use when giving a relative URL to visit
+    # [run_server = Boolean]              Whether to start a Rack server for the given Rack app (Default: true)
+    # [default_selector = :css/:xpath]    Methods which take a selector use the given type by default (Default: CSS)
+    # [default_wait_time = Integer]       The number of seconds to wait for asynchronous processes to finish (Default: 2)
+    # [ignore_hidden_elements = Boolean]  Whether to ignore hidden elements on the page (Default: false)
+    #
+   
+    def configure
+      yield self
+    end
+    
+    def url(path)
+      @rack_server.url(path)
+    end
+
+    def register_driver(obj)
+      @driver = obj
+    end
+
+    def boot
+      @rack_server = Carrot::Server.new(@app)
+      @rack_server.boot if Carrot.run_server
+    end
+
+    def shutdown
+      @external_server.shutdown if @external_server
+    end
+
+  end
+
+  autoload :Server,     'carrot/server'
+  
+end
+
+Carrot.configure do |config|
+  config.run_server = true
+  config.external_ruby = false
+  config.server_debug = false
+  config.server_port = 3000
+end
+

data/rails-carrot.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rails-carrot}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Sloan Wu"]
+  s.date = %q{2010-11-02}
+  s.description = %q{Carrot can make QA test easy with any integration test gem.}
+  s.email = %q{sloanwu@gmail.com}
+  s.extra_rdoc_files = ["README", "lib/carrot.rb", "lib/carrot/extend_server.rb", "lib/carrot/rails.rb", "lib/carrot/server.rb", "lib/carrot/util/timeout.rb"]
+  s.files = ["Manifest", "README", "Rakefile", "carrot.gemspec", "lib/carrot.rb", "lib/carrot/extend_server.rb", "lib/carrot/rails.rb", "lib/carrot/server.rb", "lib/carrot/util/timeout.rb", "rails-carrot.gemspec"]
+  s.homepage = %q{http://github.com/sloanwu/carrot.git}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Rails-carrot", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{rails-carrot}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Carrot can make QA test easy with any integration test gem.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: rails-carrot
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Sloan Wu
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-02 00:00:00 +08:00
+default_executable: 
+dependencies: []
+
+description: Carrot can make QA test easy with any integration test gem.
+email: sloanwu@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- lib/carrot.rb
+- lib/carrot/extend_server.rb
+- lib/carrot/rails.rb
+- lib/carrot/server.rb
+- lib/carrot/util/timeout.rb
+files: 
+- Manifest
+- README
+- Rakefile
+- carrot.gemspec
+- lib/carrot.rb
+- lib/carrot/extend_server.rb
+- lib/carrot/rails.rb
+- lib/carrot/server.rb
+- lib/carrot/util/timeout.rb
+- rails-carrot.gemspec
+has_rdoc: true
+homepage: http://github.com/sloanwu/carrot.git
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Rails-carrot
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: rails-carrot
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Carrot can make QA test easy with any integration test gem.
+test_files: []
+