casper 0.0.4 → 0.0.5

data/lib/casper.rb

@@ -2,7 +2,25 @@ require "libxdo"
 
 module Casper
   class Mouse
+    @@delay = 0
+    
     class << self
+      # Sets a time (in seconds, pass floats for fractions of a second) to
+      # delay after every operation. Useful for situations where the commands
+      # are going to a window and want to give the window a little time to
+      # react before sending more commands (i.e. letting the browser fire
+      # events).
+      # 
+      # Defaults to 0 (no delay).
+      def delay=(delay)
+        @@delay = delay
+      end
+      
+      # Returns the current delay time.
+      def delay
+        @@delay
+      end
+      
       # Move the mouse directly to the specified x/y coordinates.
       # 
       # If relative = true the x/y coordinates used are relative from the
@@ -59,16 +77,26 @@ module Casper
       # 
       # i.e.
       # 
-      #   drag :to => [ 300, 350 ]
-      #   drag :from => [ 200, 300 ], :to => [ 400, 800 ]
-      #   drag :from => [ 200, 300 ], :distance => [ 200, 500 ]
-      #   drag :from => [ 200, 300 ], :distance => [ 220, 340 ], :increments => 20
-      #   drag :from => [ 200, 300 ], :to => [ 300, 400 ] do
-      #     sleep 0.5
-      #   end
-      #   drag :distance => [ 20, 0 ] do
-      #     drag :distance => [ 0, 30 ]
-      #   end
+      #     drag :to => [ 300, 350 ]
+      #     drag :from => [ 200, 300 ], :to => [ 400, 800 ]
+      #     drag :from => [ 200, 300 ], :distance => [ 200, 500 ]
+      #     drag :from => [ 200, 300 ], :distance => [ 220, 340 ], :increments => 20
+      #     drag :from => [ 200, 300 ], :to => [ 300, 400 ] do
+      #       sleep 0.5
+      #     end
+      #     drag :distance => [ 20, 0 ] do
+      #       drag :distance => [ 0, 30 ]
+      #     end
+      # 
+      # NOTE: that if :increments is not evenly divisble by the total distance
+      # the mouse will move in either direction then the distance of each
+      # iteration will not be consistent. The iterations are individually
+      # rounded to try to provide a smooth movement. For instance, take:
+      # 
+      #     drag :from => [ 0, 0 ], :distance => [ 20, 20 ], :increments => 8
+      # 
+      # will still occur in 8 iterations, however each 3rd iteration will move
+      # 3px instead of 2px.
       def drag(options={}, &block)
         raise ArgumentError.new(":to or :distance is required to provide ending location") unless options.has_key?(:to) || options.has_key?(:distance)
         raise ArgumentError.new(":increments must be > 0") if options.has_key?(:increments) && options[:increments] <= 0
@@ -76,13 +104,14 @@ module Casper
         from       ||= options[:from] || location
         increments   = options[:increments] || 10
         distance     = options[:distance] || [ options[:to][0] - from[0], options[:to][1] - from[1] ]
-        
-        shift_x = distance[0] / increments
-        shift_y = distance[1] / increments
 
         move from[0], from[1]
         down
-        increments.times{ |i| move(shift_x, shift_y, true) }
+        increments.times do |i|
+          x = (from[0] + (distance[0].to_f / increments) * (i + 1)).round
+          y = (from[1] + (distance[1].to_f / increments) * (i + 1)).round
+          move(x, y)
+        end
         yield if block_given?
         up
       end
@@ -93,8 +122,9 @@ module Casper
       def xdo(&block)
         xdo = Libxdo.xdo_new(nil)
         yield(xdo)
+        sleep delay
         Libxdo.xdo_free(xdo)
-      end      
+      end
       
       # Performs an absolute mouse move
       def absolute(x, y)

data/test/casper_test.rb

@@ -17,6 +17,7 @@ $('<div class="target" id="#{id}"></div>').
   end
   
   setup do
+    Casper::Mouse.delay = 0.010
     Casper::Mouse.move 0, 0
     # Gets rid of the menu if it was left open (i.e. from leaving the mouse
     # button down and moving over it).
@@ -110,6 +111,33 @@ $('<div class="target" id="#{id}"></div>').
       assert_raise ArgumentError do
         Casper::Mouse.drag :from => [ 1, 1 ]
       end
-    end    
+    end
+    
+    should "end in the correct location when the distance is not divisible by the number of increments" do
+      Casper::Mouse.drag :from => [ 0, 0 ], :to => [ 20, 20 ], :increments => 8
+      assert_equal [ 20, 20 ], Casper::Mouse.location
+    end
+
+    should "end in the correct location when one axis is not divisible by the number of increments" do
+      Casper::Mouse.drag :from => [ 0, 0 ], :to => [ 16, 20 ], :increments => 8
+      assert_equal [ 16, 20 ], Casper::Mouse.location
+    end
+  end
+  
+  describe "with delay" do
+    should "move with no delay by default" do
+      start = Time.now
+      Casper::Mouse.move 10, 10
+      Casper::Mouse.move 20, 20
+      assert (Time.now.to_i - start.to_i) < 0.5
+    end
+    
+    should "delay after moving" do
+      start = Time.now
+      Casper::Mouse.delay = 0.5
+      Casper::Mouse.move 10, 10
+      Casper::Mouse.move 20, 20
+      assert (Time.now.to_f - start.to_f) > 0.5
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: casper
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Ben Alavi