io-tee 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e3da8765f31c2824b74e39b12beb5b4c93db903fb9228e98b99d58755c07a07c
+  data.tar.gz: a911b94bb292901a963b404803b0eb5a141d0064724eb6bdf4d75cfda55dc165
+SHA512:
+  metadata.gz: f0685be0b8390895597146d053265e4cfbb19963c03d5961ff351c138fe2033c6c50f50c782b1bb3da879217e40d703b74a9770b71c001fb04a4974086905e60
+  data.tar.gz: ee8934914afb360f171e58b8b27ed604f05d6b338c5c7694a09f622d93f39c3770c6493e0e08413d820d2e6e9680e8d7828ba9ccdf12a2376ad24f59e6bb0608

data/.gitignore

@@ -0,0 +1,47 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+# .rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Style/Documenation:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ruby-io-tee.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Daniel Vartanov
+
+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,61 @@
+IO::Tee
+=======
+
+Copies stdout (or any other IO stream) contents to a file or another stream. Works with subprocesses too.
+
+### Example 1
+
+```ruby
+# io-tee-demo.rb
+require 'io/tee'
+
+$stdout.tee('output.log')
+
+puts "Hello, world!"
+```
+
+`$stdout` is effectively copied into file `output.log` **while still being streamed as a standard output**.
+
+```
+$ ruby io-tee-demo.rb
+Hello, world!
+
+$ cat output.log
+Hello, world!
+```
+
+
+### Example 2
+
+Obviously it works with more than one stream copied into the same file
+
+```ruby
+# io-tee-demo.rb
+require 'io/tee'
+
+$stdout.tee('full-output.log')
+$stderr.tee('full-output.log')
+
+puts 'Hello, world'
+$stderr.puts '[DEBUG] Debug info'
+```
+
+One can suppress stderr during execution but still get it logged into a file alongside stdout
+
+```
+$ ruby io-tee-demo.rb 2> /dev/null
+Hello, world
+
+$ cat full-output.log
+Hello, world
+[DEBUG] Debug info
+```
+
+Append or overwrite
+-------------------
+
+A keyword argument of `append: false` can be passed to the `IO#tee`
+method in order to overwrite the given file upon start of writing.
+
+
+Sponsored by [Veeqo](https://veeqo.com)

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ruby/io/tee"
+
+# 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/doc/why-sleep.md

@@ -0,0 +1,8 @@
+Why `sleep` is used in the code and in tests?
+=============================================
+
+`tee` is expected to complete processing of all available (buffered)
+data upon SIGTERM signal, but it doesn't do that, there is just no way
+to synchronise with the moment when all given input is processed,
+therefore the use of `sleep` is justified. It is the weakest spot of
+this gem, suggestions are obviously welcome.

data/lib/io/tee.rb

@@ -0,0 +1,21 @@
+require 'io/tee/version'
+
+module IO::Tee
+  def tee(filename, append: true)
+    append_argument = append ? '--append' : ''
+    tee_cmd = "tee #{append_argument} #{filename}"
+
+    tee_output, tee_input = IO.pipe
+    tee_pid = Process.spawn tee_cmd, in: tee_output, out: self
+
+    reopen(tee_input)
+
+    at_exit do
+      sleep 0.05 # see doc/why-sleep.md
+      Process.kill('TERM', tee_pid)
+      Process.waitpid(tee_pid)
+    end
+  end
+end
+
+IO.class_eval { include IO::Tee }

data/lib/io/tee/version.rb

@@ -0,0 +1,3 @@
+module IO::Tee
+  VERSION = "1.0.0"
+end

data/ruby-io-tee.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/io/tee/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "io-tee"
+  spec.version       = IO::Tee::VERSION
+  spec.authors       = ["Daniel Vartanov"]
+  spec.email         = ["dan@vartanov.net"]
+
+  spec.summary       = %q{Copies stdout (or any other IO stream) contents to a file or another stream. Works with subprocesses too.}
+  spec.homepage      = "https://github.com/DanielVartanov/ruby-io-tee"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/DanielVartanov/ruby-io-tee"
+  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.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'rspec', '~>3'
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: io-tee
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Daniel Vartanov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: 
+email:
+- dan@vartanov.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- doc/why-sleep.md
+- lib/io/tee.rb
+- lib/io/tee/version.rb
+- ruby-io-tee.gemspec
+homepage: https://github.com/DanielVartanov/ruby-io-tee
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/DanielVartanov/ruby-io-tee
+  source_code_uri: https://github.com/DanielVartanov/ruby-io-tee
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Copies stdout (or any other IO stream) contents to a file or another stream.
+  Works with subprocesses too.
+test_files: []