xml_patch 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ed23a7f96ff5c5b584d6deaa09a293f2ba96d84
-  data.tar.gz: f9dfbae2b53dedda73213b9a6fe2c5dd5ad20d48
+  metadata.gz: e2c6bdbe6fea7b24152900af2f0c96dea6cac1f9
+  data.tar.gz: 442e95cbb9f9f533236c8c512b68a40efda585ab
 SHA512:
-  metadata.gz: 4d6c6dc8b63c69f0ca874725d133ecb1f98c4cef511712ffc201ba4e87ff9edb0476797bb4ad296330b5d8dcbb922af2824c8a781aab534901f2b1c8b947e9fb
-  data.tar.gz: 8a299fdd1dd4a0dcf5574c4ac70e5793faeb09b1db33055a1a3d0dc0c09bb6b256bf3f529769287e776490649268a843e6fca391dbbe2b2b86952c7d63c1b13a
+  metadata.gz: ef57bbdd1ff21e6db3b27541e0eed4412d7687c2a540dbb2a6daafb7deb32625fb6b79e656529e33f277e09d7c74fe5e48685ad04b880b3242f8b1094fd1fa17
+  data.tar.gz: 33ef8880ac7d7737a120c2982bde90b7a275def782ab3df97fb8bf9c408ce4764b7ce36da9a77bc29ca682be3da797876b507a373e085f95c328259f91e4c2a1

data/CHANGELOG.md

@@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [0.2.0] - 2017-11-09
+### Fixed
+- Expect patch xml to have a <diff> root node
+- Don't parse nested <remove> tags
+
 ## [0.1.0] - 2017-11-01
 ### Added
 - Support for <remove> xml patch elements

