ruby-fifo 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9fcf27bae77b111caf248abe556705cd06b1560b
-  data.tar.gz: ec8e787ebcdbae3c6b1a27fe84fd398749379ce1
+SHA256:
+  metadata.gz: 4fab97cf3842f0e9ef32f5b9a2b1fc9c275f5e912d4d05cffb30465eb74e547e
+  data.tar.gz: a29449a81938a26cbf7e8cfc70b4314fcfd477925153474f927fb4f760b00f3d
 SHA512:
-  metadata.gz: 902afd3add127ef2aaf730f5b03a63ed91e9be8c72386fd78dc6a30d52de7530f23bf73c22ade093ad40b00d990b2ed3711d9370defd63da730afc93ac9bdbf1
-  data.tar.gz: d77fa087541717df067b42983ca0b63f540fb87b624374aac0dadf54c864f37bc1b34da1a6b6704324105cb0049a0b651ad3b60d3713fdaaf2ea8e3ab7edadeb
+  metadata.gz: 50b08c65ec8ec99589ab6bba1cd2fc068df634f98c2241d4f009bbd31641447700a2303e88df3320118098e6f0398bbbe2e7631006b6c78627e44a1a847b7756
+  data.tar.gz: 7c726e78f61a499d4c31f3dbab827f3c064e1750a6e9009b3e0e9ba20ed0b5804512fd01355e19a350036565e0f165473464c49faf02ddb1db34d9d4419ba263

data/Gemfile

