linebyline 1.0.0

data/.document

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

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ruby-head

data/Gemfile

@@ -0,0 +1,11 @@
+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 "bundler"
+  gem "jeweler", "~> 1.8.4"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Julik Tarkhanov
+
+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,49 @@
+= linebyline
+
+Facilitates the comparison of files and IO buffers in tests. It will report the exact differences per line and character offset, it will report if
+lines are too short or too long, and so on.
+
+To use, include it in Minitest or Test::Unit
+
+    include LineByLine::Assertions
+    
+    # ... and in one of your tests
+    def test_outputs_same
+      ref = File.open('ref_data.txt')
+      out = File.open('my_output.txt')
+      assert_same_buffer ref, out
+    end
+
+The Assertions module expects the following methods on the object it is included into:
+
+  flunk(message)
+  assert(boolean)
+  
+so you can retrofit it to your Testing Framework Du Jour. Or you can include LineByLine itself,
+and then use +compare_buffer!+ like so:
+  
+  include LineByLine
+  
+  # ... more tests
+  begin
+    compare_buffers! ref, out
+  rescue LineByLine::NotSame => mismatch
+    fail_test mismatch.message
+  end
+
+
+== Contributing to linebyline
+ 
+* 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) 2013 Julik Tarkhanov. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+Bundler.setup(:default, :development)
+
+require 'rake'
+require 'jeweler'
+require './lib/linebyline'
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "linebyline"
+  gem.version = LineByLine::VERSION
+  gem.homepage = "http://github.com/julik/linebyline"
+  gem.license = "MIT"
+  gem.summary = %Q{ Comparse two passed IO objects line by line (useful for tests) }
+  gem.description = %Q{ Can be used for comparing long outputs to references }
+  gem.email = "me@julik.nl"
+  gem.authors = ["Julik Tarkhanov"]
+  # 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
+
+task :default => :test

data/lib/linebyline.rb

@@ -0,0 +1,97 @@
+module LineByLine
+  
+  VERSION = '1.0.0'
+  
+  # The class that handles the actual checks between two lines
+  class Checker < Struct.new(:lineno, :ref_line, :output_line)
+    
+    attr_reader :failure
+    
+    def register_mismatches!
+      catch :fail do
+        if ref_line.nil? && output_line
+          fail! "Reference buffer ended, but the output still has data"
+        end
+      
+        if ref_line && output_line.nil?
+          fail! "Reference contains chars, while the output buffer ended"
+        end
+      
+        if ref_line != output_line
+          min_len = [ref_line.length, output_line.length].sort.shift
+          min_len.times do | offset |
+            if ref_line[offset..offset] != output_line[offset..offset]
+              fail! "Line mismatch at column #{offset + 1}"
+            end
+          end
+          fail! "Lines have different lengths (%d expected, but was %d)" % [ref_line.length, output_line.length]
+        end
+      end
+    end
+    
+    # Returns true if both lines are nil
+    def eof?
+      ref_line.nil? && output_line.nil?
+    end
+    
+    # Records the failure and the details on where it occurred in the buffer
+    # into the @failure ivar
+    def fail! with_message
+      full_message = [with_message + " at line #{lineno}"]
+      full_message << " + #{ref_line.inspect}"
+      full_message << " - #{output_line.inspect}"
+      
+      @failure = full_message.join("\n")
+      throw :fail
+    end
+  end
+  
+  class NotSame < RuntimeError
+  end
+  
+  # Compares two passed String or IO objects for equal content.
+  # If the contents does not match, a NotSame exception will be raised, and
+  # it's +NotSame#message+ will contain a very specific description of the mismatch,
+  # including the line number and offset into the line.
+  def compare_buffers!(expected, actual)
+    
+    if expected.object_id == actual.object_id
+      raise NotSame, /The passed IO objects were the same thing/
+    end
+    
+    # Wrap the passed strings in IOs if necessary
+    reference_io, io_under_test = [expected, actual].map do | str_or_io |
+      str_or_io.respond_to?(:gets) ? str_or_io : StringIO.new(str_or_io)
+    end
+    
+    # There are subtle differences in how IO is handled on dfferent platforms (Darwin)
+    lineno = 0
+    loop do
+      # Increment the line counter
+      lineno += 1
+      
+      checker = Checker.new(lineno, reference_io.gets, io_under_test.gets)
+      if checker.eof?
+        return
+      else
+        checker.register_mismatches!
+        raise NotSame, checker.failure if checker.failure
+      end
+    end
+  end 
+  
+  module Assertions
+    def self.included(into)
+      into.send(:include, LineByLine)
+    end
+    
+    def assert_same_buffer(ref_buffer, actual_buffer, message = "The line should be identical but was not")
+      begin
+        compare_buffers! ref_buffer, actual_buffer
+        assert true
+      rescue NotSame => e
+        flunk [message, e.message].join("\n")
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,15 @@
+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 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'linebyline'
+

