tee 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+/.bundle/
+/.yardoc/
+/Gemfile.lock
+/doc/
+/pkg/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - jruby-19mode

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Masaki Takeuchi
+
+MIT License
+
+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,127 @@
+tee
+===
+
+A class like `tee` command for Ruby.
+
+[![Build Status](https://secure.travis-ci.org/m4i/tee.png)](http://travis-ci.org/m4i/tee)
+
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+    gem 'tee'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tee
+
+
+Examples
+--------
+
+### Basic usage
+
+```ruby
+Tee.open('a.txt') do |tee|
+  tee.puts 'foo'
+end
+```
+
+```
+# a.txt
+foo
+
+# STDOUT
+foo
+```
+
+### Multiple files
+
+```ruby
+Tee.open('a.txt', 'b.txt') do |tee|
+  tee.puts 'bar'
+end
+```
+
+```
+# a.txt
+bar
+
+# b.txt
+bar
+
+# STDOUT
+bar
+```
+
+### Appending mode
+
+```ruby
+Tee.open('a.txt', mode: 'a') do |tee|
+  tee.puts 'baz'
+end
+```
+
+```
+# a.txt
+bar
+baz
+
+# STDOUT
+baz
+```
+
+### Disable STDOUT
+
+```ruby
+Tee.open('a.txt', 'b.txt', stdout: nil) do |tee|
+  tee.puts 'qux'
+end
+```
+
+```
+# a.txt
+qux
+
+# b.txt
+qux
+```
+
+### IO instances
+
+```ruby
+require 'stringio'
+
+stringio = StringIO.new
+
+open('a.txt', 'w') do |file|
+  Tee.open(file, stringio) do |tee|
+    tee.puts 'quux'
+  end
+  file.puts 'corge'
+end
+
+puts stringio.string
+```
+
+```
+# a.txt
+quux
+corge
+
+# STDOUT
+quux
+quux
+```
+
+
+Copyright
+---------
+
+Copyright (c) 2012 Masaki Takeuchi. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/tee.rb

@@ -0,0 +1,115 @@
+require 'tee/version'
+
+# @attr stdout [IO]
+class Tee
+  class << self
+    # @overload open(*ios, options = {})
+    #   A synonym for Tee.new
+    #   @param (see #initialize)
+    #   @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)
+    #   @yieldparam tee [Tee]
+    #   @return the value of the block
+    def open(*args, &block)
+      if block_given?
+        tee = new(*args)
+        begin
+          yield tee
+        ensure
+          tee.send(:close_ios_opened_by_tee)
+        end
+      else
+        new(*args)
+      end
+    end
+  end
+
+  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
+  def initialize(*ios)
+    @options = { mode: 'w' }
+    @options.update(ios.pop) if ios.last.is_a?(Hash)
+
+    @stdout = @options.key?(:stdout) ? @options.delete(:stdout) : $stdout
+
+    @ios = []
+    add(*ios)
+  end
+
+  # Add IOs
+  #
+  # @param ios [Array<IO,String>]
+  # @return [self]
+  def add(*ios)
+    open_args = [@options[:mode]]
+    open_args << @options[:perm] if @options[:perm]
+
+    _ios = []
+    begin
+      ios.each do |io|
+        _ios << (
+          io.respond_to?(:write) ?
+            [io, false] :
+            [File.open(io, *open_args), true]
+        )
+      end
+    rescue => e
+      close_ios_opened_by_tee(_ios) rescue nil
+      raise e
+    end
+    @ios.concat(_ios)
+
+    self
+  end
+
+  # Closes all IOs
+  #
+  # @return [nil]
+  def close
+    @ios.each { |io,| io.close }
+    nil
+  end
+
+  # Returns self
+  #
+  # @return [self]
+  def to_io
+    self
+  end
+
+  %w(
+    <<
+    flush
+    print
+    printf
+    putc
+    puts
+    syswrite
+    write
+    write_nonblock
+  ).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
+      end
+    EOS
+  end
+
+  private
+
+  def close_ios_opened_by_tee(ios = @ios)
+    ios.each { |io, opened| io.close if opened }
+    nil
+  end
+end

data/lib/tee/version.rb

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

data/spec/tee_spec.rb

@@ -0,0 +1,237 @@
+require 'tee'
+
+require 'stringio'
+require 'tempfile'
+
+def temppath
+  Tempfile.open(File.basename(__FILE__)) do |file|
+    file.path.tap do
+      file.close!
+    end
+  end
+end
+
+def create_dummy_file
+  temppath.tap do |path|
+    File.open(path, 'w') do |file|
+      file.write('dummy')
+    end
+  end
+end
+
+describe Tee do
+  describe '.open' do
+    context 'with a non-existing file path' do
+      let(:path) { temppath }
+
+      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 }
+
+      context 'without mode' do
+        it 'overwrites an existing file' do
+          Tee.open(path) {}
+          File.read(path).should be_empty
+        end
+      end
+
+      context 'in appending mode' do
+        it 'does not overwrite an existing file' do
+          Tee.open(path, mode: 'a') {}
+          File.read(path).should == 'dummy'
+        end
+      end
+
+      after { File.delete(path) }
+    end
+  end
+
+  describe '#write', 'with argument "foo"' do
+    context 'when tee is opened with an existing file path' do
+      let(:path) { create_dummy_file }
+
+      before :all do
+        $stdout = StringIO.new
+        Tee.open(path) do |tee|
+          tee.write('foo')
+        end
+      end
+
+      after :all do
+        $stdout = STDOUT
+        File.delete(path)
+      end
+
+      it 'writes `foo` in STDOUT' do
+        $stdout.string.should == 'foo'
+      end
+
+      it 'overwrites an existing file and writes `foo` in the file' do
+        File.read(path).should == 'foo'
+      end
+    end
+
+    context 'when tee is opened with an existing file path in appending mode' do
+      let(:path) { create_dummy_file }
+
+      before :all do
+        $stdout = StringIO.new
+        Tee.open(path, mode: 'a') do |tee|
+          tee.write('foo')
+        end
+      end
+
+      after :all do
+        $stdout = STDOUT
+        File.delete(path)
+      end
+
+      it 'writes `foo` in STDOUT' do
+        $stdout.string.should == 'foo'
+      end
+
+      it 'does not overwrite an existing file and appends `foo` to the file' do
+        File.read(path).should == 'dummyfoo'
+      end
+    end
+
+    context 'when tee is opened without arguments' do
+      before :all do
+        $stdout = StringIO.new
+        Tee.open do |tee|
+          tee.write('foo')
+        end
+      end
+
+      after :all do
+        $stdout = STDOUT
+      end
+
+      it 'writes `foo` in STDOUT' do
+        $stdout.string.should == 'foo'
+      end
+    end
+
+    context 'when tee is opened with two paths' do
+      let(:path1) { temppath }
+      let(:path2) { temppath }
+
+      before :all do
+        $stdout = StringIO.new
+        Tee.open(path1, path2) do |tee|
+          tee.write('foo')
+        end
+      end
+
+      after :all do
+        $stdout = STDOUT
+        File.delete(path1, path2)
+      end
+
+      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
+
+    context 'when tee is opened with an option `{ stdout: nil }`' do
+      let(:path) { temppath }
+
+      before :all do
+        $stdout = StringIO.new
+        Tee.open(path, stdout: nil) do |tee|
+          tee.write('foo')
+        end
+      end
+
+      after :all do
+        $stdout = STDOUT
+        File.delete(path)
+      end
+
+      it 'writes nothing in STDOUT' do
+        $stdout.string.should be_empty
+      end
+
+      it 'writes `foo` in the file' do
+        File.read(path).should == 'foo'
+      end
+    end
+
+    context 'when tee is opened with IO instances' do
+      let(:path) { temppath }
+
+      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
+      end
+
+      after :all do
+        $stdout = STDOUT
+        File.delete(path)
+      end
+
+      it 'writes `foo` in STDOUT' do
+        $stdout.string.should == 'foo'
+      end
+
+      it 'writes `foo` to the File instance' do
+        File.read(path).should == 'foobar'
+      end
+
+      it 'writes `foo` to the StringIO instance' do
+        @stringio.string.should == 'foo'
+      end
+    end
+  end
+
+  describe '#add' do
+    let(:path1) { temppath }
+    let(:path2) { temppath }
+
+    before :all do
+      $stdout = StringIO.new
+      Tee.open(path1) do |tee|
+        tee.write('foo')
+        tee.add(path2)
+        tee.write('bar')
+      end
+    end
+
+    after :all do
+      $stdout = STDOUT
+      File.delete(path1, path2)
+    end
+
+    it 'writes `foobar` in STDOUT' do
+      $stdout.string.should == 'foobar'
+    end
+
+    it 'writes `foobar` in the first file' do
+      File.read(path1).should == 'foobar'
+    end
+
+    it 'writes `bar` in the second file' do
+      File.read(path2).should == 'bar'
+    end
+  end
+end

data/tee.gemspec

@@ -0,0 +1,22 @@
+require File.expand_path('../lib/tee/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'tee'
+  s.version     = Tee::VERSION
+  s.summary     = %q{A class like `tee` command.}
+  s.description = s.summary
+
+  s.homepage    = 'https://github.com/m4i/tee'
+  s.license     = 'MIT'
+  s.author      = 'Masaki Takeuchi'
+  s.email       = 'm.ishihara@gmail.com'
+
+  s.files       = `git ls-files`.split($\)
+  s.executables = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files  = s.files.grep(%r{^(test|spec|features)/})
+
+  s.required_ruby_version = '>= 1.9.2'
+
+  s.add_development_dependency 'rake',  '~> 0.9.2.2'
+  s.add_development_dependency 'rspec', '~> 2.11.0'
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: tee
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Masaki Takeuchi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70197438246820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: *70197438246820
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70197438246140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: *70197438246140
+description: A class like `tee` command.
+email: m.ishihara@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/tee.rb
+- lib/tee/version.rb
+- spec/tee_spec.rb
+- tee.gemspec
+homepage: https://github.com/m4i/tee
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 936261864365435023
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: A class like `tee` command.
+test_files:
+- spec/tee_spec.rb