rspec-match_ignoring_whitespace 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ad3b8354fd617b6a2db5a077cfa3b1c49ab2394f6d481e722d5158013ae378b7
+  data.tar.gz: acfabac792eee53f6f9f7ec4ee1c19498815a3e7524553fe1735845e9931f398
+SHA512:
+  metadata.gz: bebec84b9e47ae4b9db953703125bc23e017a5bdd3ae90ce6724b207bc9c48fd3c7df8c61d546a66fc651a4c95a755dc9f6eee860c41ac137779259746c93c90
+  data.tar.gz: 72a52d8d2b77a41d27ba668cb8d59769de5d2c329e06def7503b3ea28a3530e69f36c68dcb26c430fa9021b3fc6206e8950dd9c5d3f0d72c603eac641f0a5e21

data/.gitignore

@@ -0,0 +1,9 @@
+.*.swp
+.*.swo
+/.ruby-version
+/.ruby-gemset
+/pkg
+/tmp
+/README.html
+/coverage
+/Gemfile.lock

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,43 @@
+Metrics/BlockLength:
+  Enabled: false
+Metrics/LineLength:
+  Exclude:
+    - "Rakefile"
+  Max: 120
+
+Metrics/MethodLength:
+  Exclude:
+    - "spec/**/*"
+  Max: 35
+Style/BlockDelimiters:
+  EnforcedStyle: line_count_based
+  Exclude:
+    - "spec/**/*"
+
+Style/Documentation:
+  Exclude:
+    - "spec/**/*"
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    "%w": "[]"
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/ExpandPathArguments:
+  Enabled: false
+
+Gemspec/OrderedDependencies:
+  Enabled: false
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Layout/IndentHeredoc:
+  Enabled: false
+
+Style/Encoding:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+  - 1.9
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+  - jruby
+
+matrix:
+  include:
+  # Only run rubocop on the latest Ruby:
+  - rvm: 2.5
+    env: SUITE="rubocop"

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2018 Paul A. Jungwirth
+
+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,86 @@
+rspec-match_ignoring_whitespace
+===============================
+
+[![Build Status](https://travis-ci.org/pjungwir/rspec-match_ignoring_whitespace.svg?branch=master)](https://travis-ci.org/pjungwir/rspec-match_ignoring_whitespace)
+
+RSpec matcher to compare strings ignoring (most) whitespace.
+
+First we convert all adjacent whitespace to a single space, including tabs, newlines, form feeds, non-breaking spaces, etc.
+Then we also strip whitespace from the beginning and end.
+Finally we compare the results for equality.
+
+This gem borrows almost everything from [`rspec-match_fuzzy`](https://github.com/winebarrel/rspec-match_fuzzy/),
+except the comparison algorithm is just a bit different.
+
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-match_fuzzy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-match_fuzzy
+
+
+Usage
+-----
+
+```ruby
+s1 = "πόλλ΄ οἶδ΄ ἀλώπηξ, ἀλλ΄ ἐχῖνος ἓν μέγα."
+s2 = <<-EOF
+  πόλλ΄ οἶδ΄ ἀλώπηξ,
+  ἀλλ΄ ἐχῖνος ἓν μέγα.
+EOF
+expect(s1).to match_ignoring_whitespace(s2)
+```
+
+
+TODO
+----
+
+I can imagine a few variations of our comparison algorithm being useful:
+
+  - Instead of replacing whitespace with a single space, just remove it completely.
+  - Don't strip off the leading/trailing space.
+
+If anyone out there wants those features, let me know! :-)
+
+
+Tests
+-----
+
+Say `rake` to run rspec tests plus Rubocop,
+or `rspec spec` to run just the tests.
+
+
+Contributing
+------------
+ 
+* 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 hasn't already requested and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make be 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, that is fine, but please isolate that change to its own commit so I can cherry-pick around it.
+
+Commands for building/releasing/installing:
+
+* `rake build`
+* `rake install`
+* `rake release`
+
+Copyright
+---------
+
+Copyright (c) 2018 Paul A. Jungwirth.
+See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task readme: [] do
+  system %q{jq --slurp --raw-input '{"text": "\(.)", "mode": "gfm", "context": "pjungwir/rspec-match_ignoring_whitespace"}' < README.md | curl --data @- https://api.github.com/markdown > README.html}
+end
+
+if ENV['CI'].nil?
+  task default: %w[spec rubocop]
+else
+  case ENV['SUITE']
+  when 'rubocop' then task default: :rubocop
+  else                task default: :spec
+  end
+end

data/lib/rspec/match_ignoring_whitespace.rb

@@ -0,0 +1,30 @@
+require 'rspec'
+
+RSpec::Matchers.define :match_ignoring_whitespace do |expected|
+  expected = expected.to_s
+
+  match do |actual|
+    actual = actual.to_s
+    actual.gsub(/[\n[[:blank:]]]+/, ' ').strip == expected.gsub(/[\n[[:blank:]]]+/, ' ').strip
+  end
+
+  failure_message do |actual|
+    actual = actual.to_s
+    actual_normalized   = actual.gsub(/[\n[[:blank:]]]+/, ' ').strip
+    expected_normalized = expected.gsub(/[\n[[:blank:]]]+/, ' ').strip
+
+    message = <<-EOF.strip
+expected: #{expected_normalized.inspect}
+     got: #{actual_normalized.inspect}
+    EOF
+
+    diff = RSpec::Expectations.differ.diff(actual_normalized, expected_normalized)
+
+    unless diff.strip.empty?
+      diff_label = RSpec::Matchers::ExpectedsForMultipleDiffs::DEFAULT_DIFF_LABEL
+      message << "\n\n" << diff_label << diff
+    end
+
+    message
+  end
+end

data/lib/rspec/match_ignoring_whitespace/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module MatchIgnoringWhitespace
+    VERSION = '1.0.0'.freeze
+  end
+end

data/rspec-match_ignoring_whitespace.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/match_ignoring_whitespace/version'
+
+Gem::Specification.new do |s|
+  s.name = 'rspec-match_ignoring_whitespace'
+  s.version = RSpec::MatchIgnoringWhitespace::VERSION
+
+  s.summary = 'RSpec matcher to compare strings ignoring whitespace'
+  s.description = 'RSpec matcher to compare strings ignoring whitespace'
+
+  s.authors = ['Paul A. Jungwirth']
+  s.homepage = 'https://github.com/pjungwir/rspec-match_ignoring_whitespace'
+  s.email = ['pj@illuminatedcomputing.com']
+
+  s.licenses = ['MIT']
+
+  s.require_paths = ['lib']
+  s.executables = []
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,fixtures}/*`.split("\n")
+
+  s.add_dependency 'rspec', '>= 3.2.0'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'rubocop'
+end

data/spec/match_ignoring_whitespace_spec.rb

@@ -0,0 +1,65 @@
+# encoding: utf-8
+
+describe 'match_ignoring_whitespace' do
+
+  let(:expected) { "πόλλ΄ οἶδ΄ ἀλώπηξ, ἀλλ΄ ἐχῖνος ἓν μέγα." }
+
+  context "matches" do
+    specify 'an identical string' do
+      expect("πόλλ΄ οἶδ΄ ἀλώπηξ, ἀλλ΄ ἐχῖνος ἓν μέγα.").to match_ignoring_whitespace expected
+    end
+    specify 'a string with newlines' do
+      expect("πόλλ΄ οἶδ΄ ἀλώπηξ,\nἀλλ΄ ἐχῖνος ἓν μέγα.").to match_ignoring_whitespace expected
+      expect("πόλλ΄ οἶδ΄ ἀλώπηξ,\n\nἀλλ΄ ἐχῖνος ἓν μέγα.").to match_ignoring_whitespace expected
+      expect("πόλλ΄ οἶδ΄ ἀλώπηξ, \nἀλλ΄ ἐχῖνος ἓν μέγα.").to match_ignoring_whitespace expected
+      expect("πόλλ΄ οἶδ΄ ἀλώπηξ, \n ἀλλ΄ ἐχῖνος ἓν μέγα.").to match_ignoring_whitespace expected
+    end
+    specify 'a string with leading whitespace' do
+      expect(" πόλλ΄ οἶδ΄ ἀλώπηξ, ἀλλ΄ ἐχῖνος ἓν μέγα.").to match_ignoring_whitespace expected
+      expect("  πόλλ΄ οἶδ΄ ἀλώπηξ, ἀλλ΄ ἐχῖνος ἓν μέγα.").to match_ignoring_whitespace expected
+      expect("\tπόλλ΄ οἶδ΄ ἀλώπηξ, ἀλλ΄ ἐχῖνος ἓν μέγα.").to match_ignoring_whitespace expected
+      expect("\nπόλλ΄ οἶδ΄ ἀλώπηξ, ἀλλ΄ ἐχῖνος ἓν μέγα.").to match_ignoring_whitespace expected
+      expect("\n\nπόλλ΄ οἶδ΄ ἀλώπηξ, ἀλλ΄ ἐχῖνος ἓν μέγα.").to match_ignoring_whitespace expected
+      expect("\t πόλλ΄ οἶδ΄ ἀλώπηξ, ἀλλ΄ ἐχῖνος ἓν μέγα.").to match_ignoring_whitespace expected
+      expect(" \tπόλλ΄ οἶδ΄ ἀλώπηξ, ἀλλ΄ ἐχῖνος ἓν μέγα.").to match_ignoring_whitespace expected
+    end
+    specify 'a string with trailing whitespace' do
+      expect("πόλλ΄ οἶδ΄ ἀλώπηξ, ἀλλ΄ ἐχῖνος ἓν μέγα. ").to match_ignoring_whitespace expected
+      expect("πόλλ΄ οἶδ΄ ἀλώπηξ, ἀλλ΄ ἐχῖνος ἓν μέγα.  ").to match_ignoring_whitespace expected
+      expect("πόλλ΄ οἶδ΄ ἀλώπηξ, ἀλλ΄ ἐχῖνος ἓν μέγα.\t").to match_ignoring_whitespace expected
+      expect("πόλλ΄ οἶδ΄ ἀλώπηξ, ἀλλ΄ ἐχῖνος ἓν μέγα.\n").to match_ignoring_whitespace expected
+      expect("πόλλ΄ οἶδ΄ ἀλώπηξ, ἀλλ΄ ἐχῖνος ἓν μέγα.\n\n").to match_ignoring_whitespace expected
+      expect("πόλλ΄ οἶδ΄ ἀλώπηξ, ἀλλ΄ ἐχῖνος ἓν μέγα.\t ").to match_ignoring_whitespace expected
+      expect("πόλλ΄ οἶδ΄ ἀλώπηξ, ἀλλ΄ ἐχῖνος ἓν μέγα. \t").to match_ignoring_whitespace expected
+    end
+    specify 'a string with extra whitespace' do
+      expect("πόλλ΄ οἶδ΄ ἀλώπηξ,  ἀλλ΄ ἐχῖνος ἓν μέγα.").to match_ignoring_whitespace expected
+      expect("πόλλ΄ οἶδ΄ ἀλώπηξ,   ἀλλ΄ ἐχῖνος ἓν μέγα.").to match_ignoring_whitespace expected
+      expect("πόλλ΄ οἶδ΄ ἀλώπηξ, \t ἀλλ΄ ἐχῖνος ἓν μέγα.").to match_ignoring_whitespace expected
+    end
+    specify 'a string with a non-breaking space' do
+      expect("πόλλ΄ οἶδ΄ ἀλώπηξ,\u{00a0}ἀλλ΄ ἐχῖνος ἓν μέγα.").to match_ignoring_whitespace expected
+    end
+  end
+
+  context "doesn't match" do
+    specify 'nil' do
+      expect(nil).not_to match_ignoring_whitespace expected
+    end
+    specify 'an empty string' do
+      expect('').not_to match_ignoring_whitespace expected
+    end
+    specify 'a single space' do
+      expect(' ').not_to match_ignoring_whitespace expected
+    end
+    specify 'a different string' do
+      expect('χρημάτων ἄελπτον οὐδέν ἐστιν οὐδ᾽ ἀπώμιον οὐδὲ θαυμάσιον').not_to match_ignoring_whitespace expected
+    end
+    specify 'a string missing a space' do
+      expect("πόλλ΄ οἶδ΄ ἀλώπηξ,ἀλλ΄ ἐχῖνος ἓν μέγα.").not_to match_ignoring_whitespace expected
+    end
+    specify 'expecting nil' do
+      expect('anything').not_to match_ignoring_whitespace(nil)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rspec/match_ignoring_whitespace'
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: rspec-match_ignoring_whitespace
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Paul A. Jungwirth
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: bundler
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: RSpec matcher to compare strings ignoring whitespace
+email:
+- pj@illuminatedcomputing.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec/match_ignoring_whitespace.rb
+- lib/rspec/match_ignoring_whitespace/version.rb
+- rspec-match_ignoring_whitespace.gemspec
+- spec/match_ignoring_whitespace_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/pjungwir/rspec-match_ignoring_whitespace
+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.7.6
+signing_key: 
+specification_version: 4
+summary: RSpec matcher to compare strings ignoring whitespace
+test_files: []