xdo 0.0.1-x86-linux → 0.0.2-x86-linux

data/Rakefile

@@ -13,27 +13,28 @@ spec = Gem::Specification.new do |s|
 XDo is a library to automate your mouse, fake keyboard input and 
 manipulate windows in a Linux X server environment. It's wrapped 
 around a lot of command line tools (see requirements) of which xdotool 
-is the main one, the others are usually installed. 
+is the main one, the others are usually installed. It's designed to work 
+only with Ruby 1.9. 
 DESCRIPTION
-  s.add_dependency("test-unit", ">= 2.0")
-  s.requirements = ["The xdotool command-line tool.", "xwininfo (usually installed)", "The xsel command-line tool.", "eject (usually installed)", "xkill (usually installed)"]
-  s.requirements << "The unit-test gem (will be installed if you don't have it)"
-  s.version = "0.0.1"
+  s.add_development_dependency("test-unit", ">= 2.0")
+  s.requirements = ["The xdotool command-line tool.", "The xsel command-line tool.", "xwininfo (usually installed)", "eject (usually installed)", "xkill (usually installed)"]
+  s.version = "0.0.2"
   s.author = "Marvin Gülker"
   s.email = "sutniuq@gmx.net"
-  s.platform = Gem::Platform::CURRENT
+  s.platform = Gem::Platform::CURRENT #Because it's a Linux-only gem
   s.required_ruby_version = ">=1.9"
-  s.files = ["bin/xinfo.rb", Dir["lib/**/*.rb"], Dir["test/*.rb"], Dir["samples/*.rb"], "Rakefile", "lib/README.rdoc"].flatten
+  s.files = ["bin/xinfo.rb", Dir["lib/**/*.rb"], Dir["test/*.rb"], Dir["samples/*.rb"], "Rakefile", "lib/README.rdoc", "lib/HISTORY.rdoc"].flatten
   s.executables = ["xinfo.rb"]
   s.has_rdoc = true
+  s.rdoc_options << "--title" << "XDo RDocs" <<  "--main" << "lib/README.rdoc"
   s.test_files = Dir["test/test_*.rb"]
   s.rubyforge_project = "Automations"
 end
 Rake::GemPackageTask.new(spec).define
 
 Rake::RDocTask.new do |rd|
-  rd.rdoc_files.include("lib/**/*.rb", "lib/README.rdoc")
-  rd.title = "xdo RDocs"
+  rd.rdoc_files.include("lib/**/*.rb", "lib/README.rdoc", "lib/HISTORY.rdoc")
+  rd.title = "XDo RDocs"
   rd.main = "lib/README.rdoc"
 end
 

data/lib/HISTORY.rdoc

@@ -0,0 +1,11 @@
+=History of the xdo gem
+This file shows the history of the xdo gem 
+from it's very beginning. Important changes in the 
+API are marked <b>bold</b>. 
+==0.0.2
+* Replaced fork{system("gedit")} in full_demo.rb with spawn("gedit")
+* Removed "require 'pp'" from keyboard.rb
+* <b>Added the Simulatable mixin</b>
+* <b>Corrected window id usage for the XDo::Keyboard module</b>
+* Added a test for the window id usage
+* Made the test-unit gem a development dependency

data/lib/README.rdoc

@@ -4,17 +4,13 @@ Copyright © 2009 Marvin Gülker
   Initia in potestate nostra sunt, de eventu fortuna iudicat. 
 ++
 =XDo
-XDo is a library to simmulate keyboard and mouse input and manipulating windows on the X server. 
+XDo is a library to simulate keyboard and mouse input and manipulating windows on the X server. 
 It's wrapped around the command-line tools xdotool[http://www.semicomplete.com/projects/xdotool/], 
