watir-scroll 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+before_install:
+  - "export DISPLAY=:99.0"
+  - "sh -e /etc/init.d/xvfb start"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in watir-scroll.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alex Rodionov
+
+MIT License
+
+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.md

@@ -0,0 +1,43 @@
+# watir-scroll [![Build Status](https://travis-ci.org/p0deje/watir-scroll.png?branch=master)](https://travis-ci.org/p0deje/watir-scroll) [![Gem Version](https://badge.fury.io/rb/watir-scroll.png)](http://badge.fury.io/rb/watir-scroll)
+
+Scrolling API for [watir-webdriver](http://github.com/watir/watir-webdriver).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'watir-scroll'
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install watir-scroll
+```
+
+## Usage
+
+```ruby
+button = browser.button(:text => 'Click')
+
+browser.scroll.to :top      # scrolls to the top of the page
+browser.scroll.to :center   # scrolls to the center of the page
+browser.scroll.to :bottom   # scrolls to the bottom of the page
+browser.scroll.to [10, 10]  # scrolls to coordinates x and y
+browser.scroll.to button    # scrolls to element
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = %w(--color)
+  spec.pattern    = 'spec/**/*_spec.rb'
+end
+
+task default: :spec
+

data/lib/watir-scroll.rb

@@ -0,0 +1,4 @@
+require "watir-webdriver"
+require "watir-scroll/browser"
+require "watir-scroll/scroll"
+require "watir-scroll/version"

data/lib/watir-scroll/browser.rb

@@ -0,0 +1,13 @@
+module Watir
+  class Browser
+
+    #
+    # Returns scrolling object.
+    # @return [Scroll]
+    #
+    def scroll
+      Scroll.new(self)
+    end
+
+  end # Browser
+end # Watir

data/lib/watir-scroll/scroll.rb

@@ -0,0 +1,34 @@
+module Watir
+  class Browser
+    class Scroll
+
+      def initialize(browser)
+        @browser = browser
+      end
+
+      #
+      # Scrolls to position.
+      # @param [Symbol, Watir::Element, Array<Fixnum>] param
+      #
+      def to(param)
+        args = case param
+               when :top, :start
+                 'window.scrollTo(0, 0);'
+               when :center
+                 'window.scrollTo(document.body.scrollWidth / 2, document.body.scrollHeight / 2);'
+               when :bottom, :end
+                 'window.scrollTo(0, document.body.scrollHeight);'
+               when Watir::Element
+                 ['arguments[0].scrollIntoView();', param]
+               when Array
+                 ['window.scrollTo(arguments[0], arguments[1]);', Integer(param[0]), Integer(param[1])]
+               else
+                 raise ArgumentError, "Don't know how to scroll to: #{param}!"
+               end
+
+         @browser.execute_script(*args)
+      end
+
+    end # Scroll
+  end # Browser
+end # Watir

data/lib/watir-scroll/version.rb

@@ -0,0 +1,9 @@
+module Watir
+  class Browser
+    class Scroll
+
+      VERSION = "0.1.0"
+
+    end # Scroll
+  end # Browser
+end # Watir

data/spec/spec_helper.rb

@@ -0,0 +1,55 @@
+require "watir-scroll"
+
+HTML = <<-HTML
+  <html>
+    <head>
+      <script>
+        function elementInViewport(el) {
+          var top = el.offsetTop;
+          var left = el.offsetLeft;
+          var width = el.offsetWidth;
+          var height = el.offsetHeight;
+
+          while(el.offsetParent) {
+            el = el.offsetParent;
+            top += el.offsetTop;
+            left += el.offsetLeft;
+          }
+
+          return (
+            top < (window.pageYOffset + window.innerHeight) &&
+            left < (window.pageXOffset + window.innerWidth) &&
+            (top + height) > window.pageYOffset &&
+            (left + width) > window.pageXOffset
+          );
+        }
+      </script>
+    </head>
+    <body>
+      <button>Top</button
+      #{'<br />' * 300}
+      <button>Bottom</button
+    </body>
+  </html>
+HTML
+
+
+RSpec.configure do |spec|
+  spec.before(:all) do
+    @browser = Watir::Browser.new
+    @browser.goto "data:text/html,#{HTML}"
+  end
+
+  spec.after(:all) do
+    @browser.quit
+  end
+
+  spec.after(:each) do
+    @browser.refresh
+  end
+
+
+  def visible?(el)
+    @browser.execute_script('return elementInViewport(arguments[0]);', el)
+  end
+end

data/spec/watir-scroll_spec.rb

@@ -0,0 +1,40 @@
+require "spec_helper"
+
+describe "watir-scoll" do
+  describe "#scroll.to" do
+    it "scrolls to the top of the page" do
+      @browser.scroll.to :bottom
+      @browser.scroll.to :top
+      expect(visible?(@browser.button(text: 'Top'))).to eq(true)
+      expect(visible?(@browser.button(text: 'Bottom'))).to eq(false)
+    end
+
+    it "scrolls to the center of the page" do
+      @browser.scroll.to :center
+      expect(visible?(@browser.button(text: 'Top'))).to eq(false)
+      expect(visible?(@browser.button(text: 'Bottom'))).to eq(false)
+    end
+
+    it "scrolls to the bottom of the page" do
+      @browser.scroll.to :bottom
+      expect(visible?(@browser.button(text: 'Top'))).to eq(false)
+      expect(visible?(@browser.button(text: 'Bottom'))).to eq(true)
+    end
+
+    it "scrolls to element" do
+      button = @browser.button(text: 'Bottom')
+      @browser.scroll.to button
+      expect(visible?(button)).to eq(true)
+    end
+
+    it "scrolls to coordiantes" do
+      button = @browser.button(text: 'Bottom')
+      @browser.scroll.to [button.wd.location.x, button.wd.location.y]
+      expect(visible?(button)).to eq(true)
+    end
+
+    it "raises error when scroll point is not vaild" do
+      expect { @browser.scroll.to(:blah) }.to raise_error(ArgumentError)
+    end
+  end
+end

data/watir-scroll.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'watir-scroll/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "watir-scroll"
+  spec.version       = Watir::Browser::Scroll::VERSION
+  spec.authors       = "Alex Rodionov"
+  spec.email         = "p0deje@gmail.com"
+  spec.description   = "Scrolling API for watir-webdriver"
+  spec.summary       = "Scrolling API for watir-webdriver"
+  spec.homepage      = "https://github.com/p0deje/watir-scroll"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "watir-webdriver"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: watir-scroll
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Alex Rodionov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: watir-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: Scrolling API for watir-webdriver
+email: p0deje@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/watir-scroll.rb
+- lib/watir-scroll/browser.rb
+- lib/watir-scroll/scroll.rb
+- lib/watir-scroll/version.rb
+- spec/spec_helper.rb
+- spec/watir-scroll_spec.rb
+- watir-scroll.gemspec
+homepage: https://github.com/p0deje/watir-scroll
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 435878204713146797
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 435878204713146797
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Scrolling API for watir-webdriver
+test_files:
+- spec/spec_helper.rb
+- spec/watir-scroll_spec.rb