rubyserial-with-blocking 0.2.3

data/rubyserial.gemspec

@@ -0,0 +1,21 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "rubyserial/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rubyserial-with-blocking"
+  s.version     = RubySerial::VERSION
+  s.summary     = "FFI Ruby library for RS-232 serial port communication"
+  s.description = "FFI Ruby library for RS-232 serial port communication"
+  s.homepage    = "https://github.com/hybridgroup/rubyserial"
+  s.authors     = ["Adrian Zankich", "Theron Boerner", "Javier Cervantes", "Dirk Lüsebrink"]
+  s.platform    = Gem::Platform::RUBY
+  s.license     = 'Apache 2.0'
+
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency 'ffi', '~> 1.9.3'
+
+  s.add_development_dependency 'guard-rspec'
+end

data/spec/lib/posix_spec.rb

@@ -0,0 +1,150 @@
+describe Serial do
+
+  before :each do
+    @master, @slave = PTY.open
+  end
+
+  after :each do
+    #@slave.read_nonblock(255) rescue nil
+    @master.close rescue nil
+    @slave.close rescue nil
+  end
+
+  describe 'new config option settings' do
+    it 'has a queryable config attribute' do
+      expect(Serial.new(@slave.path).config).to be_kind_of(Hash)
+    end
+    it 'has a default baud rate' do
+      expect(Serial.new(@slave.path).config[:baude_rate]).to eq(9600)
+    end
+    it 'overwrites default baude rate' do
+      expect(Serial.new(@slave.path, 57600).config[:baude_rate]).to eq(57600)
+    end
+    it 'overwrites default baude rate with config' do
+      expect(
+        Serial.new(@slave.path, nil, nil, baude_rate: 57600
+      ).config[:baude_rate]).to eq(57600)
+    end
+
+    it 'has default data bits' do
+      expect(Serial.new(@slave.path).config[:data_bits]).to eq(8)
+    end
+    it 'overwrites default data bits' do
+      expect(Serial.new(@slave.path, nil, 7).config[:data_bits]).to eq(7)
+    end
+    it 'overwrites default data bits with config' do
+      expect(
+        Serial.new(@slave.path, nil, nil, data_bits: 7
+      ).config[:data_bits]).to eq(7)
+    end
+
+    it 'defaults to VMIN = 0' do
+      expect(Serial.new(@slave.path).config[:vmin]).to eq(0)
+    end
+    it 'allows overwriting VMIN' do
+      expect(
+        Serial.new(@slave.path, nil, nil, vmin: 1
+      ).config[:vmin]).to eq(1)
+    end
+  end
+
+  describe 'blocking read with VMIN=1' do
+    let(:sp) { Serial.new(@slave.path, nil, nil, vmin: 1) }
+    it 'blocks on read' do 
+      s = ''
+      c = :start
+      t = Thread.new { 
+        s = sp.read(255)
+        expect(s).to eq('hello')
+        c = :end
+      }
+      expect(c).to eq(:start)
+      expect(s).to eq('')
+      @master.write('hello')
+      t.join
+      expect(c).to eq(:end)
+    end
+  
+    it 'does not block with default VMIN=0' do
+      c = :start
+      Thread.new { 
+        s = sp.read(255)
+        expect(s).to eq('')
+        c = :end
+      }.join
+      expect(c).to eq(:end)
+    end
+  end
+
+  describe 'synchronous operation (ported from rubyserial_spec.rb)' do
+
+    let(:sp) { Serial.new @slave.path }
+
+    it "writes" do
+      sp.write('hello')
+      expect(@master.read_nonblock(0xff)).to eql('hello')
+    end
+    it "reads" do
+      @master.write('hello')
+      expect(sp.read(0xff)).to eql('hello')
+    end
+
+    it "converts ints to strings" do
+      expect(sp.write(123)).to eql(3)
+      expect(@master.read_nonblock(3)).to eql('123')
+    end
+
+    it "returns the numbers of bytes written" do
+      expect(sp.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 a zero byte from getbyte' do
+      @master.write("\x00")
+      expect(sp.getbyte).to eql(0)
+    end
+
+    it "should give me bytes" do
+      @master.write('hello')
+      expect([sp.getbyte].pack('C')).to eql('h')
+    end
+
+    describe "giving me lines" do
+      it "should give me a line" do
+        @master.write("no yes \n hello")
+        expect(sp.gets).to eql("no yes \n")
+      end
+
+      it "should accept a sep param" do
+        @master.write('no yes END bleh')
+        expect(sp.gets('END')).to eql("no yes END")
+      end
+
+      it "should accept a limit param" do
+        @master.write("no yes \n hello")
+        expect(sp.gets(4)).to eql("no y")
+      end
+
+      it "should accept limit and sep params" do
+        @master.write("no yes END hello")
+        expect(sp.gets('END', 20)).to eql("no yes END")
+        sp.read(1000) # to clear the device?
+        @master.write("no yes END hello")
+        expect(sp.gets('END', 4)).to eql('no y')
+      end
+
+      it "should read a paragraph at a time" do
+        @master.write("Something \n Something else \n\n and other stuff")
+        expect(sp.gets('')).to eql("Something \n Something else \n\n")
+      end
+    end
+
+  end # ~synchronous operation 
+end

data/spec/rubyserial_spec.rb

@@ -0,0 +1,138 @@
+require 'spec_helper'
+
+__END__
+describe "rubyserial" do
+  before do
+    @ports = []
+    require 'rbconfig'
+    if RbConfig::CONFIG['host_os'] =~ /mswin|windows|mingw/i
+      # NOTE: Tests on windows require com0com 
+      # https://github.com/hybridgroup/rubyserial/raw/appveyor_deps/setup_com0com_W7_x64_signed.exe
+      @ports[0] = "\\\\.\\CNCA0"
+      @ports[1] = "\\\\.\\CNCB0"
+    else
+      File.delete('socat.log') if File.file?('socat.log')
+
+      raise 'socat not found' unless (`socat -h` && $? == 0)
+
+      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
+=begin
+  describe 'blocking read support' do
+    let(:s_in)  { @sp }
+    let(:s_out) { @sp2 }
+    it 'hands out the file descriptor object' do
+      expect(s_in.fd).to be_kind_of(Interger)
+    end
+
+    it "should read and write" do
+      s_out.write('hello')
+      check = s_in.read(5)
+      expect(check).to eql('hello')
+    end
+  end
+=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 a zero byte from getbyte' do
+    @sp2.write("\x00")
+    sleep 0.1
+    expect(@sp.getbyte).to eql(0)
+  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

data/spec/spec_helper.rb

@@ -0,0 +1,86 @@
+# -*- encoding : utf-8 -*-
+$:.unshift(File.dirname(__FILE__))
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubyserial'
+require 'pty'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, make a
+# separate helper file that requires this one and then use it only in the specs
+# that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+=end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: rubyserial-with-blocking
+version: !ruby/object:Gem::Version
+  version: 0.2.3
+platform: ruby
+authors:
+- Adrian Zankich
+- Theron Boerner
+- Javier Cervantes
+- Dirk Lüsebrink
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.3
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: FFI Ruby library for RS-232 serial port communication
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- appveyor.yml
+- lib/rubyserial.rb
+- lib/rubyserial/linux_constants.rb
+- lib/rubyserial/osx_constants.rb
+- lib/rubyserial/posix.rb
+- lib/rubyserial/version.rb
+- lib/rubyserial/windows.rb
+- lib/rubyserial/windows_constants.rb
+- rubyserial.gemspec
+- spec/lib/posix_spec.rb
+- spec/rubyserial_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/hybridgroup/rubyserial
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: FFI Ruby library for RS-232 serial port communication
+test_files: []
+has_rdoc: