backport 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 631a99833ea290a7aa20e2e18f188eb19b81a141e32288feeb96ac514c39a86c
+  data.tar.gz: 5dcd3ea31192dbb810d18f7e5ca6c3757f3613a8e0a625f0d14e7801714a0e62
+SHA512:
+  metadata.gz: 1ab759e6cd1fb063dbc9f56648d0f98771b3b2390593937c73c6d6b8e655110644b94028f2739dab3bb2f7b5ca704d2bba0838d604866b9939f607eccd85fae5
+  data.tar.gz: 8e6531f1ad46e37f01086991bca2c6ac1ddd262c381fb514a3a4b0674b5d7001412c1b469ae56a03d50a2edf69040bd761940413b3b2d741d4fb7ec3d1b3bfec

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in backport.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Fred Snyder for Castwide Technologies LLC
+
+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.md

@@ -0,0 +1,48 @@
+# Backport
+
+A pure Ruby library for event-driven IO.
+
+This library is designed with portability as the highest priority, which is why it's written in pure Ruby. Consider [EventMachine](https://github.com/eventmachine/eventmachine) if you need a solution that's faster, more mature, and scalable.
+
+## Installation
+
+Install the gem:
+
+```
+gem install backport
+```
+
+Or add it to your application's Gemfile:
+
+```ruby
+gem 'backport'
+```
+
+## Usage
+
+This example demonstrates a simple echo server.
+
+```ruby
+require 'backport'
+
+module MyAdapter
+  def opening
+    write "Opening the connection"
+  end
+
+  def closing
+    write "Closing the connection"
+  end
+
+  def sending data
+    write "Client sent: #{data}"
+  end
+end
+
+Backport.run do
+  Backport.start_tcp_server(adapter: MyAdapter)
+  Backport.start_interval 1 do
+    puts "tick"
+  end
+end
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/backport.gemspec

@@ -0,0 +1,26 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "backport/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "backport"
+  spec.version       = Backport::VERSION
+  spec.authors       = ["Fred Snyder"]
+  spec.email         = ["fsnyder@castwide.com"]
+
+  spec.summary       = %q{A pure Ruby library for event-driven IO}
+  spec.homepage      = "http://github.com/castwide/backport"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "backport"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/backport/adapter.rb

@@ -0,0 +1,27 @@
+module Backport
+  class Adapter
+    def initialize output
+      @out = output
+    end
+
+    def opening
+      STDERR.puts "Opening"
+    end
+
+    def closing
+      STDERR.puts "Closing"
+    end
+
+    def sending data
+      STDERR.puts "Client sent #{data}"
+    end
+
+    def write data
+      @out.print data
+    end
+
+    def write_line data
+      @out.puts data
+    end
+  end
+end

data/lib/backport/client.rb

@@ -0,0 +1,73 @@
+module Backport
+  class Client
+    def initialize input, output, adapter
+      @in = input
+      @out = output
+      # @todo Adapter can either be an Adapter class or a module
+      @adapter = make_adapter(adapter)
+      @stopped = true
+      @buffer = ''
+    end
+
+    def stopped?
+      @stopped ||= false
+    end
+
+    def stop
+      return if stopped?
+      @adapter.closing
+      @stopped = true
+    end
+
+    def run
+      return unless stopped?
+      @stopped = false
+      @adapter.opening
+      run_input_thread
+    end
+
+    def sending data
+      @adapter.sending data
+    end
+
+    def read
+      tmp = nil
+      mutex.synchronize do
+        tmp = @buffer.dup
+        @buffer.clear
+      end
+      return tmp unless tmp.empty?
+    end
+
+    private
+
+    def make_adapter cls_mod
+      if cls_mod.is_a?(Class)
+        @adapter = cls_mod.new(@out)
+      elsif cls_mod.is_a?(Module)
+        @adapter = Adapter.new(@out)
+        @adapter.extend cls_mod
+      else
+        raise TypeError, "#{cls_mod} is not a valid Backport adapter"
+      end
+    end
+
+    def mutex
+      @mutex ||= Mutex.new
+    end
+
+    def run_input_thread
+      Thread.new do
+        until stopped?
+          char = @in.getc
+          if char.nil?
+            STDERR.puts "Client received nil. Stopping"
+            stop
+            break
+          end
+          mutex.synchronize { @buffer.concat char }
+        end
+      end
+    end
+  end
+end

data/lib/backport/machine.rb

@@ -0,0 +1,46 @@
+module Backport
+  class Machine
+    def initialize
+      @stopped = true
+    end
+
+    def run
+      return unless stopped?
+      @stopped = false
+      yield if block_given?
+      run_server_thread
+    end
+
+    def stop
+      servers.map(&:stop)
+      servers.clear
+      @stopped = true
+    end
+
+    def stopped?
+      @stopped ||= false
+    end
+
+    def start_server server
+      servers.push server
+    end
+
+    private
+
+    # @return [Array<Backport::Server>]
+    def servers
+      @servers ||= []
+    end
+
+    def run_server_thread
+      servers.map(&:start)
+      until stopped?
+        servers.each do |server|
+          server.tick
+          sleep 0.001
+        end
+        sleep 0.001
+      end
+    end
+  end
+end

data/lib/backport/server/base.rb

@@ -0,0 +1,21 @@
+module Backport
+  module Server
+    class Base
+      def stopped?
+        @stopped = false if @stopped.nil?
+        @stopped
+      end
+
+      def stop
+        stopping
+        @stopped = true
+      end
+
+      def stopping; end
+
+      def tick; end
+
+      def start; end
+    end
+  end
+end

data/lib/backport/server/connectable.rb

@@ -0,0 +1,26 @@
+module Backport
+  module Server
+    module Connectable
+      def tick
+        clients.each do |client|
+          input = client.read
+          client.sending input unless input.nil?
+        end
+      end
+
+      def start
+        clients.map(&:run)
+      end
+
+      def stopping
+        clients.map(&:stop)
+      end
+
+      protected
+
+      def clients
+        @clients ||= []
+      end
+    end
+  end
+end

data/lib/backport/server/interval.rb

@@ -0,0 +1,21 @@
+module Backport
+  module Server
+    class Interval < Base
+      def initialize period, &block
+        @period = period
+        @block = block
+        @last_time = Time.now
+      end
+
+      def tick
+        return unless Time.now - @last_time > @period
+        @block.call
+        @last_time = Time.now
+      end
+
+      def stop
+        @stopped = true
+      end
+    end
+  end
+end

data/lib/backport/server/stdio.rb

@@ -0,0 +1,15 @@
+module Backport
+  module Server
+    class Stdio < Base
+      include Connectable
+
+      def initialize input: STDIN, output: STDOUT, adapter: Adapter
+        @in = input
+        @out = output
+        @in.binmode
+        @adapter = adapter
+        clients.push Client.new(input, output, adapter)
+      end
+    end
+  end
+end

data/lib/backport/server/tcpip.rb

@@ -0,0 +1,52 @@
+require 'socket'
+
+module Backport
+  module Server
+    class Tcpip < Base
+      include Connectable
+
+      def initialize host: 'localhost', port: 1117, adapter: Adapter
+        @socket = TCPServer.new(host, port)
+        @adapter = adapter
+      end
+
+      def stopped?
+        @stopped ||= false
+      end
+
+      def tick
+        mutex.synchronize do
+          clients.each do |client|
+            input = client.read
+            client.sending input unless input.nil?
+          end
+        end
+      end
+
+      def start
+        super
+        start_accept_thread
+      end
+
+      private
+
+      attr_reader :socket
+
+      def mutex
+        @mutex ||= Mutex.new
+      end
+
+      def start_accept_thread
+        Thread.new do
+          until stopped?
+            conn = socket.accept
+            mutex.synchronize do
+              clients.push Client.new(conn, conn, @adapter)
+              clients.last.run
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/backport/server.rb

@@ -0,0 +1,9 @@
+module Backport
+  module Server
+    autoload :Base,        'backport/server/base'
+    autoload :Connectable, 'backport/server/connectable'
+    autoload :Stdio,       'backport/server/stdio'
+    autoload :Tcpip,       'backport/server/tcpip'
+    autoload :Interval,    'backport/server/interval'
+  end
+end

data/lib/backport/version.rb

@@ -0,0 +1,3 @@
+module Backport
+  VERSION = "0.1.0"
+end

data/lib/backport.rb

@@ -0,0 +1,37 @@
+require "backport/version"
+require 'socket'
+
+module Backport
+  autoload :Adapter, 'backport/adapter'
+  autoload :Machine, 'backport/machine'
+  autoload :Server,  'backport/server'
+  autoload :Client,  'backport/client'
+
+  class << self
+    def start_stdio_server adapter: Adapter
+      machine.start_server Backport::Server::Stdio.new(adapter: adapter)
+    end
+
+    def start_tcp_server host: 'localhost', port: 1117, adapter: Adapter
+      machine.start_server Backport::Server::Tcpip.new(host: host, port: port, adapter: adapter)
+    end
+
+    def start_interval period, &block
+      machine.start_server Backport::Server::Interval.new(period, &block)
+    end
+
+    def run &block
+      machine.run &block
+    end
+
+    def stop
+      machine.stop
+    end
+
+    private
+
+    def machine
+      @machine ||= Machine.new
+    end
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: backport
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fred Snyder
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- fsnyder@castwide.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- backport.gemspec
+- bin/console
+- bin/setup
+- lib/backport.rb
+- lib/backport/adapter.rb
+- lib/backport/client.rb
+- lib/backport/machine.rb
+- lib/backport/server.rb
+- lib/backport/server/base.rb
+- lib/backport/server/connectable.rb
+- lib/backport/server/interval.rb
+- lib/backport/server/stdio.rb
+- lib/backport/server/tcpip.rb
+- lib/backport/version.rb
+homepage: http://github.com/castwide/backport
+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.7.6
+signing_key: 
+specification_version: 4
+summary: A pure Ruby library for event-driven IO
+test_files: []