osaka 0.1.1 → 0.2.0

data/lib/osaka/applicationwrapper.rb

@@ -1,12 +1,66 @@
 
 module Osaka
+
+  class ConditionAndActionProxy
+    
+    def initialize(wrapper)
+      @wrapper = wrapper
+    end
+    
+    def create_condition_class_based_on_name(sym)
+      classname = "#{sym.to_s[0].upcase}#{sym.to_s[1..-1]}Condition"
+      eval(classname).new
+    end
+
+    def method_missing(sym, *args, &block)
+      condition = create_condition_class_based_on_name(sym)
+      @wrapper.enter_nested_action
+      yield unless block.nil?
+      @wrapper.exit_nested_action
+      @wrapper.system_event!("repeat until #{condition.as_script(*args)}; #{@wrapper.nested_action} end repeat")
+    end
+  end
+  
+  class ExistsCondition
+    def as_script(element_to_wait_for)
+      "exists #{element_to_wait_for}"
+    end
+  end
   
+  class Not_existsCondition
+    def as_script(element_to_wait_for)
+      "not exists #{element_to_wait_for}"
+    end
+  end
+    
   class ApplicationWrapper
   
     def initialize(name)
       @name = name
+      @nested = false
     end
-  
+    
+    def enter_nested_action
+      @nested = true
+      @nested_action = ""
+    end
+    
+    def nested_action
+      @nested_action
+    end
+    
+    def exit_nested_action
+      @nested = false
+    end
+    
+    def execute_script(script)
+      if @nested
+        @nested_action += "#{script};"
+      else 
+        ScriptRunner::execute(script) unless @nested
+      end
+    end
+    
     def activate
       tell("activate")
     end
@@ -16,36 +70,31 @@ module Osaka
     end
   
     def tell(command)
-      ScriptRunner::execute("tell application \"#{@name}\"; #{command}; end tell")
+      execute_script("tell application \"#{@name}\"; #{command}; end tell")
     end
   
     def system_event!(event)
-      ScriptRunner::execute("tell application \"System Events\"; tell process \"#{@name}\"; #{event}; end tell; end tell")
+      execute_script("tell application \"System Events\"; tell process \"#{@name}\"; #{event}; end tell; end tell")
     end
 
     def system_event(event)
       activate
       system_event!(event)
     end
-    
-    def wait_until_exists!(element_to_wait_for)
-      system_event!("repeat until exists #{element_to_wait_for}; end repeat")
-    end
 
-    def wait_until_exists(element_to_wait_for)
+    def wait_until
       activate
-      wait_until_exists!(element_to_wait_for)
+      wait_until!
     end
     
-    def wait_until_not_exists!(element_to_wait_for)
-      system_event!("repeat until not exists #{element_to_wait_for}; end repeat")
-    end
-
-    def wait_until_not_exists(element_to_wait_for)
-      activate
-      wait_until_not_exists!(element_to_wait_for)
+    def wait_until!
+      ConditionAndActionProxy.new(self)
     end
     
+    def until!
+      ConditionAndActionProxy.new(self)
+    end
+        
     def construct_modifier_statement(modifier_keys)
       modified_key_string = [ modifier_keys ].flatten.collect! { |mod_key| mod_key.to_s + " down"}.join(", ")
       modifier_command = " using {#{modified_key_string}}" unless modifier_keys.empty?
@@ -54,6 +103,7 @@ module Osaka
     
     def keystroke!(key, modifier_keys = [])
       system_event!("keystroke \"#{key}\"#{construct_modifier_statement(modifier_keys)}")
+      self
     end
     
     def keystroke(key, modifier_keys = [])
@@ -61,45 +111,16 @@ module Osaka
       keystroke!(key, modifier_keys)
     end
         
-    def keystroke_and_wait_until_exists!(key, modifier_keys, element)
-      keystroke!(key, modifier_keys)
-      wait_until_exists!(element)
-    end
-
-    def keystroke_and_wait_until_exists(key, modifier_keys, element)
-      activate
-      keystroke_and_wait_until_exists!(key, modifier_keys, element)
-    end
-  
     def click!(element)
       system_event!("click #{element}")
+      self
     end
 
     def click(element)
       activate
       click!(element)
     end
-  
-    def click_and_wait_until_exists!(element, wait_condition)
-      click!(element)
-      wait_until_exists!(wait_condition)
-    end
-
-    def click_and_wait_until_exists(element, wait_condition)
-      activate
-      click_and_wait_until_exists!(element, wait_condition)
-    end
-  
-    def click_and_wait_until_not_exists!(element, wait_condition)
-      click!(element)
-      wait_until_not_exists!(wait_condition)
-    end
-
-    def click_and_wait_until_not_exists(element, wait_condition)
-      activate
-      click_and_wait_until_not_exists!(element, wait_condition)
-    end
-      
+        
     def set!(element, value)
       system_event!("set #{element} to \"#{value}\"")
     end

