Class: Linguist::Generated

Inherits:
Object
  • Object
show all
Defined in:
lib/linguist/generated.rb

Constant Summary collapse

PROTOBUF_EXTENSIONS = 
['.py', '.java', '.h', '.cc', '.cpp', '.m', '.rb']
APACHE_THRIFT_EXTENSIONS = 
['.rb', '.py', '.go', '.js', '.m', '.java', '.h', '.cc', '.cpp', '.php']

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, data) ⇒ Generated

Internal: Initialize Generated instance

name - String filename data - String blob data



19
20
21
22
23
 
# File 'lib/linguist/generated.rb', line 19

def initialize(name, data)
  @name = name
  @extname = File.extname(name)
  @_data = data
end

Instance Attribute Details

#extname ⇒ Object (readonly)

Returns the value of attribute extname.



25
26
27
 
# File 'lib/linguist/generated.rb', line 25

def extname
  @extname
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



25
26
27
 
# File 'lib/linguist/generated.rb', line 25

def name
  @name
end

Class Method Details

.generated?(name, data) ⇒ Boolean

Public: Is the blob a generated file?

name - String filename data - String blob data. A block also may be passed in for lazy

loading. This behavior is deprecated and you should always
pass in a String.

Return true or false

Returns:

  • (Boolean) 


11
12
13
 
# File 'lib/linguist/generated.rb', line 11

def self.generated?(name, data)
  new(name, data).generated?
end

Instance Method Details

#cargo_lock? ⇒ Boolean

Internal: Is the blob a generated Rust Cargo lock file?

Returns true or false.

Returns:

  • (Boolean) 


398
399
400
 
# File 'lib/linguist/generated.rb', line 398

def cargo_lock?
  !!name.match(/Cargo\.lock/)
end

#carthage_build? ⇒ Boolean

Internal: Is the blob part of Carthage/Build/, which contains dependencies not meant for humans in pull requests.

Returns true or false.

Returns:

  • (Boolean) 


117
118
119
 
# File 'lib/linguist/generated.rb', line 117

