Merge pull request #2213 from ntkme/source-map

Detect generated source maps

lib/linguist/generated.rb

@@ -58,6 +58,7 @@ module Linguist
       godeps? ||
       generated_by_zephir? ||
       minified_files? ||
+      source_map? ||
       compiled_coffeescript? ||
       generated_parser? ||
       generated_net_docfile? ||
@@ -96,6 +97,20 @@ module Linguist
       end
     end
 
+    # 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.
+    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
+
     # Internal: Is the blob of JS generated by CoffeeScript?
     #
     # CoffeeScript is meant to output JS that would be difficult to

test/fixtures/Data/sourcemap.v1.map

@@ -0,0 +1,12 @@
+/** Begin line maps. **/{ “file”:”out.js”, "count": 2 }
+[0,0,0,0,0,0,1,1,1,1,2]
+[2,2,2,2,2,2,3,4,4,4,4,4]
+/** Begin file information. **/
+[“a.js”, “b.js”]
+[“b.js”, “c.js”, “d.js”]
+/** Begin mapping definitions. **/
+["a.js", 1, 34]
+["a.js", 5, 2]
+["b.js", 1, 3, "event"]
+["c.js", 1, 4]
+["d.js", 3, 78, "foo"]

test/fixtures/Data/sourcemap.v3.map

@@ -0,0 +1 @@
+{"version":3,"file":"out.js","sourceRoot":"","sources":["foo.js","bar.js"],"sourcesContent":[null,null],"names":["src","maps","are","fun"],"mappings":"A,AAAB;;ABCDE;"}

test/test_generated.rb

@@ -5,47 +5,66 @@ class TestGenerated < Minitest::Test
 
   class DataLoadedError < StandardError; end
 
-  def generated_without_loading_data(name)
-    blob = File.join(samples_path, name)
+  def generated_without_loading_data(blob)
     begin
-      assert Generated.generated?(blob, lambda { raise DataLoadedError.new }), "#{name} was not recognized as a generated file"
+      assert Generated.generated?(blob, lambda { raise DataLoadedError.new }), "#{blob} was not recognized as a generated file"
     rescue DataLoadedError
-      assert false, "Data was loaded when calling generated? on #{name}"
+      assert false, "Data was loaded when calling generated? on #{blob}"
     end
   end
 
-  def generated_loading_data(name)
-    blob = File.join(samples_path, name)
-    assert_raises(DataLoadedError, "Data wasn't loaded when calling generated? on #{name}") do
+  def generated_loading_data(blob)
+    assert_raises(DataLoadedError, "Data wasn't loaded when calling generated? on #{blob}") do
       Generated.generated?(blob, lambda { raise DataLoadedError.new })
     end
   end
 
-  def test_check_generated_without_loading_data
+  def generated_fixture_without_loading_data(name)
+    generated_without_loading_data(File.join(fixtures_path, name))
+  end
+
+  def generated_fixture_loading_data(name)
+    generated_loading_data(File.join(fixtures_path, name))
+  end
+
+  def generated_sample_without_loading_data(name)
+    generated_without_loading_data(File.join(samples_path, name))
+  end
+
+  def generated_sample_loading_data(name)
+    generated_loading_data(File.join(samples_path, name))
+  end
+
+  def test_check_generated
     # Xcode project files
-    generated_without_loading_data("Binary/MainMenu.nib")
-    generated_without_loading_data("Dummy/foo.xcworkspacedata")
-    generated_without_loading_data("Dummy/foo.xcuserstate")
+    generated_sample_without_loading_data("Binary/MainMenu.nib")
+    generated_sample_without_loading_data("Dummy/foo.xcworkspacedata")
+    generated_sample_without_loading_data("Dummy/foo.xcuserstate")
 
     # .NET designer file
-    generated_without_loading_data("Dummu/foo.designer.cs")
+    generated_sample_without_loading_data("Dummu/foo.designer.cs")
 
     # Composer generated composer.lock file
-    generated_without_loading_data("JSON/composer.lock")
+    generated_sample_without_loading_data("JSON/composer.lock")
 
     # Node modules
-    generated_without_loading_data("Dummy/node_modules/foo.js")
+    generated_sample_without_loading_data("Dummy/node_modules/foo.js")
 
     # Godep saved dependencies
-    generated_without_loading_data("Godeps/Godeps.json")
-    generated_without_loading_data("Godeps/_workspace/src/github.com/kr/s3/sign.go")
+    generated_sample_without_loading_data("Godeps/Godeps.json")
+    generated_sample_without_loading_data("Godeps/_workspace/src/github.com/kr/s3/sign.go")
 
     # Generated by Zephir
-    generated_without_loading_data("C/exception.zep.c")
-    generated_without_loading_data("C/exception.zep.h")
-    generated_without_loading_data("PHP/exception.zep.php")
+    generated_sample_without_loading_data("C/exception.zep.c")
+    generated_sample_without_loading_data("C/exception.zep.h")
+    generated_sample_without_loading_data("PHP/exception.zep.php")
 
     # Minified files
-    generated_loading_data("JavaScript/jquery-1.6.1.min.js")
+    generated_sample_loading_data("JavaScript/jquery-1.6.1.min.js")
+
+    # Source Map
+    generated_fixture_without_loading_data("Data/bootstrap.css.map")
+    generated_fixture_loading_data("Data/sourcemap.v3.map")
+    generated_fixture_loading_data("Data/sourcemap.v1.map")
   end
 end