osaka 0.2.3 → 0.3.0

data/lib/osaka/applicationwrapper.rb

@@ -32,28 +32,33 @@ module Osaka
   
   class CheckAction
     def execute(wrapper, condition, *args, &block)
-      wrapper.system_event!("#{condition.as_script(*args)};").strip == "true"
+      wrapper.system_event!("#{condition.as_script(wrapper, *args)};").strip == "true"
     end
   end
   
   class ExistsCondition
-    def as_script(element_to_check)
-      "exists #{element_to_check}"
+    def as_script(wrapper, element_to_check)
+      "exists #{wrapper.construct_location(element_to_check)}"
     end
   end
   
   class Not_existsCondition
-    def as_script(element_to_check)
-      "not exists #{element_to_check}"
+    def as_script(wrapper, element_to_check)
+      "not exists #{wrapper.construct_location(element_to_check)}"
     end
   end
-    
+  
   class ApplicationWrapper
   
-    attr_accessor :window
+    attr_reader :name
     
     def initialize(name)
       @name = name
+      @window = Location.new("")
+    end
+    
+    def ==(obj)
+      @name == obj.name && current_window_name == obj.current_window_name
     end
     
     def tell(command)
@@ -64,6 +69,10 @@ module Osaka
       ScriptRunner::execute("tell application \"System Events\"; tell process \"#{@name}\"; #{event}; end tell; end tell")
     end
 
+    def running?
+      ScriptRunner::execute("tell application \"System Events\"; (name of processes) contains \"#{@name}\"; end tell").strip == "true"
+    end
+    
     def print_warning(action, message)
       puts "Osaka WARNING while doing #{action}: #{message}"
     end
@@ -122,7 +131,7 @@ module Osaka
         
     def click!(element)
       # Click seems to often output stuff, but it doesn't have much meaning so we ignore it.
-      system_event!("click #{element}")
+      system_event!("click #{construct_location(element)}")
       self
     end
 
@@ -130,30 +139,46 @@ module Osaka
       activate
       click!(element)
     end
+    
+    def click_menu_bar(menu_item, menu_name)
+      activate
+      menu_bar_location = at.menu_bar_item(menu_name).menu_bar(1)
+      click!(menu_item + at.menu(1) + menu_bar_location)      
+    end
         
     def set!(element, location, value)
       encoded_value = (value.class == String) ? "\"#{value}\"" : value.to_s
-      check_output( system_event!("set #{element} of #{location} to #{encoded_value}"), "set")
+      check_output( system_event!("set #{element}#{construct_prefixed_location(location)} to #{encoded_value}"), "set")
     end
     
     def focus
       current_windows = window_list
-      @window = current_windows[0] if @window.nil? || current_windows.index(@window).nil?
-      set!("value", "attribute \"AXMain\" of window \"#{window}\"", true) if current_windows[0] != @window
+      currently_active_window = current_windows[0]
+      currently_active_window ||= ""
+      
+      if current_window_invalid?(current_windows)
+        @window = at.window(currently_active_window) unless currently_active_window.nil?
+      end
+
+      set!("value", "attribute \"AXMain\"", true) unless currently_active_window == current_window_name
     end
     
-    def construct_window_info(location)
-      location_string = ""
-      location_string += " of #{location}" unless location.empty?
-      location_string += " of window \"#{window}\"" unless window.nil?
-      
-      raise(Osaka::InvalidLocation, "Invalid location for command:#{location_string}") if location_string.scan("of window").length > 1
-      
-      location_string
+    def form_location_with_window(location)
+      new_location = Location.new(location)
+      new_location += @window unless new_location.has_top_level_element?
+      new_location
+    end
+    
+    def construct_location(location)
+      form_location_with_window(location).to_s
+    end
+
+    def construct_prefixed_location(location)
+      form_location_with_window(location).as_prefixed_location
     end
     
     def get!(element, location = "")
-      system_event!("get #{element}#{construct_window_info(location)}").strip
+      system_event!("get #{element}#{construct_prefixed_location(location)}").strip
     end
 
     def get_app!(element)
@@ -171,5 +196,24 @@ module Osaka
         window[7...window =~ / of application process/].strip
       }
     end 
+    
+    def set_current_window(window_name)
+      @window = at.window(window_name)
+    end
+    
+    def current_window_name
+      matchdata = @window.to_s.match(/^window "(.*)"/)
+      return "" if matchdata.nil? || matchdata[1].nil?
+      matchdata[1]
+    end
+    
+    def current_window_location
+      @window
+    end
+    
+    def current_window_invalid?(window_list)
+      @window.to_s.empty? || window_list.index(current_window_name).nil?
+    end
+    
   end
 end

