Class: Copyleaks::SubmissionExclude

Inherits:
Object
  • Object
show all
Defined in:
lib/copyleaks/models/submissions/properties/exclude.rb

Instance Method Summary collapse

Constructor Details

#initialize(quotes = false, references = false, tableOfContents = false, titles = false, htmlTemplate = false, citations = nil, documentTemplateIds = nil, code = nil) ⇒ SubmissionExclude

Returns a new instance of SubmissionExclude.

Parameters:

  • quotes (Boolean) (defaults to: false) —

    Exclude quoted text from the scan.

  • references (Boolean) (defaults to: false) —

    Exclude referenced text from the scan.

  • tableOfContents (Boolean) (defaults to: false) —

    Exclude table of contents from the scan.

  • titles (Boolean) (defaults to: false) —

    Exclude titles from the scan.

  • htmlTemplate (Boolean) (defaults to: false) —

    When the scanned document is an HTML document, exclude irrelevant text that appears across the site like the website footer or header.

  • citations (Boolean) (defaults to: nil) —

    • Exclude citations from the scan.

  • documentTemplateIds (String[]) (defaults to: nil) —

    • Exclude text based on text found within other documents.

  • code (SubmissionExcludeCode) (defaults to: nil) —

    • Exclude sections of source code



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# 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

Instance Method Details

#as_json(*_args) ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
 
# 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) ⇒ Object 



81
82
83
 
# File 'lib/copyleaks/models/submissions/properties/exclude.rb', line 81

def to_json(*options)
  as_json(*options).to_json(*options)
end