vapir-common 1.9.0 → 1.10.0

data/lib/vapir-common/browser.rb

@@ -90,10 +90,10 @@ module Vapir
     
     # does the work of #screen_capture when the WinWindow library is being used for that. see #screen_capture documentation (browser-specific)
     def screen_capture_win_window(filename, options = {})
-      options = handle_options(options, :dc => :window, :format => nil)
-      if options[:format] && !(options[:format].is_a?(String) && options[:format].downcase == 'bmp')
-        raise ArgumentError, ":format was specified as #{options[:format].inspect} but only 'bmp' is supported when :dc is #{options[:dc].inspect}"
+      if filename =~ /\.(\w+)\z/
+        extension = $1
       end
+      options = handle_options(options, :dc => :window, :format => extension)
       if options[:dc] == :desktop
         win_window.really_set_foreground!
         screenshot_win=WinWindow.desktop_window
@@ -101,7 +101,18 @@ module Vapir
       else
         screenshot_win=win_window
       end
-      screenshot_win.capture_to_bmp_file(filename, :dc => options[:dc])
+      if !options[:format] || options[:format].downcase == 'bmp'
+        screenshot_win.capture_to_bmp_file(filename, :dc => options[:dc])
+      else
+        begin
+          require 'rmagick'
+        rescue LoadError
+          raise $!.class, "To use :format => #{format.inspect}, please install rmagick: http://rmagick.rubyforge.org/install-faq.html#win\n\n"+$!.message
+        end
+        bmp_blob = screenshot_win.capture_to_bmp_blob(:dc => options[:dc])
+        magick_img = Magick::Image.from_blob(bmp_blob)[0]
+        magick_img.write(filename) # magick handles converting based on extension 
+      end
     end
     private :screen_capture_win_window
   end

data/lib/vapir-common/config.rb

@@ -76,6 +76,18 @@ module Vapir
       @config_hash = {}
       @recognized_options = {}
       yield(self) if block_given?
+      define_key_methods
+    end
+    # this is redundant with #method_missing, really, but it makes autocomplete possible in irb 
+    def define_key_methods
+      recognized_keys.each do |recognized_key|
+        (class << self; self; end).send(:define_method, recognized_key) do
+          read(recognized_key)
+        end
+        (class << self; self; end).send(:define_method, "#{recognized_key}=") do |value|
+          update recognized_key, value
+        end
+      end
     end
     # if the method invoked looks like assignment (ends with an =), calls to #update with 
     # the given method as the key and its argument as the value. otherwise calls #read with 
@@ -109,7 +121,7 @@ module Vapir
     def []=(key, value)
       update(key, value)
     end
-    # returns an array of 
+    # returns an array of configuration keys which are recognized (either locally or inherited from a parent) 
     def recognized_keys
       ((@parent ? @parent.recognized_keys : [])+@recognized_options.keys).uniq
     end
@@ -173,7 +185,7 @@ module Vapir
       end
       @recognized_options[key]= Option.new(key, options)
     end
-    # reads the value for the given key. if on value is defined, raises NoValueError. 
+    # reads the value for the given key. if no value is defined, raises NoValueError. 
     def read(key)
       key = recognize_key! key
       if @config_hash.key?(key)
@@ -201,7 +213,7 @@ module Vapir
         update(k,v)
       end
     end
-    # deletes the given value from the hash. this does not affect any ancestor Configurations. 
+    # deletes the given key from the hash. this does not affect any ancestor Configurations. 
     def delete(key)
       key = check_key key
       @config_hash.delete(key)
@@ -305,6 +317,15 @@ module Vapir
   end
 
   # :stopdoc:
+
+  # reopen this module to add stuff that's sort of separate from the Configurable module itself 
+  module Configurable
+    # call the given block with :wait set to false 
+    def without_waiting(&block)
+      with_config(:wait => false, &block)
+    end
+  end
+
   @configurations = []
   def (@configurations).update_from_source # :nodoc:
     self.each do |c|

data/lib/vapir-common/element.rb

@@ -267,7 +267,10 @@ module Vapir
     def locate!
       locate || begin
         klass=self.is_a?(Frame) ? Vapir::Exception::UnknownFrameException : Vapir::Exception::UnknownObjectException
-        message="Unable to locate #{self.class}, using #{@how}"+(@what ? ": "+@what.inspect : '')+(@index ? ", index #{@index}" : "")
+        using = []
+        using << "#{@how}: #{@what.inspect}" if @how
+        using << "index: #{@index}" if @index
+        message="Unable to locate #{self.class}" + (using.any? ? ", using #{using.join(", ")}" : "")
         message+="\non container: #{@container.inspect}" if @container
         raise(klass, message)
       end

data/lib/vapir-common/elements/elements.rb

@@ -304,16 +304,14 @@ module Vapir
     dom_attr :text, :value, :selected
     
     # sets this Option's selected state to the given (true or false). 
