dradis-html_export 4.8.0 → 4.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33775e0ad945bd81755715cbf8e456e5dff150b8c68345b81939ff638e845492
-  data.tar.gz: ad4c037605dfeddead30d36ee617face34fb654dfff8644d3749406d52b1e8c9
+  metadata.gz: ca36e1c731fed6fecd0df85b0f3e4f8d767b8165c683cab6fa1c9f306d61f741
+  data.tar.gz: 847247d60414d9ab8c1342318421d15b5e2b1cdf1103f6c061ee03d4b21fba23
 SHA512:
-  metadata.gz: 1cf2fba75c376bf10f08b1db6fefe02b924a4f3969400bbb2177f2d2dae0da4db5899c6ebe6cd4f1267564f3633594e29a1cc7d339930863b440cec6f48b3ee0
-  data.tar.gz: 507a013795af1a52eb554622faf4257f789b6be034169f4bb325c2691b2ffca0ff53dd33bf1610897aedd41d0306aa33fad3c448731444c748a389b4ebbd35be
+  metadata.gz: afad897697ffc0473072d1b2bf4b074724c3ec38286a3328eb34c654bff1676543168d3ef5081b1fa51dfaae8c1bd1eb7a754a95e66327399cd284a4c03585dd
+  data.tar.gz: ed111b118353cc1419f6d141975275a4982ca910aefd139bf6bf286bbd8372902d98c1d889051883c3242102ce627663b23c4d36fd0a9556fd0de627e2f0ced2

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+v4.9.1 (June 2023)
+  - Show HTML export tab by default in CE's export view
+
+v4.9.0 (June 2023)
+  - Update views for compatibility with Bootstrap 5
+
 v4.8.0 (April 2023)
   - Add feature to select published/all records for export
  

data/app/views/dradis/plugins/html_export/export/_index-content.html.erb

@@ -1,4 +1,4 @@
-<%= content_tag :div, id: 'plugin-html_export', class: 'tab-pane fade' do %>
+<%= content_tag :div, id: 'plugin-html_export', class: class_names('tab-pane', 'fade', 'active show': !defined?(Dradis::Pro)) do %>
   <%= form_tag project_export_manager_path(current_project), target: '_blank' do %>
     <%= hidden_field_tag :plugin, :html_export %>
     <%= hidden_field_tag :route, :root %>
@@ -8,9 +8,9 @@
 
     <% Dradis::Plugins::HtmlExport::TemplatePresenter.each_template do |template| %>
       <% present(template, Dradis::Plugins::HtmlExport::TemplatePresenter) do |template_presenter| %>
-        <div class="custom-control custom-radio">
-          <%= radio_button_tag :template, template_presenter.filename, Dradis::Plugins::HtmlExport::TemplatePresenter.templates.first == template , class: 'custom-control-input' %>
-          <label class="custom-control-label" for="template_<%= template_presenter.filename %>">
+        <div class="form-check">
+          <%= radio_button_tag :template, template_presenter.filename, Dradis::Plugins::HtmlExport::TemplatePresenter.templates.first == template , class: 'form-check-input' %>
+          <label class="form-check-label" for="template_<%= template_presenter.filename %>">
             <%= template_presenter.title %>
           </label>
         </div>

data/app/views/dradis/plugins/html_export/export/_index-tabs.html.erb

@@ -1,3 +1,3 @@
 <li class='nav-item'>
-  <a href='#html_export' class='nav-link' data-toggle='tab' data-target='#plugin-html_export'>Generate advanced HTML reports</a>
+  <a href='#plugin-html_export' class="<%= class_names('nav-link', active: !defined?(Dradis::Pro)) %>" data-bs-toggle='tab'>HTML</a>
 </li>

data/lib/dradis/plugins/html_export/engine.rb

@@ -2,7 +2,6 @@ module Dradis
   module Plugins
     module HtmlExport
       class Engine < ::Rails::Engine
-
         # Standard Rails Engine stuff
         isolate_namespace Dradis::Plugins::HtmlExport
         engine_name 'dradis_html_export'
