win_gui 0.1.0

data/book_code/simplify/windows_gui.rb

@@ -0,0 +1,232 @@
+#---
+# Excerpted from "Scripted GUI Testing With Ruby",
+# published by The Pragmatic Bookshelf.
+# Copyrights apply to this code. It may not be used to create training material, 
+# courses, books, articles, and the like. Contact us if you are in doubt.
+# We make no guarantees that this code is fit for any purpose. 
+# Visit http://www.pragmaticprogrammer.com/titles/idgtr for more book information.
+#---
+
+class String
+  def snake_case
+    gsub(/([a-z])([A-Z0-9])/, '\1_\2').downcase #(1)
+  end
+end
+
+
+
+
+require 'Win32API'
+
+module WindowsGui
+  def self.def_api(function, parameters, return_value)              #(2)
+    api = Win32API.new 'user32', function, parameters, return_value
+
+    define_method(function.snake_case) do |*args|                   #(3)
+      api.call *args                                                #(4)
+    end
+  end
+end
+
+
+
+
+module WindowsGui
+  def_api 'FindWindow',    ['P', 'P'], 'L'
+  def_api 'keybd_event',   ['I', 'I', 'L', 'L'], 'V'
+
+  # rest of API definitions here...
+
+  WM_GETTEXT = 0x000D
+  WM_SYSCOMMAND = 0x0112
+
+  # rest of constant definitions here...
+end
+
+
+
+module WindowsGui
+  def_api 'FindWindow',      ['P', 'P'], 'L'
+  def_api 'FindWindowEx',    ['L', 'L', 'P', 'P'], 'L'
+  def_api 'PostMessage',     ['L', 'L', 'L', 'L'], 'L'
+  def_api 'SendMessage',     ['L', 'L', 'L', 'P'], 'L'
+  def_api 'keybd_event',     ['I', 'I', 'L', 'L'], 'V'
+  def_api 'GetDlgItem',      ['L', 'L'], 'L'
+  def_api 'GetWindowRect',   ['L', 'P'], 'I'
+  def_api 'SetCursorPos',    ['L', 'L'], 'I'
+  def_api 'mouse_event',     ['L', 'L', 'L', 'L', 'L'], 'V'
+  def_api 'IsWindowVisible', ['L'], 'L'
+
+  SC_CLOSE = 0xF060
+
+  IDNO = 7
+
+  MOUSEEVENTF_LEFTDOWN = 0x0002
+  MOUSEEVENTF_LEFTUP = 0x0004
+
+  KEYEVENTF_KEYDOWN = 0
+  KEYEVENTF_KEYUP = 2
+end
+
+
+
+module WindowsGui
+  VK_SHIFT   = 0x10
+  VK_CONTROL = 0x11
+  VK_BACK    = 0x08
+end
+
+
+
+
+class String
+  def to_keys
+    unless size == 1                 #(5)
+      raise "conversion is for single characters only"
+    end
+
+    ascii = unpack('C')[0]           #(6)
+
+    case self                        #(7)
+    when '0'..'9'
+      [ascii - ?0 + 0x30]
+    when 'A'..'Z'
+      [WindowsGui.const_get(:VK_SHIFT), ascii]
+    when 'a'..'z'
+      [ascii - ?a + ?A]
+    when ' '
+      [ascii]
+    else
+      raise "Can't convert unknown character #{self}"
+    end
+  end
+end
+
+
+
+
+module WindowsGui
+  def keystroke(*keys)
+    return if keys.empty?
+
+    keybd_event keys.first, 0, KEYEVENTF_KEYDOWN, 0
+    sleep 0.05
+    keystroke *keys[1..-1]
+    sleep 0.05
+    keybd_event keys.first, 0, KEYEVENTF_KEYUP, 0
+  end
+end
+
+
+
+
+module WindowsGui
+  def type_in(message)
+    message.scan(/./m) do |char|
+      keystroke(*char.to_keys)
+    end
+  end
+end
+
+
+
+
+module WindowsGui
+  class Window
+    include WindowsGui #(8)
+
+    attr_reader :handle
+
+    def initialize(handle)
+      @handle = handle
+    end
+
+    def close
+      post_message @handle, WM_SYSCOMMAND, SC_CLOSE, 0
+    end
+
+    def wait_for_close #(9)
+      timeout(5) do
+        sleep 0.2 until 0 == is_window_visible(@handle)
+      end
+    end
+
+    def text
+      buffer = '\0' * 2048
+      length = send_message @handle, WM_GETTEXT, buffer.length, buffer
+      length == 0 ? '' : buffer[0..length - 1]
+    end
+  end
+end
+
+
+
+
+class WindowsGui::Window
+  extend WindowsGui #(10)
+
+  def self.top_level(title, seconds=3)
+    @handle = timeout(seconds) do
+      sleep 0.2 while (h = find_window nil, title) <= 0; h
+    end
+
+    Window.new @handle
+  end
+end
+
+
+
+
+class WindowsGui::Window
+  def child(id)
+    result = case id
+    when String
+      by_title = find_window_ex @handle, 0, nil, id.gsub('_', '&') #(11)
+      by_class = find_window_ex @handle, 0, id, nil
+      by_title > 0 ? by_title : by_class
+    when Fixnum
+      get_dlg_item @handle, id
+    else
+      0
+    end
+
+    raise "Control '#{id}' not found" if result == 0
+    Window.new result
+  end
+end
+
+
+
+
+class WindowsGui::Window
+  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
+end
+
+
+
+
+module WindowsGui
+  def dialog(title, seconds=3)
+    d = begin
+      w = Window.top_level(title, seconds)
+      yield(w) ? w : nil #(12)
+    rescue TimeoutError
+    end
+
+    d.wait_for_close if d
+    return d
+  end
+end
+

