ionian 0.1.0

data/lib/ionian/io.rb

@@ -0,0 +1,110 @@
+module Ionian
+  # A mixin for IO objects that allows regular expression matching
+  # and convenient notification of data in the buffer.
+  #
+  # This module was designed to be EXTENDED by instantiated objects
+  # that implement the standard library IO class.
+  # my_socket.extend Ionian::IO
+  module IO
+    # Number of seconds to attempt an IO operation before timing out.
+    # See standard library IO::select.
+    attr_accessor :ionian_timeout
+   
+    # Called automaticallly when the object is extended with #extend.
+    def self.extended(obj)
+      obj.initialize_ionian
+    end
+   
+    # Initialize the Ionian instance variables.
+    # This is called automatically if #extend is called on an object.
+    def initialize_ionian
+      @ionian_listeners  = []
+      @ionian_buf        = ''
+      @ionian_expression = /(.*?)\n/
+      @ionian_timeout    = 1
+    end
+   
+    # Set the expression to match against the read buffer.
+    # Can be a regular expression specifying capture groups,
+    # or a string specifying the separator or line terminator
+    # sequence. It is possible to use named captures in a
+    # regex, which allows for convienient accessors like
+    # match[:parameter].
+    def match(expression)
+      @ionian_expression = expression
+      @ionian_expression = Regexp.new "(.*?)#{expression}" if expression.is_a? String
+    end
+   
+    # Read matched data from the buffer.
+    # This method SHOULD NOT be used if #run_match is used.
+    #
+    # Passes matches to the block (do |match|). If there are multiple
+    # matches, the block is called multiple times.
+    #
+    # Returns an array of matches.
+    # Returns nil if no data was received within the timeout period.
+    #
+    # Junk data that could exist before a match in the buffer can
+    # be accessed with match.pre_match.
+    #
+    # Data at the end of the buffer that is not matched can be accessed
+    # in the last match with match.post_match. This data remains in the
+    # buffer for the next read_match cycle. This is helpful for protocols
+    # like RS232 that do not have packet boundries.
+    #
+    # kvargs:
+    #   Timeout: Timeout in seconds IO::select will block.
+    def read_match(**kvargs, &block)
+      timeout = kvargs.fetch :timeout, @ionian_timeout
+      
+      return nil unless IO.select [self], nil, nil, timeout
+      @ionian_buf << read_partial 0xFFFF
+      
+      @matches = []
+      
+      while @ionian_buf =~ @ionian_expression
+        @matches << $~ # Match data.
+        yield $~
+      end
+      
+      @ionian_buf = $' # Leave post match data in the buffer.
+      @matches
+   end
+   
+    # Start a thread that checks for data and notifies listeners.
+    # Passes kvargs to #read_match.
+    # This method SHOULD NOT be used if #read_match is used.
+    def run_match(**kvargs)
+      @match_listener ||= Thread.new do
+        while not closed? do
+            matches = read_match kvargs
+            @ionian_listeners.each {|listener| yield matches} if matches
+        end
+        
+        @match_listener = nil
+      end
+    end
+   
+   # Erase the data in Ionian's buffer.
+    def purge
+      @ionian_buf = ''
+    end
+   
+    # Register a block to be called when #run_match receives matched data.
+    # Method callbacks can be registered with &object.method(:method).
+    # Returns a reference to the given block.
+    # block = ionian_socket.register_observer {...}
+    def register_observer(&block)
+      @ionian_listeners << block unless @ionian_listeners.include? block
+      block
+    end
+   
+    # Unregister a block from being called when matched data is received.
+    def unregister_observer(&block)
+      @ionian_listeners.delete_if {|o| o == block}
+      block
+    end
+   
+  end
+end
+ 

data/lib/ionian.rb

@@ -0,0 +1 @@
+require 'ionian/io'

data/license.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Alex McLain
+
+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.

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: ionian
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex McLain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: A mixin for IO objects that allows regular expression matching and convenient
+  notification of data in the buffer.
+email: alex@alexmclain.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- doc/Ionian.html
+- doc/Ionian/IO.html
+- doc/created.rid
+- doc/fonts.css
+- doc/fonts/Lato-Light.ttf
+- doc/fonts/Lato-LightItalic.ttf
+- doc/fonts/Lato-Regular.ttf
+- doc/fonts/Lato-RegularItalic.ttf
+- doc/fonts/SourceCodePro-Bold.ttf
+- doc/fonts/SourceCodePro-Regular.ttf
+- doc/images/add.png
+- doc/images/arrow_up.png
+- doc/images/brick.png
+- doc/images/brick_link.png
+- doc/images/bug.png
+- doc/images/bullet_black.png
+- doc/images/bullet_toggle_minus.png
+- doc/images/bullet_toggle_plus.png
+- doc/images/date.png
+- doc/images/delete.png
+- doc/images/find.png
+- doc/images/loadingAnimation.gif
+- doc/images/macFFBgHack.png
+- doc/images/package.png
+- doc/images/page_green.png
+- doc/images/page_white_text.png
+- doc/images/page_white_width.png
+- doc/images/plugin.png
+- doc/images/ruby.png
+- doc/images/tag_blue.png
+- doc/images/tag_green.png
+- doc/images/transparent.png
+- doc/images/wrench.png
+- doc/images/wrench_orange.png
+- doc/images/zoom.png
+- doc/index.html
+- doc/js/darkfish.js
+- doc/js/jquery.js
+- doc/js/navigation.js
+- doc/js/search.js
+- doc/js/search_index.js
+- doc/js/searcher.js
+- doc/rdoc.css
+- doc/table_of_contents.html
+- lib/ionian.rb
+- lib/ionian/io.rb
+- license.txt
+homepage: https://bitbucket.org/amclain/ionian
+licenses:
+- MIT
+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.2.0.preview.1
+signing_key: 
+specification_version: 4
+summary: Regular expression matching and notification for IO.
+test_files: []