Merge pull request #1592 from github/vmg/tmscopes

Vmg/tmscopes

README.md

@@ -32,33 +32,57 @@ The Language stats bar that you see on every repository is built by aggregating
 
 The repository stats API, accessed through `#languages`, can be used on a directory:
 
+***API UPDATE***
+
+Since [Version 3.0.0](https://github.com/github/linguist/releases/tag/v3.0.0) Linguist requires a git repository (in the form of a [Rugged::Repository](https://github.com/libgit2/rugged#repositories)) to be passed when initializing `Linguist::Repository`.
+
+
 ```ruby
-project = Linguist::Repository.from_directory(".")
+require 'rugged'
-project.language.name  #=> "Ruby"
+require 'linguist'
-project.languages      #=> { "Ruby" => 0.98, "Shell" => 0.02 }
+
+repo = Rugged::Repository.new('.')
+project = Linguist::Repository.new(repo, repo.head.target_id)
+project.language       #=> "Ruby"
+project.languages      #=> { "Ruby" => 119387 }
 ```
 
 These stats are also printed out by the `linguist` binary. You can use the
 `--breakdown` flag, and the binary will also output the breakdown of files by language.
 
-You can try running `linguist` on the `lib/` directory in this repository itself:
+You can try running `linguist` on the root directory in this repository itself:
 
-    $ bundle exec linguist lib/ --breakdown
+    $ bundle exec linguist --breakdown
 
     100.00% Ruby
 
     Ruby:
-    linguist/blob_helper.rb
+    Gemfile
-    linguist/classifier.rb
+    Rakefile
-    linguist/file_blob.rb
+    bin/linguist
-    linguist/generated.rb
+    github-linguist.gemspec
-    linguist/heuristics.rb
+    lib/linguist.rb
-    linguist/language.rb
+    lib/linguist/blob_helper.rb
-    linguist/md5.rb
+    lib/linguist/classifier.rb
-    linguist/repository.rb
+    lib/linguist/file_blob.rb
-    linguist/samples.rb
+    lib/linguist/generated.rb
-    linguist/tokenizer.rb
+    lib/linguist/heuristics.rb
-    linguist.rb
+    lib/linguist/language.rb
+    lib/linguist/lazy_blob.rb
+    lib/linguist/md5.rb
+    lib/linguist/repository.rb
+    lib/linguist/samples.rb
+    lib/linguist/tokenizer.rb
+    lib/linguist/version.rb
+    test/test_blob.rb
+    test/test_classifier.rb
+    test/test_heuristics.rb
+    test/test_language.rb
+    test/test_md5.rb
+    test/test_pedantic.rb
+    test/test_repository.rb
+    test/test_samples.rb
+    test/test_tokenizer.rb
 
 #### Ignore vendored files
 

lib/linguist/blob_helper.rb

@@ -321,6 +321,11 @@ module Linguist
       language ? language.lexer : Pygments::Lexer.find_by_name('Text only')
     end
 
+    # Internal: Get the TextMate compatible scope for the blob
+    def tm_scope
+      language && language.tm_scope
+    end
+
     # Public: Highlight syntax of blob
     #
     # options - A Hash of options (defaults to {})

lib/linguist/heuristics.rb

@@ -19,6 +19,9 @@ module Linguist
         if languages.all? { |l| ["ECL", "Prolog"].include?(l) }
           result = disambiguate_ecl(data, languages)
         end
+        if languages.all? { |l| ["IDL", "Prolog"].include?(l) }
+          result = disambiguate_pro(data, languages)
+        end
         if languages.all? { |l| ["Common Lisp", "OpenCL"].include?(l) }
           result = disambiguate_cl(data, languages)
         end
@@ -51,6 +54,16 @@ module Linguist
       matches
     end
 
+    def self.disambiguate_pro(data, languages)
+      matches = []
+      if (data.include?(":-"))
+        matches << Language["Prolog"]
+      else
+        matches << Language["IDL"]
+      end
+      matches
+    end
+
     def self.disambiguate_ts(data, languages)
       matches = []
       if (data.include?("</translation>"))

lib/linguist/language.rb

@@ -290,6 +290,16 @@ module Linguist
       @lexer = Pygments::Lexer.find_by_name(attributes[:lexer] || name) ||
         raise(ArgumentError, "#{@name} is missing lexer")
 
+      @tm_scope = attributes[:tm_scope] || begin
+        context = case @type
+                  when :data, :markup, :prose
+                    'text'
+                  when :programming, nil
+                    'source'
+                  end
+        "#{context}.#{@name.downcase}"
+      end
+
       @ace_mode = attributes[:ace_mode]
       @wrap = attributes[:wrap] || false
 
@@ -363,6 +373,11 @@ module Linguist
     # Returns the Lexer
     attr_reader :lexer
 
+    # Public: Get the name of a TextMate-compatible scope
+    #
+    # Returns the scope
+    attr_reader :tm_scope
+
     # Public: Get Ace mode
     #
     # Examples
@@ -564,6 +579,7 @@ module Linguist
       :type              => options['type'],
       :aliases           => options['aliases'],
       :lexer             => options['lexer'],
+      :tm_scope          => options['tm_scope'],
       :ace_mode          => options['ace_mode'],
       :wrap              => options['wrap'],
       :group_name        => options['group'],

lib/linguist/languages.yml

@@ -83,6 +83,7 @@ ATS:
 ActionScript:
   type: programming
   lexer: ActionScript 3
+  tm_scope: source.actionscript.3
   color: "#e3491a"
   search_term: as3
   aliases:
@@ -282,6 +283,7 @@ C:
 C#:
   type: programming
   ace_mode: csharp
+  tm_scope: source.cs
   search_term: csharp
   color: "#178600"
   aliases:
@@ -411,6 +413,7 @@ Clojure:
 
 CoffeeScript:
   type: programming
+  tm_scope: source.coffee
   ace_mode: coffee
   color: "#244776"
   aliases:
@@ -453,6 +456,7 @@ ColdFusion CFC:
 
 Common Lisp:
   type: programming
+  tm_scope: source.lisp
   color: "#3fb68b"
   aliases:
   - lisp
@@ -648,6 +652,7 @@ Elm:
 Emacs Lisp:
   type: programming
   lexer: Common Lisp
+  tm_scope: source.lisp
   color: "#c065db"
   aliases:
   - elisp
@@ -932,6 +937,7 @@ Groovy Server Pages:
 
 HTML:
   type: markup
+  tm_scope: text.html.basic
   ace_mode: html
   aliases:
   - xhtml
@@ -1158,6 +1164,7 @@ Java Server Pages:
 
 JavaScript:
   type: programming
+  tm_scope: source.js
   ace_mode: javascript
   color: "#f1e05a"
   aliases:
@@ -1569,6 +1576,7 @@ ObjDump:
 
 Objective-C:
   type: programming
+  tm_scope: source.objc
   color: "#438eff"
   aliases:
   - obj-c
@@ -1669,6 +1677,7 @@ PAWN:
 
 PHP:
   type: programming
+  tm_scope: text.html.php
   ace_mode: php
   color: "#4F5D95"
   extensions:
@@ -1820,6 +1829,7 @@ Prolog:
   extensions:
   - .pl
   - .ecl
+  - .pro
   - .prolog
 
 Propeller Spin:
@@ -2089,6 +2099,7 @@ SQF:
 
 SQL:
   type: data
+  tm_scope: source.sql
   ace_mode: sql
   extensions:
   - .sql

lib/linguist/version.rb

@@ -1,3 +1,3 @@
 module Linguist
-  VERSION = "3.2.0"
+  VERSION = "3.3.0"
 end

samples/Prolog/logic-problem.pro

@@ -0,0 +1,68 @@
+/**
+ * Question 1.1
+ * combiner(+Buddies, -Pairs)
+ */
+combiner([], []).
+combiner([First|Buddies], Pairs):-
+	make_pairs(First, Buddies, Pairs1),
+	combiner(Buddies, Pairs2),
+	concat(Pairs1, Pairs2, Pairs).
+
+/**
+ * make_pairs(+Buddy, +Buddies, -Pairs)
+ */
+make_pairs(Buddy, [], []).
+make_pairs(Buddy, [First|Buddies], [(Buddy, First)|Pairs]):-
+	make_pairs(Buddy, Buddies, Pairs).
+
+/**
+ * concat(+X, +Y, ?T)
+ */
+concat([], Y, Y).
+concat([P|R], Y, [P|T]):-
+	concat(R, Y, T).
+
+
+/**
+ * Question 1.2
+ * extraire(+AllPossiblePairs, +NbPairs, -Tp, -RemainingPairs)
+ */
+extraire(AllPossiblePairs, 0, [], AllPossiblePairs).
+extraire([PossiblePair|AllPossiblePairs], NbPairs, [PossiblePair|Tp], NewRemainingPairs):-
+	NbPairs > 0,
+	NewNbPairs is NbPairs - 1,
+	extraire(AllPossiblePairs, NewNbPairs, Tp, RemainingPairs),
+	not(pair_in_array(PossiblePair, Tp)),
+	delete_pair(RemainingPairs, PossiblePair, NewRemainingPairs).
+extraire([PossiblePair|AllPossiblePairs], NbPairs, Tp, [PossiblePair|RemainingPairs]):-
+	NbPairs > 0,
+	extraire(AllPossiblePairs, NbPairs, Tp, RemainingPairs),
+	pair_in_array(PossiblePair, Tp).
+
+/**
+ * delete_pair(+Pairs, +Pair, -PairsWithoutPair)
+ */
+delete_pair([], _, []).
+delete_pair([Pair|Pairs], Pair, Pairs):-!.
+delete_pair([FirstPair|Pairs], Pair, [FirstPair|PairsWithoutPair]):-
+	delete_pair(Pairs, Pair, PairsWithoutPair).
+
+/**
+ * pair_in_array(+Pair, +Pairs)
+ */
+pair_in_array((A, B), [(C, D)|Pairs]):-
+	(A == C ; B == D ; A == D ; B == C),
+	!.
+pair_in_array(Pair, [FirstPair|Pairs]):-
+	pair_in_array(Pair, Pairs).
+
+
+/**
+ * Question 1.3
+ * les_tps(+Buddies, -Tps)
+ */
+les_tps(Buddies, Tps):-
+	combiner(Buddies, PossiblePairs),
+	length(Buddies, NbBuddies),
+	NbPairs is integer(NbBuddies / 2),
+	findall(Tp, extraire(PossiblePairs, NbPairs, Tp, _), Tps).

test/test_heuristics.rb

@@ -65,6 +65,18 @@ class TestHeuristcs < Test::Unit::TestCase
     assert_equal Language["ECL"], results.first
   end
 
+  def test_pro_prolog_by_heuristics
+    languages = ["IDL", "Prolog"]
+    results = Heuristics.disambiguate_pro(fixture("Prolog/logic-problem.pro"), languages)
+    assert_equal Language["Prolog"], results.first
+  end
+
+  def test_pro_idl_by_heuristics
+    languages = ["IDL", "Prolog"]
+    results = Heuristics.disambiguate_pro(fixture("IDL/mg_acosh.pro"), languages)
+    assert_equal Language["IDL"], results.first
+  end
+
   def test_ts_typescript_by_heuristics
     languages = ["TypeScript", "XML"]
     results = Heuristics.disambiguate_ts(fixture("TypeScript/classes.ts"), languages)