rubyserial 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 248fe3f8e44d655481dcc7f26c7367507e4741d5
-  data.tar.gz: df82381fdd9677680094bf844efcae566c327ffe
+  metadata.gz: d95d4b0f3e735071995dbac944d07a17061880ee
+  data.tar.gz: 833f60ee4c09de550c3695e25b6e12c33f9cbf43
 SHA512:
-  metadata.gz: c78bec3db3c730e71b269d7e1123ad54e895049e9d4cfdee3e2db9b6028dc73f6f0dadfae6f072d6aff0b006c7b8d00eac9d9345a4e7d6912a7270d7f2f3ca2a
-  data.tar.gz: 811f6208954f7e4f2c0ddd46f53af5388d5288b1f2a5a4bf0fa71085fac127de0f80439c5e43975c22055bdef4154eb19bd41895bbf89562df08c024a2f32fba
+  metadata.gz: 7a21a0889ec09eefa24810723930ce669e5a5028b3f88c559fd2ef3a8f24b25701cb73e7a7f13c7bf47e969ada36d1aaec861f7ce93f498e58ce23e4c912a9d2
+  data.tar.gz: 622b237d44d95a52528e0f68ac52d06257d8821ae99176419c538e9c869f3d4967d2e6bf7d798afd48f71065f8cad7dd20f8c6d8df23ed25beb6718551b1d296

data/.travis.yml

@@ -7,8 +7,12 @@ rvm:
   - jruby
   - jruby-head
   - rbx-2.2.10
+matrix:
+  allow_failures:
+    - rvm: jruby-head
+    - rvm: ruby-head
 install:
   - sudo apt-get update && sudo apt-get install --force-yes socat
 script:
   - bundle install
-  - bundle exec rspec
+  - bundle exec rspec -fd

data/README.md

@@ -1,6 +1,10 @@
 # rubyserial
 
