Merge pull request #5277 from atom/mb-package-json-services

Allow packages to specify services in their package.json files

spec/fixtures/packages/package-with-consumed-services/index.coffee

@@ -0,0 +1,10 @@
+module.exports =
+  activate: ->
+
+  deactivate: ->
+
+  consumeFirstServiceV3: ->
+
+  consumeFirstServiceV4: ->
+
+  consumeSecondService: ->

spec/fixtures/packages/package-with-consumed-services/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "package-with-consumed-services",
+
+  "consumedServices": {
+    "service-1": {
+      "versions": {
+        ">=0.2 <=0.3.6": "consumeFirstServiceV3",
+        "^0.4.1": "consumeFirstServiceV4"
+      }
+    },
+    "service-2": {
+      "versions": {
+        "0.2.1 || 0.2.2": "consumeSecondService"
+      }
+    }
+  }
+}

spec/fixtures/packages/package-with-provided-services/index.coffee

@@ -0,0 +1,13 @@
+module.exports =
+  activate: ->
+
+  deactivate: ->
+
+  provideFirstServiceV3: ->
+    'first-service-v3'
+
+  provideFirstServiceV4: ->
+    'first-service-v4'
+
+  provideSecondService: ->
+    'second-service'

spec/fixtures/packages/package-with-provided-services/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "package-with-provided-services",
+
+  "providedServices": {
+    "service-1": {
+      "description": "The first service",
+      "versions": {
+        "0.3.1": "provideFirstServiceV3",
+        "0.4.1": "provideFirstServiceV4"
+      }
+    },
+    "service-2": {
+      "description": "The second service",
+      "versions": {
+        "0.2.1": "provideSecondService"
+      }
+    }
+  }
+}

spec/package-manager-spec.coffee

@@ -1,5 +1,6 @@
 {$, $$} = require '../src/space-pen-extensions'
 Package = require '../src/package'
+{Disposable} = require 'atom'
 
 describe "PackageManager", ->
   workspaceElement = null
@@ -445,6 +446,47 @@ describe "PackageManager", ->
         runs ->
           expect(atom.config.get 'editor.increaseIndentPattern', scope: ['.source.omg']).toBe '^a'
 
+    describe "service registration", ->
+      it "registers the package's provided and consumed services", ->
+        consumerModule = require "./fixtures/packages/package-with-consumed-services"
+        firstServiceV3Disposed = false
+        firstServiceV4Disposed = false
+        secondServiceDisposed = false
+        spyOn(consumerModule, 'consumeFirstServiceV3').andReturn(new Disposable -> firstServiceV3Disposed = true)
+        spyOn(consumerModule, 'consumeFirstServiceV4').andReturn(new Disposable -> firstServiceV4Disposed = true)
+        spyOn(consumerModule, 'consumeSecondService').andReturn(new Disposable -> secondServiceDisposed = true)
+
+        waitsForPromise ->
+          atom.packages.activatePackage("package-with-consumed-services")
+
+        waitsForPromise ->
+          atom.packages.activatePackage("package-with-provided-services")
+
+        runs ->
+          expect(consumerModule.consumeFirstServiceV3).toHaveBeenCalledWith('first-service-v3')
+          expect(consumerModule.consumeFirstServiceV4).toHaveBeenCalledWith('first-service-v4')
+          expect(consumerModule.consumeSecondService).toHaveBeenCalledWith('second-service')
+
+          consumerModule.consumeFirstServiceV3.reset()
+          consumerModule.consumeFirstServiceV4.reset()
+          consumerModule.consumeSecondService.reset()
+
+          atom.packages.deactivatePackage("package-with-provided-services")
+
+          expect(firstServiceV3Disposed).toBe true
+          expect(firstServiceV4Disposed).toBe true
+          expect(secondServiceDisposed).toBe true
+
+          atom.packages.deactivatePackage("package-with-consumed-services")
+
+        waitsForPromise ->
+          atom.packages.activatePackage("package-with-provided-services")
+
+        runs ->
+          expect(consumerModule.consumeFirstServiceV3).not.toHaveBeenCalled()
+          expect(consumerModule.consumeFirstServiceV4).not.toHaveBeenCalled()
+          expect(consumerModule.consumeSecondService).not.toHaveBeenCalled()
+
   describe "::deactivatePackage(id)", ->
     afterEach ->
       atom.packages.unloadPackages()

spec/spec-helper.coffee

@@ -17,6 +17,7 @@ Config = require '../src/config'
 {Point} = require 'text-buffer'
 Project = require '../src/project'
 Workspace = require '../src/workspace'
+ServiceHub = require 'service-hub'
 TextEditor = require '../src/text-editor'
 TextEditorView = require '../src/text-editor-view'
 TextEditorElement = require '../src/text-editor-element'
@@ -77,6 +78,7 @@ beforeEach ->
   projectPath = specProjectPath ? path.join(@specDirectory, 'fixtures')
   atom.project = new Project(paths: [projectPath])
   atom.workspace = new Workspace()
+  atom.packages.serviceHub = new ServiceHub
   atom.keymaps.keyBindings = _.clone(keyBindingsToRestore)
   atom.commands.restoreSnapshot(commandsToRestore)
   atom.styles.restoreSnapshot(styleElementsToRestore)