ismasan / xml_patch

An implementation of XML Patch (RFC5261) in ruby

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

XmlPatch

Build Status Maintainability

An implementation of XML Patch (RFC5261) in ruby.

Installation

Add this line to your application's Gemfile:

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:

require 'xml_patch'

patch = '<remove sel="/foo" />'
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.

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.

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 code of conduct.

License

The gem is available as open source under the terms of the MIT License.

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.

About

An implementation of XML Patch (RFC5261) in ruby

License:MIT License


Languages

Language:Ruby 99.2%Language:Shell 0.8%