Class: Licensee::Projects::Project

Inherits:
Object
  • Object
show all
Includes:
HashHelper
Defined in:
lib/licensee/projects/project.rb

Direct Known Subclasses

FSProject, GitHubProject, GitProject

Constant Summary collapse

HASH_METHODS = 
%i[licenses matched_files].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from HashHelper

#to_h

Constructor Details

#initialize(detect_packages: false, detect_readme: false) ⇒ Project

Returns a new instance of Project.



16
17
18
19
 
# File 'lib/licensee/projects/project.rb', line 16

def initialize(detect_packages: false, detect_readme: false)
  @detect_packages = detect_packages
  @detect_readme = detect_readme
end

Instance Attribute Details

#detect_packages ⇒ Object (readonly) Also known as: detect_packages?

Returns the value of attribute detect_packages.



9
10
11
 
# File 'lib/licensee/projects/project.rb', line 9

def detect_packages
  @detect_packages
end

#detect_readme ⇒ Object (readonly) Also known as: detect_readme?

Returns the value of attribute detect_readme.



9
10
11
 
# File 'lib/licensee/projects/project.rb', line 9

def detect_readme
  @detect_readme
end

Instance Method Details

#license ⇒ Object

Returns the matching License instance if a license can be detected



22
23
24
25
26
27
28
29
 
# File 'lib/licensee/projects/project.rb', line 22

def license
  return @license if defined? @license
  @license = if licenses_without_copyright.count == 1 || lgpl?
    licenses_without_copyright.first
  elsif licenses_without_copyright.count > 1
    Licensee::License.find('other')
  end
end

#license_file ⇒ Object

Returns the LicenseFile used to determine the License



49
50
51
 
# File 'lib/licensee/projects/project.rb', line 49

def license_file
  license_files.first if license_files.count == 1 || lgpl?
end

#license_files ⇒ Object 



53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/licensee/projects/project.rb', line 53

def license_files
  @license_files ||= begin
    return [] if files.empty? || files.nil?
    files = find_files do |n|
      Licensee::ProjectFiles::LicenseFile.name_score(n)
    end
    files = files.map do |file|
      Licensee::ProjectFiles::LicenseFile.new(load_file(file), file)
    end

    prioritize_lgpl(files)
  end
end

#licenses ⇒ Object

Returns an array of detected Licenses



32
33
34
 
# File 'lib/licensee/projects/project.rb', line 32

def licenses
  @licenses ||= matched_files.map(&:license).uniq
end

#matched_file ⇒ Object

Returns the ProjectFile used to determine the License



37
38
39
 
# File 'lib/licensee/projects/project.rb', line 37

def matched_file
  matched_files.first if matched_files.count == 1 || lgpl?
end

#matched_files ⇒ Object

Returns an array of matches LicenseFiles



42
43
44
45
46
 
# File 'lib/licensee/projects/project.rb', line 42

def matched_files
  @matched_files ||= begin
    project_files.select(&:license)
  end
end

#package_file ⇒ Object 



82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/licensee/projects/project.rb', line 82

def package_file
  return unless detect_packages?
  return @package_file if defined? @package_file
  @package_file = begin
    content, name = find_file do |n|
      Licensee::ProjectFiles::PackageManagerFile.name_score(n)
    end

    return unless content && name
    Licensee::ProjectFiles::PackageManagerFile.new(content, name)
  end
end

#readme_file ⇒ Object Also known as: readme 



67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/licensee/projects/project.rb', line 67

def readme_file
  return unless detect_readme?
  return @readme if defined? @readme
  @readme = begin
    content, name = find_file do |n|
      Licensee::ProjectFiles::ReadmeFile.name_score(n)
    end
    content = Licensee::ProjectFiles::ReadmeFile.license_content(content)

    return unless content && name
    Licensee::ProjectFiles::ReadmeFile.new(content, name)
  end
end