rautomation 0.17.0 → 1.0.0

data/lib/rautomation/window.rb

@@ -72,27 +72,27 @@ module RAutomation
       @@wait_timeout = 60
 
       # Change the timeout to wait before {WaitHelper::TimeoutError} is raised.
-      # @param [Fixnum] timeout in seconds.
+      # @param [Integer] timeout in seconds.
       def wait_timeout=(timeout)
         @@wait_timeout = timeout
       end
 
       # Retrieve current timeout in seconds to wait before {WaitHelper::TimeoutError} is raised.
-      # @return [Fixnum] timeout in seconds
+      # @return [Integer] timeout in seconds
       def wait_timeout
         @@wait_timeout
       end
 
     end
 
-    # @return [Fixnum] handle of the window which is used internally for other methods.
+    # @return [Integer] handle of the window which is used internally for other methods.
     # @raise [UnknownWindowException] if the window doesn't exist.
     def hwnd
       wait_until_present
       @window.hwnd
     end
 
-    # @return [Fixnum] process identifier (PID) of the window.
+    # @return [Integer] process identifier (PID) of the window.
     # @raise [UnknownWindowException] if the window doesn't exist.
     def pid
       wait_until_present

data/rautomation.gemspec

@@ -1,34 +1,36 @@
-# -*- encoding: utf-8 -*-
-Gem::Specification.new do |s|
-  s.name = %q{rautomation}
-  s.version = File.read("VERSION").strip
-  s.authors = [%q{Jarmo Pertman}]
-  s.email = %q{jarmo.p@gmail.com}
-  s.description = %q{RAutomation is a small and easy to use library for helping out to automate windows and their controls
-for automated testing.
-
-RAutomation provides:
-* Easy to use and user-friendly API (inspired by Watir http://www.watir.com)
-* Cross-platform compatibility
-* Easy extensibility - with small scripting effort it's possible to add support for not yet
-  supported platforms or technologies}
-  s.homepage = %q{http://github.com/jarmo/RAutomation}
-  s.summary = %q{Automate windows and their controls through user-friendly API with Ruby}
-  s.license = "MIT"
-
-  ext_binaries = [
-    "ext/IAccessibleDLL/Release/IAccessibleDLL.dll",
-    "ext/UiaDll/Release/UiaDll.dll",
-    "ext/UiaDll/Release/RAutomation.UIA.dll",
-    "ext/WindowsForms/Release/WindowsForms.exe"
-  ]
-  s.files         = `git ls-files`.split("\n") + ext_binaries
-  s.test_files    = `git ls-files -- spec/*`.split("\n")
-  s.require_paths = ["lib"]  
-
-  s.add_dependency("ffi", "~>1.9.0")
-  s.add_development_dependency("rspec", "~> 2.14")
-  s.add_development_dependency("rake")
-  s.add_development_dependency("yard")
-end
-
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name = %q{rautomation}
+  s.version = File.read("VERSION").strip
+  s.authors = [%q{Jarmo Pertman}]
+  s.email = %q{jarmo.p@gmail.com}
+  s.description = %q{RAutomation is a small and easy to use library for helping out to automate windows and their controls
+for automated testing.
+
+RAutomation provides:
+* Easy to use and user-friendly API (inspired by Watir http://www.watir.com)
+* Cross-platform compatibility
+* Easy extensibility - with small scripting effort it's possible to add support for not yet
+  supported platforms or technologies}
+  s.homepage = %q{http://github.com/jarmo/RAutomation}
+  s.summary = %q{Automate windows and their controls through user-friendly API with Ruby}
+  s.license = "MIT"
+
+  ext_binaries = [
+    "ext/IAccessibleDLL/Release/IAccessibleDLL.dll",
+    "ext/UiaDll/Release/UiaDll.dll",
+    "ext/UiaDll/Release/RAutomation.UIA.dll",
+    "ext/WindowsForms/Release/WindowsForms.exe"
+  ]
+  s.files         = `git ls-files`.split("\n") + ext_binaries
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ["lib"]  
+
+  s.add_dependency("ffi", "~> 1.11.0")
+  s.add_development_dependency("rspec", "~> 2.14")
+  s.add_development_dependency("rake")
+  s.add_development_dependency("yard")
+  s.add_development_dependency("redcarpet")
+  s.add_development_dependency("github-markup")
+end
+

data/spec/button_spec.rb

@@ -1,69 +1,68 @@
-require 'spec_helper'
-
-describe RAutomation::Button do
-  it "#button" do
-    RAutomation::Window.new(:title => SpecHelper::DATA[:window1_title]).
-      button(:value => "Close").should exist
-
-    RAutomation::Window.wait_timeout = 0.1
-    expect {RAutomation::Window.new(:title => "non-existing-window").button(:value => "Something")}.
-      to raise_exception(RAutomation::UnknownWindowException)
-  end
-
-  it "#value" do
-    RAutomation::Window.new(:title => SpecHelper::DATA[:window1_title]).
-      button(:value => "Close").value.should == "Close"
-
-    RAutomation::Window.wait_timeout = 0.1
-    expect {RAutomation::Window.new(:title => SpecHelper::DATA[:window1_title]).button(:value => "non-existent-button").value}.
-      to raise_exception(RAutomation::UnknownButtonException)
-  end
-
-  it "#exists?" do
-    window = RAutomation::Window.new(:title => SpecHelper::DATA[:window1_title])
-    window.button(:value => "Close").should exist
-    window.button(:value => "non-existent-button").should_not exist
-  end
-
-  it "clicking non-existing button raises exception" do
-    window = RAutomation::Window.new(:title => SpecHelper::DATA[:window1_title])
-    RAutomation::Window.wait_timeout = 0.1
-    expect {window.button(:value => "non-existent-button").click}.
-      to raise_exception(RAutomation::UnknownButtonException)
-  end
-
-  #This spec will randomly fail. Why?
-  it "#click" do
-    window = RAutomation::Window.new(:title => SpecHelper::DATA[:window1_title])
-
-    button = window.button(:value => "Close")
-    button.should exist
-    button.click
-
-    button.should_not exist
-    window.should_not exist
-  end
-
-  it "#click with a block for defining successful click returning false raises a TimeoutError" do
-    window = RAutomation::Window.new(:title => SpecHelper::DATA[:window1_title])
-    RAutomation::Window.wait_timeout = 5
-    button = window.button(:value => "Close")
-    expect {button.click {false}}.
-      to raise_exception(RAutomation::WaitHelper::TimeoutError)
-
-    button.should_not exist
-    window.should_not exist
-  end
-
-  it "#click with a block for defining successful click returning true" do
-    RAutomation::Window.wait_timeout = 10
-    window = RAutomation::Window.new(:title => SpecHelper::DATA[:window1_title])
-    button = window.button(:value => "Close")
-    button.should exist
-    button.click {|button| !button.exists? && !window.exists?}
-
-    button.should_not exist
-    window.should_not exist
-  end
-
-end
+require 'spec_helper'
+
+describe RAutomation::Button do
+  it "#button" do
+    RAutomation::Window.new(:title => SpecHelper::DATA[:window1_title]).
+      button(:value => "Close").should exist
+
+    RAutomation::Window.wait_timeout = 0.1
+    expect {RAutomation::Window.new(:title => "non-existing-window").button(:value => "Something")}.
+      to raise_exception(RAutomation::UnknownWindowException)
+  end
+
+  it "#value" do
+    RAutomation::Window.new(:title => SpecHelper::DATA[:window1_title]).
+      button(:value => "Close").value.should == "Close"
+
+    RAutomation::Window.wait_timeout = 0.1
+    expect {RAutomation::Window.new(:title => SpecHelper::DATA[:window1_title]).button(:value => "non-existent-button").value}.
+      to raise_exception(RAutomation::UnknownButtonException)
+  end
+
+  it "#exists?" do
+    window = RAutomation::Window.new(:title => SpecHelper::DATA[:window1_title])
+    window.button(:value => "Close").should exist
+    window.button(:value => "non-existent-button").should_not exist
+  end
+
+  it "clicking non-existing button raises exception" do
+    window = RAutomation::Window.new(:title => SpecHelper::DATA[:window1_title])
+    RAutomation::Window.wait_timeout = 0.1
+    expect {window.button(:value => "non-existent-button").click}.
+      to raise_exception(RAutomation::UnknownButtonException)
+  end
+
+  it "#click" do
+    window = RAutomation::Window.new(:title => SpecHelper::DATA[:window1_title])
+
+    button = window.button(:value => "Close")
+    button.should exist
+    button.click
+
+    button.should_not exist
+    RAutomation::WaitHelper.wait_until { !window.exists? }
+  end
+
+  it "#click with a block for defining successful click returning false raises a TimeoutError" do
+    window = RAutomation::Window.new(:title => SpecHelper::DATA[:window1_title])
+    RAutomation::Window.wait_timeout = 5
+    button = window.button(:value => "Close")
+    expect {button.click {false}}.
+      to raise_exception(RAutomation::WaitHelper::TimeoutError)
+
+    button.should_not exist
+    window.should_not exist
+  end
+
+  it "#click with a block for defining successful click returning true" do
+    RAutomation::Window.wait_timeout = 10
+    window = RAutomation::Window.new(:title => SpecHelper::DATA[:window1_title])
+    button = window.button(:value => "Close")
+    button.should exist
+    button.click {|button| !button.exists? && !window.exists?}
+
+    button.should_not exist
+    window.should_not exist
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,122 +1,122 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'rautomation'
-require 'rspec'
-require 'timeout'
-
-module SpecHelper
-  # @private
-  def adapter
-    ENV["RAUTOMATION_ADAPTER"] && ENV["RAUTOMATION_ADAPTER"].to_sym || RAutomation::Adapter::Helper.default_adapter
-  end
-
-  def navigate_to_simple_elements
-    main_window = RAutomation::Window.new(:title => "MainFormWindow")
-    main_window.button(:value => "Simple Elements").click { RAutomation::Window.new(:title => "SimpleElementsForm").present? }
-  end
-
-  module_function :adapter, :navigate_to_simple_elements
-
-  # Since adapters are different then the windows to be tested
-  # might be different also.
-  #
-  # This constant allows to create input data for specs which could differ between the adapters.
-  #
-  # There has to be 2 windows:
-  # 1) Some random window, which is maximizable, minimizable, close'able and etc.
-  # 2) Browser window, which opens up a test.html where JavaScript prompt with a Button and a TextField objects will be shown.
-  DATA = {
-          # This adapter needs Windows OS with Internet Explorer installed into 'c:\program files\internet explorer'.
-          :autoit => {
-                  # Path to some binary, which opens up a window, what can be
-                  # minimized, maximized, activated, closed and etc.
-                  :window1 => "ext\\WindowsForms\\Release\\WindowsForms.exe",
-                  :window2 => "calc",
-                  :window2_title => /calc/i,
-                  # Window 1 title, has to be a Regexp.
-                  :window1_title => /FormWindow/i,
-                  :window1_full_title => 'MainFormWindow',
-                  # Window 1 should have this text on it.
-                  :window1_text => "This is a sample text",
-                  # When sending ENTER on Window 2, then the window OK button should be pressed and Window 2 should be closed.
-                  # "A" key
-                  :window1_send_keys => "A",
-                  :proc_after_send_keys => lambda do
-                    about_box = RAutomation::Window.new(:title => /About/i)
-                    RAutomation::WaitHelper.wait_until {about_box.present?}
-                  end,
-                  # Window 1 should have a button with the following text.
-                  :window1_button_text => "&About",
-                  # Window 1 should have a text field with the specified class name.
-                  :window1_text_field_class => "Edit",
-                  # Adapter internal method invocation for getting title of window2
-                  :title_proc => lambda {|win| win.WinGetTitle("[TITLE:MainFormWindow]")}
-          },
-          :win_32 => {
-                  # Path to some binary, which opens up a window, what can be
-                  # minimized, maximized, activated, closed and etc.
-                  :window1 => "ext\\WindowsForms\\Release\\WindowsForms.exe",
-                  :window2 => "calc",
-                  :window2_title => /calc/i,
-                  # Window 1 title, has to be a Regexp.
-                  :window1_title => /FormWindow/i,
-                  :window1_full_title => 'MainFormWindow',
-                  # Window 1 should have this text on it.
-                  :window1_text => "This is a sample text",
-                  # When sending ENTER on Window 2, then the window OK button should be pressed and Window 2 should be closed.
-                  # "A" key
-                  :window1_send_keys => "A",
-                  :proc_after_send_keys => lambda do
-                    about_box = RAutomation::Window.new(:title => /About/i)
-                    RAutomation::WaitHelper.wait_until {about_box.present?}
-                  end,
-                  # Window 1 should have a button with the following text.
-                  :window1_button_text => "&About",
-                  # Window 1 should have a text field with the specified class name.
-                  :window1_text_field_class => "Edit",
-                  # Adapter internal method invocation for getting title of window2
-                  :title_proc => lambda {|win| win.window_title(win.hwnd)}
-          },
-          #Just copying :win_ffi data for now
-          :ms_uia => {
-                  # Path to some binary, which opens up a window, what can be
-                  # minimized, maximized, activated, closed and etc.
-                  :window1 => "ext\\WindowsForms\\Release\\WindowsForms.exe",
-                  :window2 => "calc",
-                  :window2_title => /calc/i,
-                  # Window 1 title, has to be a Regexp.
-                  :window1_title => /FormWindow/i,
-                  :window1_full_title => 'MainFormWindow',
-                  # Window 1 should have this text on it.
-                  :window1_text => "This is a sample text",
-                  # When sending ENTER on Window 2, then the window OK button should be pressed and Window 2 should be closed.
-                  # "A" key
-                  :window1_send_keys => "A",
-                  :proc_after_send_keys => lambda do
-                    about_box = RAutomation::Window.new(:title => /About/i)
-                    RAutomation::WaitHelper.wait_until {about_box.present?}
-                  end,
-                  # Window 1 should have a button with the following text.
-                  :window1_button_text => "&About",
-                  # Window 1 should have a text field with the specified class name.
-                  :window1_text_field_class => "Edit",
-                  # Adapter internal method invocation for getting title of window2
-                  :title_proc => lambda {|win| win.window_title(win.hwnd)}
-          }
-  }[adapter]
-end
-
-
-RSpec.configure do |config|
-  config.before(:each) do
-    RAutomation::Window.wait_timeout = 15
-
-    unless example.metadata[:pure_unit]
-      @pid1 = IO.popen(SpecHelper::DATA[:window1]).pid
-      RAutomation::WaitHelper.wait_until { RAutomation::Window.new(:pid => @pid1).present? }
-    end
-  end
-
-  config.after(:each) do
-    Process.kill(9, @pid1) rescue nil
-  end
-end
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rautomation'
+require 'rspec'
+require 'timeout'
+
+module SpecHelper
+  # @private
+  def adapter
+    ENV["RAUTOMATION_ADAPTER"] && ENV["RAUTOMATION_ADAPTER"].to_sym || RAutomation::Adapter::Helper.default_adapter
+  end
+
+  def navigate_to_simple_elements
+    main_window = RAutomation::Window.new(:title => "MainFormWindow")
+    main_window.button(:value => "Simple Elements").click { RAutomation::Window.new(:title => "SimpleElementsForm").present? }
+  end
+
+  module_function :adapter, :navigate_to_simple_elements
+
+  # Since adapters are different then the windows to be tested
+  # might be different also.
+  #
+  # This constant allows to create input data for specs which could differ between the adapters.
+  #
+  # There has to be 2 windows:
+  # 1) Some random window, which is maximizable, minimizable, close'able and etc.
+  # 2) Browser window, which opens up a test.html where JavaScript prompt with a Button and a TextField objects will be shown.
+  DATA = {
+          # This adapter needs Windows OS with Internet Explorer installed into 'c:\program files\internet explorer'.
+          :autoit => {
+                  # Path to some binary, which opens up a window, what can be
+                  # minimized, maximized, activated, closed and etc.
+                  :window1 => "ext\\WindowsForms\\Release\\WindowsForms.exe",
+                  :window2 => "notepad",
+                  :window2_title => /notepad/i,
+                  # Window 1 title, has to be a Regexp.
+                  :window1_title => /FormWindow/i,
+                  :window1_full_title => 'MainFormWindow',
+                  # Window 1 should have this text on it.
+                  :window1_text => "This is a sample text",
+                  # When sending ENTER on Window 2, then the window OK button should be pressed and Window 2 should be closed.
+                  # "A" key
+                  :window1_send_keys => "A",
+                  :proc_after_send_keys => lambda do
+                    about_box = RAutomation::Window.new(:title => /About/i)
+                    RAutomation::WaitHelper.wait_until {about_box.present?}
+                  end,
+                  # Window 1 should have a button with the following text.
+                  :window1_button_text => "&About",
+                  # Window 1 should have a text field with the specified class name.
+                  :window1_text_field_class => "Edit",
+                  # Adapter internal method invocation for getting title of window2
+                  :title_proc => lambda {|win| win.WinGetTitle("[TITLE:MainFormWindow]")}
+          },
+          :win_32 => {
+                  # Path to some binary, which opens up a window, what can be
+                  # minimized, maximized, activated, closed and etc.
+                  :window1 => "ext\\WindowsForms\\Release\\WindowsForms.exe",
+                  :window2 => "notepad",
+                  :window2_title => /notepad/i,
+                  # Window 1 title, has to be a Regexp.
+                  :window1_title => /FormWindow/i,
+                  :window1_full_title => 'MainFormWindow',
+                  # Window 1 should have this text on it.
+                  :window1_text => "This is a sample text",
+                  # When sending ENTER on Window 2, then the window OK button should be pressed and Window 2 should be closed.
+                  # "A" key
+                  :window1_send_keys => "A",
+                  :proc_after_send_keys => lambda do
+                    about_box = RAutomation::Window.new(:title => /About/i)
+                    RAutomation::WaitHelper.wait_until {about_box.present?}
+                  end,
+                  # Window 1 should have a button with the following text.
+                  :window1_button_text => "&About",
+                  # Window 1 should have a text field with the specified class name.
+                  :window1_text_field_class => "Edit",
+                  # Adapter internal method invocation for getting title of window2
+                  :title_proc => lambda {|win| win.window_title(win.hwnd)}
+          },
+          #Just copying :win_ffi data for now
+          :ms_uia => {
+                  # Path to some binary, which opens up a window, what can be
+                  # minimized, maximized, activated, closed and etc.
+                  :window1 => "ext\\WindowsForms\\Release\\WindowsForms.exe",
+                  :window2 => "notepad",
+                  :window2_title => /notepad/i,
+                  # Window 1 title, has to be a Regexp.
+                  :window1_title => /FormWindow/i,
+                  :window1_full_title => 'MainFormWindow',
+                  # Window 1 should have this text on it.
+                  :window1_text => "This is a sample text",
+                  # When sending ENTER on Window 2, then the window OK button should be pressed and Window 2 should be closed.
+                  # "A" key
+                  :window1_send_keys => "A",
+                  :proc_after_send_keys => lambda do
+                    about_box = RAutomation::Window.new(:title => /About/i)
+                    RAutomation::WaitHelper.wait_until {about_box.present?}
+                  end,
+                  # Window 1 should have a button with the following text.
+                  :window1_button_text => "&About",
+                  # Window 1 should have a text field with the specified class name.
+                  :window1_text_field_class => "Edit",
+                  # Adapter internal method invocation for getting title of window2
+                  :title_proc => lambda {|win| win.window_title(win.hwnd)}
+          }
+  }[adapter]
+end
+
+
+RSpec.configure do |config|
+  config.before(:each) do
+    RAutomation::Window.wait_timeout = 15
+
+    unless example.metadata[:pure_unit]
+      @pid1 = IO.popen(SpecHelper::DATA[:window1]).pid
+      RAutomation::WaitHelper.wait_until { RAutomation::Window.new(:pid => @pid1).present? }
+    end
+  end
+
+  config.after(:each) do
+    Process.kill(9, @pid1) rescue nil
+  end
+end