dradis-html_export 4.9.1 → 4.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca36e1c731fed6fecd0df85b0f3e4f8d767b8165c683cab6fa1c9f306d61f741
-  data.tar.gz: 847247d60414d9ab8c1342318421d15b5e2b1cdf1103f6c061ee03d4b21fba23
+  metadata.gz: 27d99c716d170d2268e97a1b0889729ce6e653f4b8e9ab2cfb41c34527b2747a
+  data.tar.gz: ec40e7c9bbb6239f3058b2b8cc223b445290952fb1762b4ac74b22029dbc0391
 SHA512:
-  metadata.gz: afad897697ffc0473072d1b2bf4b074724c3ec38286a3328eb34c654bff1676543168d3ef5081b1fa51dfaae8c1bd1eb7a754a95e66327399cd284a4c03585dd
-  data.tar.gz: ed111b118353cc1419f6d141975275a4982ca910aefd139bf6bf286bbd8372902d98c1d889051883c3242102ce627663b23c4d36fd0a9556fd0de627e2f0ced2
+  metadata.gz: d7d68a975f8517af01b889567140163cdaa42b4a7ce786a3b68d06cc07f72310e8e8dac35b1cebe151a23e123f9c909065fd4e6db95d9eb9b8c0e2e56d2919aa
+  data.tar.gz: a8b48338691dbedcf04abb428fee667389c5a90ac0a015341c1c101581cd25260a09654715f3f757a0fa04ca79c0ba93c29eecde277da1d896d57a094657ee6b

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+v4.10.0 (September 2023)
+  - Add support for enabling/disabling
+  - Prevent exporting reports without any HTML templates
+  - Fix the default templates
+  - Implement handling of HTML exports directly from Tylium
+  - Update views for compatibility with Font Awesome 6
+  - Update gemspec links
+
 v4.9.1 (June 2023)
   - Show HTML export tab by default in CE's export view
 
@@ -6,7 +14,7 @@ v4.9.0 (June 2023)
 
 v4.8.0 (April 2023)
   - Add feature to select published/all records for export
- 
+
 v4.7.0 (February 2023)
   - No changes
 

data/app/controllers/dradis/plugins/html_export/{base_controller.rb → reports_controller.rb}

@@ -1,13 +1,14 @@
 module Dradis
   module Plugins
     module HtmlExport
-      class BaseController < Dradis::Plugins::Export::BaseController
+      class ReportsController < Dradis::Plugins::Export::BaseController
         # This method cycles throw the notes in the reporting category and creates
         # a simple HTML report with them.
         #
         # It uses the template at: ./vendor/plugins/html_export/template.html.erb
-        def index
-          exporter = Dradis::Plugins::HtmlExport::Exporter.new(export_params)
+        def create
+          options = export_params.merge(template: @template_file)
+          exporter = Dradis::Plugins::HtmlExport::Exporter.new(options)
           html = exporter.export
 
           render html: html.html_safe

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

@@ -1,24 +1,25 @@
 <%= 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 %>
-
-    <h4 class="header-underline">Choose a template</h4>
-    <p>Please choose one of the templates available for this plugin (find them in <code>.<%= Dradis::Plugins::HtmlExport::TemplatePresenter.templates_dir[Rails.root.to_s.length..-1] %></code>)</p>
-
-    <% Dradis::Plugins::HtmlExport::TemplatePresenter.each_template do |template| %>
-      <% present(template, Dradis::Plugins::HtmlExport::TemplatePresenter) do |template_presenter| %>
-        <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>
+  <% if Dradis::Plugins::HtmlExport::TemplatePresenter.templates.any? %>
+    <%= form_tag html_export.project_report_path(current_project) do %>
+      <h4 class="header-underline">Choose a template</h4>
+      <p>Please choose one of the templates available for this plugin (find them in <code>.<%= Dradis::Plugins::HtmlExport::TemplatePresenter.templates_dir[Rails.root.to_s.length..-1] %></code>)</p>
+    
+      <% Dradis::Plugins::HtmlExport::TemplatePresenter.each_template do |template| %>
+        <% present(template, Dradis::Plugins::HtmlExport::TemplatePresenter) do |template_presenter| %>
+          <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>
+        <% end %>
       <% end %>
-    <% end %>
 