@@ -19,12 +18,17 @@ module Dradis
         provides :export, :rtp
         description 'Generate advanced HTML reports'
 
-
         initializer 'dradis-html_export.mount_engine' do
           Rails.application.routes.append do
             mount Dradis::Plugins::HtmlExport::Engine => '/export/html'
           end
         end
+
+        initializer 'draids-html_export.include_helper' do
+          ActiveSupport.on_load(:action_view) do
+            Dradis::Plugins::HtmlExport::Exporter.include(ApplicationHelper)
+          end
+        end
       end
     end
   end

data/lib/dradis/plugins/html_export/exporter.rb

@@ -1,31 +1,13 @@
 module Dradis
   module Plugins
     module HtmlExport
-
       class Exporter < Dradis::Plugins::Export::Base
         def export(args = {})
           log_report
 
-          controller = args[:controller] || ApplicationController
-
           with_temporary_template(options[:template]) do |temporary_template|
-            # Render template
-            controller.render(
-              template: temporary_template,
-              layout: false,
-              locals: {
-                categorized_issues: categorized_issues,
-                content_service: content_service,
-                issues: issues,
-                nodes: nodes,
-                notes: notes,
-                project: project,
-                reporting_cat: content_service.report_category,
-                tags: tags,
-                title: title,
-                user: options[:user]
-              }
-            )
+            erb = ERB.new(File.read(temporary_template))
+            erb.result(binding)
           end
         end
 
@@ -89,11 +71,30 @@ module Dradis
         end
 
         def title
-          @title ||= if Dradis.constants.include?(:Pro)
-                       "Dradis Professional Edition v#{Dradis::Pro.version}"
-                     else
-                       "Dradis Community Edition v#{Dradis::CE.version}"
-                     end
+          @title ||=
+            if Dradis.constants.include?(:Pro)
+              "Dradis Professional Edition v#{Dradis::Pro.version}"
+            else
+              "Dradis Community Edition v#{Dradis::CE.version}"
+            end
+        end
+
+        def liquid_assigns
+          assigns = {
+            'issues' => issues.map { |issue| IssueDrop.new(issue) },
+            'nodes' => nodes.map { |node| NodeDrop.new(node) },
+            'project' => ProjectDrop.new(project),
+            'tags' => tags.map { |tag| TagDrop.new(tag) }
+          }
+
+          if defined?(Dradis::Pro)
+            assigns.merge!(
+              'content_blocks' => content_service.all_content_blocks.map { |c| ContentBlockDrop.new(c) },
+              'document_properties' => DocumentPropertiesDrop.new(properties: project.content_library.properties)
+            )
+          end
+
+          assigns
         end
 
         def with_temporary_template(original, &block)
@@ -103,7 +104,7 @@ module Dradis
           FileUtils.mkdir_p(File.dirname(destination_path))
           FileUtils.cp(original, destination_path)
 
-          yield("tmp/#{filename}")
+          yield(destination_path)
         ensure
           file_path = Rails.root.join("app/views/tmp/#{filename}")
           File.delete(file_path) if File.exists?(file_path)

data/lib/dradis/plugins/html_export/gem_version.rb

@@ -8,8 +8,8 @@ module Dradis
 
       module VERSION
         MAJOR = 4
-        MINOR = 8
-        TINY  = 0
+        MINOR = 9
+        TINY  = 1
         PRE   = nil
 
         STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")

data/spec/fixtures/files/liquid.html.erb

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>My Title</title>
+  </head>
+  <body>
+    <h2>Issues</h2>
+    <% issues.each do |issue| %>
+      <p><%= markup(issue.text, liquid: true) %></p>
+    <% end %>
+  </body>
+</html>

data/spec/lib/dradis/plugins/html_export/exporter_spec.rb

@@ -1,25 +1,108 @@
 require 'rails_helper'
 
 describe Dradis::Plugins::HtmlExport::Exporter do
