dradis-html_export 3.16.0 → 3.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e2bed448d7dd1b3038207793b3c1b22163d93b8cb8caaacac94c3232ac4b11f
-  data.tar.gz: f56b207d4739c5eacde0cfa506aef41e41942dc7145cb632737e7f6296c071ec
+  metadata.gz: 8ff810f1056abb025188e810af787950b710ed140b919a3c4c8e28750bbdb757
+  data.tar.gz: 0bf32f0708e38397d807df364ac6a781f23c2cf4a2aaeaf930830e2745c98f8d
 SHA512:
-  metadata.gz: a055468ffac66d7a13bb0d52fd60b4430421d834bc866d70510a70d6e1619fce75b96201c4ca12fe2462eef831ba9f4f4e89a757942132d008565dffed84ca63
-  data.tar.gz: '096bc01b204b281c1a43f502a5cd6d16d827c7388229acb90f496a7ee858c3d1cf6d70f477869568ee034d69559a7133e2b183e3165521d02c34253438a0f7ab'
+  metadata.gz: b85f5c997dbe5664c007ef8b1c40010cf38e123bf57360a5ddf32b6686d33b79ae9d5dc411913945fa5c97f18f8c259c960a1710cb414ee2dea117519234d177
+  data.tar.gz: 6a60cacc47c5fbe64431a9f47865dff2f3fa645e53c1d2b13fb733a279b63794cd9e7f6c610bfe996083dc6d3ecb8e9caf723b5f8a77206e8a73a60eaf4cce52

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## Dradis Framework 3.17 (May, 2020) ##
+
+*   Render report using main app's ApplicationController#render.
+
 ## Dradis Framework 3.16 (February, 2020) ##
 
 *   No changes.
@@ -6,9 +10,6 @@
 
 *   No changes.
 
-## Dradis Framework 3.15 (August, 2019) ##
-
-*   No changes.
 
 ## Dradis Framework 3.14 (August, 2019) ##
 

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

@@ -3,75 +3,94 @@ module Dradis
     module HtmlExport
 
       class Exporter < Dradis::Plugins::Export::Base
-        # Add auto_link support to the ERB processor (see rails_autolink)
-        include ::ActionView::Helpers::TextHelper
-        # For auto_link feature (requires #mail_to)
-        include ::ActionView::Helpers::UrlHelper
 
         def export(args = {})
-          template_path       = options.fetch(:template)
-          template_properties = ::ReportTemplateProperties.find_by_template_file(File.basename(template_path)) rescue nil
+          log_report
 
-          # Build title
-          title = if Dradis.constants.include?(:Pro)
-                    "Dradis Professional Edition v#{Dradis::Pro.version}"
-                  else
-                    "Dradis Community Edition v#{Dradis::CE.version}"
-                  end
-          logger.debug{ "Report title: #{title}"}
-
-          # Prepare notes
-          reporting_cat = content_service.report_category
-          notes = content_service.all_notes
-          logger.debug{ "Found #{notes.count} notes assigned to the reporting category."}
-
-          # Prepare issues
-          issues = content_service.all_issues
-          if issues
-            # Sort our issues based on the ReportTemplateProperties rules.
-            if template_properties && template_properties.sort_field
-              sort_by = template_properties.sort_field
+          # 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]
+            }
+          )
+        end
 
-              logger.debug{ "Template properties define a sort field: #{sort_by}. Sorting..." }
+        private
+        def log_report
+          logger.debug { "Report title: #{title}" }
+          logger.debug { "Template properties define a sort field: #{sort_field}" }
 
-              # FIXME: Assume the Field :type is :number, so cast .to_f and sort
-              issues.to_a.sort! do |a, b|
-                b.fields.fetch(sort_by, '0').to_f <=> a.fields.fetch(sort_by, '0').to_f
-              end
+          if issues&.any?
+            logger.debug { "Found #{issues.count} issues affecting #{nodes.count} nodes" }
+          else
+            logger.warn { 'No issue library node found in this project' }
+          end
 
-              logger.debug{ "Done." }
-            end
+          logger.debug { "Found #{notes.count} notes assigned to the reporting category." }
+        end
 
-            # FIXME: This is an ugly piece of code and the list of nodes should
-            # come from the ContentService.
-            nodes = issues.map(&:evidence).flatten.map(&:node).uniq
+        def nodes
+          # FIXME: This is an ugly piece of code and the list of nodes should
+          # come from the ContentService.
+          @nodes ||= issues.map(&:evidence).flatten.map(&:node).uniq
+        end
 
-            logger.debug{ "Found #{issues.count} issues affecting #{nodes.count} nodes" }
-          else
-            logger.warning { "No issue library node found in this project" }
-          end
+        def notes
+          @notes ||= content_service.all_notes
+        end
 
-          # Render template
-          erb = ERB.new( File.read(template_path) )
-          erb.result( binding )
+        def issues
+          @issues ||= sort_issues content_service.all_issues.includes(:tags)
         end
 
-        private
+        def categorized_issues
+          @categorized_issues ||= tags
+            .each_with_object({}) do |tag, hash|
+              hash[tag.id] = issues.select { |issue| issue.tags.include?(tag) }
+            end
+            .tap do |hash|
+              hash[:untagged] = issues.select { |issue| issue.tags.empty? }
+            end
+        end
 
-        # FIXME This method is a behavioural duplicate of ApplicationHelper#markup
-        # from the main app, it would be better to re-use that code.
-        def markup(text)
-          return unless text.present?
+        def sort_field
+          @sort_field ||= begin
+            template_path = options.fetch(:template)
+            properties = ::ReportTemplateProperties.find_by_template_file(File.basename(template_path)) rescue nil
+            properties&.sort_field
+          end
+        end
 
-          # escape HTML 'manually' instead of using RedCloth's "filter_html"
-          # for security reasons
-          output = ERB::Util.html_escape(text.dup)
+        def sort_issues(unsorted_issues)
+          return unsorted_issues unless unsorted_issues.any? && sort_field
 
-          Hash[ *text.scan(/#\[(.+?)\]#[\r|\n](.*?)(?=#\[|\z)/m).flatten.collect{ |str| str.strip } ].keys.each do |field|
-            output.gsub!(/#\[#{Regexp.escape(field)}\]#[\r|\n]/, "h4. #{field}\n\n")
+          # FIXME: Assume the Field :type is :number, so cast .to_f and sort
+          unsorted_issues.sort do |a, b|
+            b.fields.fetch(sort_field, '0').to_f <=> a.fields.fetch(sort_field, '0').to_f
           end
+        end
+
+        def tags
+          @tags ||= project.tags
+        end
 
-          auto_link(RedCloth.new(output, [:no_span_caps]).to_html).html_safe
+        def title
+          @title ||= if Dradis.constants.include?(:Pro)
+                       "Dradis Professional Edition v#{Dradis::Pro.version}"
+                     else
+                       "Dradis Community Edition v#{Dradis::CE.version}"
+                     end
         end
       end
     end

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dradis-html_export
 version: !ruby/object:Gem::Version
-  version: 3.16.0
+  version: 3.17.0
 platform: ruby
 authors:
 - Daniel Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-26 00:00:00.000000000 Z
+date: 2020-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dradis-plugins