-RubySerial is a simple RubyGem for reading from and writing to serial ports.
+RubySerial is a simple Ruby gem for reading from and writing to serial ports. 
+
+Unlike other Ruby serial port implementations, it supports all of the most popular Ruby implementations (MRI, JRuby, & Rubinius) on the most popular operating systems (OSX, Linux, & Windows). And it does not require any native compilation thanks to using RubyFFI [https://github.com/ffi/ffi](https://github.com/ffi/ffi).
+
+The interface to RubySerial should be (mostly) compatible with other Ruby serialport gems, so you should be able to drop in the new gem, change the `require` and use it as a replacement. If not, please let us know so we can address any issues.
 
 [![Build Status](https://travis-ci.org/hybridgroup/rubyserial.svg)](https://travis-ci.org/hybridgroup/rubyserial)
 

data/lib/rubyserial/posix.rb

@@ -43,16 +43,20 @@ class Serial
   end
 
   def write(data)
+    data = data.to_s
     n =  0
     while data.size > n do
       buff = FFI::MemoryPointer.from_string(data[n..-1].to_s)
-      i = RubySerial::Posix.write(@fd, buff, buff.size)
+      i = RubySerial::Posix.write(@fd, buff, buff.size-1)
       if i == -1
         raise RubySerial::Exception, RubySerial::Posix::ERROR_CODES[FFI.errno]
       else
         n = n+i
       end
     end
+
+    # return number of bytes written
+    n
   end
 
   def read(size)
@@ -78,6 +82,20 @@ class Serial
     end
   end
 
+  def gets(sep=$/, limit=nil)
+    sep = "\n\n" if sep == ''
+    # This allows the method signature to be (sep) or (limit)
+    (limit = sep; sep="\n") if sep.is_a? Integer
+    bytes = []
+    loop do
+      current_byte = getbyte
+      bytes << current_byte unless current_byte.nil?
+      break if (bytes.last(sep.bytes.to_a.size) == sep.bytes.to_a) || ((bytes.size == limit) if limit)
+    end
+
+    bytes.map { |e| e.chr }.join
+  end
+
   private
 
   def build_config(baude_rate, data_bits)
@@ -95,4 +113,4 @@ class Serial
 
     config
   end
-end
+end

data/lib/rubyserial/version.rb

@@ -1,5 +1,5 @@
 module RubySerial
   unless const_defined?('VERSION')
-    VERSION = "0.1.2"
+    VERSION = "0.2.0"
   end
 end

data/lib/rubyserial/windows.rb

@@ -68,10 +68,25 @@ class Serial
   def write(data)
     buff = FFI::MemoryPointer.from_string(data.to_s)
     count = FFI::MemoryPointer.new :uint32, 1
-    err = RubySerial::Win32.WriteFile(@fd, buff, buff.size, count, nil)
+    err = RubySerial::Win32.WriteFile(@fd, buff, buff.size-1, count, nil)
     if err == 0
       raise RubySerial::Exception, RubySerial::Win32::ERROR_CODES[FFI.errno]
     end
+    count.read_string.unpack('H4').join().to_i(16)
+  end
+
+  def gets(sep=$/, limit=nil)
+    sep = "\n\n" if sep == ''
+    # This allows the method signature to be (sep) or (limit)
+    (limit = sep; sep="\n") if sep.is_a? Integer
+    bytes = []
+    loop do
+      current_byte = getbyte
+      bytes << current_byte unless current_byte.nil?
+      break if (bytes.last(sep.bytes.to_a.size) == sep.bytes) || ((bytes.size == limit) if limit)
+    end
+
+    bytes.map { |e| e.chr }.join
   end
 
   def close

data/spec/rubyserial_spec.rb

@@ -0,0 +1,131 @@
+require 'rubyserial'
+
+describe "rubyserial" do
+  before do
+    @ports = []
+    require 'rbconfig'
+    if RbConfig::CONFIG['host_os'] =~ /mswin|windows|mingw/i
+      @command_output = `powershell "Get-WmiObject Win32_SerialPort | Select-Object DeviceID, Description"`
+      @prefix = "\\\\.\\"
+      @coms = @command_output.scan(/COM\d*/).uniq
+      @file_array = @command_output.split("\n")
+      @file_array.each do |line|
+        if line.include?('com0com')
+          @coms.each do |e|
+            if line =~ /#{e}/
+              @ports << "#{@prefix}#{e}"
+            end
+          end
+        end
+      end
+
+      if @ports[0].nil?
+        puts "Heya mister (or miss(es)). For this to work you need com0com "\
+        "installed. It doesn't look like you have it so rerun this after you"\
+        "install it from here: https://code.google.com/p/powersdr-iq/download"\
+        "s/detail?name=setup_com0com_W7_x64_signed.exe&can=2&q="
+      end
+    else
+      File.delete('socat.log') if File.file?('socat.log')
+
+      Thread.new do
+        system('socat -lf socat.log -d -d pty,raw,echo=0 pty,raw,echo=0')
+      end
+
+      @ptys = nil
+
+      loop do
+        if File.file? 'socat.log'
+          @file = File.open('socat.log', "r")
+          @fileread = @file.read
+
+          unless @fileread.count("\n") < 3
+            @ptys = @fileread.scan(/PTY is (.*)/)
+            break
+          end
+        end
+      end
+
+      @ports = [@ptys[1][0], @ptys[0][0]]
+    end
+
+    @sp2 = Serial.new(@ports[0])
+    @sp = Serial.new(@ports[1])
+  end
+
+  after do
+   @sp2.close
+   @sp.close
+  end
+
+  it "should read and write" do
+    @sp2.write('hello')
+    # small delay so it can write to the other port.
+    sleep 0.1
+    check = @sp.read(5)
+    expect(check).to eql('hello')
+  end
+
+  it "should convert ints to strings" do
+    expect(@sp2.write(123)).to eql(3)
+    sleep 0.1
+    expect(@sp.read(3)).to eql('123')
+  end
+
+  it "write should return bytes written" do
+    expect(@sp2.write('hello')).to eql(5)
+  end
+
+  it "reading nothing should be blank" do
+    expect(@sp.read(5)).to eql('')
+  end
+
+  it "should give me nil on getbyte" do
+    expect(@sp.getbyte).to be_nil
+  end
+
+  it "should give me bytes" do
+    @sp2.write('hello')
+    # small delay so it can write to the other port.
+    sleep 0.1
+    check = @sp.getbyte
+    expect([check].pack('C')).to eql('h')
+  end
+
+
+  describe "giving me lines" do
+    it "should give me a line" do
+      @sp.write("no yes \n hello")
+      sleep 0.1
+      expect(@sp2.gets).to eql("no yes \n")
+    end
+
+    it "should accept a sep param" do
+      @sp.write('no yes END bleh')
+      sleep 0.1
+      expect(@sp2.gets('END')).to eql("no yes END")
+    end
+
+    it "should accept a limit param" do
+      @sp.write("no yes \n hello")
+      sleep 0.1
+      expect(@sp2.gets(4)).to eql("no y")
+    end
+
+    it "should accept limit and sep params" do
+      @sp.write("no yes END hello")
+      sleep 0.1
+      expect(@sp2.gets('END', 20)).to eql("no yes END")
+      @sp2.read(1000)
+      @sp.write("no yes END hello")
+      sleep 0.1
+      expect(@sp2.gets('END', 4)).to eql('no y')
+    end
+
+    it "should read a paragraph at a time" do
+      @sp.write("Something \n Something else \n\n and other stuff")
+      sleep 0.1
+      expect(@sp2.gets('')).to eql("Something \n Something else \n\n")
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubyserial
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Adrian Zankich
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-07 00:00:00.000000000 Z
+date: 2014-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -47,7 +47,7 @@ files:
 - lib/rubyserial/windows.rb
 - lib/rubyserial/windows_constants.rb
 - rubyserial.gemspec
-- spec/basic_rw_spec.rb
+- spec/rubyserial_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/hybridgroup/rubyserial
 licenses:

data/spec/basic_rw_spec.rb

@@ -1,35 +0,0 @@
-describe "basic reading and writing" do
-  before do
-    File.delete('socat.log') if File.file?('socat.log')
-
-    Thread.new do
-      system('socat -lf socat.log -d -d pty,raw,echo=0 pty,raw,echo=0')
-    end
-
-    @ptys = nil
-
-    loop do
-      if File.file? 'socat.log'
-        @file = File.open('socat.log', "r")
-        @fileread = @file.read
-        unless @fileread.count("\n") < 3
-          @ptys = @fileread.scan(/PTY is (.*)/)
-          break
-        end
-      end
-    end
-
-    require 'rubyserial'
-    @sp2 = Serial.new(@ptys[1][0])
-    @sp = Serial.new(@ptys[0][0])
-    @sp2.write('hello')
-
-		# small delay so it can write to the other port.
-    sleep 0.1
-  end
-
-  it "should read and write" do
-    check = @sp.read(5)
-    expect(check).to eql('hello')
-  end
-end