cucumber_steps 0.0.1.sketch → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 884c20285202cd562a175d92e46ccd6ce35509a6
-  data.tar.gz: fa4cdab4834ce029f799b79b3dba39a3882b4cd9
+  metadata.gz: 45beaf5b6ca6bd6506e2ca36e6a581c239617fe4
+  data.tar.gz: a4737c0e677888d5187695011019fc9950c3579b
 SHA512:
-  metadata.gz: cd734f205303e751e1fe063ccaea6b8c5b856b98f1afcccde3db993a04e482ee543dd6594e228b3735edcbb938e5620bbafc523c237b79468a7caedaa52776ff
-  data.tar.gz: df35443ec4014b4505de3bff8622fe52cc6af2763fa901f54b5e24f8c992046c5046998b5fe0f7d859cba5921c5c74a09a1b81c0f00e23e6ad5b38508b5e6352
+  metadata.gz: 82bc10db105114a1cbaa1533c23bac2a4dd927a94e186c25b4bb7cb8cdaae9714ea8e31b21beb9db86b7c927ba1997bc69408457fee2c417b9f14ad176ac0448
+  data.tar.gz: 51df69ea1ef561d2ec2f04ee6fdf15d946e084b83acdb22fbfe8fd8b5350c80a53d4e7cf44ab9a715b1f55055bd1593c232d58a95754d8051e9a5a3da32fa552

data/Gemfile

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

data/README.md

@@ -18,7 +18,16 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### ENV variables
+
+* BROWSER_NAME 
+  * phantomjs
+  * chrome
+  * firefox 
+  * etx 
+  
+* BROWSER_NOT_EXIT_AFTER_TEST
+  * Do not apply browser object to close on exit
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,45 @@
 require "bundler/gem_tasks"
 
+# From https://gist.github.com/778535
+# In turn based on http://www.natontesting.com/2010/01/11/updated-script-to-list-all-cucumber-step-definitions/
+desc "List all available steps"
+task :steps do
+  require 'hirb'
+  extend Hirb::Console
+  features_dir = ENV['FEATURES_PATH'] ||  "features"
+  step_candidates = Dir.glob(File.join(features_dir,'**/*.rb'))
+
+  # Follow all the gem requires, and identify which files have steps in them
+  step_files = []
+  step_candidates.each do |candidate|
+
+    File.foreach(candidate) do |line|
+      if line =~ /require ['"](.*\/.*)['"]/
+        if libfile = `gem which #{$1} 2>/dev/null`.chomp
+          step_candidates << libfile unless step_candidates.include?(libfile)
+        end
+      elsif line =~ /^\s*(?:Given|When|Then)\s+/
+        step_files << candidate
+      end
+    end
+  end
+
+  step_files.uniq.each do |step_file|
+    puts "File: #{step_file}"
+    puts ""
+    results = []
+    File.new(step_file).read.each_line.each_with_index do |line, number|
+      next unless line =~ /^\s*(?:Given|When|Then)\s+|\//
+      res = /(?:Given|When|Then)[\s\(]*\/(.*)\/([imxo]*)[\s\)]*do\s*(?:$|\|(.*)\|)/.match(line)
+      next unless res
+      matches = res.captures
+      results << OpenStruct.new(
+          :steps => matches[0],
+          :args => matches[2]
+      )
+    end
+    table results, :resize => false, :fields=>[:steps, :args]
+    puts ""
+
+  end
+end

data/VERSION

@@ -1 +1 @@
-0.0.1.sketch
+0.0.1

data/cucumber_steps.gemspec

@@ -23,7 +23,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
 
+  spec.add_dependency 'watir'
   spec.add_dependency 'rspec'
   spec.add_dependency 'cucumber'
 
+  spec.add_development_dependency 'hirb'
+
 end

data/lib/cucumber_steps.rb

@@ -1,3 +1,12 @@
 module CucumberSteps
-  # Your code goes here...
+
+  require 'cucumber_steps/env_fetcher'
+
+  require 'cucumber_steps/debug' if CucumberSteps::ENVFetcher.development?
+
+  require 'cucumber'
+  require 'cucumber/rb_support/rb_dsl'
+
+  require 'cucumber_steps/browser'
+
 end

data/lib/cucumber_steps/browser.rb

@@ -0,0 +1,47 @@
+require 'cucumber_steps/browser/browser_steps'
+require 'cucumber_steps/browser/click_steps'
+require 'cucumber_steps/browser/expect_steps'
+require 'cucumber_steps/browser/hover_steps'
+require 'cucumber_steps/browser/sketch_steps'
+require 'cucumber_steps/browser/typing_steps'
+require 'cucumber_steps/browser/visit_steps'
+
+module CucumberSteps::Browser
+
+  require 'cucumber_steps/browser/instance'
+
+  def browser
+    @browser || reopen_browser!
+  end
+
+  def reopen_browser!
+
+    if @browser.is_a?(::CucumberSteps::Browser::Instance)
+      @browser.close
+    end
+
+    browser = ::CucumberSteps::Browser::Instance.new(browser_name)
+    @browser = browser
+
+  end
+
+  def browser_name=(new_browser_name)
+    @browser_name = new_browser_name.to_s.strip
+  end
+
+  def browser_name
+    CucumberSteps::ENVFetcher.browser_name || @browser_name || 'phantomjs'
+  end
+
+  def parse_html_attributes(raw_attributes)
+    raw_attributes.scan(/(\w+)="([^"]+)"/).reduce({}) do |all_matcher, (attr_name, value)|
+      all_matcher[attr_name.downcase.to_sym]=value
+      all_matcher
+    end
+  end
+
+end
+
+World(CucumberSteps::Browser)
+
+

