Towards model serializers

Gemfile

@@ -2,7 +2,7 @@ source 'https://rubygems.org'
 
 gem 'rails', '~> 4.2.0.rc1'
 gem 'pg'
-gem 'jbuilder', '~> 2.2'
+gem 'restpack_serializer', '~> 0.5.6'
 gem 'sdoc', '~> 0.4', group: :doc
 gem 'spring', group: :development
 

Gemfile.lock

@@ -64,10 +64,10 @@ GEM
     hike (1.2.3)
     hitimes (1.2.2)
     i18n (0.7.0.beta1)
-    jbuilder (2.2.5)
-      activesupport (>= 3.0.0, < 5)
-      multi_json (~> 1.2)
     json (1.8.1)
+    kaminari (0.16.1)
+      actionpack (>= 3.0.0)
+      activesupport (>= 3.0.0)
     listen (2.8.3)
       celluloid (>= 0.15.2)
       rb-fsevent (>= 0.9.3)
@@ -122,6 +122,10 @@ GEM
       ffi (>= 0.5.0)
     rdoc (4.1.2)
       json (~> 1.4)
+    restpack_serializer (0.5.6)
+      activerecord (>= 4.0.3, < 5.0)
+      activesupport (>= 4.0.3, < 5.0)
+      kaminari (~> 0.16.1)
     rspec (3.1.0)
       rspec-core (~> 3.1.0)
       rspec-expectations (~> 3.1.0)
@@ -172,11 +176,11 @@ PLATFORMS
 DEPENDENCIES
   factory_girl_rails
   guard-rspec
-  jbuilder (~> 2.2)
   pg
   pry
   rails (~> 4.2.0.rc1)
   rb-fsevent
+  restpack_serializer (~> 0.5.6)
   rspec-rails
   sdoc (~> 0.4)
   spring

app/serializers/board_serializer.rb

@@ -0,0 +1,5 @@
+class BoardSerializer
+  include TalkSerializer
+  all_attributes
+  can_include :discussions
+end

app/serializers/comment_serializer.rb

@@ -0,0 +1,11 @@
+class CommentSerializer
+  include TalkSerializer
+  all_attributes
+  can_include :focus
+
+  def links
+    {
+      focus_type: model.focus_type
+    } if model.focus_id
+  end
+end

app/serializers/concerns/talk_serializer.rb

@@ -0,0 +1,20 @@
+module TalkSerializer
+  extend ActiveSupport::Concern
+
+  included do
+    include RestPack::Serializer
+    attr_reader :model
+    attributes :href, :links
+    can_filter_by(:section) if model_class.columns_hash.has_key? 'section'
+  end
+
+  module ClassMethods
+    def all_attributes
+      attributes *model_class.attribute_names
+    end
+  end
+
+  def links
+    { }
+  end
+end

app/serializers/conversation_serializer.rb

@@ -0,0 +1,5 @@
+class ConversationSerializer
+  include TalkSerializer
+  all_attributes
+  can_include :messages
+end

app/serializers/discussion_serializer.rb

@@ -0,0 +1,5 @@
+class DiscussionSerializer
+  include TalkSerializer
+  all_attributes
+  can_include :comments, :board, :user
+end

app/serializers/focus_serializer.rb

@@ -0,0 +1,4 @@
+class FocusSerializer
+  include TalkSerializer
+  all_attributes
+end

app/serializers/message_serializer.rb

@@ -0,0 +1,14 @@
+class MessageSerializer
+  include TalkSerializer
+  all_attributes
+  attributes :sender, :recipient
+  can_include :conversation
+
+  def sender
+    UserSerializer.as_json model.sender
+  end
+
+  def recipient
+    UserSerializer.as_json model.recipient
+  end
+end

app/serializers/moderation_serializer.rb

@@ -0,0 +1,4 @@
+class ModerationSerializer
+  include TalkSerializer
+  all_attributes
+end

app/serializers/tag_serializer.rb

@@ -0,0 +1,4 @@
+class TagSerializer
+  include TalkSerializer
+  all_attributes
+end

app/serializers/user_conversation_serializer.rb

@@ -0,0 +1,5 @@
+class UserConversationSerializer
+  include TalkSerializer
+  all_attributes
+  can_include :user, :conversation
+end

app/serializers/user_serializer.rb

@@ -0,0 +1,4 @@
+class UserSerializer
+  include TalkSerializer
+  all_attributes
+end

config/application.rb

@@ -11,7 +11,9 @@
 module Talk
   class Application < Rails::Application
     config.autoload_paths += [
-      'app/services'
+      'app/services',
+      'app/serializers/concerns',
+      'app/serializers'
     ].collect{ |path| Rails.root.join path }
   end
 end

config/initializers/restpack_serializer.rb

@@ -0,0 +1,19 @@
+require 'restpack_serializer'
+
+module RestPack::Serializer
+  class SideLoadDataBuilder
+    # Bug fix.  Prevent side loaded association from try to find non-existant records
+    def side_load_belongs_to
+      foreign_keys = @models.map { |model| model.send(@association.foreign_key) }.uniq.compact
+      side_load = foreign_keys.any? ? @association.klass.find(foreign_keys) : []
+      json_model_data = side_load.map { |model| @serializer.as_json(model) }
+      { @association.plural_name.to_sym => json_model_data, meta: { } }
+    end
+  end
+end
+
+# preload autoloaded serializers
+Dir[Rails.root.join('app/serializers/**/*.rb')].sort.each do |path|
+  name = path.match(/serializers\/(.+)\.rb$/)[1]
+  name.classify.constantize unless path =~ /serializers\/concerns/
+end

spec/factories/tags.rb

@@ -1,6 +1,6 @@
 FactoryGirl.define do
   factory :tag do
-
+    name{ "tag#{ id }" }
   end
 
 end

spec/serializers/board_serializer_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+RSpec.describe BoardSerializer, type: :serializer do
+  it_behaves_like 'a talk serializer', exposing: :all, including: [:discussions]
+end

spec/serializers/comment_serializer_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+RSpec.describe CommentSerializer, type: :serializer do
+  it_behaves_like 'a talk serializer', exposing: :all, including: [:focus]
+
+  it 'should specify the focus type in links' do
+    subject = create :subject
+    comment = create :comment_for_focus, focus: subject
+    json = CommentSerializer.resource id: comment.id
+    comment_json = json[:comments].first
+    expect(comment_json[:links]).to eql focus: subject.id.to_s, focus_type: 'Subject'
+  end
+end

spec/serializers/conversation_serializer_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+RSpec.describe ConversationSerializer, type: :serializer do
+  it_behaves_like 'a talk serializer', exposing: :all, including: [:messages]
+end

spec/serializers/discussion_serializer_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+RSpec.describe DiscussionSerializer, type: :serializer do
+  it_behaves_like 'a talk serializer', exposing: :all, including: [:comments, :board, :user]
+end

spec/serializers/focus_serializer_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+RSpec.describe FocusSerializer, type: :serializer do
+  it_behaves_like 'a talk serializer', exposing: :all
+end

spec/serializers/message_serializer_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+RSpec.describe MessageSerializer, type: :serializer do
+  let(:conversation){ create :conversation_with_messages }
+  let(:object){ conversation.messages.first }
+  it_behaves_like 'a talk serializer', exposing: :all, including: [:conversation]
+
+  it 'should sideload sender' do
+    json = MessageSerializer.resource id: object.id
+    message_json = json[:messages].first
+    expect(message_json[:sender][:id]).to eql object.sender.id
+    expect(message_json[:recipient][:id]).to eql object.recipient.id
+  end
+end

spec/serializers/moderation_serializer_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+RSpec.describe ModerationSerializer, type: :serializer do
+  it_behaves_like 'a talk serializer', exposing: :all
+end

spec/serializers/tag_serializer_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+RSpec.describe TagSerializer, type: :serializer do
+  it_behaves_like 'a talk serializer', exposing: :all
+end

spec/serializers/user_conversation_serializer_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+RSpec.describe UserConversationSerializer, type: :serializer do
+  it_behaves_like 'a talk serializer', exposing: :all, including: [:user, :conversation]
+end

spec/serializers/user_serializer_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+RSpec.describe UserSerializer, type: :serializer do
+  it_behaves_like 'a talk serializer', exposing: :all
+end

spec/support/shared_examples_for_talk_serializer.rb

@@ -0,0 +1,46 @@
+RSpec.shared_context 'a serializer' do
+  let(:serializer){ described_class }
+  let(:model){ serializer.model_class }
+  let(:instance){ FactoryGirl.create serializer.singular_key }
+  let(:model_instance){ instance }
+  let(:json){ serializer.as_json model_instance }
+end
+
+RSpec.shared_examples 'a talk serializer' do |exposing: nil, including: nil|
+  include_context 'a serializer'
+  let(:model_instance){ defined?(object) ? object : instance }
+
+  describe 'attributes' do
+    subject{ json }
+
+    if exposing == :all
+      described_class.model_class.attribute_names.each do |name|
+        it{ is_expected.to include name.to_sym }
+      end
+    elsif exposing
+      exposing.each do |name|
+        it{ is_expected.to include name.to_sym }
+      end
+    end
+
+    it{ is_expected.to include :href }
+  end
+
+  describe 'associations' do
+    if including
+      including.each do |association|
+        it "should allow inclusion of #{ association }" do
+          association = association.to_s
+          json = serializer.resource id: model_instance.id, include: association
+          association_key = association.to_s.pluralize.to_sym
+          expect(json[:linked]).to include association_key
+
+          macro = model.reflect_on_association(association).macro
+          unless macro.in? [:belongs_to, :has_one]
+            expect(json[:meta]).to include association_key
+          end
+        end
+      end
+    end
+  end
+end