Merge pull request #77 from kaimallea/various-fixes

Various updates
kaimallea · Nov 12, 2018 · 1aaae36 · 1aaae36
2 parents df39aec + 1b14e02
commit 1aaae36
Show file tree

Hide file tree

Showing 24 changed files with 6,767 additions and 1,385 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,2 @@
-node_modules/
-_SpecRunner.html
-.grunt
+node_modules
+dist
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,6 @@
+{
+  "trailingComma": "none",
+  "tabWidth": 2,
+  "semi": true,
+  "singleQuote": true
+}
diff --git a/.travis.yml b/.travis.yml
@@ -1,7 +1,6 @@
 language: node_js
 node_js:
-  - "0.11"
+  - "10.13"
 before_script:
-  - npm install -g grunt-cli
-  - npm install grunt grunt-contrib-jasmine grunt-contrib-jshint grunt-contrib-uglify
-script: grunt -v
+  - npm install
+script: npm test
diff --git a/Gruntfile.js b/Gruntfile.js
diff --git a/README.md b/README.md
@@ -1,6 +1,5 @@
 [![Build Status](https://travis-ci.org/kaimallea/isMobile.png)](https://travis-ci.org/kaimallea/isMobile)
 [![Node dependencies status](https://david-dm.org/kaimallea/isMobile.png)](https://david-dm.org/kaimallea/isMobile)
-![Bower version](https://img.shields.io/bower/v/isMobile.svg)
 
 # isMobile
 
@@ -22,112 +21,127 @@ I couldn't do detection on the back-end, because the entire site was generated a
 
 So I resorted to User-Agent (UA) sniffing.
 
-I tried to keep the script small (**currently ~1.4k bytes, minified**) and simple, because it would need to execute in the `<head>`, which is generally a bad idea, since JS blocks the downloading and rendering of all assets while it parses and executes. In the case of mobile redirection, I don't mind so much, because I want to start the redirect as soon as possible, before the device has a chance to start downloading and rendering other stuff. For non-mobile platforms, the script should execute fast, so the browser can quickly get back to downloading and rendering.
+I tried to keep the script small (**currently ~1.5k bytes, minified**) and simple, because it would need to execute in the `<head>`, which is generally a bad idea, since JS blocks the downloading and rendering of all assets while it parses and executes. In the case of mobile redirection, I don't mind so much, because I want to start the redirect as soon as possible, before the device has a chance to start downloading and rendering other stuff. For non-mobile platforms, the script should execute fast, so the browser can quickly get back to downloading and rendering.
 
-## How it works
+## How it works in the browser
 
 isMobile runs quickly during initial page load to detect mobile devices; it then creates a JavaScript object with the results.
 
+## How it works in Node.js
+
+You import and call the `isMobile` function, passing it a user agent string; it then returns a JavaScript object with the results.
+
 ## Devices detected by isMobile
 
-The following properties of the global `isMobile` object will either be `true` or `false`
+In a browser, the following properties of the global `isMobile` object will either be `true` or `false`. In Node, `isMobile` will be whatever you named the variable.
 
 ### Apple devices
 
-* `isMobile.apple.phone`
-* `isMobile.apple.ipod`
-* `isMobile.apple.tablet`
-* `isMobile.apple.device` (any mobile Apple device)
+- `isMobile.apple.phone`
+- `isMobile.apple.ipod`
+- `isMobile.apple.tablet`
+- `isMobile.apple.device` (any mobile Apple device)
 
 ### Android devices
 
-* `isMobile.android.phone`
-* `isMobile.android.tablet`
-* `isMobile.android.device` (any mobile Android device)
+- `isMobile.android.phone`
+- `isMobile.android.tablet`
+- `isMobile.android.device` (any mobile Android device)
 
 ### Amazon Silk devices (also passes Android checks)
 
-* `isMobile.amazon.phone`
-* `isMobile.amazon.tablet`
-* `isMobile.amazon.device` (any mobile Amazon Silk device)
+- `isMobile.amazon.phone`
+- `isMobile.amazon.tablet`
+- `isMobile.amazon.device` (any mobile Amazon Silk device)
 
 ### Windows devices
 
-* `isMobile.windows.phone`
-* `isMobile.windows.tablet`
-* `isMobile.windows.device` (any mobile Windows device)
-
-### Specific seven inch devices
-
-* `isMobile.seven_inch`
-	* `true` if the device is one of the following 7" devices:
-		- Nexus 7
-		- Kindle Fire
-		- Nook Tablet 7 inch
-		- Galaxy Tab 7 inch
+- `isMobile.windows.phone`
+- `isMobile.windows.tablet`
+- `isMobile.windows.device` (any mobile Windows device)
 
 ### "Other" devices
 
-* `isMobile.other.blackberry_10`
-* `isMobile.other.blackberry`
-* `isMobile.other.opera` (Opera Mini)
-* `isMobile.other.firefox`
-* `isMobile.other.chrome`
-* `isMobile.other.device` (any "Other" device)
+- `isMobile.other.blackberry_10`
+- `isMobile.other.blackberry`
+- `isMobile.other.opera` (Opera Mini)
+- `isMobile.other.firefox`
+- `isMobile.other.chrome`
+- `isMobile.other.device` (any "Other" device)
 
 ### Aggregate Groupings
 
-* `isMobile.any` - any device matched
-* `isMobile.phone` - any device in the 'phone' groups above
-* `isMobile.tablet` - any device in the 'tablet' groups above
-
+- `isMobile.any` - any device matched
+- `isMobile.phone` - any device in the 'phone' groups above
+- `isMobile.tablet` - any device in the 'tablet' groups above
 
 ## Example Usage
 
-I include the minified version of the script, inline, and at the top of the `<head>`. Cellular connections tend to suck, so it would be wasteful overhead to open another connection, just to download ~1.8kb of JS:
-
+I include the minified version of the script, inline, and at the top of the `<head>`. Cellular connections tend to suck, so it would be wasteful overhead to open another connection, just to download ~1.5kb of JS:
 
+<!-- prettier-ignore -->
 ```html
 <!DOCTYPE html>
 <html lang="en">
-<head>
-    <meta charset="utf-8">
+  <head>
+    <meta charset="utf-8" />
     <script>
-        // Minified version of isMobile included in the HTML since it's small
-        !function(a){var b=/iPhone/i,c=/iPod/i,d=/iPad/i,e=/(?=.*\bAndroid\b)(?=.*\bMobile\b)/i,f=/Android/i,g=/(?=.*\bAndroid\b)(?=.*\bSD4930UR\b)/i,h=/(?=.*\bAndroid\b)(?=.*\b(?:KFOT|KFTT|KFJWI|KFJWA|KFSOWI|KFTHWI|KFTHWA|KFAPWI|KFAPWA|KFARWI|KFASWI|KFSAWI|KFSAWA)\b)/i,i=/IEMobile/i,j=/(?=.*\bWindows\b)(?=.*\bARM\b)/i,k=/BlackBerry/i,l=/BB10/i,m=/Opera Mini/i,n=/(CriOS|Chrome)(?=.*\bMobile\b)/i,o=/(?=.*\bFirefox\b)(?=.*\bMobile\b)/i,p=new RegExp("(?:Nexus 7|BNTV250|Kindle Fire|Silk|GT-P1000)","i"),q=function(a,b){return a.test(b)},r=function(a){var r=a||navigator.userAgent,s=r.split("[FBAN");return"undefined"!=typeof s[1]&&(r=s[0]),s=r.split("Twitter"),"undefined"!=typeof s[1]&&(r=s[0]),this.apple={phone:q(b,r),ipod:q(c,r),tablet:!q(b,r)&&q(d,r),device:q(b,r)||q(c,r)||q(d,r)},this.amazon={phone:q(g,r),tablet:!q(g,r)&&q(h,r),device:q(g,r)||q(h,r)},this.android={phone:q(g,r)||q(e,r),tablet:!q(g,r)&&!q(e,r)&&(q(h,r)||q(f,r)),device:q(g,r)||q(h,r)||q(e,r)||q(f,r)},this.windows={phone:q(i,r),tablet:q(j,r),device:q(i,r)||q(j,r)},this.other={blackberry:q(k,r),blackberry10:q(l,r),opera:q(m,r),firefox:q(o,r),chrome:q(n,r),device:q(k,r)||q(l,r)||q(m,r)||q(o,r)||q(n,r)},this.seven_inch=q(p,r),this.any=this.apple.device||this.android.device||this.windows.device||this.other.device||this.seven_inch,this.phone=this.apple.phone||this.android.phone||this.windows.phone,this.tablet=this.apple.tablet||this.android.tablet||this.windows.tablet,"undefined"==typeof window?this:void 0},s=function(){var a=new r;return a.Class=r,a};"undefined"!=typeof module&&module.exports&&"undefined"==typeof window?module.exports=r:"undefined"!=typeof module&&module.exports&&"undefined"!=typeof window?module.exports=s():"function"==typeof define&&define.amd?define("isMobile",[],a.isMobile=s()):a.isMobile=s()}(this);
-
-
-        // My own arbitrary use of isMobile, as an example
-        (function () {
-            var MOBILE_SITE = '/mobile/index.html', // site to redirect to
-                NO_REDIRECT = 'noredirect'; // cookie to prevent redirect
-
-            // I only want to redirect iPhones, Android phones and a handful of 7" devices
-            if (isMobile.apple.phone || isMobile.android.phone || isMobile.seven_inch) {
-
-                // Only redirect if the user didn't previously choose
-                // to explicitly view the full site. This is validated
-                // by checking if a "noredirect" cookie exists
-                if ( document.cookie.indexOf(NO_REDIRECT) === -1 ) {
-                    document.location = MOBILE_SITE;
-                }
-            }
-        })();
+      // Minified version of isMobile included in the HTML since it's small
+      !function(e){var n=/iPhone/i,t=/iPod/i,r=/iPad/i,a=/\bAndroid(?:.+)Mobile\b/i,p=/Android/i,l=/\bAndroid(?:.+)SD4930UR\b/i,b=/\bAndroid(?:.+)(?:KF[A-Z]{2,4})\b/i,f=/Windows Phone/i,u=/\bWindows(?:.+)ARM\b/i,c=/BlackBerry/i,s=/BB10/i,v=/Opera Mini/i,h=/\b(CriOS|Chrome)(?:.+)Mobile/i,w=/\Mobile(?:.+)Firefox\b/i;function m(e,i){return e.test(i)}function i(e){var i=e||("undefined"!=typeof navigator?navigator.userAgent:""),o=i.split("[FBAN");void 0!==o[1]&&(i=o[0]),void 0!==(o=i.split("Twitter"))[1]&&(i=o[0]);var d={apple:{phone:m(n,i),ipod:m(t,i),tablet:!m(n,i)&&m(r,i),device:m(n,i)||m(t,i)||m(r,i)},amazon:{phone:m(l,i),tablet:!m(l,i)&&m(b,i),device:m(l,i)||m(b,i)},android:{phone:m(l,i)||m(a,i),tablet:!m(l,i)&&!m(a,i)&&(m(b,i)||m(p,i)),device:m(l,i)||m(b,i)||m(a,i)||m(p,i)},windows:{phone:m(f,i),tablet:m(u,i),device:m(f,i)||m(u,i)},other:{blackberry:m(c,i),blackberry10:m(s,i),opera:m(v,i),firefox:m(w,i),chrome:m(h,i),device:m(c,i)||m(s,i)||m(v,i)||m(w,i)||m(h,i)}};return d.any=d.apple.device||d.android.device||d.windows.device||d.other.device,d.phone=d.apple.phone||d.android.phone||d.windows.phone,d.tablet=d.apple.tablet||d.android.tablet||d.windows.tablet,d}"undefined"!=typeof module&&module.exports&&"undefined"==typeof window?module.exports=i:"undefined"!=typeof module&&module.exports&&"undefined"!=typeof window?module.exports=i():"function"==typeof define&&define.amd?define([],e.isMobile=i()):e.isMobile=i()}(this);
+
+      // My own arbitrary use of isMobile, as an example
+      (function() {
+        var MOBILE_SITE = '/mobile/index.html', // site to redirect to
+          NO_REDIRECT = 'noredirect'; // cookie to prevent redirect
+
+        // I only want to redirect iPhones, Android phones
+        if (isMobile.apple.phone || isMobile.android.phone) {
+          // Only redirect if the user didn't previously choose
+          // to explicitly view the full site. This is validated
+          // by checking if a "noredirect" cookie exists
+          if (document.cookie.indexOf(NO_REDIRECT) === -1) {
+            document.location = MOBILE_SITE;
+          }
+        }
+      })();
     </script>
-</head>
-<body>
+  </head>
+  <body>
     <!-- imagine lots of html and content -->
-</body>
+  </body>
 </html>
 ```
 
-### node.js usage
+## Building manually
+
+After checking out the repo, install dependencies:
+
+```shell
+npm install
+```
 
-#####Installation
-`npm install ismobilejs`
+Then build a minified, distributable JS file:
 
-#####Usage
+```shell
+npm run build
 ```
-var isMobile = require('ismobilejs');
-console.log(isMobile(req.headers['user-agent']).any);
+
+It will be output to `./dist/isMobile.min.js`.
+
+You can then use it with a `<script>` tag, bundle it with something else or follow the suggestion in the example above and include it inline to save opening another connection.
+
+## Node.js Usage
+
+### Installation
+
+```shell
+npm install ismobilejs
+```
+
+### Usage
+
+```js
+const isMobile = require('ismobilejs');
+const userAgent = req.headers['user-agent'];
+console.log(isMobile(userAgent).any);
 ```