data/book_code/simplify/windows_gui_spec.rb

@@ -0,0 +1,35 @@
+#---
+# Excerpted from "Scripted GUI Testing With Ruby",
+# published by The Pragmatic Bookshelf.
+# Copyrights apply to this code. It may not be used to create training material, 
+# courses, books, articles, and the like. Contact us if you are in doubt.
+# We make no guarantees that this code is fit for any purpose. 
+# Visit http://www.pragmaticprogrammer.com/titles/idgtr for more book information.
+#---
+
+require 'windows_gui'
+
+describe WindowsGui do                       #(1)
+  include WindowsGui
+  
+  it 'wraps a Windows call with a method' do
+    find_window(nil, nil).should_not == 0    #(2)
+  end
+
+  it 'enforces the argument count' do
+    lambda {find_window}.should raise_error  #(3)
+  end
+end
+
+
+
+
+describe String, '#snake_case' do
+  it 'transforms CamelCase strings' do
+    'GetCharWidth32'.snake_case.should == 'get_char_width_32'
+  end
+  
+  it 'leaves snake_case strings intact' do
+    'keybd_event'.snake_case.should == 'keybd_event'
+  end
+end

data/book_code/story/invite.story

@@ -0,0 +1,19 @@
+Story: minimalist invites
+  As a host with lots to do
+  I want to plan a party with a minimum of mouse clicks
+  So that I can get on with the rest of my tasks
+  
+  Scenario: manual invites
+    Given a party called "Celebration"
+    And a description of "There's a party goin' on"
+    And a location of "Right here"
+    And a starting time of September 29, 2010 at 12:30 PM
+    And an ending time of September 29, 2010 at 12:35 PM
+
+    When I view the invitation
+    Then I should see the Web address to send to my friends
+    And the name should be "Celebration"
+    And the description should be "There's a party goin' on"
+    And the location should be "Right here"
+    And the party should begin on September 29, 2010 at 12:30 PM
+    And the party should end on September 29, 2010 at 12:35 PM

data/book_code/story/journal.txt

@@ -0,0 +1,29 @@
+Make sure you install the Selenium gem, with a capital S.
+
+First story.
+
+Add browser code.
+
+./script/generate rspec_scaffold Party name:string description:text location:text begins_at:datetime ends_at:datetime
+
+rake db:migrate
+
+./script/generate migration AddLinkToParty link:string
+
+Edit view.
+
+RESTful with to_param
+
+Make sure date/time updates!!!!
+
+Scenario: email invites
+  Given a blank invitation
+  When I plan a party called "Celebration"
+  And I enter a description of "Good times, come on"
+  And I enter a location of "Right here in Jersey City, NJ"
+  And I enter a starting time of "Sep. 29, 1980, 8 PM"
+  And I enter an ending time of "Sep. 29, 1980, 10 PM"
+  And I enter a recipient address of "example@example.com"
+  Then I should see an email preview
+  When I confirm the email
+  Then I should see a confirmation

data/book_code/story/novite_stories.rb

