https://github.com/danini-the-panini/tag_remover

Remove elements from large XML documents.
https://github.com/danini-the-panini/tag_remover

Last synced: 15 days ago
JSON representation

Remove elements from large XML documents.

• Host: GitHub
• URL: https://github.com/danini-the-panini/tag_remover
• Owner: danini-the-panini
• License: mit
• Created: 2014-10-27T12:41:44.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2014-10-28T17:16:10.000Z (about 10 years ago)
• Last Synced: 2024-12-01T06:09:12.167Z (22 days ago)
• Language: Ruby
• Size: 137 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# TagRemover

Tag remover let's you remove all elements of specified tags from extremely large XML documents without parsing or loading the whole thing in memory, useful for processing unreasonably large documents without making your server fall over.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'tag_remover'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install tag_remover

## Usage

The following line will read XML from `input_stream`, and write it out to `output_stream` with all `div` and `img` elements removed.

```ruby

TagRemover.process input_stream, output_stream, remove_tags: ['div', 'img']

```

Options include:

  * `remove_tags`: List of tags to remove from the XML file.

  * `close_streams`: (`true`|`false`) If set, TagRemover will close `input_stream` and `output_stream` once the proccess is over.

  * [NOT IMPLEMENTED] `format`: (`true`|`false`) If set, then the contents of `output_stream` will be formatted.

TagRemover can be used from the command line with the `rmtags` command. The following is an example that reads input.xml and writes the output to output.xml, removing all `div` and `img` elements:

    $ rmtags input.xml output.xml div img

## Limitations

Tag remover currently only works correctly if the XML is formatted with only one tag per line.

## Contributing

  1. Fork it ( https://github.com/[my-github-username]/tag_remover/fork )

  2. Create your feature branch (`git checkout -b my-new-feature`)

  3. Commit your changes (`git commit -am 'Add some feature'`)

  4. Push to the branch (`git push origin my-new-feature`)

  5. Create a new Pull Request