class Decidim::Proposals::MarkdownToProposals

This class parses a participatory text document in markdown and produces Proposals in the form of sections and articles.

This implementation uses Redcarpet Base renderer. Redcarpet::Render::Base performs a callback for every block it finds, what MarkdownToProposals does is to implement callbacks for the blocks which it is interested in performing some actions.

Public Class Methods

new(component, current_user) click to toggle source

Public: Initializes the serializer with a proposal.

Calls superclass method
# File lib/decidim/proposals/markdown_to_proposals.rb, line 16
def initialize(component, current_user)
  super()
  @component = component
  @current_user = current_user
  @last_position = 0
  @num_sections = 0
  @list_items = []
end

Public Instance Methods

double_emphasis(text) click to toggle source
# File lib/decidim/proposals/markdown_to_proposals.rb, line 119
def double_emphasis(text)
  "<strong>#{text}</strong>"
end
emphasis(text) click to toggle source
# File lib/decidim/proposals/markdown_to_proposals.rb, line 115
def emphasis(text)
  "<em>#{text}</em>"
end
header(title, level) click to toggle source

Recarpet callback to process headers. Creates Paricipatory Text Proposals at Section and Subsection levels.

# File lib/decidim/proposals/markdown_to_proposals.rb, line 46
def header(title, level)
  participatory_text_level = if level > 1
                               Decidim::Proposals::ParticipatoryTextSection::LEVELS[:sub_section]
                             else
                               Decidim::Proposals::ParticipatoryTextSection::LEVELS[:section]
                             end

  create_proposal(title, title, participatory_text_level)

  @num_sections += 1
  title
end
image(link, title, alt_text) click to toggle source
# File lib/decidim/proposals/markdown_to_proposals.rb, line 108
def image(link, title, alt_text)
  attrs = %(src="#{link}")
  attrs += %( alt="#{alt_text}") if alt_text.present?
  attrs += %( title="#{title}") if title.present?
  "<img #{attrs}/>"
end
list(_contents, list_type) click to toggle source

Render the list as a whole

# File lib/decidim/proposals/markdown_to_proposals.rb, line 74
def list(_contents, list_type)
  return if @list_items.empty?

  body = case list_type
         when :ordered
           @list_items.collect.with_index { |item, idx| "#{idx + 1}. #{item}\n" }.join
         else
           @list_items.collect { |item| "- #{item}\n" }.join
         end
  # reset items for the next list
  @list_items = []
  create_proposal(
    (@last_position + 1 - @num_sections).to_s,
    body,
    Decidim::Proposals::ParticipatoryTextSection::LEVELS[:article]
  )

  body
end
list_item(text, _list_type) click to toggle source

do not render list items, save them for rendering with the whole list

# File lib/decidim/proposals/markdown_to_proposals.rb, line 95
def list_item(text, _list_type)
  @list_items << text.strip
  nil
end
paragraph(text) click to toggle source

Recarpet callback to process paragraphs. Creates Paricipatory Text Proposals at Article level.

# File lib/decidim/proposals/markdown_to_proposals.rb, line 61
def paragraph(text)
  return if text.blank?

  create_proposal(
    (@last_position + 1 - @num_sections).to_s,
    text,
    Decidim::Proposals::ParticipatoryTextSection::LEVELS[:article]
  )

  text
end
parse(document) click to toggle source
# File lib/decidim/proposals/markdown_to_proposals.rb, line 25
def parse(document)
  renderer = self
  extensions = {
    # no lax_spacing so that it is easier to group paragraphs in articles.
    lax_spacing: false,
    fenced_code_blocks: true,
    autolink: true,
    underline: true
  }
  parser = ::Redcarpet::Markdown.new(renderer, extensions)
  parser.render(document)
end
underline(text) click to toggle source
# File lib/decidim/proposals/markdown_to_proposals.rb, line 123
def underline(text)
  "<u>#{text}</u>"
end

Private Instance Methods

create_proposal(title, body, participatory_text_level) click to toggle source

Prevents PaperTrail from creating versions while producing proposals from a document. A first version will be created when publishing the Participatory Text.

# File lib/decidim/proposals/markdown_to_proposals.rb, line 131
def create_proposal(title, body, participatory_text_level)
  attributes = {
    component: @component,
    title: { I18n.locale => title },
    body: { I18n.locale => body },
    participatory_text_level: participatory_text_level
  }

  PaperTrail.request(enabled: false) do
    proposal = Decidim::Proposals::ProposalBuilder.create(
      attributes: attributes,
      author: @component.organization,
      action_user: @current_user
    )

    @last_position = proposal.position

    proposal
  end
end