data/lib/cucumber_steps/browser/browser_steps.rb

@@ -0,0 +1,11 @@
+And /^I use "([^"]+)"(?: as the)? browser$/i do |new_browser_name|
+  self.browser_name= new_browser_name
+end
+
+And /^the browser is (.*)$/i do |new_browser_name|
+  self.browser_name= new_browser_name
+end
+
+And /^the browser resolution is (\d+)x(\d+) pixels$/i do |width, height|
+  browser.window.resize_to(width.to_i, height.to_i)
+end

data/lib/cucumber_steps/browser/click_steps.rb

@@ -0,0 +1,16 @@
+
+And /^I click to the "([^"]+)" field that is near to the "([^"]+)" label$/i do |tag_name,label_text|
+  relative_positioned_label = browser.current_scope.label(text: label_text).when_present
+  element_to_click = relative_positioned_label.parent.element(tag_name: tag_name).when_present
+  element_to_click.click
+end
+
+And /^I press the "([^"]+)" button$/i do |button_text|
+  element_to_click = browser.current_scope.element(text: button_text).when_present
+  element_to_click.click
+end
+
+And /^I press click to the element that html attributes match the following: (.*)$/ do |raw_html_attributes|
+  element_to_click = browser.current_scope.element(parse_html_attributes(raw_html_attributes)).when_present
+  element_to_click.click
+end

data/lib/cucumber_steps/browser/expect_steps.rb

@@ -0,0 +1,33 @@
+Then(/^the browser url should include "([^"]*)"$/) do |include_text|
+  Watir::Wait.until(10, "the url do not include the #{include_text.inspect} text") do
+    browser.url.include?(include_text)
+  end
+end
+
+Then(/^the browser url should not include "([^"]*)"$/) do |include_text|
+  Watir::Wait.until(10, "the url do include the #{include_text.inspect} text\n#{browser.url}") do
+    not browser.url.include?(include_text)
+  end
+end
+
+And(/^The browser's url should match the following: \/(.*)\/$/i) do |expected_url|
+  Watir::Wait.until(10, "the url do not match the /#{expected_url}/ regular expression") do
+    !!(browser.url =~ Regexp.new(expected_url))
+  end
+end
+
+And(/^the (\w+) with the attributes: (.*?) should match the following text: (.*)$/i) do |tag_name, raw_attr_matcher, expected_match_text|
+  Watir::Wait.until(10, "the url do not match the /#{expected_match_text}/ regular expression") do
+    begin
+      !!((browser.current_scope.element({tag_name: tag_name}.merge(parse_html_attributes(raw_attr_matcher))).when_present.text) =~ Regexp.new(expected_match_text))
+    rescue
+      false
+    end
+  end
+end
+
+And(/^the browser should include the following text:$/) do |text|
+  Watir::Wait.until(10, "the browser do not include the following text: #{text}") do
+    browser.current_scope.text.include?(text.strip)
+  end
+end

data/lib/cucumber_steps/browser/hover_steps.rb

@@ -0,0 +1,7 @@
+And /^I hover(?: mouse)? to the "([^"])" button$/i do |button_text|
+  browser.current_scope.element(text: button_text).when_present.hover
+end
+
+And /^I hover mouse to the element that html attributes match the following: (.*)$/ do |raw_html_attributes|
+  browser.current_scope.element(parse_html_attributes(raw_html_attributes)).when_present.hover
+end

data/lib/cucumber_steps/browser/instance.rb

