ActiveModelSerializersMatchers

RSpec matchers for testing ActiveModel::Serializer

Installation

Add this line to your application's Gemfile:

gem 'active_model_serializers_matchers', '0.0.3'

And then execute:

$ bundle

Or install it yourself as:

$ gem install active_model_serializers_matchers

Configure RSpec

RSpec.configure do |config|
  config.include ActiveModelSerializersMatchers, type: :serializer
end

Usage

Simple has_many and has_one Associations

class ListSerializer < ActiveModel::Serializer
  has_one :title
  has_many :items
end

RSpec.describe ListSerializer, type: :serializer do
  subject { described_class }
  it { should have_one(:title) }
  it { should have_many(:items) }
  it { should have_many(:cats) }
end

ListSerializer
  should have one :title
  should have many :items
  should have many :cats (FAILED - 1)

Failures:

  1) ListSerializer should have many :cats
     Failure/Error: it { should have_many(:cats) }
       expected ListSerializer to define a 'has_many :cats' association

Association Options

Key

use: #as

class ShoeRackSerializer < ActiveModel::Serializer
  has_many :shoes, key: :kicks
end

RSpec.describe ShoeRackSerializer, type: :serializer do
  subject { described_class }
  it { should have_many(:shoes).as(:kicks) }
  it { should have_many(:shoes).as(:ones_and_twos) }
end

ShoeRackSerializer
  should have many :shoes as :kicks
  should have many :shoes as :ones_and_twos (FAILED - 1)

Failures:

  1) ShoeRackSerializer should have many :shoes as :ones_and_twos
     Failure/Error: it { should have_many(:shoes).as(:ones_and_twos) }
       expected ShoeRackSerializer 'has_many :shoes' association to explicitly have key :ones_and_twos but instead was :kicks

Serializer

use: #serialized_with

class ProductSerializer < ActiveModel::Serializer; end
class SoupCanSerializer < ActiveModel::Serializer; end

class ShoppingCartSerializer < ActiveModel::Serializer
  has_many :items, serializer: ProductSerializer
end

RSpec.describe ShoppingCartSerializer, type: :serializer do
  subject { described_class }
  it { should have_many(:items).serialized_with(ProductSerializer) }
  it { should have_many(:items).serialized_with(SoupCanSerializer) }
end

ShoppingCartSerializer
  should have many :items serialized with ProductSerializer
  should have many :items serialized with SoupCanSerializer (FAILED - 1)

Failures

  1) ShoppingCartSerializer should have many :items serialized with SoupCanSerializer
     Failure/Error: it { should have_many(:items).serialized_with(SoupCanSerializer) }
       expected ShoppingCartSerializer 'has_many :items' association to explicitly have serializer SoupCanSerializer but instead was ProductSerializer

Chainable

These can be chained in any order.

class FoodSerializer < ActiveModel::Serializer; end

class MenuSerializer < ActiveModel::Serializer
  has_many :entrees, key: :dishes, serializer: FoodSerializer
end

RSpec.describe MenuSerializer, type: :serializer do
  subject { described_class }
  it { should have_many(:entrees).as(:dishes).serialized_with(FoodSerializer) }
  it { should have_many(:entrees).serialized_with(FoodSerializer).as(:dishes) }
end

MenuSerializer
  should have many :entrees as :dishes serialized with FoodSerializer
  should have many :entrees serialized with FoodSerializer as :dishes
  should have many :entrees serialized with FoodSerializer as :eats (FAILED - 1)
  should have many :entrees serialized with MilkSerializer as :dishes (FAILED - 2)

Failures:

  1) MenuSerializer should have many :entrees serialized with FoodSerializer as :eats
     Failure/Error: it { should have_many(:entrees).serialized_with(FoodSerializer).as(:eats) }
       expected MenuSerializer 'has_many :entrees' association to explicitly have key :eats but instead was :dishes

  2) MenuSerializer should have many :entrees serialized with MilkSerializer as :dishes
     Failure/Error: it { should have_many(:entrees).serialized_with(MilkSerializer).as(:dishes) }
       expected MenuSerializer 'has_many :entrees' association to explicitly have serializer MilkSerializer but instead was FoodSerializer

Contributing

1. Fork it ( https://github.com/tonyta/active_model_serializers_matchers/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request