-    <div class="mt-4">
-      <%= render partial: 'export/submit_button', locals: { plugin_name: Dradis::Plugins::HtmlExport::Engine.plugin_name } %>
-    </div>
+      <div class="mt-4">
+        <%= render partial: 'export/submit_button', locals: { plugin_name: Dradis::Plugins::HtmlExport::Engine.plugin_name } %>
+      </div>
+    <% end %>
+  <% else %>
+    <%= render partial: 'export/no_templates', locals: { plugin_name: Dradis::Plugins::HtmlExport::Engine.plugin_name } %>
   <% end %>
-<% end%>
+<% end %>

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

@@ -1,3 +1,3 @@
 <li class='nav-item'>
-  <a href='#plugin-html_export' class="<%= class_names('nav-link', active: !defined?(Dradis::Pro)) %>" data-bs-toggle='tab'>HTML</a>
+  <a href='#plugin-html_export' class="<%= class_names('nav-link', active: !defined?(Dradis::Pro)) %>" data-bs-toggle='tab'><i class="fa-solid fa-file-code fa-fw"></i>HTML</a>
 </li>

data/config/routes.rb

@@ -1,3 +1,5 @@
 Dradis::Plugins::HtmlExport::Engine.routes.draw do
-  root to: 'base#index'
+  resources :projects, only: [] do
+    resource :report, only: [:create], path: '/export/html/reports'
+  end
 end

data/dradis-html_export.gemspec

@@ -1,24 +1,24 @@
 # -*- encoding: utf-8 -*-
+
 require File.expand_path('../lib/dradis/plugins/html_export/version', __FILE__)
 version = Dradis::Plugins::HtmlExport::version
 
 Gem::Specification.new do |spec|
   spec.platform      = Gem::Platform::RUBY
-  spec.name          = "dradis-html_export"
+  spec.name          = 'dradis-html_export'
   spec.version       = version
   spec.required_ruby_version = '>= 1.9.3'
   spec.license       = 'GPL-2'
 
   spec.authors       = ['Daniel Martin']
-  spec.email         = ["<etd@nomejortu.com>"]
-  spec.description   = %q{Export to HTML plugin for the Dradis Framework}
-  spec.summary       = %q{Dradis HTML export plugin}
-  spec.homepage      = 'http://dradisframework.org'
+  spec.description   = 'Export to HTML plugin for the Dradis Framework'
+  spec.summary       = 'Dradis HTML export plugin'
+  spec.homepage      = 'http://dradis.com'
 
   spec.files         = `git ls-files`.split($\)
-  spec.executables   = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  spec.executables   = spec.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   # gem.add_dependency 'dradis_core', version
   spec.add_dependency 'dradis-plugins', '>= 4.8.0'

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

@@ -18,13 +18,21 @@ module Dradis
         provides :export, :rtp
         description 'Generate advanced HTML reports'
 
+        addon_settings :html_export do
+          settings.default_enabled = false
+        end if defined?(Dradis::Pro)
+
         initializer 'dradis-html_export.mount_engine' do
           Rails.application.routes.append do
-            mount Dradis::Plugins::HtmlExport::Engine => '/export/html'
+            # Enabling/disabling integrations calls Rails.application.reload_routes! we need the enable
+            # check inside the block to ensure the routes can be re-enabled without a server restart
+            if Engine.enabled?
+              mount Engine => '/', as: :html_export
+            end
           end
         end
 
-        initializer 'draids-html_export.include_helper' do
+        initializer 'dradis-html_export.include_helper' do
           ActiveSupport.on_load(:action_view) do
             Dradis::Plugins::HtmlExport::Exporter.include(ApplicationHelper)
           end

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

@@ -2,6 +2,8 @@ module Dradis
   module Plugins
     module HtmlExport
       class Exporter < Dradis::Plugins::Export::Base
+        include ActionView::Helpers::TextHelper
+
         def export(args = {})
           log_report
 

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

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

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

@@ -1,6 +1,8 @@
 require 'rails_helper'
 
 describe Dradis::Plugins::HtmlExport::Exporter do
+  before { Dradis::Plugins::HtmlExport::Exporter.include(ApplicationHelper) }
+
   let!(:project) { create(:project, :with_team) }
 
   let!(:content_blocks) { create_list(:content_block, 5, project: project) }
@@ -8,7 +10,7 @@ describe Dradis::Plugins::HtmlExport::Exporter do
   let!(:nodes) { create_list(:node, 5, project: project) }
   let!(:tags) { create_list(:tag, 5, project: project) }
 
-  let(:controller) { Dradis::Plugins::HtmlExport::BaseController.new }
+  let(:controller) { Dradis::Plugins::HtmlExport::ExportController.new }
 
   let(:exporter) { described_class.new(export_options) }
 