@@ -0,0 +1,17 @@
+require 'watir'
+class CucumberSteps::Browser::Instance < Watir::Browser
+
+  require 'cucumber_steps/browser/instance/defaults'
+  extend CucumberSteps::Browser::Instance::Defaults
+
+  require 'cucumber_steps/browser/instance/scope_handler'
+  include CucumberSteps::Browser::Instance::ScopeHandler
+
+  protected
+
+  def initialize(browser_name, *args)
+    super(browser_name, *self.class.args_with_default_options(browser_name, *args))
+    Kernel.at_exit { self.close rescue nil } if CucumberSteps::ENVFetcher.close_browser_at_exit?
+  end
+
+end

data/lib/cucumber_steps/browser/instance/defaults.rb

@@ -0,0 +1,32 @@
+module CucumberSteps::Browser::Instance::Defaults
+
+  BROWSER_ARGUMENTS = {
+      'phantomjs' => {
+          # --load-plugins=[yes|no]            Load all plugins (i.e. 'Flash', 'Silverlight', ...)  (default is 'no').
+          # --ignore-ssl-errors=[yes|no]       Ignore SSL errors (i.e. expired or self-signed certificate errors).
+          # --ssl-protocol=any
+          # --config=/path/to/config
+          # # javascriptCanCloseWindows: true
+          # # javascriptCanOpenWindows: true
+          # # javascriptEnabled: true
+          args: ['--ssl-protocol=any']
+      }
+
+  }
+
+  def args_with_default_options(browser_name, *args)
+
+    unless args.any? { |e| e.is_a?(Hash) }
+      args.unshift({})
+    end
+
+    options = args.find { |e| e.is_a?(Hash) }
+
+    pare_defined_options = ::CucumberSteps::Browser::Instance::Defaults::BROWSER_ARGUMENTS[browser_name.to_s] || {}
+    options.merge!(pare_defined_options) if pare_defined_options.is_a?(Hash)
+
+    return args
+
+  end
+
+end

data/lib/cucumber_steps/browser/instance/scope_handler.rb

@@ -0,0 +1,35 @@
+module CucumberSteps::Browser::Instance::ScopeHandler
+
+  def current_scope
+    target_scope = self
+
+    locating_scopes.each do |location_def|
+      target_scope = location_def.call(target_scope)
+    end
+
+    target_scope
+  end
+
+  def add_locating_scope(locating_scope_name, &block)
+    locating_scopes.push([locating_scope_name.to_s.to_sym, block])
+    nil
+  end
+
+  def pop_locating_scope(locating_scope_name)
+    locating_scope_name = locating_scope_name.to_s.to_sym
+    locating_scopes.delete_if { |name, block| name == locating_scope_name }
+    nil
+  end
+
+  def clear_locating_scopes!
+    locating_scopes.clear
+    nil
+  end
+
+  protected
+
+  def locating_scopes
+    @locating_scopes ||= []
+  end
+
+end

data/lib/cucumber_steps/browser/locating_scope_steps.rb

@@ -0,0 +1,15 @@
+And /^From here I work (?:in|with) iframe$/i do
+  browser.add_locating_scope :work_with_iframe do |scope|
+    ::Watir::Wait.until { scope.iframes.count > 0 }
+
+    scope.iframe
+  end
+end
+
+And /^I no longer work (?:in|with) iframe$/i do
+  browser.pop_locating_scope(:work_with_iframe)
+end
+
+And /^in the browser(?: without any additional scoping)?$/ do
+  browser.clear_locating_scopes!
+end

data/lib/cucumber_steps/browser/sketch_steps.rb

@@ -0,0 +1,17 @@
+# And(/fill Password text\-field with "([^"]*)"$/i) do |password_text|
+#
+#   password_element = browser.elements(text: /^ *passw(?:or)?d:? *$/i).sort_by { |e| e.text.length }.first.to_subtype
+#
+#   case password_element
+#
+#     when Watir::TableDataCell
+#       # [:cell_index, :tab_index]
+#       value_td = password_element.parent.td(index: password_element.cell_index + 1)
+#       value_td.elements.first.set(password_text)
+#
+#   end
+#
+#   # $element = password_element
+#   # irb_session
+#
+# end

data/lib/cucumber_steps/browser/typing_steps.rb

