Class: LicenseFinder::Package

Inherits:
Object
  • Object
show all
Defined in:
lib/license_finder/package.rb

Overview

Super-class that adapts data from different package management systems (gems, npm, pip, etc.) to a common interface.

Guidance on adding a new system

  • subclass Package, and initialize based on the data you receive from the package manager

  • if the package specs will report license names, pass :spec_licenses in the constructor options

  • if the package’s files can be searched for licenses pass :install_path in the constructor options

  • otherwise, override #licenses_from_spec or #license_files

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, version = nil, options = {}) ⇒ Package

Returns a new instance of Package.



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
 
# File 'lib/license_finder/package.rb', line 36

def initialize(name, version = nil, options = {})
  @logger = options[:logger] || Core.default_logger

  ## DESCRIPTION
  @name = name
  @version = version
  @authors = options[:authors] || ''
  @summary = options[:summary] || ''
  @description = options[:description] || ''
  @homepage = options[:homepage] || ''
  @children = options[:children] || []
  @parents = Set.new # will be figured out later by package manager
  @groups = options[:groups] || []

  ## APPROVAL
  @whitelisted = false
  @blacklisted = false
  @manual_approval = nil

  ## LICENSING
  @license_names_from_spec = options[:spec_licenses] || []
  @install_path = options[:install_path]
  @missing = options[:missing] || false
  @decided_licenses = Set.new
end

Instance Attribute Details

#authors ⇒ Object (readonly)

Returns the value of attribute authors.



66
67
68
 
# File 'lib/license_finder/package.rb', line 66

def authors
  @authors
end

#children ⇒ Object (readonly)

Returns the value of attribute children.



66
67
68
 
# File 'lib/license_finder/package.rb', line 66

def children
  @children
end

#description ⇒ Object (readonly)

Returns the value of attribute description.



66
67
68
 
# File 'lib/license_finder/package.rb', line 66

def description
  @description
end

#groups ⇒ Object (readonly)

Returns the value of attribute groups.



66
67
68
 
# File 'lib/license_finder/package.rb', line 66

def groups
  @groups
end

#homepage ⇒ Object

DESCRIPTION



64
65
66
 
# File 'lib/license_finder/package.rb', line 64

def homepage
  @homepage
end

#install_path ⇒ Object (readonly)

checked in tests, otherwise private



125
126
127
 
# File 'lib/license_finder/package.rb', line 125

def install_path
  @install_path
end

#license_names_from_spec ⇒ Object (readonly)

LICENSING



124
125
126
 
# File 'lib/license_finder/package.rb', line 124

def license_names_from_spec
  @license_names_from_spec
end

#logger ⇒ Object (readonly)

Returns the value of attribute logger.



21
22
23
 
# File 'lib/license_finder/package.rb', line 21

def logger
  @logger
end

#manual_approval ⇒ Object (readonly)

Returns the value of attribute manual_approval.



103
104
105
 
# File 'lib/license_finder/package.rb', line 103

def manual_approval
  @manual_approval
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



66
67
68
 
# File 'lib/license_finder/package.rb', line 66

def name
  @name
end

#parents ⇒ Object (readonly)

Returns the value of attribute parents.



66
67
68
 
# File 'lib/license_finder/package.rb', line 66

def parents
  @parents
end

#summary ⇒ Object (readonly)

Returns the value of attribute summary.



66
67
68
 
# File 'lib/license_finder/package.rb', line 66

def summary
  @summary
end

#version ⇒ Object (readonly)

Returns the value of attribute version.



66
67
68
 
# File 'lib/license_finder/package.rb', line 66

def version
  @version
end

Class Method Details

.license_names_from_standard_spec(spec) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/license_finder/package.rb', line 23

def self.license_names_from_standard_spec(spec)
  licenses = spec['licenses'] || [spec['license']].compact
  licenses = [licenses] unless licenses.is_a?(Array)
  licenses = licenses.flatten
  licenses.map do |license|
    if license.is_a? Hash
      license['type']
    else
      license
    end
  end
end

Instance Method Details

#<=>(other) ⇒ Object

EQUALITY



107
108
109
110
111
112
 
# File 'lib/license_finder/package.rb', line 107

