moon-null_io 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2c8680028df3d884b787ea9b790aacced72cc04f
+  data.tar.gz: 017f84e0d3d8dd5385e6bbb6477a9406118f16b4
+SHA512:
+  metadata.gz: 4619154f2c8241d6887e2e079f97cdb07667f6436f4d7512997c06d54051fa341fbf221c255b0f49bee3961c65a6267883f8cac41ec246c90ea8e1a6e2a2f8c5
+  data.tar.gz: 6bbcc558151dec8aa4833d49e60ea255a3ca914c3d2686cceee44426f8768b686d05030fe7e0518f0d695fcfa6cbfb9c83b32fbadaede6c42498bef7b3fffc47

data/lib/moon-null_io/_basalt.rb

@@ -0,0 +1 @@
+require 'moon-null_io/load'

data/lib/moon-null_io/load.rb

@@ -0,0 +1 @@
+require 'moon-null_io/null_io'

data/lib/moon-null_io/null_io.rb

@@ -0,0 +1,125 @@
+# An IO class stub, this class is intended to be used as a placeholder for
+# a class that uses an IO object.
+# Example of such classes would be a logger that logs to an IO.
+class NullIO
+  # @param [Object] fd  file descriptor
+  # @param [String] mode
+  # @param [Hash] options
+  def initialize(fd, mode = 'w+', options = {})
+    @fd = fd
+    @mode = mode
+    @options = options
+    @writable = !!(@mode =~ /[w\+a]/)
+    @readable = !!(@mode =~ /[r\+]/)
+    @binmode = !!(@mode =~ /[b]/)
+    @closed = false
+  end
+
+  # Is the IO closed?
+  #
+  # @return [Boolean]
+  def closed?
+    @closed
+  end
+
+  # Checks if the IO is open for operations
+  #
+  # @raise IOError
+  private def check_open
+    raise IOError, 'closed stream' if closed?
+  end
+
+  # Checks if the IO is open for writing
+  #
+  # @raise IOError
+  private def check_writable
+    check_open
+    raise IOError, 'not opened for writing' unless @writable
+  end
+
+  # Checks if the IO is open for reading
+  #
+  # @raise IOError
+  private def check_readable
+    check_open
+    raise IOError, 'not opened for reading' unless @readable
+  end
+
+  # Closes the IO
+  #
+  # @return [void]
+  def close
+    check_open
+    @closed = true
+  end
+
+  # Sets the IO into binary mode
+  #
+  # @return [NullIO]
+  def binmode
+    NullIO.new(@fd, @mode + 'b', @options)
+  end
+
+  # Is the IO in binary mode?
+  #
+  # @return [Boolean]
+  def binmode?
+    @binmode
+  end
+
+  # Writes a string to the stream, in the case of NullIO.
+  #
+  # @param [Object] args
+  # @return [Integer] number of bytes written
+  def write(*args)
+    check_writable
+    args.inject(0) { |acc, o| acc + o.to_s.size }
+  end
+
+  # Writes args to the stream.
+  #
+  # @param [Object] args
+  # @return [nil]
+  def print(*args)
+    write(*args)
+    nil
+  end
+
+  # (see #print)
+  def puts(*args)
+    print(*args)
+  end
+
+  # Pushes objects into the stream.
+  #
+  # @param [Object] args
+  # @return [self]
+  def <<(*args)
+    print(*args)
+    self
+  end
+
+  # Reads values from the stream, in the case of NullIO, an empty string is
+  # returned.
+  #
+  # @return [String] an empty string
+  def read
+    check_readable
+    ''
+  end
+
+  # Flushes the stream
+  #
+  # @return [self]
+  def flush(*args)
+    check_open
+    self
+  end
+
+  # STDIN shim
+  IN  = new 0, 'r'
+  # STDOUT shim
+  OUT = new 1, 'w'
+  # STDERR shim
+  ERR = new 2, 'w'
+end

data/lib/moon-null_io/pkg.yml

@@ -0,0 +1,6 @@
+---
+name: NullIO
+author: IceDragon200 (Corey Powell) (mistdragon100@gmail.com)
+description: "An empty, no-op IO object"
+require: _basalt.rb
+deps: []

data/spec/null_io_err_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+require 'moon-null_io/null_io'
+
+describe NullIO::ERR do
+  subject(:io) { NullIO::ERR }
+
+  it 'is write only' do
+    io.puts('Hi')
+
+    expect { io.read }.to raise_error(IOError)
+  end
+end

data/spec/null_io_in_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+require 'moon-null_io/null_io'
+
+describe NullIO::IN do
+  subject(:io) { NullIO::IN }
+
+  it 'is read only' do
+    expect { io.puts('Hi') }.to raise_error(IOError)
+    io.read
+  end
+end

data/spec/null_io_out_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+require 'moon-null_io/null_io'
+
+describe NullIO::OUT do
+  subject(:io) { NullIO::OUT }
+
+  it 'is write only' do
+    io.puts('Hi')
+
+    expect { io.read }.to raise_error(IOError)
+  end
+end

data/spec/null_io_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+require 'moon-null_io/null_io'
+
+describe NullIO do
+  subject(:io) { @io ||= NullIO.new(-1, 'rw') }
+
+  context '#close' do
+    it 'closes a stream' do
+      myio = NullIO.new(-1, 'rw')
+      myio.close
+      expect(myio).to be_closed
+    end
+  end
+
+  context '#binmode' do
+    it 'creates a binary stream' do
+      myio = NullIO.new(-1, 'rw')
+      expect(myio).not_to be_binmode
+      myio = myio.binmode
+      expect(myio).to be_binmode
+    end
+  end
+
+  context '#write' do
+    it 'writes given objects' do
+      expect(io.write('Hi')).to eq(2)
+    end
+  end
+
+  context '#print' do
+    it 'prints given objects' do
+      io.print('Hello World', 1, 2, [], {})
+    end
+  end
+
+  context '#puts' do
+    # this is a lie in NullIOs case
+    it 'prints given objects appended with record seperator' do
+      io.puts('Hello World')
+    end
+  end
+
+  context '#<<' do
+    it 'writes given object' do
+      io << 'Hello World' << 'Derp'
+    end
+  end
+
+  context '#read' do
+    it 'reads from the io' do
+      expect(io.read).to eq('')
+    end
+  end
+
+  context '#flush' do
+    it 'flushes the io' do
+      expect(io.flush).to equal(io)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+Encoding.default_internal = Encoding.default_external = 'UTF-8'
+
+require 'codeclimate-test-reporter'
+
+require 'simplecov'
+
+CodeClimate::TestReporter.start
+SimpleCov.start
+
+require 'moon-null_io/load'

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: moon-null_io
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Blaž Hrastnik
+- Corey Powell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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: simplecov
+  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: An empty, no-op IO object in ruby.
+email: mistdragon100@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/moon-null_io/_basalt.rb
+- lib/moon-null_io/load.rb
+- lib/moon-null_io/null_io.rb
+- lib/moon-null_io/pkg.yml
+- spec/null_io_err_spec.rb
+- spec/null_io_in_spec.rb
+- spec/null_io_out_spec.rb
+- spec/null_io_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/polyfox/moon-null_io
+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.4.8
+signing_key: 
+specification_version: 4
+summary: NullIO
+test_files: []
+has_rdoc: