ripl-watir 0.0.2 → 0.0.3

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+lib/pages

data/README.rdoc

@@ -8,7 +8,7 @@ may then be performed with bionic superpowers.
 
     gem install ripl_watir
 
-== Demonstration
+== Usage
 
 Hopefully this serves as some kind of demonstration:
 
@@ -23,71 +23,59 @@ ripl console shell.
 
 ... add the 'lib' directory to the load path
 
-Now create a file 'lib/ripl_watir/github.rb' containing the following:
+Now create a file 'lib/pages/github.rb' containing the following:
 
-    require 'watir-page-helper'
-
-    module RiplWatir::Github
-      extend WatirPageHelper::ClassMethods
-
-      direct_url 'github.com'
-      link :login, text: 'Login'
-
-      def logged_in?
-        browser.div(id: 'user').exists?
+    module Pages::Github
+      def goto
+        browser.goto 'github.com'
       end
     end
 
 ... and now be amazed:
 
-    >> p = visit_page :github
+    >> visit_page :github
 
-... this creates an instance of the RiplWatir::Page class, requires 'ripl_watir/github' (from whereever it happens to be on the load
-path), mixes RiplWatir::Github into the page class and calls the
-goto method (which tells the browser to goto github.com).
+... this creates an instance of the Pages::Page class, loads 'pages/github' (from whereever it happens to be on the load
+path), mixes Pages::Github into the page class and calls the
+goto method (which tells the browser to goto github.com).  Amazing?
 
-    >> p.login
+Now edit the 'lib/pages/github.rb' file to add this method:
 
-... calls the login method on the page (which clicks the login button).
+    module Pages::Github
+      def login
+        browser.link(text: 'Sign in').click
+      end
+    ...
 
-Now create a file 'lib/ripl_watir/github/login.rb' containing the following:
+... and back in the ripl session:
 
-    require 'watir-page-helper'
+    >> on_page(:github).login
 
-    module RiplWatir::Github::Login
-      extend WatirPageHelper::ClassMethods
+This reloads the github page and calls the login method on the page (which clicks the login button).
 
-      text_field :email, id: 'login_field'
-      text_field :password, id: 'password'
-      button :submit, value: 'Log in'
+Now create a file 'lib/pages/github/login.rb' containing the following:
 
+    module Pages::Github::Login
       def login email, password
-        self.email = email
-        self.password = password
-        self.submit
+        browser.text_field(id: 'login_field').set email
+        browser.text_field(id: 'password').set password
+        browser.button(value: 'Sign in').click
       end
     end
 
 ... and be further amazed:
 
-    >> on_page(:github, :login) do |login_page|
-    |    login_page.login 'me@my.mail.com', 'password'
-    |  end
+    >> on_page(:github, :login).login 'me@my.mail.com', 'password'
 
-... creates another instance of the RiplWatir::Page class, requires
-'ripl_watir/github/home' (from whereever it happens to be on the load
-path), mixes RiplWatir::Github::Login into it and yields to the block.
+... creates another instance of the Pages::Page class, reloads
+'pages/github/login.rb' (from whereever it happens to be on the load
+path) and mixes Pages::Github::Login into it.
 
 The main purpose of all this is to be able to modify/define page mixins,
 and reload them all without having to restart the console or create a
 new browser session.
 
-If for example, you added a new page mixin or a new method to an already instantiated one, you can simply reload the class and should find the new method is available.
-
-    >> load 'ripl_watir/github/login'
-
-If the page mixin you've created has not been loaded already, this step
-is not necessary since the page mixins are only required on first use.
+If for example, you added a new page mixin or a new method to an already instantiated one, you should find the new method is immediately available.
 
 If you just want to tell the browser to do something, it is directly
 available as 'browser' without needing a page object.
@@ -96,12 +84,12 @@ available as 'browser' without needing a page object.
 
 == Page Objects
 
-At this time, the page objects are always a RiplWatir::Page instance
+The page objects are always a Pages::Page instance
 (which is a delegate of Watir::Browser) with a specified mixin.
 