@@ -0,0 +1,21 @@
+And /^I type the following into the browser:$/i do |text_to_be_typed|
+  browser.send_keys(text_to_be_typed.to_s)
+end
+
+[
+
+    :null, :cancel, :help, :backspace, :tab, :clear, :return, :enter, :shift, :left_shift, :control, :left_control, :alt, :left_alt,
+    :pause, :escape, :space, :page_up, :page_down, :end, :home, :left, :arrow_left, :up, :arrow_up, :right, :arrow_right, :down, :arrow_down, :insert, :delete, :semicolon, :equals,
+    :numpad0, :numpad1, :numpad2, :numpad3, :numpad4, :numpad5, :numpad6, :numpad7, :numpad8, :numpad9,
+    :multiply, :add, :separator, :subtract, :decimal, :divide,
+    :f1, :f2, :f3, :f4, :f5, :f6, :f7, :f8, :f9, :f10, :f11, :f12,
+    :meta, :command
+
+].each do |special_key|
+
+  And /^I hit #{special_key.to_s.inspect} to the browser$/ do
+    browser.send_keys(:enter)
+  end
+
+end
+

data/lib/cucumber_steps/browser/visit_steps.rb

@@ -0,0 +1,7 @@
+And /^I (?:visit|goto) the following url: *(.*)$/ do |url|
+  browser.goto(url.strip)
+end
+
+And /^I (?:visit|goto) the "([^"]+)" url$/ do |url|
+  browser.goto(url)
+end

data/lib/cucumber_steps/debug.rb

@@ -0,0 +1,21 @@
+def start_irb
+  require 'irb'
+  require 'irb/completion'
+  ARGV.clear
+  IRB.start
+end
+
+module DebugSteps
+
+  def irb_session
+    $b = $browser = browser
+    start_irb
+  end
+
+end
+
+World(DebugSteps)
+
+And /irb/i do
+  irb_session
+end

data/lib/cucumber_steps/env_fetcher.rb

@@ -0,0 +1,40 @@
+module CucumberSteps::ENVFetcher
+  extend self
+
+  CLI_ALIASES_FOR_TRUE = %W[yes true]
+  CLI_ALIASES_FOR_FALSE = %W[no false]
+
+  def development?
+    lookup_for_true_case('DEVELOPER_ENV')
+  end
+
+  def close_browser_at_exit?
+    lookup_for_true_case('CLOSE_BROWSER_AT_EXIT') or
+        not lookup_for_false_case('BROWSER_NOT_EXIT_AFTER_TEST', 'BROWSER_NOT_EXIT_AT_EXIT')
+  end
+
+  def browser_name
+    lookup_value_by('BROWSER','BROWSER_NAME')
+  end
+
+  protected
+
+  def lookup_for_true_case(*env_keys)
+    filtered_env(env_keys).any? { |k, v| CLI_ALIASES_FOR_TRUE.include?(v.to_s.downcase) }
+  end
+
+  def lookup_for_false_case(*env_keys)
+    filtered_env(env_keys).any? { |k, v| CLI_ALIASES_FOR_FALSE.include?(v.to_s.downcase) }
+  end
+
+  def lookup_value_by(*env_keys)
+    filtered_env(env_keys).values.first
+  end
+
+  def filtered_env(env_keys)
+    lookup_env_keys = env_keys.map(&:to_s).map(&:upcase)
+
+    ENV.select { |env_key, value| lookup_env_keys.include?(env_key) }
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cucumber_steps
 version: !ruby/object:Gem::Version
-  version: 0.0.1.sketch
+  version: 0.0.1
 platform: ruby
 authors:
 - Adam Luzsi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-10 00:00:00.000000000 Z
+date: 2015-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: watir
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: hirb
+  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'
 description: collection of often used cucumber steps to avoid the violation of DRY
   principle
 email:
@@ -82,6 +110,20 @@ files:
 - VERSION
 - cucumber_steps.gemspec
 - lib/cucumber_steps.rb
+- lib/cucumber_steps/browser.rb
+- lib/cucumber_steps/browser/browser_steps.rb
+- lib/cucumber_steps/browser/click_steps.rb
+- lib/cucumber_steps/browser/expect_steps.rb
+- lib/cucumber_steps/browser/hover_steps.rb
+- lib/cucumber_steps/browser/instance.rb
+- lib/cucumber_steps/browser/instance/defaults.rb
+- lib/cucumber_steps/browser/instance/scope_handler.rb
+- lib/cucumber_steps/browser/locating_scope_steps.rb
+- lib/cucumber_steps/browser/sketch_steps.rb
+- lib/cucumber_steps/browser/typing_steps.rb
+- lib/cucumber_steps/browser/visit_steps.rb
+- lib/cucumber_steps/debug.rb
+- lib/cucumber_steps/env_fetcher.rb
 homepage: ''
 licenses:
 - MIT
@@ -97,9 +139,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2