jjulian / tvml

Ruby library for working with Apple's TVML

TVML

Provides a way of working with Apple's TVML documents, templates, and elements in an elegant and friendly Ruby-style DSL.

The TVML gem is based on Builder. For an example of how to integrate TVML with Sinatra, check out the tvml-example repo.

Installation

Add this line to your application's Gemfile:

gem 'tvml'

And then execute:

$ bundle

Or install it yourself as:

$ gem install tvml

Usage

doc = TVML::Document.new
doc.template = TVML::Template::Alert.new.tap do |alert|
  alert.title       = "Hello World"
  alert.description = "How are things?"
end

doc.build # => "<?xml version=\"1.0\" encoding=\"UTF-8\"?><document><alertTemplate><description>How are things?</description><title>Hello World</title></alertTemplate></document>"

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bundle exec rspec 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/chrisb/tvml.

Copyright

Copyright (c) 2015-2016 Chris Bielinski. See MIT-LICENSE for details.