data/lib/osaka/applicationwrapperexpectations.rb

@@ -0,0 +1,46 @@
+
+module Osaka
+  module ApplicationWrapperExpectations
+
+    def should_wait(wait_command, wait_condition, wait_element)
+      condition = double(:ConditionAndActionProxy)
+      @wrapper.should_receive(wait_command).and_return(condition)
+      condition.should_receive(wait_condition).with(wait_element)
+    end
+
+    def should_wait_until(wait_condition, wait_element)
+      should_wait(:wait_until, wait_condition, wait_element)
+    end
+
+    def should_wait_until!(wait_condition, wait_element)
+      should_wait(:wait_until!, wait_condition, wait_element)
+    end
+
+    def should_do_until!(wait_condition, wait_element)
+      should_wait(:until!, wait_condition, wait_element).and_yield
+      yield
+    end
+
+    def expect_keystroke(key, modifier)
+      @wrapper.should_receive(:keystroke).with(key, modifier).and_return(@wrapper)
+    end
+
+    def expect_click!(location)
+      @wrapper.should_receive(:click!).with(location).and_return(@wrapper)
+    end
+
+    def expect_click(location)
+      @wrapper.should_receive(:click).with(location).and_return(@wrapper)
+    end
+    
+    def expect_tell(do_this)
+      @wrapper.should_receive(:tell).with(do_this)
+    end
+    
+    def expect_system_event(event)
+      @wrapper.should_receive(:system_event).with(event)
+    end
+    
+    
+  end
+end

data/lib/osaka/pages.rb

@@ -10,7 +10,7 @@ module Osaka
     def merge
       @wrapper.click!('button "Merge" of sheet 1 of window 1')
       print_dialog_location = 'window "Print"' 
-      @wrapper.wait_until_exists!("menu button \"PDF\" of #{print_dialog_location}")
+      @wrapper.wait_until!.exists("menu button \"PDF\" of #{print_dialog_location}")
       TypicalPrintDialog.new(print_dialog_location, @wrapper)
     end
   
@@ -23,8 +23,8 @@ module Osaka
     end
   
     def mail_merge
-      @wrapper.systemEvent("tell menu bar 1; tell menu \"Edit\"; click menu item 20; end tell; end tell")
-      @wrapper.wait_until_exists('button "Merge" of sheet 1 of window 1')
+      @wrapper.system_event("tell menu bar 1; tell menu \"Edit\"; click menu item 20; end tell; end tell")
+      @wrapper.wait_until.exists('button "Merge" of sheet 1 of window 1')
       PagesMailMergeDialog.new(@wrapper)
     end
     

data/lib/osaka/typicalapplication.rb

@@ -14,13 +14,13 @@ module Osaka
     end
   
     def set_folder(pathname)
-      @wrapper.keystroke_and_wait_until_exists("g", [ :command, :shift ], "sheet 1 of #{@location}")
+      @wrapper.keystroke("g", [ :command, :shift ]).wait_until.exists ("sheet 1 of #{@location}")
       @wrapper.set("value of text field 1 of sheet 1 of #{@location}", pathname)
-      @wrapper.click_and_wait_until_not_exists("button \"Go\" of sheet 1 of #{@location}", "sheet 1 of #{@location}")
+      @wrapper.click("button \"Go\" of sheet 1 of #{@location}").wait_until.not_exists("sheet 1 of #{@location}")
     end
   
     def click_save
-      @wrapper.click_and_wait_until_not_exists("button \"Save\"  of #{@location}", "#{@location}")
+      @wrapper.click("button \"Save\" of #{@location}").wait_until.not_exists("#{@location}")
     end
   
     def save(filename)
@@ -44,11 +44,16 @@ module Osaka
     end
 
     def save_as_pdf(filename)
-      @wrapper.click_and_wait_until_exists!("menu button \"PDF\" of #{@location}", "menu 1 of menu button \"PDF\" of #{@location}")
-      @wrapper.click_and_wait_until_exists!("menu item 2 of menu 1 of menu button \"PDF\" of #{@location}", 'window "Save"')
+      @wrapper.click!("menu button \"PDF\" of #{@location}").wait_until!.exists ("menu 1 of menu button \"PDF\" of #{@location}")
+      @wrapper.click!("menu item 2 of menu 1 of menu button \"PDF\" of #{@location}").wait_until!.exists('window "Save"')
       save_dialog = create_save_dialog("window \"Save\"", @wrapper)
       save_dialog.save(filename)