@@ -0,0 +1,16 @@
+source :rubygems
+
+if RUBY_PLATFORM =~ /mswin/
+  gem 'win32-pipe'
+else
+  gem 'mkfifo'
+end
+
+group :test do
+  gem 'rspec'
+  gem 'rake'
+end
+
+group :development do
+  gem 'pry'
+end

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    coderay (1.0.6)
+    diff-lcs (1.1.3)
+    method_source (0.7.1)
+    mkfifo (0.0.1)
+    pry (0.9.9.6)
+      coderay (~> 1.0.5)
+      method_source (~> 0.7.1)
+      slop (>= 2.4.4, < 3)
+    rake (0.9.2.2)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.0)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    slop (2.4.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mkfifo
+  pry
+  rake
+  rspec

data/LICENSE

@@ -0,0 +1,13 @@
+           DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                   Version 2, December 2004
+
+Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
+
+Everyone is permitted to copy and distribute verbatim or modified
+copies of this license document, and changing it is allowed as long
+as the name is changed.
+
+           DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+  TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. You just DO WHAT THE FUCK YOU WANT TO.

data/README.md

@@ -0,0 +1,124 @@
+# ruby-fifo [![Build Status](https://travis-ci.org/shurizzle/ruby-fifo.svg?branch=master)](https://travis-ci.org/shurizzle/ruby-fifo)
+
+A small, simple library for using Fifos in Ruby. A Fifo is traditionally a Unix
+idea that lets processes communicate by writing to and reading from a special
+kind of file in the filesystem. More information on fifos can be found here:
+[http://en.wikipedia.org/wiki/Named_pipe](http://en.wikipedia.org/wiki/Named_pipe).
+
+# Installation
+
+To install ruby-fifo, execute the following command at your terminal:
+
+    $ gem install ruby-fifo
+
+Being sure not to include the dollar sign. The dollar sign is simply convention
+for denoting a terminal command.
+
+# Usage
+
+To use a fifo, you need both a reader and a writer (the POSIX standard does not
+define the behaviour from using the same file handle as both a reader and a
+writer so this library does not allow it).
+
+Here's some example code that will simply write to a fifo and read from it, all
+in the same process:
+
+``` ruby
+reader = Fifo.new('path/to/fifo', :r, :nowait)
+writer = Fifo.new('path/to/fifo', :w, :nowait)
+
+writer.puts "Hello, world!"
+reader.gets
+#=> "Hello, world!\n"
+```
+
+Notice that we pass in `:r` and `:w` for the reader and writer respectively.
+Also, we have this `:nowait` symbol in there. This tells the library that we
+don't want to use "blocking" fifos.
+
+## Blocking vs Non-blocking
+
+A blocking fifo will block the current thread of execution until the other end
+is opened. For example, the following code will never finish executing:
+
+``` ruby
+reader = Fifo.new('path/to/fifo', :r, :wait)
+writer = Fifo.new('path/to/fifo', :w, :wait)
+```
+
+The thread will be blocked after the first line and it will wait until the
+writing end of the fifo is opened before allowing execution to continue. This
+also works exactly the same way in reverse (if you opened the writer before the
+reader).
+
+The following code should work fine:
+
+``` ruby
+fork do
+  reader = Fifo.new('path/to/fifo', :r, :wait)
+  reader.gets
+  #=> Eventually, this will return "Hello, fork!\n"
+end
+
+fork do
+  writer = Fifo.new('path/to/fifo', :w, :wait)
+  writer.puts "Hello, fork!"
+end
+```
+
+### Non-blocking
+
+Alternately, you can use non-blocking pipes. These pipes don't wait for the
+other end to be open before doing there work. The following code will work just
+fine all in the same process:
+
+``` ruby
+writer = Fifo.new('path/to/fifo', :w, :nowait)
+writer.puts "Testing"
+
+reader = Fifo.new('path/to/fifo', :r, :nowait)
+reader.gets
+#=> "Testing\n"
+```
+
+### Defaults
+
+Because of this, non-blocking is the default type of fifo that this library will
+create.
+
+``` ruby
+fifo = Fifo.new('path/to/fifo')
+# This is a non-blocking reader by default
+```
+
+## Other methods for reading and writing
+
+There are other forms of reading and writing that will be familiar to you if you
+have used the Ruby File object:
+
+``` ruby
+reader = Fifo.new('path/to/fifo', :r, :nowait)
+writer = Fifo.new('path/to/fifo', :w, :nowait)
+
+writer.puts "Two", "Lines"
+reader.gets
+#=> "Two\n"
+reader.gets
+#=> "Lines\n"
+
+writer.print "12345"
+# reader.gets would block forever here, no new line
+reader.getc
+#=> "1"
+reader.read(1)
+#=> "2"
+reader.read(3)
+#=> "345"
+
+# reader.read(1)
+#=> Blocks until something is written
+
+writer.print "Same as puts\n"
+reader.readline
+#=> "Same as puts\n"
+```

data/Rakefile

@@ -0,0 +1,16 @@
+require 'rspec/core/rake_task'
+
+task :default => [:test]
+
+desc "Run all tests."
+RSpec::Core::RakeTask.new(:test) do |t|
+    t.rspec_opts = '-cfs'
+end
+
+desc "Opens up an irb session with the load path and library required."
+task :console do
+  exec "irb -I lib/ -r ./lib/ruby-fifo.rb"
+end
+
+desc "Alias for rake console."
+task :c => [:console]

data/lib/ruby-fifo/fifo.rb

@@ -0,0 +1,131 @@
+class Fifo
+  # Module to allow delegation
+  include Forwardable
+
+  # Constructs a new Fifo. Can open either a read or write fifo in either
+  # blocking or non-blocking mode.
+  #
+  # Examples:
+  #
+  #   # Non-blocking read Fifo (default)
+  #   r = Fifo.new('path/to/fifo')
+  #
+  #   # Blocking read Fifo
+  #   r = Fifo.new('path/to/fifo', :r, :wait)
+  #
+  #   # Non blocking write Fifo
+  #   w = Fifo.new('path/to/fifo', :w, :nowait)
+  def initialize(file, perms = :r, mode = :nowait)
+    unless [:r, :w].include?(perms)
+      raise "Unknown file permission. Must be either :r or :w."
+    end
+
+    unless [:wait, :nowait].include?(mode)
+      raise "Unknown file mode. Must be either :wait or :nowait for blocking" +
+            " or non-blocking respectively."
+    end
+
+    if not $POSIX
+      include Win32
+
+      mode  = mode  == :wait ? Pipe::WAIT : Pipe::NOWAIT
+      @pipe = perms == :r ? Pipe.new_server(file, mode) : Pipe.new_client(file)
+      @pipe.connect if perms == :r
+    else
+      unless File.exists?(file)
+        File.mkfifo(file)
+        File.chmod(0666, file)
+      end
+
+      perms = perms.to_s + (mode == :wait ? '' : '+')
+      @pipe = File.open(file, perms)
+    end
+
+    def_delegators :@pipe, :read, :write, :close, :to_io, :flush
+  end
+
+  # Prints the arguments passed in to the fifo. to_s is called on either
+  # argument passed in.
+  #
+  # Example:
+  #
+  #   f = Fifo.new('path/to/fifo', :w)
+  #   f.print "Hello!"
+  #   f.print "Multiple", "Arguments"
+  #   f.puts "!" # Need a puts because fifos are line buffered
+  #
+  #   r = Fifo.new('path/to/fifo', :r)
+  #   r.gets
+  #   #=> "Hello!MultipleArugments!\n"
+  def print(*args)
+    args.each do |obj|
+      self.write obj.to_s
+    end
+
+    write $OUTPUT_RECORD_SEPARATOR
+    flush
+  end
+
+  # Works the same as Kernel::puts, writes a string or multiple strings to the
+  # Fifo and then appends a new line. In the case of multiple arguments, a new
+  # line is printed after each one.
+  #
+  # Examples:
+  #
+  #   w = Fifo.new('path/to/fifo', :w)
+  #   r = Fifo.new('path/to/fifo', :r)
+  #
+  #   w.puts "1", "2", "3", "4"
+  #
+  #   r.gets
+  #   #=> "1\n"
+  #
+  #   r.gets
+  #   #=> "2\n"
+  #
+  #   r.gets
+  #   #=> "3\n"
+  #
+  #   r.gets
+  #   #=> "4\n"
+  def puts(*args)
+    args.each do |obj|
+      self.write "#{obj.to_s.sub(/\n$/, '')}\n"
+      flush
+    end
+  end
+
+  # Alias for read(1).
+  def getc
+    self.read(1)
+  end
+
+  # Works in the same way as gets does but uses the $_ global variable for
+  # reading in each character. There is no functional difference between this
+  # and gets.
+  def readline
+    str = ""
+    while ($_ = self.read(1)) != "\n"
+      str << $_
+    end
+    str << "\n"
+  end
+
+  # Reads from the Fifo until it encounters a new line. Will block the current
+  # thread of execution until it hits a new line. This includes when the fifo is
+  # empty and nothing is writing to it.
+  #
+  # Example:
+  #
+  #   w = Fifo.new('path/to/fifo', :w)
+  #   r = Fifo.new('path/to/fifo', :r)
+  #
+  #   w.puts "Hello, world!"
+  #   r.gets
+  #   #=> "Hello, world!\n"
+  def gets
+    str = ""
+    str << (r = self.read(1)) until r == "\n"
+    str
+  end
+end

data/ruby-fifo.gemspec

@@ -0,0 +1,24 @@
+require 'rubygems'
+
+Gem::Specification.new {|s|
+    s.name                  = 'ruby-fifo'
+    s.version               = '0.2.0'
+    s.author                = 'shura'
+    s.email                 = 'shura1991@gmail.com'
+    s.homepage              = 'http://github.com/shurizzle/ruby-fifo'
+    s.platform              = Gem::Platform::RUBY
+    s.required_ruby_version = '>= 1.9.2'
+    s.summary               = 'A cross-platform library to use named pipe'
+    s.description           = s.summary
+    s.require_paths         = ['lib']
+    s.has_rdoc              = true
+    s.license               = 'WTFPL'
+
+    # exclude these files and directories from the gem
+    dir_exclude  = Regexp.new(%r{^(test|spec|features)/})
+    file_exclude = Regexp.new(/^(\.gitignore|\.travis|\.rubocop|\.rspec|Guardfile)/)
+    excludes     = Regexp.union(dir_exclude, file_exclude)
+
+    # add all files in the repository not matching any of the above
+    s.files = `git ls-files -z`.split("\x0").reject { |f| f.match(excludes) }
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-fifo
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - shura
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-10-15 00:00:00.000000000 Z
+date: 2024-08-04 00:00:00.000000000 Z
 dependencies: []
 description: A cross-platform library to use named pipe
 email: shura1991@gmail.com
@@ -16,28 +16,35 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
 - lib/ruby-fifo.rb
+- lib/ruby-fifo/fifo.rb
+- ruby-fifo.gemspec
 homepage: http://github.com/shurizzle/ruby-fifo
-licenses: []
+licenses:
+- WTFPL
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.14
-signing_key: 
+rubygems_version: 3.3.25
+signing_key:
 specification_version: 4
 summary: A cross-platform library to use named pipe
 test_files: []