Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/webhippie/po_to_json
Ruby library for converting gettext PO files to JSON
https://github.com/webhippie/po_to_json
gettext i18n json ruby rubygem
Last synced: 7 days ago
JSON representation
Ruby library for converting gettext PO files to JSON
- Host: GitHub
- URL: https://github.com/webhippie/po_to_json
- Owner: webhippie
- License: mit
- Created: 2012-07-16T19:13:49.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2023-09-05T05:38:41.000Z (about 1 year ago)
- Last Synced: 2024-04-24T19:12:27.945Z (7 months ago)
- Topics: gettext, i18n, json, ruby, rubygem
- Language: Ruby
- Homepage: https://github.com/webhippie/po_to_json
- Size: 48.8 KB
- Stars: 4
- Watchers: 3
- Forks: 10
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# po_to_json
[](https://github.com/webhippie/po_to_json/actions/workflows/testing.yaml) [](https://matrix.to/#/#webhippie:matrix.org) [](https://app.codacy.com/gh/webhippie/po_to_json/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [](https://badge.fury.io/rb/po_to_json)
Convert gettext PO files to JSON to use in your javascript app, based on
po2json.pl by [DuckDuckGo, Inc.](http://duckduckgo.com/). Ideally you'll use
this on a Rake task that creates JSON versions of your PO files, which can
later be used from javascript with [Jed](http://slexaxton.github.io/Jed/)
## Versions
For a list of the tested and supported Ruby and JSON versions please take a
look at the [wokflow][workflow].
## Installation
```ruby
gem "po_to_json", "~> 2.0"
```
## Versioning
This library aims to adhere to [Semantic Versioning 2.0.0][semver]. Violations
of this scheme should be reported as bugs. Specifically, if a minor or patch
version is released that breaks backward compatibility, a new version should be
immediately released that restores compatibility. Breaking changes to the public
API will only be introduced with new major versions.
As a result of this policy, you can (and should) specify a dependency on this
gem using the [Pessimistic Version Constraint][pvc] with two digits of precision.
For example:
```ruby
spec.add_dependency "po_to_json", "~> 2.0"
```
## Usage
Most common use would be to generate a Jed ready javascript file. For example,
in a Rails project:
```ruby
require "po_to_json"
json = PoToJson.new(
Rails.root.join("locale", "de", "app.po")
).generate_for_jed("de")
Rails.root.join(
"app",
"assets",
"javascripts",
"locale",
"de",
"app.js"
).write(json)
```
If you need a pretty json, add `pretty: true` to `generate_for_jed`, like the
following example:
```ruby
require "po_to_json"
json = PoToJson.new(
Rails.root.join("locale", "de", "app.po")
).generate_for_jed("de", pretty: true)
Rails.root.join(
"app",
"assets",
"javascripts",
"locale",
"de",
"app.js"
).write(json)
```
The javascript file generated has a global "locales" object with an attribute
corresponding to the generated language:
```javascript
i18n = new Jed(locales["de"])
i18n.gettext("Hello World") // Should evaluate to "Hallo Welt"
```
## Contributing
Fork -> Patch -> Spec -> Push -> Pull Request
## Authors
* [Thomas Boerger](https://github.com/tboerger)
* [Nubis](https://github.com/nubis)
* [Other contributors](https://github.com/webhippie/po_to_json/graphs/contributors)
## License
MIT
## Copyright
```
Copyright (c) 2012-2015 Dropmysite.com
Copyright (c) 2015 Webhippie
```
[workflow]: https://github.com/webhippie/po_to_json/blob/master/.github/workflows/testing.yml
[semver]: http://semver.org
[pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint