Module: Lorca::LorcaManifest

Defined in:
lib/lorca/manifest.rb

Overview

Aimed at basic security auditing tools.

Class Method Summary collapse

Class Method Details

.authors ⇒ Object

Array of authors’ string names



18
19
20
 
# File 'lib/lorca/manifest.rb', line 18

def self.authors
  ["René Maya"].freeze
end

.bindir ⇒ Object

Directory housing binstubs.



72
73
74
 
# File 'lib/lorca/manifest.rb', line 72

def self.bindir
  "bin"
end

.binstubs ⇒ Object

Array of binstubs.

Officially, there can only be one +++



80
81
82
 
# File 'lib/lorca/manifest.rb', line 80

def self.binstubs
  %w[lorca].freeze
end

.codebase ⇒ Object

Array of directories housing the codebase.



55
56
57
58
 
# File 'lib/lorca/manifest.rb', line 55

def self.codebase
  src = "lib"
  [src].freeze if files.any? { |f| f.start_with? "#{src}/" }
end

.contact_emails ⇒ Object

Array of maintainers’ email strings.



23
24
25
 
# File 'lib/lorca/manifest.rb', line 23

def self.contact_emails
  %w[[email protected]].freeze
end

.files ⇒ Object

Array of official gem files. Manually maintained at Manifest.md. – Not frozen, raises warnings building gem. ++



50
51
52
 
# File 'lib/lorca/manifest.rb', line 50

def self.files
  File.readlines("./Manifest.md").map(&:chomp).reject(&:empty?)
end

.gem_name ⇒ Object

Name as used in ‘require` statements.



8
9
10
 
# File 'lib/lorca/manifest.rb', line 8

def self.gem_name
  official_name.downcase
end

.license ⇒ Object

License type. Full text in License.md.



33
34
35
 
# File 'lib/lorca/manifest.rb', line 33

def self.license
  "ISC"
end

.metadata ⇒ Object

Online resources.



38
39
40
41
42
43
44
 
# File 'lib/lorca/manifest.rb', line 38

def self.metadata
  {
    "source_code_uri"   => repo,
    "bug_tracker_uri"   => "https://notabug.org/rem/lorca/issues",
    "changelog_uri"     => "https://notabug.org/rem/lorca/src/master/ChangeLog.md"
  }.freeze
end

.official_name ⇒ Object

Name as it’s meant to be spelled.



13
14
15
 
# File 'lib/lorca/manifest.rb', line 13

def self.official_name
  "Lorca"
end

.repo ⇒ Object

Main repo url.



28
29
30
 
# File 'lib/lorca/manifest.rb', line 28

def self.repo
  "https://notabug.org/rem/lorca"
end

.test_suite ⇒ Object

Directory housing the test suite.



61
62
63
 
# File 'lib/lorca/manifest.rb', line 61

def self.test_suite
  "test"
end

.tests ⇒ Object

Array of test files.



66
67
68
69
 
# File 'lib/lorca/manifest.rb', line 66

def self.tests
  tests = Dir["test/**/test_*.rb"] - Dir["test/dev/**/*.rb"]
  tests.freeze
end