class Copyleaks::SubmissionExclude
Public Class Methods
new( quotes = false, references = false, tableOfContents = false, titles = false, htmlTemplate = false, citations = nil, documentTemplateIds = nil, code = nil )
click to toggle source
@param [Boolean] quotes Exclude quoted text from the scan. @param [Boolean] references Exclude referenced text from the scan. @param [Boolean] tableOfContents Exclude table of contents from the scan. @param [Boolean] titles Exclude titles from the scan. @param [Boolean] htmlTemplate When the scanned document is an HTML document, exclude irrelevant text that appears across the site like the website footer or header. @param [Boolean] citations - Exclude citations from the scan. @param [String documentTemplateIds - Exclude text based on text found within other documents. @param [SubmissionExcludeCode] code - Exclude sections of source code
# File lib/copyleaks/models/submissions/properties/exclude.rb, line 35 def initialize( quotes = false, references = false, tableOfContents = false, titles = false, htmlTemplate = false, citations = nil, documentTemplateIds = nil, code = nil ) if !citations.nil? && ![true, false].include?(citations) raise 'Copyleaks::SubmissionExclude - citations - citations must be of type Boolean' end if !documentTemplateIds.nil? && !(documentTemplateIds.is_a?(Array) && documentTemplateIds.all? { |element| element.is_a?(String) }) raise 'Copyleaks::SubmissionExclude - documentTemplateIds - documentTemplateIds must be of type String[]' end if !code.nil? && !code.instance_of?(SubmissionExcludeCode) raise 'Copyleaks::SubmissionExclude - code - code must be of type SubmissionExcludeCode' end @quotes = quotes @references = references @tableOfContents = tableOfContents @titles = titles @htmlTemplate = htmlTemplate @citations = citations @documentTemplateIds = documentTemplateIds @code = code end
Public Instance Methods
as_json(*_args)
click to toggle source
# File lib/copyleaks/models/submissions/properties/exclude.rb, line 68 def as_json(*_args) { quotes: @quotes, references: @references, tableOfContents: @tableOfContents, titles: @titles, htmlTemplate: @htmlTemplate, citations: @citations, documentTemplateIds: @documentTemplateIds, code: @code }.select { |_k, v| !v.nil? } end
to_json(*options)
click to toggle source
# File lib/copyleaks/models/submissions/properties/exclude.rb, line 81 def to_json(*options) as_json(*options).to_json(*options) end