assert_dirs_equal 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: daf396e81ffce0b83fd79a9218cf036385b0c695
+  data.tar.gz: 000fafee50178f01fd58bc5da8cb01948091f592
+SHA512:
+  metadata.gz: 5396b72a55da522376094401f159b0ef3bc46e96503532c8e3d766132e4ac44bb5e7935903e19d7c4777e722e955a132a2e19388f81e08b47bc512d7045a0737
+  data.tar.gz: caff9934d55bb2000b8b4059ab0e339b86491ad91db47f5a27934a17539c4bf951411dd8eee3852e47730fbe03eb55cdc64996f6b62bd1d203968c838f681cd2

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - jruby-19mode
+  - rbx-2
+bundler_args: --without doc debug

data/.yardopts

@@ -0,0 +1 @@
+--no-private

data/CHANGELOG.md

@@ -0,0 +1 @@
+## Unreleased

data/CONTRIBUTING.md

@@ -0,0 +1,47 @@
+# Contributing
+
+## Adding a feature
+
+1. Open an issue and explain what you're planning to do. It is better to discuss new idea first,
+   rather when diving into code.
+2. Add some tests.
+3. Write the code.
+4. Make sure all tests pass.
+5. Commit with detailed explanation what you've done in a message.
+6. Open pull request.
+
+## Breaking/removing a feature
+
+1. Add deprecation warning and fallback to old behaivour if possible.
+2. Explain how to migrate to the new code in CHANGELOG.
+3. Update/remove tests.
+4. Update the code.
+5. Make sure all tests pass.
+6. Commit with detailed explanation what you've done in a message.
+7. Open pull request.
+
+## Fixing a bug
+
+1. Add failing test.
+2. Fix the bug.
+3. Make sure all tests pass.
+4. Commit with detailed explanation what you've done in a message.
+5. Open pull request.
+
+## Fixing a typo
+
+1. Commit with a message that include "[ci skip]" remark.
+2. Open pull request.
+
+## Running the tests
+
+```
+rake test
+```
+
+## Working with documentation
+
+```
+yard server -dr
+open http://localhost:8808
+```

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem "pry", :group => :debug
+gem "yard", "~> 0.8", :group => :doc

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Andrii Malyshko
+
+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,66 @@
+# AssertDirsEqual
+
+[![Build Status](https://img.shields.io/travis/torba-rb/assert_dirs_equal.svg)](https://travis-ci.org/torba-rb/assert_dirs_equal)
+[![Gem version](https://img.shields.io/gem/v/assert_dirs_equal.svg)](https://rubygems.org/gems/assert_dirs_equal)
+
+**AssertDirsEqual** is a test framework-agnostic expectation/assertion for directories equality
+by tree and content comparison.
+
+## Status
+
+Production ready.
+
+## Documentation
+
+[Released version](http://rubydoc.info/gems/assert_dirs_equal/0.1.0)
+
+## Why
+
+Sometimes it is easier to commit expected directory structure and compare it with a directory
+created by a method under test.
+
+If you prefer DSL-like expectations, see [minitest-filesystem][minitest-filesystem].
+
+## Installation
+
+Add this line to your application's Gemfile and run `bundle`:
+
+```ruby
+gem 'assert_dirs_equal', require: false
+```
+## Usage
+
+```ruby
+class MyWriter
+  def self.perform
+    File.write("/tmp/my_writer/result.txt", "Hello world!")
+  end
+end
+
+```
+
+Create a file "result.txt" with "Hello world!" in "test/fixtures/case01".
+
+### Minitest
+
+```ruby
+require 'minitest/assert_dirs_equal'
+
+class MyWriterTest < Minitest::Test
+  def test_perform
+    MyWriter.perform
+    assert_dirs_equal "test/fixtures/case01", "/tmp/my_writer"
+  end
+end
+```
+
+### RSpec
+
+TODO
+
+## Origin
+
+Extracted from [Torba][torba-github] library since it looks more like a standalone component.
+
+[minitest-filesystem]: https://github.com/stefanozanella/minitest-filesystem
+[torba-github]: https://github.com/torba-rb/torba

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+task :default => :test
+task :test do
+  $LOAD_PATH.unshift("test")
+  Dir.glob("./test/**/*_test.rb").each { |file| require file}
+end

data/assert_dirs_equal.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |spec|
+  spec.name          = "assert_dirs_equal"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Andrii Malyshko"]
+  spec.email         = ["mail@nashbridges.me"]
+  spec.description   = "Test assertion for directories equality by tree and content comparison"
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/torba-rb/assert_dirs_equal"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.4"
+end

data/lib/assert_dirs_equal/matcher.rb

@@ -0,0 +1,95 @@
+# @since 0.1.0
+module AssertDirsEqual
+  class Diff
+    # @return [String] human readable diff between `expected` and `actual`.
+    # @abstract Reuse existing test framework diff functionality to override this method.
+    def self.perform(expected, actual)
+      "Expected: #{expected.inspect}\n  Actual: #{actual.inspect}"
+    end
+  end
+
+  # Confirms with RSpec3 custom matcher protocol.
+  # @see https://github.com/rspec/rspec-expectations/blob/3-0-maintenance/lib/rspec/matchers.rb#L130
+  class Matcher
+    # @return [String]
+    attr_reader :failure_message
+
+    def initialize(expected)
+      @expected = expected
+    end
+
+    # @return [true] if `target` mirrors subdirectory of `expected` directory.
+    # @return [false] if `target` lacks some files, or has extra files, or any file in subdirectory differs from according file content.
+    def matches?(target)
+      @target = target
+      assert_exists(@expected) && assert_exists(@target) &&
+        assert_directory(@expected) && assert_directory(@target) &&
+        assert_target_contains_all_expected_entries &&
+        refute_extra_files_in_target
+    end
+
+    # @return [String]
+    def failure_message_when_negated
+      "expected #{@target.inspect} to not be equal to #{@expected.inspect}, but they are equal"
+    end
+
+    private
+
+    def assert_exists(path, msg = nil)
+      File.exist?(path) || fail_with(msg || "expected #{path.inspect} to exist")
+    end
+
+    def assert_directory(directory)
+      File.directory?(directory) || fail_with("expected #{directory.inspect} to be a directory")
+    end
+
+    def assert_equal_content(expected, target)
+      return true if File.directory?(expected) && File.directory?(target)
+
+      expected_content = File.read(expected).strip
+      target_content = File.read(target).strip
+
+      expected_content == target_content || fail_with(
+        "expected #{target.inspect} to have same content as #{expected.inspect}:\n#{Diff.perform(expected_content, target_content)}"
+      )
+    rescue ArgumentError # strip on binary file
+      expected_size = File.size(expected)
+      target_size = File.size(target)
+
+      expected_size == target_size || fail_with(
+        "expected #{target.inspect} to be the same size as #{expected.inspect}"
+      )
+    end
+
+    def assert_target_contains_all_expected_entries
+      both_paths_in(@expected, @target).all? do |expected_path, target_path|
+        exists_msg = "expected #{target_path.inspect} to exist since #{expected_path.inspect} exists"
+        assert_exists(target_path, exists_msg) && assert_equal_content(expected_path, target_path)
+      end
+    end
+
+    def refute_extra_files_in_target
+      expected_files = both_paths_in(@expected, @target).map { |pair| pair[1] }
+      actual_expected_files = Dir.glob(File.join(@target, "**/*"))
+      diff = actual_expected_files - expected_files
+      diff.empty? || fail_with("found unexpected files #{diff.inspect}")
+    end
+
+    def fail_with(message)
+      @failure_message = message
+      false
+    end
+
+    def both_paths_in(expected, target)
+      Enumerator.new do |y|
+        glob = File.join(expected, "**/*")
+        Dir.glob(glob).each do |expected_full_path|
+          path = expected_full_path.sub(expected, "")
+          target_full_path = File.join(target, path)
+          y << [expected_full_path, target_full_path]
+        end
+      end
+    end
+  end
+end
+

data/lib/minitest/assert_dirs_equal.rb

@@ -0,0 +1,24 @@
+require "minitest"
+require "assert_dirs_equal/matcher"
+
+module AssertDirsEqual
+  class Diff
+    extend Minitest::Assertions
+
+    def self.perform(expected, actual)
+      diff(expected, actual)
+    end
+  end
+end
+
+class Minitest::Test
+  def assert_dirs_equal(expected, target)
+    matcher = AssertDirsEqual::Matcher.new(expected)
+    assert matcher.matches?(target), matcher.failure_message
+  end
+
+  def refute_dirs_equal(expected, target)
+    matcher = AssertDirsEqual::Matcher.new(expected)
+    refute matcher.matches?(target), matcher.failure_message_when_negated
+  end
+end

data/test/cases/binary_and_text_files/expected/file.txt

@@ -0,0 +1 @@
+hello

data/test/cases/different_text_files/expected/file

@@ -0,0 +1 @@
+hello

data/test/cases/different_text_files/target/file

@@ -0,0 +1 @@
+world

data/test/cases/large_different_text_files/expected/file

@@ -0,0 +1,19 @@
+minitest
+minitest
+minitest
+minitest
+minitest
+minitest
+minitest
+minitest
+minitest
+minitest
+minitest
+minitest
+minitest
+minitest
+minitest
+minitest
+minitest
+minitest
+minitest

data/test/cases/large_different_text_files/target/file

@@ -0,0 +1,19 @@
+minitest
+minitest
+minitest
+minitest
+minitest
+minitest
+minitest
+minitest
+minitest
+minitest
+minitest
+minitest
+minitest
+rspec
+minitest
+minitest
+minitest
+minitest
+minitest

data/test/cases/same_text_files/expected/file

@@ -0,0 +1 @@
+hello

data/test/cases/same_text_files/target/file

@@ -0,0 +1 @@
+hello

data/test/matcher_test.rb

@@ -0,0 +1,106 @@
+require "test_helper"
+require "assert_dirs_equal/matcher"
+
+module AssertDirsEqual
+  class MatcherTest < Minitest::Test
+    def matcher
+      @matcher ||= Matcher.new(expected_dir)
+    end
+
+    def test_missing_expected
+      @case_directory = "test/cases/missing_expected"
+      refute matcher.matches?(target_dir)
+      assert_equal "expected \"#{expected_dir}\" to exist", matcher.failure_message
+    end
+
+    def test_missing_target
+      @case_directory = "test/cases/missing_target"
+      refute matcher.matches?(target_dir)
+      assert_equal "expected \"#{target_dir}\" to exist", matcher.failure_message
+    end
+
+    def test_expected_is_not_a_dir
+      @case_directory = "test/cases/expected_is_not_a_dir"
+      refute matcher.matches?(target_dir)
+      assert_equal "expected \"#{expected_dir}\" to be a directory", matcher.failure_message
+    end
+
+    def test_target_is_not_a_dir
+      @case_directory = "test/cases/target_is_not_a_dir"
+      refute matcher.matches?(target_dir)
+      assert_equal "expected \"#{target_dir}\" to be a directory", matcher.failure_message
+    end
+
+    def test_empty_dirs_are_equal
+      @case_directory = "test/cases/empty_dirs_are_equal"
+      assert matcher.matches?(target_dir), matcher.failure_message
+    end
+
+    def test_missing_file_in_target
+      @case_directory = "test/cases/missing_file_in_target"
+      refute matcher.matches?(target_dir)
+      assert_equal "expected \"#{target_dir}/file\" to exist since \"#{expected_dir}/file\" exists", matcher.failure_message
+    end
+
+    def test_missing_directory_in_target
+      @case_directory = "test/cases/missing_directory_in_target"
+      refute matcher.matches?(target_dir)
+      assert_equal "expected \"#{target_dir}/directory\" to exist since \"#{expected_dir}/directory\" exists", matcher.failure_message
+    end
+
+    def test_missing_nested_file_in_target
+      @case_directory = "test/cases/missing_nested_file_in_target"
+      refute matcher.matches?(target_dir)
+      assert_equal "expected \"#{target_dir}/nested/file\" to exist since \"#{expected_dir}/nested/file\" exists", matcher.failure_message
+    end
+
+    def test_empty_files_are_equal
+      @case_directory = "test/cases/empty_files_are_equal"
+      assert matcher.matches?(target_dir), matcher.failure_message
+    end
+
+    def test_different_text_files
+      @case_directory = "test/cases/different_text_files"
+      refute matcher.matches?(target_dir)
+      assert_equal <<MSG.strip, matcher.failure_message
+expected "#{target_dir}/file" to have same content as "#{expected_dir}/file":
+Expected: "hello"
+  Actual: "world"
+MSG
+    end
+
+    def test_same_text_files
+      @case_directory = "test/cases/same_text_files"
+      assert matcher.matches?(target_dir), matcher.failure_message
+    end
+
+    def test_different_binary_files
+      @case_directory = "test/cases/different_binary_files"
+      refute matcher.matches?(target_dir)
+      assert_equal "expected \"#{target_dir}/file.png\" to be the same size as \"#{expected_dir}/file.png\"", matcher.failure_message
+    end
+
+    def test_same_binary_files
+      @case_directory = "test/cases/same_binary_files"
+      assert matcher.matches?(target_dir), matcher.failure_message
+    end
+
+    def test_binary_and_text_files
+      @case_directory = "test/cases/binary_and_text_files"
+      refute matcher.matches?(target_dir)
+      assert_equal "expected \"#{target_dir}/file.txt\" to be the same size as \"#{expected_dir}/file.txt\"", matcher.failure_message
+    end
+
+    def test_extra_file_in_target
+      @case_directory = "test/cases/extra_file_in_target"
+      refute matcher.matches?(target_dir)
+      assert_equal "found unexpected files [\"#{target_dir}/file\"]", matcher.failure_message
+    end
+
+    def test_failure_message_negated
+      @case_directory = "test/cases/empty_dirs_are_equal"
+      matcher.matches?(target_dir)
+      assert_equal "expected \"#{target_dir}\" to not be equal to \"#{expected_dir}\", but they are equal", matcher.failure_message_when_negated
+    end
+  end
+end

data/test/minitest_integration_test.rb

@@ -0,0 +1,59 @@
+require "test_helper"
+require "minitest/assert_dirs_equal"
+
+module AssertDirsEqual
+  class MinitestIntegrationTest < Minitest::Test
+    def test_successful_assert
+      @case_directory = "test/cases/empty_dirs_are_equal"
+      assert_dirs_equal expected_dir, target_dir
+    end
+
+    def test_failed_assert
+      @case_directory = "test/cases/missing_expected"
+
+      error = assert_raises(Minitest::Assertion) do
+        assert_dirs_equal expected_dir, target_dir
+      end
+
+      assert_equal "expected \"#{expected_dir}\" to exist", error.message
+    end
+
+    def test_successful_refute
+      @case_directory = "test/cases/missing_expected"
+      refute_dirs_equal expected_dir, target_dir
+    end
+
+    def test_failed_refute
+      @case_directory = "test/cases/empty_dirs_are_equal"
+
+      error = assert_raises(Minitest::Assertion) do
+        refute_dirs_equal expected_dir, target_dir
+      end
+
+      assert_equal "expected \"#{target_dir}\" to not be equal to \"#{expected_dir}\", but they are equal", error.message
+    end
+
+    def test_minitest_powered_diff
+      @case_directory = "test/cases/large_different_text_files"
+
+      error = assert_raises(Minitest::Assertion) do
+        assert_dirs_equal expected_dir, target_dir
+      end
+
+      assert_equal <<MSG, error.message
+expected "#{target_dir}/file" to have same content as "#{expected_dir}/file":
+--- expected
++++ actual
+@@ -11,7 +11,7 @@
+ minitest
+ minitest
+ minitest
+-minitest
++rspec
+ minitest
+ minitest
+ minitest
+MSG
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+require "bundler/setup"
+require "minitest/autorun"
+
+class Minitest::Test
+  def expected_dir
+    File.join(@case_directory, "expected")
+  end
+
+  def target_dir
+    File.join(@case_directory, "target")
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: assert_dirs_equal
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrii Malyshko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+description: Test assertion for directories equality by tree and content comparison
+email:
+- mail@nashbridges.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- assert_dirs_equal.gemspec
+- lib/assert_dirs_equal/matcher.rb
+- lib/minitest/assert_dirs_equal.rb
+- test/cases/binary_and_text_files/expected/file.txt
+- test/cases/binary_and_text_files/target/file.txt
+- test/cases/different_binary_files/expected/file.png
+- test/cases/different_binary_files/target/file.png
+- test/cases/different_text_files/expected/file
+- test/cases/different_text_files/target/file
+- test/cases/empty_files_are_equal/expected/file
+- test/cases/empty_files_are_equal/target/file
+- test/cases/expected_is_not_a_dir/expected
+- test/cases/extra_file_in_target/target/file
+- test/cases/large_different_text_files/expected/file
+- test/cases/large_different_text_files/target/file
+- test/cases/missing_file_in_target/expected/file
+- test/cases/missing_nested_file_in_target/expected/nested/file
+- test/cases/same_binary_files/expected/file.png
+- test/cases/same_binary_files/target/file.png
+- test/cases/same_text_files/expected/file
+- test/cases/same_text_files/target/file
+- test/cases/target_is_not_a_dir/target
+- test/matcher_test.rb
+- test/minitest_integration_test.rb
+- test/test_helper.rb
+homepage: https://github.com/torba-rb/assert_dirs_equal
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Test assertion for directories equality by tree and content comparison
+test_files:
+- test/cases/binary_and_text_files/expected/file.txt
+- test/cases/binary_and_text_files/target/file.txt
+- test/cases/different_binary_files/expected/file.png
+- test/cases/different_binary_files/target/file.png
+- test/cases/different_text_files/expected/file
+- test/cases/different_text_files/target/file
+- test/cases/empty_files_are_equal/expected/file
+- test/cases/empty_files_are_equal/target/file
+- test/cases/expected_is_not_a_dir/expected
+- test/cases/extra_file_in_target/target/file
+- test/cases/large_different_text_files/expected/file
+- test/cases/large_different_text_files/target/file
+- test/cases/missing_file_in_target/expected/file
+- test/cases/missing_nested_file_in_target/expected/nested/file
+- test/cases/same_binary_files/expected/file.png
+- test/cases/same_binary_files/target/file.png
+- test/cases/same_text_files/expected/file
+- test/cases/same_text_files/target/file
+- test/cases/target_is_not_a_dir/target
+- test/matcher_test.rb
+- test/minitest_integration_test.rb
+- test/test_helper.rb
+has_rdoc: