Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
d2b883b7
Commit
d2b883b7
authored
Apr 10, 2017
by
Nick Thomas
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Start versioning cached markdown fields
parent
e9819de1
Changes
8
Show whitespace changes
Inline
Side-by-side
Showing
8 changed files
with
329 additions
and
169 deletions
+329
-169
app/models/concerns/cache_markdown_field.rb
app/models/concerns/cache_markdown_field.rb
+68
-33
changelogs/unreleased/30672-versioned-markdown-cache.yml
changelogs/unreleased/30672-versioned-markdown-cache.yml
+4
-0
db/migrate/20170410133135_add_version_field_to_markdown_cache.rb
...ate/20170410133135_add_version_field_to_markdown_cache.rb
+25
-0
db/schema.rb
db/schema.rb
+13
-0
lib/banzai/renderer.rb
lib/banzai/renderer.rb
+7
-14
spec/lib/banzai/object_renderer_spec.rb
spec/lib/banzai/object_renderer_spec.rb
+2
-2
spec/lib/banzai/renderer_spec.rb
spec/lib/banzai/renderer_spec.rb
+16
-53
spec/models/concerns/cache_markdown_field_spec.rb
spec/models/concerns/cache_markdown_field_spec.rb
+194
-67
No files found.
app/models/concerns/cache_markdown_field.rb
View file @
d2b883b7
...
@@ -8,6 +8,14 @@
...
@@ -8,6 +8,14 @@
#
#
# Corresponding foo_html, bar_html and baz_html fields should exist.
# Corresponding foo_html, bar_html and baz_html fields should exist.
module
CacheMarkdownField
module
CacheMarkdownField
extend
ActiveSupport
::
Concern
# Increment this number every time the renderer changes its output
CACHE_VERSION
=
1
# changes to these attributes cause the cache to be invalidates
INVALIDATED_BY
=
%w[author project]
.
freeze
# Knows about the relationship between markdown and html field names, and
# Knows about the relationship between markdown and html field names, and
# stores the rendering contexts for the latter
# stores the rendering contexts for the latter
class
FieldData
class
FieldData
...
@@ -34,13 +42,6 @@ module CacheMarkdownField
...
@@ -34,13 +42,6 @@ module CacheMarkdownField
false
false
end
end
extend
ActiveSupport
::
Concern
included
do
cattr_reader
:cached_markdown_fields
do
FieldData
.
new
end
# Returns the default Banzai render context for the cached markdown field.
# Returns the default Banzai render context for the cached markdown field.
def
banzai_render_context
(
field
)
def
banzai_render_context
(
field
)
raise
ArgumentError
.
new
(
"Unknown field:
#{
field
.
inspect
}
"
)
unless
raise
ArgumentError
.
new
(
"Unknown field:
#{
field
.
inspect
}
"
)
unless
...
@@ -56,12 +57,52 @@ module CacheMarkdownField
...
@@ -56,12 +57,52 @@ module CacheMarkdownField
context
context
end
end
# Allow callers to look up the cache field name, rather than hardcoding it
# Update every column in a row if any one is invalidated, as we only store
def
markdown_cache_field_for
(
field
)
# one version per row
def
refresh_markdown_cache!
(
do_update:
false
)
options
=
{
skip_project_check:
skip_project_check?
}
updates
=
cached_markdown_fields
.
markdown_fields
.
map
do
|
markdown_field
|
[
cached_markdown_fields
.
html_field
(
markdown_field
),
Banzai
::
Renderer
.
cacheless_render_field
(
self
,
markdown_field
,
options
)
]
end
.
to_h
updates
[
'cached_markdown_version'
]
=
CacheMarkdownField
::
CACHE_VERSION
updates
.
each
{
|
html_field
,
data
|
write_attribute
(
html_field
,
data
)
}
update_columns
(
updates
)
if
persisted?
&&
do_update
end
def
cached_html_up_to_date?
(
markdown_field
)
html_field
=
cached_markdown_fields
.
html_field
(
markdown_field
)
markdown_changed
=
attribute_changed?
(
markdown_field
)
||
false
html_changed
=
attribute_changed?
(
html_field
)
||
false
CacheMarkdownField
::
CACHE_VERSION
==
cached_markdown_version
&&
(
html_changed
||
markdown_changed
==
html_changed
)
end
def
invalidated_markdown_cache?
cached_markdown_fields
.
html_fields
.
any?
{
|
html_field
|
attribute_invalidated?
(
html_field
)
}
end
def
attribute_invalidated?
(
attr
)
__send__
(
"
#{
attr
}
_invalidated?"
)
end
def
cached_html_for
(
markdown_field
)
raise
ArgumentError
.
new
(
"Unknown field:
#{
field
}
"
)
unless
raise
ArgumentError
.
new
(
"Unknown field:
#{
field
}
"
)
unless
cached_markdown_fields
.
markdown_fields
.
include?
(
field
)
cached_markdown_fields
.
markdown_fields
.
include?
(
markdown_
field
)
cached_markdown_fields
.
html_field
(
field
)
__send__
(
cached_markdown_fields
.
html_field
(
markdown_field
))
end
included
do
cattr_reader
:cached_markdown_fields
do
FieldData
.
new
end
end
# Always exclude _html fields from attributes (including serialization).
# Always exclude _html fields from attributes (including serialization).
...
@@ -70,12 +111,16 @@ module CacheMarkdownField
...
@@ -70,12 +111,16 @@ module CacheMarkdownField
def
attributes
def
attributes
attrs
=
attributes_before_markdown_cache
attrs
=
attributes_before_markdown_cache
attrs
.
delete
(
'cached_markdown_version'
)
cached_markdown_fields
.
html_fields
.
each
do
|
field
|
cached_markdown_fields
.
html_fields
.
each
do
|
field
|
attrs
.
delete
(
field
)
attrs
.
delete
(
field
)
end
end
attrs
attrs
end
end
before_save
:refresh_markdown_cache!
,
if: :invalidated_markdown_cache?
end
end
class_methods
do
class_methods
do
...
@@ -88,25 +133,15 @@ module CacheMarkdownField
...
@@ -88,25 +133,15 @@ module CacheMarkdownField
cached_markdown_fields
[
markdown_field
]
=
context
cached_markdown_fields
[
markdown_field
]
=
context
html_field
=
cached_markdown_fields
.
html_field
(
markdown_field
)
html_field
=
cached_markdown_fields
.
html_field
(
markdown_field
)
cache_method
=
"
#{
markdown_field
}
_cache_refresh"
.
to_sym
invalidation_method
=
"
#{
html_field
}
_invalidated?"
.
to_sym
invalidation_method
=
"
#{
html_field
}
_invalidated?"
.
to_sym
define_method
(
cache_method
)
do
options
=
{
skip_project_check:
skip_project_check?
}
html
=
Banzai
::
Renderer
.
cacheless_render_field
(
self
,
markdown_field
,
options
)
__send__
(
"
#{
html_field
}
="
,
html
)
true
end
# The HTML becomes invalid if any dependent fields change. For now, assume
# The HTML becomes invalid if any dependent fields change. For now, assume
# author and project invalidate the cache in all circumstances.
# author and project invalidate the cache in all circumstances.
define_method
(
invalidation_method
)
do
define_method
(
invalidation_method
)
do
changed_fields
=
changed_attributes
.
keys
changed_fields
=
changed_attributes
.
keys
invalidations
=
changed_fields
&
[
markdown_field
.
to_s
,
"author"
,
"project"
]
invalidations
=
changed_fields
&
[
markdown_field
.
to_s
,
*
INVALIDATED_BY
]
!
invalidations
.
empty?
!
invalidations
.
empty?
||
!
cached_html_up_to_date?
(
markdown_field
)
end
end
before_save
cache_method
,
if:
invalidation_method
end
end
end
end
end
end
changelogs/unreleased/30672-versioned-markdown-cache.yml
0 → 100644
View file @
d2b883b7
---
title
:
Replace rake cache:clear:db with an automatic mechanism
merge_request
:
10597
author
:
db/migrate/20170410133135_add_version_field_to_markdown_cache.rb
0 → 100644
View file @
d2b883b7
class
AddVersionFieldToMarkdownCache
<
ActiveRecord
::
Migration
include
Gitlab
::
Database
::
MigrationHelpers
DOWNTIME
=
false
def
change
%i[
abuse_reports
appearances
application_settings
broadcast_messages
issues
labels
merge_requests
milestones
namespaces
notes
projects
releases
snippets
]
.
each
do
|
table
|
add_column
table
,
:cached_markdown_version
,
:integer
,
limit:
4
end
end
end
db/schema.rb
View file @
d2b883b7
...
@@ -24,6 +24,7 @@ ActiveRecord::Schema.define(version: 20170419001229) do
...
@@ -24,6 +24,7 @@ ActiveRecord::Schema.define(version: 20170419001229) do
t
.
datetime
"created_at"
t
.
datetime
"created_at"
t
.
datetime
"updated_at"
t
.
datetime
"updated_at"
t
.
text
"message_html"
t
.
text
"message_html"
t
.
integer
"cached_markdown_version"
end
end
create_table
"appearances"
,
force: :cascade
do
|
t
|
create_table
"appearances"
,
force: :cascade
do
|
t
|
...
@@ -34,6 +35,7 @@ ActiveRecord::Schema.define(version: 20170419001229) do
...
@@ -34,6 +35,7 @@ ActiveRecord::Schema.define(version: 20170419001229) do
t
.
datetime
"created_at"
,
null:
false
t
.
datetime
"created_at"
,
null:
false
t
.
datetime
"updated_at"
,
null:
false
t
.
datetime
"updated_at"
,
null:
false
t
.
text
"description_html"
t
.
text
"description_html"
t
.
integer
"cached_markdown_version"
end
end
create_table
"application_settings"
,
force: :cascade
do
|
t
|
create_table
"application_settings"
,
force: :cascade
do
|
t
|
...
@@ -116,6 +118,7 @@ ActiveRecord::Schema.define(version: 20170419001229) do
...
@@ -116,6 +118,7 @@ ActiveRecord::Schema.define(version: 20170419001229) do
t
.
integer
"unique_ips_limit_time_window"
t
.
integer
"unique_ips_limit_time_window"
t
.
boolean
"unique_ips_limit_enabled"
,
default:
false
,
null:
false
t
.
boolean
"unique_ips_limit_enabled"
,
default:
false
,
null:
false
t
.
decimal
"polling_interval_multiplier"
,
default:
1.0
,
null:
false
t
.
decimal
"polling_interval_multiplier"
,
default:
1.0
,
null:
false
t
.
integer
"cached_markdown_version"
t
.
boolean
"usage_ping_enabled"
,
default:
true
,
null:
false
t
.
boolean
"usage_ping_enabled"
,
default:
true
,
null:
false
t
.
string
"uuid"
t
.
string
"uuid"
end
end
...
@@ -161,6 +164,7 @@ ActiveRecord::Schema.define(version: 20170419001229) do
...
@@ -161,6 +164,7 @@ ActiveRecord::Schema.define(version: 20170419001229) do
t
.
string
"color"
t
.
string
"color"
t
.
string
"font"
t
.
string
"font"
t
.
text
"message_html"
t
.
text
"message_html"
t
.
integer
"cached_markdown_version"
end
end
create_table
"chat_names"
,
force: :cascade
do
|
t
|
create_table
"chat_names"
,
force: :cascade
do
|
t
|
...
@@ -479,6 +483,7 @@ ActiveRecord::Schema.define(version: 20170419001229) do
...
@@ -479,6 +483,7 @@ ActiveRecord::Schema.define(version: 20170419001229) do
t
.
integer
"time_estimate"
t
.
integer
"time_estimate"
t
.
integer
"relative_position"
t
.
integer
"relative_position"
t
.
datetime
"closed_at"
t
.
datetime
"closed_at"
t
.
integer
"cached_markdown_version"
end
end
add_index
"issues"
,
[
"assignee_id"
],
name:
"index_issues_on_assignee_id"
,
using: :btree
add_index
"issues"
,
[
"assignee_id"
],
name:
"index_issues_on_assignee_id"
,
using: :btree
...
@@ -543,6 +548,7 @@ ActiveRecord::Schema.define(version: 20170419001229) do
...
@@ -543,6 +548,7 @@ ActiveRecord::Schema.define(version: 20170419001229) do
t
.
text
"description_html"
t
.
text
"description_html"
t
.
string
"type"
t
.
string
"type"
t
.
integer
"group_id"
t
.
integer
"group_id"
t
.
integer
"cached_markdown_version"
end
end
add_index
"labels"
,
[
"group_id"
,
"project_id"
,
"title"
],
name:
"index_labels_on_group_id_and_project_id_and_title"
,
unique:
true
,
using: :btree
add_index
"labels"
,
[
"group_id"
,
"project_id"
,
"title"
],
name:
"index_labels_on_group_id_and_project_id_and_title"
,
unique:
true
,
using: :btree
...
@@ -663,6 +669,7 @@ ActiveRecord::Schema.define(version: 20170419001229) do
...
@@ -663,6 +669,7 @@ ActiveRecord::Schema.define(version: 20170419001229) do
t
.
text
"title_html"
t
.
text
"title_html"
t
.
text
"description_html"
t
.
text
"description_html"
t
.
integer
"time_estimate"
t
.
integer
"time_estimate"
t
.
integer
"cached_markdown_version"
end
end
add_index
"merge_requests"
,
[
"assignee_id"
],
name:
"index_merge_requests_on_assignee_id"
,
using: :btree
add_index
"merge_requests"
,
[
"assignee_id"
],
name:
"index_merge_requests_on_assignee_id"
,
using: :btree
...
@@ -700,6 +707,7 @@ ActiveRecord::Schema.define(version: 20170419001229) do
...
@@ -700,6 +707,7 @@ ActiveRecord::Schema.define(version: 20170419001229) do
t
.
text
"title_html"
t
.
text
"title_html"
t
.
text
"description_html"
t
.
text
"description_html"
t
.
date
"start_date"
t
.
date
"start_date"
t
.
integer
"cached_markdown_version"
end
end
add_index
"milestones"
,
[
"description"
],
name:
"index_milestones_on_description_trigram"
,
using: :gin
,
opclasses:
{
"description"
=>
"gin_trgm_ops"
}
add_index
"milestones"
,
[
"description"
],
name:
"index_milestones_on_description_trigram"
,
using: :gin
,
opclasses:
{
"description"
=>
"gin_trgm_ops"
}
...
@@ -726,6 +734,7 @@ ActiveRecord::Schema.define(version: 20170419001229) do
...
@@ -726,6 +734,7 @@ ActiveRecord::Schema.define(version: 20170419001229) do
t
.
integer
"parent_id"
t
.
integer
"parent_id"
t
.
boolean
"require_two_factor_authentication"
,
default:
false
,
null:
false
t
.
boolean
"require_two_factor_authentication"
,
default:
false
,
null:
false
t
.
integer
"two_factor_grace_period"
,
default:
48
,
null:
false
t
.
integer
"two_factor_grace_period"
,
default:
48
,
null:
false
t
.
integer
"cached_markdown_version"
end
end
add_index
"namespaces"
,
[
"created_at"
],
name:
"index_namespaces_on_created_at"
,
using: :btree
add_index
"namespaces"
,
[
"created_at"
],
name:
"index_namespaces_on_created_at"
,
using: :btree
...
@@ -760,6 +769,7 @@ ActiveRecord::Schema.define(version: 20170419001229) do
...
@@ -760,6 +769,7 @@ ActiveRecord::Schema.define(version: 20170419001229) do
t
.
integer
"resolved_by_id"
t
.
integer
"resolved_by_id"
t
.
string
"discussion_id"
t
.
string
"discussion_id"
t
.
text
"note_html"
t
.
text
"note_html"
t
.
integer
"cached_markdown_version"
end
end
add_index
"notes"
,
[
"author_id"
],
name:
"index_notes_on_author_id"
,
using: :btree
add_index
"notes"
,
[
"author_id"
],
name:
"index_notes_on_author_id"
,
using: :btree
...
@@ -956,6 +966,7 @@ ActiveRecord::Schema.define(version: 20170419001229) do
...
@@ -956,6 +966,7 @@ ActiveRecord::Schema.define(version: 20170419001229) do
t
.
integer
"auto_cancel_pending_pipelines"
,
default:
0
,
null:
false
t
.
integer
"auto_cancel_pending_pipelines"
,
default:
0
,
null:
false
t
.
boolean
"printing_merge_request_link_enabled"
,
default:
true
,
null:
false
t
.
boolean
"printing_merge_request_link_enabled"
,
default:
true
,
null:
false
t
.
string
"import_jid"
t
.
string
"import_jid"
t
.
integer
"cached_markdown_version"
end
end
add_index
"projects"
,
[
"ci_id"
],
name:
"index_projects_on_ci_id"
,
using: :btree
add_index
"projects"
,
[
"ci_id"
],
name:
"index_projects_on_ci_id"
,
using: :btree
...
@@ -1028,6 +1039,7 @@ ActiveRecord::Schema.define(version: 20170419001229) do
...
@@ -1028,6 +1039,7 @@ ActiveRecord::Schema.define(version: 20170419001229) do
t
.
datetime
"created_at"
t
.
datetime
"created_at"
t
.
datetime
"updated_at"
t
.
datetime
"updated_at"
t
.
text
"description_html"
t
.
text
"description_html"
t
.
integer
"cached_markdown_version"
end
end
add_index
"releases"
,
[
"project_id"
,
"tag"
],
name:
"index_releases_on_project_id_and_tag"
,
using: :btree
add_index
"releases"
,
[
"project_id"
,
"tag"
],
name:
"index_releases_on_project_id_and_tag"
,
using: :btree
...
@@ -1099,6 +1111,7 @@ ActiveRecord::Schema.define(version: 20170419001229) do
...
@@ -1099,6 +1111,7 @@ ActiveRecord::Schema.define(version: 20170419001229) do
t
.
integer
"visibility_level"
,
default:
0
,
null:
false
t
.
integer
"visibility_level"
,
default:
0
,
null:
false
t
.
text
"title_html"
t
.
text
"title_html"
t
.
text
"content_html"
t
.
text
"content_html"
t
.
integer
"cached_markdown_version"
end
end
add_index
"snippets"
,
[
"author_id"
],
name:
"index_snippets_on_author_id"
,
using: :btree
add_index
"snippets"
,
[
"author_id"
],
name:
"index_snippets_on_author_id"
,
using: :btree
...
...
lib/banzai/renderer.rb
View file @
d2b883b7
...
@@ -33,20 +33,12 @@ module Banzai
...
@@ -33,20 +33,12 @@ module Banzai
# of HTML. This method is analogous to calling render(object.field), but it
# of HTML. This method is analogous to calling render(object.field), but it
# can cache the rendered HTML in the object, rather than Redis.
# can cache the rendered HTML in the object, rather than Redis.
#
#
# The context to use is learned from the passed-in object by calling
# The context to use is managed by the object and cannot be changed.
# #banzai_render_context(field), and cannot be changed. Use #render, passing
# Use #render, passing it the field text, if a custom rendering is needed.
# it the field text, if a custom rendering is needed. The generated context
# is returned along with the HTML.
def
self
.
render_field
(
object
,
field
)
def
self
.
render_field
(
object
,
field
)
html_field
=
object
.
markdown_cache_field_for
(
field
)
object
.
refresh_markdown_cache!
(
do_update:
update_object?
(
object
))
unless
object
.
cached_html_up_to_date?
(
field
)
html
=
object
.
__send__
(
html_field
)
object
.
cached_html_for
(
field
)
return
html
if
html
.
present?
html
=
cacheless_render_field
(
object
,
field
)
update_object
(
object
,
html_field
,
html
)
unless
object
.
new_record?
||
object
.
destroyed?
html
end
end
# Same as +render_field+, but without consulting or updating the cache field
# Same as +render_field+, but without consulting or updating the cache field
...
@@ -165,8 +157,9 @@ module Banzai
...
@@ -165,8 +157,9 @@ module Banzai
Rails
.
cache
.
send
(
:expanded_key
,
full_cache_key
(
cache_key
,
pipeline_name
))
Rails
.
cache
.
send
(
:expanded_key
,
full_cache_key
(
cache_key
,
pipeline_name
))
end
end
def
self
.
update_object
(
object
,
html_field
,
html
)
# GitLab EE needs to disable updates on GET requests in Geo
object
.
update_column
(
html_field
,
html
)
def
self
.
update_object?
(
object
)
true
end
end
end
end
end
end
spec/lib/banzai/object_renderer_spec.rb
View file @
d2b883b7
...
@@ -4,13 +4,13 @@ describe Banzai::ObjectRenderer do
...
@@ -4,13 +4,13 @@ describe Banzai::ObjectRenderer do
let
(
:project
)
{
create
(
:empty_project
)
}
let
(
:project
)
{
create
(
:empty_project
)
}
let
(
:user
)
{
project
.
owner
}
let
(
:user
)
{
project
.
owner
}
let
(
:renderer
)
{
described_class
.
new
(
project
,
user
,
custom_value:
'value'
)
}
let
(
:renderer
)
{
described_class
.
new
(
project
,
user
,
custom_value:
'value'
)
}
let
(
:object
)
{
Note
.
new
(
note:
'hello'
,
note_html:
'<p
>hello</p>'
)
}
let
(
:object
)
{
Note
.
new
(
note:
'hello'
,
note_html:
'<p
dir="auto">hello</p>'
,
cached_markdown_version:
CacheMarkdownField
::
CACHE_VERSION
)
}
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
.
render
([
object
],
:note
)
renderer
.
render
([
object
],
:note
)
expect
(
object
.
redacted_note_html
).
to
eq
'<p>hello</p>'
expect
(
object
.
redacted_note_html
).
to
eq
'<p
dir="auto"
>hello</p>'
expect
(
object
.
user_visible_reference_count
).
to
eq
0
expect
(
object
.
user_visible_reference_count
).
to
eq
0
end
end
...
...
spec/lib/banzai/renderer_spec.rb
View file @
d2b883b7
require
'spec_helper'
require
'spec_helper'
describe
Banzai
::
Renderer
do
describe
Banzai
::
Renderer
do
def
expect_render
(
project
=
:project
)
def
fake_object
(
fresh
:)
expected_context
=
{
project:
project
}
object
=
double
(
'object'
)
expect
(
renderer
).
to
receive
(
:cacheless_render
)
{
:html
}.
with
(
:markdown
,
expected_context
)
end
def
expect_cache_update
expect
(
object
).
to
receive
(
:update_column
).
with
(
"field_html"
,
:html
)
end
def
fake_object
(
*
features
)
markdown
=
:markdown
if
features
.
include?
(
:markdown
)
html
=
:html
if
features
.
include?
(
:html
)
object
=
double
(
"object"
,
banzai_render_context:
{
project: :project
},
field:
markdown
,
field_html:
html
)
allow
(
object
).
to
receive
(
:markdown_cache_field_for
).
with
(
:field
).
and_return
(
"field_html"
)
allow
(
object
).
to
receive
(
:cached_html_up_to_date?
).
with
(
:field
).
and_return
(
fresh
)
allow
(
object
).
to
receive
(
:new_record?
).
and_return
(
features
.
include?
(
:new
))
allow
(
object
).
to
receive
(
:cached_html_for
).
with
(
:field
).
and_return
(
'field_html'
)
allow
(
object
).
to
receive
(
:destroyed?
).
and_return
(
features
.
include?
(
:destroyed
))
object
object
end
end
describe
"#render_field"
do
describe
'#render_field'
do
let
(
:renderer
)
{
Banzai
::
Renderer
}
let
(
:renderer
)
{
Banzai
::
Renderer
}
let
(
:subject
)
{
renderer
.
render_field
(
object
,
:field
)
}
subject
{
renderer
.
render_field
(
object
,
:field
)
}
context
"with an empty cache"
do
context
'with a stale cache'
do
let
(
:object
)
{
fake_object
(
:markdown
)
}
let
(
:object
)
{
fake_object
(
fresh:
false
)
}
it
"caches and returns the result"
do
expect_render
expect_cache_update
expect
(
subject
).
to
eq
(
:html
)
end
end
context
"with a filled cache"
do
it
'caches and returns the result'
do
let
(
:object
)
{
fake_object
(
:markdown
,
:html
)
}
expect
(
object
).
to
receive
(
:refresh_markdown_cache!
).
with
(
do_update:
true
)
it
"uses the cache"
do
is_expected
.
to
eq
(
'field_html'
)
expect_render
.
never
expect_cache_update
.
never
should
eq
(
:html
)
end
end
end
end
context
"new object"
do
context
'with an up-to-date cache'
do
let
(
:object
)
{
fake_object
(
:new
,
:markdown
)
}
let
(
:object
)
{
fake_object
(
fresh:
true
)
}
it
"doesn't cache the result"
do
expect_render
expect_cache_update
.
never
expect
(
subject
).
to
eq
(
:html
)
end
end
context
"destroyed object"
do
it
'uses the cache'
do
let
(
:object
)
{
fake_object
(
:destroyed
,
:markdown
)
}
expect
(
object
).
to
receive
(
:refresh_markdown_cache!
).
never
it
"doesn't cache the result"
do
is_expected
.
to
eq
(
'field_html'
)
expect_render
expect_cache_update
.
never
expect
(
subject
).
to
eq
(
:html
)
end
end
end
end
end
end
...
...
spec/models/concerns/cache_markdown_field_spec.rb
View file @
d2b883b7
...
@@ -24,18 +24,19 @@ describe CacheMarkdownField do
...
@@ -24,18 +24,19 @@ describe CacheMarkdownField do
cache_markdown_field
:foo
cache_markdown_field
:foo
cache_markdown_field
:baz
,
pipeline: :single_line
cache_markdown_field
:baz
,
pipeline: :single_line
def
self
.
add_attr
(
attr_name
)
def
self
.
add_attr
(
name
)
self
.
attribute_names
+=
[
attr_name
]
self
.
attribute_names
+=
[
name
]
define_attribute_methods
(
attr_name
)
define_attribute_methods
(
name
)
attr_reader
(
attr_name
)
attr_reader
(
name
)
define_method
(
"
#{
attr_name
}
="
)
do
|
val
|
define_method
(
"
#{
name
}
="
)
do
|
value
|
send
(
"
#{
attr_name
}
_will_change!"
)
unless
val
==
send
(
attr_name
)
write_attribute
(
name
,
value
)
instance_variable_set
(
"@
#{
attr_name
}
"
,
val
)
end
end
end
end
[
:foo
,
:foo_html
,
:bar
,
:baz
,
:baz_html
].
each
do
|
attr_name
|
add_attr
:cached_markdown_version
add_attr
(
attr_name
)
[
:foo
,
:foo_html
,
:bar
,
:baz
,
:baz_html
].
each
do
|
name
|
add_attr
(
name
)
end
end
def
initialize
(
*
)
def
initialize
(
*
)
...
@@ -45,6 +46,15 @@ describe CacheMarkdownField do
...
@@ -45,6 +46,15 @@ describe CacheMarkdownField do
clear_changes_information
clear_changes_information
end
end
def
read_attribute
(
name
)
instance_variable_get
(
"@
#{
name
}
"
)
end
def
write_attribute
(
name
,
value
)
send
(
"
#{
name
}
_will_change!"
)
unless
value
==
read_attribute
(
name
)
instance_variable_set
(
"@
#{
name
}
"
,
value
)
end
def
save
def
save
run_callbacks
:save
do
run_callbacks
:save
do
changes_applied
changes_applied
...
@@ -56,115 +66,232 @@ describe CacheMarkdownField do
...
@@ -56,115 +66,232 @@ describe CacheMarkdownField do
Class
.
new
(
ThingWithMarkdownFields
)
{
add_attr
(
new_attr
)
}
Class
.
new
(
ThingWithMarkdownFields
)
{
add_attr
(
new_attr
)
}
end
end
let
(
:markdown
)
{
"`Foo`"
}
let
(
:markdown
)
{
'`Foo`'
}
let
(
:html
)
{
"<p><code>Foo</code></p>"
}
let
(
:html
)
{
'<p dir="auto"><code>Foo</code></p>'
}
let
(
:updated_markdown
)
{
"`Bar`"
}
let
(
:updated_markdown
)
{
'`Bar`'
}
let
(
:updated_html
)
{
"<p dir=
\"
auto
\"
><code>Bar</code></p>"
}
let
(
:updated_html
)
{
'<p dir="auto"><code>Bar</code></p>'
}
subject
{
ThingWithMarkdownFields
.
new
(
foo:
markdown
,
foo_html:
html
)
}
let
(
:thing
)
{
ThingWithMarkdownFields
.
new
(
foo:
markdown
,
foo_html:
html
,
cached_markdown_version:
CacheMarkdownField
::
CACHE_VERSION
)
}
describe
'.attributes'
do
describe
'.attributes'
do
it
'excludes cache attributes'
do
it
'excludes cache attributes'
do
expect
(
subject
.
attributes
.
keys
.
sort
).
to
eq
(
%w[bar baz foo]
)
expect
(
thing
.
attributes
.
keys
.
sort
).
to
eq
(
%w[bar baz foo]
)
end
end
context
'an unchanged markdown field'
do
before
do
thing
.
foo
=
thing
.
foo
thing
.
save
end
end
it
{
expect
(
thing
.
foo
).
to
eq
(
markdown
)
}
it
{
expect
(
thing
.
foo_html
).
to
eq
(
html
)
}
it
{
expect
(
thing
.
foo_html_changed?
).
not_to
be_truthy
}
it
{
expect
(
thing
.
cached_markdown_version
).
to
eq
(
CacheMarkdownField
::
CACHE_VERSION
)
}
end
end
context
"an unchanged markdown field"
do
context
'a changed markdown field'
do
before
do
before
do
subject
.
foo
=
subject
.
foo
thing
.
foo
=
updated_markdown
subject
.
save
thing
.
save
end
end
it
{
expect
(
subject
.
foo
).
to
eq
(
markdown
)
}
it
{
expect
(
thing
.
foo_html
).
to
eq
(
updated_html
)
}
it
{
expect
(
subject
.
foo_html
).
to
eq
(
html
)
}
it
{
expect
(
thing
.
cached_markdown_version
).
to
eq
(
CacheMarkdownField
::
CACHE_VERSION
)
}
it
{
expect
(
subject
.
foo_html_changed?
).
not_to
be_truthy
}
end
end
context
"a changed markdown field"
do
context
'a non-markdown field changed'
do
before
do
before
do
subject
.
foo
=
updated_markdown
thing
.
bar
=
'OK'
subject
.
save
thing
.
save
end
end
it
{
expect
(
subject
.
foo_html
).
to
eq
(
updated_html
)
}
it
{
expect
(
thing
.
bar
).
to
eq
(
'OK'
)
}
it
{
expect
(
thing
.
foo
).
to
eq
(
markdown
)
}
it
{
expect
(
thing
.
foo_html
).
to
eq
(
html
)
}
it
{
expect
(
thing
.
cached_markdown_version
).
to
eq
(
CacheMarkdownField
::
CACHE_VERSION
)
}
end
end
context
"a non-markdown field changed"
do
context
'version is out of date'
do
let
(
:thing
)
{
ThingWithMarkdownFields
.
new
(
foo:
updated_markdown
,
foo_html:
html
,
cached_markdown_version:
nil
)
}
before
do
before
do
subject
.
bar
=
"OK"
thing
.
save
subject
.
save
end
it
{
expect
(
thing
.
foo_html
).
to
eq
(
updated_html
)
}
it
{
expect
(
thing
.
cached_markdown_version
).
to
eq
(
CacheMarkdownField
::
CACHE_VERSION
)
}
end
end
it
{
expect
(
subject
.
bar
).
to
eq
(
"OK"
)
}
describe
'#cached_html_up_to_date?'
do
it
{
expect
(
subject
.
foo
).
to
eq
(
markdown
)
}
subject
{
thing
.
cached_html_up_to_date?
(
:foo
)
}
it
{
expect
(
subject
.
foo_html
).
to
eq
(
html
)
}
it
'returns false when the version is absent'
do
thing
.
cached_markdown_version
=
nil
is_expected
.
to
be_falsy
end
it
'returns false when the version is too early'
do
thing
.
cached_markdown_version
-=
1
is_expected
.
to
be_falsy
end
it
'returns false when the version is too late'
do
thing
.
cached_markdown_version
+=
1
is_expected
.
to
be_falsy
end
it
'returns true when the version is just right'
do
thing
.
cached_markdown_version
=
CacheMarkdownField
::
CACHE_VERSION
is_expected
.
to
be_truthy
end
it
'returns false if markdown has been changed but html has not'
do
thing
.
foo
=
updated_html
is_expected
.
to
be_falsy
end
it
'returns true if markdown has not been changed but html has'
do
thing
.
foo_html
=
updated_html
is_expected
.
to
be_truthy
end
it
'returns true if markdown and html have both been changed'
do
thing
.
foo
=
updated_markdown
thing
.
foo_html
=
updated_html
is_expected
.
to
be_truthy
end
end
describe
'#refresh_markdown_cache!'
do
before
do
thing
.
foo
=
updated_markdown
end
context
'do_update: false'
do
it
'fills all html fields'
do
thing
.
refresh_markdown_cache!
expect
(
thing
.
foo_html
).
to
eq
(
updated_html
)
expect
(
thing
.
foo_html_changed?
).
to
be_truthy
expect
(
thing
.
baz_html_changed?
).
to
be_truthy
end
it
'does not save the result'
do
expect
(
thing
).
not_to
receive
(
:update_columns
)
thing
.
refresh_markdown_cache!
end
it
'updates the markdown cache version'
do
thing
.
cached_markdown_version
=
nil
thing
.
refresh_markdown_cache!
expect
(
thing
.
cached_markdown_version
).
to
eq
(
CacheMarkdownField
::
CACHE_VERSION
)
end
end
context
'do_update: true'
do
it
'fills all html fields'
do
thing
.
refresh_markdown_cache!
(
do_update:
true
)
expect
(
thing
.
foo_html
).
to
eq
(
updated_html
)
expect
(
thing
.
foo_html_changed?
).
to
be_truthy
expect
(
thing
.
baz_html_changed?
).
to
be_truthy
end
it
'skips saving if not persisted'
do
expect
(
thing
).
to
receive
(
:persisted?
).
and_return
(
false
)
expect
(
thing
).
not_to
receive
(
:update_columns
)
thing
.
refresh_markdown_cache!
(
do_update:
true
)
end
it
'saves the changes using #update_columns'
do
expect
(
thing
).
to
receive
(
:persisted?
).
and_return
(
true
)
expect
(
thing
).
to
receive
(
:update_columns
)
.
with
(
"foo_html"
=>
updated_html
,
"baz_html"
=>
""
,
"cached_markdown_version"
=>
CacheMarkdownField
::
CACHE_VERSION
)
thing
.
refresh_markdown_cache!
(
do_update:
true
)
end
end
end
end
describe
'#banzai_render_context'
do
describe
'#banzai_render_context'
do
it
"sets project to nil if the object lacks a project"
do
subject
(
:context
)
{
thing
.
banzai_render_context
(
:foo
)
}
context
=
subject
.
banzai_render_context
(
:foo
)
expect
(
context
).
to
have_key
(
:project
)
it
'sets project to nil if the object lacks a project'
do
is_expected
.
to
have_key
(
:project
)
expect
(
context
[
:project
]).
to
be_nil
expect
(
context
[
:project
]).
to
be_nil
end
end
it
"excludes author if the object lacks an author"
do
it
'excludes author if the object lacks an author'
do
context
=
subject
.
banzai_render_context
(
:foo
)
is_expected
.
not_to
have_key
(
:author
)
expect
(
context
).
not_to
have_key
(
:author
)
end
end
it
"raises if the context for an unrecognised field is requested"
do
it
'raises if the context for an unrecognised field is requested'
do
expect
{
subject
.
banzai_render_context
(
:not_found
)
}.
to
raise_error
(
ArgumentError
)
expect
{
thing
.
banzai_render_context
(
:not_found
)
}.
to
raise_error
(
ArgumentError
)
end
end
it
"includes the pipeline"
do
it
'includes the pipeline'
do
context
=
subject
.
banzai_render_context
(
:baz
)
baz
=
thing
.
banzai_render_context
(
:baz
)
expect
(
context
[
:pipeline
]).
to
eq
(
:single_line
)
expect
(
baz
[
:pipeline
]).
to
eq
(
:single_line
)
end
end
it
"returns copies of the context template"
do
it
'returns copies of the context template'
do
template
=
subject
.
cached_markdown_fields
[
:baz
]
template
=
thing
.
cached_markdown_fields
[
:baz
]
copy
=
subject
.
banzai_render_context
(
:baz
)
copy
=
thing
.
banzai_render_context
(
:baz
)
expect
(
copy
).
not_to
be
(
template
)
expect
(
copy
).
not_to
be
(
template
)
end
end
context
"with a project"
do
context
'with a project'
do
subject
{
thing_subclass
(
:project
).
new
(
foo:
markdown
,
foo_html:
html
,
project: :project
)
}
let
(
:thing
)
{
thing_subclass
(
:project
).
new
(
foo:
markdown
,
foo_html:
html
,
project: :project_value
)
}
it
"sets the project in the context"
do
it
'sets the project in the context'
do
context
=
subject
.
banzai_render_context
(
:foo
)
is_expected
.
to
have_key
(
:project
)
expect
(
context
).
to
have_key
(
:project
)
expect
(
context
[
:project
]).
to
eq
(
:project_value
)
expect
(
context
[
:project
]).
to
eq
(
:project
)
end
end
it
"invalidates the cache when project changes"
do
it
'invalidates the cache when project changes'
do
subject
.
project
=
:new_project
thing
.
project
=
:new_project
allow
(
Banzai
::
Renderer
).
to
receive
(
:cacheless_render_field
).
and_return
(
updated_html
)
allow
(
Banzai
::
Renderer
).
to
receive
(
:cacheless_render_field
).
and_return
(
updated_html
)
subject
.
save
thing
.
save
expect
(
subject
.
foo_html
).
to
eq
(
updated_html
)
expect
(
thing
.
foo_html
).
to
eq
(
updated_html
)
expect
(
subject
.
baz_html
).
to
eq
(
updated_html
)
expect
(
thing
.
baz_html
).
to
eq
(
updated_html
)
expect
(
thing
.
cached_markdown_version
).
to
eq
(
CacheMarkdownField
::
CACHE_VERSION
)
end
end
end
end
context
"with an author"
do
context
'with an author'
do
subject
{
thing_subclass
(
:author
).
new
(
foo:
markdown
,
foo_html:
html
,
author: :author
)
}
let
(
:thing
)
{
thing_subclass
(
:author
).
new
(
foo:
markdown
,
foo_html:
html
,
author: :author_value
)
}
it
"sets the author in the context"
do
it
'sets the author in the context'
do
context
=
subject
.
banzai_render_context
(
:foo
)
is_expected
.
to
have_key
(
:author
)
expect
(
context
).
to
have_key
(
:author
)
expect
(
context
[
:author
]).
to
eq
(
:author_value
)
expect
(
context
[
:author
]).
to
eq
(
:author
)
end
end
it
"invalidates the cache when author changes"
do
it
'invalidates the cache when author changes'
do
subject
.
author
=
:new_author
thing
.
author
=
:new_author
allow
(
Banzai
::
Renderer
).
to
receive
(
:cacheless_render_field
).
and_return
(
updated_html
)
allow
(
Banzai
::
Renderer
).
to
receive
(
:cacheless_render_field
).
and_return
(
updated_html
)
subject
.
save
thing
.
save
expect
(
subject
.
foo_html
).
to
eq
(
updated_html
)
expect
(
thing
.
foo_html
).
to
eq
(
updated_html
)
expect
(
subject
.
baz_html
).
to
eq
(
updated_html
)
expect
(
thing
.
baz_html
).
to
eq
(
updated_html
)
expect
(
thing
.
cached_markdown_version
).
to
eq
(
CacheMarkdownField
::
CACHE_VERSION
)
end
end
end
end
end
end
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment