chenhang / opml-handler

Opml handler Gem in ruby

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Opml::Handler

Handle opml(xml) in your ruby application, both import and export and support children outlines

Installation

Add this line to your application's Gemfile:

gem 'opml-handler'

And then execute:

$ bundle

Or install it yourself as:

$ gem install opml-handler

Usage

You can convert ruby hash to opml string

require 'opml-handler'

data = [{text: 'First level',
         children: [{text: 'Second Level',
                     children: [{text: 'Item 1', _note: "Some notes", children: []},
                                {text: 'Item 2', children: []}]
                    }
         ]
        }]

opml = OpmlHandler::Opml.new(outlines_attributes: data, title: "title")

puts opml.to_xml

Or convert opml string to ruby hash

content = '<?xml version="1.0" encoding="UTF-8"?>
<opml version="1.0">
  <head>
    <title>Title</title>
  </head>
  <body>
    <outline text="First level">
      <outline text="Second Level">
        <outline text="Item 1" _note="Some notes"/>
        <outline text="Item 2"/>
      </outline>
    </outline>
  </body>
</opml>'

opml_object = OpmlHandler::Opml.new(content: content)

opml_object.to_hash

puts opml_object.title
puts opml_object.outlines_attributes

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake rspec 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]/opml-handler. 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.

About

Opml handler Gem in ruby


Languages

Language:Ruby 97.1%Language:Shell 2.9%