vigilem-evdev 0.1.3

data/spec/vigilem/evdev/input_system_handler_spec.rb

@@ -0,0 +1,146 @@
+require 'spec_helper'
+
+require 'vigilem/evdev/input_system_handler'
+
+require 'timeout'
+
+# @todo allow(inst).to receive(:filtered?) { true }
+describe Vigilem::Evdev::InputSystemHandler, :clean_up_test_cache do
+  
+  after(:each) do
+    [(v = ::Vigilem)::Evdev::TransferAgent, v::Evdev::Demultiplexer, 
+                              described_class, v::Evdev::Multiplexer].each do |klass|
+      (klass.instance_variables).each {|ivar| klass.send(:remove_instance_variable, ivar) }
+    end
+  end
+  
+  let(:pipes1) { IO.pipe }
+  
+  let(:pipes2) { IO.pipe }
+  
+  let(:pipes3) { IO.pipe }
+  
+  let(:input_event) { Vigilem::Evdev::System::Input::InputEvent }
+  
+  let(:read_pipes) { [pipes1, pipes2, pipes3].map(&:first) }
+  
+  let(:write_pipes) { [pipes1, pipes2, pipes3].map(&:last) }
+  
+  describe '#initialize' do
+    it 'sets up the transfer_agent' do
+      sys = described_class.new([])
+      expect(sys.instance_variable_get(:@transfer_agent)).not_to be_nil
+    end
+  end
+  
+  context 'post init' do
+    
+    subject do
+      inst = described_class.new(*read_pipes)
+      inst.context_filters.replace([])
+      inst
+    end
+    
+    let(:written_events) { [input_event[[7, 8], 1, 30, 1], input_event[[12, 13], 1, 30, 0]].sort {|a, b| a.time.to_f <=> b.time.to_f} }
+    
+    let(:one) { written_events[0] }
+    
+    let(:one_bytes) { one.bytes }
+    
+    let(:two) { written_events[1] }
+    
+    let(:two_bytes) { two.bytes }
+    
+    describe '#read_many_nonblock' do
+      
+      it 'reads messages without blocking from the source' do
+        expect do 
+          Timeout.timeout(5) do
+            subject.read_many_nonblock
+          end
+        end.not_to raise_error
+      end
+      
+      it 'defaults to one message' do
+        write_pipes[0] << one_bytes
+        write_pipes[2] << two_bytes
+        expect(subject.read_many_nonblock.map(&:bytes).join).to eql(one_bytes)
+      end
+      
+      it %q<will read as many of the `max_number_of_events' as available> do
+        write_pipes[0] << one_bytes
+        write_pipes[2] << two_bytes
+        expect(subject.read_many_nonblock(4).map(&:bytes)).to eql([one_bytes, two_bytes])
+      end
+      
+    end
+    
+    describe '#read_one_nonblock' do
+      it 'attempts to reads one message without blocking from the source' do
+        expect do 
+          Timeout.timeout(7) do
+            subject.read_one_nonblock
+          end
+        end.not_to raise_error
+      end
+      
+      it 'reads one message' do
+        write_pipes[0] << one_bytes
+        write_pipes[2] << two_bytes
+        expect(subject.read_one_nonblock.bytes).to eql(one_bytes)
+      end
+      
+      it %q<will read one of the available messages> do
+        write_pipes[0] << one_bytes
+        write_pipes[2] << two_bytes
+        expect(subject.read_one_nonblock.bytes).to eql(one_bytes)
+      end
+    end
+    
+    describe '#read_many' do
+      
+      it 'reads messages blocking if source is empty' do
+        expect do
+          Timeout.timeout(3) do
+            subject.read_many
+          end
+        end.to raise_error(Timeout::Error)
+      end
+      
+      it 'defaults to one message' do
+        write_pipes[0] << one_bytes
+        write_pipes[2] << two_bytes
+        expect(Timeout.timeout(6) { subject.read_many.first.bytes }).to eql(one_bytes)
+      end
+      
+      it %q<will read the number of messages equal to parameter passed in> do
+        write_pipes[0] << one_bytes
+        write_pipes[2] << two_bytes
+        expect(Timeout.timeout(6) { subject.read_many(2).map(&:bytes) }).to eql([one_bytes, two_bytes])
+      end
+    end
+    
+    describe '#read_one' do
+      it 'reads a single message, blocking if source is empty' do
+        expect do 
+          Timeout.timeout(6) do
+            subject.read_one
+          end
+        end.to raise_error(Timeout::Error)
+      end
+      
+      it 'defaults to one message' do
+        write_pipes[0] << one_bytes
+        write_pipes[2] << two_bytes
+        expect(Timeout.timeout(6) { subject.read_one.bytes }).to eql(one_bytes)
+      end
+      
+      it %q<will read the number of messages equal to parameter passed in> do
+        write_pipes[0] << one_bytes
+        write_pipes[2] << two_bytes
+        expect(Timeout.timeout(6) { subject.read_one.bytes }).to eql(one_bytes)
+      end
+    end
+    
+  end
+end

data/spec/vigilem/evdev/key_map_cache_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+require 'vigilem/evdev/key_map_cache'
+
+describe Vigilem::Evdev::KeyMapCache do
+  
+  context 'unaugmented filename' do
+    
+    describe '::default_filename' do
+      it %q<returns the default filename> do
+        expect(described_class.default_filename).to eql('key_map_cache')
+      end
+    end
+    
+    describe '::default_path' do
+      
+      let(:filepath) { File.join(Bundler.root, 'data', described_class.default_filename) }
+      
+      it %q<returns the default path> do
+        expect(described_class.default_path).to eql(filepath)
+      end
+    end
+  end
+  
+  context 'augmented filename for test', :clean_up_test_cache do
+    
+    let(:test_filename) { 'key_map_cache_test' }
+    
+    let(:test_cache_path) { File.join(Bundler.root, 'data', test_filename) }
+    
+    describe '::exists?' do
+      
+      it %q<returns false when the file doesn't exist> do
+        expect(described_class.exists?).to eql(false)
+      end
+      
+      context 'testfile block' do
+        it %q<returns true when the file does exist> do
+          FileUtils.touch(test_cache_path)
+          expect(described_class.exists?).to eql(true)
+        end
+      end
+      
+    end
+    
+    let(:key_map) { Vigilem::Support::KeyMap.new("keycode1"=>"Escape") }
+    
+    describe '::dump' do
+      
+      it 'marshals the key_map and stores it in the #default_path' do
+        described_class.dump(key_map, test_cache_path)
+        expect(File.binread(test_cache_path)).to eql(Marshal.dump(key_map))
+      end
+    end
+    
+    describe '::restore' do
+      
+      it 'marshals the key_map and stores it in the #default_path' do
+        described_class.dump(key_map, test_cache_path)
+        expect(described_class.restore(test_cache_path)).to eql(key_map)
+      end
+    end
+  end
+  
+end

data/spec/vigilem/evdev/multiplexer_spec.rb

@@ -0,0 +1,55 @@
+require 'vigilem/evdev/multiplexer'
+
+describe Vigilem::Evdev::Multiplexer do
+  
+  let(:input_event) { Vigilem::Evdev::System::Input::InputEvent }
+  
+  let(:out) { [] }
+  
+  let(:pipes1) { IO.pipe }
+  
+  let(:pipes2) { IO.pipe }
+  
+  let(:pipes3) { IO.pipe }
+  
+  subject { described_class.acquire([pipes1, pipes2, pipes3].map(&:first))  }
+  
+  describe '#sweep' do
+    it %q<checks the io's and returns sorted InputEvents> do
+      written_events = [input_event[[7, 8], 9, 10, 11], input_event[[12, 13], 14, 15, 16]]
+      pipes1.last << written_events[0].bytes
+      pipes2.last << written_events[1].bytes
+      expect(subject.sweep(1).map(&:bytes)).to eql(written_events.sort {|a,b| a.time.to_f <=> b.time.to_f }.map(&:bytes))
+    end
+  end
+  
+  describe '::acquire' do
+    
+    let(:singleton_var_name) { :@multiplexer }
+    
+    context 'none exists' do
+      before(:all) { described_class.send(:remove_instance_variable, :@multiplexer) }
+      
+      it 'the class instance variable will be nil' do
+        expect(described_class.instance_variable_get(singleton_var_name)).to be_nil
+      end
+      
+      it 'creates a new one' do
+        expect(described_class.acquire()).to be_a described_class
+      end
+      
+      it 'the class instance variable will be set' do
+        expect(described_class.instance_variable_get(singleton_var_name)).not_to be_nil
+      end
+    end
+    
+    context 'one exists' do
+      
+      it 'grabs the existing one' do
+        described_class.acquire
+        expect(described_class.acquire()).to eql(described_class.instance_variable_get(singleton_var_name))
+      end
+    end
+  end
+  
+end

data/spec/vigilem/evdev/system/input/input_event_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+require 'vigilem/evdev/system/input/input_event'
+
+describe Vigilem::Evdev::System::Input do
+  describe described_class::InputEvent do
+    describe 'structure' do
+      it 'will respond_to #time' do
+        expect(subject).to respond_to(:time)
+      end
+      
+      it 'will respond_to #type' do
+        expect(subject).to respond_to(:type)
+      end
+      
+      it 'will respond_to #code' do
+        expect(subject).to respond_to(:code)
+      end
+      
+      it 'will respond_to #value' do
+        expect(subject).to respond_to(:value)
+      end
+      
+    end
+    
+    describe '#time' do
+      it 'will return with a Timeval' do
+        expect(subject.time).to be_a Vigilem::Evdev::Time::Timeval
+      end
+    end
+    
+  end
+end

data/spec/vigilem/evdev/system/input_spec.rb

@@ -0,0 +1,274 @@
+require 'spec_helper'
+
+require 'vigilem/evdev/system/input'
+
+describe Vigilem::Evdev::System::Input do
+  
+  class EVIOC
+    inline do |builder|
+      builder.include '<stdio.h>'
+      builder.include '<sys/ioctl.h>'
+      builder.include '<linux/input.h>'
+      builder.include '<fcntl.h>'
+      builder.include '<stddef.h>'
+      %w(EVIOCGVERSION EVIOCGID EVIOCGREP EVIOCSREP EVIOCGKEYCODE EVIOCGKEYCODE_V2
+      EVIOCSKEYCODE EVIOCSKEYCODE_V2
+      EVIOCSFF EVIOCRMFF EVIOCGEFFECTS EVIOCGRAB).map do |mac|
+        builder.c "
+          long #{mac.gsub(/EVIOC/, '').downcase}() {
+            return #{mac};
+          }
+        "
+      end
+      %w(EVIOCGNAME EVIOCGPHYS EVIOCGUNIQ EVIOCGPROP EVIOCGKEY EVIOCGLED
+      EVIOCGSND EVIOCGSW).map do |mac| 
+        builder.c "
+          long #{mac.gsub(/EVIOC/, '').downcase}(int len) {
+            return #{mac}(len);
+          }
+        "
+      end
+      if $major >= 3 and $minor >= 4
+        builder.c "
+          long gmtslots(int len) {
+            return EVIOCGMTSLOTS(len);
+          }
+        "
+        builder.c "
+          long sclockid() {
+            return EVIOCSCLOCKID;
+          }
+        "
+        $gmtslots_sclockid = true
+      else
+        warn 'EVIOCGMTSLOTS and EVIOCSCLOCKID untestable'
+        $gmtslots_sclockid = false
+      end
+      
+      if $major >= 3 and $minor >= 12
+        builder.c "
+          long _revoke() {
+            return EVIOCREVOKE;
+          }
+        "
+        $revoke = true
+      else
+        warn 'EVIOCREVOKE untestable'
+        $revoke = false
+      end
+      
+      builder.c "
+        long gbit(int evtype, int len) {
+          return EVIOCGBIT(evtype, len);
+        }
+      "
+      builder.c "
+        long gabs(int abs) {
+          return EVIOCGABS(abs);
+        }
+      "
+      builder.c "
+        long sabs(int abs) {
+          return EVIOCSABS(abs);
+        }
+      "
+      
+      builder.c '
+        long size_of_input_keymap_entry() {
+          return sizeof(struct input_keymap_entry);
+        }
+      '
+      
+      builder.c '
+        long size_of_ff_effect() {
+          return sizeof(struct ff_effect);
+        }
+      '
+      
+    end
+  end
+  
+  let(:evioc) { EVIOC.new }
+  
+  describe 'input_keymap_entry' do
+    it 'sizeof(input_keymap_entry) will eql it\'s linux counterpart' do
+      expect(Vigilem::Support::Sys.sizeof(described_class.input_keymap_entry)).to eql(evioc.size_of_input_keymap_entry)
+    end
+  end
+  
+  describe 'ff_effect' do
+    it 'sizeof(ff_effect) will eql it\'s linux counterpart' do
+      expect(described_class::FFEffect.size).to eql(evioc.size_of_ff_effect)
+    end
+  end
+  
+  describe '::EVIOCGVERSION' do
+    it 'will not be zero' do
+      expect(described_class.EVIOCGVERSION).not_to eql(0)
+    end
+    
+    it 'will equal the macro specified in input.h' do
+      expect(described_class.EVIOCGVERSION).to eql(evioc.gversion)
+    end
+  end
+  
+  describe '::EVIOCGID' do
+    it 'will equal the macro specified in input.h' do
+      expect(described_class.EVIOCGID).to eql(evioc.gid)
+    end
+  end
+  
+  describe '::EVIOCGREP' do
+    it 'will equal the macro specified in input.h' do
+      expect(described_class.EVIOCGREP).to eql(evioc.grep)
+    end
+  end
+  
+  describe '::EVIOCSREP' do
+    it 'will equal the macro specified in input.h' do
+      expect(described_class.EVIOCSREP).to eql(evioc.srep)
+    end
+  end
+  
+  if $gmtslots_sclockid
+    describe '::EVIOCGMTSLOTS' do
+      it 'will equal the macro specified in input.h' do
+        expect(described_class.EVIOCGMTSLOTS(3)).to eql(evioc.gmtslots(3))
+      end
+    end
+  end
+  
+  describe '::EVIOCGKEYCODE' do
+    it 'will equal the macro specified in input.h' do
+      expect(described_class.EVIOCGKEYCODE).to eql(evioc.gkeycode)
+    end
+  end
+  
+  let(:ioc_r) { described_class::_IOC_READ }
+  
+  describe '::EVIOCGKEYCODE_V2' do
+    it 'will equal the macro specified in input.h' do
+      expect(described_class.EVIOCGKEYCODE_V2).to eql(evioc.gkeycode_v2)
+    end
+  end
+  
+  describe '::EVIOCSKEYCODE' do
+    it 'will equal the macro specified in input.h' do
+      expect(described_class.EVIOCSKEYCODE).to eql(evioc.skeycode)
+    end
+  end
+  
+  describe '::EVIOCSKEYCODE_V2' do
+    it 'will equal the macro specified in input.h' do
+      expect(described_class.EVIOCSKEYCODE_V2).to eql(evioc.skeycode_v2)
+    end
+  end
+  
+  describe '::EVIOCGNAME' do
+    it 'will equal the macro specified in input.h' do
+      expect(described_class.EVIOCGNAME(255)).to eql(evioc.gname(255))
+    end
+  end
+  
+  describe '::EVIOCGPHYS' do
+    it 'will equal the macro specified in input.h' do
+      expect(described_class.EVIOCGPHYS(255)).to eql(evioc.gphys(255))
+    end
+  end
+  
+  describe '::EVIOCGUNIQ' do
+    it 'will equal the macro specified in input.h' do
+      expect(described_class.EVIOCGUNIQ(255)).to eql(evioc.guniq(255))
+    end
+  end
+  
+  describe '::EVIOCGPROP' do
+    it 'will equal the macro specified in input.h' do
+      expect(described_class.EVIOCGPROP(255)).to eql(evioc.gprop(255))
+    end
+  end
+  
+  describe '::EVIOCGKEY' do
+    it 'will equal the macro specified in input.h' do
+      expect(described_class.EVIOCGKEY(255)).to eql(evioc.gkey(255))
+    end
+  end
+  
+  describe '::EVIOCGLED' do
+    it 'will equal the macro specified in input.h' do
+      expect(described_class.EVIOCGLED(255)).to eql(evioc.gled(255))
+    end
+  end
+  
+  describe '::EVIOCGSND' do
+    it 'will equal the macro specified in input.h' do
+      expect(described_class.EVIOCGSND(255)).to eql(evioc.gsnd(255))
+    end
+  end
+  
+  describe '::EVIOCGSW' do
+    it 'will equal the macro specified in input.h' do
+      expect(described_class::EVIOCGSW(255)).to eql(evioc.gsw(255))
+    end
+  end
+=begin # @todo
+  describe '::EVIOCGBIT' do
+    it 'will equal the macro specified in input.h' do
+      expect(described_class::EVIOCGBIT(evtype, len)).to eql(evioc.gbit(evtype, len))
+    end
+  end
+  
+  describe '::EVIOCGABS' do
+    it 'will equal the macro specified in input.h' do
+      expect(described_class::EVIOCGABS(abs)).to eql(evioc.gabs(abs))
+    end
+  end
+  
+  describe '::EVIOCSABS' do
+    it 'will equal the macro specified in input.h' do
+      expect(described_class::EVIOCSABS(abs)).to eql(evioc.sabs(abs))
+    end
+  end
+=end
+  describe '::EVIOCSFF' do
+    it 'will equal the macro specified in input.h' do
+      expect(described_class.EVIOCSFF).to eql(evioc.sff)
+    end
+  end
+  
+  describe '::EVIOCRMFF' do
+    it 'will equal the macro specified in input.h' do
+      expect(described_class.EVIOCRMFF()).to eql(evioc.rmff)
+    end
+  end
+  
+  describe '::EVIOCGEFFECTS' do
+    it 'will equal the macro specified in input.h' do
+      expect(described_class.EVIOCGEFFECTS()).to eql(evioc.geffects)
+    end
+  end
+  
+  describe '::EVIOCGRAB' do
+    it 'will equal the macro specified in input.h' do
+      expect(described_class.EVIOCGRAB()).to eql(evioc.grab)
+    end
+  end
+  
+  # @todo switch to optinos flag >=3.4
+  if $revoke
+    describe '::EVIOCREVOKE', '>=v4.3' do
+      it 'will equal the macro specified in input.h' do
+        expect(described_class.EVIOCREVOKE()).to eql(evioc._revoke)
+      end
+    end
+  end
+  
+  if $gmtslots_sclockid
+    describe '::EVIOCSCLOCKID' do
+      it 'will equal the macro specified in input.h' do
+        expect(described_class.EVIOCSCLOCKID()).to eql(evioc.sclockid)
+      end
+    end
+  end
+  
+end