data/lib/osaka/applicationwrapperexpectations.rb

@@ -37,6 +37,10 @@ module Osaka
       @wrapper.should_receive(:click).with(location).and_return(@wrapper)
     end
     
+    def expect_click_menu_bar(menu_item, menu_name)
+      @wrapper.should_receive(:click_menu_bar).with(menu_item, menu_name).and_return(@wrapper)
+    end
+    
     def expect_tell(do_this)
       @wrapper.should_receive(:tell).with(do_this)
     end

data/lib/osaka/calculator.rb

@@ -6,18 +6,19 @@ module Osaka
     def initialize
       @name = "Calculator"
       @wrapper = ApplicationWrapper.new("Calculator")
+      @wrapper.set_current_window(@name)
     end
     
     def activate
       super
-      if (@wrapper.window.nil?)
+      if (@wrapper.current_window_name.empty?)
         wait_for_new_window([])
-        @wrapper.window = @wrapper.window_list[0]
+        @wrapper.set_current_window(@wrapper.window_list[0])
       end
     end
     
     def click(key)
-      @wrapper.click!("button \"#{key}\" of group 2 of window \"#{@name}\"")
+      @wrapper.click!(at.button(key).group(2))
     end
     
     def key(k)
@@ -25,8 +26,7 @@ module Osaka
     end
     
     def result
-      @wrapper.get!('value', "static text 1 of group 1")
+      @wrapper.get!('value', at.static_text(1).group(1))
     end
-    
   end
 end

data/lib/osaka/keynote.rb

@@ -14,5 +14,14 @@ module Osaka
     def create_print_dialog(location)
       KeynotePrintDialog.new(location, @wrapper)
     end
+    
+    def select_all_slides
+      if @wrapper.check!.exists(at.button("Slides").group(1).outline(1).scroll_area(2).splitter_group(1).splitter_group(1))
+        @wrapper.click(at.button("Slides").group(1).outline(1).scroll_area(2).splitter_group(1).splitter_group(1))
+      else
+        @wrapper.click(at.button("Slides").group(1).outline(1).scroll_area(1).splitter_group(1).splitter_group(1))
+      end
+      select_all
+    end
   end
 end

data/lib/osaka/keynoteflow.rb

@@ -0,0 +1,29 @@
+
+module CommonFlows
+  def self.keynote_combine_files(result_file, files_to_merge)
+    keynote = Osaka::Keynote.new
+    files_to_merge = [files_to_merge].flatten
+    keynote.open(files_to_merge.shift)
+    keynote.save_as(result_file)
+    
+    files_to_merge.each { |file|
+      combine_keynote = Osaka::Keynote.new
+      combine_keynote.open(file)
+      combine_keynote.select_all_slides
+      combine_keynote.copy
+      keynote.select_all_slides
+      keynote.paste
+      combine_keynote.close
+    }
+    
+    keynote.save
+    keynote.quit
+  end
+  
+  def self.keynote_combine_files_from_directory_sorted(result_file, directory = ".", pattern = /^.*\.key$/)
+    files_in_directory = Dir.new(directory).entries
+    files_in_directory.select! { |f| f =~ pattern }
+    files_to_open = files_in_directory.collect { |f| File.join(directory, f)}
+    keynote_combine_files(result_file, files_to_open.sort)
+  end
+end

data/lib/osaka/location.rb

