db_serializer

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:

gem 'db_serializer'

And then execute:

$ bundle install

Then you need to include the concern DbSerializer::GeoJSON to your model:

# 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

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.

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.

License

The gem is available as open source under the terms of the MIT License.

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.