-xsel[http://linux.die.net/man/1/xsel], xwininfo[http://linux.die.net/man/1/xwininfo], ecject[http://linux.die.net/man/1/eject] and xkill[http://linux.die.net/man/1/xkill], 
-so you will need to have them installed if you want to use Xdo (even if xsel, xwininfo, eject and xkill are usually already installed). 
-If not, as an Ubuntu or Debian user try to install them via 
-  sudo apt-get install xdotool xsel xwininfo eject xkill
+xsel[http://linux.die.net/man/1/xsel], xwininfo[http://linux.die.net/man/1/xwininfo], eject[http://linux.die.net/man/1/eject] and xkill[http://linux.die.net/man/1/xkill], 
+so you will need to have them installed if you want to use Xdo (even if xwininfo, eject and xkill are usually already installed). 
+If not, try to install them via your favourite packaging manager. 
 After they're installed, install XDo via RubyGems: 
   sudo gem install xdo
-If you want to run the tests, change to the gem's installation directory and type "rake test". 
-Keep in mind that, while the tests run, you won't be able to use your computer, since they take control 
-of all things XDo is able to. 
 ==Usage
   #Require some of XDo's files
   require "xdo/keyboard"
@@ -24,6 +20,8 @@ of all things XDo is able to.
   XDo::Mouse.move(100, 100)
   #Simulate text (with special escape sequences!)
   XDo::Keyboard.simulate("This is{TAB}text.")
+  #Some sequences can be shortened: 
+  XDo::Keyboard.simulate("This ist\ttext.")
   #And this will move a window containing the string "gedit", 
   #unless it's maximized. 
   win = XDo::XWindow.from_name("gedit")
@@ -42,10 +40,10 @@ It's by far not perfect, maybe not even good, but I think it can be useful somet
 (you will need to have wxRuby installed, try <tt>sudo gem install wxruby-ruby19</tt>). 
 If you're looking for a more professional program, try the "X window information" tool. 
 ==Notes
-* +xdotool+ rejects to accept the --window option although it's documented, so you can't use the +w_id+ parameter of many methods in XDo::Keyboard. 
+* If your +xdotool+ seems to reject the --window option, you are not using the current version. Try building the newest one from the source. 
 * I recommand the "X window information" tool to get infos about your windows if you aren't satisfied by the xinfo.rb shipped with this package. 
 ==Fairly incomplete
-* I'm sure there are several things I didn't notice that can be automated somehow. If you know about, email me! Please add a description of the possibilities and a sample script (but don't expect that I will understand it - I only speak Ruby fluently, a bit C and a bit sh ;-) )
+* I'm sure there are several things I didn't notice that can be automated somehow. If you know about, email me! Please add a description of the possibilities and a sample script. 
 * Another interesting thing are the samples. There are many Linux distrubitions out there, and even many of them rely on X. I cannot test with another than a recent Ubuntu machine, but if you want to contribute and send samples for another OS, I want to encourage you to - I surely won't reject your work. :-)
 ==License/Copyright
   Copyright © 2009 Marvin Gülker

data/lib/xdo.rb

@@ -21,6 +21,9 @@ module XDo
   #The command to start eject. 
   EJECT = "eject"
   
+  #The version of this library. 
+  VERSION = "0.0.2"
+  
   #Class for errors in this library. 
   class XError < StandardError
   end

data/lib/xdo/keyboard.rb

@@ -3,7 +3,6 @@
 #Copyright © 2009 Marvin Gülker
 #  Initia in potestate nostra sunt, de eventu fortuna iudicat. 
 require_relative("../xdo")
-require "pp"
 
 module XDo
   
@@ -150,7 +149,7 @@ module XDo
       #Types a character sequence, but without any special chars. 
       #This function is a bit faster then #simulate. 
       def type(str, w_id = nil)
-        out = `#{XDOTOOL} type #{w_id ? "--window #{w_id}" : ""}"#{str}"`
+        out = `#{XDOTOOL} type #{w_id ? "--window #{w_id} " : ""}"#{str}"`
         nil
       end
       
@@ -164,7 +163,7 @@ module XDo
         if raw
           commands = []
           str.each_char do |char|
-            commands << "#{XDOTOOL} key #{w_id ? "--window #{w_id}" : ""}#{check_for_special_key(char)}"
+            commands << "#{XDOTOOL} key #{w_id ? "--window #{w_id} " : ""}#{check_for_special_key(char)}"
           end
           
           commands.each do |cmd|
@@ -197,7 +196,7 @@ module XDo
             else
               #Ab hier ist der Token sicherlich normaler Text; entsprechend wird damit verfahren. 
               token.each_char do |char|
-                commands << "#{XDOTOOL} key #{w_id ? "--window #{w_id}" : ""}#{check_for_special_key(char)}"
+                commands << "#{XDOTOOL} key #{w_id ? "--window #{w_id} " : ""}#{check_for_special_key(char)}"
               end
               commands.flatten! #Zur Sicherheit
             end
@@ -212,18 +211,18 @@ module XDo
       #Simulate a single char directly via the +key+ function of +xdotool+. 
       #+c+ is a single char like "a" or a combination like "shift+a". 
       def char(c, w_id = nil)
-        `#{XDOTOOL} key #{w_id ? "--window #{w_id}" : ""}#{c}`
+        `#{XDOTOOL} key #{w_id ? "--window #{w_id} " : ""}#{c}`
       end
       alias key char
       
       #Holds a key down. Please call #key_up after a call to this method. 
       def  key_down(key, w_id = nil)
-        `#{XDOTOOL} keydown #{w_id ? "--window #{w_id}" : "" }#{check_for_special_key(key)}`
+        `#{XDOTOOL} keydown #{w_id ? "--window #{w_id} " : "" }#{check_for_special_key(key)}`
       end
       
       #Releases a key hold down by #key_down. 
       def key_up(key, w_id = nil)
-        `#{XDOTOOL} keyup #{w_id ? "--window #{w_id}" : "" }#{check_for_special_key(key)}`
+        `#{XDOTOOL} keyup #{w_id ? "--window #{w_id} " : "" }#{check_for_special_key(key)}`
       end
       
       #Deletes a char. If +right+ is true, +del_char+ uses 

data/lib/xdo/simulatable.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+#Encoding: UTF-8
+#This file is part of Xdo. 
+#Copyright © 2009 Marvin Gülker
+#  Initia in potestate nostra sunt, de eventu fortuna iudicat. 
+require_relative("../xdo")
+require_relative("./keyboard")
+
+module XDo
+  
+  #Mixin that allows String-like objects to be directly 
+  #simulated. You can use it with Ruby's String class: 
+  #  require "xdo/simulatable"
+  #  
+  #  class String
+  #    include XDo::Simulatable
+  #    def to_xdo
+  #      to_s
+  #    end
+  #  end
+  #
+  #  "abc".simulate
+  #Every method in this module calls ##to_xdo on +self+ 
+  #first, so make sure this method returns a xdo-usable 
+  #String (i.e. no invisible characters except newline, tab and space). 
+  module Simulatable
+    
+    #Simulates +self+ as keystrokes. Escape sequences are allowed. 
+    def simulate(raw = false, w_id = nil)
+      XDo::Keyboard.simulate(to_xdo, raw, w_id)
+    end
+    
+    #Types +self+ as keystrokes. Ignores escape sequences. 
+    def type(w_id = nil)
+      XDo::Keyboard.type(to_xdo, w_id)
+    end
+    
+    #Holds the first key of +self+ down. 
+    def down(w_id = nil)
+      XDo::Keyboard.key_down(to_xdo[0], w_id)
+    end
+    
+    #Releases the first key of +self+ if it's hold 
+    #down by #down. 
+    def up(w_id = nil)
+      XDo::Keyboard.key_up(to_xdo[0], w_id)
+    end
+    
+  end
+  
+end

data/samples/full_demo.rb

@@ -36,7 +36,7 @@ class XXX
     #If we would use system in the main program to open 
     #gedit, it would hang until gedit is closed. That's why 
     #we run it in a separate process. 
-    fork{system("gedit")}
+    spawn("gedit")
     #Now we wait until gedit has made up its GUI. 
     #wait_for_window returns the ID of the found window, so 
     #we catch it and...
@@ -104,7 +104,7 @@ class XXX
     #command and it sometimes works, but you mustn't rely on it. Therefore I use 
     #the HOME environment variable here to get the home directory, rather than ~. 
     XDo::Keyboard.simulate("#{ENV["HOME"]}/testXDo.txt")
-    sleep 1 #gedit terminates if send [ALT]+[A] immediatly after the path
+    sleep 1 #gedit terminates if send [ALT]+[S] immediatly after the path
     XDo::Keyboard.alt_s
     #Now, let's duplicate our table. We could send all the stuff again, 
     #but I want to introduce you in the use of the X clipboard. 
@@ -132,7 +132,7 @@ class XXX
     sleep 5
     #Than close gedit. There are three methods to close a window, 
     ##close, #close! and #kill!. #close is like sending an [ALT]+[F4] keypress which may result in 
-    #a dialog box asking you for confimation. #close! is a bit stronger. First it calls #close and waits 
+    #a dialog box asking you for confirmation. #close! is a bit stronger. First it calls #close and waits 
     #a few seconds (you can specify how long exactly) then shuts down the window process. What 
     #leads us to the third method: #kill!. Be sure to call #kill! only on windows you know - 
     #it kills the process of a window by sending SIGTERM first and then SIGKILL. I've not tried 

data/test/test_keyboard.rb

@@ -1,60 +1,110 @@
 #!/usr/bin/env ruby
 #Encoding: UTF-8
 require "test/unit"
+require "tempfile"
 require "xdo/keyboard.rb"
 require "xdo/clipboard.rb"
 require "xdo/xwindow"
+require "xdo/simulatable"
 
 class TestKeyboard < Test::Unit::TestCase
   
   #Command to start a simple text editor
   EDITOR_CMD = "gedit"
-  TESTFILENAME = "#{ENV["HOME"]}/abcdefghijklmnopqrstuvwxyzäöüß.txt"
+  
   TESTTEXT = "This is test\ntext."
-  APPEND = "XYZ"
+  TESTTEXT2 = "XYZ"
   TESTTEXT_RAW = "ä{TAB}?b"
   TESTTEXT_SPECIAL = "ab{TAB}c{TAB}{TAB}d"
   
-  def self.startup
-    File.open(TESTFILENAME, "w"){|file| file.write(TESTTEXT)}
-    fork{system(%Q|#{EDITOR_CMD} "#{TESTFILENAME}"|)}
-    sleep 5
+  def setup
+    @edit_pid = spawn(EDITOR_CMD)
+    sleep 0.5
+  end
+  
+  def teardown
+    Process.kill("KILL", @edit_pid)
   end
   
-  def test_all
-    XDo::Keyboard.simulate("{PGUP}")
+  def test_char
+    Process.kill("KILL", @edit_pid) #Special file need to be opened
+    tempfile = Tempfile.open("XDOTEST")
+    tempfile.write(TESTTEXT)
+    tempfile.flush
+    sleep 1 #Wait for the buffer to be written out
+    @edit_pid = spawn(EDITOR_CMD, tempfile.path) #So it's automatically killed by #teardown
+    sleep 1
+    tempfile.close
     20.times{XDo::Keyboard.char("Shift+Right")}
     XDo::Keyboard.ctrl_c
     sleep 0.2
     assert_equal(TESTTEXT, XDo::Clipboard.read_clipboard)
-    XDo::Keyboard.simulate("{RIGHT}#{APPEND}")
+  end
+  
+  def test_simulate
+    XDo::Keyboard.simulate("A{BS}#{TESTTEXT2}")
     XDo::Keyboard.ctrl_a
     XDo::Keyboard.ctrl_c
     sleep 0.2
-    assert_equal(TESTTEXT + APPEND, XDo::Clipboard.read_clipboard)
-    (TESTTEXT.length + APPEND.length + 2).times{XDo::Keyboard.simulate("\b")}
-    XDo::Keyboard.simulate(TESTTEXT_RAW, true)
+    assert_equal(TESTTEXT2, XDo::Clipboard.read_clipboard)
+    
+    XDo::Keyboard.ctrl_a
+    XDo::Keyboard.delete
+    XDo::Keyboard.simulate(TESTTEXT_SPECIAL)
+    XDo::Keyboard.ctrl_a
+    XDo::Keyboard.ctrl_c
     sleep 0.2
+    assert_equal(TESTTEXT_SPECIAL.gsub("{TAB}", "\t"), XDo::Clipboard.read_clipboard)
+    
+    XDo::Keyboard.ctrl_a
+    XDo::Keyboard.delete
+    XDo::Keyboard.simulate(TESTTEXT_RAW, true)
     XDo::Keyboard.ctrl_a
     XDo::Keyboard.ctrl_c
     sleep 0.2
     assert_equal(TESTTEXT_RAW, XDo::Clipboard.read_clipboard)
-    (TESTTEXT_RAW.length + 2).times{XDo::Keyboard.delete}
-    XDo::Keyboard.simulate(TESTTEXT_SPECIAL)
+  end
+  
+  def test_type
+    XDo::Keyboard.type(TESTTEXT2)
+    XDo::Keyboard.ctrl_a
+    XDo::Keyboard.ctrl_c
     sleep 0.2
+    assert_equal(TESTTEXT2, XDo::Clipboard.read_clipboard)
+  end
+  
+  def test_window_id
+    XDo::XWindow.focus_desktop #Ensure that the editor hasn't the input focus anymore
+    sleep 1
+    edit_id = XDo::XWindow.search(EDITOR_CMD).first
+    xwin = XDo::XWindow.new(edit_id)
+    XDo::Keyboard.simulate(TESTTEXT_SPECIAL, false, edit_id)
+    sleep 1
+    xwin.activate
     XDo::Keyboard.ctrl_a
     XDo::Keyboard.ctrl_c
     sleep 0.2
     assert_equal(TESTTEXT_SPECIAL.gsub("{TAB}", "\t"), XDo::Clipboard.read_clipboard)
   end
   
-  def self.shutdown
-    xwin = XDo::XWindow.from_name(EDITOR_CMD)
-    xwin.activate
-    XDo::Keyboard.ctrl_s
-    sleep 0.5
-    xwin.close
-    File.delete(TESTFILENAME)
+  def test_include
+    String.class_eval do
+      include XDo::Simulatable
+      
+      def to_xdo
+        to_s
+      end
+    end
+    
+    XDo::Keyboard.ctrl_a
+    XDo::Keyboard.delete
+    "Ein String".simulate
+    XDo::Keyboard.ctrl_a
+    sleep 0.2
+    XDo::Keyboard.ctrl_c
+    sleep 0.2
+    clip = XDo::Clipboard.read_clipboard
+    assert_equal("Ein String", clip)
   end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: xdo
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: x86-linux
 authors: 
 - "Marvin G\xC3\xBClker"
@@ -9,12 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-23 00:00:00 +02:00
+date: 2009-12-04 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: test-unit
-  type: :runtime
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -26,7 +26,8 @@ description: |
   XDo is a library to automate your mouse, fake keyboard input and 
   manipulate windows in a Linux X server environment. It's wrapped 
   around a lot of command line tools (see requirements) of which xdotool 
-  is the main one, the others are usually installed. 
+  is the main one, the others are usually installed. It's designed to work 
+  only with Ruby 1.9. 
 
 email: sutniuq@gmx.net
 executables: 
@@ -39,6 +40,7 @@ files:
 - bin/xinfo.rb
 - lib/xdo.rb
 - lib/xdo/xwindow.rb
+- lib/xdo/simulatable.rb
 - lib/xdo/mouse.rb
 - lib/xdo/drive.rb
 - lib/xdo/keyboard.rb
@@ -53,13 +55,17 @@ files:
 - samples/full_demo.rb
 - Rakefile
 - lib/README.rdoc
+- lib/HISTORY.rdoc
 has_rdoc: true
 homepage: 
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --title
+- XDo RDocs
+- --main
+- lib/README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -76,11 +82,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: 
 - The xdotool command-line tool.
-- xwininfo (usually installed)
 - The xsel command-line tool.
+- xwininfo (usually installed)
 - eject (usually installed)
 - xkill (usually installed)
-- The unit-test gem (will be installed if you don't have it)
 rubyforge_project: Automations
 rubygems_version: 1.3.5
 signing_key: