textfile 1.0.0.rc1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YWRjZWIwY2JmZDg5Zjg4N2RiOGU4OWJmZGNkZDdjNjI4ZDc4NzI2NA==
+  data.tar.gz: !binary |-
+    ODViYmEzN2Y1Zjg1YjI2NzM0OWU0YTI0NzU2YWU2YTllZWM3YWFmMw==
+SHA512:
+  metadata.gz: !binary |-
+    OGJlYjNhYTZhNWY5NGE5YzUxYzU3N2Y4YzM1NGRmYzczNDFmNDA0NDNlOWE4
+    ZGUxMWZhNDgxYmU0YjMwZjJhMjAxNWI5MmI3ODhlYWVkNWViMzNiNzA4M2Mx
+    OTY2ZGJjNzNmYjI2ZjhlYTkyNjk1MmVkNWU5MmRhYzRlYzZjNTQ=
+  data.tar.gz: !binary |-
+    NWEyMGFjZjA3OWM0YWE3MmMxZDUwMjQ1YjliZGMwYjEyYTFlNzg3NGY3OWU3
+    NzNiNTBiNGE5YWE4NTYxYTMxYTdlZDgyNmQ0NTI1ZGJjNjA0ODEzZjkxOTgx
+    NGVjZWUzNjVhMjNmMTQ3ZTJkNzg4MmQ0ZGQ1YjBjMjNhN2ZkMmE=

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+  gem "simplecov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,80 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.1.2)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    addressable (2.3.6)
+    builder (3.2.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    docile (1.1.5)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.7)
+    github_api (0.11.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.1)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 1.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.0)
+      oauth2
+    hashie (3.1.0)
+    highline (1.6.21)
+    i18n (0.6.9)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (1.0.0)
+    mini_portile (0.6.0)
+    minitest (5.3.5)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.2.1)
+      mini_portile (= 0.6.0)
+    oauth2 (0.9.4)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.3.2)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.1)
+    shoulda-matchers (2.6.1)
+      activesupport (>= 3.0.0)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    thread_safe (0.3.4)
+    tzinfo (1.2.1)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  jeweler (~> 2.0.1)
+  rdoc (~> 3.12)
+  shoulda
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Piers Chambers
+
+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.rdoc

@@ -0,0 +1,24 @@
+= textfile
+
+Provides a Set-like wrapper around GNU comm and related textfile utilities.  
+Method names are inspired by Set, though this is not an Enumerable class.
+
+On OS X see http://apple.stackexchange.com/questions/69223/how-to-replace-mac-os-x-utilities-with-gnu-core-utilities
+
+A common use case is to identify differences between exported datasets where the datasets may exceed 100K rows and each row may exceed 4K characters.
+
+== Contributing to textfile
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2014 Piers Chambers. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "textfile"
+  gem.homepage = "http://github.com/varyonic/textfile"
+  gem.license = "MIT"
+  gem.summary = %Q{Set-like wrapper around GNU comm and related textfile utilities.}
+  gem.description = %Q{A common use case is to identify differences between exported datasets where the datasets may exceed 100K rows and each row may exceed 4K characters.}
+  gem.email = "piers@varyonic.com"
+  gem.authors = ["Piers Chambers"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "textfile #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0.rc1

data/lib/textfile.rb

@@ -0,0 +1,85 @@
+require 'logger'
+require 'tempfile'
+
+class Textfile
+
+  attr_accessor :path, :logger
+
+  # options
+  # * +:bufsiz+ - Passed to GNU sort to optimize performance.
+  # * +:debug+ - Suppress deletion of temp files.
+  # * +:lang+ - Collation sequence.
+  # * +:logger+ - Logs shell commands and resulting ouput (default: STDOUT).
+  def initialize(path, options = {})
+    @bufize = options[:bufsiz]
+    @debug = options[:debug]
+    @lang = options[:lang]
+    @logger = options[:logger] || Logger.new(STDOUT)
+    @path = path
+  end
+
+  # Removes all records.
+  def clear
+    sh "cat /dev/null > #{@path}"
+  end
+
+  # Removes records not present in other textfile.
+  def intersection(textfile)
+    comm(textfile, '-12')
+  end
+
+  # Merges the contents of other textfiles and returns self.
+  def merge(*textfiles)
+    sh "cat #{textfiles.map(&:path).join(' ')} >> #{@path}"
+    self.sort
+  end
+
+  # Remove records present in other textfile.
+  def subtract(textfile)
+    # --nocheck-order, see https://bugzilla.redhat.com/show_bug.cgi?id=1001775
+    comm(textfile, '--nocheck-order -23')
+  end
+
+  protected
+  # OS X comm can't handle lines > 2K bytes.
+  # See http://apple.stackexchange.com/questions/69223/how-to-replace-mac-os-x-utilities-with-gnu-core-utilities
+  def comm_cmd() (RUBY_PLATFORM =~ /darwin/ ? 'gcomm' : 'comm') end
+  def sort_cmd() (RUBY_PLATFORM =~ /darwin/ ? 'gsort' : 'sort') end
+  def uniq_cmd() (RUBY_PLATFORM =~ /darwin/ ? 'guniq' : 'uniq') end
+
+  def comm(textfile, options)
+    self.sort
+    textfile.sort
+    with_tempcopy do |tempcopy|
+      sh "#{comm_cmd} #{options} #{tempcopy} #{textfile.path} > #{@path}"
+    end
+  end
+
+  def sh(cmd)
+    cmd = "export LC_COLLATE=#{@lang}; #{cmd}" if @lang
+    logger.info cmd;
+    logger.info %x[ #{cmd} ] # TODO: capture $?
+    self
+  end
+
+  # Sorts file and removes any duplicate records.
+  def sort
+    return self if sorted
+    options = "--buffer-size=#{@bufsiz}" if @bufsiz
+    with_tempcopy do |tempcopy|
+      sh "#{sort_cmd} #{options} #{tempcopy} | #{uniq_cmd} > #{@path}"
+    end
+    @sorted = true
+    self
+  end
+  attr_accessor :sorted
+
+  def with_tempcopy
+    tempcopy = Tempfile.new(['temp-','.txt'])
+    tempcopy.write(File.read(@path))
+    tempcopy.close
+    yield tempcopy.path
+    tempcopy.unlink unless @debug
+    self
+  end
+end

data/test/helper.rb

@@ -0,0 +1,32 @@
+require 'simplecov'
+
+module SimpleCov::Configuration
+  def clean_filters
+    @filters = []
+  end
+end
+
+SimpleCov.configure do
+  clean_filters
+  load_profile 'test_frameworks'
+end
+
+ENV["COVERAGE"] && SimpleCov.start do
+  add_filter "/.rvm/"
+end
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require "minitest/autorun"
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'textfile'
+

data/test/test_textfile.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+require 'helper'
+
+class TestTextfile < Minitest::Test
+  def infile(*records)
+    file = Tempfile.new(self.class.name)
+    file.puts(records)
+    file.close
+    Textfile.new(file.path)
+  end
+
+  should "clear a file" do
+    textfile = infile('3','2','1')
+
+    textfile.clear
+
+    file = File.open(textfile.path)
+    assert_equal([], file.read.split)
+  end
+
+  should "find the intersection of two datasets" do
+    tf1 = infile('3','2','1','b')
+    tf2 = infile('c','b','a','2')
+
+    tf1.intersection(tf2)
+
+    file = File.open(tf1.path)
+    assert_equal(['2','b'], file.read.split)
+  end
+
+  should "merge two datasets" do
+    tf1 = infile('3','2','1','b')
+    tf2 = infile('c','b','a','2')
+
+    tf1.merge(tf2)
+
+    file = File.open(tf1.path)
+    assert_equal(['1','2','3','a','b','c'], file.read.split)
+  end
+
+  should "sort a simple file" do
+    textfile = infile(['3','2','1'])
+
+    textfile.send :sort
+
+    file = File.open(textfile.path)
+    assert_equal(file.read.split, ['1', '2', '3'])
+  end
+
+  should "sort a file with very long records" do
+    textfile = infile('3'*9999,'2','1')
+
+    textfile.send :sort
+
+    file = File.open(textfile.path)
+    assert_equal(file.read.split, ['1', '2', '3'*9999])
+  end
+
+  should "sort non-ASCII characters" do
+    textfile = infile('Muffler','MX Systems','Müller','MySQL')
+
+    textfile.send :sort
+
+    file = File.open(textfile.path, external_encoding: 'UTF-8')
+    assert_equal(file.read.split("\n"), ["MX Systems", "Muffler", "MySQL", "Müller"])
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: textfile
+version: !ruby/object:Gem::Version
+  version: 1.0.0.rc1
+platform: ruby
+authors:
+- Piers Chambers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  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: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !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: A common use case is to identify differences between exported datasets
+  where the datasets may exceed 100K rows and each row may exceed 4K characters.
+email: piers@varyonic.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/textfile.rb
+- test/helper.rb
+- test/test_textfile.rb
+homepage: http://github.com/varyonic/textfile
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Set-like wrapper around GNU comm and related textfile utilities.
+test_files: []