Class: Licensed::Sources::Source

Inherits:
Object
  • Object
show all
Defined in:
lib/licensed/sources/source.rb

Defined Under Namespace

Classes: DependencyEnumerationNotImplementedError, Error

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(configuration) ⇒ Source

Returns a new instance of Source.



71
72
73
 
# File 'lib/licensed/sources/source.rb', line 71

def initialize(configuration)
  @config = configuration
end

Class Attribute Details

.sources ⇒ Object (readonly)

Returns the value of attribute sources.



15
16
17
 
# File 'lib/licensed/sources/source.rb', line 15

def sources
  @sources
end

Instance Attribute Details

#config ⇒ Object

all sources have a configuration



69
70
71
 
# File 'lib/licensed/sources/source.rb', line 69

def config
  @config
end

Class Method Details

.full_type ⇒ Object

Returns the source name as a “/” delimited string of all the module and class names following “Licensed::Sources::”. This is the type that is used to distinguish multiple versions of a sources from each other. e.g. for ‘Licensed::Sources::Yarn::V1`, this returns `yarn/v1`



46
47
48
 
# File 'lib/licensed/sources/source.rb', line 46

def self.full_type
  type_and_version.join("/")
end

.inherited(klass) ⇒ Object 



23
24
25
26
 
# File 'lib/licensed/sources/source.rb', line 23

def self.inherited(klass)
  # register the inherited class as a source on the Licensed::Sources::Source class
  Licensed::Sources::Source.register_source(klass)
end

.register_source(klass) ⇒ Object 



28
29
30
31
32
 
# File 'lib/licensed/sources/source.rb', line 28

def self.register_source(klass)
  # add the source class to the known sources list
  return unless klass < Licensed::Sources::Source
  (@sources ||= []) << klass
end

.require_matched_dependency_version ⇒ Object

Returns true if the source requires matching reviewed and ignored dependencies’ versions as well as their name



64
65
66
 
# File 'lib/licensed/sources/source.rb', line 64

def self.require_matched_dependency_version
  false
end

.type ⇒ Object

Returns the source name as the first snake cased class or module name following “Licensed::Sources::”. This is the type that is included in metadata files and cache paths. e.g. for ‘Licensed::Sources::Yarn::V1`, this returns “yarn”



38
39
40
 
# File 'lib/licensed/sources/source.rb', line 38

def self.type
  type_and_version[0]
end

.type_and_version ⇒ Object

Returns an array that includes the source’s type name at the first index, and optionally a version string for the source as the second index. Callers should override this function and not ‘type` or `full_type` when needing to adjust the default type and version parsing logic



54
55
56
57
58
59
60
 
# File 'lib/licensed/sources/source.rb', line 54

def self.type_and_version
  self.name.gsub("#{Licensed::Sources.name}::", "")
           .gsub(/([A-Z\d]+)([A-Z][a-z])/, "\\1_\\2".freeze)
           .gsub(/([a-z\d])([A-Z])/, "\\1_\\2".freeze)
           .downcase
           .split("::")
end

Instance Method Details

#dependencies ⇒ Object

Returns all dependencies that should be evaluated. Excludes ignored dependencies.



83
84
85
86
87
 
# File 'lib/licensed/sources/source.rb', line 83

def dependencies
  cached_dependencies
    .reject { |d| ignored?(d) }
    .each { |d| add_additional_terms_from_configuration(d) }
end

#enabled? ⇒ Boolean

Returns whether a source is enabled based on the environment in which licensed is run Defaults to false.

Returns:

  • (Boolean) 


77
78
79
 
# File 'lib/licensed/sources/source.rb', line 77

def enabled?
  false
end

#enumerate_dependencies ⇒ Object

Enumerate all source dependencies. Must be implemented by each source class.

Raises:



90
91
92
 
# File 'lib/licensed/sources/source.rb', line 90

def enumerate_dependencies
  raise DependencyEnumerationNotImplementedError
end

#ignored?(dependency) ⇒ Boolean

Returns whether a dependency is ignored in the configuration.

Returns:

  • (Boolean) 


95
96
97
 
# File 'lib/licensed/sources/source.rb', line 95

def ignored?(dependency)
  config.ignored?(dependency.metadata, require_version: self.class.require_matched_dependency_version)
end

#source_config ⇒ Object

Returns configuration options set for the current source



100
101
102
 
# File 'lib/licensed/sources/source.rb', line 100

def source_config
  @source_config ||= config[self.class.type].is_a?(Hash) ? config[self.class.type] : {}
end