PostgresExt-Serializers

Note: Current release is Rails 4.0.x compatible

There will be updates to postgres_ext coming soon to make it 4.1 compatible

Looking for help?

If it is a bug please open an issue on Github. If you need help using the gem please ask the question on Stack Overflow. Be sure to tag the question with DockYard so we can find it.

Installation

Add this line to your application's Gemfile:

gem 'postgres_ext-serializers'

And then execute:

$ bundle

Or install it yourself as:

$ gem install postgres_ext-serializers

Usage

Just require 'postgres_ext/serializers' and use ActiveModel::Serializers as you normally would! Postgres_ext-serializers will take over anytime you try to serialize an ActiveRecord::Relation.

Methods in Serializers and Models

If you are using methods to compute properties for your JSON responses in your models or serializers, postgres_ext-serializers will try to discover a SQL version of this call by looking for a class method with the same name and the prefex __sql. Here's an example:

class MySerializer < ActiveModel::Serializer
  def full_name
    "#{object.first_name} #{object.last_name}"
  end

  def self.full_name__sql(scope)
    "first_name || ' ' || last_name"
  end
end

The scope is passed to methods in a serializer, while there are no arguments passed to __sql methods in a model. You will not have access to the current_user alias of scope, but the scope passed in will be the same object. Right now, this string is used as a SQL literal, so be sure to not use untrusted values in the return value. This feature may change before the 1.0 release, if a cleaner implementation is found.

Developing

To work on postgres_ext-serializers locally, follow these steps:

1. Run bundle install, this will install (almost) all the development dependencies
2. Run gem install byebug (not a declared dependency to not break CI)
3. Run bundle exec rake setup, this will set up the .env file necessary to run the tests and set up the database
4. Run bundle exec rake db:create, this will create the test database
5. Run bundle exec rake db:migrate, this will set up the database tables required by the test
6. Run BUNDLE_GEMFILE='gemfiles/Gemfile.activerecord-4.0.x' bundle install --quiet to create the Gemfile.lock.
7. Run bundle exec rake test:all to run tests against all supported versions of Active Record (currently only 4.0.x)

Authors

Dan McClain twitter github

We are very thankful for the many contributors

Versioning

This gem follows Semantic Versioning

Want to help?

Please do! We are always looking to improve this gem.

Legal

DockYard, Inc © 2014

@dockyard

Licensed under the MIT license