@@ -0,0 +1,132 @@
+
+module Osaka
+  class Location
+
+    def initialize(location_name)
+      @location_name = location_name.to_s
+      validate
+    end
+    
+    def validate
+      raise(Osaka::InvalidLocation, "Invalid location: #{to_s}") if as_prefixed_location.scan(" of window").length > 1
+    end
+    
+    def+(other_location)
+      return Location.new(self) if other_location.to_s.empty?
+      return Location.new(other_location) if to_s.empty?
+      Location.new(to_s + " of " + other_location.to_s)
+    end
+    
+    def to_s
+      @location_name
+    end
+    
+    def as_prefixed_location
+      return "" if to_s.empty?
+      " of " + to_s
+    end
+    
+    def has_top_level_element?
+      has_window? || has_menu_bar?
+    end
+
+    def button(name)
+      create_location_with_added_name("button", name)
+    end
+    
+    def group(name)
+      create_location_with_added_name("group", name)
+    end
+    
+    def window(name)
+      create_location_with_added_name("window", name)
+    end
+    
+    def has_window?
+      has_element?("window")
+    end
+    
+    def static_text(name)
+      create_location_with_added_name("static text", name)
+    end
+    
+    def menu_button(name)
+      create_location_with_added_name("menu button", name)
+    end
+
+    def menu(name)
+      create_location_with_added_name("menu", name)
+    end
+
+    def menu_item(name)
+      create_location_with_added_name("menu item", name)
+    end
+
+    def menu_bar(name)
+      create_location_with_added_name("menu bar", name)
+    end
+    
+    def has_menu_bar?
+      has_element?("menu bar")
+    end
+    
+    def menu_bar_item(name)
+      create_location_with_added_name("menu bar item", name)
+    end
+    
+    def dialog(name)
+      create_location_with_added_name("dialog", name)
+    end
+    
+    def checkbox(name)
+      create_location_with_added_name("checkbox", name)
+    end
+    
+    def sheet(name)
+      create_location_with_added_name("sheet", name)
+    end
+    
+    def text_field(name)
+      create_location_with_added_name("text field", name)
+    end
+
+    def pop_up_button(name)
+      create_location_with_added_name("pop up button", name)
+    end
+    
+    def splitter_group(name)
+      create_location_with_added_name("splitter group", name)
+    end
+
+    def scroll_area(name)
+      create_location_with_added_name("scroll area", name)
+    end
+    
+    def outline(name)
+      create_location_with_added_name("outline", name)
+    end
+    
+    def to_location_string(name)
+      return name.to_s if name.kind_of? Integer
+      '"' + name.to_s + '"'
+    end
+    
+    def create_location_with_added_name(element, name)
+      self + Location.new(element + " " + to_location_string(name))
+    end
+    
+    def has_element?(name)
+      as_prefixed_location.scan(" of #{name}").length >= 1
+    end
+    
+    def ==(obj)
+      @location_name == obj.to_s
+    end
+      
+  end
+  
+end
+
+def at
+  Osaka::Location.new ""
+end

data/lib/osaka/mailmergeflow.rb

@@ -0,0 +1,19 @@
+
+module CommonFlows
+  
+  def self.number_and_pages_mail_merge(numbers_file, pages_file, output_file)
+    numbers = Osaka::Numbers.new
+    pages = Osaka::Pages.new
+    
+    numbers.open(numbers_file)
+    yield numbers if block_given?
+    numbers.save
+    
+    pages.open(pages_file)
+    pages.mail_merge_to_pdf(output_file)
+    
+    numbers.quit(:dont_save)
+    pages.quit(:dont_save)
+    
+  end
+end

data/lib/osaka/pages.rb

@@ -9,7 +9,7 @@ module Osaka
     end
   
     def merge
-      @wrapper.click!('button "Merge" of sheet 1 of window 1')
+      @wrapper.click!(at.button("Merge").sheet(1))
       print_dialog_location = 'window "Print"' 
       @wrapper.wait_until!.exists("menu button \"PDF\" of #{print_dialog_location}")
       TypicalPrintDialog.new(print_dialog_location, @wrapper)
@@ -25,9 +25,9 @@ module Osaka
     
   private
     def set_merge_to_document_printer(value)
-      @wrapper.click("pop up button 2 of #{@location}")
-      @wrapper.wait_until!.exists("menu item #{value} of menu 1 of pop up button 2 of #{@location}")
-      @wrapper.click!("menu item #{value} of menu 1 of pop up button 2 of #{@location}")
+      @wrapper.click(at.pop_up_button(2).sheet(1))
+      @wrapper.wait_until!.exists(at.menu_item(value).menu(1).pop_up_button(2).sheet(1))
+      @wrapper.click!(at.menu_item(value).menu(1).pop_up_button(2).sheet(1))
     end    
   end
 
@@ -38,9 +38,12 @@ module Osaka
     end
   
     def mail_merge
-      @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("sheet 1 of window 1", @wrapper)
+      @wrapper.click_menu_bar(at.menu_item(20), "Edit")
+      # @wrapper.click!(at.menu_bar_item("Edit").menu_bar(1))
+      # @wrapper.wait_until.exists(at.menu(1).menu_bar_item("Edit").menu_bar(1))
+      # @wrapper.click!(at.menu_item(20).menu(1).menu_bar_item("Edit").menu_bar(1))
+      @wrapper.wait_until.exists(at.button("Merge").sheet(1))
+      PagesMailMergeDialog.new(at.sheet(1), @wrapper)
     end
     
     def mail_merge_to_pdf(filename)

