Reorganize the structure of the code

package.json

@@ -1,7 +1,7 @@
 {
-  "title": "UA-Parser.js",
+  "title": "UA-Parser.JS",
   "name": "ua-parser-js",
-  "version": "0.3.2",
+  "version": "0.4.0",
   "author": "Faisal Salman <fyzlman@gmail.com> (http://faisalman.com)",
   "description": "Lightweight JavaScript-based user-agent string parser",
   "keywords": [

readme.md

@@ -1,6 +1,6 @@
-# UA-Parser.js
+# UA-Parser.JS
 
-Light-weight JavaScript-based all-in-one user-agent parser
+Lightweight JavaScript-based User-Agent string parser
 
 * Author    : Faisalman <<fyzlman@gmail.com>>
 * Home      : http://faisalman.github.com/ua-parser-js
@@ -9,20 +9,18 @@ Light-weight JavaScript-based all-in-one user-agent parser
 
 ## Features
 
-Get detailed type and version of web browser, layout engine, operating system, and device.
+Extract detailed type of web browser, layout engine, operating system, and device purely from user-agent string.
 
 ## Methods
 
-* `getBrowser([uastring])`
-* `getDevice([uastring])`
-* `getEngine([uastring])`
-* `getOS([uastring])`
+* `getBrowser()`
+* `getDevice()`
+* `getEngine()`
+* `getOS()`
+* `getResult()`
+* `getUA()`
 * `setUA(uastring)`
 
-## Properties
-
-* `result`
-
 ## Example
 
 ```html
@@ -31,8 +29,8 @@ Get detailed type and version of web browser, layout engine, operating system, a
     
 	var parser = new UAParser();
 	
-    // by default it takes ua string from current browser's window.navigator
-    console.log(parser.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:
         {
@@ -60,9 +58,9 @@ Get detailed type and version of web browser, layout engine, operating system, a
     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(parser.result.browser);  // {name: "Chromium", major: "15", version: "15.0.874.106"}
-    console.log(parser.result.engine);   // {name: "AppleWebKit", version: "535.2"}
-    console.log(parser.result.os);       // {name: "Ubuntu", version: "11.10"}
+    console.log(parser.getResult().browser);    // {name: "Chromium", major: "15", version: "15.0.874.106"}
+    console.log(parser.getResult().engine);     // {name: "AppleWebKit", version: "535.2"}
+    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"
@@ -74,26 +72,23 @@ Get detailed type and version of web browser, layout engine, operating system, a
 ```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+';
+var uaString    = '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';
 
-parser.setUA(ua1).getDevice().name; // "PlayBook"
-parser.getOS()                      // {name: "RIM Tablet OS", version: "1.0.0"}
-parser.getOS(ua2)                   // {name: "Linux", version: undefined}
-parser.getOS()                      // {name: "RIM Tablet OS", version: "1.0.0"}
-parser.getEngine().name;            // "AppleWebKit"
+console.log(parser.setUA(uaString).getDevice().name);   // "PlayBook"
+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
-modify it under the terms of the GNU General Public License
-as published by the Free Software Foundation; either version 2
-of the License, or (at your option) any later version.
+Permission is hereby granted, free of charge, to any person obtaining a copy of 
+this software and associated documentation files (the "Software"), to deal in 
+the Software without restriction, including without limitation the rights to use, 
+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,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
+The above copyright notice and this permission notice shall be included in all 
+copies or substantial portions of the Software.

ua-parser.js

@@ -1,4 +1,4 @@
-// UA-Parser.js v0.3.2
+// UA-Parser.JS v0.4.0
 // Lightweight JavaScript-based User-Agent string parser
 // https://github.com/faisalman/ua-parser-js
 //
@@ -6,75 +6,98 @@
 // Dual licensed under GPLv2 & MIT
 
 (function (undefined) {
-    var parser = function UAParser (uastring) {
 
-        var ua = uastring || (typeof window !== 'undefined' ? window.navigator.userAgent : "");
+    var mapper = {
     
-        // regexp mapper
-        var regxMap = function (ua) {
-            var result = {}, i, j, k, l;
-            for (i = 1; i < arguments.length; i += 2) {
-                var regex = arguments[i],       // odd sequence (2,4,6,..)
-                    props = arguments[i + 1];   // even sequence (3,5,7,..)
+        regex : function () {
+        
+            var result, i, j, k, l, m, args = arguments;
+            
+            // loop through all regexes maps
+            for (i = 0; i < args.length; i += 2) {
+            
+                var regex = args[i],       // odd sequence (0,2,4,..)
+                    props = args[i + 1];   // even sequence (1,3,5,..)
+                
+                // construct object barebones
+                if (typeof result === 'undefined') {
+                    result = {};
                     for (k = 0; k < props.length; k++) {
-                    if (typeof props[k] == 'object') {
+                        if (typeof props[k] === 'object') {
                             result[props[k][0]] = undefined;
                         } else {
                             result[props[k]] = undefined;
                         }
                     }
+                    if (this.getUA().toString() === '') {
+                        return result;
+                    }
+                }
+                
+                // try matching uastring with regexes
                 for (j = 0; j < regex.length; j++) {
-                    var match = regex[j].exec(ua);
-                    if (!!match) {
-                        l = 1;
+                    l = regex[j].exec(this.getUA());
+                    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];
-                                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;
+                                result[props[k][0]] = m ? m.replace(props[k][1], props[k][2]) : undefined;
                             } else {
-                                result[props[k]] = (!!match[k + l]) ? match[k + l] : undefined;
+                                result[props[k]] = m ? m : undefined;
                             }
                         }
                         break;
                     }
                 }
-                if(!!l) break; // break the loop if match found
+                
+                if(!!l) break; // break the loop immediately if match found
             }
             return result;
-        };
+        },
     
-        var mapper = {
-            check: function(str, map){
-                for (var i = 0; i < map.length; i++) {
-                    if (str.toLowerCase().indexOf(map[i][0]) !== -1) {
-                        return map[i][1];
+        string : 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;
-            },
+        }
+    };
+
+    var maps = {
         os : {
-                win: function (match, str1) {
-                    var map = [
-                        ['4.90',     'ME'],
-                        ['nt3.51',   'NT 3.11'],
-                        ['nt4.0',    'NT 4.0'],
-                        ['nt 5.0',   '2000'],
-                        ['nt 5.1',   'XP'],
-                        ['nt 5.2',   'XP'],
-                        ['nt 6.0',   'Vista'],
-                        ['nt 6.1',   '7'],
-                        ['nt 6.2',   '8'],
-                    ];
-                    return mapper.check(str1, map);
+            windows : {
+                version : function (match, str1) {
+                    return mapper.string(str1, {
+                        'ME'        : '4.90',
+                        'NT 3.11'   : 'nt3.51',
+                        'NT 4.0'    : 'nt4.0',
+                        '2000'      : 'nt 5.0',
+                        'XP'        : ['nt 5.1', 'nt 5.2'],
+                        'Vista'     : 'nt 6.0',
+                        '7'         : 'nt 6.1',
+                        '8'         : 'nt 6.2'
+                    });
+                }
             }
         }
     };
     
-        this.getBrowser = function (uastring) {
+    var regexes = {
 
-            return regxMap(uastring || ua, [
+        browser : [[
 
             // Mixed
             /(kindle)\/((\d+)?[\w\.]+)/i,                                       // Kindle
@@ -83,7 +106,8 @@
             // 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
@@ -94,7 +118,7 @@
             /(chrome|omniweb|arora|dolfin|[tizenaok]{5}\s?browser)\/((\d+)?[\w\.]+)/i,
                                                                                 // Chrome/OmniWeb/Arora/Dolphin/Tizen/Nokia
             ], ['name', 'version', 'major'], [
-                /(?:android.+crmo|crios)\/((\d+)?[\w\.]+)/i,                        // Chrome for Android/iOS
+            /(?: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,
@@ -108,73 +132,10 @@
 
             // Other
             /(lynx|dillo|icab)[\/\s]?((\d+)?[\w\.]+)/i,                         // Lynx/Dillo/iCab
-                ], ['name', 'version', 'major']);  
-        };
+            ], ['name', 'version', 'major']
+        ],
         
-        this.getEngine = function (uastring) {
-
-            return regxMap(uastring || ua, [
-
-                /(presto)\/([\w\.]+)/i,                                             // Presto
-                /([aple]*webkit|trident)\/([\w\.]+)/i,                              // Webkit/Trident
-                /(khtml)\/([\w\.]+)/i                                               // KHTML
-                ], ['name', 'version'], [
-
-                /rv\:([\w\.]+).*(gecko)/i                                           // Gecko
-                ], ['version', 'name']);
-        };
-
-        this.getOS = function (uastring) { 
-
-            return regxMap(uastring || ua, [
-
-                // Windows based
-                /(windows\sphone\sos|windows)\s?([nt\d\.\s]+\d)/i                   // Windows
-                ], ['name', ['version', /(.+)/gi, mapper.os.win]], [
-                /(win(?=3|9|n)|win\s9x\s)([nt\d\.]+)/i
-                ], [['name', 'Windows'], ['version', /(.+)/gi, mapper.os.win]], [
-                
-                // Mobile/Embedded OS
-                /(blackberry).+version\/([\w\.]+)/i,                                // Blackberry
-                /(tizen)\/([\w\.]+)/i,                                              // Tizen
-                /(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
-                /(mint)[\/\s\(]?(\w+)*/i,                                           // Mint
-                /(joli|[kxln]?ubuntu|debian|[open]*suse|gentoo|arch|slackware|fedora|mandriva|centos|pclinuxos|redhat|zenwalk)[\/\s-]?([\w\.-]+)*/i,
-                                                                                    // Joli/Ubuntu/Debian/SUSE/Gentoo/Arch/Slackware
-                                                                                    // Fedora/Mandriva/CentOS/PCLinuxOS/RedHat/Zenwalk
-                /(gnu|linux)\s?([\w\.]+)*/i                                         // Other GNU/Linux
-                ], ['name', 'version'], [
-
-                /cros\s([\w\.\s]+\d)/i                                              // Chromium OS
-                ], [['name', 'Chromium OS'], 'version'],[
-
-                // Solaris
-                /sunos\s?([\w\.\s]+\d)*/i                                           // Solaris
-                ], [['name', 'Solaris'], 'version'], [
-
-                // BSD based
-                /\s(\w*bsd|dragonfly)\s?([\w\.]+)*/i,                               // FreeBSD/NetBSD/OpenBSD/DragonFly
-                ], ['name', 'version'],[
-
-                /(ip[honead]+).*os\s*([\w]+)*\slike\smac/i                          // iOS
-                ], [['name', /.+/g, 'iOS'], ['version', /_/g, '.']], [
-
-                /(mac\sos\sx)\s([\w\s\.]+\w)/i,                                     // Mac OS
-                ], ['name', ['version', /_/g, '.']], [
-
-                // Other
-                /(haiku)\s(\w+)/i,                                                  // Haiku
-                /(macintosh|unix|minix|beos)[\/\s]?()*/i                            // UNIX/Minix/BeOS
-                ], ['name', 'version']);
-        };
-
-        this.getDevice = function (uastring) { 
-
-            return regxMap(uastring || ua, [
+        device : [[
 
             /\((ip[honead]+|playbook);/i,                                       // iPod/iPhone/iPad/PlayBook
             /(blackberry)[\s-]?(\w+)/i,                                         // BlackBerry
@@ -191,24 +152,111 @@
             /(zte)-([\w]+)*/i
             ], ['name', ['version', /_/g, ' ']], [
                         
-                /\s(milestone|mz601|droid[2x]?|xoom)[globa\s]*\sbuild\//i,          // Motorola
-                /mot[\s-]?(\w+)*/i
+            /\s((milestone|mz601|droid[2x]?|xoom))[globa\s]*\sbuild\//i,        // Motorola
+            /(mot)[\s-]?(\w+)*/i
             ], [['name', 'Motorola'], 'version'], [
             
-                /(s[cgp]h-\w+|gt-\w+|galaxy\snexus)/i,                              // Samsung
-                /sam[sung]*[\s-]*(\w+-?[\w-]*)*/i,
-                /sec-(sgh\w+)/i
+            /((s[cgp]h-\w+|gt-\w+|galaxy\snexus))/i,                            // Samsung
+            /(sam[sung]*)[\s-]*(\w+-?[\w-]*)*/i,
+            /sec-((sgh\w+))/i
             ], [['name', 'Samsung'], 'version'], [
             
-                /(transfo[prime\s]{4,10}\s\w+|(?:android).*eeepc)/i                 // Asus
+            /((transfo[prime\s]{4,10}\s\w+))|(?:android.*)((eeepc))/i           // Asus
             ], [['name', 'Asus'], 'version'], [
 
-                /sie-(\w+)*/i                                                       // Siemens
+            /(sie)-(\w+)*/i                                                     // Siemens
             ], [['name', 'Siemens'], 'version'], [
             
-                /(?=maemo|nokia).*(n900|lumia\s\d+)/i,                              // Nokia
-                /nokia[\s_-]?([\w-]+)*/i
-                ], [['name', 'Nokia'], 'version']);
+            /(maemo|nokia).*(n900|lumia\s\d+)/i,                                // Nokia
+            /(nokia)[\s_-]?([\w-]+)*/i
+            ], [['name', 'Nokia'], 'version']            
+        ],
+        
+        engine : [[
+
+            /(presto)\/([\w\.]+)/i,                                             // Presto
+            /([aple]*webkit|trident)\/([\w\.]+)/i,                              // Webkit/Trident
+            /(khtml)\/([\w\.]+)/i                                               // KHTML
+            ], ['name', 'version'], [
+
+            /rv\:([\w\.]+).*(gecko)/i                                           // Gecko
+            ], ['version', 'name']            
+        ],
+        
+        os : [[
+
+            // Windows based
+            /(windows\sphone\sos|windows)\s?([nt\d\.\s]+\d)/i                   // Windows
+            ], ['name', ['version', /(.+)/gi, maps.os.windows.version]], [
+            /(win(?=3|9|n)|win\s9x\s)([nt\d\.]+)/i
+            ], [['name', 'Windows'], ['version', /(.+)/gi, maps.os.windows.version]], [
+            
+            // Mobile/Embedded OS
+            /(blackberry).+version\/([\w\.]+)/i,                                // Blackberry
+            /(tizen)\/([\w\.]+)/i,                                              // Tizen
+            /(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
+            /(mint)[\/\s\(]?(\w+)*/i,                                           // Mint
+            /(joli|[kxln]?ubuntu|debian|[open]*suse|gentoo|arch|slackware|fedora|mandriva|centos|pclinuxos|redhat|zenwalk)[\/\s-]?([\w\.-]+)*/i,
+                                                                                // Joli/Ubuntu/Debian/SUSE/Gentoo/Arch/Slackware
+                                                                                // Fedora/Mandriva/CentOS/PCLinuxOS/RedHat/Zenwalk
+            /(gnu|linux)\s?([\w\.]+)*/i                                         // Other GNU/Linux
+            ], ['name', 'version'], [
+
+            /(cros)\s([\w\.\s]+\d)/i                                            // Chromium OS
+            ], [['name', 'Chromium OS'], 'version'],[
+
+            // Solaris
+            /(sunos)\s?([\w\.\s]+\d)*/i                                         // Solaris
+            ], [['name', 'Solaris'], 'version'], [
+
+            // BSD based
+            /\s(\w*bsd|dragonfly)\s?([\w\.]+)*/i,                               // FreeBSD/NetBSD/OpenBSD/DragonFly
+            ], ['name', 'version'],[
+
+            /(ip[honead]+).*os\s*([\w]+)*\slike\smac/i                          // iOS
+            ], [['name', /.+/g, 'iOS'], ['version', /_/g, '.']], [
+
+            /(mac\sos\sx)\s([\w\s\.]+\w)/i,                                     // Mac OS
+            ], ['name', ['version', /_/g, '.']], [
+
+            // Other
+            /(haiku)\s(\w+)/i,                                                  // Haiku
+            /(macintosh|unix|minix|beos)[\/\s]?()*/i                            // UNIX/Minix/BeOS
+            ], ['name', 'version']            
+        ]
+    };
+
+    var UAParser = function UAParser (uastring) {
+
+        var ua = uastring || (typeof window !== 'undefined' ? window.navigator.userAgent : "");
+
+        this.getBrowser = function () {
+            return mapper.regex.apply(this, regexes.browser);  
+        };
+
+        this.getDevice = function () {
+            return mapper.regex.apply(this, regexes.device);
+        };
+
+        this.getEngine = function () {
+            return mapper.regex.apply(this, regexes.engine);
+        };
+
+        this.getOS = function () {
+            return mapper.regex.apply(this, regexes.os);
+        };
+
+        this.getResult = function() {
+            return {
+                browser : this.getBrowser(),
+                engine  : this.getEngine(),
+                os      : this.getOS(),
+                device  : this.getDevice()
+            };
         };
         
         this.getUA = function() {
@@ -217,12 +265,6 @@
 
         this.setUA = function (uastring) {
             ua = uastring;
-            this.result = {
-                browser : this.getBrowser(),
-                engine  : this.getEngine(),
-                os      : this.getOS(),
-                device  : this.getDevice()
-            };
             return this;
         };
 
@@ -232,10 +274,10 @@
     // 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 = parser;
+            exports = module.exports = UAParser;
         }
-        exports.UAParser = parser;
+        exports.UAParser = UAParser;
     } else {
-        this['UAParser'] = parser;
+        this['UAParser'] = UAParser;
     }
 })();