packet_io 0.4.0.rc2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/History.txt

@@ -0,0 +1,6 @@
+== 0.4.0 / 2011-05-31
+  * much simpler reimplementation without threads
+
+== 0.3.0 / 2008-10-12
+  * initial release
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Levin Alexander
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,42 @@
+serial_interface
+    by Levin Alexander
+    http://levinalex.net/
+
+== DESCRIPTION:
+
+serial_interface intends to be a small library that makes it easy
+to define packet based protocols over a serial link (RS232) in a
+declarative fashion.
+
+== SYNOPSIS:
+
+  nothing written yet
+
+== INSTALL:
+
+* not yet written
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2006-2008 Levin Alexander
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,19 @@
+$LOAD_PATH.unshift './lib'
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'packet_io'
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'yard'
+YARD::Rake::YardocTask.new
+
+task :doc => :yard
+task :default => [:test]

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/lib/packet_io/io_listener.rb

@@ -0,0 +1,113 @@
+module PacketIO
+
+  # a chainable IO-Listener that provides two methods:
+  #
+  # {#on_data} ::
+  #   a callback that is called whenever a message is received
+  # {#write} ::
+  #   can be called so send messages to the underlying IO
+  #
+  # when overriding this class, you need to implement two methods:
+  #
+  # {#receive} ::
+  #   is called from an underlying IO whenever a message is received
+  #   the message can be handled.  Call {#forward} to propagate
+  #
+  # {#write} ::
+  #   transform/encode a message before sending it. Call +super+ to propagate
+  #
+  # See {LineBasedProtocol} for a toy implementation which strips
+  # newlines and only forwards complete lines.
+  #
+  class Base
+
+    # @param [Base, #on_data] read data source
+    # @param [Base, IO, #write] write object where messages are written to
+    #
+    def initialize(read, write = read)
+      @reader, @writer = read, write
+      @on_data = nil
+      @reader.on_data { |*data| receive(*data) } if @reader.respond_to?(:on_data)
+    end
+
+    # register a block, to be run whenever the protocol implementation
+    # receives data (by calling {#forward})
+    #
+    # this is used to chain protocol layers together
+    #
+    # @return [self]
+    # @yield [*args] called whenever the protocol implementaion calls {#forward}
+    # @yieldreturn [nil]
+    #
+    def on_data(&block)
+      @on_data = block
+      self
+    end
+
+    # @see #write
+    #
+    def <<(*args)
+      write(*args)
+    end
+
+    # write data to underlying interface. override if data needs to be preprocessed
+    #
+    def write(*args)
+      @writer.<<(*args) if @writer
+    end
+
+
+    protected
+
+    # override this method to handle data received from an underlying interface, for
+    # example splitting it into messages or only passing on complete lines
+    # (see {LineBasedProtocol#receive} for an example)
+    #
+    # call {#forward} to pass it on to higher levels
+    #
+    # @return [nil]
+    #
+    def receive(data)
+      forward(data)
+    end
+
+    def forward(*data)
+      @on_data.call(*data) if @on_data
+    end
+  end
+
+
+  class LineBasedProtocol < Base
+
+    # strip newlines from received data and pass on complete lines
+    #
+    # @param [String] data
+    #
+    def receive(data)
+      @memo ||= ""
+      scanner = StringScanner.new(@memo + data)
+      while s = scanner.scan(/.*?\n/)
+        forward(s.strip)
+      end
+      @memo = scanner.rest
+      nil
+    end
+
+    # add a newline to data and pass it on
+    # @param [String] data
+    #
+    def write(data)
+      super(data + "\n")
+    end
+  end
+
+  class IOListener < Base
+    def run!
+      while not @reader.eof?
+        str = @reader.readpartial(4096)
+        forward(str)
+      end
+    end
+  end
+end
+

data/lib/packet_io/test/mock_server.rb

