Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tonytonyjan/plist_lite
plist_lite the fastest plist processor for Ruby written in C.
https://github.com/tonytonyjan/plist_lite
Last synced: about 2 months ago
JSON representation
plist_lite the fastest plist processor for Ruby written in C.
- Host: GitHub
- URL: https://github.com/tonytonyjan/plist_lite
- Owner: tonytonyjan
- Created: 2021-06-27T11:09:44.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-06-27T15:25:12.000Z (over 3 years ago)
- Last Synced: 2024-10-31T14:40:57.735Z (2 months ago)
- Language: Ruby
- Homepage:
- Size: 14.6 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# plist_lite
`plist_lite` the fastest plist processor for Ruby written in C.
It can convert Ruby object to XML [plist (a.k.a. property list)](https://en.wikipedia.org/wiki/Property_list#macOS), vice versa.
## Usage
`plist_lite` does one thing and does it well.
It only has 2 API:
- `PlistLite#dump(object)`
- `PlistLite#load(plist_string)`
```ruby
require 'plist_lite'
plist = PlistLite.dump({foo: 'bar', ary: [1,2,3], time: Time.at(0)})
# => "foobarary123time1970-01-01T00:00:00Z"
PlistLite.load(plist)
# => {"foo"=>"bar", "ary"=>[1, 2, 3], "time"=>1970-01-01 00:00:00 UTC}
```
### Supported Types
- `Array` - ``
- `Hash` - ``
- `Integer` - ``
- `Float` - ``
- `TrueClass` - ``
- `FalseClass` - ``
- `String`
- binary encoding - ``
- other encodings - ``
- `Symbol` - ``
- `Time` - ``
- `DateTime` - ``
- `Date` - ``
- avoid using this because it does not have time zone information like `Time` or `DateTime`.
## Why plist_lite?
There is another competitor called [plist](https://github.com/patsplat/plist).
I am not a big fan of reinventing wheels, but when I see all the other wheels are square-shaped, they leave me no choice.
Here are some reasons of why `plist_lite` is better than `plist`.
1. `plist_lite` is 5 times faster than `plist`, see [benchmark](#benchmark).
2. `plist_lite` knows how to handle encoding while `plist` doesn't.
`plist` assume all strings are UTF-8 encoded.
```shell
ruby -rplist -e 'puts Plist::Emit.dump("兜".encode(Encoding::BIG5))'
```
```
```
3. `plist_lite` treat binary string as binary data while `plist` treats `IO` and `StringIO` instances as binary data. The design of `plist` makes little sense.
4. `plist` uses `Marshal#dump` to handle unsupported data types that makes it vulnerable.
5. `plist_lite` knows how to handle XML encoding while `plist` doesn't.
According the [the spec](https://www.w3.org/TR/xml/), escaping `"` and `'` is unnecessary.
```shell
ruby -rplist -e 'puts Plist::Emit.dump "\""'
```
```
"
```
## Benchmark
```shell
ruby -Ilib benchmark/dump.rb
```
```
Rehearsal ----------------------------------------------------
Plist::Emit.dump 3.715427 0.003159 3.718586 ( 3.720294)
PlistLite.dump 0.634391 0.000851 0.635242 ( 0.635718)
------------------------------------------- total: 4.353828sec
user system total real
Plist::Emit.dump 3.853843 0.003882 3.857725 ( 3.860390)
PlistLite.dump 0.700628 0.001118 0.701746 ( 0.702823)
```
```sh
ruby -Ilib benchmark/load.rb
```
```
Rehearsal ---------------------------------------------------
Plist.parse_xml 2.220934 1.423194 3.644128 ( 3.645330)
PlistLite.load 0.598344 0.007032 0.605376 ( 0.605603)
------------------------------------------ total: 4.249504sec
user system total real
Plist.parse_xml 2.265274 1.454423 3.719697 ( 3.721122)
PlistLite.load 0.673733 0.005373 0.679106 ( 0.679638)
```