Class: Ronin::Wordlists::CLI::WordlistIndex::Entry Private

Inherits:
Object
  • Object
show all
Defined in:
lib/ronin/wordlists/cli/wordlist_index.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Represents an entry in the wordlist index file.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, url:, summary:, categories: []) ⇒ Entry

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Initializes the entry object.

Parameters:

  • name (String) —

    The name of the wordlist.

  • url (String) —

    The download URL of the wordlist.

  • summary (String) —

    A brief summary of the wordlist.

  • categories (Array<String>) (defaults to: []) —

    The categories the wordlist belongs to.



77
78
79
80
81
82
83
 
# File 'lib/ronin/wordlists/cli/wordlist_index.rb', line 77

def initialize(name, url: , summary: , categories: [])
  @name = name
  @url  = url

  @summary    = summary
  @categories = categories.to_set
end

Instance Attribute Details

#categories ⇒ Set<String> (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

The categories the wordlist belongs to.

Returns:

  • (Set<String>) 


60
61
62
 
# File 'lib/ronin/wordlists/cli/wordlist_index.rb', line 60

def categories
  @categories
end

#name ⇒ String (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

The name of the wordlist.

Returns:

  • (String) 


45
46
47
 
# File 'lib/ronin/wordlists/cli/wordlist_index.rb', line 45

def name
  @name
end

#summary ⇒ String (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

A brief summary of the wordlist.

Returns:

  • (String) 


55
56
57
 
# File 'lib/ronin/wordlists/cli/wordlist_index.rb', line 55

def summary
  @summary
end

#url ⇒ String (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

The download URL of the wordlist.

Returns:

  • (String) 


50
51
52
 
# File 'lib/ronin/wordlists/cli/wordlist_index.rb', line 50

def url
  @url
end