def carthage_build?
  !!name.match(/(^|\/)Carthage\/Build\//)
end

#cocoapods? ⇒ Boolean

Internal: Is the blob part of Pods/, which contains dependencies not meant for humans in pull requests.

Returns true or false.

Returns:

  • (Boolean) 


110
111
112
 
# File 'lib/linguist/generated.rb', line 110

def cocoapods?
  !!name.match(/(^Pods|\/Pods)\//)
end

#compiled_coffeescript? ⇒ Boolean

Internal: Is the blob of JS generated by CoffeeScript?

CoffeeScript is meant to output JS that would be difficult to tell if it was generated or not. Look for a number of patterns output by the CS compiler.

Return true or false

Returns:

  • (Boolean) 


174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/linguist/generated.rb', line 174

def compiled_coffeescript?
  return false unless extname == '.js'

  # CoffeeScript generated by > 1.2 include a comment on the first line
  if lines[0] =~ /^\/\/ Generated by /
    return true
  end

  if lines[0] == '(function() {' &&     # First line is module closure opening
      lines[-2] == '}).call(this);' &&  # Second to last line closes module closure
      lines[-1] == ''                   # Last line is blank

    score = 0

    lines.each do |line|
      if line =~ /var /
        # Underscored temp vars are likely to be Coffee
        score += 1 * line.gsub(/(_fn|_i|_len|_ref|_results)/).count

        # bind and extend functions are very Coffee specific
        score += 3 * line.gsub(/(__bind|__extends|__hasProp|__indexOf|__slice)/).count
      end
    end

    # Require a score of 3. This is fairly arbitrary. Consider
    # tweaking later.
    score >= 3
  else
    false
  end
end

#compiled_cython_file? ⇒ Boolean

Internal: Is this a compiled C/C++ file from Cython?

Cython-compiled C/C++ files typically contain: /* Generated by Cython x.x.x on … */ on the first line.

Return true or false

Returns:

  • (Boolean) 


419
420
421
422
423
 
# File 'lib/linguist/generated.rb', line 419

def compiled_cython_file?
  return false unless ['.c', '.cpp'].include? extname
  return false unless lines.count > 1
  return lines[0].include?("Generated by Cython")
end

#composer_lock? ⇒ Boolean

Internal: Is the blob a generated php composer lock file?

Returns true or false.

Returns:

  • (Boolean) 


384
385
386
 
# File 'lib/linguist/generated.rb', line 384

def composer_lock?
  !!name.match(/composer\.lock/)
end

#data ⇒ Object

Lazy load blob data if block was passed in.

Awful, awful stuff happening here.

Returns String data.



32
33
34
 
# File 'lib/linguist/generated.rb', line 32

def data
  @data ||= @_data.respond_to?(:call) ? @_data.call() : @_data
end

#extract_html_meta(match) ⇒ Object

Internal: Extract a Hash of name/content pairs from an HTML <meta> tag



636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
 
# File 'lib/linguist/generated.rb', line 636

def extract_html_meta(match)
  (match.last.sub(/\/\Z/, "").strip.scan(/
    (?<=^|\s)        # Check for preceding whitespace
    (name|content)   # Attribute names we're interested in
    \s* = \s*        # Key-value separator

    # Attribute value
    ( "[^"]+"        # name="value"
    | '[^']+'        # name='value'
    |  [^\s"']+      # name=value
    )
  /ix)).map do |match|
    key = match[0].downcase
    val = match[1].gsub(/\A["']|["']\Z/, '')
    [key, val]
  end.select { |x| x.length == 2 }.to_h
end

#generated? ⇒ Boolean

Internal: Is the blob a generated file?

Generated source code is suppressed in diffs and is ignored by language statistics.

Please add additional test coverage to ‘test/test_blob.rb#test_generated` if you make any changes.

Return true or false

Returns:

  • (Boolean) 


53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/linguist/generated.rb', line 53

def generated?
  xcode_file? ||
  cocoapods? ||
  carthage_build? ||
  generated_graphql_relay? ||
  generated_net_designer_file? ||
  generated_net_specflow_feature_file? ||
  composer_lock? ||
  cargo_lock? ||
  node_modules? ||
  go_vendor? ||
  go_lock? ||
  npm_shrinkwrap_or_package_lock? ||
  godeps? ||
  generated_by_zephir? ||
  minified_files? ||
  has_source_map? ||
  source_map? ||
  compiled_coffeescript? ||
  generated_parser? ||
  generated_net_docfile? ||
  generated_postscript? ||
  compiled_cython_file? ||
  pipenv_lock? ||
  generated_go? ||
  generated_protocol_buffer? ||
  generated_javascript_protocol_buffer? ||
  generated_apache_thrift? ||
  generated_jni_header? ||
  vcr_cassette? ||
  generated_module? ||
  generated_unity3d_meta? ||
  generated_racc? ||
  generated_jflex? ||
  generated_grammarkit? ||
  generated_roxygen2? ||
  generated_html? ||
  generated_jison? ||
  generated_grpc_cpp? ||
  generated_dart? ||
  generated_perl_ppport_header? ||
  generated_gamemakerstudio?
end

#generated_apache_thrift? ⇒ Boolean

Internal: Is the blob generated by Apache Thrift compiler?

Returns true or false

Returns:

  • (Boolean) 


328
329
330
331
 
# File 'lib/linguist/generated.rb', line 328

def generated_apache_thrift?
  return false unless APACHE_THRIFT_EXTENSIONS.include?(extname)
  return lines.first(6).any? { |l| l.include?("Autogenerated by Thrift Compiler") }
end

#generated_by_zephir? ⇒ Boolean

Internal: Is the blob generated by Zephir?

Returns true or false.

Returns:

  • (Boolean) 


391
392
393
 
# File 'lib/linguist/generated.rb', line 391

def generated_by_zephir?
  !!name.match(/.\.zep\.(?:c|h|php)$/)
end

#generated_dart? ⇒ Boolean

Internal: Is this a generated Dart file?

A dart-lang/appengine generated file contains: // Generated code. Do not modify. on the first line.

An owl generated file contains: // GENERATED CODE - DO NOT MODIFY on the first line.

Return true or false

Returns:

  • (Boolean) 


559
560
561
562
563
 
# File 'lib/linguist/generated.rb', line 559

def generated_dart?
  return false unless extname == '.dart'
  return false unless lines.count > 1
  return lines.first.downcase =~ /generated code\W{2,3}do not modify/
end

#generated_gamemakerstudio? ⇒ Boolean

Internal: Is this a generated Game Maker Studio (2) metadata file?

All Game Maker Studio 2 generated files will be JSON, .yy or .yyp, and have a part that looks like “modelName: GMname” on the 3rd line

Return true or false

Returns:

  • (Boolean) 


587
588
589
590
591
592
 
# File 'lib/linguist/generated.rb', line 587

def generated_gamemakerstudio?
  return false unless ['.yy', '.yyp'].include? extname
  return false unless lines.count > 3
  return lines[2].match(/\"modelName\"\:\s*\"GM/) ||
         lines[0] =~ /^\d\.\d\.\d.+\|\{/
end

#generated_go? ⇒ Boolean

Returns:

  • (Boolean) 


292
293
294
295
296
297
 
# File 'lib/linguist/generated.rb', line 292

def generated_go?
  return false unless extname == '.go'
  return false unless lines.count > 1

  return lines[0].include?("Code generated by")
end

#generated_grammarkit? ⇒ Boolean

Internal: Is this a GrammarKit-generated file?

A GrammarKit-generated file typically contain: // This is a generated file. Not intended for manual editing. on the first line. This is not always the case, as it’s possible to customize the class header.

Return true or false

Returns:

  • (Boolean) 


497
498
499
500
501
 
# File 'lib/linguist/generated.rb', line 497

def generated_grammarkit?
  return false unless extname == '.java'
  return false unless lines.count > 1
  return lines[0].start_with?("// This is a generated file. Not intended for manual editing.")
end

#generated_graphql_relay? ⇒ Boolean

Internal: Is this a relay-compiler generated graphql file?

Return true or false

Returns:

  • (Boolean) 


577
578
579
 
# File 'lib/linguist/generated.rb', line 577

def generated_graphql_relay?
  !!name.match(/__generated__\//)
end

#generated_grpc_cpp? ⇒ Boolean

Internal: Is this a protobuf/grpc-generated C++ file?

A generated file contains: // Generated by the gRPC C++ plugin. on the first line.

Return true or false

Returns:

  • (Boolean) 


542
543
544
545
546
 
# File 'lib/linguist/generated.rb', line 542

def generated_grpc_cpp?
  return false unless %w{.cpp .hpp .h .cc}.include? extname
  return false unless lines.count > 1
  return lines[0].start_with?("// Generated by the gRPC")
end

#generated_html? ⇒ Boolean

Internal: Is this a generated HTML file?

HTML documents generated by authoring tools often include a a <meta> tag in the header of the form:

<meta name="generator" content="DocGen v5.0.1" />

Return true or false

Returns:

  • (Boolean) 


602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'lib/linguist/generated.rb', line 602

def generated_html?
  return false unless ['.html', '.htm', '.xhtml'].include? extname.downcase
  return false unless lines.count > 1

  # Pkgdown
  return true if lines[0..1].any? do |line|
    line.match(/<!-- Generated by pkgdown: do not edit by hand -->/)
  end

  # Mandoc
  return true if lines.count > 2 && lines[2].start_with?('<!-- This is an automatically generated file.')

  # Doxygen
  return true if lines[0..30].any? do |line|
    line.match(/<!--\s+Generated by Doxygen\s+[.0-9]+\s*-->/i)
  end

  # HTML tag: <meta name="generator" content="…" />
  matches = lines[0..30].join(' ').scan(/<meta(\s+[^>]++)>/i)
  return false if matches.empty?
  return matches.map {|x| extract_html_meta(x) }.any? do |attr|
    attr["name"].to_s.downcase == 'generator' &&
    attr["content"].match(/^
      ( org \s+ mode
      | j?latex2html
      | groff
      | makeinfo
      | texi2html
      ) \b
    /ix)
  end
end

#generated_javascript_protocol_buffer? ⇒ Boolean

Internal: Is the blob a Javascript source file generated by the Protocol Buffer compiler?

Returns true or false.

Returns:

  • (Boolean) 


316
317
318
319
320
321
 
# File 'lib/linguist/generated.rb', line 316

def generated_javascript_protocol_buffer?
  return false unless extname == ".js"
  return false unless lines.count > 6

  return lines[5].include?("GENERATED CODE -- DO NOT EDIT!")
end

#generated_jflex? ⇒ Boolean

Internal: Is this a JFlex-generated file?

A JFlex-generated file contains: /* The following code was generated by JFlex x.y.z on d/at/e ti:me */ on the first line.

Return true or false

Returns:

  • (Boolean) 


483
484
485
486
487
 
# File 'lib/linguist/generated.rb', line 483

def generated_jflex?
  return false unless extname == '.java'
  return false unless lines.count > 1
  return lines[0].start_with?("/* The following code was generated by JFlex ")
end

#generated_jison? ⇒ Boolean

Internal: Is this a Jison-generated file?

Jison-generated parsers typically contain: /* parser generated by jison on the first line.

Jison-generated lexers typically contain: /* generated by jison-lex on the first line.

Return true or false

Returns:

  • (Boolean) 


528
529
530
531
532
533
 
# File 'lib/linguist/generated.rb', line 528

def generated_jison?
  return false unless extname == '.js'
  return false unless lines.count > 1
  return lines[0].start_with?("/* parser generated by jison ") ||
         lines[0].start_with?("/* generated by jison-lex ")
end

#generated_jni_header? ⇒ Boolean

Internal: Is the blob a C/C++ header generated by the Java JNI tool javah?

Returns true or false.

Returns:

  • (Boolean) 


336
337
338
339
340
341
342
 
# File 'lib/linguist/generated.rb', line 336

def generated_jni_header?
  return false unless extname == '.h'
  return false unless lines.count > 2

  return lines[0].include?("/* DO NOT EDIT THIS FILE - it is machine generated */") &&
           lines[1].include?("#include <jni.h>")
end

#generated_module? ⇒ Boolean

Internal: Is it a KiCAD or GFortran module file?

KiCAD module files contain: PCBNEW-LibModule-V1 yyyy-mm-dd h:mm:ss XM on the first line.

GFortran module files contain: GFORTRAN module version ‘x’ created from on the first line.

Return true or false

Returns:

  • (Boolean) 


443
444
445
446
447
448
 
# File 'lib/linguist/generated.rb', line 443

def generated_module?
  return false unless extname == '.mod'
  return false unless lines.count > 1
  return lines[0].include?("PCBNEW-LibModule-V") ||
          lines[0].include?("GFORTRAN module version '")
end

#generated_net_designer_file? ⇒ Boolean

Internal: Is this a codegen file for a .NET project?

Visual Studio often uses code generation to generate partial classes, and these files can be quite unwieldy. Let’s hide them.

Returns true or false

Returns:

  • (Boolean) 


231
232
233
 
# File 'lib/linguist/generated.rb', line 231

def generated_net_designer_file?
  name.downcase =~ /\.designer\.(cs|vb)$/
end

#generated_net_docfile? ⇒ Boolean

Internal: Is this a generated documentation file for a .NET assembly?

.NET developers often check in the XML Intellisense file along with an assembly - however, these don’t have a special extension, so we have to dig into the contents to determine if it’s a docfile. Luckily, these files are extremely structured, so recognizing them is easy.

Returns true or false

Returns:

  • (Boolean) 


214
215
216
217
218
219
220
221
222
223
 
# File 'lib/linguist/generated.rb', line 214

def generated_net_docfile?
  return false unless extname.downcase == ".xml"
  return false unless lines.count > 3

  # .NET Docfiles always open with <doc> and their first tag is an
  # <assembly> tag
  return lines[1].include?("<doc>") &&
    lines[2].include?("<assembly>") &&
    lines[-2].include?("</doc>")
end

#generated_net_specflow_feature_file? ⇒ Boolean

Internal: Is this a codegen file for Specflow feature file?

Visual Studio’s SpecFlow extension generates *.feature.cs files from *.feature files, they are not meant to be consumed by humans. Let’s hide them.

Returns true or false

Returns:

  • (Boolean) 


242
243
244
 
# File 'lib/linguist/generated.rb', line 242

def generated_net_specflow_feature_file?
  name.downcase =~ /\.feature\.cs$/
end

#generated_parser? ⇒ Boolean

Internal: Is the blob of JS a parser generated by PEG.js?

PEG.js-generated parsers are not meant to be consumed by humans.

Return true or false

Returns:

  • (Boolean) 


251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/linguist/generated.rb', line 251

def generated_parser?
  return false unless extname == '.js'

  # PEG.js-generated parsers include a comment near the top  of the file
  # that marks them as such.
  if lines[0..4].join('') =~ /^(?:[^\/]|\/[^\*])*\/\*(?:[^\*]|\*[^\/])*Generated by PEG.js/
    return true
  end

  false
end

#generated_perl_ppport_header? ⇒ Boolean

Internal: Is the file a generated Perl/Pollution/Portability header file?

Returns true or false.

Returns:

  • (Boolean) 


568
569
570
571
572
 
# File 'lib/linguist/generated.rb', line 568

def generated_perl_ppport_header?
    return false unless name.match(/ppport\.h$/)
    return false unless lines.count > 10
    return lines[8].include?("Automatically created by Devel::PPPort")
end

#generated_postscript? ⇒ Boolean

Internal: Is the blob of PostScript generated?

PostScript files are often generated by other programs. If they tell us so, we can detect them.

Returns true or false.

Returns:

  • (Boolean) 


269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/linguist/generated.rb', line 269

def generated_postscript?
  return false unless ['.ps', '.eps', '.pfa'].include? extname

  # Type 1 and Type 42 fonts converted to PostScript are stored as hex-encoded byte streams; these
  # streams are always preceded the `eexec` operator (if Type 1), or the `/sfnts` key (if Type 42).
  return true if data =~ /(\n|\r\n|\r)\s*(?:currentfile eexec\s+|\/sfnts\s+\[\1<)\h{8,}\1/

  # We analyze the "%%Creator:" comment, which contains the author/generator
  # of the file. If there is one, it should be in one of the first few lines.
  creator = lines[0..9].find {|line| line =~ /^%%Creator: /}
  return false if creator.nil?

  # Most generators write their version number, while human authors' or companies'
  # names don't contain numbers. So look if the line contains digits. Also
  # look for some special cases without version numbers.
  return true if creator =~ /[0-9]|draw|mpage|ImageMagick|inkscape|MATLAB/ ||
    creator =~ /PCBNEW|pnmtops|\(Unknown\)|Serif Affinity|Filterimage -tops/

  # EAGLE doesn't include a version number when it generates PostScript.
  # However, it does prepend its name to the document's "%%Title" field.
  !!creator.include?("EAGLE") and lines[0..4].find {|line| line =~ /^%%Title: EAGLE Drawing /}
end

#generated_protocol_buffer? ⇒ Boolean

Internal: Is the blob a C++, Java or Python source file generated by the Protocol Buffer compiler?

Returns true or false.

Returns:

  • (Boolean) 


305
306
307
308
309
310
 
# File 'lib/linguist/generated.rb', line 305

def generated_protocol_buffer?
  return false unless PROTOBUF_EXTENSIONS.include?(extname)
  return false unless lines.count > 1

  return lines[0].include?("Generated by the protocol buffer compiler.  DO NOT EDIT!")
end

#generated_racc? ⇒ Boolean

Internal: Is this a Racc-generated file?

A Racc-generated file contains: # This file is automatically generated by Racc x.y.z on the third line.

Return true or false

Returns:

  • (Boolean) 


470
471
472
473
474
 
# File 'lib/linguist/generated.rb', line 470

def generated_racc?
  return false unless extname == '.rb'
  return false unless lines.count > 2
  return lines[2].start_with?("# This file is automatically generated by Racc")
end

#generated_roxygen2? ⇒ Boolean

Internal: Is this a roxygen2-generated file?

A roxygen2-generated file typically contain: % Generated by roxygen2: do not edit by hand on the first line.

Return true or false

Returns:

  • (Boolean) 


510
511
512
513
514
515
 
# File 'lib/linguist/generated.rb', line 510

def generated_roxygen2?
  return false unless extname == '.Rd'
  return false unless lines.count > 1

  return lines[0].include?("% Generated by roxygen2: do not edit by hand")
end

#generated_unity3d_meta? ⇒ Boolean

Internal: Is this a metadata file from Unity3D?

Unity3D Meta files start with:

fileFormatVersion: X
guid: XXXXXXXXXXXXXXX

Return true or false

Returns:

  • (Boolean) 


457
458
459
460
461
 
# File 'lib/linguist/generated.rb', line 457

def generated_unity3d_meta?
  return false unless extname == '.meta'
  return false unless lines.count > 1
  return lines[0].include?("fileFormatVersion: ")
end

#go_lock? ⇒ Boolean

Internal: Is the blob a generated Go dep or glide lock file?

Returns true or false.

Returns:

  • (Boolean) 


362
363
364
 
# File 'lib/linguist/generated.rb', line 362

def go_lock?
  !!name.match(/(Gopkg|glide)\.lock/)
end

#go_vendor? ⇒ Boolean

Internal: Is the blob part of the Go vendor/ tree, not meant for humans in pull requests.

Returns true or false.

Returns:

  • (Boolean) 


355
356
357
 
# File 'lib/linguist/generated.rb', line 355

def go_vendor?
  !!name.match(/vendor\/((?!-)[-0-9A-Za-z]+(?<!-)\.)+(com|edu|gov|in|me|net|org|fm|io)/)
end

#godeps? ⇒ Boolean

Internal: Is the blob part of Godeps/, which are not meant for humans in pull requests.

Returns true or false.

Returns:

  • (Boolean) 


377
378
379
 
# File 'lib/linguist/generated.rb', line 377

def godeps?
  !!name.match(/Godeps\//)
end

#has_source_map? ⇒ Boolean

Internal: Does the blob contain a source map reference?

We assume that if one of the last 2 lines starts with a source map reference, then the current file was generated from other files.

We use the last 2 lines because the last line might be empty.

We only handle JavaScript, no CSS support yet.

Returns true or false.

Returns:

  • (Boolean) 


148
149
150
151
 
# File 'lib/linguist/generated.rb', line 148

def has_source_map?
  return false unless extname.downcase == '.js'
  lines.last(2).any? { |line| line.start_with?('//# sourceMappingURL') }
end

#lines ⇒ Object

Public: Get each line of data

Returns an Array of lines



39
40
41
42
 
# File 'lib/linguist/generated.rb', line 39

def lines
  # TODO: data should be required to be a String, no nils
  @lines ||= data ? data.split("\n", -1) : []
end

#minified_files? ⇒ Boolean

Internal: Is the blob minified files?

Consider a file minified if the average line length is greater then 110c.

Currently, only JS and CSS files are detected by this method.

Returns true or false.

Returns:

  • (Boolean) 


129
130
131
132
133
134
135
136
 
# File 'lib/linguist/generated.rb', line 129

def minified_files?
  return unless ['.js', '.css'].include? extname
  if lines.any?
    (lines.inject(0) { |n, l| n += l.length } / lines.length) > 110
  else
    false
  end
end

#node_modules? ⇒ Boolean

Internal: Is the blob part of node_modules/, which are not meant for humans in pull requests.

Returns true or false.

Returns:

  • (Boolean) 


347
348
349
 
# File 'lib/linguist/generated.rb', line 347

def node_modules?
  !!name.match(/node_modules\//)
end

#npm_shrinkwrap_or_package_lock? ⇒ Boolean

Internal: Is the blob a generated npm shrinkwrap or package lock file?

Returns true or false.

Returns:

  • (Boolean) 


369
370
371
 
# File 'lib/linguist/generated.rb', line 369

def npm_shrinkwrap_or_package_lock?
  name.match(/npm-shrinkwrap\.json/) || name.match(/package-lock\.json/)
end

#pipenv_lock? ⇒ Boolean

Internal: Is this a Pipenv lock file?

Returns true or false.

Returns:

  • (Boolean) 


428
429
430
 
# File 'lib/linguist/generated.rb', line 428

def pipenv_lock?
  name.match(/Pipfile\.lock/)
end

#source_map? ⇒ Boolean

Internal: Is the blob a generated source map?

Source Maps usually have .css.map or .js.map extensions. In case they are not following the name convention, detect them based on the content.

Returns true or false.

Returns:

  • (Boolean) 


159
160
161
162
163
164
165
 
# File 'lib/linguist/generated.rb', line 159

def source_map?
  return false unless extname.downcase == '.map'

  name =~ /(\.css|\.js)\.map$/i ||                 # Name convention
  lines[0] =~ /^{"version":\d+,/ ||                # Revision 2 and later begin with the version number
  lines[0] =~ /^\/\*\* Begin line maps\. \*\*\/{/  # Revision 1 begins with a magic comment
end

#vcr_cassette? ⇒ Boolean

Is the blob a VCR Cassette file?

Returns true or false

Returns:

  • (Boolean) 


405
406
407
408
409
410
 
# File 'lib/linguist/generated.rb', line 405

def vcr_cassette?
  return false unless extname == '.yml'
  return false unless lines.count > 2
  # VCR Cassettes have "recorded_with: VCR" in the second last line.
  return lines[-2].include?("recorded_with: VCR")
end

#xcode_file? ⇒ Boolean

Internal: Is the blob an Xcode file?

Generated if the file extension is an Xcode file extension.

Returns true or false.

Returns:

  • (Boolean) 


103
104
105
 
# File 'lib/linguist/generated.rb', line 103

def xcode_file?
  ['.nib', '.xcworkspacedata', '.xcuserstate'].include?(extname)
end