data/README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://travis-ci.org/iainbeeston/xml_patch.svg?branch=master)](https://travis-ci.org/iainbeeston/xml_patch)
 [![Maintainability](https://api.codeclimate.com/v1/badges/048c9e7b3b129c80a2e0/maintainability)](https://codeclimate.com/github/iainbeeston/xml_patch/maintainability)
 
-An implementation of XML Patch (RFC5261) in ruby.
+An implementation of [XML Patch (RFC5261)](https://tools.ietf.org/html/rfc5261) in ruby.
 
 ## Installation
 
@@ -28,13 +28,24 @@ To apply an xml patch to an xml string:
 ``` ruby
 require 'xml_patch'
 
-patch = '<remove sel="/foo" />'
+patch = '<diff><remove sel="/foo" /></diff>'
 xml = '<foo /><bar />'
 
 XmlPatch.apply(patch).to(xml)
 # => "<bar />"
 ```
 
+## Limitations
+
+So far this implementation supports:
+
+* `<remove>` elements
+
+But not:
+
+* `<add>` elements
+* `<replace>` elements
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/bin/run_specs_one_by_one

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+# inspired by the run_specs_one_by_one script in rspec-core
+
+EXIT=0
+
+echo "Running each spec file, one-by-one..."
+
+for file in `find spec -iname '*_spec.rb'`; do
+  echo "Running $file"
+  bundle exec rspec $file -b --format progress || EXIT=$?
+done
+
+exit $EXIT

data/lib/xml_patch.rb

@@ -1,10 +1,12 @@
 require 'xml_patch/version'
 require 'xml_patch/applicator'
+require 'xml_patch/xml_document'
 
 module XmlPatch
   class << self
     def apply(xml)
-      XmlPatch::Applicator.new(xml)
+      patch = XmlPatch::XmlDocument.new(xml)
+      XmlPatch::Applicator.new(patch)
     end
   end
 end

data/lib/xml_patch/applicator.rb

@@ -1,19 +1,24 @@
 require 'xml_patch/diff_builder'
-require 'xml_patch/target_document'
+require 'xml_patch/xml_document'
 
 module XmlPatch
   class Applicator
-    attr_reader :diff_xml
-
-    def initialize(diff_xml)
-      @diff_xml = diff_xml.dup.freeze
+    def initialize(patch)
+      @patch = patch
     end
 
     def to(target_xml)
-      diff = XmlPatch::DiffBuilder.new.parse(diff_xml).diff_document
-      target = XmlPatch::TargetDocument.new(target_xml)
-      diff.apply_to(target)
+      target = XmlPatch::XmlDocument.new(target_xml)
+      diff_document.apply_to(target)
       target.to_xml
     end
+
+    private
+
+    attr_reader :patch
+
+    def diff_document
+      XmlPatch::DiffBuilder.new.parse(patch).diff_document
+    end
   end
 end

data/lib/xml_patch/diff_builder.rb

@@ -1,4 +1,3 @@
-require 'oga'
 require 'xml_patch/diff_document'
 require 'xml_patch/operations/remove'
 
@@ -14,26 +13,13 @@ module XmlPatch
       diff_document << XmlPatch::Operations::Remove.new(sel: xpath)
     end
 
-    def parse(xml)
-      handler = SaxHandler.new(self)
-      Oga.sax_parse_xml(handler, xml)
-      self
-    end
-
-    class SaxHandler
-      attr_reader :builder
-
-      def initialize(builder)
-        @builder = builder
-      end
-
-      def on_element(_namespace, name, attrs = {})
+    def parse(patch)
+      patch.get_at('/diff/*') do |name, attrs|
         case name
-        when 'remove' then builder.remove(attrs['sel'])
+        when 'remove' then remove(attrs['sel'])
         end
       end
+      self
     end
-
-    private_constant :SaxHandler
   end
 end

data/lib/xml_patch/diff_document.rb

@@ -27,7 +27,11 @@ module XmlPatch
     end
 
     def to_xml
-      operations.inject('') { |str, op| str + op.to_xml + "\n" }.chomp
+      if operations.empty?
+        '<diff />'
+      else
+        '<diff>' + operations.map(&:to_xml).join("\n") + '</diff>'
+      end
     end
 
     private

data/lib/xml_patch/operations/remove.rb

@@ -9,6 +9,7 @@ module XmlPatch
 
       def apply_to(doc)
         doc.remove_at!(sel)
+        doc
       end
 
       def ==(other)

data/lib/xml_patch/version.rb

@@ -1,3 +1,3 @@
 module XmlPatch
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/xml_patch/{target_document.rb → xml_document.rb}

@@ -3,27 +3,25 @@ require 'xml_patch/errors/invalid_xml'
 require 'xml_patch/errors/invalid_xpath'
 
 module XmlPatch
-  class TargetDocument
+  class XmlDocument
     def initialize(xml)
-      @xml = Oga.parse_xml(xml)
-    rescue LL::ParserError => e
-      raise XmlPatch::Errors::InvalidXml, e.message
+      @xml = xml
     end
 
     def to_xml
-      xml.to_xml
+      xml_dom.to_xml
     end
 
     def remove_at!(xpath)
-      nodes = []
+      nodes_at(xpath).each { |n| remove_node(n) }
 
-      begin
-        nodes = xml.xpath(xpath)
-      rescue LL::ParserError => e
-        raise XmlPatch::Errors::InvalidXpath, e.message
-      end
+      self
+    end
 
-      nodes.each { |n| remove_node(n) }
+    def get_at(xpath)
+      if block_given?
+        nodes_at(xpath).each { |n| yield(n.name, node_attributes(n)) }
+      end
 
       self
     end
@@ -32,6 +30,12 @@ module XmlPatch
 
     attr_reader :xml
 
+    def xml_dom
+      @xml_dom ||= Oga.parse_xml(xml)
+    rescue LL::ParserError => e
+      raise XmlPatch::Errors::InvalidXml, e.message
+    end
+
     def remove_node(node)
       if node.respond_to?(:remove)
         node.remove
@@ -39,5 +43,19 @@ module XmlPatch
         node.element.unset(node.name)
       end
     end
+
+    def nodes_at(xpath)
+      begin
+        return xml_dom.xpath(xpath)
+      rescue LL::ParserError => e
+        raise XmlPatch::Errors::InvalidXpath, e.message
+      end
+    end
+
+    def node_attributes(node)
+      node.attributes.each_with_object({}) do |attr, hsh|
+        hsh[attr.name] = attr.value
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xml_patch
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Iain Beeston
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-01 00:00:00.000000000 Z
+date: 2017-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -83,6 +83,7 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/run_specs_one_by_one
 - bin/setup
 - lib/xml_patch.rb
 - lib/xml_patch/applicator.rb
@@ -91,8 +92,8 @@ files:
 - lib/xml_patch/errors/invalid_xml.rb
 - lib/xml_patch/errors/invalid_xpath.rb
 - lib/xml_patch/operations/remove.rb
-- lib/xml_patch/target_document.rb
 - lib/xml_patch/version.rb
+- lib/xml_patch/xml_document.rb
 - xml_patch.gemspec
 homepage: https://github.com/iainbeeston/xml_patch
 licenses: