rspec-xml_helpers 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cb7c346fc01e79f1189dac0c02f3dc210226e9c33dbfb5558e65ea580a019c6d
+  data.tar.gz: cbb22de74c0730916365f861d86a6f430d2dd71bf3fac033fdd6817725bba3a5
+SHA512:
+  metadata.gz: 30ecf89ba9bda70d0780d87da14e846d1723098c97253a1ea7c1adac2d853e7bdb53b344b72faf32cec18bfdb2cd00919e68ba9870473eba671d1a4a03cc09d3
+  data.tar.gz: 8e38bde9bbb14921b3fa361852578913f1e2b9904e08b3ccfe5191b711cc21bdac8ff848fdc9dc671b5c7ad25d26188cff011a987dad07f1e2f84b510c16de0c

data/lib/rspec/xml_helpers.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'naws_xml'
+
+require_relative 'xml_helpers/xml_matcher'
+require_relative 'xml_helpers/xml_formatter'
+
+module RSpec
+  # Provides a `match_xml` rspec matcher.
+  module XmlHelpers
+    # @param [String<XML>] expected
+    def match_xml(expected)
+      XmlMatcher.new(expected)
+    end
+
+    class << self
+
+      # @param [String<XML>] xml
+      # @return [String<XML>]
+      # @api private
+      def normalize_xml(xml)
+        XmlFormatter.new.format(xml)
+      end
+
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include RSpec::XmlHelpers
+end

data/lib/rspec/xml_helpers/xml_formatter.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'diff-lcs'
+require 'diffy'
+require 'stringio'
+
+module RSpec
+  module XmlHelpers
+    # @api private
+    class XmlFormatter
+
+      def format(xml)
+        xml = NawsXml::Parser.new.parse(xml)
+        xml = stable_sort(xml)
+        xml.to_s(indent: '  ')
+      end
+
+      private
+
+      def stable_sort(xml)
+        node = NawsXml::Node.new(xml.name)
+        node.attributes.update(sort_attrs(xml.attributes))
+        node << xml.text if xml.text
+        sort_nodes(xml.children).each do |child|
+          node << child
+        end
+        node
+      end
+
+      def sort_attrs(attrs)
+        attrs.keys.sort.each_with_object({}) do |key, sorted|
+          sorted[key] = attrs[key]
+        end
+      end
+
+      def sort_nodes(nodes)
+        nodes.sort_by.with_index { |node, idx| [node.name, idx] }
+      end
+
+    end
+  end
+end

data/lib/rspec/xml_helpers/xml_matcher.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'diff-lcs'
+require 'diffy'
+require 'stringio'
+
+module RSpec
+  module XmlHelpers
+    # @api private
+    class XmlMatcher
+
+      def initialize(expected, colorize: true)
+        @expected = XmlHelpers.normalize_xml(expected)
+        @diff_format = colorize ? :color : :text
+      end
+
+      def matches?(actual)
+        @actual = XmlHelpers.normalize_xml(actual)
+        @expected == @actual
+      rescue ArgumentError => error
+        @wrong_type_error_message = error.message
+        false
+      end
+
+      def failure_message
+        @wrong_type_error_message || diff_json_error_message
+      end
+
+      def failure_message_when_negated
+        'expected XML value not to be equal'
+      end
+
+      def diff_json_error_message
+        message = StringIO.new
+        message << "expected: #{@expected}\n\n"
+        message << "got: #{@actual}\n\n"
+        message << "Diff: #{diff}"
+        message.string
+      end
+
+      def diff
+        diff = Diffy::Diff.new(@expected, @actual).to_s(@diff_format)
+        diff.lines[0..-2].join
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,220 @@
+--- !ruby/object:Gem::Specification
+name: rspec-xml_helpers
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- The Incognito Coder
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: diff-lcs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: naws_xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0.pre
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0.pre
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.60'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.60'
+- !ruby/object:Gem::Dependency
+  name: semver-string
+  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: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: yard-sitemap
+  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'
+description: 
+email:
+- theincognitocoder@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rspec/xml_helpers.rb
+- lib/rspec/xml_helpers/xml_formatter.rb
+- lib/rspec/xml_helpers/xml_matcher.rb
+homepage: https://github.com/theincognitocoder/rspec-xml_helpers
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/theincognitocoder/rspec-xml_helpers/issues
+  changelog_uri: https://github.com/theincognitocoder/rspec-xml_helpers/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/github/theincognitocoder/rspec-xml_helpers/master
+  homepage_uri: https://github.com/theincognitocoder/rspec-xml_helpers
+  source_code_uri: https://github.com/theincognitocoder/rspec-xml_helpers
+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.8
+signing_key: 
+specification_version: 4
+summary: Rspec Xml Helpers
+test_files: []