@@ -31,6 +33,46 @@ describe Dradis::Plugins::HtmlExport::Exporter do
     end
   end
 
+  context 'templates' do
+    describe 'basic template' do
+      let(:export_options) do
+        {
+          project_id: project.id,
+          template: Dradis::Plugins::HtmlExport::Engine.root.join(
+            'templates/basic.html.erb'
+          )
+        }
+      end
+
+      it 'exports html' do
+        html = exporter.export
+
+        issues.each do |issue|
+          expect(html.include?(issue.title))
+        end
+      end
+    end
+
+    describe 'default template' do
+      let(:export_options) do
+        {
+          project_id: project.id,
+          template: Dradis::Plugins::HtmlExport::Engine.root.join(
+            'templates/default_dradis_template_v3.0.html.erb'
+          )
+        }
+      end
+
+      it 'exports html' do
+        html = exporter.export
+
+        issues.each do |issue|
+          expect(html.include?(issue.title))
+        end
+      end
+    end
+  end
+
   context 'liquid' do
     let(:export_options) do
       {

data/templates/basic.html.erb

@@ -26,14 +26,14 @@
     <section>
       <h2>Issues</h2>
       <% issues.each do |issue| %>
-      <div class="note"><%= markup(issue.text) %></div>
+      <div class="note"><%= markup(issue.text, liquid: true) %></div>
       <% end %>
     </section>
 
     <section>
-      <h2>Notes assigned to the <%= reporting_cat.name %> category</h2>
+      <h2>Notes</h2>
       <% notes.each do |note| %>
-      <div class="note"><%= markup(note.text) %></div>
+      <div class="note"><%= markup(note.text, liquid: true) %></div>
       <% end %>
     </section>
 

data/templates/default_dradis_template_v3.0.html.erb

@@ -70,7 +70,7 @@
       <% notes.each do |note| %>
       <div class="panel panel-default">
         <div class="panel-body">
-          <%= markup(note.text) %>
+          <%= markup(note.text, liquid: true) %>
         </div>
       </div>
       <% end %>
@@ -81,7 +81,7 @@
       <% issues.each do |issue| %>
       <div class="panel panel-default">
         <div class="panel-body">
-          <%= markup(issue.text) %>
+          <%= markup(issue.text, liquid: true) %>
 
           <h3>Assets affected by this issue</h3>
           <% if issue.affected.empty? %>
@@ -101,7 +101,7 @@
                   <section id="evidence_for_#{node.id}">
                     <% if instances.count == 1 %>
                       <div class="content-textile" id="node_<%= node.id %>_instance_0">
-                        <%= markup(instances.first.content) %>
+                        <%= markup(instances.first.content, liquid: true) %>
                       </div>
                     <% else %>
                       <ul class="nav nav-tabs">
@@ -113,7 +113,7 @@
                       <div class="tab-content">
                         <% instances.each_with_index do |evidence, i| %>
                         <div class="content-textile tab-pane<%= ' active' if i==0 %>" id="node_<%= node.id %>_instance_<%= i %>">
-                          <%= markup(evidence.content) %>
+                          <%= markup(evidence.content, liquid: true) %>
                         </div>
                         <% end %>
                       </div>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dradis-html_export
 version: !ruby/object:Gem::Version
-  version: 4.9.1
+  version: 4.10.0
 platform: ruby
 authors:
 - Daniel Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-02 00:00:00.000000000 Z
+date: 2023-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dradis-plugins
@@ -53,8 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 4.3.2
 description: Export to HTML plugin for the Dradis Framework
-email:
-- "<etd@nomejortu.com>"
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -69,7 +68,7 @@ files:
 - Gemfile
 - README.md
 - Rakefile
-- app/controllers/dradis/plugins/html_export/base_controller.rb
+- app/controllers/dradis/plugins/html_export/reports_controller.rb
 - app/presenters/dradis/plugins/html_export/template_presenter.rb
 - app/views/dradis/plugins/html_export/export/_index-content.html.erb
 - app/views/dradis/plugins/html_export/export/_index-tabs.html.erb
@@ -90,7 +89,7 @@ files:
 - spec/spec_helper.rb
 - templates/basic.html.erb
 - templates/default_dradis_template_v3.0.html.erb
-homepage: http://dradisframework.org
+homepage: http://dradis.com
 licenses:
 - GPL-2
 metadata: {}
@@ -109,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Dradis HTML export plugin