Merge pull request #424 from telamonian/add-user-settings

Adds user setings: historyCount controls number of logs shown

Author: fcollonval

.travis.yml

@@ -5,13 +5,15 @@ cache:
   pip: true
   directories:
     - /home/travis/.yarn-cache/
+install: pip install pytest "jupyterlab~=1.0"
 script:
-  - pip install 'jupyterlab~=1.0'
   - python setup.py sdist
-  - pip install --find-links=dist jupyterlab_git[test]
-  - pytest jupyterlab_git
-  - jlpm run test
+  - pip install jupyterlab_git[test] --find-links=dist --no-deps --no-cache-dir -v
+  - pip install jupyterlab_git[test] --find-links=dist -v
+  - jupyter labextension list
   - jupyter lab build
+  - pytest jupyterlab_git -r ap
+  - jlpm run test
   - python -m jupyterlab.browser_check
   - jlpm run lint
   - python tests/test-browser/run_browser_test.py

MANIFEST.in

@@ -14,6 +14,7 @@ graft tests
 prune tests/build
 
 # Javascript files
+graft schema
 graft src
 graft style
 prune **/node_modules
@@ -24,4 +25,4 @@ global-exclude *~
 global-exclude *.pyc
 global-exclude *.pyo
 global-exclude .git
-global-exclude .ipynb_checkpoints
+global-exclude .ipynb_checkpoints

jupyterlab_git/_version.py

@@ -1,5 +1,5 @@
 # Copyright (c) Project Jupyter.
 # Distributed under the terms of the Modified BSD License.
 
-version_info = (0, 8, 2)
+version_info = (0, 9, 0)
 __version__ = ".".join(map(str, version_info))

jupyterlab_git/git.py

@@ -233,12 +233,12 @@ def status(self, current_path):
                 "message": my_error.decode("utf-8"),
             }
 
