win_gui 0.1.6 → 0.2.0

data/.gitignore

@@ -1,21 +1,21 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/HISTORY

@@ -0,0 +1,7 @@
+== 0.0.0 / 2010-01-08
+
+* Birthday! Initial concept: Following "Scripted Gui testing with Ruby" by Ian Dees
+
+== 0.2.0 / 2010-05-15
+
+* Window class extracted into a separate lib

data/LICENSE

@@ -1,20 +1,20 @@
-Copyright (c) 2009 arvicco
-
-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.
+Copyright (c) 2010 Arvicco
+
+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.rdoc

@@ -1,114 +1,77 @@
-= win_gui
-    by: Arvicco
-    url: http://github.com/arvicco/win_gui
-
-== DESCRIPTION:
-
-WinGui is a module that provides convenient wrapper methods for multiple Win32 API
-functions (mostly from user32.dll) dealing with Windows GUI manipulation/automation.
-In addition to straightforward API wrappers, it also defines more Ruby-like
-abstractions and convenience methods for manipulating windows and other GUI 
-elements (such as WinGui::Window class and its methods).
-
-!!! This project has been discontinued due to problems with Win32::API Callbacks and
-need to support non-MRI Ruby implementations. So, new project is now based on FFI and
-can be found here:http://github.com/arvicco/win (it is now available as a gem 'win').
-
-== SUMMARY
-
-So you want to write a simple program that makes some Win32 API function calls.
-You searched MSDN high and low and you now know exactly what functions you need.
-All you want is just putting those function calls into your Ruby code without too
-much pain. You'd love this to be more or less natural extension of your Ruby code,
-preferably not turning your code base into an ugly C++ like spaghetty
-of CamelCase calls, String/Array pack/unpack gymnastics, buffer allocations,
-extracting return values from [in/out] parameters and checking return codes for 0.
-
-You can definitely use excellent 'win32-api' gem by Daniel J. Berger and Park Heesob
-that allows you to define Win32 API objects for any function you can find on MSDN,
-execute calls on them and even define callback objects that some of those API functions expect.
-
-However, that gem will only take you so far. You'll still have to handle (somewhat)
-gory details of argument preparation, mimicking pointers with Strings and stuff.
-For example, consider the amount of code needed to complete a task as simple as
-getting unicode title text for the window that you already have handle for:
-
-  api = Win32::API.new( 'GetWindowTextW', ['L', 'P', 'I'], 'L', 'user32' )
-  buffer = "\x00" * 1024  # I just hope it will be enough...
-  num_chars = api.call( window_handle, buffer, buffer.size)
-  title = if num_chars == 0
-    nil                   
-  else
-     buffer.force_encoding('utf-16LE').encode('utf-8').rstrip
-  end
-
-Ew, ugly. What about getting information about process id for a known window?
-
-  api = Win32::API.new( 'GetWindowThreadProcessId', ['L', 'P'], 'L' , 'user32' )
-    process_packed = [1].pack('L')
-    thread = api.call(window_handle, process_packed)
-    process = process_packed.unpack('L').first
-
-Wow, packing and unpacking arrays into String to get hold of a simple integer id.
-Just great. Now, wouldn't it be MUCH better if you can just say something like this:
-
-  title = window_text( window_handle)
-  thread, process = window_thread_process_id( window_handle)
-
-What about API functions expecting callbacks? Well, something like this may be nice:
-
-  enum_child_windows( parent_handle, message ){|child_handle, message| puts child_handle }
-
-If you think about it, callbacks are not much more than code blocks, so let's not be afraid
-to treat them as such. It would be also good if test functions return true/false instead of
-zero/nonzero, find functions return nil if nothing was found etc...
-
-So this is an idea behind WinGui library - make Win32 API functions more fun to use
-and feel more natural inside Ruby code. Following the principle of least surprise, we
-define methods with Rubyesque names (minimized? instead of IsMinimized, etc), minimum
-arguments with sensible defaults, explicit return values and generous use of attached blocks.
-
-Well, we even keep a backup solution for those diehard Win32 API longtimers who would rather
-allocate their buffer strings by hand and mess with obscure return codes. If you use original
-CamelCase method name instead of Rubyesque snake_case one, it will expect those standard
-parameters you know and love from MSDN, return your zeroes instead of nils and support no
-other enhancements.
-
-And if you do not see your favorite Windows API function amoung those already defined, it is
-quite easy to define new one with def_api class method that does a lot of heavy lifting for
-you and can be customized with options and code blocks to give you reusable API wrapper method
-with the exact behavior you need.
-
-== DOCUMENTATION:
-
-See WinGui and WinGui::Window for documentation
-
-== REQUIREMENTS:
-
-Only works with Ruby 1.9.1+ since it uses some of the most recent features (block
-arguments given to block, etc...)
-
-== FEATURES/PROBLEMS:
-
-This project is quite new, so it may be not suitable for production-quality systems yet.
-Contributors always welcome!
-
-== INSTALL:
-
-  $ sudo gem install win_gui
-
-== SYNOPSIS:
-
-  require 'win_gui'
-  include WinGui
-
-More examples will follow when the code is closer to production quality...  
-
-== CREDITS:
-
-This library started as an extension of ideas and code described in excellent book
-"Scripted GUI Testing with Ruby" by Ian Dees.
-
-== LICENSE:
-
-Copyright (c) 2009 Arvicco. See LICENSE for details
+= win_gui
+by:: Arvicco
+url:: http://github.com/arvicco/win_gui
+
+== DESCRIPTION:
+
+WinGui is a module that provides higher-level abstractions/wrappers around GUI-related
+Win32 API functions. It uses Win gem as a basis, which in turn uses FFI.
+So (in theory) it should work for any Ruby implementation supporting FFI. In practice,
+it's only been tested under mingw and cygwin flavors of Ruby 1.9.1.
+
+== SUMMARY:
+
+Win gem provides Rubyesque wrappers around Win32 API functions, but it is not enough to
+to make Win32 API calls feel like more or less natural extension of Ruby code.
+The reason for this, straightforward API wrappers are not object-oriented enough.
+
+For example, here is how you deal with typical GUI-related tasks using Win:
+
+  require 'win/gui'
+  include Win::Gui::Window
+
+  window_handle = find_window('WinClass', nil)
+  title = window_text(window_handle )
+  thread, process = window_thread_process_id(window_handle)
+  puts window_handle, title, thread, process
+
+  enum_child_windows(window_handle, message) do |child_handle, message|
+    title = window_text(child_handle )
+    thread, process = window_thread_process_id(child_handle)
+    puts child_handle, title, thread, process
+  end
+  close_window(window_handle)
+
+Ideally, there should be a thin wrapper class around window handle, and the code above should be more like this:
+  require 'win_gui'
+  include WinGui
+
+  window = Window.find(:first, :class => 'WinClass')
+  puts window.handle, window.title, window.thread, window.process
+  window.each_child {|child| puts child.handle, child.title, child.thread, child.process }
+  window.close
+
+This library will try to provide such wrappers and convenience methods that will make working with
+Windows GUI-related code much more fun than it is right now.
+
+== REQUIREMENTS:
+
+Only works with Ruby 1.9.1+ compatible implementations since Win gem uses some of latest Ruby features.
+
+== FEATURES/PROBLEMS:
+
+This project is quite new, so it may be not suitable for production-quality systems yet.
+Contributors always welcome!
+
+== INSTALL:
+
+  $ sudo gem install win_gui
+
+== SYNOPSIS:
+
+  require 'win_gui'
+  include WinGui
+
+More examples will follow when the code is closer to production quality...  
+
+== CREDITS/PRIOR ART:
+
+This library started as an extension of ideas and code described in excellent book
+"Scripted GUI Testing with Ruby" by Ian Dees.
+
+Win32::GuiTest by MoonWolf is a port of eponimous Perl library to Ruby
+(http://raa.ruby-lang.org/project/win32-guitest). I do not like its Perlisms though.
+
+== LICENSE:
+
+Copyright (c) 2010 Arvicco. See LICENSE for details

data/Rakefile

@@ -1,58 +1,24 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "win_gui"
-    gem.summary = %Q{Rubyesque interfaces and wrappers for Win32 API GUI functions}
-    gem.description = %Q{Rubyesque interfaces and wrappers for Win32 API GUI functions}
-    gem.email = "arvitallian@gmail.com"
-    gem.homepage = "http://github.com/arvicco/win_gui"
-    gem.authors = ["arvicco"]
-    gem.add_dependency "win32-api", ">= 1.4.5"
-    gem.add_development_dependency "rspec", ">= 1.2.9"
-    gem.add_development_dependency "cucumber", ">= 0"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-end
-
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-task :spec => :check_dependencies
-
-begin
-  require 'cucumber/rake/task'
-  Cucumber::Rake::Task.new(:features)
-
-  task :features => :check_dependencies
-rescue LoadError
-  task :features do
-    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
-  end
-end
-
-task :default => :spec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "win_gui #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require 'pathname'
+NAME = 'win_gui'
+BASE_PATH = Pathname.new(__FILE__).dirname
+LIB_PATH =  BASE_PATH + 'lib'
+PKG_PATH =  BASE_PATH + 'pkg'
+DOC_PATH =  BASE_PATH + 'rdoc'
+
+$LOAD_PATH.unshift LIB_PATH.to_s
+require 'version'
+
+CLASS_NAME = WinGui
+VERSION = CLASS_NAME::VERSION
+
+begin
+  require 'rake'
+rescue LoadError
+  require 'rubygems'
+  gem 'rake', '~> 0.8.3.1'
+  require 'rake'
+end
+
+# Load rakefile tasks
+Dir['tasks/*.rake'].sort.each { |file| load file }
+

data/VERSION

@@ -1 +1 @@
-0.1.6
+0.2.0

data/features/support/env.rb

@@ -1,4 +1,7 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
-require 'win_gui'
-
-require 'spec/expectations'
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'win_gui'
+require 'spec/expectations'
+require 'spec/stubs/cucumber'
+
+require 'pathname'
+BASE_PATH = Pathname.new(__FILE__).dirname + '../..'

data/features/win_gui.feature

@@ -1,9 +1,9 @@
-Feature: something something
-  In order to something something
-  A user something something
-  something something something
-
-  Scenario: something something
-    Given inspiration
-    When I create a sweet new gem
-    Then everyone should see how awesome I am
+Feature: something something
+  In order to something something
+  A user something something
+  something something something
+
+  Scenario: something something
+    Given inspiration
+    When I create a sweet new gem
+    Then everyone should see how awesome I am

data/lib/version.rb

@@ -0,0 +1,8 @@
+require 'pathname'
+
+module WinGui
+
+  VERSION_FILE = Pathname.new(__FILE__).dirname + '../VERSION'   # :nodoc:
+  VERSION = VERSION_FILE.exist? ? VERSION_FILE.read.strip : nil
+
+end

data/lib/win_gui/window.rb

@@ -1,70 +1,79 @@
-module WinGui
-  class Window
-    include WinGui
-    extend WinGui
-    
-    attr_reader :handle
-    
-    # find top level window by title, return wrapped Window object
-    def self.top_level(title, seconds=3)
-      @handle = timeout(seconds) do
-        sleep WG_SLEEP_DELAY while (h = find_window nil, title) == nil; h
-      end
-      Window.new @handle
-    end  
-    
-    def initialize(handle)
-      @handle = handle
-    end
-   
-    # find child window (control) by title, window class, or control ID:
-    def child(id)
-      result = case id
-        when String
-        by_title = find_window_ex @handle, 0, nil, id.gsub('_' , '&' )
-        by_class = find_window_ex @handle, 0, id, nil
-        by_title ? by_title : by_class
-        when Fixnum
-        get_dlg_item @handle, id
-        when nil
-        find_window_ex @handle, 0, nil, nil
-      else
-        nil
-      end
-      raise "Control '#{id}' not found" unless result
-      Window.new result
-    end
-
-    def children
-      enum_child_windows(@handle,'Msg').map{|child_handle| Window.new child_handle}
-    end
-
-    # emulate click of the control identified by id
-    def click(id)
-      h = child(id).handle
-      rectangle = [0, 0, 0, 0].pack 'LLLL'
-      get_window_rect h, rectangle
-      left, top, right, bottom = rectangle.unpack 'LLLL'
-      center = [(left + right) / 2, (top + bottom) / 2]
-      set_cursor_pos *center
-      mouse_event MOUSEEVENTF_LEFTDOWN, 0, 0, 0, 0
-      mouse_event MOUSEEVENTF_LEFTUP, 0, 0, 0, 0
-    end
-    
-    def close
-      post_message @handle, WM_SYSCOMMAND, SC_CLOSE, 0
-    end
-    
-    def wait_for_close
-      timeout(WG_CLOSE_TIMEOUT) do
-        sleep WG_SLEEP_DELAY while window_visible?(@handle) 
-      end
-    end
-    
-    def text
-      buffer = "\x0" * 2048
-      length = send_message @handle, WM_GETTEXT, buffer.length, buffer
-      length == 0 ? '' : buffer[0..length - 1]
-    end
-  end
+require 'win/gui'
+
+module WinGui
+  # Delay between key commands (events)
+  WG_KEY_DELAY = 0.00001
+  # Wait delay quant
+  WG_SLEEP_DELAY = 0.001
+  # Timeout waiting for Window to be closed
+  WG_CLOSE_TIMEOUT = 1
+
+  class Window
+    include Win::Gui
+    extend Win::Gui
+    
+    def initialize(handle)
+      @handle = handle
+    end
+
+    attr_reader :handle
+    
+    # find top level window by title, return wrapped Window object
+    def self.top_level(title, seconds=3)
+      @handle = timeout(seconds) do
+        sleep WG_SLEEP_DELAY while (h = find_window nil, title) == nil; h
+      end
+      Window.new @handle
+    end  
+    
+    # find child window (control) by title, window class, or control ID:
+    def child(id)
+      result = case id
+        when String
+        by_title = find_window_ex @handle, 0, nil, id.gsub('_' , '&' )
+        by_class = find_window_ex @handle, 0, id, nil
+        by_title ? by_title : by_class
+        when Fixnum
+        get_dlg_item @handle, id
+        when nil
+        find_window_ex @handle, 0, nil, nil
+      else
+        nil
+      end
+      raise "Control '#{id}' not found" unless result
+      Window.new result
+    end
+
+    def children
+      enum_child_windows(@handle).map{|child_handle| Window.new child_handle}
+    end
+
+    # emulate click of the control identified by id
+    def click(id)
+      h = child(id).handle
+      rectangle = [0, 0, 0, 0].pack 'LLLL'
+      get_window_rect h, rectangle
+      left, top, right, bottom = rectangle.unpack 'LLLL'
+      center = [(left + right) / 2, (top + bottom) / 2]
+      set_cursor_pos *center
+      mouse_event MOUSEEVENTF_LEFTDOWN, 0, 0, 0, 0
+      mouse_event MOUSEEVENTF_LEFTUP, 0, 0, 0, 0
+    end
+    
+    def close
+      post_message @handle, WM_SYSCOMMAND, SC_CLOSE, nil
+    end
+    
+    def wait_for_close
+      timeout(WG_CLOSE_TIMEOUT) do
+        sleep WG_SLEEP_DELAY while window_visible?(@handle) 
+      end
+    end
+    
+    def text
+      buffer = "\x0" * 2048
+      length = send_message @handle, WM_GETTEXT, buffer.length, buffer
+      length == 0 ? '' : buffer[0..length - 1]
+    end
+  end
 end

data/lib/win_gui.rb

@@ -1,3 +1,25 @@
-win_gui_dir = File.join(File.dirname(__FILE__),"win_gui" )
-$LOAD_PATH.unshift win_gui_dir unless $LOAD_PATH.include?(win_gui_dir)
-require 'win_gui'
+require 'version'
+
+module WinGui
+
+#  require "bundler"
+#  Bundler.setup
+
+  # Requires ruby source file(s). Accepts either single filename/glob or Array of filenames/globs.
+  # Accepts following options:
+  # :*file*:: Lib(s) required relative to this file - defaults to __FILE__
+  # :*dir*:: Required lib(s) located under this dir name - defaults to gem name
+  #
+  def self.require_libs( libs, opts={} )
+    file = Pathname.new(opts[:file] || __FILE__)
+    [libs].flatten.each do |lib|
+      name = file.dirname + (opts[:dir] || file.basename('.*')) + lib.gsub(/(?<!.rb)$/, '.rb')
+      Pathname.glob(name.to_s).sort.each {|rb| require rb}
+    end
+  end
+end  # module WinGui
+
+# Require all ruby source files located under directory lib/win_gui
+# If you need files in specific order, you should specify it here before the glob
+WinGui.require_libs %W[**/*]
+

data/spec/spec.opts

@@ -1,2 +1,2 @@
---color
+--color
 --format nested