data/lib/osaka/scriptrunner.rb

@@ -11,8 +11,9 @@ module Osaka
 
     @@debug_info_enabled = false
 
-    def self.enable_debug_prints
+    def self.enable_debug_prints(debug_info_format = :plain_text)
       @@debug_info_enabled = true
+      @@debug_info_format = debug_info_format
     end
 
     def self.disable_debug_prints
@@ -29,7 +30,16 @@ module Osaka
       script_commands.each { |l| 
         escaped_commands += " -e \"#{l.strip}\""
       }
-      puts "Executing: osascript#{escaped_commands}" if debug_prints?
+      if (debug_prints?)
+        if (@@debug_info_format == :plain_text)
+          debug_output = "Executing: osascript#{escaped_commands}"
+        elsif (@@debug_info_format == :short_html)
+          debug_output = applescript
+          debug_output += "<br>"
+        end        
+        puts debug_output
+      end
+      
 
       output = ""
       begin
@@ -38,7 +48,12 @@ module Osaka
         raise(Osaka::ScriptRunnerError, "Error received while executing: #{applescript}")
       end
       if (!output.empty? && debug_prints?)
-        puts "Output was: #{output}"
+        if (@@debug_info_format == :plain_text)
+          debug_output = "Output was: #{output}"
+        elsif (@@debug_info_format == :short_html)
+          debug_output = "Output: <b>#{output}</b><br>"
+        end        
+        puts debug_output
       end
       output
     end  

data/lib/osaka/textedit.rb

@@ -10,9 +10,9 @@ module Osaka
     
     def activate
       super
-      if (@wrapper.window.nil?)
+      if (@wrapper.current_window_name.empty?)
         wait_for_new_window([])
-        @wrapper.window = @wrapper.window_list[0]
+        @wrapper.set_current_window(@wrapper.window_list[0])
       end
     end
     

data/lib/osaka/typicalapplication.rb

@@ -4,23 +4,24 @@ module Osaka
   class TypicalSaveDialog
     attr_accessor :wrapper
 
-    def initialize(location, wrapper)
-      @location = location
-      @wrapper = wrapper
+    def initialize(self_location, wrapper)
+      @self_location = self_location
+      @wrapper = wrapper.clone
+      @wrapper.set_current_window("") if self_location.has_top_level_element?
     end
   
     def set_filename(filename)
-      @wrapper.set("value", "text field 1 of #{@location}", filename)
+      @wrapper.set("value", at.text_field(1) + @self_location, filename)
     end
   
     def set_folder(pathname)
-      @wrapper.keystroke("g", [ :command, :shift ]).wait_until.exists("sheet 1 of #{@location}")
-      @wrapper.set("value", "text field 1 of sheet 1 of #{@location}", pathname)
-      @wrapper.click("button \"Go\" of sheet 1 of #{@location}").wait_until.not_exists("sheet 1 of #{@location}")
+      @wrapper.keystroke("g", [ :command, :shift ]).wait_until.exists(at.sheet(1) + @self_location)
+      @wrapper.set("value", at.text_field(1).sheet(1) + @self_location, pathname)
+      @wrapper.click(at.button("Go").sheet(1) + @self_location).wait_until.not_exists(at.sheet(1) + @self_location)
     end
   
     def click_save
-      @wrapper.click("button \"Save\" of #{@location}").wait_until.not_exists("#{@location}")
+      @wrapper.click(at.button("Save") + @self_location).wait_until.not_exists(@self_location)
     end
   
     def save(filename)
@@ -34,8 +35,8 @@ module Osaka
   class TypicalPrintDialog
     attr_accessor :wrapper
 
-    def initialize(location, wrapper)
-      @location = location
+    def initialize(parent, wrapper)
+      @parent = parent
       @wrapper = wrapper
     end
   
@@ -44,15 +45,15 @@ module Osaka
     end
 
     def save_as_pdf(filename)
-      @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)
+      @wrapper.click!(at.menu_button("PDF") + @parent).wait_until!.exists(at.menu(1).menu_button("PDF") + @parent)
+      @wrapper.click!(at.menu_item(2).menu(1).menu_button("PDF") + @parent).wait_until!.exists('window "Save"')
+      save_dialog = create_save_dialog(at.window("Save"), @wrapper)
       save_dialog.save(filename)
       
