Merge pull request #3601 from atom/bo-rename-git

Rename Git -> GitRepository

exports/atom.coffee

@@ -1,12 +1,17 @@
 {Point, Range} = require 'text-buffer'
+{deprecate} = require 'grim'
 
 module.exports =
   BufferedNodeProcess: require '../src/buffered-node-process'
   BufferedProcess: require '../src/buffered-process'
-  Git: require '../src/git'
+  GitRepository: require '../src/git-repository'
   Point: Point
   Range: Range
 
+Object.defineProperty module.exports, 'Git', get: ->
+  deprecate "Please require `GitRepository` instead of `Git`: `{Git} = require 'atom'`"
+  module.exports.GitRepository
+
 # The following classes can't be used from a Task handler and should therefore
 # only be exported when not running as a child node process
 unless process.env.ATOM_SHELL_INTERNAL_RUN_AS_NODE

spec/git-spec.coffee

@@ -1,5 +1,5 @@
 temp = require 'temp'
-Git = require '../src/git'
+GitRepository = require '../src/git-repository'
 fs = require 'fs-plus'
 path = require 'path'
 Task = require '../src/task'
@@ -10,7 +10,7 @@ copyRepository = ->
   fs.renameSync(path.join(workingDirPath, 'git.git'), path.join(workingDirPath, '.git'))
   workingDirPath
 
-describe "Git", ->
+describe "GitRepository", ->
   repo = null
 
   beforeEach ->
@@ -22,28 +22,28 @@ describe "Git", ->
 
   describe "@open(path)", ->
     it "returns null when no repository is found", ->
-      expect(Git.open(path.join(temp.dir, 'nogit.txt'))).toBeNull()
+      expect(GitRepository.open(path.join(temp.dir, 'nogit.txt'))).toBeNull()
 
-  describe "new Git(path)", ->
+  describe "new GitRepository(path)", ->
     it "throws an exception when no repository is found", ->
-      expect(-> new Git(path.join(temp.dir, 'nogit.txt'))).toThrow()
+      expect(-> new GitRepository(path.join(temp.dir, 'nogit.txt'))).toThrow()
 
   describe ".getPath()", ->
     it "returns the repository path for a .git directory path", ->
-      repo = new Git(path.join(__dirname, 'fixtures', 'git', 'master.git', 'HEAD'))
+      repo = new GitRepository(path.join(__dirname, 'fixtures', 'git', 'master.git', 'HEAD'))
       expect(repo.getPath()).toBe path.join(__dirname, 'fixtures', 'git', 'master.git')
 
     it "returns the repository path for a repository path", ->
-      repo = new Git(path.join(__dirname, 'fixtures', 'git', 'master.git'))
+      repo = new GitRepository(path.join(__dirname, 'fixtures', 'git', 'master.git'))
       expect(repo.getPath()).toBe path.join(__dirname, 'fixtures', 'git', 'master.git')
 
   describe ".isPathIgnored(path)", ->
     it "returns true for an ignored path", ->
-      repo = new Git(path.join(__dirname, 'fixtures', 'git', 'ignore.git'))
+      repo = new GitRepository(path.join(__dirname, 'fixtures', 'git', 'ignore.git'))
       expect(repo.isPathIgnored('a.txt')).toBeTruthy()
 
     it "returns false for a non-ignored path", ->
-      repo = new Git(path.join(__dirname, 'fixtures', 'git', 'ignore.git'))
+      repo = new GitRepository(path.join(__dirname, 'fixtures', 'git', 'ignore.git'))
       expect(repo.isPathIgnored('b.txt')).toBeFalsy()
 
   describe ".isPathModified(path)", ->
@@ -51,7 +51,7 @@ describe "Git", ->
 
     beforeEach ->
       workingDirPath = copyRepository()
-      repo = new Git(workingDirPath)
+      repo = new GitRepository(workingDirPath)
       filePath = path.join(workingDirPath, 'a.txt')
       newPath = path.join(workingDirPath, 'new-path.txt')
 
@@ -75,7 +75,7 @@ describe "Git", ->
 
     beforeEach ->
       workingDirPath = copyRepository()
-      repo = new Git(workingDirPath)
+      repo = new GitRepository(workingDirPath)
       filePath = path.join(workingDirPath, 'a.txt')
       newPath = path.join(workingDirPath, 'new-path.txt')
       fs.writeFileSync(newPath, "i'm new here")
@@ -92,7 +92,7 @@ describe "Git", ->
 
     beforeEach ->
       workingDirPath = copyRepository()
-      repo = new Git(workingDirPath)
+      repo = new GitRepository(workingDirPath)
       filePath = path.join(workingDirPath, 'a.txt')
 
     it "no longer reports a path as modified after checkout", ->
@@ -124,7 +124,7 @@ describe "Git", ->
 
     beforeEach ->
       workingDirPath = copyRepository()
