Merge pull request #1262 from dradis/liquid/all-project-drops

Load all project drops and parse liquid async

CHANGELOG

@@ -1,6 +1,5 @@
 [v#.#.#] ([month] [YYYY])
-  - [entity]:
-    - [future tense verb] [feature]
+  - Liquid: Make project-level collections available for Liquid syntax
   - Upgraded gems: nokogiri, rails, rexml
   - Bugs fixes:
     - [entity]:

app/assets/javascripts/tylium.js

@@ -51,6 +51,7 @@
 //= require tylium/modules/export
 //= require tylium/modules/fileupload
 //= require tylium/modules/issues
+//= require tylium/modules/liquid_async
 //= require tylium/modules/nodes
 //= require tylium/modules/search
 //= require tylium/modules/sidebar

app/assets/javascripts/tylium/modules/liquid_async.js

@@ -0,0 +1,22 @@
+document.addEventListener('turbolinks:load', function () {
+  $('[data-behavior~=liquid-async]').each(function () {
+    const that = this,
+      data = { text: $(that).attr('data-content') },
+      $spinner = $(that).prev().find('[data-behavior~=liquid-spinner');
+
+    fetch($(that).attr('data-path'), {
+      method: 'POST',
+      headers: {
+        Accept: 'text/html',
+        'Content-Type': 'application/json',
+        'X-CSRF-Token': $('meta[name="csrf-token"]').attr('content'),
+      },
+      body: JSON.stringify(data),
+    })
+      .then((response) => response.text())
+      .then(function (html) {
+        $(that).html(html);
+        $spinner.addClass('d-none');
+      });
+  });
+});

app/assets/stylesheets/tylium/modules.scss

@@ -149,6 +149,7 @@
 }
 
 .header-underline {
+  align-items: center;
   border-bottom: 1px solid $borderColor;
   display: flex;
   margin-bottom: 0.5em;

app/controllers/concerns/liquid_enabled_resource.rb

@@ -35,6 +35,6 @@ def project_assigns
     project = Project.find(params[:project_id])
     authorize! :use, project
 
-    LiquidAssignsService.new(project).assigns
+    LiquidAssignsService.new(project: project, text: params[:text]).assigns
   end
 end

app/helpers/application_helper.rb

@@ -1,5 +1,5 @@
 module ApplicationHelper # :nodoc:
-  def markup(text, options={})
+  def markup(text, options = {})
     return unless text.present?
 
     context = {}
@@ -38,8 +38,8 @@ def render_view_hooks(partial, locals: {}, feature: :addon)
     ;nil
   end
 
-  def spinner_tag(spinner_class: 'text-primary')
-    content_tag :div, class: 'd-flex align-items-center justify-content-center spinner-container' do
+  def spinner_tag(spinner_class: 'text-primary', align: 'center', inline: false)
+    content_tag :div, class: "#{inline ? 'd-inline-flex' : 'd-flex' } align-items-center justify-content-#{align} spinner-container" do
       content_tag :div, nil, class: "spinner-border #{spinner_class}"
     end
   end

app/services/liquid_assigns_service.rb

@@ -1,12 +1,15 @@
 class LiquidAssignsService
-  attr_accessor :project
+  AVAILABLE_PROJECT_ASSIGNS = %w{ evidences issues nodes notes tags }.freeze
 
-  def initialize(project)
+  attr_accessor :project, :text
+
+  def initialize(project:, text: nil)
     @project = project
+    @text = text
   end
 
   def assigns
-    result = { 'project' => ProjectDrop.new(project) }
+    result = project_assigns
     result.merge!(assigns_pro) if defined?(Dradis::Pro)
     result
   end
@@ -15,4 +18,44 @@ def assigns
 
   def assigns_pro
   end
+
+  # This method uses Liquid::VariableLookup to find all liquid variables from
+  # a given text. We use the list to know which project assign we need.
+  def assigns_from_content
+    return AVAILABLE_PROJECT_ASSIGNS if text.nil?
+
+    variable_lookup = Liquid::VariableLookup.parse(text)
+    return (variable_lookup.lookups & AVAILABLE_PROJECT_ASSIGNS)
+  end
+
+  def cached_drops(records, record_type)
+    return [] if records.empty?
+
+    cache_key = "liquid-project-#{project.id}-#{record_type.pluralize}:#{records.maximum(:updated_at).to_i}-#{records.count}"
+    drop_class = "#{record_type.camelize}Drop".constantize
+
+    Rails.cache.fetch(cache_key) do
+      records.map { |record| drop_class.new(record) }
+    end
+  end
+
+  def project_assigns
+    project_assigns = { 'project' => ProjectDrop.new(project) }
+
+    assigns_from_content.each do |record_type|
+      records =
+        case record_type
+        when 'evidences'
+          project.evidence
+        when 'nodes'
+          project.nodes.user_nodes
+        else
+          project.send(record_type.to_sym)
+        end
+
+      project_assigns.merge!(record_type => cached_drops(records, record_type.singularize))
+    end
+
+    project_assigns
+  end
 end

app/views/evidence/show.html.erb

@@ -30,12 +30,10 @@
             <div class="note-text-inner">
               <h4 class="header-underline">
                 <span class="text-truncate" title="Evidence for this instance">Evidence for this instance</span>
+                <%= render partial: 'shared/liquid_loading' %>
                 <%= render partial: 'actions' %>
               </h4>
-
-              <div class="content-textile" data-behavior="content-textile">
-                <%= markup(@evidence.content, liquid: true) %>
-              </div>
+              <%= render partial: 'shared/textile_content', locals: { record: @evidence, preview_path: preview_project_node_evidence_path(current_project, @evidence.node, @evidence) } %>
               <div class="author-info">
                 <span class="ms-auto">Author: <%= @evidence.author || 'n/a' %></span>
               </div>

app/views/issues/show.html.erb

@@ -33,11 +33,10 @@
             <div class="note-text-inner">
               <h4 class="mb-4 header-underline">
                 <span class="text-truncate" title="<%= @issue.title %>"><%= @issue.title %></span>
+                <%= render partial: 'shared/liquid_loading' %>
                 <%= render partial: 'actions' %>
               </h4>
-              <div class="content-textile" data-behavior="content-textile">
-                <%= markup(@issue.text, liquid: true) %>
-              </div>
+              <%= render partial: 'shared/textile_content', locals: { record: @issue, preview_path: preview_project_issue_path(current_project, @issue)  } %>
               <div class="author-info">
                 <span class="ms-auto">Author: <%= @issue.author || 'n/a' %></span>
               </div>

app/views/notes/show.html.erb

@@ -21,11 +21,10 @@
             <div id="<%= dom_id(@note) %>" class="note-text-inner">
               <h4 class="header-underline">
                 <span class="text-truncate" title="<%= @note.title %>"><%= @note.title %></span>
+                <%= render partial: 'shared/liquid_loading' %>
                 <%= render partial: 'actions' %>
               </h4>
-              <div class="content-textile" data-behavior="content-textile">
-                <%= markup(@note.text, liquid: true) %>
-              </div>
+              <%= render partial: 'shared/textile_content', locals: { record: @note, preview_path: preview_project_node_note_path(current_project, @note.node, @note) } %>
               <div class="author-info">
                 <span class="ms-auto">Author: <%= @note.author || 'n/a' %></span>
               </div>

app/views/qa/issues/show.html.erb

@@ -21,6 +21,7 @@
         <div class="note-text-inner">
           <h4 class="mb-4 header-underline align-items-center">
             <span class="text-truncate" title="<%= @issue.title %>"><%= @issue.title %></span>
+            <%= render partial: 'shared/liquid_loading' %>
             <span class="actions">
               <span class="action">
                 <%= link_to edit_project_qa_issue_path(current_project, @issue) do %>
@@ -29,9 +30,7 @@
               </span>
             </span>
           </h4>
-          <div class="content-textile" data-behavior="content-textile">
-            <%= markup(@issue.text, liquid: true) %>
-          </div>
+          <%= render partial: 'shared/textile_content', locals: { record: @issue, preview_path: preview_project_issue_path(current_project, @issue) } %>
           <div class="author-info">
             <span class="ms-auto">Author: <%= @issue.author || 'n/a' %></span>
           </div>

app/views/shared/_liquid_loading.html.erb

@@ -0,0 +1,8 @@
+<div 
+  class="d-inline-flex align-items-center fs-6 fw-light" 
+  data-behavior="liquid-spinner"
+>
+  <span class="mx-2">-</span>
+  <%= spinner_tag spinner_class: 'spinner-border-sm text-primary', align: 'start', inline: true %>
+  <span class="ms-2 text-nowrap">Loading liquid dynamic content</span>
+</div>

app/views/shared/_textile_content.html.erb

@@ -0,0 +1,5 @@
+<% content = record.is_a?(Note) ? record.text : record.content %>
+
+<%= content_tag :div, class: 'content-textile', data: { behavior: 'content-textile liquid-async', path: preview_path, content: content } do %>
+  <%= markup(content) %>
+<% end %>

spec/services/liquid_assigns_service_spec.rb

@@ -3,24 +3,57 @@
 RSpec.describe LiquidAssignsService do
   let!(:project) { create(:project) }
 
-  let(:liquid_assigns) { described_class.new(project).assigns }
+  before do
+    node = create(:node, project: project)
+    issue = create(:issue, node: project.issue_library)
+    create(:evidence, issue: issue, node: node)
+    create(:note, node: node)
+    create(:tag)
+  end
+
+  describe '#project_assigns' do
+    context 'with the :text argument' do
+      LiquidAssignsService::AVAILABLE_PROJECT_ASSIGNS.each do |assign|
+        it "adds #{assign} to the project_assigns if present in the text" do
+          text = "#[Description]#\n {% for #{assign.singularize} in #{assign} %}{% endfor %}\n"
+          liquid_assigns = described_class.new(project: project, text: text).assigns
+
+          expect(liquid_assigns.keys).to include(assign)
+        end
+      end
+    end
 
-  it 'builds a hash of liquid assigns' do
-    expect(liquid_assigns['project'].name).to eq(project.name)
+    context 'without the :text argument' do
+      let(:liquid_assigns) { described_class.new(project: project).assigns }
+
+      it 'builds a hash of liquid assigns' do
+        expect(liquid_assigns['project'].name).to eq(project.name)
+        expect(liquid_assigns['issues'].map(&:title)).to eq(project.issues.map(&:title))
+        expect(liquid_assigns['evidences'].map(&:title)).to eq(project.evidence.map(&:title))
+        expect(liquid_assigns['nodes'].map(&:label)).to eq(project.nodes.user_nodes.map(&:label))
+        expect(liquid_assigns['notes'].map(&:title)).to eq(project.notes.map(&:title))
+        expect(liquid_assigns['tags'].map(&:display_name)).to eq(project.tags.map(&:display_name))
+      end
+    end
   end
 
   context 'with pro records', skip: !defined?(Dradis::Pro)  do
+    let(:liquid_assigns) { described_class.new(project: project).assigns }
+
     let!(:project) { create(:project, :with_team) }
 
     before do
       report_content = project.content_library
       report_content.properties = { 'dradis.project' => project.name }
       report_content.save
+
+      create(:content_block, project: project)
     end
 
     it 'builds a hash with Dradis::Pro assigns' do
       expect(liquid_assigns['document_properties'].available_properties).to eq({ 'dradis.project' => project.name })
       expect(liquid_assigns['team'].name).to eq(project.team.name)
+      expect(liquid_assigns['content_blocks'].map(&:content)).to eq(project.content_blocks.map(&:content))
     end
   end
 end

spec/support/liquid_shared_examples.rb

@@ -9,14 +9,15 @@
     visit @path
   end
 
-  it 'dynamically renders item properties' do
+  it 'dynamically renders item properties', js: true do
+    expect(page).to have_no_css('span.text-nowrap', text: 'Loading liquid dynamic content', wait: 10)
+
     expect(find('.note-text-inner')).to have_content("Liquid: #{record.title}")
     expect(find('.note-text-inner')).not_to have_content("Liquid: {{#{item_type}.title}}")
   end
 end
 
 shared_examples 'liquid preview' do |item_type, node_association|
-
   before do
     @path = if node_association
       polymorphic_path([:edit, current_project, record.node, record])

spec/support/qa_shared_examples.rb

@@ -78,7 +78,9 @@
       visit polymorphic_path([current_project, :qa, record])
     end
 
-    it 'parses liquid content' do
+    it 'parses liquid content', js: true do
+      expect(page).to have_no_css('span.text-nowrap', text: 'Loading liquid dynamic content', wait: 10)
+
       expect(find('.note-text-inner')).to have_content("Liquid: #{record.title}")
       expect(find('.note-text-inner')).not_to have_content("Liquid: {{#{item_type.to_s}.title}}")
     end