active_window_x 0.0.1

data/spec/root_window_spec.rb

@@ -0,0 +1,47 @@
+# -*- coding:utf-8; mode:ruby; -*-
+
+require 'active_window_x'
+
+include ActiveWindowX
+
+describe RootWindow do
+  before do
+    @display_raw = mock Xlib::Display
+    @display_raw.stub(:kind_of?).with(Data).and_return(true)
+    Xlib.stub(:x_open_display).and_return(@display_raw)
+    @display = Display.new
+    @root_id = 9999
+    Xlib.stub(:default_root_window).with(@display_raw).and_return(@root_id)
+    @root = @display.root_window
+  end
+
+  describe '#active_window' do
+    before do
+      @prop_atom = 111
+      @active_window_id = 123456
+      Xlib.should_receive(:x_intern_atom).with(@display.raw, '_NET_ACTIVE_WINDOW', false).
+        and_return(@prop_atom)
+    end
+    context ', which Xlib::x_get_window_property find an active window,' do
+      before do
+        Xlib.should_receive(:x_get_window_property).
+          with(@display.raw, @root.id, @prop_atom, 0, Window::READ_BUFF_LENGTH, false, Xlib::AnyPropertyType).
+          and_return([0,32,2,0,[@active_window_id,0].pack('l!*')])
+      end
+      it 'should return the active windows' do
+        @display.active_window.id.should == @active_window_id
+      end
+    end
+    context ', which Xlib::x_get_window_property cannot find an active window,' do
+      before do
+        Xlib.should_receive(:x_get_window_property).
+          with(@display.raw, @root.id, @prop_atom, 0, Window::READ_BUFF_LENGTH, false, Xlib::AnyPropertyType).
+          and_return([0,32,2,0,[Xlib::None,0].pack('l!*')])
+      end
+      it 'should return nil' do
+        @display.active_window.should == nil
+      end
+    end
+  end
+
+end

data/spec/window_spec.rb

@@ -0,0 +1,285 @@
+# -*- coding:utf-8; mode:ruby; -*-
+
+require 'active_window_x'
+
+include ActiveWindowX
+
+describe Window do
+  before do
+    @raw_display = mock Xlib::Display
+    @display = mock Display
+    @display.stub(:raw){@raw_display}
+    @display.stub(:kind_of?).with(Display).and_return(true)
+    @id = 123456
+    @window = Window.new @display, @id
+  end
+
+  describe '#root' do
+    context ', which recive a window from x_query_tree,' do
+      before do
+        @root = 111
+        Xlib.should_receive(:x_query_tree).
+          with(@display.raw, @window.id).
+          and_return([@root, nil, []])
+      end
+      it 'should return the root Window' do
+        @window.root.id.should == @root
+      end
+    end
+    context ', which recive nil from x_query_tree,' do
+      before do
+        Xlib.should_receive(:x_query_tree).
+          with(@display.raw, @window.id).
+          and_return([nil, nil, []])
+      end
+      it 'should return nil' do
+        @window.root.should be_nil
+      end
+    end
+  end
+
+  describe '#parent' do
+    context ', which recive a window from x_query_tree,' do
+      before do
+        @parent = 111
+        Xlib.should_receive(:x_query_tree).
+          with(@display.raw, @window.id).
+          and_return([nil, @parent, []])
+      end
+      it 'should return the parent Window' do
+        @window.parent.id.should == @parent
+      end
+    end
+    context ', which recive nil from x_query_tree,' do
+      before do
+        Xlib.should_receive(:x_query_tree).
+          with(@display.raw, @window.id).
+          and_return([nil, nil, []])
+      end
+      it 'should return nil' do
+        @window.root.should be_nil
+      end
+    end
+  end
+
+  describe '#children' do
+    before do
+      @children = []
+      @children.push 111
+      @children.push 222
+      @children.push 333
+      Xlib.should_receive(:x_query_tree).
+        with(@display.raw, @window.id).
+        and_return([nil, nil, @children])
+    end
+    it 'should return the child Windows' do
+      c = @window.children
+      c[0].id.should == @children[0]
+      c[1].id.should == @children[1]
+      c[2].id.should == @children[2]
+    end
+  end
+
+  describe '#title' do
+    context ', when the _NET_WM_NAME and WM_NAME prop was not found,' do
+      before do
+        @window.stub(:prop).with('_NET_WM_NAME').and_return(nil)
+        @window.stub(:prop).with('WM_NAME').and_return(nil)
+      end
+      it 'should return nil' do
+        @window.title.should be_nil
+      end
+    end
+    context ', when the WM_NAME prop was found,' do
+      before do
+        @title = 'foo bar baz'
+        @window.stub(:prop).with('_NET_WM_NAME').and_return(nil)
+        @window.stub(:prop).with('WM_NAME').and_return(@title)
+      end
+      it 'should return the value' do
+        @window.title.should == @title
+      end
+    end
+    context ', when the _NET_WM_NAME prop was found,' do
+      before do
+        @title = 'foo bar baz'
+        @window.stub(:prop).with('_NET_WM_NAME').and_return(@title)
+      end
+      it 'should return the value' do
+        @window.title.should == @title
+      end
+    end
+  end
+
+  describe '#app_name' do
+    context ', when the class prop was not found,' do
+      before do
+        @window.stub(:prop).with('WM_CLASS').and_return(nil)
+      end
+      it 'should return nil' do
+        @window.app_name.should be_nil
+      end
+    end
+    context ', when the class prop was found,' do
+      before do
+        @name = "bar"
+        @class = "foo"
+        @value = "#{@name}\0#{@class}\0"
+        @window.stub(:prop).with('WM_CLASS').and_return(@value)
+      end
+      it 'should return the value' do
+        @window.app_name.should == @name
+      end
+    end
+  end
+
+  describe '#app_class' do
+    context ', when the class prop was not found,' do
+      before do
+        @window.stub(:prop).with('WM_CLASS').and_return(nil)
+      end
+      it 'should return nil' do
+        @window.app_class.should be_nil
+      end
+    end
+    context ', when the class prop was found,' do
+      before do
+        @name = "bar"
+        @class = "foo"
+        @value = "#{@name}\0#{@class}\0"
+        @window.stub(:prop).with('WM_CLASS').and_return(@value)
+      end
+      it 'should return the value' do
+        @window.app_class.should == @class
+      end
+    end
+  end
+
+  describe '#pid' do
+    context ', when the pid prop was not found,' do
+      before do
+        @window.stub(:prop).with('_NET_WM_PID').and_return(nil)
+      end
+      it 'should return nil' do
+        @window.pid.should be_nil
+      end
+    end
+    context ', when the pid prop was found,' do
+      before do
+        @pid = 1111111
+        @window.stub(:prop).with('_NET_WM_PID').and_return([@pid])
+      end
+      it 'should return nil' do
+        @window.pid.should == @pid
+      end
+    end
+  end
+
+  describe '#command' do
+    context ', when the pid prop was not found,' do
+      before do
+        @window.stub(:prop).with('_NET_WM_PID').and_return(nil)
+      end
+      it 'should return nil' do
+        @window.command.should be_nil
+      end
+    end
+    context ', when the pid prop was found,' do
+      before do
+        @pid = 1111111
+        @window.stub(:prop).with('_NET_WM_PID').and_return([@pid])
+        @command = 'foobar'
+        @path = "/proc/#{@pid}/cmdline"
+        File.stub(:readable_real?).with(@path).and_return(true)
+        File.stub(:read).with(@path).and_return(@command)
+      end
+      it 'should return nil' do
+        @window.command.should == @command
+      end
+    end
+  end
+
+  describe '#prop' do
+    before do
+      @prop_id = 1234
+      @prop_name = 'FOO'
+      @display.should_receive(:intern_atom).with(@prop_name).and_return(@prop_id)
+    end
+    context 'with a property name, which does not exist for the window,' do
+      before do
+        Xlib.should_receive(:x_get_window_property).
+          with(@display.raw, @window.id, @prop_id, 0, Window::READ_BUFF_LENGTH, false, Xlib::AnyPropertyType).
+          and_return([nil, 0, 0, 0, nil])
+      end
+      it 'should return nil' do
+        @window.prop(@prop_name).should be_nil
+      end
+    end
+    context 'with a property name, which exist for the window and is the long type,' do
+      before do
+        @prop = [123, 456]
+        Xlib.should_receive(:x_get_window_property).
+          with(@display.raw, @window.id, @prop_id, 0, Window::READ_BUFF_LENGTH, false, Xlib::AnyPropertyType).
+          and_return([@prop_id, 32, @prop.length, 0, @prop.pack('l!*')])
+      end
+      it 'should return a Array of Numeric' do
+        @window.prop(@prop_name).should == @prop
+      end
+    end
+    context 'with a property name, which exist for the window and is the short type,' do
+      before do
+        @prop = [12, 34, 46]
+        Xlib.should_receive(:x_get_window_property).
+          with(@display.raw, @window.id, @prop_id, 0, Window::READ_BUFF_LENGTH, false, Xlib::AnyPropertyType).
+          and_return([@prop_id, 16, @prop.length, 0, @prop.pack('s*')])
+      end
+      it 'should return a Array of Numeric' do
+        @window.prop(@prop_name).should == @prop
+      end
+    end
+    context 'with a property name, which exist for the window and is the char type,' do
+      before do
+        @prop = "abcdefg\0hijklmn"
+        Xlib.should_receive(:x_get_window_property).
+          with(@display.raw, @window.id, @prop_id, 0, Window::READ_BUFF_LENGTH, false, Xlib::AnyPropertyType).
+          and_return([@prop_id, 8, @prop.length, 0, @prop])
+      end
+      it 'should return String' do
+        @window.prop(@prop_name).should == @prop
+      end
+    end
+  end
+
+  describe '#prop_atom_ids' do
+    context ', which recieve property atoms(Numeric),' do
+      before do
+        @prop_list = [000, 111, 222]
+        Xlib.should_receive(:x_list_properties).and_return(@prop_list)
+      end
+      it 'shuold return the atoms' do
+        @window.prop_atom_ids.should == @prop_list
+      end
+    end
+    context ', which recieve no property atoms,' do
+      before do
+        @prop_list = nil
+        Xlib.should_receive(:x_list_properties){ @prop_list }
+      end
+      it 'shuold return an empty array' do
+        @window.prop_atom_ids.should == []
+      end
+    end
+  end
+
+  describe '#select_input' do
+    context 'with a valid mask' do
+      before do
+        @mask = Xlib::PropertyChangeMask
+        Xlib.should_receive(:x_select_input).with(@display.raw, @id, @mask).and_return(1)
+      end
+      it 'should call Xlib::x_select_input' do
+        @window.select_input @mask
+      end
+    end
+  end
+end

