dradis-html_export 3.19.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fcb7bc8d38264378015cd4c8e1685e44a7cd09e1253a01ef073fe9c27069cb7
-  data.tar.gz: 1dd26e8483b3613c68148c0b0ad0707dafa925219ee4e32192096860a11fa42a
+  metadata.gz: 0e30ca0b3eebbe1ddc727fd0b9f9197b25490f545913c9e666282f40508bd858
+  data.tar.gz: 46ab64967389ecd8687c5dbba547ca78b1446bc97ff965f2851983e3ccc168b6
 SHA512:
-  metadata.gz: 98d58bc1d770bf388e73946bbd76cda56ca9fec22f5f1505ff24c9ac8dd71005462ca7bc75fc5b0146402258f683680d32790b2e7f6524d5176bd1b9a81bb7e5
-  data.tar.gz: a387b6edd7adab12deba1868970b03f9c7a02e2fa5f75cff7add7ad37c9bdf2b19f0a1e7cccd2560c3bb1feae1c02db20415b045b476efcab37d076db0ab3dc7
+  metadata.gz: ff0405750e4525d3e9b2cfcaf434dabff1df3d3523fc398e2eaaf7764007e0b0b51c3c8a789e57bebb2f232e660e9ae3dad772985c3efe73ea0a5f8913bdafff
+  data.tar.gz: d52abe89584e52491e3edee462d788ec7d52e14ff38657c1553b624902fe9435882dbba99d4ff2a9909d639a5f9fd76b5dbe758746f752f23c5dcb85df954b7b

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## Dradis Framework 4.0.0 (July, 2021) ##
+
+*   No changes.
+
+## Dradis Framework 3.22 (April, 2021) ##
+
+*   No changes.
+
+## 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) ##
 
 *   No changes.

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/dradis-html_export.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # gem.add_dependency 'dradis_core', version
-  spec.add_dependency 'dradis-plugins', '~> 3.6'
+  spec.add_dependency 'dradis-plugins', '~> 4.0.0'
 
   # Note markup
   spec.add_dependency 'rails_autolink', '~> 1.1'

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

@@ -3,27 +3,30 @@ module Dradis
     module HtmlExport
 
       class Exporter < Dradis::Plugins::Export::Base
-
         def export(args = {})
           log_report
 
-          # Render template
-          ApplicationController.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]
-            }
-          )
+          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]
+              }
+            )
+          end
         end
 
         private
@@ -92,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

@@ -7,8 +7,8 @@ module Dradis
       end
 
       module VERSION
-        MAJOR = 3
-        MINOR = 19
+        MAJOR = 4
+        MINOR = 0
         TINY  = 0
         PRE   = nil
 

data/lib/tasks/thorfile.rb

@@ -15,9 +15,15 @@ class HtmlExportTasks < Thor
 
     report_path = options.output || Rails.root
     unless report_path.to_s =~ /\.html\z/
-      date      = DateTime.now.strftime("%Y-%m-%d")
-      sequence  = Dir.glob(File.join(report_path, "dradis-report_#{date}_*.html")).collect { |a| a.match(/_([0-9]+)\.html\z/)[1].to_i }.max || 0
-      report_path = File.join(report_path, "dradis-report_#{date}_#{sequence + 1}.html")
+      date = DateTime.now.strftime("%Y-%m-%d")
+      base_filename = "dradis-report_#{date}.html"
+
+      report_filename = NamingService.name_file(
+        original_filename: base_filename,
+        pathname: Pathname.new(report_path)
+      )
+
+      report_path = File.join(report_path, report_filename)
     end
 
     if template = options.template

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.19.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Daniel Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-04 00:00:00.000000000 Z
+date: 2021-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dradis-plugins
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: rails_autolink
   requirement: !ruby/object:Gem::Requirement
@@ -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
@@ -102,10 +106,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.1.4
 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