dradis-html_export 4.7.0 → 4.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae758e02f855542073277aa3b444e2d3fce2bbfd9272597b38432c83ca0d87f0
-  data.tar.gz: ae4ed11607ecf26f9f098d223119033815099d1605acec28bb4a19ff3f1c2db5
+  metadata.gz: 4f159a418d2f4dea8f4b57772360b8bb3d687c1df4f311a5277da61135532984
+  data.tar.gz: fef4201229f3d73ea441747f072d25b411709cefcd27e9423b2b7ab9af82b310
 SHA512:
-  metadata.gz: 02063660baee8928849fd5a36ae24f73e5661cf96ba6305d551921e34456e894304ed98e36337e095a4ff7438cbfa2e1bc51fb5174645d96ee94707d2e5af51c
-  data.tar.gz: 62ec459d7a00ab9d849a8966a10c42a73695cc7c07920bb5cecaa79093758de5767721b11f1715ec4eea5a5e942f7b87b59411e1f17ec12de3ed9c08fee06a75
+  metadata.gz: 799c8f3fc2a9a8209b12c307ce0fa544497b38825fe669002e56e4986050a85ba7aaaa5f0dcffe6da27cd1057f52c6eabe3e2efac8f96f69794f8f0eb02fcb06
+  data.tar.gz: af728f464fc65494da24da642b173434dbd7d31146438a96bd2690a166f266324f4fe6867f3bd509b8a743acebef4293f34a38c647c9552dbb8e806d5c7bc95e

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+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
+ 
 v4.7.0 (February 2023)
   - No changes
 

data/app/controllers/dradis/plugins/html_export/base_controller.rb

@@ -7,13 +7,12 @@ module Dradis
         #
         # It uses the template at: ./vendor/plugins/html_export/template.html.erb
         def index
-          exporter = Dradis::Plugins::HtmlExport::Exporter.new(export_options)
-          html     = exporter.export
+          exporter = Dradis::Plugins::HtmlExport::Exporter.new(export_params)
+          html = exporter.export
 
           render html: html.html_safe
         end
       end
-
     end
   end
 end

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

@@ -8,15 +8,17 @@
 
     <% 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>
       <% end %>
     <% end %>
 
-    <button id="export-button" class="btn btn-lg btn-primary mt-4">Export</button>
+    <div class="mt-4">
+      <%= render partial: 'export/submit_button', locals: { plugin_name: Dradis::Plugins::HtmlExport::Engine.plugin_name } %>
+    </div>
   <% end %>
 <% end%>

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='nav-link' data-bs-toggle='tab'>HTML</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', '~> 4.0'
+  spec.add_dependency 'dradis-plugins', '>= 4.8.0'
 
   # Note markup
   spec.add_dependency 'rails_autolink', '~> 1.1'

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,7 +8,7 @@ module Dradis
 
       module VERSION
         MAJOR = 4
-        MINOR = 7
+        MINOR = 9
         TINY  = 0
         PRE   = nil
 

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,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: dradis-html_export
 version: !ruby/object:Gem::Version
-  version: 4.7.0
+  version: 4.9.0
 platform: ruby
 authors:
 - Daniel Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-20 00:00:00.000000000 Z
+date: 2023-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dradis-plugins
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 4.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 4.8.0
 - !ruby/object:Gem::Dependency
   name: rails_autolink
   requirement: !ruby/object:Gem::Requirement
@@ -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
@@ -113,6 +114,7 @@ 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