data/spec/xlib_spec.rb

@@ -0,0 +1,245 @@
+# -*- coding:utf-8; mode:ruby; -*-
+
+require 'active_window_x'
+require 'dl'
+
+include ActiveWindowX
+
+describe Xlib do
+  describe '.#x_open_display' do
+    context 'with nil' do
+      it 'should return a Display' do
+        Xlib::x_open_display(nil).class.should == Xlib::Display
+      end
+    end
+    context 'with the default display name' do
+      it 'should return a Display' do
+        Xlib::x_open_display(ENV['DISPLAY']).class.should == Xlib::Display
+      end
+    end if ENV['DISPLAY']
+    context 'with an invalid display name' do
+      it 'should raise a exception' do
+        lambda{ Xlib::x_open_display('foo') }.should raise_error(Xlib::UnknownDisplayName)
+      end
+    end
+  end
+
+  describe '.#x_close_display' do
+    context 'with a Display' do
+      it 'should return 0' do
+        d = Xlib::x_open_display(nil)
+        Xlib::x_close_display(d).should == 0
+      end
+    end
+  end
+
+  describe '.#get_input_focus' do
+    before do
+      @display = Xlib::x_open_display(nil)
+    end
+    after do
+      Xlib::x_close_display @display
+    end
+    it 'should return a Array of Number (for window id)' do
+      result = Xlib::x_get_input_focus(@display)
+      result[0].should be_a Numeric
+      result[1].should be_within(0).of(2)
+    end
+  end
+
+  describe '.#x_query_tree' do
+    before do
+      @display = Xlib::x_open_display(nil)
+    end
+    after do
+      Xlib::x_close_display @display
+    end
+    context 'with the root window' do
+      before do
+        @root = Xlib::default_root_window(@display)
+      end
+      it 'should return the root, the parent and then children' do
+        result = Xlib::x_query_tree(@display, @root)
+        result.shift.should == @root
+        result.shift.should be_nil
+        children = result.shift
+        children.each do |w|
+          w.should be_a Numeric
+        end
+      end
+    end
+    context 'with a child window of the root window' do
+      before do
+        @root = Xlib::default_root_window(@display)
+        result = Xlib::x_query_tree(@display, @root)
+        children = result[2]
+        @window = children.first
+      end
+      it 'should return the root, the parent and then children' do
+        result = Xlib::x_query_tree(@display, @window)
+        result.shift.should == @root
+        result.shift.should be_a Numeric
+        children = result.shift
+        children.each do |w|
+          w.should be_a Numeric
+        end
+      end
+    end
+  end
+
+  describe '.#intern_atom' do
+    before do
+      @display = Xlib::x_open_display(nil)
+    end
+    after do
+      Xlib::x_close_display @display
+    end
+    context "with a atom name" do
+      it 'should return a Numeric' do
+        Xlib::x_intern_atom(@display, "Name", false).should be_a Numeric
+      end
+    end
+  end
+
+  describe '.#get_atom_name' do
+    before do
+      @display = Xlib::x_open_display(nil)
+      @name = "Name"
+      @atom = Xlib::x_intern_atom(@display, @name, false)
+    end
+    after do
+      Xlib::x_close_display @display
+    end
+    context "with a atom" do
+      it 'should return the atom name' do
+        Xlib::x_get_atom_name(@display, @atom).should == @name
+      end
+    end
+  end
+
+  describe '.#get_window_property' do
+    before do
+      @display = Xlib::x_open_display nil
+      @window = Xlib::default_root_window @display
+      @length = 1024
+    end
+    after do
+      Xlib::x_close_display @display
+    end
+    context 'with unknown property' do
+      before do
+        @name = "FOO"
+        @atom = Xlib::x_intern_atom @display, @name, false
+      end
+      it 'should return a Array such as [Xlib::None, ]' do
+        r = Xlib::x_get_window_property(@display, @window, @atom, 0, @length, false, Xlib::AnyPropertyType);
+        r.shift.should == Xlib::None
+        r.shift.should == 0
+        r.shift.should == 0
+        r.shift.should == 0
+        r.length.should == 1
+      end
+    end
+    context 'with an invalid type and a propery named as "_NET_ACTIVE_WINDOW"' do
+      before do
+        @name = "_NET_ACTIVE_WINDOW"
+        @atom = Xlib::x_intern_atom @display, @name, false
+        @window_atom = Xlib::x_intern_atom(@display, "WINDOW", false)
+      end
+      it 'should return a Array such as [Xlib::None, ]' do
+        r = Xlib::x_get_window_property(@display, @window, @atom, 0, @length, false, 10)
+        p r
+        r.shift.should == @window_atom
+        r.shift.should == 32
+        r.shift.should == 0
+        r.shift.should # == DL::sizeof('l')
+        r.length.should == 1
+      end
+    end
+    context 'with an validi type and a propery named as "_NET_ACTIVE_WINDOW"' do
+      before do
+        @name = "_NET_ACTIVE_WINDOW"
+        @atom = Xlib::x_intern_atom @display, @name, false
+        @window_atom = Xlib::x_intern_atom(@display, "WINDOW", false)
+      end
+      it 'should return a Array such as [Xlib::None, ]' do
+        r = Xlib::x_get_window_property(@display, @window, @atom, 0, @length, false, @window_atom)
+        p r
+        r.shift.should == @window_atom
+        r.shift.should == 32
+        l = r.shift
+        r.shift.should
+        r.shift.length == DL::sizeof('l') * l
+      end
+    end
+  end
+
+  describe '.#list_properties' do
+    before do
+      @display = Xlib::x_open_display nil
+      @root = Xlib::default_root_window @display
+    end
+    after do
+      Xlib::x_close_display @display
+    end
+    context 'with the root window' do
+      it 'should return a Array of Numeric' do
+        arr = Xlib::x_list_properties(@display, @root)
+        arr.should be_a Array
+        arr.each{|a| a.should be_a Numeric; }
+      end
+    end
+    context 'with child windows of the root window' do
+      before do
+        arr = Xlib::x_query_tree @display, @root
+        @children = arr[2]
+      end
+      it 'should return a Array of Numeric' do
+        @children.each do |child|
+          arr = Xlib::x_list_properties(@display, child)
+          if arr
+            arr.should be_a Array
+            arr.each{|a| a.should be_a Numeric }
+          else
+            arr.should be_nil
+          end
+        end
+      end
+    end
+  end
+
+  describe '.#x_select_input' do
+    before do
+      @display = Xlib::x_open_display nil
+      @root = Xlib::default_root_window @display
+    end
+    after do
+      Xlib::x_close_display @display
+    end
+    it 'should return a int' do
+      ret = Xlib::x_select_input @display, @root, Xlib::PropertyChangeMask
+      ret.should be_a Numeric
+    end
+  end
+
+  describe '.#x_next_event' do
+    before do
+      @display = Xlib::x_open_display nil
+      @root = Xlib::default_root_window @display
+      ret = Xlib::x_select_input @display, @root, Xlib::PropertyChangeMask
+    end
+    after do
+      Xlib::x_close_display @display
+    end
+    it 'should return an event' do
+      puts "\nswitch another window !"
+      event = Xlib::x_next_event @display
+      event.should be_a Xlib::XPropertyEvent
+      event.type.should == Xlib::PropertyNotify
+      puts "type:#{event.type}, serial:#{event.serial}, send_event:#{event.send_event},"+
+        " display:#{event.display}, window:#{event.window}, atom:#{event.atom},"+
+        " time:#{event.time}, state:#{event.state}"
+    end if false
+  end
+
+end if ENV.has_key? 'DISPLAY' # if X Window System running, this spec should be executed

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification 
+name: active_window_x
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Keiichiro Ui
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-16 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: ActiveWindowX is a gem to observe an active window on Linux (X Window System).
+email: 
+- keiichiro.ui@gmail.com
+executables: []
+
+extensions: 
+- ext/active_window_x/extconf.rb
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- active_window_x.gemspec
+- ext/active_window_x/extconf.rb
+- ext/active_window_x/xlib.c
+- lib/active_window_x.rb
+- lib/active_window_x/atom.rb
+- lib/active_window_x/client_message_event.rb
+- lib/active_window_x/display.rb
+- lib/active_window_x/event.rb
+- lib/active_window_x/event_listener.rb
+- lib/active_window_x/property_event.rb
+- lib/active_window_x/root_window.rb
+- lib/active_window_x/version.rb
+- lib/active_window_x/window.rb
+- lib/active_window_x/xid.rb
+- sample/active_window_dump.rb
+- sample/simple.rb
+- spec/atom_spec.rb
+- spec/display_spec.rb
+- spec/root_window_spec.rb
+- spec/window_spec.rb
+- spec/xlib_spec.rb
+homepage: https://github.com/kui/active_window_x
+licenses: []
+
+post_install_message: 
+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.7.2
+signing_key: 
+specification_version: 3
+summary: observer an active window on Linux (X Window System).
+test_files: 
+- spec/atom_spec.rb
+- spec/display_spec.rb
+- spec/root_window_spec.rb
+- spec/window_spec.rb
+- spec/xlib_spec.rb