Update to Allow Bundle Exec

* Update to add preference to allow use of bundle exec

Author: mzagaja

CHANGELOG.md

@@ -1,3 +1,7 @@
+## Version 1.2
+* Enable using `bundle exec` with rubocop.
+* Bug: fix error if there are no fixes from Rubocop.
+
 ## Version 1.1
 
 Add issue severity differentiation.

README.md

@@ -21,7 +21,16 @@ gem install rubocop rubocop-rails rubocop-rspec rubocop-md
 
 
 ### Configuration
+* We now let you choose whether to prepend your rubocop with `bundle exec`. If you do not it will
+use `rubocop` from your default/global gemset.
 
-Following the [Rails Doctrine](https://rubyonrails.org/doctrine/#convention-over-configuration)
-this extension does not require nor support configuration. It will use your global
-Rubocop installation. 
+### Troubleshooting
+If you have a .rubocop.yml with `inherit_gem` and use `rvm` you will need to make sure your gems are
+all available in the default gemset. The easiest way to do this is to avoid using app specific
+gemsets. Otherwise try:
+
+```sh
+cd $APP_DIRECTORY
+rvm use default
+bundle install
+```

Scripts/main.js

@@ -1,6 +1,6 @@
 
 exports.activate = function() {
-    
+
 }
 
 exports.deactivate = function() {
@@ -12,8 +12,14 @@ class IssuesProvider {
         return new Promise(function(resolve) {
             try {
                 const options = {
+                    cwd: nova.workspace.path,
                     args: ["rubocop", '--disable-pending-cops', '-fj', editor.document.path]
                 };
+                if(nova.config.get("Rubocop.bundle-exec", "boolean")) {
+                    options.args.unshift("bundle", "exec")
+                }
+                // console.log('Config: ' + nova.config.get("Rubocop.bundle-exec", "boolean"))
+                // console.log("Options: " + options.args)
                 let rubocop = new Process("/usr/bin/env", options);
                 let rawIssues = []
                 let issues = [];
@@ -25,24 +31,27 @@ class IssuesProvider {
                     'convention': IssueSeverity.Hint,
                     'info': IssueSeverity.Info
                 }
-        
                 rubocop.onStdout((line) => { rawIssues.push(line); });
-                rubocop.onStderr((line) => { console.warn(`Rubocop ERROR: ${line}`); });
+                rubocop.onStderr((line) => { console.error(`Rubocop ERROR: ${line}`); });
                 rubocop.onDidExit((message) => {
-                    const allIssues = JSON.parse(rawIssues)['files'][0]['offenses'];
-                    allIssues.forEach((offense) => {
-                        let issue = new Issue();
-                        issue.message = offense['message']
-                        issue.code = offense['cop_name']
-                        issue.severity = issueSeverity[offense['severity']];
-                        issue.column = offense["location"]["start_column"]
-                        issue.endColumn = offense["location"]["end_column"]
-                        issue.line = offense["location"]["start_line"]
-                        issue.endLine = offense["location"]["end_line"]
-                        issues.push(issue);
-                    })
-                    resolve(issues);
-                    return;
+                    if(rawIssues.length === 0) {
+                        return;
+                    } else {
+                        const allIssues = JSON.parse(rawIssues)['files'][0]['offenses'];
+                        allIssues.forEach((offense) => {
+                            let issue = new Issue();
+                            issue.message = offense['message']
+                            issue.code = offense['cop_name']
+                            issue.severity = issueSeverity[offense['severity']];
+                            issue.column = offense["location"]["start_column"]
+                            issue.endColumn = offense["location"]["end_column"]
+                            issue.line = offense["location"]["start_line"]
+                            issue.endLine = offense["location"]["end_line"]
+                            issues.push(issue);
+                        })
+                        resolve(issues);
+                        return;
+                    }
                 });
                 rubocop.start();
             } catch(error) {
@@ -54,4 +63,4 @@ class IssuesProvider {
     }
 }
 
-nova.assistants.registerIssueAssistant("ruby", new IssuesProvider(), {event: "onChange"});
+nova.assistants.registerIssueAssistant("ruby", new IssuesProvider(), {event: "onChange"});

extension.json

@@ -3,18 +3,26 @@
     "name": "RuboCop",
     "organization": "Matt Zagaja",
     "description": "Rubocop extension.",
-    "version": "1.1",
-    "categories": ["issues"],
+    "version": "1.2",
+    "categories": [
+        "issues"
+    ],
     "repository": "https://github.com/mzagaja/Rubocop.novaextension",
     "bugs": "https://github.com/mzagaja/Rubocop.novaextension/issues",
-    
     "main": "main.js",
-    
     "activationEvents": [
         "onLanguage:ruby"
     ],
-    
     "entitlements": {
         "process": true
-    }
+    },
+    "config": [
+        {
+            "key": "Rubocop.bundle-exec",
+            "title": "Prepend rubocop with bundle exec",
+            "description": "Use this to prepend rubocop with bundle exec.",
+            "type": "boolean",
+            "default": false
+        }
+    ]
 }