watir-rails 0.0.1 → 0.0.2

data/.yardopts

@@ -0,0 +1,6 @@
+--readme README.md
+--no-private
+--hide-void-return
+--title "Watir-Rails"
+--files LICENSE
+--default-return ""

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Jarmo Pertman
+Copyright (c) 2012-2013 Jarmo Pertman
 
 MIT License
 
@@ -19,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,42 +1,46 @@
-# Watir::Rails
-
-This gem adds the [Watir](http://github.com/watir/watir) usage support when writing integration tests in Rails.
-
-## Installation
-
-Add this code to your Gemfile:
-
-    group :test do
-      gem 'watir-rails'
-    end
-
-## Usage
-
-Just use Watir like you've always done in your requests/integration tests:
-
-    browser = Watir::Browser.new
-    browser.goto home_path
-    browser.text_field(name: "first").set "Jarmo"
-    browser.text_field(name: "last").set  "Pertman"
-    browser.button(name: "sign_in").click
-
-## Limitations
-
-* Watir-Rails works currently only with the [Watir-WebDriver](http://github.com/watir/watir-webdriver) and not with
-the [Watir-Classic](http://github.com/watir/watir-classic) due to the problems of running a server
-in the separate thread when WIN32OLE is used.
-The problem is probably caused by the fact that [WIN32OLE overwrites Thread#initialize](https://github.com/ruby/ruby/blob/trunk/test/ruby/test_thread.rb#L607).
-
-* When using Rails path/url helpers in your tests then always use path instead of url methods, because latter won't work!
-
-## License
-
-See [LICENSE](https://github.com/watir/watir-rails/blob/master/LICENSE).
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+# Watir::Rails
+
+This gem adds the [Watir](http://github.com/watir/watir) usage support when writing integration tests in Rails.
+
+## Installation
+
+Add this code to your Gemfile:
+
+````ruby
+group :test do
+  gem 'watir-rails'
+end
+````
+
+## Usage
+
+Just use Watir like you've always done in your requests/integration tests:
+
+````ruby
+browser = Watir::Browser.new
+browser.goto home_path
+browser.text_field(name: "first").set "Jarmo"
+browser.text_field(name: "last").set  "Pertman"
+browser.button(name: "sign_in").click
+````
+
+## Limitations
+
+* Watir-Rails works currently only with the [Watir-WebDriver](http://github.com/watir/watir-webdriver) and not with
+the [Watir-Classic](http://github.com/watir/watir-classic) due to the problems of running a server
+in the separate thread when WIN32OLE is used.
+The problem is probably caused by the fact that [WIN32OLE overwrites Thread#initialize](https://github.com/ruby/ruby/blob/trunk/test/ruby/test_thread.rb#L607).
+
+* When using Rails path/url helpers in your tests then always use path instead of url methods, because latter won't work!
+
+## License
+
+See [LICENSE](https://github.com/watir/watir-rails/blob/master/LICENSE).
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -1 +1,3 @@
 require "bundler/gem_tasks"
+require "yard"
+YARD::Rake::YardocTask.new

data/lib/watir/browser.rb

@@ -1,16 +1,31 @@
 module Watir
+  # Reopened Watir::Browser class for working with Rails
   class Browser
+    # @private
     alias_method :original_initialize, :initialize
 
+    # Will start Rails instance for Watir automatically and then invoke the
+    # original Watir::Browser#initialize method.
     def initialize(*args)
       Rails.boot
       original_initialize *args
     end
 
+    # @private
     alias_method :original_goto, :goto
 
+    # Opens the url with the browser instance.
+    # Will add {Rails.host} and {Rails.port} to the url when path is specified.
+    #
+    # @example Open the regular url:
+    #   browser.goto "http://google.com"
+    #
+    # @example Open the controller path:
+    #   browser.goto home_path
+    #
+    # @param [String] url URL to be navigated to.
     def goto(url)
-      url = "http://#{Rails.host}:#{Rails.port}#{url}" unless url =~ %r{^http://}i
+      url = "http://#{Rails.host}:#{Rails.port}#{url}" unless url =~ %r{^https?://}i || url == "about:blank"
       original_goto url
     end
   end

data/lib/watir/rails.rb

@@ -6,6 +6,7 @@ require File.expand_path("browser.rb", File.dirname(__FILE__))
 
 module Watir
   class Rails
+    # @private
     class Middleware
       def initialize(app)
         @app = app
@@ -24,6 +25,8 @@ module Watir
       private :new
       attr_reader :port, :middleware
 
+      # Start the Rails server for tests.
+      # Will be called automatically by {Watir::Browser#initialize}.
       def boot
         unless running?
           @middleware = Middleware.new(app)
@@ -39,10 +42,16 @@ module Watir
         raise "Rack application timed out during boot"
       end
 
+      # Host for Rails app under test.
+      #
+      # @return [String] Host for Rails app for testing.
       def host
         "127.0.0.1"
       end
 
+      # Check if Rails app under test is running.
+      #
+      # @return [Boolean] true when Rails app under test is running, false otherwise.
       def running?
         return false if @server_thread && @server_thread.join(0)
 
@@ -55,6 +64,9 @@ module Watir
         return false
       end
 
+      # Rails app under test.
+      #
+      # @return [Object] Rails Rack app.
       def app
         @app ||= Rack::Builder.new do
           map "/" do

data/lib/watir/version.rb

@@ -1,5 +1,5 @@
 module Watir
   class Rails
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/watir-rails.gemspec

@@ -18,4 +18,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency "rack"
   gem.add_dependency "rails"
   gem.add_dependency "watir-webdriver"
+
+  gem.add_development_dependency "yard"
+  gem.add_development_dependency "redcarpet"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: watir-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-25 00:00:00.000000000 Z
+date: 2013-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -59,6 +59,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Add support for Watir (http://github.com/watir/watir) in Rails.
 email:
 - jarmo.p@gmail.com
@@ -67,6 +99,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .yardopts
 - Gemfile
 - LICENSE
 - README.md