xml_patch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6ed23a7f96ff5c5b584d6deaa09a293f2ba96d84
+  data.tar.gz: f9dfbae2b53dedda73213b9a6fe2c5dd5ad20d48
+SHA512:
+  metadata.gz: 4d6c6dc8b63c69f0ca874725d133ecb1f98c4cef511712ffc201ba4e87ff9edb0476797bb4ad296330b5d8dcbb922af2824c8a781aab534901f2b1c8b947e9fb
+  data.tar.gz: 8a299fdd1dd4a0dcf5574c4ac70e5793faeb09b1db33055a1a3d0dc0c09bb6b256bf3f529769287e776490649268a843e6fca391dbbe2b2b86952c7d63c1b13a

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4
+  - 2.3
+  - 2.2
+before_install: gem install bundler -v 1.15.4

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2017-11-01
+### Added
+- Support for <remove> xml patch elements

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at iainbeeston@users.noreply.github.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in xml_patch.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Iain Beeston
+
+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,54 @@
+# XmlPatch
+
+[![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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'xml_patch'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install xml_patch
+
+## Usage
+
+To apply an xml patch to an xml string:
+
+``` ruby
+require 'xml_patch'
+
+patch = '<remove sel="/foo" />'
+xml = '<foo /><bar />'
+
+XmlPatch.apply(patch).to(xml)
+# => "<bar />"
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/xml_patch. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the XmlPatch project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/xml_patch/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "xml_patch"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/xml_patch.rb

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

data/lib/xml_patch/applicator.rb

@@ -0,0 +1,19 @@
+require 'xml_patch/diff_builder'
+require 'xml_patch/target_document'
+
+module XmlPatch
+  class Applicator
+    attr_reader :diff_xml
+
+    def initialize(diff_xml)
+      @diff_xml = diff_xml.dup.freeze
+    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.to_xml
+    end
+  end
+end

data/lib/xml_patch/diff_builder.rb

@@ -0,0 +1,39 @@
+require 'oga'
+require 'xml_patch/diff_document'
+require 'xml_patch/operations/remove'
+
+module XmlPatch
+  class DiffBuilder
+    attr_reader :diff_document
+
+    def initialize
+      @diff_document = XmlPatch::DiffDocument.new
+    end
+
+    def remove(xpath)
+      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 = {})
+        case name
+        when 'remove' then builder.remove(attrs['sel'])
+        end
+      end
+    end
+
+    private_constant :SaxHandler
+  end
+end

data/lib/xml_patch/diff_document.rb

@@ -0,0 +1,37 @@
+module XmlPatch
+  class DiffDocument
+    include Enumerable
+
+    def initialize
+      @operations = []
+    end
+
+    def <<(operation)
+      operations << operation
+      self
+    end
+
+    def each(&blk)
+      operations.each(&blk)
+    end
+
+    def apply_to(doc)
+      operations.each { |op| op.apply_to(doc) }
+      doc
+    end
+
+    def ==(other)
+      other.respond_to?(:apply_to) &&
+        other.respond_to?(:zip) &&
+        other.zip(self).all? { |a, b| a == b }
+    end
+
+    def to_xml
+      operations.inject('') { |str, op| str + op.to_xml + "\n" }.chomp
+    end
+
+    private
+
+    attr_reader :operations
+  end
+end

data/lib/xml_patch/errors/invalid_xml.rb

@@ -0,0 +1,5 @@
+module XmlPatch
+  module Errors
+    class InvalidXml < StandardError; end
+  end
+end

data/lib/xml_patch/errors/invalid_xpath.rb

@@ -0,0 +1,5 @@
+module XmlPatch
+  module Errors
+    class InvalidXpath < StandardError; end
+  end
+end

data/lib/xml_patch/operations/remove.rb

@@ -0,0 +1,30 @@
+module XmlPatch
+  module Operations
+    class Remove
+      attr_reader :sel
+
+      def initialize(sel:)
+        @sel = sel.dup.freeze
+      end
+
+      def apply_to(doc)
+        doc.remove_at!(sel)
+      end
+
+      def ==(other)
+        other.respond_to?(:operation) &&
+          other.operation == operation &&
+          other.respond_to?(:sel) &&
+          other.sel == sel
+      end
+
+      def operation
+        :remove
+      end
+
+      def to_xml
+        %(<remove sel="#{sel}" />)
+      end
+    end
+  end
+end

data/lib/xml_patch/target_document.rb

@@ -0,0 +1,43 @@
+require 'oga'
+require 'xml_patch/errors/invalid_xml'
+require 'xml_patch/errors/invalid_xpath'
+
+module XmlPatch
+  class TargetDocument
+    def initialize(xml)
+      @xml = Oga.parse_xml(xml)
+    rescue LL::ParserError => e
+      raise XmlPatch::Errors::InvalidXml, e.message
+    end
+
+    def to_xml
+      xml.to_xml
+    end
+
+    def remove_at!(xpath)
+      nodes = []
+
+      begin
+        nodes = xml.xpath(xpath)
+      rescue LL::ParserError => e
+        raise XmlPatch::Errors::InvalidXpath, e.message
+      end
+
+      nodes.each { |n| remove_node(n) }
+
+      self
+    end
+
+    private
+
+    attr_reader :xml
+
+    def remove_node(node)
+      if node.respond_to?(:remove)
+        node.remove
+      elsif node.respond_to?(:element)
+        node.element.unset(node.name)
+      end
+    end
+  end
+end

data/lib/xml_patch/version.rb

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

data/xml_patch.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "xml_patch/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "xml_patch"
+  spec.version       = XmlPatch::VERSION
+  spec.authors       = ["Iain Beeston"]
+  spec.email         = ["iainbeeston@users.noreply.github.com"]
+
+  spec.summary       = %q{An implementation of XML Patch (RFC5261) in ruby}
+  spec.homepage      = "https://github.com/iainbeeston/xml_patch"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "oga", "~> 2.11"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: xml_patch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Iain Beeston
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: oga
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+description: 
+email:
+- iainbeeston@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/xml_patch.rb
+- lib/xml_patch/applicator.rb
+- lib/xml_patch/diff_builder.rb
+- lib/xml_patch/diff_document.rb
+- 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
+- xml_patch.gemspec
+homepage: https://github.com/iainbeeston/xml_patch
+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.6.13
+signing_key: 
+specification_version: 4
+summary: An implementation of XML Patch (RFC5261) in ruby
+test_files: []