data/test/test_assertions.rb

@@ -0,0 +1,34 @@
+require 'helper'
+require 'stringio'
+
+class TestAssertions < Test::Unit::TestCase
+  include LineByLine::Assertions
+  
+  def test_nothing_raises
+    assert_same_buffer "foo", "foo"
+  end
+  
+  class Refuter
+    include LineByLine::Assertions
+    
+    attr_reader :m
+    def flunk(m)
+      @m = m
+    end
+    
+    def perform
+      assert_same_buffer "foo\nbar\nbaz", "foo\nbar", "Total fail"
+    end
+  end
+  
+  def test_not_same
+    r = Refuter.new
+    message = 'Total fail
+Lines have different lengths (4 expected, but was 3) at line 2
+ + "bar\n"
+ - "bar"'
+
+    r.perform
+    assert_equal message, r.m
+  end
+end

data/test/test_linebyline.rb

@@ -0,0 +1,53 @@
+require 'helper'
+require 'stringio'
+
+class TestLinebyline < Test::Unit::TestCase
+  include LineByLine
+  
+  def test_nothing_raises
+    a = "foo"
+    ref = StringIO.new(a)
+    another = StringIO.new(a)
+    
+    compare_buffers! ref, another
+  end
+  
+  def test_works_with_string_and_io
+    assert_mismatch  'foo', 'foobar' do | msg |
+      assert_match /Lines have different lengths \(3 expected, but was 6\)/, msg
+    end
+  end
+  
+  def test_raises_on_mismatch
+    same = StringIO.new('dude')
+    assert_mismatch  same, same do | msg |
+      assert_match /The passed IO objects were the same thing/, msg
+    end
+    
+    assert_mismatch  StringIO.new("foo"), StringIO.new("bar") do | msg |
+      assert_match /Line mismatch at column 1 at line 1/, msg
+    end
+    
+    assert_mismatch  StringIO.new("foobar"), StringIO.new("foo") do | msg |
+      assert_match /Lines have different lengths \(6 expected, but was 3\) at line 1/, msg
+    end
+    
+    assert_mismatch  StringIO.new("foo"), StringIO.new("foobar") do | msg |
+      assert_match /Lines have different lengths \(3 expected, but was 6\) at line 1/, msg
+    end
+    
+    assert_mismatch  StringIO.new("foo\nbar\n"), StringIO.new("foo\nbar\nbaz") do | msg |
+      assert_match /Reference buffer ended, but the output still has data at line 3/, msg
+    end
+    
+  end
+  
+  def assert_mismatch(ref, output)
+    begin
+      compare_buffers! ref, output
+      flunk "These buffers are not the same and LineByLine should have raise"
+    rescue LineByLine::NotSame => e
+      yield e.message
+    end
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: linebyline
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Julik Tarkhanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+description: ! ' Can be used for comparing long outputs to references '
+email: me@julik.nl
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- lib/linebyline.rb
+- test/helper.rb
+- test/test_assertions.rb
+- test/test_linebyline.rb
+homepage: http://github.com/julik/linebyline
+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: '0'
+      segments:
+      - 0
+      hash: 2945154336957707059
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Comparse two passed IO objects line by line (useful for tests)
+test_files: []