dradis-html_export 3.15.0 → 3.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bb233fc308356f8613baeef2ed7351abe6e92b95d166b5f15b33d76af86e222
-  data.tar.gz: c3f4e9a1fd1c71759f09a853c4f2d02a9860708e5ba0e4e2751f4cff3c77542d
+  metadata.gz: 5f6ac583114b620b0f712eec9d0d4635012a0566e1b6b5bf6e331b708991c223
+  data.tar.gz: 571a3c231cddac14d08577f6811dd8beab715a0387fc763a99ce57b8340e9110
 SHA512:
-  metadata.gz: 9464ccc7a9ea7f6cb1e66fa70444e5c699dfe4dc6230953ab5eee4e77690429862afce59dee11006aaaab901c34c3e50a4e7d9be94a974d637bfca94c29a9507
-  data.tar.gz: f3ee8071c3b12efffc403e159a11f39aef17beaf0a657e081a3aa0a399f38d91c4338f9d4dba76c40bc91abd9cdef89d2df7125dd1751184c2919f88fdf1976c
+  metadata.gz: 6700179c827068d2810787d028bdc0621f918e86588d7c666547e7ea00be5425e141b15740cab0b0afe359021f13e28e1300c4a03edd87e7e2b86cd0b6adb1b8
+  data.tar.gz: 36b73d54c2167cf49063882d9521e6954562331a3edc4464ec77b3f951302ad8ebc20ded1b9a7d996acc369e2000364ee916b0d2e6a5b1a2038d43ae6a7b1800

data/CHANGELOG.md

@@ -1,11 +1,29 @@
-## Dradis Framework 3.15 (November, 2019) ##
+## Dradis Framework 3.20 (December, 2020) ##
+
+*   Add an option in the exporter to pass a controller for rendering.
+*   Use NamingService to build export filename.
+
+## Dradis Framework 3.19 (September, 2020) ##
 
 *   No changes.
 
-## Dradis Framework 3.15 (August, 2019) ##
+## Dradis Framework 3.18 (July, 2020) ##
 
 *   No changes.
 
+## Dradis Framework 3.17 (May, 2020) ##
+
+*   Render report using main app's ApplicationController#render.
+
+## Dradis Framework 3.16 (February, 2020) ##
+
+*   No changes.
+
+## Dradis Framework 3.15 (November, 2019) ##
+
+*   No changes.
+
+
 ## Dradis Framework 3.14 (August, 2019) ##
 
 *   No changes.

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

@@ -3,75 +3,96 @@ 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
-
-          # 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
-
-              logger.debug{ "Template properties define a sort field: #{sort_by}. Sorting..." }
-
-              # 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
-
-              logger.debug{ "Done." }
-            end
+          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]
+            }
+          )
+        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
+        private
+        def log_report
+          logger.debug { "Report title: #{title}" }
+          logger.debug { "Template properties define a sort field: #{sort_field}" }
 
-            logger.debug{ "Found #{issues.count} issues affecting #{nodes.count} nodes" }
+          if issues&.any?
+            logger.debug { "Found #{issues.count} issues affecting #{nodes.count} nodes" }
           else
-            logger.warning { "No issue library node found in this project" }
+            logger.warn { 'No issue library node found in this project' }
           end
 
-          # Render template
-          erb = ERB.new( File.read(template_path) )
-          erb.result( binding )
+          logger.debug { "Found #{notes.count} notes assigned to the reporting category." }
         end
 
-        private
+        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
+
+        def notes
+          @notes ||= content_service.all_notes
+        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 issues
+          @issues ||= sort_issues content_service.all_issues.includes(:tags)
+        end
 
-          # escape HTML 'manually' instead of using RedCloth's "filter_html"
-          # for security reasons
-          output = ERB::Util.html_escape(text.dup)
+        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
 
-          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")
+        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
+
+        def sort_issues(unsorted_issues)
+          return unsorted_issues unless unsorted_issues.any? && sort_field
+
+          # 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 = 15
+        MINOR = 20
         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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dradis-html_export
 version: !ruby/object:Gem::Version
-  version: 3.15.0
+  version: 3.20.0
 platform: ruby
 authors:
 - Daniel Martin
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-12-11 00:00:00.000000000 Z
+date: 2021-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dradis-plugins
@@ -87,7 +87,7 @@ homepage: http://dradisframework.org
 licenses:
 - GPL-2
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -102,8 +102,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.2.4
+signing_key:
 specification_version: 4
 summary: Dradis HTML export plugin
 test_files: