API Changes for v1.0. Fixes #4 and #8.

ssenbud · ssenbud · commit 7fea06d2f747 · 2015-12-30T10:03:06.000-08:00
StackFrames can be optionally constructed with an Object. This is
necessary in order to avoid an explosion of constructor params.

eval() origin information can now be represented in a StackFrame.
This is done through setEvalOrigin() where one can store a "child"
StackFrame that represents location information within the eval'd
String or Function.
diff --git a/README.md b/README.md
@@ -3,14 +3,23 @@ stackframe
 ## JS Object representation of a stack frame
 [![Build Status](https://travis-ci.org/stacktracejs/stackframe.svg?branch=master)](https://travis-ci.org/stacktracejs/stackframe) [![Coverage Status](https://img.shields.io/coveralls/stacktracejs/stackframe.svg)](https://coveralls.io/r/stacktracejs/stackframe?branch=master) [![Code Climate](https://codeclimate.com/github/stacktracejs/stackframe/badges/gpa.svg)](https://codeclimate.com/github/stacktracejs/stackframe)
 
-Underlies functionality of other modules within [stacktrace.js](http://www.stacktracejs.com).
+Underlies functionality of other modules within [stacktrace.js](https://www.stacktracejs.com).
 
-Written to closely resemble StackFrame representations in [Gecko](http://mxr.mozilla.org/mozilla-central/source/xpcom/base/nsIException.idl#14) and [V8](https://code.google.com/p/v8-wiki/wiki/JavaScriptStackTraceApi)
+Written to closely resemble StackFrame representations in [Gecko](http://mxr.mozilla.org/mozilla-central/source/xpcom/base/nsIException.idl#14) and [V8](https://github.com/v8/v8/wiki/Stack%20Trace%20API)
 
 ## Usage
 ```js
 // Create StackFrame and set properties
-var stackFrame = new StackFrame('funName', ['args'], 'http://localhost:3000/file.js', 1, 3288, 'ORIGINAL_STACK_LINE');
+var stackFrame = new StackFrame({
+    functionName: 'funName',
+    args: ['args'],
+    fileName: 'http://localhost:3000/file.js',
+    lineNumber: 1,
+    columnNumber: 3288, 
+    isEval: true,
+    isNative: false,
+    source: 'ORIGINAL_STACK_LINE'
+});
 
 stackFrame.functionName      // => "funName"
 stackFrame.setFunctionName('newName')
@@ -36,6 +45,14 @@ stackFrame.source            // => 'ORIGINAL_STACK_LINE'
 stackFrame.setSource('NEW_SOURCE')
 stackFrame.getSource()       // => 'NEW_SOURCE'
 
+stackFrame.isEval            // => true
+stackFrame.setIsEval(false)
+stackFrame.getIsEval()       // => false
+
+stackFrame.isNative            // => false
+stackFrame.setIsNative(true)
+stackFrame.getIsNative()       // => true
+
 stackFrame.toString() // => 'funName(args)@http://localhost:3000/file.js:325:20'
 ```
 
diff --git a/gulpfile.js b/gulpfile.js
@@ -2,7 +2,7 @@ var coveralls = require('gulp-coveralls');
 var del = require('del');
 var gulp = require('gulp');
 var jshint = require('gulp-jshint');
-var karma = require('karma').server;
+var karma = require('karma');
 var rename = require('gulp-rename');
 var runSequence = require('run-sequence');
 var sourcemaps = require('gulp-sourcemaps');
@@ -19,17 +19,17 @@ gulp.task('lint', function () {
 });
 
 gulp.task('test', function (done) {
-    karma.start({
+    new karma.Server({
         configFile: __dirname + '/karma.conf.js',
         singleRun: true
-    }, done);
+    }, done).start();
 });
 
 gulp.task('test-ci', ['copy', 'dist'], function (done) {
-    karma.start({
+    new karma.Server({
         configFile: __dirname + '/karma.conf.ci.js',
         singleRun: true
-    }, done);
+    }, done).start();
 });
 
 gulp.task('copy', function () {
diff --git a/package.json b/package.json
@@ -6,40 +6,42 @@
         "Victor Homyakov <vkhomyackov@gmail.com> (https://github.com/victor-homyakov)",
         "Oliver Salzburg (https://github.com/oliversalzburg)"
     ],
-    "version": "0.3.1",
+    "version": "1.0.0",
     "license": "SEE LICENSE IN LICENSE",
     "keywords": [
         "stacktrace",
         "error",
         "debugger",
         "stack frame"
     ],
-    "homepage": "http://www.stacktracejs.com",
+    "homepage": "https://www.stacktracejs.com",
     "repository": {
         "type": "git",
         "url": "git://github.com/stacktracejs/stackframe.git"
     },
     "devDependencies": {
         "colors": "^1.1.2",
-        "del": "^1.2.0",
+        "del": "^2.2.0",
         "gulp": "^3.9.0",
         "gulp-coveralls": "^0.1.4",
-        "gulp-jshint": "^1.11.2",
+        "gulp-jshint": "^2.0.0",
         "gulp-rename": "^1.2.2",
-        "gulp-sourcemaps": "^1.5.2",
-        "gulp-uglify": "^1.2.0",
-        "jasmine-node": "~1.14",
-        "karma": "~0.12",
-        "karma-chrome-launcher": "^0.1.5",
-        "karma-coverage": "^0.2.6",
-        "karma-firefox-launcher": "^0.1.3",
-        "karma-ie-launcher": "^0.1.5",
-        "karma-jasmine": "^0.2.3",
-        "karma-opera-launcher": "^0.1.0",
-        "karma-phantomjs2-launcher": "^0.3.0",
+        "gulp-sourcemaps": "^1.6.0",
+        "gulp-uglify": "^1.5.1",
+        "jasmine": "^2.4.1",
+        "jasmine-core": "^2.4.1",
+        "jshint": "^2.8.0",
+        "karma": "^0.13.15",
+        "karma-chrome-launcher": "^0.2.2",
+        "karma-coverage": "^0.5.3",
+        "karma-firefox-launcher": "^0.1.7",
+        "karma-ie-launcher": "^0.2.0",
+        "karma-jasmine": "^0.3.6",
+        "karma-opera-launcher": "^0.3.0",
+        "karma-phantomjs2-launcher": "^0.3.2",
         "karma-safari-launcher": "^0.1.1",
-        "karma-sauce-launcher": "^0.2.10",
-        "run-sequence": "^1.1.2"
+        "karma-sauce-launcher": "^0.3.0",
+        "run-sequence": "^1.1.5"
     },
     "bugs": {
         "url": "https://github.com/stacktracejs/stackframe/issues"
@@ -49,3 +51,4 @@
         "test": "gulp test"
     }
 }
+
diff --git a/spec/stackframe-spec.js b/spec/stackframe-spec.js
@@ -8,7 +8,7 @@ describe('StackFrame', function () {
 
         it('throws an error given an illogical line number', function() {
             var fn = function () {
-                new StackFrame('foo', [], 'path/to/file.js', 'BOGUS');
+                new StackFrame({lineNumber: 'BOGUS'});
             };
             expect(fn).toThrow();
         });
@@ -38,6 +38,26 @@ describe('StackFrame', function () {
         });
     });
 
+    describe('#setEvalOrigin', function() {
+        var unit = new StackFrame();
+
+        it('throws an error given a non-Object', function() {
+            expect(function() {
+                unit.setEvalOrigin('BOGUS');
+            }).toThrow(new TypeError('Eval Origin must be an Object or StackFrame'));
+        });
+
+        it('handles given StackFrame', function() {
+            unit.setEvalOrigin(new StackFrame({lineNumber: 2}));
+            expect(unit.getEvalOrigin().getLineNumber()).toEqual(2);
+        });
+
+        it('handles given Object', function() {
+            unit.setEvalOrigin({functionName: 'evalFn'});
+            expect(unit.getEvalOrigin().getFunctionName()).toEqual('evalFn');
+        });
+    });
+
     describe('#setFileName', function() {
         var unit = new StackFrame();
         it('coerces input to String', function() {
@@ -57,7 +77,7 @@ describe('StackFrame', function () {
         });
 
         it('throws an error given input that cannot be coerced', function() {
-            expect(function() { unit.setLineNumber('BOGUS'); }).toThrow(new TypeError('Line Number must be a Number'));
+            expect(function() { unit.setLineNumber('BOGUS'); }).toThrow(new TypeError('lineNumber must be a Number'));
         });
     });
 
@@ -69,7 +89,42 @@ describe('StackFrame', function () {
         });
 
         it('throws an error given input that cannot be coerced', function() {
-            expect(function() { unit.setColumnNumber('BOGUS'); }).toThrow(new TypeError('Column Number must be a Number'));
+            expect(function() { unit.setColumnNumber('BOGUS'); }).toThrow(new TypeError('columnNumber must be a Number'));
+        });
+    });
+
+    describe('#setIsEval', function() {
+        var unit = new StackFrame();
+        it('coerces input to Boolean', function() {
+            unit.setIsEval('true');
+            expect(unit.getIsEval()).toBe(true);
+        });
+    });
+
+    describe('#setIsConstructor', function() {
+        var unit = new StackFrame();
+        it('coerces input to Boolean', function() {
+            unit.setIsConstructor(0);
+            expect(unit.getIsConstructor()).toBe(false);
+            expect(unit.isConstructor).toBe(false);
+        });
+    });
+
+    describe('#setIsNative', function() {
+        var unit = new StackFrame();
+        it('coerces input to Boolean', function() {
+            unit.setIsNative(undefined);
+            expect(unit.getIsNative()).toBe(false);
+            expect(unit.isNative).toBe(false);
+        });
+    });
+
+    describe('#setIsToplevel', function() {
+        var unit = new StackFrame();
+        it('coerces input to Boolean', function() {
+            unit.setIsToplevel(null);
+            expect(unit.getIsToplevel()).toBe(false);
+            expect(unit.isToplevel).toBe(false);
         });
     });
 
@@ -86,7 +141,16 @@ describe('StackFrame', function () {
             expect(new StackFrame().toString()).toEqual('{anonymous}()');
         });
         it('represents complete StackFrame same as old stacktrace.js', function() {
-            var unit = new StackFrame('fun', [1, 2], 'http://site.com/path.js', 1, 4567, 'SOURCE');
+            var unit = new StackFrame({
+                functionName: 'fun',
+                args: [1, 2],
+                fileName: 'http://site.com/path.js',
+                lineNumber: 1,
+                columnNumber: 4567,
+                isEval: false,
+                isNative: false,
+                source: 'SOURCE'
+            });
             expect(unit.toString()).toEqual('fun(1,2)@http://site.com/path.js:1:4567');
         });
     });
diff --git a/stackframe.js b/stackframe.js
