dradis-html_export 5.3.0 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a693517be40a25b6923aa7fa8841c1fb4d307edeb2a8103a0153b4682f9bbca2
-  data.tar.gz: 3cab5796f2b3e81ac658d3d02c6e92d806fde4c077e850e335dc20160c4bb5f8
+  metadata.gz: f45358ed8df2359d53e55838b812d4d5e2b01266d4bac0ae6980c29f838d74d1
+  data.tar.gz: e93833b125fb875df49501a251ec47756b9578700bb3f449674acdc3a521e311
 SHA512:
-  metadata.gz: 2901e5a008a7b5fd65f28c0f2fdbb908b99f2ca59c6d8e0c11b70c1b1a1b2f27385e3f59657c8357c09402d458b33d9635e579ac24510ec5fe46bf671b140a0a
-  data.tar.gz: f16056c95ebef3b7e929f649a1462171b8b059342ab3c9ea89a73cefdfc9ee377d1b4f380352ee49f26ee5567ea6adfb9e46cf2091fa46d0f15a4724eafad8b6
+  metadata.gz: 2a87500d8072415c08196b61b9cd1bd32ea947c10f8b3769d81ebd1d1e9cdc52b736e985b1f4869b413c51c4c677fda47c92d610ec461d650c466fb72a7333a2
+  data.tar.gz: ffe9102e55b1a8e4e9f42bc9318b0ba4d9b1c172ea7354ac790033e686f164f6dd4d1dab7c370de12e8410b6b35a2c5929a39047889b92b00a968a10355075a4

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+v5.4.0 (September 2026)
+  - Only include Published Evidence in exports when the export scope is set to Published
+
 v5.3.0 (August 2026)
   - No changes
 

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

@@ -14,6 +14,7 @@ module Dradis
         end
 
         private
+
         def log_report
           logger.debug { "Report title: #{title}" }
           logger.debug { "Template properties define sort fields: #{template_properties&.sort_fields}" }
@@ -28,9 +29,7 @@ module Dradis
         end
 
         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
+          @nodes ||= content_service.all_evidence.map(&:node).uniq
         end
 
         def notes

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

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

data/templates/default_dradis_template_v3.0.html.erb

@@ -90,14 +90,14 @@
             <div class="row">
               <div class="col-md-3 evidence-sidebar">
                 <ul class="nav nav-list evidence-sidenav">
-                <% issue.evidence_by_node.each do |node, instances| %>
+                <% issue.evidence_by_node(scope).each do |node, instances| %>
                   <li><a href="#evidence_for_<%= node.id %>"><i class="glyphicon glyphicon-<%= ['folder-close','hdd'][node.type_id] %>"></i> <%= node.label %> (<%= pluralize instances.count, 'instance' %>)</a></li>
                 <% end %>
                 </ul>
               </div>
 
               <div class="col-md-9">
-                <% issue.evidence_by_node.each do |node, instances| %>
+                <% issue.evidence_by_node(scope).each do |node, instances| %>
                   <section id="evidence_for_#{node.id}">
                     <% if instances.count == 1 %>
                       <div class="content-textile" id="node_<%= node.id %>_instance_0">

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dradis-html_export
 version: !ruby/object:Gem::Version
-  version: 5.3.0
+  version: 5.4.0
 platform: ruby
 authors:
 - Daniel Martin
@@ -56,14 +56,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/issue_template.md"
-- ".github/pull_request_template.md"
-- ".gitignore"
-- ".rspec"
 - CHANGELOG.md
-- CHANGELOG.template
-- CONTRIBUTING.md
-- Gemfile
 - README.md
 - Rakefile
 - app/controllers/dradis/plugins/html_export/reports_controller.rb
@@ -71,7 +64,6 @@ files:
 - 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
 - lib/dradis/plugins/html_export.rb
 - lib/dradis/plugins/html_export/engine.rb
@@ -79,12 +71,6 @@ 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
-- spec/requests/html_export_spec.rb
-- spec/spec_helper.rb
 - templates/basic.html.erb
 - templates/default_dradis_template_v3.0.html.erb
 homepage: https://dradis.com/support/guides/reporting/html_reports.html
@@ -108,10 +94,4 @@ requirements: []
 rubygems_version: 3.6.9
 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
-- spec/requests/html_export_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/.github/issue_template.md

@@ -1,16 +0,0 @@
-### Steps to reproduce
-
-Help us help you, how can we reproduce the problem?
-
-### Expected behavior
-Tell us what should happen
-
-### Actual behavior
-Tell us what happens instead
-
-### System configuration
-**Dradis version**:
-
-**Ruby version**:
-
-**OS version**:

data/.github/pull_request_template.md