def <=>(other)
  eq_name = name <=> other.name
  return eq_name unless eq_name.zero?

  version <=> other.version
end

#activations ⇒ Object 



131
132
133
134
135
 
# File 'lib/license_finder/package.rb', line 131

def activations
  licensing.activations.tap do |activations|
    activations.each { |activation| log_activation activation }
  end
end

#approved? ⇒ Boolean

Returns:

  • (Boolean) 


80
81
82
83
84
85
 
# File 'lib/license_finder/package.rb', line 80

def approved?
  # Question: is `!blacklisted?` redundant?
  # DecisionApplier does not call `whitelisted!` or `approved_manually!`
  # if a Package has been blacklisted.
  (approved_manually? || whitelisted?) && !blacklisted?
end

#approved_manually!(approval) ⇒ Object

APPROVAL



72
73
74
 
# File 'lib/license_finder/package.rb', line 72

def approved_manually!(approval)
  @manual_approval = approval
end

#approved_manually? ⇒ Boolean

Returns:

  • (Boolean) 


76
77
78
 
# File 'lib/license_finder/package.rb', line 76

def approved_manually?
  !@manual_approval.nil?
end

#blacklisted! ⇒ Object 



95
96
97
 
# File 'lib/license_finder/package.rb', line 95

def blacklisted!
  @blacklisted = true
end

#blacklisted? ⇒ Boolean

Returns:

  • (Boolean) 


99
100
101
 
# File 'lib/license_finder/package.rb', line 99

def blacklisted?
  @blacklisted
end

#decide_on_license(license) ⇒ Object 



141
142
143
 
# File 'lib/license_finder/package.rb', line 141

def decide_on_license(license)
  @decided_licenses << license
end

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean) 


114
115
116
 
# File 'lib/license_finder/package.rb', line 114

def eql?(other)
  name == other.name && version == other.version
end

#hash ⇒ Object 



118
119
120
 
# File 'lib/license_finder/package.rb', line 118

def hash
  [name, version].hash
end

#license_files ⇒ Object 



151
152
153
 
# File 'lib/license_finder/package.rb', line 151

def license_files
  LicenseFiles.find(install_path, logger: logger)
end

#licenses ⇒ Object 



127
128
129
 
# File 'lib/license_finder/package.rb', line 127

def licenses
  @licenses ||= activations.map(&:license).to_set
end

#licenses_from_spec ⇒ Object 



145
146
147
148
149
 
# File 'lib/license_finder/package.rb', line 145

def licenses_from_spec
  license_names_from_spec
    .map { |name| License.find_by_name(name) }
    .to_set
end

#licensing ⇒ Object 



137
138
139
 
# File 'lib/license_finder/package.rb', line 137

def licensing
  Licensing.new(self, @decided_licenses, licenses_from_spec, license_files)
end

#log_activation(activation) ⇒ Object 



167
168
169
170
171
172
173
174
175
176
 
# File 'lib/license_finder/package.rb', line 167

def log_activation(activation)
  preamble = format('package %s:', activation.package.name)
  if activation.sources.empty?
    logger.debug activation.package.class, format('%s no licenses found', preamble)
  else
    activation.sources.each do |source|
      logger.debug activation.package.class, format("%s found license '%s' %s", preamble, activation.license.name, source)
    end
  end
end

#missing? ⇒ Boolean

Returns:

  • (Boolean) 


163
164
165
 
# File 'lib/license_finder/package.rb', line 163

def missing?
  @missing
end

#notice_files ⇒ Object 



155
156
157
 
# File 'lib/license_finder/package.rb', line 155

def notice_files
  NoticeFiles.find(install_path, logger: logger)
end

#package_manager ⇒ Object 



159
160
161
 
# File 'lib/license_finder/package.rb', line 159

def package_manager
  'unknown'
end

#whitelisted! ⇒ Object 



87
88
89
 
# File 'lib/license_finder/package.rb', line 87

def whitelisted!
  @whitelisted = true
end

#whitelisted? ⇒ Boolean

Returns:

  • (Boolean) 


91
92
93
 
# File 'lib/license_finder/package.rb', line 91

def whitelisted?
  @whitelisted
end