tee 0.0.1 → 0.0.2

data/README.md

@@ -1,7 +1,7 @@
 tee
 ===
 
-A class like `tee` command for Ruby.
+A class like tee(1) for Ruby.
 
 [![Build Status](https://secure.travis-ci.org/m4i/tee.png)](http://travis-ci.org/m4i/tee)
 
@@ -103,7 +103,7 @@ stringio = StringIO.new
 open('a.txt', 'w') do |file|
   Tee.open(file, stringio) do |tee|
     tee.puts 'quux'
-  end
+  end  # `file` doesn't close because it wasn't opened by Tee.
   file.puts 'corge'
 end
 

data/lib/tee.rb

@@ -1,17 +1,25 @@
-require 'tee/version'
-
-# @attr stdout [IO]
+# A class like tee(1)
 class Tee
+  # @return [String]
+  VERSION = '0.0.2'
+
   class << self
+    # @macro new
+    #   @param ios [Array<IO, String>]
+    #   @param options [Hash]
+    #   @option options [String, Fixnum] :mode ('w')
+    #   @option options [Fixnum] :perm (0666)
+    #   @option options [IO, nil] :stdout ($stdout)
+    #
     # @overload open(*ios, options = {})
     #   A synonym for Tee.new
-    #   @param (see #initialize)
+    #   @macro new
     #   @return [Tee]
     #
     # @overload open(*ios, options = {}, &block)
     #   It will be passed the Tee as an argument,
     #   and the Tee will automatically be closed when the block terminates.
-    #   @param (see #initialize)
+    #   @macro new
     #   @yieldparam tee [Tee]
     #   @return the value of the block
     def open(*args, &block)
@@ -20,7 +28,7 @@ class Tee
         begin
           yield tee
         ensure
-          tee.send(:close_ios_opened_by_tee)
+          tee.send(:close_ios_opened_by_self)
         end
       else
         new(*args)
@@ -28,14 +36,12 @@ class Tee
     end
   end
 
+  # @param value [IO, nil] Sets the attribute stdout
+  # @return [IO, nil]      Returns the value of attribute stdout
   attr_accessor :stdout
 
   # @overload initialize(*ios, options = {})
-  #   @param ios [Array<IO,String>]
-  #   @param options [Hash]
-  #   @option options [String, Fixnum] :mode
-  #   @option options [Fixnum] :perm
-  #   @option options [IO, nil] :stdout
+  #   @macro new
   def initialize(*ios)
     @options = { mode: 'w' }
     @options.update(ios.pop) if ios.last.is_a?(Hash)
@@ -46,9 +52,9 @@ class Tee
     add(*ios)
   end
 
-  # Add IOs
+  # Add ios
   #
-  # @param ios [Array<IO,String>]
+  # @param ios [Array<IO, String>]
   # @return [self]
   def add(*ios)
     open_args = [@options[:mode]]
@@ -64,7 +70,7 @@ class Tee
         )
       end
     rescue => e
-      close_ios_opened_by_tee(_ios) rescue nil
+      close_ios_opened_by_self(_ios) rescue nil
       raise e
     end
     @ios.concat(_ios)
@@ -72,14 +78,48 @@ class Tee
     self
   end
 
-  # Closes all IOs
+  # Delegates #<< to ios
+  #
+  # @param obj [Object]
+  # @return [self]
+  def <<(obj)
+    each_ios_and_stdout { |io| io << obj }
+    self
+  end
+
+  # Closes all ios except stdout
   #
   # @return [nil]
   def close
-    @ios.each { |io,| io.close }
+    each_ios(&:close)
     nil
   end
 
+  # Returns true if all ios except stdout is closed, false otherwise.
+  #
+  # @return [Boolean]
+  def closed?
+    each_ios.all?(&:closed?)
+  end
+
+  # Delegates #flush to ios
+  #
+  # @return [self]
+  def flush
+    each_ios_and_stdout(&:flush)
+    self
+  end
+
+  # Delegates #putc to ios
+  #
+  # @param char [Fixnum, String]
+  # @return [Fixnum]
+  # @return [String]
+  def putc(char)
+    each_ios_and_stdout { |io| io.putc(char) }
+    char
+  end
+
   # Returns self
   #
   # @return [self]
@@ -87,29 +127,79 @@ class Tee
     self
   end
 
-  %w(
-    <<
-    flush
-    print
-    printf
-    putc
-    puts
-    syswrite
-    write
-    write_nonblock
-  ).each do |method|
+  # Delegates #tty? to stdout
+  #
+  # @return [Boolean]
+  def tty?
+    @stdout ? @stdout.tty? : false
+  end
+  alias isatty tty?
+
+  # @method print(obj, ...)
+  # Delegates #print to ios
+  # @param obj [Object]
+  # @return [nil]
+
+  # @method printf(format[, obj, ...])
+  # Delegates #printf to ios
+  # @param format [String]
+  # @param obj [Object]
+  # @return [nil]
+
+  # @method puts(obj, ...)
+  # Delegates #puts to ios
+  # @param obj [Object]
+  # @return [nil]
+  %w( print printf puts ).each do |method|
     class_eval(<<-EOS, __FILE__, __LINE__ + 1)
       def #{method}(*args)
-        @ios.each { |io,| io.send(:#{method}, *args) }
-        @stdout.send(:#{method}, *args) if @stdout
+        each_ios_and_stdout { |io| io.#{method}(*args) }
+        nil
+      end
+    EOS
+  end
+
+  # @method syswrite(string)
+  # Delegates #syswrite to ios
+  # @param string [String]
+  # @return [Array<Integer>]
+
+  # @method write(string)
+  # Delegates #write to ios
+  # @param string [String]
+  # @return [Array<Integer>]
+
+  # @method write_nonblock(string)
+  # Delegates #write_nonblock to ios
+  # @param string [String]
+  # @return [Array<Integer>]
+  %w( syswrite write write_nonblock ).each do |method|
+    class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+      def #{method}(string)
+        each_ios_and_stdout.map { |io| io.#{method}(string) }
       end
     EOS
   end
 
   private
 
-  def close_ios_opened_by_tee(ios = @ios)
-    ios.each { |io, opened| io.close if opened }
+  def each_ios(&block)
+    return to_enum(:each_ios) unless block_given?
+    @ios.each do |io,|
+      yield io
+    end
+    self
+  end
+
+  def each_ios_and_stdout(&block)
+    return to_enum(:each_ios_and_stdout) unless block_given?
+    each_ios(&block)
+    yield @stdout if @stdout
+    self
+  end
+
+  def close_ios_opened_by_self(ios = @ios)
+    ios.each { |io, opened| io.close if opened && !io.closed? }
     nil
   end
 end

data/spec/tee_spec.rb

@@ -20,218 +20,313 @@ def create_dummy_file
 end
 
 describe Tee do
+  before { $stdout = StringIO.new }
+  after  { $stdout = STDOUT }
+  let(:tee) { Tee.new }
+
   describe '.open' do
     context 'with a non-existing file path' do
       let(:path) { temppath }
+      after { File.delete(path) }
 
       it 'creates a file at the path' do
         expect { Tee.open(path) {} }.to change { File.exist?(path) }.from(false).to(true)
       end
-
-      after { File.delete(path) }
     end
 
     context 'with an existing file path' do
       let(:path) { create_dummy_file }
+      after { File.delete(path) }
 
       context 'without mode' do
+        before { @tee = Tee.open(path) }
+        after  { @tee.close }
+
         it 'overwrites an existing file' do
-          Tee.open(path) {}
           File.read(path).should be_empty
         end
+
+        context 'when tee writes "foo"' do
+          before do
+            @tee.write('foo')
+            @tee.flush
+          end
+
+          it 'writes `foo` in STDOUT' do
+            $stdout.string.should == 'foo'
+          end
+
+          it 'writes `foo` in the file' do
+            File.read(path).should == 'foo'
+          end
+        end
       end
 
       context 'in appending mode' do
+        before do
+          @orignal_content = File.read(path)
+          @tee = Tee.open(path, mode: 'a')
+        end
+        after { @tee.close }
+
         it 'does not overwrite an existing file' do
-          Tee.open(path, mode: 'a') {}
-          File.read(path).should == 'dummy'
+          File.read(path).should == @orignal_content
         end
-      end
 
-      after { File.delete(path) }
-    end
-  end
+        context 'when tee writes "foo"' do
+          before do
+            @tee.write('foo')
+            @tee.flush
+          end
 
-  describe '#write', 'with argument "foo"' do
-    context 'when tee is opened with an existing file path' do
-      let(:path) { create_dummy_file }
+          it 'writes `foo` in STDOUT' do
+            $stdout.string.should == 'foo'
+          end
 
-      before :all do
-        $stdout = StringIO.new
-        Tee.open(path) do |tee|
-          tee.write('foo')
+          it 'appends `foo` to the file' do
+            File.read(path).should == @orignal_content + 'foo'
+          end
         end
       end
+    end
 
-      after :all do
-        $stdout = STDOUT
-        File.delete(path)
-      end
+    context 'without arguments' do
+      context 'when tee writes "foo"' do
+        before { tee.write('foo') }
 
-      it 'writes `foo` in STDOUT' do
-        $stdout.string.should == 'foo'
+        it 'writes `foo` in STDOUT' do
+          $stdout.string.should == 'foo'
+        end
       end
+    end
 
-      it 'overwrites an existing file and writes `foo` in the file' do
-        File.read(path).should == 'foo'
+    context 'with two paths' do
+      let(:path1) { temppath }
+      let(:path2) { temppath }
+      before do
+        @tee = Tee.open(path1, path2)
+      end
+      after do
+        @tee.close
+        File.delete(path1, path2)
       end
-    end
 
-    context 'when tee is opened with an existing file path in appending mode' do
-      let(:path) { create_dummy_file }
+      context 'when tee writes "foo"' do
+        before do
+          @tee.write('foo')
+          @tee.flush
+        end
 
-      before :all do
-        $stdout = StringIO.new
-        Tee.open(path, mode: 'a') do |tee|
-          tee.write('foo')
+        it 'writes `foo` in STDOUT' do
+          $stdout.string.should == 'foo'
+        end
+
+        it 'writes `foo` in the first file' do
+          File.read(path1).should == 'foo'
+        end
+
+        it 'writes `foo` in the second file' do
+          File.read(path2).should == 'foo'
         end
       end
+    end
 
-      after :all do
-        $stdout = STDOUT
+    context 'with an option `{ stdout: nil }`' do
+      let(:path) { temppath }
+      before do
+        @tee = Tee.open(path, stdout: nil)
+      end
+      after do
+        @tee.close
         File.delete(path)
       end
 
-      it 'writes `foo` in STDOUT' do
-        $stdout.string.should == 'foo'
-      end
+      context 'when tee writes "foo"' do
+        before do
+          @tee.write('foo')
+          @tee.flush
+        end
 
-      it 'does not overwrite an existing file and appends `foo` to the file' do
-        File.read(path).should == 'dummyfoo'
-      end
-    end
+        it 'writes nothing in STDOUT' do
+          $stdout.string.should be_empty
+        end
 
-    context 'when tee is opened without arguments' do
-      before :all do
-        $stdout = StringIO.new
-        Tee.open do |tee|
-          tee.write('foo')
+        it 'writes `foo` in the first file' do
+          File.read(path).should == 'foo'
         end
       end
+    end
 
-      after :all do
-        $stdout = STDOUT
+    context 'with File instance' do
+      let(:path) { temppath }
+      before do
+        @file = open(path, 'w')
+        @tee  = Tee.open(@file)
       end
-
-      it 'writes `foo` in STDOUT' do
-        $stdout.string.should == 'foo'
+      after do
+        @file.close
+        File.delete(path)
       end
-    end
 
-    context 'when tee is opened with two paths' do
-      let(:path1) { temppath }
-      let(:path2) { temppath }
+      context 'when tee writes "foo"' do
+        before do
+          @tee.write('foo')
+          @tee.flush
+        end
 
-      before :all do
-        $stdout = StringIO.new
-        Tee.open(path1, path2) do |tee|
-          tee.write('foo')
+        it 'writes `foo` in STDOUT' do
+          $stdout.string.should == 'foo'
         end
-      end
 
-      after :all do
-        $stdout = STDOUT
-        File.delete(path1, path2)
+        it 'writes `foo` to the File instance' do
+          File.read(path).should == 'foo'
+        end
       end
+    end
 
-      it 'writes `foo` in STDOUT' do
-        $stdout.string.should == 'foo'
+    context 'with StringIO instance' do
+      before do
+        @stringio = StringIO.new
+        @tee      = Tee.open(@stringio)
       end
 
-      it 'writes `foo` in the first file' do
-        File.read(path1).should == 'foo'
-      end
+      context 'when tee writes "foo"' do
+        before do
+          @tee.write('foo')
+          @tee.flush
+        end
 
-      it 'writes `foo` in the second file' do
-        File.read(path2).should == 'foo'
+        it 'writes `foo` in STDOUT' do
+          $stdout.string.should == 'foo'
+        end
+
+        it 'writes `foo` to the StringIO instance' do
+          @stringio.string.should == 'foo'
+        end
       end
     end
+  end
 
-    context 'when tee is opened with an option `{ stdout: nil }`' do
-      let(:path) { temppath }
+  describe '#<<' do
+    it 'returns self' do
+      (tee << 'foo').should be tee
+    end
+  end
 
-      before :all do
-        $stdout = StringIO.new
-        Tee.open(path, stdout: nil) do |tee|
+  describe '#add' do
+    it 'returns self' do
+      tee.add.should be tee
+    end
+
+    context 'when tee writes "foo", adds a file and writes "bar"' do
+      let(:file1) { StringIO.new }
+      let(:file2) { StringIO.new }
+
+      before do
+        Tee.open(file1) do |tee|
           tee.write('foo')
+          tee.add(file2)
+          tee.write('bar')
         end
       end
 
-      after :all do
-        $stdout = STDOUT
-        File.delete(path)
+      it 'writes `foobar` in STDOUT' do
+        $stdout.string.should == 'foobar'
       end
 
-      it 'writes nothing in STDOUT' do
-        $stdout.string.should be_empty
+      it 'writes `foobar` in the first file' do
+        file1.string.should == 'foobar'
       end
 
-      it 'writes `foo` in the file' do
-        File.read(path).should == 'foo'
+      it 'writes `bar` in the second file' do
+        file2.string.should == 'bar'
       end
     end
+  end
 
-    context 'when tee is opened with IO instances' do
-      let(:path) { temppath }
+  describe '#close' do
+    it 'returns nil' do
+      tee.close.should be_nil
+    end
 
-      before :all do
-        $stdout   = StringIO.new
-        @stringio = StringIO.new
-        open(path, 'w') do |file|
-          Tee.open(file, @stringio) do |tee|
-            tee.write('foo')
-          end
-          file.write('bar')
-        end
+    it 'closes ios opened by self' do
+      path = temppath
+      Tee.open(path) do |tee|
+        expect { tee.close }.to change {
+          tee.instance_variable_get(:@ios)[0][0].closed?
+        }.from(false).to(true)
       end
+      File.delete(path)
+    end
 
-      after :all do
-        $stdout = STDOUT
-        File.delete(path)
-      end
+    it 'closes passed ios' do
+      file = open(temppath, 'w')
+      tee = Tee.open(file)
+      expect { tee.close }.to change { file.closed? }.from(false).to(true)
+      File.delete(file.path)
+    end
+  end
 
-      it 'writes `foo` in STDOUT' do
-        $stdout.string.should == 'foo'
-      end
+  describe '#flush' do
+    it 'returns self' do
+      tee.flush.should be tee
+    end
+  end
 
-      it 'writes `foo` to the File instance' do
-        File.read(path).should == 'foobar'
-      end
+  describe '#print' do
+    it 'returns nil' do
+      tee.print.should be_nil
+    end
+  end
 
-      it 'writes `foo` to the StringIO instance' do
-        @stringio.string.should == 'foo'
-      end
+  describe '#printf' do
+    it 'returns nil' do
+      tee.printf('format').should be_nil
     end
   end
 
-  describe '#add' do
-    let(:path1) { temppath }
-    let(:path2) { temppath }
+  describe '#putc' do
+    context 'with Fixnum argument' do
+      it 'returns argument' do
+        char = 0x20
+        tee.putc(char).should == char
+      end
+    end
 
-    before :all do
-      $stdout = StringIO.new
-      Tee.open(path1) do |tee|
-        tee.write('foo')
-        tee.add(path2)
-        tee.write('bar')
+    context 'with String argument' do
+      it 'returns argument' do
+        string = 'foo'
+        tee.putc(string).should == string
       end
     end
+  end
 
-    after :all do
-      $stdout = STDOUT
-      File.delete(path1, path2)
+  describe '#puts' do
+    it 'returns nil' do
+      tee.puts.should be_nil
     end
+  end
 
-    it 'writes `foobar` in STDOUT' do
-      $stdout.string.should == 'foobar'
+  describe '#to_io' do
+    it 'returns self' do
+      tee.to_io.should be tee
     end
+  end
 
-    it 'writes `foobar` in the first file' do
-      File.read(path1).should == 'foobar'
+  %w( tty? isatty ).each do |method|
+    describe "##{method}" do
+      it 'returns $stdout.tty?' do
+        tee.send(method).should == $stdout.tty?
+      end
     end
+  end
 
-    it 'writes `bar` in the second file' do
-      File.read(path2).should == 'bar'
+  %w( syswrite write write_nonblock ).each do |method|
+    describe "##{method}" do
+      it 'returns Array of the number of bytes written' do
+        string = 'foo'
+        tee.send(method, string).should == [string.length]
+      end
     end
   end
 end

data/tee.gemspec

@@ -1,9 +1,9 @@
-require File.expand_path('../lib/tee/version', __FILE__)
+require File.expand_path('../lib/tee', __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = 'tee'
   s.version     = Tee::VERSION
-  s.summary     = %q{A class like `tee` command.}
+  s.summary     = %q{A class like tee(1).}
   s.description = s.summary
 
   s.homepage    = 'https://github.com/m4i/tee'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tee
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-05 00:00:00.000000000 Z
+date: 2012-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70197438246820 !ruby/object:Gem::Requirement
+  requirement: &70332175132780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *70197438246820
+  version_requirements: *70332175132780
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70197438246140 !ruby/object:Gem::Requirement
+  requirement: &70332175131820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,8 +32,8 @@ dependencies:
         version: 2.11.0
   type: :development
   prerelease: false
-  version_requirements: *70197438246140
-description: A class like `tee` command.
+  version_requirements: *70332175131820
+description: A class like tee(1).
 email: m.ishihara@gmail.com
 executables: []
 extensions: []
@@ -47,7 +47,6 @@ files:
 - README.md
 - Rakefile
 - lib/tee.rb
-- lib/tee/version.rb
 - spec/tee_spec.rb
 - tee.gemspec
 homepage: https://github.com/m4i/tee
@@ -71,12 +70,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 936261864365435023
+      hash: 4540246555897654950
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: A class like `tee` command.
+summary: A class like tee(1).
 test_files:
 - spec/tee_spec.rb

data/lib/tee/version.rb

@@ -1,3 +0,0 @@
-class Tee
-  VERSION = '0.0.1'
-end