gitlab-org--gitlab-foss/lib/gitlab/markdown_cache.rb

# frozen_string_literal: true

module Gitlab
  module MarkdownCache
    # Increment this number every time the renderer changes its output
    CACHE_COMMONMARK_VERSION        = 18
    CACHE_COMMONMARK_VERSION_START  = 10

    BaseError = Class.new(StandardError)
    UnsupportedClassError = Class.new(BaseError)
  end
end
Use Redis for CacheMarkDownField on non AR models This allows using `CacheMarkdownField` for models that are not backed by ActiveRecord. When the including class inherits `ActiveRecord::Base` we include `Gitlab::MarkdownCache::ActiveRecord::Extension`. This will cause the markdown fields to be rendered and the generated HTML stored in a `<field>_html` attribute on the record. We also store the version used for generating the markdown. All other classes that include this model will include the `Gitlab::MarkdownCache::Redis::Extension`. This add the `<field>_html` attributes to that model and will generate the html in them. The generated HTML will be cached in redis under the key `markdown_cache:<class>:<id>`. The class this included in must therefore respond to `id`. 2019-06-05 00:59:48 -04:00			`# frozen_string_literal: true`

			`module Gitlab`
			`module MarkdownCache`
			`# Increment this number every time the renderer changes its output`
Bump the CACHE_COMMONMARK_VERSION to ensure any markdown generated before the asset proxy default was corrected is re-generated 2019-09-11 15:30:17 -04:00			`CACHE_COMMONMARK_VERSION = 18`
Use Redis for CacheMarkDownField on non AR models This allows using `CacheMarkdownField` for models that are not backed by ActiveRecord. When the including class inherits `ActiveRecord::Base` we include `Gitlab::MarkdownCache::ActiveRecord::Extension`. This will cause the markdown fields to be rendered and the generated HTML stored in a `<field>_html` attribute on the record. We also store the version used for generating the markdown. All other classes that include this model will include the `Gitlab::MarkdownCache::Redis::Extension`. This add the `<field>_html` attributes to that model and will generate the html in them. The generated HTML will be cached in redis under the key `markdown_cache:<class>:<id>`. The class this included in must therefore respond to `id`. 2019-06-05 00:59:48 -04:00			`CACHE_COMMONMARK_VERSION_START = 10`

			`BaseError = Class.new(StandardError)`
			`UnsupportedClassError = Class.new(BaseError)`
			`end`
			`end`