zinzout 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 140303de5452b7727cff22f4a3e6d117df2d1a87b52815b4454b73186a19f4d3
+  data.tar.gz: 4c968b7ff19c1529ff4c0e084cbc127335b33ababa7ad0a07dc892d56ed07879
+SHA512:
+  metadata.gz: bf901312d7c814460b0e9b7cd20b5a45d541a258a4a86466db5a3ce4bffc31e605117e301b6b19a0d449631e7ebf32e98c1a4d6ab7c1b9e39240c574800355f6
+  data.tar.gz: a9cb9e292f27812aee680cd1413c30cf5b13cd2d455f73b87442d0602584533048720c133d33a8988f07056a898fa4c81c87e9af47d2667b4bcf703ba2a62727

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.idea
+*.iml
+.tool-versions

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in zinzout.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    zinzout (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  zinzout!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Bill Dueber
+
+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,66 @@
+# Zinzout
+
+`Zinzout` is a naïve wrapper that uses Zlib::Gzip[Reader/Writer] to make
+dealing with gzipped files a little easier.
+
+_Basically_:
+* When given a filename (and optionaly encoding), will attempt to open
+the appropriate file and correctly deal with gzippedness transparently
+* When given no filename, will simply return either STDIN or STDOUT
+
+## Examples
+
+```ruby
+
+# The following code should work no matter which filename is used
+
+# filename = nil # STDIN/STDOUT
+# filename = 'textfile.txt'
+filename = 'textfile.txt.gz'
+
+outfilename = 'results_' + filename unless filename.nil?
+
+infile = Zinzout.zin(filename, encoding: "utf-8")
+outfile = Zinzout.zout(outfilename) # "utf-8" is the default
+
+infile.each {|line| blah.blah }
+outfile.puts "All done!"
+
+# Much like using `File#open`, Zinzout will automatically close files
+# (but not STDIN/STDOUT!) if given a block
+
+Zinzout.zout(outfilename) do |outfile|
+  Zinzout.zin(filename) do |infile|
+    infile.each do |line|
+      outfile.puts(line)
+    end
+  end
+end
+
+```
+
+## Determining gzippedness
+
+`Zinzout` isn't smart. It's just convenient.
+
+* `Zinzout::zin`
+  * _No filename / filename.nil?_: STDIN
+  * _Filename (String or Pathname)_:
+    * Sniff the file to see if it's gzipped
+    * Return either a `Zlib::GzipReader` or a `File`
+* `Zinzout::zout`
+  * _No filename / filename.nil?_: STDOUT
+  * _Filename (String or Pathname) ends in .gz_: `Zlib::GzipWriter`
+  * _Filename does not end in .gz_: `File`
+  
+In particular, note that there's no attempt to sniff STDIN to see if
+it's gzipped, or to force compression before writing to STDOUT.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/billdueber/zinzout.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "zinzout"
+
+# 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/lib/zinzout.rb

@@ -0,0 +1,98 @@
+require "zinzout/version"
+require 'zlib'
+
+module Zinzout
+  class Error < StandardError; end
+
+  DEFAULT_ENCODING = "utf-8"
+
+  def self.zin(filename = nil, encoding: DEFAULT_ENCODING)
+    zin = Zin.new(filename, encoding)
+    if block_given?
+      yield zin.io
+      zin.close
+    end
+    zin.io
+  end
+
+  def self.zout(filename = nil, encoding: DEFAULT_ENCODING)
+    zout = Zout.new(filename, encoding)
+    if block_given?
+      yield zout.io
+      zout.close
+      nil
+    else
+      zout.io
+    end
+  end
+
+  class Zin
+    def self.new(filename, encoding)
+      if filename.nil?
+        ZinStdin.new
+      else
+        ZinFile.new(filename.to_s, encoding)
+      end
+    end
+  end
+
+  class Zout
+    def self.new(filename, encoding)
+      if filename.nil?
+        ZoutStdout.new
+      else
+        ZoutFile.new(filename.to_s, encoding)
+      end
+    end
+  end
+
+
+  class ZinFile
+    attr_reader :io
+
+    def initialize(filename, encoding)
+      @io = io_from_file(filename, encoding)
+    end
+
+    def io_from_file(filename, encoding)
+      Zlib::GzipReader.open(filename, encoding: encoding)
+    rescue Zlib::GzipFile::Error
+      ::File.open(filename, 'r', encoding: encoding)
+    end
+
+    def close
+      @io.close
+    end
+  end
+
+  class ZoutFile < ZinFile
+    def io_from_file(filename, encoding)
+      if /\.gz\Z/.match(filename)
+        Zlib::GzipWriter.open(filename, encoding: encoding)
+      else
+        File.open(filename, 'w', encoding: encoding)
+      end
+    end
+  end
+
+
+  class ZinStdin
+    attr_reader :io
+
+    def initialize
+      @io = STDIN
+    end
+
+    def close
+      # no op
+    end
+  end
+
+  class ZoutStdout < ZinStdin
+    def initialize
+      @io = STDOUT
+    end
+  end
+
+
+end

data/lib/zinzout/version.rb

@@ -0,0 +1,3 @@
+module Zinzout
+  VERSION = "0.1.0"
+end

data/zinzout.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/zinzout/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zinzout"
+  spec.version       = Zinzout::VERSION
+  spec.authors       = ["Bill Dueber"]
+  spec.email         = ["bill@dueber.com"]
+
+  spec.summary       = %q{Transparently open gzipped files for input/output}
+  spec.homepage      = "https://github.com/billdueber/zinzout"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage + '/CHANGELOG.md'
+
+  # 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"]
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: zinzout
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bill Dueber
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-29 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- bill@dueber.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/zinzout.rb
+- lib/zinzout/version.rb
+- zinzout.gemspec
+homepage: https://github.com/billdueber/zinzout
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/billdueber/zinzout
+  source_code_uri: https://github.com/billdueber/zinzout
+  changelog_uri: https://github.com/billdueber/zinzout/CHANGELOG.md
+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.3
+signing_key: 
+specification_version: 4
+summary: Transparently open gzipped files for input/output
+test_files: []