browser_scroll 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38cb9aaf23ce8704f3cee01a99b8238a77832f52
+  data.tar.gz: c289be55e9752ef5743f3060bf9ad07a56da9f3c
+SHA512:
+  metadata.gz: 04ec07f1e89e280d350c1241649d26255f571fcee049aaa3da1b4c3963eb7caee86a2a9890855a43b22618d02958ce4b5db3998e21f2e39e44e227558efdb887
+  data.tar.gz: 58428ccb49862fb6e85ca033b80606180e866f7882681c3f664c6385abd859369e4069dc3663ec8f4d6295896ea35b4b22e710b5ef5079db88143916702bc251

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.ruby-version
+
+# rspec failure tracking
+.rspec_status

data/.hound.yml

@@ -0,0 +1,69 @@
+AllCops:
+  Exclude:
+    - browser_scroll.gemspec
+    - spec/**/*
+
+# Removing need for frozen string literal comment.
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Removing the preference for string single quotes.
+Style/StringLiterals:
+  Enabled: false
+
+# Missing top-level module documentation comment.
+Style/Documentation:
+  Enabled: false
+
+# Prefer reduce over inject.
+Style/CollectionMethods:
+  PreferredMethods:
+    reduce: 'inject'
+
+# Use each_with_object instead of inject.
+Style/EachWithObject:
+  Enabled: false
+
+# Prefer fail over raise.
+Style/SignalException:
+  Enabled: false
+
+# This never works for validations.
+Layout/AlignHash:
+  EnforcedLastArgumentHashStyle: ignore_implicit
+
+# Align multi-line params with previous line.
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+# Indent `when` clause one step from `case`.
+Layout/CaseIndentation:
+  IndentOneStep: true
+
+# Don't force bad var names for reduce/inject loops.
+Style/SingleLineBlockParams:
+  Enabled: false
+
+# For method chains, keep the dot with the method name.
+Layout/DotPosition:
+  EnforcedStyle: leading
+
+# Stop nesting so hard.
+Metrics/BlockNesting:
+  Max: 2
+
+# Encourage short methods.
+Metrics/MethodLength:
+  Max: 15
+
+# Encourage short (as possible) modules.
+Metrics/ModuleLength:
+  Max: 110
+
+# Encourage fewer parameters.
+Metrics/ParameterLists:
+  Max: 4
+
+# Remove execute permissions check.
+Lint/ScriptPermission:
+  Enabled: false

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_from:
+  - .hound.yml

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.6
+before_install: gem install bundler -v 1.16.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jeff.nyman@yello.co. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Jeff Nyman
+
+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,149 @@
+# BrowserScroll
+
+[![Gem Version](https://badge.fury.io/rb/browser_scroll.svg)](http://badge.fury.io/rb/browser_scroll)
+[![License](http://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/jeffnyman/browser_scroll/blob/master/LICENSE.md)
+
+This gem provides a small API on top of the JavaScript functionality that allows scrolling within the browser.
+
+## Installation
+
+To get the latest stable release, add this line to your application's Gemfile:
+
+```ruby
+gem 'browser_scroll'
+```
+
+To get the latest code:
+
+```ruby
+gem 'browser_scroll', git: 'https://github.com/jeffnyman/browser_scroll'
+```
+
+After doing one of the above, execute the following command:
+
+    $ bundle
+
+You can also install BrowserScroll just as you would any other gem:
+
+    $ gem install browser_scroll
+
+## Usage
+
+There are two means of scrolling: one is based on the browser window and the other is relative to an element within the browser window.
+
+### Browser Scrolling
+
+The API provides a simple means of scrolling to the top, middle, or bottom of the page.
+
+```ruby
+browser.scroll.to.top
+browser.scroll.to.middle
+browser.scroll.to.bottom
+```
+
+It is also scroll to specific x and y coordinates as such:
+
+```ruby
+browser.scroll.to [30, 30]
+```
+
+Finally, it is also possible to scroll by an offset. You can provide a horizontal and vertical offset.
+
+```ruby
+browser.scroll.by 30, 10
+```
+
+This would scroll to the left by 30 pixels and down by 10 pixels.
+
+```ruby
+browser.scroll.by -30, -10
+```
+
+Here the negative values means this would scroll to the right by 30 pixels and up by 10 pixels.
+
+You can chain the API calls:
+
+```ruby
+browser.scroll.to.top.by(0, 30)
+```
+
+This would scroll to the top of the page and then 30 pixels down.
+
+### Element Scrolling
+
+Unlike scrolling in the browser itself, you can scroll relative to an element. Consider the following element:
+
+```ruby
+search = @browser.button(text: 'Search')
+```
+
+The API provides a simple means of scrolling to the top, middle, or bottom of a given element.
+
+```ruby
+search.scroll.to.top
+search.scroll.to.middle
+search.scroll.to.bottom
+```
+
+Note that this is not referring to the top, middle and bottom of the element. Rather, what this is doing is scrolling the element to the top of the browser, to the middle of the browser, or to the bottom of the browser. There is a shorthand for scrolling an element to the top of the browser:
+
+```ruby
+search.scroll_to
+```
+
+Unlike the browser, you won't scroll to the coordinates of the element but you can scroll the element itself by horizontal and vertical offsets.
+
+```ruby
+search.scroll.by 30, 10
+```
+
+This would scroll the element to the left by 30 pixels and down by 10 pixels.
+
+```ruby
+search.scroll.by -30, -10
+```
+
+Here the negative values means this would scroll the element to the right by 30 pixels and up by 10 pixels.
+
+You can chain the API calls:
+
+```ruby
+search.scroll_to.by(0, 30)
+```
+
+Here this scrolls to the element and then 30 pixels down.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake spec:all` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+The default `rake` command will run all tests as well as a RuboCop analysis.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/jeffnyman/browser_scroll](https://github.com/jeffnyman/browser_scroll). The testing ecosystem of Ruby is very large and this project is intended to be a welcoming arena for collaboration on yet another test-supporting tool. As such, contributors are very much welcome but are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+The BrowserScroll gems follows [semantic versioning](http://semver.org).
+
+To contribute to BrowserScroll:
+
+1. [Fork the project](http://gun.io/blog/how-to-github-fork-branch-and-pull-request/).
+2. Create your feature branch. (`git checkout -b my-new-feature`)
+3. Commit your changes. (`git commit -am 'new feature'`)
+4. Push the branch. (`git push origin my-new-feature`)
+5. Create a new [pull request](https://help.github.com/articles/using-pull-requests).
+
+## Author
+
+* [Jeff Nyman](http://testerstories.com)
+
+## Credits
+
+This code is based upon the [watir-scroll](https://github.com/p0deje/watir-scroll) gem. I wanted to create a more chained API than one that relied on symbols. I also wanted to remove the notion that this is Watir specific. While that is currently the case, future expansion will be about being able to scroll in the browser independent of Watir.
+
+## License
+
+BrowserScroll is distributed under the [MIT](http://www.opensource.org/licenses/MIT) license.
+See the [LICENSE](https://github.com/jeffnyman/browser_scroll/blob/master/LICENSE.md) file for details.

data/Rakefile

@@ -0,0 +1,34 @@
+#!/usr/bin/env rake
+
+require "bundler/gem_tasks"
+require "rdoc/task"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+RSpec::Core::RakeTask.new(:spec)
+
+namespace :spec do
+  desc 'Clean all generated reports'
+  task :clean do
+    system('rm -rf spec/reports')
+  end
+
+  RSpec::Core::RakeTask.new(all: :clean) do |config|
+    options  = %w[--color]
+    options += %w[--format documentation]
+    options += %w[--format html --out spec/reports/unit-test-report.html]
+
+    config.rspec_opts = options
+  end
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.main = 'README.md'
+  rdoc.title = "Tapestry #{BrowserScroll::VERSION}"
+  rdoc.rdoc_files.include('README*', 'lib/**/*.rb')
+end
+
+task default: ['spec:all', :rubocop]

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "browser_scroll"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/browser_scroll.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "browser_scroll/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "browser_scroll"
+  spec.version       = BrowserScroll::VERSION
+  spec.authors       = ["Jeff Nyman"]
+  spec.email         = ["jeffnyman@gmail.com"]
+
+  spec.summary       = %q{Provides API Around JavaScript Scrolling Functionality}
+  spec.description   = %q{Provides API Around JavaScript Scrolling Functionality}
+  spec.homepage      = "https://github.com/jeffnyman/browser_scroll"
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "pry"
+
+  spec.add_runtime_dependency "watir", "~> 6.0"
+
+  spec.post_install_message = %{
+(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)
+  BrowserScroll #{BrowserScroll::VERSION} has been installed.
+(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)
+  }
+end

data/lib/browser_scroll.rb

@@ -0,0 +1,9 @@
+require "watir"
+require "browser_scroll/version"
+require "browser_scroll/browser"
+require "browser_scroll/browser/scroll"
+require "browser_scroll/element"
+require "browser_scroll/element/scroll"
+
+module BrowserScroll
+end

data/lib/browser_scroll/browser.rb

@@ -0,0 +1,7 @@
+module Watir
+  class Browser
+    def scroll
+      Scroll.new(self)
+    end
+  end
+end

data/lib/browser_scroll/browser/scroll.rb

@@ -0,0 +1,54 @@
+module Watir
+  class Browser
+    class Scroll
+      def initialize(browser)
+        @browser = browser
+      end
+
+      def to(param = nil)
+        if !param.nil? && param.is_a?(Array)
+          unless param.is_a?(Array)
+            raise ArgumentError, "Unable to scroll to: #{param}."
+          end
+
+          execute(
+            'window.scrollTo(arguments[0], arguments[1]);',
+            Integer(param[0]), Integer(param[1])
+          )
+        end
+        self
+      end
+
+      def top
+        execute('window.scrollTo(0, 0);')
+        self
+      end
+
+      def bottom
+        execute('window.scrollTo(0, document.body.scrollHeight);')
+        self
+      end
+
+      def middle
+        execute(
+          'window.scrollTo(window.outerWidth / 2, window.outerHeight / 2);'
+        )
+        self
+      end
+
+      def by(left, top)
+        execute(
+          'window.scrollBy(arguments[0], arguments[1]);',
+          Integer(left), Integer(top)
+        )
+        self
+      end
+
+      private
+
+      def execute(*args)
+        @browser.execute_script(*args)
+      end
+    end
+  end
+end

data/lib/browser_scroll/element.rb

@@ -0,0 +1,7 @@
+module Watir
+  class Element
+    def scroll
+      Scroll.new(self)
+    end
+  end
+end

data/lib/browser_scroll/element/scroll.rb

@@ -0,0 +1,53 @@
+module Watir
+  class Element
+    class Scroll
+      def initialize(element)
+        @element = element
+      end
+
+      def to
+        self
+      end
+
+      def scroll_to
+        top
+      end
+
+      def top
+        execute('arguments[0].scrollIntoView();', @element)
+        self
+      end
+
+      def bottom
+        execute('arguments[0].scrollIntoView(false);', @element)
+        self
+      end
+
+      def middle
+        script = <<-JS
+          var bodyRect = document.body.getBoundingClientRect();
+          var elementRect = arguments[0].getBoundingClientRect();
+          var left = (elementRect.left - bodyRect.left) - (window.innerWidth / 2);
+          var top = (elementRect.top - bodyRect.top) - (window.innerHeight / 2);
+          window.scrollTo(left, top);
+        JS
+        execute(script, @element)
+        self
+      end
+
+      def by(left, top)
+        execute(
+          'window.scrollBy(arguments[0], arguments[1]);',
+          Integer(left), Integer(top)
+        )
+        self
+      end
+
+      private
+
+      def execute(*args)
+        @element.browser.execute_script(*args)
+      end
+    end
+  end
+end

data/lib/browser_scroll/version.rb

@@ -0,0 +1,3 @@
+module BrowserScroll
+  VERSION = "0.5.0".freeze
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: browser_scroll
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Jeff Nyman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: watir
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: Provides API Around JavaScript Scrolling Functionality
+email:
+- jeffnyman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".hound.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- browser_scroll.gemspec
+- lib/browser_scroll.rb
+- lib/browser_scroll/browser.rb
+- lib/browser_scroll/browser/scroll.rb
+- lib/browser_scroll/element.rb
+- lib/browser_scroll/element/scroll.rb
+- lib/browser_scroll/version.rb
+homepage: https://github.com/jeffnyman/browser_scroll
+licenses:
+- MIT
+metadata: {}
+post_install_message: "\n(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n
+  \ BrowserScroll 0.5.0 has been installed.\n(::) (::) (::) (::) (::) (::) (::) (::)
+  (::) (::) (::) (::)\n  "
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.2
+signing_key: 
+specification_version: 4
+summary: Provides API Around JavaScript Scrolling Functionality
+test_files: []