Move regexMapper & maps outside UAParser class

package.json

@@ -1,40 +1,51 @@
 {
-  "title"       : "UA-Parser.js",
+  "title": "UA-Parser.JS",
-  "name"        : "ua-parser-js",
+  "name": "ua-parser-js",
-  "version"     : "0.1.2",
+  "version": "0.3.4",
-  "author"      : {
+  "author": "Faisal Salman <fyzlman@gmail.com> (http://faisalman.com)",
-      "name"      : "Faisal Salman",
+  "description": "Lightweight JavaScript-based user-agent string parser",
-      "email"     : "fyzlman@gmail.com",
+  "keywords": [
-      "url"       : "http://faisalman.com"
+    "user agent",
-  },
-  "description" : "Lightweight JavaScript-based user-agent parser",
-  "keywords"    : [
-    "user-agent",
     "parser",
-    "browser"
+    "browser",
+    "engine",
+    "os",
+    "device"
   ],
-  "homepage"    : "http://faisalman.github.com/ua-parser-js",
+  "homepage": "http://github.com/faisalman/ua-parser-js",
   "contributors": [
-    {
+    "Faisal Salman <fyzlman@gmail.com>"
-      "name"    : "Faisal Salman",
-      "email"   : "fyzlman@gmail.com"
-    }
   ],
-  "main"        : "ua-parser.js",
+  "main": "ua-parser",
   "repositories": [
     {
-      "type"    : "git",
+      "type": "git",
-      "url"     : "https://github.com/faisalman/ua-parser-js.git"
+      "url": "https://github.com/faisalman/ua-parser-js.git"
     }
   ],
-  "licenses"    : [
+  "repository" :
   {
-      "type"    : "GPLv2",
+    "type": "git",
-      "url"     : "http://www.gnu.org/licenses/gpl-2.0.html" 
+    "url": "https://github.com/faisalman/ua-parser-js.git"
+  },
+  "licenses": [
+    {
+      "type": "GPLv2",
+      "url": "http://www.gnu.org/licenses/gpl-2.0.html"
     },
     {
-      "type"    : "MIT",
+      "type": "MIT",
-      "url"     : "http://www.opensource.org/licenses/mit-license.php" 
+      "url": "http://www.opensource.org/licenses/mit-license.php"
     }
-  ]
+  ],
+  "engines": {
+    "node": "*"
+  },
+  "directories": {
+    "lib": "."
+  },
+  "files": [
+    ""
+  ],
+  "repository": "git://github.com/faisalman/ua-parser-js.git"
 }

readme.md

@@ -1,21 +1,24 @@
-# UA-Parser.js
+# UA-Parser.JS
 
-JavaScript-based user-agent parser
+Lightweight JavaScript-based User-Agent string parser
 
 * Author    : Faisalman <<fyzlman@gmail.com>>
 * Home      : http://faisalman.github.com/ua-parser-js
 * Source    : https://github.com/faisalman/ua-parser-js
-* License	: GPLv2
+* License   : GPLv2 & MIT
 
 ## Features
 
-Get detailed type and version of web browser, layout engine, and operating system.
+Extract detailed type of web browser, layout engine, operating system, and device purely from user-agent string.
 
 ## Methods
 
-* `getBrowser([uastring])`
+* `getBrowser()`
-* `getEngine([uastring])`
+* `getDevice()`
-* `getOS([uastring])`
+* `getEngine()`
+* `getOS()`
+* `getResult()`
+* `getUA()`
 * `setUA(uastring)`
 
 ## Example
@@ -24,9 +27,10 @@ Get detailed type and version of web browser, layout engine, and operating syste
 <script type="text/javascript" src="ua-parser.js"></script>
 <script type="text/javascript">
     
-    var p = new UAParser();     // if no string given as parameter, by default it takes ua string from current browser's window.navigator
+	var parser = new UAParser();
 	
-    console.log(p.result);
+    // by default it takes ua string from current browser's window.navigator.userAgent
+    console.log(parser.getResult());
     /*
         /// this will print an object structured like this:
         {
@@ -42,30 +46,52 @@ Get detailed type and version of web browser, layout engine, and operating syste
             os: {
                 name: "",
                 version: ""
+            },
+            device: {
+                name: "",
+                version: ""
             }
         }
     */
 
     // let's test a custom user-agent string as an example
-    p.setUA("Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/535.2 (KHTML, like Gecko) Ubuntu/11.10 Chromium/15.0.874.106 Chrome/15.0.874.106 Safari/535.2");
+    var uastr = "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/535.2 (KHTML, like Gecko) Ubuntu/11.10 Chromium/15.0.874.106 Chrome/15.0.874.106 Safari/535.2";
+    parser.setUA(uastr);
     
-    console.log(p.result.browser);  // {name: "Chromium", major: "15", version: "15.0.874.106"}
+    console.log(parser.getResult().browser);    // {name: "Chromium", major: "15", version: "15.0.874.106"}
-    console.log(p.result.engine);   // {name: "AppleWebKit", version: "535.2"}
+    console.log(parser.getResult().engine);     // {name: "AppleWebKit", version: "535.2"}
-    console.log(p.result.os);       // {name: "Ubuntu", version: "11.10"}
+    console.log(parser.getResult().os);         // {name: "Ubuntu", version: "11.10"}
     
+    // let's take another test please
+    console.log(parser.setUA("Mozilla/5.0 (compatible; Konqueror/4.1; OpenBSD) KHTML/4.1.4 (like Gecko)").getOS().name); // "OpenBSD"
 </script>
 ```
 
+## Using node.js
+
+```js
+var UAParser = require('ua-parser');
+var parser = new UAParser();
+var ua1 = 'Mozilla/5.0 (PlayBook; U; RIM Tablet OS 1.0.0; en-US) AppleWebKit/534.11 (KHTML, like Gecko) Version/7.1.0.7 Safari/534.11';
+var ua2 = 'Midori/0.2 (X11; Linux; U; cs-cz) WebKit/531.2+';
+
+console.log(parser.setUA(ua1).getDevice().name);    // "PlayBook"
+console.log(parser.getOS())                         // {name: "RIM Tablet OS", version: "1.0.0"}
+console.log(parser.getOS(ua2))                      // {name: "Linux", version: undefined}
+console.log(parser.getOS())                         // {name: "RIM Tablet OS", version: "1.0.0"}
+console.log(parser.getEngine().name);               // "AppleWebKit"
+```
+
 ## License
 
 Copyright © 2012 Faisalman <<fyzlman@gmail.com>>
 
-This program is free software; you can redistribute it and/or
+Permission is hereby granted, free of charge, to any person obtaining a copy of 
-modify it under the terms of the GNU General Public License
+this software and associated documentation files (the "Software"), to deal in 
-as published by the Free Software Foundation; either version 2
+the Software without restriction, including without limitation the rights to use, 
-of the License, or (at your option) any later version.
+copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the 
+Software, and to permit persons to whom the Software is furnished to do so, 
+subject to the following conditions:
 
-This program is distributed in the hope that it will be useful,
+The above copyright notice and this permission notice shall be included in all 
-but WITHOUT ANY WARRANTY; without even the implied warranty of
+copies or substantial portions of the Software.
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.

ua-parser.js

@@ -1,85 +1,96 @@
-// UA-Parser.js v0.2.0
+// UA-Parser.JS v0.3.4
-// Lightweight JavaScript-based user-agent parser
+// Lightweight JavaScript-based User-Agent string parser
 // https://github.com/faisalman/ua-parser-js
 //
 // Copyright © 2012 Faisalman
-// Licensed under GPLv2
+// Dual licensed under GPLv2 & MIT
 
-function UAParser (uastring) {
+(function (undefined) {
 
-    var ua = uastring || window.navigator.userAgent;
+    var regexMapper = function (ua, args) {
         
-    // regexp mapper
+        var result = {}, i, j, k, l, m;
-    var regxMap = function (ua) {
+        
-        var result;
+        // loop through all regexes maps
-        var i, j, k, l;
         for (i = 1; i < arguments.length; i += 2) {
-            var regex = arguments[i];
+        
-            var props = arguments[i + 1];
+            var regex = arguments[i],       // even sequence (1,3,5,..)
-            var isMatchFound = false;
+                props = arguments[i + 1];   // odd sequence (2,4,6,..)
-            for (j = 0; j < regex.length; j++) {
+            
-                var match = regex[j].exec(ua);
+            // build object barebones
-                //console.log(match);
-                if (!!match) {
-                    result = {};
-                    l = 1;
             for (k = 0; k < props.length; k++) {
-                        if (typeof props[k] === 'object' && props[k].length === 2) {
-                            result[props[k][0]] = props[k][1];
-                            l -= 1;
-                        } else if (typeof props[k] === 'object' && props[k].length === 3) {
-                            result[props[k][0]] = (!!match[k + l]) ? match[k + l].replace(props[k][1], props[k][2]) : undefined;
-                        } else {
-                            result[props[k]] = (!!match[k + l]) ? match[k + l] : undefined;
-                        }
-                    }
-                    isMatchFound = true;
-                    break;
-                }
-            }
-            if (!isMatchFound) {
-                result = {};
-                for (k in props) {
-                    if (props.hasOwnProperty(k)) {
                 if (typeof props[k] == 'object') {
                     result[props[k][0]] = undefined;
                 } else {
                     result[props[k]] = undefined;
                 }
             }
-                }
+            
+            // try matching uastring with regexes
+            for (j = 0; j < regex.length; j++) {
+                l = regex[j].exec(ua);
+                if (!!l) {
+                    for (k = 0; k < props.length; k++) {
+                        m = l[k + 1];
+                        if (typeof props[k] === 'object' && props[k].length === 2) {
+                            result[props[k][0]] = props[k][1];
+                        } else if (typeof props[k] === 'object' && props[k].length === 3) {
+                            result[props[k][0]] = m ? m.replace(props[k][1], props[k][2]) : undefined;
                         } else {
-                return result;
+                            result[props[k]] = m ? m : undefined;
                         }
                     }
+                    break;
+                }
+            }
+            
+            if(!!l) break; // break the loop immediately if match found
+        }
         return result;
     };
 
-    var mapper = {
+    var maps = {
+    
+        check : function(str, map){
+            for (var i in map){
+                if (map.hasOwnProperty(i)) {
+                    if (typeof map[i] === 'object' && map[i].length > 0) {
+                        for (var j = 0; j < map[i].length; j++) {
+                            if (str.toLowerCase().indexOf(map[i][j]) !== -1) {
+                                return i;
+                            }
+                        }
+                    } else if (str.toLowerCase().indexOf(map[i]) !== -1) {
+                        return i;
+                    }
+                }
+            }
+            return str;
+        },
+        
         os : {
-            win: function (str, match) {
+            win : function (match, str1) {
-                switch (match.toLowerCase()) {
+                return maps.check(str1, {
-                    case 'nt 5.0':
+                    'ME'        : '4.90',
-                        return '2000';
+                    'NT 3.11'   : 'nt3.51',
-                    case 'nt 5.1':
+                    'NT 4.0'    : 'nt4.0',
-                    case 'nt 5.2':
+                    '2000'      : 'nt 5.0',
-                        return 'XP';
+                    'XP'        : ['nt 5.1', 'nt 5.2'],
-                    case 'nt 6.0':
+                    'Vista'     : 'nt 6.0',
-                        return 'Vista';
+                    '7'         : 'nt 6.1',
-                    case 'nt 6.1':
+                    '8'         : 'nt 6.2'
-                        return '7';
+                });
-                    case 'nt 6.2':
-                        return '8';
-                    default:
-                        return match;
-                };
             }
         }
     };
 
-    this.getBrowser = function (uastring) {
+    var UAParser = function UAParser (uastring) {
 
-        return regxMap(uastring || ua, [
+        var ua = uastring || (typeof window !== 'undefined' ? window.navigator.userAgent : "");
+
+        this.getBrowser = function () {
+
+            return regexMapper(ua, [
 
                 // Mixed
                 /(kindle)\/((\d+)?[\w\.]+)/i,                                       // Kindle
@@ -88,23 +99,26 @@ function UAParser (uastring) {
                 // Presto based
                 /(opera\smini)\/((\d+)?[\w\.-]+)/i,                                 // Opera Mini
                 /(opera\smobi)\/((\d+)?[\w\.-]+)/i,                                 // Opera Mobile
-            /(opera).*\/((\d+)?[\w\.]+)/i,                                      // Opera
+                /(opera).+version\/((\d+)?[\w\.]+)/i,                               // Opera
+                /(opera)[\/\s]+((\d+)?[\w\.]+)/i,
                 
                 // Trident based
                 /(avant\sbrowser|iemobile|slimbrowser)[\/\s]?((\d+)?[\w\.]*)/i,     // Avant/IEMobile/SlimBrowser
                 /ms(ie)\s((\d+)?[\w\.]+)/i,                                         // Internet Explorer
 
                 // Webkit/KHTML based
-            /(chromium|flock|rockmelt|midori|epiphany)\/((\d+)?[\w\.]+)/i,      // Chromium/Flock/RockMelt/Midori/Epiphany
+                /(chromium|flock|rockmelt|midori|epiphany|silk)\/((\d+)?[\w\.]+)/i, // Chromium/Flock/RockMelt/Midori/Epiphany
-            /(chrome|omniweb|arora|dolfin)\/((\d+)?[\w\.]+)/i,                  // Chrome/OmniWeb/Arora/Dolphin
+                /(chrome|omniweb|arora|dolfin|[tizenaok]{5}\s?browser)\/((\d+)?[\w\.]+)/i,
+                                                                                    // Chrome/OmniWeb/Arora/Dolphin/Tizen/Nokia
                 ], ['name', 'version', 'major'], [
-            /android.+crmo\/((\d+)?[\w\.]+)/i,                                  // Chrome for Android
+                /(?:android.+(crmo|crios))\/((\d+)?[\w\.]+)/i,                      // Chrome for Android/iOS
                 ], [['name', 'Chrome'], 'version', 'major'], [
                 /(mobile\ssafari|safari|konqueror)\/((\d+)?[\w\.]+)/i,              // Safari/Konqueror
                 /(applewebkit|khtml)\/((\d+)?[\w\.]+)/i,
 
                 // Gecko based
-            /(iceweasel|camino|fennec|maemo|minimo)[\/\s]?((\d+)?[\w\.\+]+)/i,  // Iceweasel/Camino/Fennec/Maemo/Minimo
+                /(iceweasel|camino|fennec|maemo\sbrowser|minimo)[\/\s]?((\d+)?[\w\.\+]+)/i,  
+                                                                                    // Iceweasel/Camino/Fennec/Maemo/Minimo
                 /(firefox|seamonkey|netscape|navigator|k-meleon|icecat|iceape)\/((\d+)?[\w\.]+)/i,
                                                                                     // Firefox/SeaMonkey/Netscape/K-Meleon/IceCat/IceApe
                 /(mozilla)\/([\w\.]+).+rv\:.+gecko\/\d+/i,                          // Mozilla
@@ -114,9 +128,9 @@ function UAParser (uastring) {
                 ], ['name', 'version', 'major']);  
         };
 
-    this.getEngine = function (uastring) {
+        this.getEngine = function () {
 
-        return regxMap(uastring || ua, [
+            return regexMapper(ua, [
 
                 /(presto)\/([\w\.]+)/i,                                             // Presto
                 /([aple]*webkit|trident)\/([\w\.]+)/i,                              // Webkit/Trident
@@ -127,18 +141,21 @@ function UAParser (uastring) {
                 ], ['version', 'name']);
         };
 
-    this.getOS = function (uastring) { 
+        this.getOS = function () { 
 
-        return regxMap(uastring || ua, [
+            return regexMapper(ua, [
 
                 // Windows based
-            /(windows\sphone\sos|windows)\s+([\w\.\s]+)*/i,                     // Windows
+                /(windows\sphone\sos|windows)\s?([nt\d\.\s]+\d)/i                   // Windows
-            ], ['name', ['version', /(nt\s[\d\.]+)/gi, mapper.os.win]], [
+                ], ['name', ['version', /(.+)/gi, maps.os.win]], [
+                /(win(?=3|9|n)|win\s9x\s)([nt\d\.]+)/i
+                ], [['name', 'Windows'], ['version', /(.+)/gi, maps.os.win]], [
                 
                 // Mobile/Embedded OS
                 /(blackberry).+version\/([\w\.]+)/i,                                // Blackberry
-            /(android|symbianos|symbos|webos|palm\os|qnx|bada|rim\stablet\sos)[\/\s-]?([\w\.]+)*/i,
+                /(tizen)\/([\w\.]+)/i,                                              // Tizen
-                                                                                // Android/Symbian/WebOS/Palm/QNX/Bada/RIM
+                /(android|symbianos|symbos|webos|palm\os|qnx|bada|rim\stablet\sos|meego)[\/\s-]?([\w\.]+)*/i,
+                                                                                    // Android/Symbian/WebOS/Palm/QNX/Bada/RIM/MeeGo
                 /(nintendo|playstation)\s([wids3portable]+)/i,                      // Nintendo/Playstation
 
                 // GNU/Linux based
@@ -149,11 +166,11 @@ function UAParser (uastring) {
                 /(gnu|linux)\s?([\w\.]+)*/i                                         // Other GNU/Linux
                 ], ['name', 'version'], [
 
-            /cros\s([\w\.\s]+)/i                                                // Chromium OS
+                /(cros)\s([\w\.\s]+\d)/i                                            // Chromium OS
                 ], [['name', 'Chromium OS'], 'version'],[
 
                 // Solaris
-            /sunos\s?([\w\.\s]+)*/i                                             // Solaris
+                /(sunos)\s?([\w\.\s]+\d)*/i                                         // Solaris
                 ], [['name', 'Solaris'], 'version'], [
 
                 // BSD based
@@ -163,22 +180,24 @@ function UAParser (uastring) {
                 /(ip[honead]+).*os\s*([\w]+)*\slike\smac/i                          // iOS
                 ], [['name', /.+/g, 'iOS'], ['version', /_/g, '.']], [
 
-            /(mac\sos)\sx\s([\w\s\.]+)/i,                                       // Mac OS
+                /(mac\sos\sx)\s([\w\s\.]+\w)/i,                                     // Mac OS
                 ], ['name', ['version', /_/g, '.']], [
 
                 // Other
-            /(macintosh|unix|minix|beos)[\/\s]?()*/i
+                /(haiku)\s(\w+)/i,                                                  // Haiku
+                /(macintosh|unix|minix|beos)[\/\s]?()*/i                            // UNIX/Minix/BeOS
                 ], ['name', 'version']);
         };
 
-    this.getDevice = function (uastring) { 
+        this.getDevice = function () { 
 
-        return regxMap(uastring || ua, [
+            return regexMapper(ua, [
 
                 /\((ip[honead]+|playbook);/i,                                       // iPod/iPhone/iPad/PlayBook
                 /(blackberry)[\s-]?(\w+)/i,                                         // BlackBerry
-            /(blackberry|benq|nokia|palm(?=\-)|sonyericsson)[\s-]?([\w-]+)*/i,  // BenQ/Nokia/Palm/Sony-Ericsson
+                /(blackberry|benq|palm(?=\-)|sonyericsson|acer|asus|dell|nexus|zte)[\s_-]?([\w-]+)*/i,  
-            /(hp)\s([\w\s]+)/i,                                                 // HP iPAQ
+                                                                                    // BenQ/Palm/Sony-Ericsson/Acer/Asus/Dell/Nexus/ZTE
+                /(hp)\s([\w\s]+\w)/i,                                               // HP iPAQ
                 /(hp).+(touchpad)/i,                                                // HP TouchPad
                 /(kindle)\/([\w\.]+)/i,                                             // Kindle
                 /(lg)[e;\s-]+(\w+)*/i,                                              // LG
@@ -189,22 +208,32 @@ function UAParser (uastring) {
                 /(zte)-([\w]+)*/i
                 ], ['name', ['version', /_/g, ' ']], [
                             
-            /\s(milestone|mz601|droid[2x]?|xoom)[globa\s]*\sbuild\//i,          // Motorola
+                /\s((milestone|mz601|droid[2x]?|xoom))[globa\s]*\sbuild\//i,        // Motorola
-            /mot[\s-]?(\w+)*/i
+                /(mot)[\s-]?(\w+)*/i
                 ], [['name', 'Motorola'], 'version'], [
                 
-            /(s[cgp]h-\w+|gt-\w+|galaxy\snexus)/i,                              // Samsung
+                /((s[cgp]h-\w+|gt-\w+|galaxy\snexus))/i,                            // Samsung
-            /sam[sung]*[\s-]*(\w+-?[\w-]*)*/i,
+                /(sam[sung]*)[\s-]*(\w+-?[\w-]*)*/i,
-            /sec-(sgh\w+)/i
+                /sec-((sgh\w+))/i
                 ], [['name', 'Samsung'], 'version'], [
                 
-            /sie-(\w+)*/i                                                       // Siemens
+                /((transfo[prime\s]{4,10}\s\w+|(?:android.*)eeepc))/i               // Asus
-            ], [['name', 'Siemens'], 'version']);
+                ], [['name', 'Asus'], 'version'], [
+
+                /(sie)-(\w+)*/i                                                     // Siemens
+                ], [['name', 'Siemens'], 'version'], [
+                
+                /(maemo|nokia).*(n900|lumia\s\d+)/i,                                // Nokia
+                /(nokia)[\s_-]?([\w-]+)*/i
+                ], [['name', 'Nokia'], 'version']);
         };
         
-    this.setUA = function (uastring) {
+        this.getUA = function() {
-        ua = uastring || ua;
+            return ua;
-        return this.result = {
+        };
+
+        this.getResult = function() {
+            return {
                 browser : this.getBrowser(),
                 engine  : this.getEngine(),
                 os      : this.getOS(),
@@ -212,5 +241,21 @@ function UAParser (uastring) {
             };
         };
 
+        this.setUA = function (uastring) {
+            ua = uastring;
+            return this;
+        };
+
         this.setUA(ua);
-};
+    };
+        
+    // check whether script is running inside node.js export as module
+    if (typeof exports !== 'undefined' && this.toString() !== '[object DOMWindow]') {
+        if (typeof module !== 'undefined' && module.exports) {
+            exports = module.exports = UAParser;
+        }
+        exports.UAParser = UAParser;
+    } else {
+        this['UAParser'] = UAParser;
+    }
+})();