-  let!(:project) { create(:project) }
-  let!(:issues) { create_list(:issue, 3, node: project.issue_library) }
-
-  let(:export_options) do
-    {
-      project_id: project.id,
-      template: Dradis::Plugins::HtmlExport::Engine.root.join(
-        'spec/fixtures/files/template.html.erb'
-      )
-    }
-  end
+  let!(:project) { create(:project, :with_team) }
+
+  let!(:content_blocks) { create_list(:content_block, 5, project: project) }
+  let!(:issues) { create_list(:issue, 5, node: project.issue_library) }
+  let!(:nodes) { create_list(:node, 5, project: project) }
+  let!(:tags) { create_list(:tag, 5, project: project) }
+
+  let(:controller) { Dradis::Plugins::HtmlExport::BaseController.new }
 
   let(:exporter) { described_class.new(export_options) }
 
-  it 'exports html' do
-    html = exporter.export
+  context 'html' do
+    let(:export_options) do
+      {
+        project_id: project.id,
+        template: Dradis::Plugins::HtmlExport::Engine.root.join(
+          'spec/fixtures/files/template.html.erb'
+        )
+      }
+    end
+
+    it 'exports html' do
+      html = exporter.export
+
+      issues.each do |issue|
+        expect(html.include?(issue.title))
+      end
+    end
+  end
+
+  context 'liquid' do
+    let(:export_options) do
+      {
+        project_id: project.id,
+        template: Dradis::Plugins::HtmlExport::Engine.root.join(
+          'spec/fixtures/files/liquid.html.erb'
+        )
+      }
+    end
+
+    before do
+      report_content = project.content_library
+      report_content.properties = {
+        'dradis.project' => project.name,
+        'dradis.version' => 'v1.0'
+      }
+      report_content.save
+
+      nodes.each do |node|
+        create(:evidence, node: node, issue: issues.first)
+      end
+
+      create(:issue,
+        node: project.issue_library,
+        text: <<-TEXT
+#[Title]#
+Test Issue
+
+#[Description]#
+*Project:* {{ project.name }}
+*Document Properties:*
+* {{ document_properties.dradis.project }}
+* {{ document_properties.dradis.version }}
+
+*Nodes:*
+{% for node in nodes %}
+* {{ node.label }}
+{% endfor %}
+
+*Content blocks:*
+{% for content_block in content_blocks %}
+* {{ content_block.fields['Title'] }}
+{% endfor %}
+
+*Tags:*
+{% for tag in tags %}
+* {{ tag.name }}
+{% endfor %}
+TEXT
+      )
+    end
+
+    it 'parses liquid syntax' do
+      html = exporter.export
+
+      expect(html).to include project.name
+
+      project.content_library.properties.each do |_, value|
+        expect(html).to include value
+      end
+
+      nodes.each do |node|
+        expect(html).to include node.label
+      end
+
+      content_blocks.each do |content_block|
+        expect(html).to include content_block.title
+      end
 
-    issues.each do |issue|
-      expect(html.include?(issue.title))
+      tags.each do |tag|
+        expect(html).to include tag.name
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dradis-html_export
 version: !ruby/object:Gem::Version
-  version: 4.8.0
+  version: 4.9.1
 platform: ruby
 authors:
 - Daniel Martin
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-12 00:00:00.000000000 Z
+date: 2023-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dradis-plugins
@@ -82,6 +82,7 @@ files:
 - lib/dradis/plugins/html_export/gem_version.rb
 - lib/dradis/plugins/html_export/version.rb
 - lib/tasks/thorfile.rb
+- spec/fixtures/files/liquid.html.erb
 - spec/fixtures/files/template.html.erb
 - spec/lib/dradis/plugins/html_export/exporter_spec.rb
 - spec/presenters/dradis/plugins/html_export/template_presenter_spec.rb
@@ -93,7 +94,7 @@ homepage: http://dradisframework.org
 licenses:
 - GPL-2
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -108,11 +109,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: Dradis HTML export plugin
 test_files:
+- spec/fixtures/files/liquid.html.erb
 - spec/fixtures/files/template.html.erb
 - spec/lib/dradis/plugins/html_export/exporter_spec.rb
 - spec/presenters/dradis/plugins/html_export/template_presenter_spec.rb