dradis-html_export 3.20.0 → 3.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f6ac583114b620b0f712eec9d0d4635012a0566e1b6b5bf6e331b708991c223
-  data.tar.gz: 571a3c231cddac14d08577f6811dd8beab715a0387fc763a99ce57b8340e9110
+  metadata.gz: f29710e9f73ca0b7af15e9fbe8c3bd980d549393993c9dc6a801930921d01ceb
+  data.tar.gz: 221eb9afccb68af19eedb080964f9e60dca1518f473beaeaee91b7680b92bc7d
 SHA512:
-  metadata.gz: 6700179c827068d2810787d028bdc0621f918e86588d7c666547e7ea00be5425e141b15740cab0b0afe359021f13e28e1300c4a03edd87e7e2b86cd0b6adb1b8
-  data.tar.gz: 36b73d54c2167cf49063882d9521e6954562331a3edc4464ec77b3f951302ad8ebc20ded1b9a7d996acc369e2000364ee916b0d2e6a5b1a2038d43ae6a7b1800
+  metadata.gz: b7c8395019a1b5e1eec2ab049ab9c475d6ee57a9d30819cc4023d14dbc78428355e5045c924265e4e3edb25bf7ca2da48af09fcc90e6810f62f0162fd43e3e46
+  data.tar.gz: 3f2912502311e65530cca4d8641a3e7d24d921dff1baefd3af118a195aaa90f288974849286d8ea397c17d8f06f51fde2ade20e9ebab6c2fc15279e89898acea

data/CHANGELOG.md

@@ -1,6 +1,11 @@
+## Dradis Framework 3.21 (February, 2021) ##
+
+*   Add a fix for Rails 6 not allowing HTML rendering outside the view directory.
+
 ## Dradis Framework 3.20 (December, 2020) ##
 
 *   Add an option in the exporter to pass a controller for rendering.
+*   Add views for the export view.
 *   Use NamingService to build export filename.
 
 ## Dradis Framework 3.19 (September, 2020) ##

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

@@ -0,0 +1,23 @@
+<%
+  templates_dir = File.join(::Configuration::paths_templates_reports, 'html_export')
+  templates = Dir["%s/*" % templates_dir].map { |t| File.basename(t) }.sort
+%>
+
+<%= content_tag :div, id: 'plugin-html_export', class: 'tab-pane fade' do %>
+  <%= form_tag project_export_manager_path(current_project), target: '_blank' do %>
+    <%= hidden_field_tag :plugin, :html_export %>
+    <%= hidden_field_tag :route, :root %>
+
+    <h4 class="header-underline">Choose a template</h4>
+    <p>Please choose one of the templates available for this plugin (find them in <code>.<%= templates_dir[Rails.root.to_s.length..-1] %></code>)</p>
+
+    <% templates.each do |template| %>
+      <div class="custom-control custom-radio">
+        <%= radio_button_tag :template, template, template == templates.first, :class => 'custom-control-input' %>
+        <label class="custom-control-label" for="template_<%= template %>"><%= template %></label>
+      </div>
+    <% end %>
+
+    <button id="export-button" class="btn btn-lg btn-primary mt-4">Export</button>
+  <% end %>
+<% end%>

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

@@ -0,0 +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>
+</li>

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

@@ -3,29 +3,30 @@ module Dradis
     module HtmlExport
 
       class Exporter < Dradis::Plugins::Export::Base
-
         def export(args = {})
           log_report
 
           controller = args[:controller] || ApplicationController
 
-          # Render template
-          controller.render(
-            file: options.fetch(: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]
-            }
-          )
+          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]
+              }
+            )
+          end
         end
 
         private
@@ -94,6 +95,19 @@ module Dradis
                        "Dradis Community Edition v#{Dradis::CE.version}"
                      end
         end
+
+        def with_temporary_template(original, &block)
+          filename = File.basename(Dir::Tmpname.create(['', '.html.erb']) {})
+          destination_path = Rails.root.join('app', 'views', 'tmp', filename)
+
+          FileUtils.mkdir_p(File.dirname(destination_path))
+          FileUtils.cp(original, destination_path)
+
+          yield("tmp/#{filename}")
+        ensure
+          file_path = Rails.root.join("app/views/tmp/#{filename}")
+          File.delete(file_path) if File.exists?(file_path)
+        end
       end
     end
   end

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

@@ -8,7 +8,7 @@ module Dradis
 
       module VERSION
         MAJOR = 3
-        MINOR = 20
+        MINOR = 21
         TINY  = 0
         PRE   = nil
 

data/spec/fixtures/files/template.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) %></p>
+    <% end %>
+  </body>
+</html>

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

@@ -0,0 +1,25 @@
+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(:exporter) { described_class.new(export_options) }
+
+  it 'exports html' do
+    html = exporter.export
+
+    issues.each do |issue|
+      expect(html.include?(issue.title))
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dradis-html_export
 version: !ruby/object:Gem::Version
-  version: 3.20.0
+  version: 3.21.0
 platform: ruby
 authors:
 - Daniel Martin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-07 00:00:00.000000000 Z
+date: 2021-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dradis-plugins
@@ -70,6 +70,8 @@ files:
 - README.md
 - Rakefile
 - app/controllers/dradis/plugins/html_export/base_controller.rb
+- app/views/dradis/plugins/html_export/export/_index-content.html.erb
+- app/views/dradis/plugins/html_export/export/_index-tabs.html.erb
 - config/routes.rb
 - dradis-html_export.gemspec
 - lib/dradis-html_export.rb
@@ -79,6 +81,8 @@ files:
 - lib/dradis/plugins/html_export/gem_version.rb
 - lib/dradis/plugins/html_export/version.rb
 - lib/tasks/thorfile.rb
+- spec/fixtures/files/template.html.erb
+- spec/lib/dradis/plugins/html_export/exporter_spec.rb
 - spec/requests/html_export_spec.rb
 - spec/spec_helper.rb
 - templates/basic.html.erb
@@ -107,5 +111,7 @@ signing_key:
 specification_version: 4
 summary: Dradis HTML export plugin
 test_files:
+- spec/fixtures/files/template.html.erb
+- spec/lib/dradis/plugins/html_export/exporter_spec.rb
 - spec/requests/html_export_spec.rb
 - spec/spec_helper.rb