-      repo = new Git(workingDirPath)
+      repo = new GitRepository(workingDirPath)
       filePath = path.join(workingDirPath, 'a.txt')
       fs.writeFileSync(filePath, 'ch ch changes')
 
@@ -153,7 +153,7 @@ describe "Git", ->
 
   describe ".destroy()", ->
     it "throws an exception when any method is called after it is called", ->
-      repo = new Git(require.resolve('./fixtures/git/master.git/HEAD'))
+      repo = new GitRepository(require.resolve('./fixtures/git/master.git/HEAD'))
       repo.destroy()
       expect(-> repo.getShortHead()).toThrow()
 
@@ -162,7 +162,7 @@ describe "Git", ->
 
     beforeEach ->
       workingDirectory = copyRepository()
-      repo = new Git(workingDirectory)
+      repo = new GitRepository(workingDirectory)
       filePath = path.join(workingDirectory, 'file.txt')
 
     it "trigger a status-changed event when the new status differs from the last cached one", ->
@@ -182,7 +182,7 @@ describe "Git", ->
 
     beforeEach ->
       workingDirectory = copyRepository()
-      repo = new Git(workingDirectory)
+      repo = new GitRepository(workingDirectory)
       directoryPath = path.join(workingDirectory, 'dir')
       filePath = path.join(directoryPath, 'b.txt')
 
@@ -197,7 +197,7 @@ describe "Git", ->
 
     beforeEach ->
       workingDirectory = copyRepository()
-      repo = new Git(workingDirectory)
+      repo = new GitRepository(workingDirectory)
       modifiedPath = path.join(workingDirectory, 'file.txt')
       newPath = path.join(workingDirectory, 'untracked.txt')
       cleanPath = path.join(workingDirectory, 'other.txt')

src/git-repository.coffee

@@ -40,10 +40,10 @@ Task = require './task'
 # ### Requiring in packages
 #
 # ```coffee
-# {Git} = require 'atom'
+# {GitRepository} = require 'atom'
 # ```
 module.exports =
-class Git
+class GitRepository
   EmitterMixin.includeInto(this)
   Subscriber.includeInto(this)
 
@@ -58,18 +58,18 @@ class Git
   Section: Construction and Destruction
   ###
 
-  # Public: Creates a new Git instance.
+  # Public: Creates a new GitRepository instance.
   #
   # * `path` The {String} path to the Git repository to open.
   # * `options` An optinal {Object} with the following keys:
   #   * `refreshOnWindowFocus` A {Boolean}, `true` to refresh the index and
   #     statuses when the window is focused.
   #
-  # Returns a {Git} instance or `null` if the repository could not be opened.
+  # Returns a {GitRepository} instance or `null` if the repository could not be opened.
   @open: (path, options) ->
     return null unless path
     try
-      new Git(path, options)
+      new GitRepository(path, options)
     catch
       null
 
@@ -96,7 +96,7 @@ class Git
     if @project?
       @subscribe @project.eachBuffer (buffer) => @subscribeToBuffer(buffer)
 
-  # Public: Destroy this {Git} object.
+  # Public: Destroy this {GitRepository} object.
   #
   # This destroys any tasks and subscriptions and releases the underlying
   # libgit2 repository handle.
@@ -143,11 +143,11 @@ class Git
   on: (eventName) ->
     switch eventName
       when 'status-changed'
-        deprecate 'Use Git::onDidChangeStatus instead'
+        deprecate 'Use GitRepository::onDidChangeStatus instead'
       when 'statuses-changed'
-        deprecate 'Use Git::onDidChangeStatuses instead'
+        deprecate 'Use GitRepository::onDidChangeStatuses instead'
       else
-        deprecate 'Git::on is deprecated. Use event subscription methods instead.'
+        deprecate 'GitRepository::on is deprecated. Use event subscription methods instead.'
     EmitterMixin::on.apply(this, arguments)
 
   ###

src/project.coffee

@@ -13,7 +13,7 @@ TextBuffer = require 'text-buffer'
 
 Editor = require './editor'
 Task = require './task'
-Git = require './git'
+GitRepository = require './git-repository'
 
 # Extended: Represents a project that's opened in Atom.
 #
@@ -70,7 +70,7 @@ class Project extends Model
   Section: Accessing the git repository
   ###
 
-  # Public: Returns the {Git} repository if available.
+  # Public: Returns the {GitRepository} if available.
   getRepo: -> @repo
 
   ###
@@ -93,7 +93,7 @@ class Project extends Model
     if projectPath?
       directory = if fs.isDirectorySync(projectPath) then projectPath else path.dirname(projectPath)
       @rootDirectory = new Directory(directory)
-      if @repo = Git.open(directory, project: this)
+      if @repo = GitRepository.open(directory, project: this)
         @repo.refreshIndex()
         @repo.refreshStatus()
     else