Class: Linguist::LazyBlob

Inherits:
Object
  • Object
show all
Includes:
BlobHelper
Defined in:
lib/linguist/lazy_blob.rb

Constant Summary collapse

GIT_ATTR =
['linguist-documentation',
'linguist-language',
'linguist-vendored',
'linguist-generated',
'linguist-detectable']
GIT_ATTR_OPTS =
{ :priority => [:index], :skip_system => true }
GIT_ATTR_FLAGS =
Rugged::Repository::Attributes.parse_opts(GIT_ATTR_OPTS)
MAX_SIZE =
128 * 1024

Constants included from BlobHelper

BlobHelper::DETECTABLE_TYPES, BlobHelper::DocumentationRegexp, BlobHelper::MEGABYTE, BlobHelper::VendoredRegexp

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from BlobHelper

#_mime_type, #binary?, #binary_mime_type?, #content_type, #csv?, #detect_encoding, #disposition, #empty?, #encoded_newlines_re, #encoding, #extname, #first_lines, #high_ratio_of_long_lines?, #image?, #include_in_language_stats?, #large?, #last_lines, #likely_binary?, #lines, #loc, #mime_type, #pdf?, #ruby_encoding, #safe_to_colorize?, #sloc, #solid?, #text?, #tm_scope, #viewable?

Constructor Details

#initialize(repo, oid, path, mode = nil) ⇒ LazyBlob

Returns a new instance of LazyBlob.



27
28
29
30
31
32
33
# File 'lib/linguist/lazy_blob.rb', line 27

def initialize(repo, oid, path, mode = nil)
  @repository = repo
  @oid = oid
  @path = path
  @mode = mode
  @data = nil
end

Instance Attribute Details

#modeObject (readonly)

Returns the value of attribute mode.



23
24
25
# File 'lib/linguist/lazy_blob.rb', line 23

def mode
  @mode
end

#oidObject (readonly)

Returns the value of attribute oid.



21
22
23
# File 'lib/linguist/lazy_blob.rb', line 21

def oid
  @oid
end

#pathObject (readonly) Also known as: name

Returns the value of attribute path.



22
23
24
# File 'lib/linguist/lazy_blob.rb', line 22

def path
  @path
end

#repositoryObject (readonly)

Returns the value of attribute repository.



20
21
22
# File 'lib/linguist/lazy_blob.rb', line 20

def repository
  @repository
end

Instance Method Details

#cleanup!Object



97
98
99
# File 'lib/linguist/lazy_blob.rb', line 97

def cleanup!
  @data.clear if @data
end

#dataObject



82
83
84
85
# File 'lib/linguist/lazy_blob.rb', line 82

def data
  load_blob!
  @data
end

#detectable?Boolean

Returns:

  • (Boolean)


74
75
76
77
78
79
80
# File 'lib/linguist/lazy_blob.rb', line 74

def detectable?
  if not git_attributes['linguist-detectable'].nil?
    boolean_attribute(git_attributes['linguist-detectable'])
  else
    nil
  end
end

#documentation?Boolean

Returns:

  • (Boolean)


40
41
42
43
44
45
46
# File 'lib/linguist/lazy_blob.rb', line 40

def documentation?
  if not git_attributes['linguist-documentation'].nil?
    boolean_attribute(git_attributes['linguist-documentation'])
  else
    super
  end
end

#generated?Boolean

Returns:

  • (Boolean)


48
49
50
51
52
53
54
# File 'lib/linguist/lazy_blob.rb', line 48

def generated?
  if not git_attributes['linguist-generated'].nil?
    boolean_attribute(git_attributes['linguist-generated'])
  else
    super
  end
end

#git_attributesObject



35
36
37
38
# File 'lib/linguist/lazy_blob.rb', line 35

def git_attributes
  @git_attributes ||= repository.fetch_attributes(
    name, GIT_ATTR, GIT_ATTR_FLAGS)
end

#languageObject



64
65
66
67
68
69
70
71
72
# File 'lib/linguist/lazy_blob.rb', line 64

def language
  return @language if defined?(@language)

  @language = if lang = git_attributes['linguist-language']
    Language.find_by_alias(lang)
  else
    super
  end
end

#sizeObject



87
88
89
90
# File 'lib/linguist/lazy_blob.rb', line 87

def size
  load_blob!
  @size
end

#symlink?Boolean

Returns:

  • (Boolean)


92
93
94
95
# File 'lib/linguist/lazy_blob.rb', line 92

def symlink?
  # We don't create LazyBlobs for symlinks.
  false
end

#vendored?Boolean

Returns:

  • (Boolean)


56
57
58
59
60
61
62
# File 'lib/linguist/lazy_blob.rb', line 56

def vendored?
  if not git_attributes['linguist-vendored'].nil?
    boolean_attribute(git_attributes['linguist-vendored'])
  else
    super
  end
end