-      @wrapper.wait_until_not_exists(@location)
+      
+      @wrapper.until!.not_exists(@location) {
+        # Weird, but sometimes the dialog "hangs around" and clicking this checkbox will make it go away.
+        # Anyone who knows a better solution, please let me know!
+        @wrapper.click!('checkbox 1 of window "Print"')
+      }
     end
   end
 
@@ -83,7 +88,7 @@ module Osaka
   
     def print_dialog
       location = "sheet 1 of window 1"
-      @wrapper.keystroke_and_wait_until_exists("p", :command, location)
+      @wrapper.keystroke("p", :command).wait_until.exists(location)
       create_print_dialog(location)
     end
   

data/lib/osaka/version.rb

@@ -1,4 +1,4 @@
 
 module Osaka
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/osaka.rb

@@ -1,6 +1,7 @@
 
 require 'osaka/scriptrunner'
 require 'osaka/applicationwrapper'
+require 'osaka/applicationwrapperexpectations'
 require 'osaka/typicalapplication'
 require 'osaka/pages'
 require 'osaka/numbers'

data/spec/applicationwrapper_spec.rb

@@ -39,25 +39,19 @@ describe "Osaka::ApplicationWrapper" do
   end
   
   it "Should be able to wait for for a specific element existing" do
-    Osaka::ScriptRunner.should_receive(:execute).with(/repeat until exists window 1; end repeat/)
-    subject.wait_until_exists!("window 1")
+    Osaka::ScriptRunner.should_receive(:execute).with(/repeat until exists window 1;  end repeat/)
+    subject.wait_until!.exists("window 1")
   end
   
   it "Should be able to wait until exists and activate the application first" do
     subject.should_receive(:activate)
-    subject.should_receive(:wait_until_exists!).with("window 1")
-    subject.wait_until_exists("window 1")    
+    Osaka::ScriptRunner.should_receive(:execute).with(/repeat until exists window 1;  end repeat/)
+    subject.wait_until.exists("window 1")
   end
 
   it "Should be able to wait for a specific element to not exist anymore" do
-    Osaka::ScriptRunner.should_receive(:execute).with(/repeat until not exists window 1; end repeat/)
-    subject.wait_until_not_exists!("window 1")    
-  end
-  
-  it "Should be able to wait_until_not_exists and activate" do
-    subject.should_receive(:activate)
-    subject.should_receive(:wait_until_not_exists!).with("window 1")
-    subject.wait_until_not_exists("window 1")        
+    Osaka::ScriptRunner.should_receive(:execute).with(/repeat until not exists window 1;  end repeat/)
+    subject.wait_until!.not_exists("window 1")    
   end
   
   it "Should be able to generate keystroke events" do
@@ -81,16 +75,17 @@ describe "Osaka::ApplicationWrapper" do
     subject.keystroke!("p", [ :option, :command ])    
   end
   
-  it "Should be able to do a keystroke and wait until something happen in one easy command" do
-    subject.should_receive(:keystroke!).with("p", [])
-    subject.should_receive(:wait_until_exists!).with("window 1")
-    subject.keystroke_and_wait_until_exists!("p", [], "window 1")
+  it "Should be able to do a keystroke and wait until something happen in one easy line" do
+    Osaka::ScriptRunner.should_receive(:execute).with(/keystroke "p"/)
+    Osaka::ScriptRunner.should_receive(:execute).with(/repeat until exists window 1;  end repeat/)
+    subject.keystroke!("p", []).wait_until!.exists("window 1")
   end
   
   it "Should be able to keystroke_and_wait_until_exists and activate" do
     subject.should_receive(:activate)
-    subject.should_receive(:keystroke_and_wait_until_exists!).with("p", [], "window 1")
-    subject.keystroke_and_wait_until_exists("p", [], "window 1")    
+    Osaka::ScriptRunner.should_receive(:execute).with(/keystroke "p"/)
+    Osaka::ScriptRunner.should_receive(:execute).with(/repeat until exists window 1;  end repeat/)
+    subject.keystroke("p", []).wait_until!.exists("window 1")    
   end
   
   it "Should be able to do clicks" do
@@ -104,30 +99,19 @@ describe "Osaka::ApplicationWrapper" do
     subject.click("button")    
   end
   