-      @wrapper.until!.not_exists(@location) {
+      @wrapper.until!.not_exists(@parent) {
         # 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"')
+        @wrapper.click!(at.checkbox(1).window("Print"))
       }
     end
   end
@@ -84,22 +85,36 @@ module Osaka
     def open (filename)
       abolutePathFileName = File.absolute_path(filename)
       @wrapper.tell("open \"#{abolutePathFileName}\"")
-      @wrapper.window = filename
+      @wrapper.set_current_window(File.basename(filename))
     end
 
     def wait_for_window_and_dialogs_to_close(option)
       if (option != :user_chose)
-        @wrapper.until!.not_exists("window \"#{wrapper.window}\"") {
-          if (@wrapper.check!.exists("sheet 1 of window \"#{wrapper.window}\""))
-            @wrapper.click!("button 2 of sheet 1 of window \"#{wrapper.window}\"")
-          end
+        @wrapper.until!.not_exists(@wrapper.current_window_location) {
+          close_dialog_sheet_with_dont_save
         }
       end
     end
-      
+
+    def wait_for_application_to_quit(option)
+      if (option != :user_chose)
+        while @wrapper.running?
+          close_dialog_sheet_with_dont_save
+        end
+      end
+    end
+    
+    def close_dialog_sheet_with_dont_save
+      if (@wrapper.check!.exists(at.sheet(1)))
+        @wrapper.click!(at.button(2).sheet(1))
+      end
+    end
+    
     def quit(option = :user_chose)
-      @wrapper.quit
-      wait_for_window_and_dialogs_to_close(option)
+      if @wrapper.running?
+        @wrapper.quit
+        wait_for_application_to_quit(option)
+      end
     end
 
     def wait_for_new_window(original_window_list)
@@ -113,7 +128,7 @@ module Osaka
     def new_document
       window_list = @wrapper.window_list
       @wrapper.keystroke("n", :command)
-      @wrapper.window = wait_for_new_window(window_list)
+      @wrapper.set_current_window(wait_for_new_window(window_list))
       @wrapper.focus
     end
     
@@ -121,6 +136,17 @@ module Osaka
       @wrapper.keystroke("s", :command)
     end
     
+    def save_dialog
+      @wrapper.keystroke("s", [:command, :shift]).wait_until.exists(at.sheet(1))
+      create_save_dialog(at.sheet(1))
+    end
+    
+    def save_as(filename)
+      dialog = save_dialog
+      dialog.save(filename)
+      @wrapper.set_current_window(File.basename(filename))
+    end
+    
     def close(option = :user_chose)
       @wrapper.keystroke("w", :command)
       wait_for_window_and_dialogs_to_close(option)
@@ -129,15 +155,42 @@ module Osaka
     def activate
       @wrapper.activate
     end
+    
+    def focus
+      @wrapper.focus
+    end
+    
+    def running?
+      @wrapper.running?
+    end
   
+    def copy
+      @wrapper.keystroke("c", :command)
+    end
+
+    def paste
+      @wrapper.keystroke("v", :command)
+    end
+
+    def cut
+      @wrapper.keystroke("x", :command)
+    end
+
+    def select_all
+      @wrapper.keystroke("a", :command)
+    end
+    
     def create_print_dialog(location)
       TypicalPrintDialog.new(location, @wrapper)
     end
+    
+    def create_save_dialog(location)
+      TypicalSaveDialog.new(location, @wrapper)
+    end
   
     def print_dialog
-      location = "sheet 1#{@wrapper.construct_window_info}"
-      @wrapper.keystroke("p", :command).wait_until.exists(location)
-      create_print_dialog(location)
+      @wrapper.keystroke("p", :command).wait_until.exists(at.sheet(1))
+      create_print_dialog(at.sheet(1))
     end
   
   end

data/lib/osaka/version.rb

@@ -1,4 +1,4 @@
 
 module Osaka
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

data/lib/osaka.rb

@@ -1,5 +1,6 @@
 
 require 'osaka/scriptrunner'
+require 'osaka/location'
 require 'osaka/applicationwrapper'
 require 'osaka/applicationwrapperexpectations'
 require 'osaka/typicalapplication'
@@ -8,4 +9,6 @@ require 'osaka/numbers'
 require 'osaka/keynote'
 require 'osaka/calculator'
 require 'osaka/textedit'
+require 'osaka/mailmergeflow'
+require 'osaka/keynoteflow'