-This mixin can add methods specifically for interacting with that page.
-The watir-page-helper mixin may be used as in the github examples in this gem but is not mandatory.  You can just define methods
-against the @browser instance varaible or delegate to the page itself.
+This mixins add methods specifically for interacting with that particular page.
+
+You can just define methods against the browser instance varaible or delegate to the page itself.
 
 These page mixins will be loaded from anywhere on the load path.
 
@@ -111,9 +99,9 @@ To use page mixins defined in this way with cucumber, define your
 page objects in a 'lib' (make sure this directory is on the load path)
 and mix the commands into the cucumber 'world' in env.rb:
 
-    require 'ripl_watir/'
+    require 'ripl_watir'
     World RiplWatir::Commands
 
-As long as your page mixins are in a 'ripl_watir' directory on the path
+As long as your page mixins are in a 'pages' directory on the path
 and are constants defined (at any depth) under the RiplWatir module, they
-should be located.
+should be successfully located.

data/bin/ripl-watir

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
+$: << File.dirname(__FILE__)+'/../lib'
 require 'ripl'
-require 'watir-page-helper/commands'
-Ripl::Commands.include WatirPageHelper::Commands
-browser = WatirPageHelper.create
-puts "'browser' has started and is now available to control: see http://bit.ly/ripl-watir for more details."
-Ripl.start :binding => binding
+require 'ripl_watir'
+include RiplWatir::Commands
+browser = RiplWatir.create
+Ripl.start binding: binding

data/lib/ripl_watir.rb

@@ -0,0 +1,56 @@
+require 'watir-webdriver'
+require 'watir-webdriver'
+require 'forwardable'
+
+module Pages
+  class Page
+    attr_reader :browser
+    extend Forwardable
+
+    def_delegators :@browser, :title, :url, :html, :status, :refresh, :back
+
+    def initialize browser
+      @browser = browser
+    end
+  end
+end
+
+module RiplWatir
+  class << self
+    attr_accessor :browser
+
+    def create
+      @browser = ::Watir::Browser.new ENV['WEBDRIVER'] || :firefox
+    end
+  end
+
+  module Commands
+    def classify s
+      s.to_s.split('_').map(&:capitalize).join
+    end
+
+    def page_class *args
+      page = Pages::Page.new RiplWatir.browser
+      load "pages/#{args.join '/'}.rb"
+      mod = Pages
+      args.each do |name|
+        mod = mod.const_get classify name
+      end
+      page.extend mod
+      page
+    end
+
+    def on_page *args
+      page_class(*args).tap do |p|
+        yield p if block_given?
+      end
+    end
+
+    def visit_page *args
+      on_page(*args) do |p|
+        p.goto
+        yield p if block_given?
+      end
+    end
+  end
+end

data/ripl-watir.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "ripl-watir"
-  s.version     = '0.0.2'
+  s.version     = '0.0.3'
   s.authors     = ["Mark Ryall"]
   s.email       = ["mark@ryall.name"]
   s.homepage    = "https://github.com/markryall/ripl_watir"
@@ -21,7 +21,7 @@ EOF
   s.require_paths = ["lib"]
 
   s.add_runtime_dependency "ripl"
-  s.add_runtime_dependency "watir-page-helper"
+  s.add_runtime_dependency "watir-webdriver"
 
   s.add_development_dependency "rake"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ripl-watir
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-14 00:00:00.000000000 Z
+date: 2012-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ripl
-  requirement: &70311937843260 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70311937843260
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: watir-page-helper
-  requirement: &70311937842820 !ruby/object:Gem::Requirement
+  name: watir-webdriver
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70311937842820
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70311937842380 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +53,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70311937842380
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ! 'A ripl plugin to provide an interactive shell for creating page objects
 
   to build an automated testing infrastructure for a site.
@@ -61,6 +76,7 @@ files:
 - README.rdoc
 - Rakefile
 - bin/ripl-watir
+- lib/ripl_watir.rb
 - ripl-watir.gemspec
 homepage: https://github.com/markryall/ripl_watir
 licenses: []
@@ -76,7 +92,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -102335906843895574
+      hash: -3087682925850807916
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -85,10 +101,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -102335906843895574
+      hash: -3087682925850807916
 requirements: []
 rubyforge_project: ripl-watir
-rubygems_version: 1.8.11
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: watir repl for efficiently creating page objects