-  it "Should be able to do clicks and wait until something happened in one easy command" do
-    subject.should_receive(:click!).with("button")
-    subject.should_receive(:wait_until_exists!).with("window")
-    subject.click_and_wait_until_exists!("button", "window")
+  it "Should be able to do clicks and wait until something happened in one easy line" do
+    Osaka::ScriptRunner.should_receive(:execute).with(/click/)
+    Osaka::ScriptRunner.should_receive(:execute).with(/repeat until exists window;  end repeat/)
+    subject.click!("button").wait_until!.exists("window")
   end
   
   it "Should be able to click_and_wait_until_exists and activate" do
     subject.should_receive(:activate)
-    subject.should_receive(:click_and_wait_until_exists!).with("button", "window")
-    subject.click_and_wait_until_exists("button", "window")
+    Osaka::ScriptRunner.should_receive(:execute).with(/click/)
+    Osaka::ScriptRunner.should_receive(:execute).with(/repeat until exists window;  end repeat/)
+    subject.click("button").wait_until!.exists("window")
   end
     
-  it "Should be able to click and wait until something doesn't exist anymore" do
-    subject.should_receive(:click!).with("button1")
-    subject.should_receive(:wait_until_not_exists!).with("window 1")
-    subject.click_and_wait_until_not_exists!('button1', 'window 1')
-  end
-
-  it "Should be able to click_and_wait_until_not_exists and activate" do
-    subject.should_receive(:activate)
-    subject.should_receive(:click_and_wait_until_not_exists!).with("button", "window")
-    subject.click_and_wait_until_not_exists('button', 'window')    
-  end
-  
   it "Should be able to set a value to an element" do
     subject.should_receive(:system_event!).with(/set value of window to "newvalue"/)
     subject.set!("value of window", "newvalue")
@@ -139,6 +123,11 @@ describe "Osaka::ApplicationWrapper" do
     subject.set("value of window", "newvalue")
   end
   