@@ -0,0 +1,49 @@
+module PacketIO::Test
+  class MockServer
+    def initialize(read, write)
+      @read, @write = read, write
+      @queue = Queue.new
+      @thread = Thread.new do
+        parse_commands
+      end
+    end
+
+    def write(string)
+      @queue.push [:write, string]
+      self
+    end
+
+    def read_all
+      @read.readpartial(4096)
+    end
+
+    def wait(seconds = 0.02)
+      @queue.push [:wait, seconds]
+      self
+    end
+
+    def eof
+      @queue.push [:close]
+    end
+
+
+    private
+
+    def parse_commands
+      loop do
+        action, data = @queue.pop
+
+        case action
+        when :close
+          @write.close
+          break
+        when :write
+          @write.write(data)
+          @write.flush
+        when :wait
+          sleep data
+        end
+      end
+    end
+  end
+end

data/lib/packet_io.rb

@@ -0,0 +1,8 @@
+
+module PacketIO
+  VERSION = '0.4.0.rc2'
+end
+
+require 'strscan'
+require 'packet_io/io_listener'
+

data/packet_io.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'packet_io'
+
+Gem::Specification.new do |s|
+  s.name = %q{packet_io}
+  s.version = PacketIO::VERSION
+
+  s.authors = ["Levin Alexander"]
+  s.description = %q{}
+  s.email = %q{mail@levinalex.net}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+
+  s.homepage = %q{http://github.com/levinalex/packet_io}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.summary = %q{define packet based protocols in a declarative fashion}
+
+  s.add_development_dependency("shoulda", ["~> 2.11.3"])
+  s.add_development_dependency("mocha", ["~> 0.9.12"])
+  s.add_development_dependency("yard", ["~> 0.7.1"])
+  s.add_development_dependency("cucumber", ["~> 0.10.3"])
+end
+

data/test/helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'packet_io'
+require 'packet_io/test/mock_server'
+
+class Test::Unit::TestCase
+end
+

data/test/test_io_listener.rb

@@ -0,0 +1,34 @@
+require 'helper'
+
+class TestIOListener < Test::Unit::TestCase
+  context "a server" do
+    setup do
+      r1, w1 = IO.pipe # Server -> Client
+      r2, w2 = IO.pipe # Client -> Server
+
+      @server = PacketIO::IOListener.new(r1, w2)
+      @protocol = PacketIO::LineBasedProtocol.new(@server)
+      @device = PacketIO::Test::MockServer.new(r2, w1)
+    end
+
+    should "exist" do
+      assert_not_nil @server
+    end
+
+    should "yield packets written to it" do
+      @packets = []
+      @protocol.on_data { |packet| @packets << packet }
+
+      @device.write("fo").wait.write("o\n").wait.write("bar\n").eof
+      @server.run!
+
+      assert_equal ["foo", "bar"], @packets
+    end
+
+    should "send data" do
+      @protocol << "hello world"
+      data = @device.read_all
+      assert_equal "hello world\n", data
+    end
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification 
+name: packet_io
+version: !ruby/object:Gem::Version 
+  prerelease: true
+  segments: 
+  - 0
+  - 4
+  - 0
+  - rc2
+  version: 0.4.0.rc2
+platform: ruby
+authors: 
+- Levin Alexander
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-31 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 11
+        - 3
+        version: 2.11.3
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 12
+        version: 0.9.12
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 7
+        - 1
+        version: 0.7.1
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 10
+        - 3
+        version: 0.10.3
+  type: :development
+  version_requirements: *id004
+description: ""
+email: mail@levinalex.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .document
+- .gitignore
+- History.txt
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/packet_io.rb
+- lib/packet_io/io_listener.rb
+- lib/packet_io/test/mock_server.rb
+- packet_io.gemspec
+- test/helper.rb
+- test/test_io_listener.rb
+has_rdoc: true
+homepage: http://github.com/levinalex/packet_io
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: define packet based protocols in a declarative fashion
+test_files: 
+- test/helper.rb
+- test/test_io_listener.rb