@@ -1,45 +0,0 @@
-Please review [CONTRIBUTING.md](https://github.com/dradis/dradis-ce/blob/develop/CONTRIBUTING.md) and remove this line.
-
-### Summary
-
-Provide a general description of the code changes in your pull
-request... were there any bugs you had fixed? If so, mention them. If
-these bugs have open GitHub issues, be sure to tag them here as well,
-to keep the conversation linked together.
-
-
-### Testing Steps
-
-Provide steps to test functionality, described in detail for someone not familiar with this part of the application / code base
-
-
-### Other Information
-
-If there's anything else that's important and relevant to your pull
-request, mention that information here. This could include
-benchmarks, or other information.
-
-Thanks for contributing to Dradis!
-
-
-### Copyright assignment
-
-Collaboration is difficult with commercial closed source but we want
-to keep as much of the OSS ethos as possible available to users
-who want to fix it themselves.
-
-In order to unambiguously own and sell Dradis Framework commercial
-products, we must have the copyright associated with the entire
-codebase. Any code you create which is merged must be owned by us.
-That's not us trying to be a jerks, that's just the way it works.
-
-You can delete this section, but the following sentence needs to
-remain in the PR's description:
-
-> I assign all rights, including copyright, to any future Dradis
-> work by myself to Security Roots.
-
-### Check List
-
-- [ ] Added a CHANGELOG entry
-- [ ] Added specs

data/.gitignore

@@ -1,20 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-spec/dummy
-test/tmp
-test/version_tmp
-tmp
-/vendor/
-.DS_Store

data/.rspec

@@ -1 +0,0 @@
---color

data/CHANGELOG.template

@@ -1,12 +0,0 @@
-[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/CONTRIBUTING.md

@@ -1,3 +0,0 @@
-# Plugin contribution guidelines
-
-See the Dradis Framework's [CONTRIBUTING.md](https://github.com/dradis/dradisframework/blob/master/CONTRIBUTING.md)

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in dradis-html_export.gemspec
-gemspec

data/dradis-html_export.gemspec

@@ -1,35 +0,0 @@
-# -*- 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.version       = version
-  spec.required_ruby_version = '>= 1.9.3'
-  spec.license       = 'GPL-2'
-
-  spec.authors       = ['Daniel Martin']
-  spec.description   = 'Export to HTML plugin for the Dradis Framework'
-  spec.summary       = 'Dradis HTML export plugin'
-  spec.homepage      = 'https://dradis.com/support/guides/reporting/html_reports.html'
-
-  spec.files         = `git ls-files`.split($\)
-  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']
-
-  # gem.add_dependency 'dradis_core', version
-  spec.add_dependency 'dradis-plugins', '>= 4.8.0'
-
-  # Note markup
-  spec.add_dependency 'rails_autolink', '~> 1.1'
-  spec.add_dependency 'RedCloth', '~> 4.3.2'
-
-  # gem.add_development_dependency 'capybara', '~> 1.1.3'
-  # gem.add_development_dependency 'database_cleaner'
-  # gem.add_development_dependency 'factory_girl_rails'
-  # gem.add_development_dependency 'rspec-rails',  '~> 2.11.0'
-  # gem.add_development_dependency 'sqlite3'
-end

data/spec/fixtures/files/liquid.html.erb

@@ -1,12 +0,0 @@
-<!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/fixtures/files/template.html.erb

@@ -1,12 +0,0 @@
-<!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

@@ -1,150 +0,0 @@
-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) }
-  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::ExportController.new }
-
-  let(:exporter) { described_class.new(export_options) }
-
-  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 '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
-      {
-        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
-
-      tags.each do |tag|
-        expect(html).to include tag.name
-      end
-    end
-  end
-end

data/spec/presenters/dradis/plugins/html_export/template_presenter_spec.rb

@@ -1,47 +0,0 @@
-require 'rails_helper'
-
-RSpec.describe Dradis::Plugins::HtmlExport::TemplatePresenter do
-  class FakeView
-    include ActionView::Helpers::TextHelper
-  end
-
-  let(:template_presenter) { described_class.new(template, FakeView.new) }
-
-  describe '#title' do
-    context 'when template is a string' do
-      let(:template) { 'basic.html.erb' }
-
-      it 'returns the string' do
-        expect(template_presenter.title).to eq template
-      end
-    end
-
-    context 'when template is a RTP' do
-      let(:template) do
-        double(
-          'ReportTemplateProperties',
-          title: 'Basic',
-          template_file: 'basic.html.erb'
-        )
-      end
-
-      it 'returns a formatted title' do
-        expect(template_presenter.title).to eq "<span>#{template.title} - </span><small>#{template.template_file}</small>"
-      end
-
-      context 'when title contains javascript' do
-        let(:template) do
-          double(
-            'ReportTemplateProperties',
-            title: '<script>alert("hello world")</script>',
-            template_file: 'basic.html.erb'
-          )
-        end
-
-        it 'prevents cross site scriptiing' do
-          expect(template_presenter.title).to eq "<span>&lt;script&gt;alert(&quot;hello world&quot;)&lt;/script&gt; - </span><small>#{template.template_file}</small>"
-        end
-      end
-    end
-  end
-end

data/spec/requests/html_export_spec.rb

@@ -1,7 +0,0 @@
-require 'spec_helper'
-
-describe "HTML Export" do
-  it "presents the note text in the report layout" do
-    Dradis::Core::VERSION::STRING.should eq('3.0.0.beta')
-  end
-end

data/spec/spec_helper.rb

@@ -1,39 +0,0 @@
-# Configure Rails Envinronment
-ENV["RAILS_ENV"] ||= 'test'
-require File.expand_path("../dummy/config/environment", __FILE__)
-
-require 'rspec/rails'
-
-# Requires supporting ruby files with custom matchers and macros, etc,
-# in spec/support/ and its subdirectories.
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
-
-require 'database_cleaner'
-require 'factory_girl_rails'
-
-
-RSpec.configure do |config|
-
-  # Capybara javascript drivers require transactional fixtures set to false,
-  # and we just use DatabaseCleaner to cleanup after each test instead.
-  # Without transactional fixtures set to false none of the records created to
-  # setup a test will be available to the browser, which runs under a seperate
-  # server instance.
-  config.use_transactional_fixtures = false
-
-  config.before(:each) do
-    if example.metadata[:js]
-      DatabaseCleaner.strategy = :truncation
-    else
-      DatabaseCleaner.strategy = :transaction
-    end
-  end
-
-  config.before(:each) do
-    DatabaseCleaner.start
-  end
-
-  config.after(:each) do
-    DatabaseCleaner.clean
-  end
-end