Merge pull request #61 from jclem/issue-repo-objects

Make `context.issue` and `context.repo` objects

Author: JasonEtco

README.md

@@ -316,23 +316,13 @@ The Git `sha` at which the action was triggered
 
 The name of the workflow that was triggered.
 
-#### tools.context.issue([object])
+#### tools.context.issue
 
-Return the `owner`, `repo`, and `number` params for making API requests against an issue or pull request. The object passed in will be merged with the repo params.
+The `owner`, `repo`, and `number` params for making API requests against an issue or pull request.
 
-```js
-const params = context.issue({body: 'Hello World!'})
-// Returns: {owner: 'username', repo: 'reponame', number: 123, body: 'Hello World!'}
-```
-
-#### tools.context.repo([object])
+#### tools.context.repo
 
-Return the `owner` and `repo` params for making API requests against a repository.
-
-```js
-const params = context.repo({path: '.github/config.yml'})
-// Returns: {owner: 'username', repo: 'reponame', path: '.github/config.yml'}
-```
+The `owner` and `repo` params for making API requests against a repository.
 
 ## Actions using actions-toolkit
 

src/context.ts

@@ -70,47 +70,26 @@ export class Context {
     this.actor = process.env.GITHUB_ACTOR as string
   }
 
-  /**
-   * Return the `owner` and `repo` params for making API requests against a
-   * repository.
-   *
-   * ```js
-   * const params = context.repo({path: '.github/config.yml'})
-   * // Returns: {owner: 'username', repo: 'reponame', path: '.github/config.yml'}
-   * ```
-   *
-   * @param object - Params to be merged with the repo params.
-   *
-   */
-  public repo<T> (object?: T) {
+  public get issue () {
+    const payload = this.payload
+
+    return {
+      ...this.repo,
+      number: (payload.issue || payload.pull_request || payload).number
+    }
+  }
+
+  public get repo () {
     const repo = this.payload.repository
 
     if (!repo) {
-      throw new Error('context.repo() is not supported for this webhook event.')
+      throw new Error('context.repo is not supported for this webhook event.')
     }
 
-    return Object.assign({
+    return {
       owner: repo.owner.login,
       repo: repo.name
-    }, object)
+    }
   }
 
-  /**
-   * Return the `owner`, `repo`, and `number` params for making API requests
-   * against an issue or pull request. The object passed in will be merged with
-   * the repo params.
-   *
-   * ```js
-   * const params = context.issue({body: 'Hello World!'})
-   * // Returns: {owner: 'username', repo: 'reponame', number: 123, body: 'Hello World!'}
-   * ```
-   *
-   * @param object - Params to be merged with the issue params.
-   */
-  public issue<T> (object?: T) {
-    const payload = this.payload
-    return Object.assign({
-      number: (payload.issue || payload.pull_request || payload).number
-    }, this.repo(object))
-  }
 }

tests/context.test.ts

@@ -27,61 +27,38 @@ describe('Context', () => {
 
   describe('#repo', () => {
     it('returns attributes from repository payload', () => {
-      expect(context.repo()).toEqual({ owner: 'JasonEtco', repo: 'test' })
+      expect(context.repo).toEqual({ owner: 'JasonEtco', repo: 'test' })
     })
 
-    it('merges attributes', () => {
-      expect(context.repo({ foo: 1, bar: 2 })).toEqual({
-        bar: 2, foo: 1, owner: 'JasonEtco', repo: 'test'
-      })
-    })
-
-    it('overrides repo attributes', () => {
-      expect(context.repo({ owner: 'muahaha' })).toEqual({
-        owner: 'muahaha', repo: 'test'
-      })
-    })
-
-    it('return error for context.repo() when repository doesn\'t exist', () => {
+    it('return error for context.repo when repository doesn\'t exist', () => {
       context.payload = {}
       try {
-        context.repo()
+        // tslint:disable-next-line no-unused-expression
+        context.repo
       } catch (e) {
-        expect(e.message).toMatch('context.repo() is not supported')
+        expect(e.message).toMatch('context.repo is not supported')
       }
     })
   })
 
   describe('#issue', () => {
     it('returns attributes from the repository payload', () => {
-      expect(context.issue()).toEqual({ owner: 'JasonEtco', repo: 'test', number: 1 })
-    })
-
-    it('merges attributes', () => {
-      expect(context.issue({ foo: 1, bar: 2 })).toEqual({
-        bar: 2, foo: 1, number: 1, owner: 'JasonEtco', repo: 'test'
-      })
-    })
-
-    it('overrides repo attributes', () => {
-      expect(context.issue({ owner: 'muahaha', number: 5 })).toEqual({
-        number: 5, owner: 'muahaha', repo: 'test'
-      })
+      expect(context.issue).toEqual({ owner: 'JasonEtco', repo: 'test', number: 1 })
     })
 
     it('works with pull_request payloads', () => {
       context.payload = {
         pull_request: { number: 2 },
         repository: { owner: { login: 'JasonEtco' }, name: 'test' }
       }
-      expect(context.issue()).toEqual({
+      expect(context.issue).toEqual({
         number: 2, owner: 'JasonEtco', repo: 'test'
       })
     })
 
     it('works with payload.number payloads', () => {
       context.payload = { number: 2, repository: { owner: { login: 'JasonEtco' }, name: 'test' } }
-      expect(context.issue()).toEqual({
+      expect(context.issue).toEqual({
         number: 2, owner: 'JasonEtco', repo: 'test'
       })
     })