@@ -0,0 +1,156 @@
+#---
+# Excerpted from "Scripted GUI Testing With Ruby",
+# published by The Pragmatic Bookshelf.
+# Copyrights apply to this code. It may not be used to create training material, 
+# courses, books, articles, and the like. Contact us if you are in doubt.
+# We make no guarantees that this code is fit for any purpose. 
+# Visit http://www.pragmaticprogrammer.com/titles/idgtr for more book information.
+#---
+
+require 'rubygems'
+require 'spec/story'
+require 'chronic'
+require 'party'
+
+class Listener
+  attr_reader :browser
+  
+  def run_started(num_scenarios)
+    @browser = Selenium::SeleniumDriver.new \
+      'localhost', 4444, '*firefox', 'http://localhost:3000', 10000
+    @browser.start
+  end
+
+  def run_ended
+    @browser.stop
+  end
+  
+  def method_missing(name, *args, &block)
+    # We don't care about the rest of the Story Runner events.
+  end
+end
+
+listener = Listener.new
+Spec::Story::Runner.register_listener(listener)
+
+
+
+
+steps_for :planning do
+  Given 'a party called "$name"' do |name|
+    @party = Party.new(listener.browser)
+    @party.name = name
+  end
+
+  Given 'a description of "$desc"' do |desc|
+    @party.description = desc
+  end
+  
+  Given 'a location of "$loc"' do |loc|
+    @party.location = loc
+  end
+  
+  Given /an? $event time of $sometime/ do |event, sometime|   #(1)
+    clean = sometime.gsub ',', ' '
+    date_time = Chronic.parse clean, :now => Time.now - 86400 #(2)
+
+    if event == 'starting'
+      @party.begins_at = date_time
+    else
+      @party.ends_at = date_time
+    end
+  end
+
+  When 'I view the invitation' do
+    @party.save_and_view
+  end
+end
+
+
+
+
+steps_for :reviewing do
+  Then 'the $setting should be "$value"' do |setting, value|
+    @party.send(setting).should == value
+  end
+
+  Then 'the party should $event on $date_time' do |event, date_time|
+    actual_time =
+      (event == 'begin') ?
+      @party.begins_at :
+      @party.ends_at
+
+    clean = date_time.gsub ',', ' '
+    expected_time = Chronic.parse clean, :now => Time.now - 86400
+    
+    actual_time.should == expected_time
+  end
+  
+  Then 'I should see the Web address to send to my friends' do
+    @party.link.should match(%r{^http://})
+  end
+end
+
+
+
+
+steps_for :rsvp do
+  Then 'I should see the party details' do
+    @party.should have_name
+    @party.should have_description
+    @party.should have_location
+    @party.should have_times
+  end
+  
+  When /I answer that "$guest" will( not)? attend/ do |guest, answer|
+    attending = !answer.include?('not')
+    @party.rsvp guest, attending
+  end
+
+  Then 'I should see "$guest" in the list of $type' do |guest, type|
+    want_attending = (type == 'partygoers')
+    @party.responses(want_attending).should include(guest)
+  end
+end
+
+
+
+
+steps_for :email do
+  Given 'a guest list of "$list"' do |list|
+    @party.recipients = list
+  end
+  
+  Then 'I should see that e-mail was sent to "$list"' do |list|
+    @party.notice.include?(list).should be_true
+  end
+
+  When 'I view the e-mail that was sent to "$address"' do |address|
+    @email = @party.email_to address
+  end
+  
+  Then 'I should see "Yes/No" links' do
+    @email.should match(%r{Yes - http://})
+    @email.should match(%r{No - http://})
+  end
+  
+  When 'I follow the "$answer" link' do |answer|
+    link = %r{#{answer} - (http://.+)}.match(@email)[1]
+    @party.rsvp_at link
+  end
+end
+
+
+
+
+with_steps_for :planning, :reviewing do
+  run 'invite.story'
+end
+
+
+
+
+with_steps_for :planning, :reviewing, :rsvp, :email do
+  run 'rsvp.story'
+end
+

data/book_code/story/party.rb

@@ -0,0 +1,149 @@
+#---
+# Excerpted from "Scripted GUI Testing With Ruby",
+# published by The Pragmatic Bookshelf.
+# Copyrights apply to this code. It may not be used to create training material, 
+# courses, books, articles, and the like. Contact us if you are in doubt.
+# We make no guarantees that this code is fit for any purpose. 
+# Visit http://www.pragmaticprogrammer.com/titles/idgtr for more book information.
+#---
+
+require 'rubygems'
+require 'selenium'
+require 'time'
+
+class Party
+  def initialize(browser)
+    @browser = browser
+    @browser.open '/parties/new'
+  end
+
+  def self.def_setting(setting, type = :read_write)
+    if type == :readable || type == :read_write
+      define_method(setting) do
+        @browser.get_text("id=party_#{setting}")
+      end
+      
+      define_method("has_#{setting}?") do
+        send(setting) rescue nil
+      end
+    end
+    
+    if type == :writable || type == :read_write
+      define_method("#{setting}=") do |value|
+        @browser.type "id=party_#{setting}", value
+      end
+    end
+  end
+
+  def_setting :name
+  def_setting :description
+  def_setting :location
+  def_setting :link, :readable
+  def_setting :notice, :readable
+  def_setting :recipients, :writable
+end
+
+
+
+
+class Party  
+  def begins_at=(time); set_time(:begin, time) end
+  def ends_at=  (time); set_time(:end, time) end
+
+  def set_time(event, time)
+    ['%Y', '%B', '%d', '%H', '%M'].each_with_index do |part, index|
+      element = "id=party_#{event}s_at_#{index + 1}i"
+      value = time.strftime part
+      
+      @browser.select element, value
+    end
+  end
+end
+
+
+
+
+class Party  
+  def begins_at; get_times.first end
+  def ends_at; get_times.last end
+
+  def get_times
+    begins_on = @browser.get_text 'party_begins_on'
+    begins_at = @browser.get_text 'party_begins_at'
+    ends_at = @browser.get_text 'party_ends_at'
+    
+    begins = Time.parse(begins_on + ' ' + begins_at)
+    ends = Time.parse(begins_on + ' ' + ends_at)
+    ends += 86400 if ends < begins
+    
+    [begins, ends]
+  end
+  
+  def has_times?
+    get_times rescue nil
+  end
+end
+
+
+
+
+class Party
+  def save_and_view
+    @browser.click 'id=party_submit'
+    @browser.wait_for_page_to_load 5000
+    @saved = true
+  end
+end
+
+
+
+
+class Party
+  def rsvp(name, attending)
+    @browser.type 'guest_name', name
+    @browser.click 'guest_attending' unless attending
+    @browser.click 'rsvp'
+    @browser.wait_for_page_to_load 5000
+  end
+end
+
+
+
+
+class Party
+  RsvpItem = '//ul[@id="guests"]/li'
+  
+  def responses(want_attending)
+    num_guests = @browser.get_xpath_count(RsvpItem).to_i
+    return [] unless num_guests >= 1
+
+    all = (1..num_guests).map do |i|
+      name = @browser.get_text \
+        "#{RsvpItem}[#{i}]/span[@class='rsvp_name']"
+      rsvp = @browser.get_text \
+        "#{RsvpItem}[#{i}]/span[@class='rsvp_attending']"
+      [name, rsvp]
+    end
+    
+    matching = all.select do |name, rsvp|
+      is_attending = !rsvp.include?('not')
+      !(want_attending ^ is_attending)
+    end
+    
+    matching.map {|name, rsvp| name}
+  end
+end
+
+
+
+
+class Party
+  def email_to(address)
+    @browser.open link + '.txt?email=' + address
+    @browser.get_body_text
+  end
+
+  def rsvp_at(rsvp_link)
+    @browser.open rsvp_link
+  end
+end

data/book_code/story/password.rb

@@ -0,0 +1,61 @@
+#---
+# Excerpted from "Scripted GUI Testing With Ruby",
+# published by The Pragmatic Bookshelf.
+# Copyrights apply to this code. It may not be used to create training material, 
+# courses, books, articles, and the like. Contact us if you are in doubt.
+# We make no guarantees that this code is fit for any purpose. 
+# Visit http://www.pragmaticprogrammer.com/titles/idgtr for more book information.
+#---
+
+require 'rubygems'
+require 'spec/story'
+
+steps_for :app_state do #(1)
+  Given 'a new document' do
+    @note = Note.open
+  end
+
+  When 'I exit the app' do
+    @note.exit!
+  end
+
+  Then 'the app should be running' do
+    @note.should be_running
+  end
+end
+
+
+
+
+steps_for :documents do
+  When 'I type "$something"' do |something|
+    @note.text = something
+  end  
+
+  When 'I save the document as "$name" with password "$password"' do  #(2)
+    |name, password|
+    @note.save_as name, :password => password
+  end
+  
+  When 'I open the document "$name" with password "$password"' do
+    |name, password|
+    @note = Note.open name, :password => password
+  end
+
+  When 'I change the password from "$old" to "$password"' do
+    |old, password|
+    @note.change_password :old_password => old, :password => password
+  end
+
+  Then 'the text should be "$something"' do |something|
+    @note.text.should == something
+  end
+end
+
+
+
+
+with_steps_for :app_state, :documents do
+  run 'password.story'
+end
+

data/book_code/story/password.story

@@ -0,0 +1,26 @@
+START: password_story
+Story: Password protection
+
+As a security-conscious person
+I want to encrypt each document with a password
+So that only I (and the NSA) can read it
+END: password_story
+
+START: password_scenario
+Scenario: Changing the password
+  Given a new document
+  When I type "this is my document"
+  And I save the document as "Secrets" with password "unguessable"
+  And I exit the app
+  And I open the document "Secrets" with password "unguessable"
+  Then the app should be running
+  And the text should be "this is my document"
+  
+  When I change the password from "unguessable" to "uncrackable"
+  And I exit the app
+  And I open the document "Secrets" with password "uncrackable"
+  Then the app should be running
+  And the text should be "this is my document"
+END: password_scenario
+
+  When I exit the app