-  
+  it "Should be able to loop over some script until something happens" do
+    Osaka::ScriptRunner.should_receive(:execute).with(/repeat until exists window; tell application \"ApplicationName\"; activate; end tell; end repeat/)
+    subject.until!.exists("window") {
+      subject.activate
+    }
+  end
   
 end

data/spec/keynote_spec.rb

@@ -8,4 +8,9 @@ describe "Osaka::Keynote" do
   before (:each) do
     subject.wrapper = double("Osaka::ApplicationWrapper").as_null_object
   end
+  
+  it "Should create the correct keynote print dialog" do
+    subject.create_print_dialog("window").class.should == Osaka::KeynotePrintDialog
+  end
+  
 end

data/spec/pages_spec.rb

@@ -3,10 +3,12 @@ require 'osaka'
 
 describe "Osaka::Pages" do
 
+  include(*Osaka::ApplicationWrapperExpectations)
+
   subject { Osaka::Pages.new }
   
   before (:each) do
-    subject.wrapper = double("Osaka::ApplicationWrapper").as_null_object
+    @wrapper = subject.wrapper = double("Osaka::ApplicationWrapper").as_null_object
   end
   
   it "Should be able to do mail merge to a PDF flow" do
@@ -19,18 +21,17 @@ describe "Osaka::Pages" do
     print_dialog.should_receive(:save_as_pdf).with("filename")
     
     subject.mail_merge_to_pdf("filename")
-    
   end
   
   it "Should be able to select the Mail Merge" do
-    subject.wrapper.should_receive(:systemEvent).with("tell menu bar 1; tell menu \"Edit\"; click menu item 20; end tell; end tell")
-    subject.wrapper.should_receive(:wait_until_exists).with('button "Merge" of sheet 1 of window 1')
+    expect_system_event('tell menu bar 1; tell menu "Edit"; click menu item 20; end tell; end tell')
+    should_wait_until(:exists, 'button "Merge" of sheet 1 of window 1')
     subject.mail_merge
   end
 
   it "Should click the merge button of the mail merge dialog" do
-    subject.wrapper.should_receive(:click!).with('button "Merge" of sheet 1 of window 1')
-    subject.wrapper.should_receive(:wait_until_exists!).with('menu button "PDF" of window "Print"')
+    expect_click!('button "Merge" of sheet 1 of window 1')
+    should_wait_until!(:exists, 'menu button "PDF" of window "Print"')
     subject.mail_merge.merge
   end
   

data/spec/typicalapplication_spec.rb

@@ -3,37 +3,40 @@ require 'osaka'
 
 describe "Osaka::TypicalApplication" do
 
+  include(*Osaka::ApplicationWrapperExpectations)
+  
   subject { Osaka::TypicalApplication.new("ApplicationName") }
   
   before (:each) do
-    subject.wrapper = double("Osaka::ApplicationWrapper").as_null_object
+    @wrapper = subject.wrapper = double("Osaka::ApplicationWrapper")
   end
   
   it "Should pass the right open string to the Keynote application osascript" do
     filename = "filename.key"
-    subject.wrapper.should_receive(:tell).with("open \"#{File.absolute_path(filename)}\"")
+    expect_tell("open \"#{File.absolute_path(filename)}\"")
     subject.open(filename)    
   end
   
   it "Should be able to quit" do
-    subject.wrapper.should_receive(:quit)
+    @wrapper.should_receive(:quit)
     subject.quit
   end
   
   it "Should be able to save" do
-    subject.wrapper.should_receive(:keystroke).with("s", :command)
+    expect_keystroke("s", :command)
     subject.save
   end
   
   it "Should be able to activate keynote" do
-    subject.wrapper.should_receive(:activate)
+    @wrapper.should_receive(:activate)
     subject.activate
   end
   
   it "Should be able to retrieve a print dialog" do
-    subject.wrapper.should_receive(:keystroke_and_wait_until_exists).with("p", :command, "sheet 1 of window 1")
+    expect_keystroke("p", :command)
+    should_wait_until(:exists, "sheet 1 of window 1")
     subject.print_dialog
-  end
+  end  
   
   describe "Generic Print Dialog" do
     
@@ -42,11 +45,20 @@ describe "Osaka::TypicalApplication" do
 
     it "Should be able to save the PDF in a print dialog" do
       save_dialog_mock = double(:GenericSaveDialog)
-      subject.wrapper.should_receive(:click_and_wait_until_exists!).with('menu button "PDF" of window 1', 'menu 1 of menu button "PDF" of window 1')
-      subject.wrapper.should_receive(:click_and_wait_until_exists!).with('menu item 2 of menu 1 of menu button "PDF" of window 1', 'window "Save"')
+      
+      expect_click!('menu button "PDF" of window 1') 
+      should_wait_until!(:exists, 'menu 1 of menu button "PDF" of window 1')
+      
+      expect_click!('menu item 2 of menu 1 of menu button "PDF" of window 1')
+      should_wait_until!(:exists, 'window "Save"')
+
       subject.should_receive(:create_save_dialog).with("window \"Save\"", subject.wrapper).and_return(save_dialog_mock)
       save_dialog_mock.should_receive(:save).with("filename")
-      subject.wrapper.should_receive(:wait_until_not_exists).with('window 1')
+      
+      should_do_until!(:not_exists, 'window 1') {
+        expect_click!('checkbox 1 of window "Print"')
+      }
+      
       subject.save_as_pdf("filename")
     end
   end
@@ -70,13 +82,15 @@ describe "Osaka::TypicalApplication" do
     end
     
     it "Should set the path when a full path is given" do
+      subject.wrapper.as_null_object
       subject.should_receive(:set_filename)
       subject.should_receive(:set_folder).with("/path/second")
       subject.save("/path/second/name")
     end
     
     it "Should be able to click save" do
-      subject.wrapper.should_receive(:click_and_wait_until_not_exists).with('button "Save"  of window 1', 'window 1')
+      expect_click('button "Save" of window 1')
+      should_wait_until(:not_exists, 'window 1')
       subject.click_save
     end
     
@@ -86,9 +100,11 @@ describe "Osaka::TypicalApplication" do
     end
     
     it "Should be able to set the path" do
-      subject.wrapper.should_receive(:keystroke_and_wait_until_exists).with("g", [ :command, :shift ], "sheet 1 of window 1")
+      expect_keystroke("g", [ :command, :shift ])
+      should_wait_until(:exists,  "sheet 1 of window 1")
       subject.wrapper.should_receive(:set).with("value of text field 1 of sheet 1 of window 1", "path")
-      subject.wrapper.should_receive(:click_and_wait_until_not_exists).with('button "Go" of sheet 1 of window 1', "sheet 1 of window 1")
+      expect_click('button "Go" of sheet 1 of window 1')
+      should_wait_until(:not_exists, "sheet 1 of window 1")
       subject.set_folder("path")
     end
   end

metadata

@@ -2,7 +2,7 @@
 name: osaka
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Bas Vodde
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-10 00:00:00 +08:00
+date: 2012-02-18 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -48,6 +48,7 @@ files:
 - Rakefile
 - lib/osaka.rb
 - lib/osaka/applicationwrapper.rb
+- lib/osaka/applicationwrapperexpectations.rb
 - lib/osaka/keynote.rb
 - lib/osaka/numbers.rb
 - lib/osaka/pages.rb