Commit 109816c4 authored by Nick Thomas's avatar Nick Thomas

Use CacheMarkdownField for notes

parent e94cd6fd
...@@ -6,10 +6,13 @@ class Note < ActiveRecord::Base ...@@ -6,10 +6,13 @@ class Note < ActiveRecord::Base
include Awardable include Awardable
include Importable include Importable
include FasterCacheKeys include FasterCacheKeys
include CacheMarkdownField
cache_markdown_field :note, pipeline: :note
# Attribute containing rendered and redacted Markdown as generated by # Attribute containing rendered and redacted Markdown as generated by
# Banzai::ObjectRenderer. # Banzai::ObjectRenderer.
attr_accessor :note_html attr_accessor :redacted_note_html
# An Array containing the number of visible references as generated by # An Array containing the number of visible references as generated by
# Banzai::ObjectRenderer # Banzai::ObjectRenderer
......
...@@ -61,7 +61,7 @@ ...@@ -61,7 +61,7 @@
.note-body{class: note_editable ? 'js-task-list-container' : ''} .note-body{class: note_editable ? 'js-task-list-container' : ''}
.note-text.md .note-text.md
= preserve do = preserve do
= note.note_html = note.redacted_note_html
= edited_time_ago_with_tooltip(note, placement: 'bottom', html_class: 'note_edited_ago', include_author: true) = edited_time_ago_with_tooltip(note, placement: 'bottom', html_class: 'note_edited_ago', include_author: true)
- if note_editable - if note_editable
= render 'projects/notes/edit_form', note: note = render 'projects/notes/edit_form', note: note
......
...@@ -3,7 +3,7 @@ module Banzai ...@@ -3,7 +3,7 @@ module Banzai
# Renders a collection of Note instances. # Renders a collection of Note instances.
# #
# notes - The notes to render. # notes - The notes to render.
# project - The project to use for rendering/redacting. # project - The project to use for redacting.
# user - The user viewing the notes. # user - The user viewing the notes.
# path - The request path. # path - The request path.
# wiki - The project's wiki. # wiki - The project's wiki.
...@@ -13,8 +13,7 @@ module Banzai ...@@ -13,8 +13,7 @@ module Banzai
user, user,
requested_path: path, requested_path: path,
project_wiki: wiki, project_wiki: wiki,
ref: git_ref, ref: git_ref)
pipeline: :note)
renderer.render(notes, :note) renderer.render(notes, :note)
end end
......
module Banzai module Banzai
# Class for rendering multiple objects (e.g. Note instances) in a single pass. # Class for rendering multiple objects (e.g. Note instances) in a single pass,
# using +render_field+ to benefit from caching in the database. Rendering and
# redaction are both performed.
# #
# Rendered Markdown is stored in an attribute in every object based on the # The unredacted HTML is generated according to the usual +render_field+
# name of the attribute containing the Markdown. For example, when the # policy, so specify the pipeline and any other context options on the model.
# attribute `note` is rendered the HTML is stored in `note_html`. #
# The *redacted* (i.e., suitable for use) HTML is placed in an attribute
# named "redacted_<foo>", where <foo> is the name of the cache field for the
# chosen attribute.
#
# As an example, rendering the attribute `note` would place the unredacted
# HTML into `note_html` and the redacted HTML into `redacted_note_html`.
class ObjectRenderer class ObjectRenderer
attr_reader :project, :user attr_reader :project, :user
# Make sure to set the appropriate pipeline in the `raw_context` attribute # project - A Project to use for redacting Markdown.
# (e.g. `:note` for Note instances).
#
# project - A Project to use for rendering and redacting Markdown.
# user - The user viewing the Markdown/HTML documents, if any. # user - The user viewing the Markdown/HTML documents, if any.
# context - A Hash containing extra attributes to use in the rendering # context - A Hash containing extra attributes to use during redaction
# pipeline. def initialize(project, user = nil, redaction_context = {})
def initialize(project, user = nil, raw_context = {})
@project = project @project = project
@user = user @user = user
@raw_context = raw_context @redaction_context = redaction_context
end end
# Renders and redacts an Array of objects. # Renders and redacts an Array of objects.
# #
# objects - The objects to render # objects - The objects to render.
# attribute - The attribute containing the raw Markdown to render. # attribute - The attribute containing the raw Markdown to render.
# #
# Returns the same input objects. # Returns the same input objects.
...@@ -32,7 +36,7 @@ module Banzai ...@@ -32,7 +36,7 @@ module Banzai
objects.each_with_index do |object, index| objects.each_with_index do |object, index|
redacted_data = redacted[index] redacted_data = redacted[index]
object.__send__("#{attribute}_html=", redacted_data[:document].to_html.html_safe) object.__send__("redacted_#{attribute}_html=", redacted_data[:document].to_html.html_safe)
object.user_visible_reference_count = redacted_data[:visible_reference_count] object.user_visible_reference_count = redacted_data[:visible_reference_count]
end end
end end
...@@ -53,12 +57,8 @@ module Banzai ...@@ -53,12 +57,8 @@ module Banzai
# Returns a Banzai context for the given object and attribute. # Returns a Banzai context for the given object and attribute.
def context_for(object, attribute) def context_for(object, attribute)
context = base_context.merge(cache_key: [object, attribute]) context = base_context.dup
context = context.merge(object.banzai_render_context(attribute))
if object.respond_to?(:author)
context[:author] = object.author
end
context context
end end
...@@ -66,21 +66,16 @@ module Banzai ...@@ -66,21 +66,16 @@ module Banzai
# #
# Returns an Array of `Nokogiri::HTML::Document`. # Returns an Array of `Nokogiri::HTML::Document`.
def render_attributes(objects, attribute) def render_attributes(objects, attribute)
strings_and_contexts = objects.map do |object| objects.map do |object|
string = Banzai.render_field(object, attribute)
context = context_for(object, attribute) context = context_for(object, attribute)
string = object.__send__(attribute) Banzai::Pipeline[:relative_link].to_document(string, context)
{ text: string, context: context }
end
Banzai.cache_collection_render(strings_and_contexts).each_with_index.map do |html, index|
Banzai::Pipeline[:relative_link].to_document(html, strings_and_contexts[index][:context])
end end
end end
def base_context def base_context
@base_context ||= @raw_context.merge(current_user: user, project: project) @base_context ||= @redaction_context.merge(current_user: user, project: project)
end end
end end
end end
...@@ -12,8 +12,7 @@ describe Banzai::NoteRenderer do ...@@ -12,8 +12,7 @@ describe Banzai::NoteRenderer do
with(project, user, with(project, user,
requested_path: 'foo', requested_path: 'foo',
project_wiki: wiki, project_wiki: wiki,
ref: 'bar', ref: 'bar').
pipeline: :note).
and_call_original and_call_original
expect_any_instance_of(Banzai::ObjectRenderer). expect_any_instance_of(Banzai::ObjectRenderer).
......
...@@ -4,10 +4,18 @@ describe Banzai::ObjectRenderer do ...@@ -4,10 +4,18 @@ describe Banzai::ObjectRenderer do
let(:project) { create(:empty_project) } let(:project) { create(:empty_project) }
let(:user) { project.owner } let(:user) { project.owner }
def fake_object(attrs = {})
object = double(attrs.merge("new_record?": true, "destroyed?": true))
allow(object).to receive(:markdown_cache_field_for).with(:note).and_return(:note_html)
allow(object).to receive(:banzai_render_context).with(:note).and_return(project: nil, author: nil)
allow(object).to receive(:update_column).with(:note_html, anything).and_return(true)
object
end
describe '#render' do describe '#render' do
it 'renders and redacts an Array of objects' do it 'renders and redacts an Array of objects' do
renderer = described_class.new(project, user) renderer = described_class.new(project, user)
object = double(:object, note: 'hello', note_html: nil) object = fake_object(note: 'hello', note_html: nil)
expect(renderer).to receive(:render_objects).with([object], :note). expect(renderer).to receive(:render_objects).with([object], :note).
and_call_original and_call_original
...@@ -16,7 +24,7 @@ describe Banzai::ObjectRenderer do ...@@ -16,7 +24,7 @@ describe Banzai::ObjectRenderer do
with(an_instance_of(Array)). with(an_instance_of(Array)).
and_call_original and_call_original
expect(object).to receive(:note_html=).with('<p>hello</p>') expect(object).to receive(:redacted_note_html=).with('<p>hello</p>')
expect(object).to receive(:user_visible_reference_count=).with(0) expect(object).to receive(:user_visible_reference_count=).with(0)
renderer.render([object], :note) renderer.render([object], :note)
...@@ -25,7 +33,7 @@ describe Banzai::ObjectRenderer do ...@@ -25,7 +33,7 @@ describe Banzai::ObjectRenderer do
describe '#render_objects' do describe '#render_objects' do
it 'renders an Array of objects' do it 'renders an Array of objects' do
object = double(:object, note: 'hello') object = fake_object(note: 'hello', note_html: nil)
renderer = described_class.new(project, user) renderer = described_class.new(project, user)
...@@ -57,49 +65,29 @@ describe Banzai::ObjectRenderer do ...@@ -57,49 +65,29 @@ describe Banzai::ObjectRenderer do
end end
describe '#context_for' do describe '#context_for' do
let(:object) { double(:object, note: 'hello') } let(:object) { fake_object(note: 'hello') }
let(:renderer) { described_class.new(project, user) } let(:renderer) { described_class.new(project, user) }
it 'returns a Hash' do it 'returns a Hash' do
expect(renderer.context_for(object, :note)).to be_an_instance_of(Hash) expect(renderer.context_for(object, :note)).to be_an_instance_of(Hash)
end end
it 'includes the cache key' do it 'includes the banzai render context for the object' do
expect(object).to receive(:banzai_render_context).with(:note).and_return(foo: :bar)
context = renderer.context_for(object, :note) context = renderer.context_for(object, :note)
expect(context).to have_key(:foo)
expect(context[:cache_key]).to eq([object, :note]) expect(context[:foo]).to eq(:bar)
end
context 'when the object responds to "author"' do
it 'includes the author in the context' do
expect(object).to receive(:author).and_return('Alice')
context = renderer.context_for(object, :note)
expect(context[:author]).to eq('Alice')
end
end
context 'when the object does not respond to "author"' do
it 'does not include the author in the context' do
context = renderer.context_for(object, :note)
expect(context.key?(:author)).to eq(false)
end
end end
end end
describe '#render_attributes' do describe '#render_attributes' do
it 'renders the attribute of a list of objects' do it 'renders the attribute of a list of objects' do
objects = [double(:doc, note: 'hello'), double(:doc, note: 'bye')] objects = [fake_object(note: 'hello', note_html: nil), fake_object(note: 'bye', note_html: nil)]
renderer = described_class.new(project, user, pipeline: :note) renderer = described_class.new(project, user)
expect(Banzai).to receive(:cache_collection_render). objects.each do |object|
with([ expect(Banzai).to receive(:render_field).with(object, :note).and_call_original
{ text: 'hello', context: renderer.context_for(objects[0], :note) }, end
{ text: 'bye', context: renderer.context_for(objects[1], :note) }
]).
and_call_original
docs = renderer.render_attributes(objects, :note) docs = renderer.render_attributes(objects, :note)
...@@ -114,17 +102,13 @@ describe Banzai::ObjectRenderer do ...@@ -114,17 +102,13 @@ describe Banzai::ObjectRenderer do
objects = [] objects = []
renderer = described_class.new(project, user, pipeline: :note) renderer = described_class.new(project, user, pipeline: :note)
expect(Banzai).to receive(:cache_collection_render).
with([]).
and_call_original
expect(renderer.render_attributes(objects, :note)).to eq([]) expect(renderer.render_attributes(objects, :note)).to eq([])
end end
end end
describe '#base_context' do describe '#base_context' do
let(:context) do let(:context) do
described_class.new(project, user, pipeline: :note).base_context described_class.new(project, user, foo: :bar).base_context
end end
it 'returns a Hash' do it 'returns a Hash' do
...@@ -132,7 +116,7 @@ describe Banzai::ObjectRenderer do ...@@ -132,7 +116,7 @@ describe Banzai::ObjectRenderer do
end end
it 'includes the custom attributes' do it 'includes the custom attributes' do
expect(context[:pipeline]).to eq(:note) expect(context[:foo]).to eq(:bar)
end end
it 'includes the current user' do it 'includes the current user' do
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment