dradis-html_export 3.20.0 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f6ac583114b620b0f712eec9d0d4635012a0566e1b6b5bf6e331b708991c223
-  data.tar.gz: 571a3c231cddac14d08577f6811dd8beab715a0387fc763a99ce57b8340e9110
+  metadata.gz: 205222446aa051525b3f1a66c3de03860b2bcda28162666b170e156d6cf2d7da
+  data.tar.gz: e4ce08b1eb00b95a08371d710debab240efd7251f27859fc5dadf6abb2ac2e8a
 SHA512:
-  metadata.gz: 6700179c827068d2810787d028bdc0621f918e86588d7c666547e7ea00be5425e141b15740cab0b0afe359021f13e28e1300c4a03edd87e7e2b86cd0b6adb1b8
-  data.tar.gz: 36b73d54c2167cf49063882d9521e6954562331a3edc4464ec77b3f951302ad8ebc20ded1b9a7d996acc369e2000364ee916b0d2e6a5b1a2038d43ae6a7b1800
+  metadata.gz: 327c889c0dc25383b6b7db55cd1b70bcfb9bd20131ec54560235c03c65af8394096ba62b75c4c06f4b46b7bed3e1397d201bb9d939d12984847ff5f4835c098e
+  data.tar.gz: eb430dfd5ad4428e95a6d5babae0068d0813c3323fe8ce59d3cdfe162d2c745116688c8ef68928a89a2bb6ce3b61886f03dc3c2c2b6b44ecbf0c8756c3e187a7

data/CHANGELOG.md

@@ -1,62 +1,64 @@
-## Dradis Framework 3.20 (December, 2020) ##
+v4.1.1 (November 2021)
+  - Loosen dradis-plugins version requirement
 
-*   Add an option in the exporter to pass a controller for rendering.
-*   Use NamingService to build export filename.
+v4.1.0 (November 2021)
+  - No changes
 
-## Dradis Framework 3.19 (September, 2020) ##
+v4.0.0 (July 2021)
+  - No changes
 
-*   No changes.
+v3.22.0 (April 2021)
+  - No changes
 
-## Dradis Framework 3.18 (July, 2020) ##
+v3.21.0 (February 2021)
+  - Add a fix for Rails 6 not allowing HTML rendering outside the view directory
 
-*   No changes.
+v3.20.0 (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.17 (May, 2020) ##
+v3.19.0 (September 2020)
+  - No changes
 
-*   Render report using main app's ApplicationController#render.
+v3.18.0 (July 2020)
+  - No changes
 
-## Dradis Framework 3.16 (February, 2020) ##
+v3.17.0 (May 2020)
+  - Render report using main app's ApplicationController#render
 
-*   No changes.
+v3.16.0 (February 2020)
+  - No changes
 
-## Dradis Framework 3.15 (November, 2019) ##
+v3.15.0 (November 2019)
+  - No changes
 
-*   No changes.
+v3.14.0 (August 2019)
+  - No changes
 
+v3.13.0 (June 2019)
+  - No changes
 
-## Dradis Framework 3.14 (August, 2019) ##
+v3.12.0 (March 2019)
+  - No changes
 
-*   No changes.
+v3.11.0 (November 2018)
+  - No changes
 
-## Dradis Framework 3.13 (June, 2019) ##
+v3.10.0 (August 2018)
+  - Upgraded gems:
+    - RedCloth
+  - Bugs fixes:
+    - issue sorting
 
-*   No changes.
+v3.9.0 (January 2018)
+  - Updated rendering html as in Rails 5.1 (`render html:`)
 
-## Dradis Framework 3.12 (March, 2019) ##
+v3.8.0 (September 2017)
+  - No changes
 
-*   No changes.
+v3.7.0 (July 2017)
+  - No changes
 
-## Dradis Framework 3.11 (November, 2018) ##
-
-*   No changes.
-
-## Dradis Framework 3.10 (August, 2018) ##
-
-*   Security fix: update RedCloth to 4.3.2
-*   Fix issue sorting
-
-## Dradis Framework 3.9 (January, 2018) ##
-
-*   Updated rendering html as in Rails 5.1 (`render html:`)
-
-## Dradis Framework 3.8 (September, 2017) ##
-
-*   No changes.
-
-## Dradis Framework 3.7 (July, 2017) ##
-
-*   No changes.
-
-## Dradis Framework 3.6 (March, 2017) ##
-
-*   No changes.
+v3.6.0 (March 2017)
+  - No changes

data/CHANGELOG.template

@@ -0,0 +1,12 @@
+[v#.#.#] ([month] [YYYY])
+  - [future tense verb] [feature]
+  - Upgraded gems:
+    - [gem]
+  - Bugs fixes:
+    - [future tense verb] [bug fix]
+    - Bug tracker items:
+      - [item]
+  - Security Fixes:
+    - High: (Authenticated|Unauthenticated) (admin|author|contributor) [vulnerability description]
+    - Medium: (Authenticated|Unauthenticated) (admin|author|contributor) [vulnerability description]
+    - Low: (Authenticated|Unauthenticated) (admin|author|contributor) [vulnerability description]

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'
 
   # Note markup
   spec.add_dependency 'rails_autolink', '~> 1.1'

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

@@ -3,29 +3,30 @@ module Dradis
     module HtmlExport
 
       class Exporter < Dradis::Plugins::Export::Base
-
         def export(args = {})
           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]
-            }
-          )
+          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
@@ -94,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,9 +7,9 @@ module Dradis
       end
 
       module VERSION
-        MAJOR = 3
-        MINOR = 20
-        TINY  = 0
+        MAJOR = 4
+        MINOR = 1
+        TINY  = 1
         PRE   = nil
 
         STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")

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.20.0
+  version: 4.1.1
 platform: ruby
 authors:
 - Daniel Martin
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-07 00:00:00.000000000 Z
+date: 2021-11-18 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'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rails_autolink
   requirement: !ruby/object:Gem::Requirement
@@ -63,13 +63,15 @@ files:
 - ".github/pull_request_template.md"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
+- CHANGELOG.template
 - CONTRIBUTING.md
 - Gemfile
 - 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
@@ -87,7 +91,7 @@ homepage: http://dradisframework.org
 licenses:
 - GPL-2
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -102,10 +106,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.4
-signing_key:
+rubygems_version: 3.1.6
+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

data/.travis.yml

@@ -1,11 +0,0 @@
-rvm:
-  - 1.9.3
-notifications:
-  irc:
-    on_success: change
-    on_failure: always
-    channels:
-      - "irc.freenode.org#dradis"
-
-bundler_args: --path vendor/bundle
-script: "bundle exec rake spec"