Class: Licensee::License

Inherits:
Object
  • Object
show all
Includes:
ContentHelper
Defined in:
lib/licensee/license.rb

Constant Summary collapse

YAML_DEFAULTS =

These should be in sync with choosealicense.com’s collection defaults

{
  'featured' => false,
  'hidden'   => true
}.freeze
PSEUDO_LICENSES =

Pseudo-license are license placeholders with no content

‘other` - The project had a license, but we were not able to detect it `no-license` - The project is not licensed (e.g., all rights reserved)

Note: A lack of detected license will be a nil license

%w(other no-license).freeze

Constants included from ContentHelper

ContentHelper::DIGEST

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from ContentHelper

#content_normalized, #hash, #wordset

Constructor Details

#initialize(key) ⇒ License

Returns a new instance of License.



70
71
72
 
# File 'lib/licensee/license.rb', line 70

def initialize(key)
  @key = key.downcase
end

Instance Attribute Details

#key ⇒ Object (readonly)

Returns the value of attribute key.



52
53
54
 
# File 'lib/licensee/license.rb', line 52

def key
  @key
end

Class Method Details

.all(options = {}) ⇒ Object

All license objects defined via Licensee (via choosealicense.com)

Options:

  • :hidden - boolean, return hidden licenses (default: false)

  • :featured - boolean, return only (non)featured licenses (default: all)

Returns an Array of License objects.



15
16
17
18
19
20
21
 
# File 'lib/licensee/license.rb', line 15

def all(options = {})
  options = { hidden: false, featured: nil }.merge(options)
  output = licenses.dup
  output.reject!(&:hidden?) unless options[:hidden]
  return output if options[:featured].nil?
  output.select { |l| l.featured? == options[:featured] }
end

.find(key, options = {}) ⇒ Object Also known as: [], find_by_key 



29
30
31
32
 
# File 'lib/licensee/license.rb', line 29

def find(key, options = {})
  options = { hidden: true }.merge(options)
  all(options).find { |license| key.casecmp(license.key).zero? }
end

.keys ⇒ Object 



23
24
25
26
27
 
# File 'lib/licensee/license.rb', line 23

def keys
  @keys ||= license_files.map do |license_file|
    File.basename(license_file, '.txt').downcase
  end + PSEUDO_LICENSES
end

.license_dir ⇒ Object 



36
37
38
39
 
# File 'lib/licensee/license.rb', line 36

def license_dir
  dir = File.dirname(__FILE__)
  File.expand_path '../../vendor/choosealicense.com/_licenses', dir
end

.license_files ⇒ Object 



41
42
43
 
# File 'lib/licensee/license.rb', line 41

def license_files
  @license_files ||= Dir.glob("#{license_dir}/*.txt")
end

Instance Method Details

#==(other) ⇒ Object 



128
129
130
 
# File 'lib/licensee/license.rb', line 128

def ==(other)
  !other.nil? && key == other.key
end

#content ⇒ Object Also known as: to_s, text, body

The license body (e.g., contents - frontmatter)



117
118
119
 
# File 'lib/licensee/license.rb', line 117

def content
  @content ||= parts[2] if parts && parts[2]
end

#featured? ⇒ Boolean Also known as: featured

Returns:

  • (Boolean) 


104
105
106
107
 
# File 'lib/licensee/license.rb', line 104

def featured?
  return YAML_DEFAULTS['featured'] unless meta
  meta['featured']
end

#hidden? ⇒ Boolean

Returns:

  • (Boolean) 


110
111
112
113
114
 
# File 'lib/licensee/license.rb', line 110

def hidden?
  return true if PSEUDO_LICENSES.include?(key)
  return YAML_DEFAULTS['hidden'] unless meta
  meta['hidden']
end

#meta ⇒ Object

License metadata from YAML front matter



80
81
82
83
84
85
86
87
88
89
 
# File 'lib/licensee/license.rb', line 80

def meta
  @meta ||= if parts && parts[1]
    meta = if YAML.respond_to? :safe_load
      YAML.safe_load(parts[1])
    else
      YAML.load(parts[1])
    end
    YAML_DEFAULTS.merge(meta)
  end
end

#name ⇒ Object

Returns the human-readable license name



92
93
94
 
# File 'lib/licensee/license.rb', line 92

def name
  meta.nil? ? key.capitalize : meta['title']
end

#name_without_version ⇒ Object 



100
101
102
 
# File 'lib/licensee/license.rb', line 100

def name_without_version
  /(.+?)(( v?\d\.\d)|$)/.match(name)[1]
end

#nickname ⇒ Object 



96
97
98
 
# File 'lib/licensee/license.rb', line 96

def nickname
  meta['nickname'] if meta
end

#path ⇒ Object

Path to vendored license file on disk



75
76
77
 
# File 'lib/licensee/license.rb', line 75

def path
  @path ||= File.expand_path "#{@key}.txt", Licensee::License.license_dir
end

#url ⇒ Object 



124
125
126
 
# File 'lib/licensee/license.rb', line 124

def url
  URI.join(Licensee::DOMAIN, "/licenses/#{key}/").to_s
end