-    def log(self, current_path):
+    def log(self, current_path, history_count=10):
         """
         Execute git log command & return the result.
         """
         p = Popen(
-            ["git", "log", "--pretty=format:%H%n%an%n%ar%n%s", "-10"],
+            ["git", "log", "--pretty=format:%H%n%an%n%ar%n%s", ("-%d" % history_count)],
             stdout=PIPE,
             stderr=PIPE,
             cwd=os.path.join(self.root_dir, current_path),

jupyterlab_git/handlers.py

@@ -51,13 +51,16 @@ def post(self):
         POST request handler, calls individual handlers for
         'git show_top_level', 'git branch', 'git log', and 'git status'
         """
-        current_path = self.get_json_body()["current_path"]
+        body = self.get_json_body()
+        current_path = body["current_path"]
+        history_count = body["history_count"]
+
         show_top_level = self.git.show_top_level(current_path)
         if show_top_level["code"] != 0:
             self.finish(json.dumps(show_top_level))
         else:
             branch = self.git.branch(current_path)
-            log = self.git.log(current_path)
+            log = self.git.log(current_path, history_count)
             status = self.git.status(current_path)
 
             result = {

jupyterlab_git/tests/test_handlers.py

@@ -1,6 +1,7 @@
+import json
 from mock import Mock, ANY, patch
 
-from jupyterlab_git.handlers import GitUpstreamHandler, GitPushHandler, setup_handlers
+from jupyterlab_git.handlers import GitAllHistoryHandler, GitUpstreamHandler, GitPushHandler, setup_handlers
 
 
 def test_mapping_added():
@@ -17,7 +18,7 @@ def test_mapping_added():
 @patch('jupyterlab_git.handlers.GitUpstreamHandler.get_json_body', Mock(return_value={'current_path': 'test_path'}))
 @patch('jupyterlab_git.handlers.GitUpstreamHandler.git')
 @patch('jupyterlab_git.handlers.GitUpstreamHandler.finish')
-def test_push_handler_localbranch(mock_finish, mock_git):
+def test_upstream_handler_localbranch(mock_finish, mock_git):
     # Given
     mock_git.get_current_branch.return_value = 'foo'
     mock_git.get_upstream_branch.return_value = 'bar'
@@ -31,6 +32,42 @@ def test_push_handler_localbranch(mock_finish, mock_git):
     mock_finish.assert_called_with('{"upstream": "bar"}')
 
 
+@patch('jupyterlab_git.handlers.GitAllHistoryHandler.__init__', Mock(return_value=None))
+@patch('jupyterlab_git.handlers.GitAllHistoryHandler.get_json_body', Mock(return_value={'current_path': 'test_path', 'history_count': 25}))
+@patch('jupyterlab_git.handlers.GitAllHistoryHandler.git')
+@patch('jupyterlab_git.handlers.GitAllHistoryHandler.finish')
+def test_all_history_handler_localbranch(mock_finish, mock_git):
+    # Given
+    show_top_level = {'code': 0, 'foo': 'top_level'}
+    branch = 'branch_foo'
+    log = 'log_foo'
+    status = 'status_foo'
+
+    mock_git.show_top_level.return_value = show_top_level
+    mock_git.branch.return_value = branch
+    mock_git.log.return_value = log
+    mock_git.status.return_value = status
+
+    # When
+    GitAllHistoryHandler().post()
+
+    # Then
+    mock_git.show_top_level.assert_called_with('test_path')
+    mock_git.branch.assert_called_with('test_path')
+    mock_git.log.assert_called_with('test_path', 25)
+    mock_git.status.assert_called_with('test_path')
+
+    mock_finish.assert_called_with(json.dumps({
+        'code': show_top_level['code'],
+        'data': {
+            'show_top_level': show_top_level,
+            'branch': branch,
+            'log': log,
+            'status': status,
+        }
+    }))
+
+
 @patch('jupyterlab_git.handlers.GitPushHandler.__init__', Mock(return_value=None))
 @patch('jupyterlab_git.handlers.GitPushHandler.get_json_body', Mock(return_value={'current_path': 'test_path'}))
 @patch('jupyterlab_git.handlers.GitPushHandler.git')

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyterlab/git",
-  "version": "0.8.2",
+  "version": "0.9.0",
   "description": "A JupyterLab extension for version control using git",
   "main": "lib/index.js",
   "style": "style/index.css",
@@ -28,14 +28,13 @@
   },
   "files": [
     "lib/**/*.{d.ts,eot,gif,html,jpg,js,js.map,json,png,svg,woff2,ttf}",
-    "style/*.css",
-    "style/images/*.svg"
+    "schema/**/*.{json,}",
+    "style/**/*.{css,svg}"
   ],
   "sideEffects": [
     "style/*.css"
   ],
   "jupyterlab": {
-    "extension": true,
     "discovery": {
       "server": {
         "managers": [
@@ -46,7 +45,9 @@
           "name": "jupyterlab-git"
         }
       }
-    }
+    },
+    "extension": true,
+    "schemaDir": "schema"
   },
   "dependencies": {
     "@jupyterlab/application": "^1.1.0",

schema/plugin.json

@@ -0,0 +1,15 @@
+{
+  "jupyter.lab.setting-icon-class": "jp-GitIcon",
+  "jupyter.lab.setting-icon-label": "Git",
+  "title": "Git",
+  "description": "jupyterlab-git settings.",
+  "type": "object",
+  "properties": {
+    "historyCount": {
+      "type": "integer",
+      "title": "History count",
+      "description": "Number of (most recent) commits shown in the history log",
+      "default": 25
+    }
+  }
+}

src/components/GitPanel.tsx

@@ -28,6 +28,7 @@ import {
   findRepoButtonStyle
 } from '../style/GitPanelStyle';
 import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
+import { ISettingRegistry } from '@jupyterlab/coreutils';
 
 /** Interface for GitPanel component state */
 export interface IGitSessionNodeState {
@@ -56,6 +57,7 @@ export interface IGitSessionNodeProps {
   app: JupyterFrontEnd;
   diff: IDiffCallback;
   renderMime: IRenderMimeRegistry;
+  settings: ISettingRegistry.ISettings;
 }
 
 /** A React component for the git extension's main display */
@@ -103,7 +105,8 @@ export class GitPanel extends React.Component<
       if (fileBrowser) {
         // Make API call to get all git info for repo
         let apiResult = await gitApi.allHistory(
-          (fileBrowser as any).model.path
+          (fileBrowser as any).model.path,
+          this.props.settings.composite['historyCount'] as number
         );
 
         if (apiResult.code === 0) {

src/components/GitWidget.tsx

@@ -19,10 +19,16 @@ import { gitWidgetStyle } from '../style/GitWidgetStyle';
 import { IDiffCallback } from '../git';
 
 import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
+import { ISettingRegistry } from '@jupyterlab/coreutils';
 /**
  * An options object for creating a running sessions widget.
  */
 export interface IOptions {
+  /**
+   * A settings key.
+   */
+  key: string;
+
   /**
    * A service manager instance.
    */
@@ -33,6 +39,11 @@ export interface IOptions {
    * The default is a shared renderer instance.
    */
   renderer?: IRenderer;
+
+  /**
+   * The setings registry.
+   */
+  settings: ISettingRegistry;
 }
 
 /**
@@ -77,11 +88,26 @@ export class GitWidget extends Widget {
       node: (options.renderer || defaultRenderer).createNode()
     });
     this.addClass(gitWidgetStyle);
-    const element = (
-      <GitPanel app={app} diff={diffFunction} renderMime={renderMime} />
-    );
-    this.component = ReactDOM.render(element, this.node);
-    this.component.refresh();
+
+    const { key } = options;
+    const registry = options.settings;
+
+    void registry.load(key).then(settings => {
+      this._settings = settings;
+
+      const element = (
+        <GitPanel
+          app={app}
+          diff={diffFunction}
+          renderMime={renderMime}
+          settings={this._settings}
+        />
+      );
+      this.component = ReactDOM.render(element, this.node);
+
+      this._settings.changed.connect(this.component.refresh, this);
+      this.component.refresh();
+    });
   }
 
   /**
@@ -190,4 +216,5 @@ export class GitWidget extends Widget {
   private _renderer: IRenderer = null;
   private _refreshId = -1;
   private _refreshed = new Signal<this, void>(this);
+  private _settings: ISettingRegistry.ISettings;
 }