Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leonard-henriquez/db_serializer
This gem provide a blazing fast way to serialize Active Record models
https://github.com/leonard-henriquez/db_serializer
Last synced: about 1 month ago
JSON representation
This gem provide a blazing fast way to serialize Active Record models
- Host: GitHub
- URL: https://github.com/leonard-henriquez/db_serializer
- Owner: leonard-henriquez
- License: mit
- Created: 2020-05-09T15:29:57.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-06-24T20:45:44.000Z (over 4 years ago)
- Last Synced: 2024-06-08T23:35:30.757Z (6 months ago)
- Language: Ruby
- Homepage: https://hqz.me/db_serializer/
- Size: 112 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-blazingly-fast - db_serializer - This gem provide a blazing fast way to serialize Active Record models (Ruby)
README
# Db Serializer
This gem provide a blazing fast way to serialize Active Record models.
At the moment only a GeoJSON serializer is implemented
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'db_serializer'
```
And then execute:
```bash
$ bundle install
```
Then you need to include the concern `DbSerializer::GeoJSON` to your model:
```ruby
# In this example the City model has:
# - an attribute name of type string
# - an attribute boundaries of type geometry
class City < ActiveRecord::Base
# Include this concern
include DbSerializer::JSON
# Specify which column contains the geometry
# If you don't specify it, by default it will be :geometry
db_serializer :boundaries
end
```
## Usage
```ruby
puts City.all.to_geojson([:id, :name])
# If you had such a model, it would output something like this:
# {
# "type": "FeatureCollection", "features": [{
# "id": 1, "type": "Feature", "geometry": {
# "type": "MultiLineString", "coordinates": [[[x1,y1],[x2,y2]]]
# },
# "properties": {"id": 1, "name": "Paris"}
# }]
# }
```
Note: the output has been pretty printed for readability but please keep in mind that `to_geojson` returns a *string* containing a valid serialized JSON.
It means that you do not need to use `to_json` on it and that it can be parse with `JSON.parse`.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/leonard-henriquez/db_serializer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/leonard-henriquez/db_serializer/blob/master/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the db_serializer project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/leonard-henriquez/db_serializer/blob/master/CODE_OF_CONDUCT.md).