-    # if this Option is aware of its select list (this will generally be the case if you
-    # got this Option from a SelectList container), will fire the onchange event on the 
-    # select list if our state changes. 
+    # will fire the onchange event on the select list if our state changes. 
     def set_selected(state, method_options={})
-      method_options={:highlight => true, :wait => true}.merge(method_options)
+      method_options={:highlight => true, :wait => config.wait}.merge(method_options)
       with_highlight(method_options) do
         state_was=element_object.selected
         element_object.selected=state # TODO: if state is false and this isn't an option of a multiple select list, should this error? 
-        if @extra[:select_list] && state_was != state
-          @extra[:select_list].fire_event(:onchange, method_options)
+        if state_was != state
+          (@extra[:select_list] || parent_select_list).fire_event(:onchange, method_options)
         end
         wait if method_options[:wait]
       end
@@ -433,10 +431,10 @@ module Vapir
     # any have changed. raises Vapir::Exception::NoValueFoundException if none matched. 
     # breaks after the first match found if this is not a multiple select list. 
     # takes options hash (note, these are flags for the function, not to be confused with the Options of the select list)
-    # - :wait => true/false  default true. controls whether #wait is called and whether fire_event or fire_event_no_wait is
-    #   used for the onchange event. 
+    # - :wait => true/false - default is the current config.wait value. controls whether #wait is called and whether 
+    #   fire_event or fire_event_no_wait is used for the onchange event. 
     def select_options_if(method_options={})
-      method_options={:wait => true, :highlight => true}.merge(method_options)
+      method_options={:wait => config.wait, :highlight => true}.merge(method_options)
       raise ArgumentError, "no block given!" unless block_given?
       assert_enabled
       any_matched=false
@@ -496,7 +494,7 @@ module Vapir
     # Fires the onchange event if value changes. 
     # Fires the onclick event the state is true. 
     def set(state=true, options={})
-      options=handle_options(options, :highlight => true, :wait => true)
+      options=handle_options(options, :highlight => true, :wait => config.wait)
       with_highlight(options) do
         assert_enabled
         if checked!=state
@@ -527,9 +525,9 @@ module Vapir
     #
     # takes options:
     # * :highlight => true/false (defaults to true)
-    # * :wait => true/false (defaults to false)
+    # * :wait => true/false (defaults to true)
     def set(state=true, options={})
-      options=handle_options(options, :highlight => true, :wait => true)
+      options=handle_options(options, :highlight => true, :wait => config.wait)
       with_highlight(options) do
         assert_enabled
         if checked!=state

data/lib/vapir-common/keycodes.rb

@@ -1,5 +1,6 @@
 require 'vapir-common/external/core_extensions'
 module Vapir
+  # Hash of all known key codes. hash keys are symbols representing the key. hash values are integers. 
   KeyCodes = (('0'..'9').to_a+('a'..'z').to_a).inject({}){|hash, char| hash.merge(char.to_sym => char.vapir_ord) }.merge(
   {
     :cancel        => 3,
@@ -83,6 +84,8 @@ module Vapir
     :quote         => 222,
     :meta          => 224,
   })
+  # Hash of key codes for characters that get printed when you hit the key (in a text field for example). 
+  # hash keys are single-character strings; values are integers. 
   PrintKeyCodes = (('0'..'9').to_a+('a'..'z').to_a).inject({}){|hash, char| hash.merge(char => char.to_sym) }.merge(
   {
     "\t" => :tab,
@@ -100,6 +103,9 @@ module Vapir
     ']'  => :close_bracket,
     "'"  => :quote,
   }).inject({}){|hash, (key, key_codes_key)| hash.merge(key => KeyCodes[key_codes_key]) }
+  # Hash of key codes for characters that get printed when you hit the key combined with the shift key
+  # (in a text field for example). 
+  # hash keys are single-character strings; values are integers. 
   ShiftPrintKeyCodes = ('A'..'Z').to_a.inject({}){|hash, char| hash.merge(char => char.downcase.to_sym) }.merge(
   {
     ')' => :'0',
@@ -123,6 +129,8 @@ module Vapir
     '}' => :close_bracket,
     '"' => :quote,
   }).inject({}){|hash, (key, key_codes_key)| hash.merge(key => KeyCodes[key_codes_key]) }
+  # Hash of key codes for characters on the number pad. 
+  # hash keys are single-character strings; values are integers. 
   NumpadKeyCodes = ('0'..'9').inject({}){|hash, char| hash.merge(char => "numpad#{char}".to_sym) }.merge(
   {
     '*' => :multiply,

data/lib/vapir-common/version.rb

@@ -1,5 +1,5 @@
 module Vapir
   module Common
-    VERSION = '1.9.0'
+    VERSION = '1.10.0'
   end
 end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: vapir-common
 version: !ruby/object:Gem::Version 
-  hash: 51
   prerelease: false
   segments: 
   - 1
-  - 9
+  - 10
   - 0
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors: 
 - Ethan
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-04 00:00:00 -04:00
+date: 2011-09-28 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -68,27 +67,23 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Common basis for Vapir libraries for automating web browsers in Ruby