visibilityjs 0.6.2 → 1.0.0

data/ChangeLog

@@ -1,3 +1,7 @@
+== 1.0.0 (Discoverer 2, stable)
+* Remove jQuery.Chrono integration.
+* Remove outdated Firefox prefix.
+
 == 0.6.2 (Pioneer 4, american sun)
 * Decrease files size (by compressible code and UnglifyJS 2).
 * Remove unnecessary vendor prefixes from fallback.

data/README.md

@@ -1,42 +1,42 @@
-# Visibility.js – a wrapper for the Page Visibility API
+# Visibility.js: a wrapper for the Page Visibility API
 
 Visibility.js allows you to determine whether your web page is visible to a
-user, is hidden in background tab or is prerendering. It allows you to use the
-page visibility state in JavaScript logic and improve browser performance by
-disabling unnecessary timers and AJAX requests, or improve user interface
-experience (for example, by stopping video playback or slideshow when user
+user, is hidden in background tab or is prerendering. It allows you to use
+the page visibility state in JavaScript logic and improve browser performance
+by disabling unnecessary timers and AJAX requests, or improve user interface
+experience (for example, by stopping video playback or slideshow when user
 switches to another browser tab).
 
 Moreover, you can detect if the browser is just [prerendering] the page while
-the user has not still opened the link, and don’t count this as a visit in your
+the user has not still opened the link, and don’t count this as a visit in your
 analytics module, or do not run heavy calculations or other actions which will
 disable the prerendering.
 
-This library is a wrapper of the [Page Visibility API]. It eases usage of the
-API by hiding vendor-specific property prefixes and adding some high-level
-functions.
+This library is a wrapper of the [Page Visibility API]. It eases usage
+of the API by hiding vendor-specific property prefixes and adding some
+high-level functions.
 
 In most cases you don’t need to check whether the Page Visibility API is
 actually supported in the browser as, if it does not, the library will just
 assume that the page is visible all the time, and your logic will still work
 correctly, albeit less effective in some cases.
 
-Page Visibility API is [natively supported] by Google Chrome 13, Firefox 10,
-Opera 12.10 and IE 10. For old browsers you can use `lib/visibility.fallback.js`
-with focus/blur hack (note that this hack have issue, that document become
-to be hidden, when browser just lose focus, but still visible for user).
+Page Visibility API is [natively supported] by all browsers. For old browsers
+you can use `lib/visibility.fallback.js` with focus/blur hack (note that this
+hack have issue, that document become to be hidden, when browser just
+lose focus, but still visible for user).
 
 Sponsored by [Evil Martians].
 
-[Page Visibility API]: http://www.w3.org/TR/2011/WD-page-visibility-20110602/
+[Page Visibility API]: http://www.w3.org/TR/page-visibility/
 [prerendering]:        http://code.google.com/chrome/whitepapers/prerender.html
-[MozVisibility]:       https://github.com/private-face/mozvisibility
-[natively supported]:  http://caniuse.com/#feat=pagevisibility
+[natively supported]:  http://caniuse.com/pagevisibility
 [Evil Martians]:       http://evilmartians.com/
 
 ## Translations
 
-Документация на русском: <http://habrahabr.ru/blogs/javascript/125833/>
+Документация на русском:
+[habrahabr.ru/blogs/javascript/125833/](http://habrahabr.ru/blogs/javascript/125833/)
 
 ## States
 
@@ -45,12 +45,12 @@ Currently the Page Visibility API supports three visibility states:
 * `visible`: user has opened the page and works within it.
 * `hidden`: user has switched to another tab or minimized browser window.
 * `prerender`: browser is just prerendering a page which may possibly be opened
-   by the user to make the apparent loading time lesser.
+   by the user to make the apparent loading time lesser.
 
 ## Timers
 
 The main use case for this library is to enable some of the times only when
-content is visible to the user, i.e. the ones animating a countdown animation.
+content is visible to the user, i.e. the ones animating a countdown animation.
 
 `Visibility.every(interval, callback)` is similar to
 `setInterval(callback, interval)`, but calls `callback` every `interval` ms only
@@ -63,7 +63,7 @@ Visibility.every(1000, function () {
 ```
 
 You can provide an additional interval which will be used when the page
-is hidden. In next example, a check for inbox updates will be run every 1 minute
+is hidden. In next example, a check for inbox updates will be run every 1 minute
 for a visible page and every 5 minutes for a hidden one:
 
 ```js
@@ -76,18 +76,8 @@ Visibility.every(minute, 5 * minute, function () {
 Note that the callback will also be executed on every `hidden`->`visible` state
 change to update old contents.
 
-A syntactic sugar for specifying time intervals is supported when
-[jQuery Chrono plugin] is included before Visibility.js. It can be used like
-this:
-
-```js
-Visibility.every('minute', '5 minutes', function () {
-    checkNewMails();
-});
-```
-
 `Visibility.every` returns a timer identifier, much like the `setTimeout`
-function. It cannot be passed to `clearInterval`, through, and you should use
+function. It cannot be passed to `clearInterval`, through, and you should use
 `Visibility.stop(id)` to stop the timer.
 
 ```js
@@ -101,11 +91,9 @@ $('.stopSlideshow').click(function () {
 ```
 
 If the browser does not support the Page Visibility API, `Visibility.every` will
-fall back to `setInterval`, and `callback` will be run every `interval` ms for
+fall back to `setInterval`, and `callback` will be run every `interval` ms for
 both the hidden and visible pages.
 
-[jQuery Chrono plugin]: https://github.com/avk/jQuery-Chrono
-
 ## Initializers
 
 In another common use case you need to execute some actions upon a switch to
@@ -118,9 +106,9 @@ visible now, it will run `callback`, otherwise it will wait until state changes
 to `visible`, and then run `callback`.
 
 For example, let’s show an animated notification only when the page is visible,
-so if an user opens a page in the background, the animation will delay until
-the page becomes visible, i.e. until the user has switched to a tab with
-the page:
+so if an user opens a page in the background, the animation will delay until
+the page becomes visible, i.e. until the user has switched
+to a tab with the page:
 
 ```js
 Visibility.onVisible(function () {
@@ -128,14 +116,14 @@ Visibility.onVisible(function () {
 });
 ```
 
-If a browser doesn’t support Page Visibility API, `Visibility.onVisible` will
-run the `callback` immediately.
+If a browser doesn’t support Page Visibility API, `Visibility.onVisible`
+will run the `callback` immediately.
 
 ### Wait until the page is opened after prerendering
 
-A web developer can hint a browser (using Prerendering API) that an user is
-likely to click on some link (i.e. on a “Next” link in a multi-page article),
-and the browser then may prefetch and prerender the page, so that the user will
+A web developer can hint a browser (using Prerendering API) that an user
+is likely to click on some link (i.e. on a “Next” link in a multi-page article),
+and the browser then may prefetch and prerender the page, so that the user will
 not wait after actually going via the like.
 
 But you may not want to count the browser prerendering a page as a visitor in
@@ -160,7 +148,7 @@ If the browser doesn’t support Page Visibility API,
 ## Low-level API
 
 In some cases you may need more low-level methods. For example, you may want to
-count the time user has viewed the page in foreground and time it has stayed in
+count the time user has viewed the page in foreground and time it has stayed in
 background.
 
 `Visibility.isSupported()` will return `true` if browser supports the
@@ -174,9 +162,9 @@ if( Visibility.isSupported() ) {
 
 `Visibility.state()` will return a string with visibility state. More states
 can be added in the future, so for most cases a simpler `Visibility.hidden()`
-method can be used. It will return `true` if the page is hidden by any reason.
+method can be used. It will return `true` if the page is hidden by any reason.
 For example, while prerendering, `Visibility.state()` will return `"prerender"`,
-but `Visibility.hidden()` will return `true`.
+but `Visibility.hidden()` will return `true`.
 
 This code will aid in collecting page visibility statistics:
 
@@ -207,7 +195,7 @@ $(document).load(function () {
 ```
 
 Using `Visibility.change(callback)` you can listen to visibility state changing
-events. The `callback` takes 2 arguments: an event object and a state name.
+events. The `callback` takes 2 arguments: an event object and a state name.
 
 Let’s collect some statistics with this evented approach:
 
@@ -233,7 +221,7 @@ VideoPlayer.onFinish(function () {
 ```
 
 Methods `onVisible` and `afterPrerendering` will also return listener ID,
-if they wait visibility state changes. If they execute callback immediately,
+if they wait visibility state changes. If they execute callback immediately,
 they return `true` if Page Visibility API is supported and `false`
 if they can’t detect visibility state.
 
@@ -294,20 +282,17 @@ For Ruby on Rails you can use gem for Assets Pipeline.
 
 ### CDN
 
-If you don’t use any assets packaging manager use [CDNJS]. Add to your site:
+If you don’t use any assets packaging manager use [cdnjs](http://cdnjs.com/).
+Add to your site:
 
 ```html
-<script src="//cdnjs.cloudflare.com/ajax/libs/visibility.js/0.6.2/visibility.min.js"></script>
+<script src="//cdnjs.cloudflare.com/ajax/libs/visibility.js/1.0.0/visibility.min.js"></script>
 ```
 
-[CDNJS]: http://cdnjs.com/
-
 ### Other
 
 If you need just a files, you can take already minified packages from
-[github.com/ai/visibility.js/downloads].
-
-[github.com/ai/visibility.js/downloads]: https://github.com/ai/visibility.js/downloads
+[github.com/ai/visibility.js/releases](https://github.com/ai/visibility.js/releases).
 
 ## Contributing
 
@@ -326,7 +311,7 @@ If you need just a files, you can take already minified packages from
 3. Run all tests:
 
    ```sh
-   ./node_modules/.bin/cake test
+   npm test
    ```
 
 4. Run test server, to check code in real browsers:
@@ -335,8 +320,6 @@ If you need just a files, you can take already minified packages from
    ./node_modules/.bin/cake server
    ```
 
-5. Open tests in browser: [localhost:8000].
+5. Open tests in browser: [localhost:8000](http://localhost:8000).
 6. Also you can see real usage example in integration test
    `test/integration.html`.
-
-[localhost:8000]: http://localhost:8000

data/lib/assets/javascripts/visibility.core.js

@@ -159,9 +159,6 @@
         // Link to document object to change it in tests.
         _doc: window.document,
 
-        // Vendor prefixes to create event and properties names.
-        _prefixes: ['webkit', 'moz'],
-
         // Vendor prefix cached by `_prefix` function.
         _chechedPrefix: null,
 
@@ -191,12 +188,8 @@
             if ( defined(self._doc.visibilityState) ) {
                 return self._chechedPrefix = '';
             }
-            var name;
-            for ( var i = 0; i < self._prefixes.length; i++ ) {
-                name = self._prefixes[i] + 'VisibilityState';
-                if ( defined(self._doc[name]) ) {
-                    return self._chechedPrefix = self._prefixes[i];
-                }
+            if ( defined(self._doc.webkitVisibilityState) ) {
+                return self._chechedPrefix = 'webkit';
             }
         },
 

data/lib/assets/javascripts/visibility.js

@@ -159,9 +159,6 @@
         // Link to document object to change it in tests.
         _doc: window.document,
 
-        // Vendor prefixes to create event and properties names.
-        _prefixes: ['webkit', 'moz'],
-
         // Vendor prefix cached by `_prefix` function.
         _chechedPrefix: null,
 
@@ -191,12 +188,8 @@
             if ( defined(self._doc.visibilityState) ) {
                 return self._chechedPrefix = '';
             }
-            var name;
-            for ( var i = 0; i < self._prefixes.length; i++ ) {
-                name = self._prefixes[i] + 'VisibilityState';
-                if ( defined(self._doc[name]) ) {
-                    return self._chechedPrefix = self._prefixes[i];
-                }
+            if ( defined(self._doc.webkitVisibilityState) ) {
+                return self._chechedPrefix = 'webkit';
             }
         },
 
@@ -279,16 +272,6 @@
       // so don’t use it in `clearInterval`.
       //
       // On change state from hidden to visible timers will be execute.
-      //
-      // If you include jQuery Chrono plugin before Visibility.js, you could
-      // use Chrono’s syntax sugar in interval arguments:
-      //
-      //   Visibility.every('second', function () {
-      //       updateCountdown();
-      //   });
-      //   Visibility.every('1 minute', '5 minutes', function () {
-      //       checkNewMails();
-      //   });
       every: function (interval, hiddenInterval, callback) {
           self._initTimers();
 
@@ -345,38 +328,16 @@
           }
           self._timersInitialized = true;
 
-          if ( defined(window.jQuery) && defined(jQuery.every) ) {
-              self._setInterval = self._chronoInterval;
-          } else {
-              self._setInterval = self._originalInterval;
-          }
           self.change(function () {
               self._timersStopRun()
           });
       },
 
-      // Set interval directly by `setInterval` function without any syntax
-      // sugar.
-      _originalInterval: function (callback, interval) {
-          return setInterval(callback, interval);
-      },
-
-      // Set interval by jQuery Chrono plugin. Add syntax sugar to `interval`
-      // and `hiddenInterval` arguments, such as "1 second" and others.
-      //
-      // It will be automatically set to `_setInterval` on loading if
-      // you include jQuery Chrono plugin before Visibility.js.
-      _chronoInterval: function (callback, internal) {
-          return jQuery.every(internal, callback);
-      },
-
       // Set interval by `setInterval`. Allow to change function for tests or
       // syntax sugar in `interval` arguments.
-      //
-      // Function will be automatically set in `_init` method (which will be
-      // call on script loading). So you must include jQuery Chrono plugin
-      // before Visibility.js.
-      _setInterval: null,
+      _setInterval: function (callback, interval) {
+          return setInterval(callback, interval);
+      },
 
       // Try to run timer from every method by it’s ID. It will be use
       // `interval` or `hiddenInterval` depending on visibility state.

data/lib/assets/javascripts/visibility.timers.js

@@ -50,16 +50,6 @@
       // so don’t use it in `clearInterval`.
       //
       // On change state from hidden to visible timers will be execute.
-      //
-      // If you include jQuery Chrono plugin before Visibility.js, you could
-      // use Chrono’s syntax sugar in interval arguments:
-      //
-      //   Visibility.every('second', function () {
-      //       updateCountdown();
-      //   });
-      //   Visibility.every('1 minute', '5 minutes', function () {
-      //       checkNewMails();
-      //   });
       every: function (interval, hiddenInterval, callback) {
           self._initTimers();
 
@@ -116,38 +106,16 @@
           }
           self._timersInitialized = true;
 
-          if ( defined(window.jQuery) && defined(jQuery.every) ) {
-              self._setInterval = self._chronoInterval;
-          } else {
-              self._setInterval = self._originalInterval;
-          }
           self.change(function () {
               self._timersStopRun()
           });
       },
 
-      // Set interval directly by `setInterval` function without any syntax
-      // sugar.
-      _originalInterval: function (callback, interval) {
-          return setInterval(callback, interval);
-      },
-
-      // Set interval by jQuery Chrono plugin. Add syntax sugar to `interval`
-      // and `hiddenInterval` arguments, such as "1 second" and others.
-      //
-      // It will be automatically set to `_setInterval` on loading if
-      // you include jQuery Chrono plugin before Visibility.js.
-      _chronoInterval: function (callback, internal) {
-          return jQuery.every(internal, callback);
-      },
-
       // Set interval by `setInterval`. Allow to change function for tests or
       // syntax sugar in `interval` arguments.
-      //
-      // Function will be automatically set in `_init` method (which will be
-      // call on script loading). So you must include jQuery Chrono plugin
-      // before Visibility.js.
-      _setInterval: null,
+      _setInterval: function (callback, interval) {
+          return setInterval(callback, interval);
+      },
 
       // Try to run timer from every method by it’s ID. It will be use
       // `interval` or `hiddenInterval` depending on visibility state.

metadata

@@ -1,32 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: visibilityjs
 version: !ruby/object:Gem::Version
+  version: 1.0.0
   prerelease: 
-  version: 0.6.2
 platform: ruby
 authors:
 - Andrey "A.I" Sitnik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-28 00:00:00.000000000 Z
+date: 2013-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  type: :runtime
   name: sprockets
-  prerelease: false
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '2'
-    none: false
+  type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '2'
-    none: false
 description: Visibility.js allow you to determine whether your web page is visible
   to an user, is hidden in background tab or is prerendering. It allows you use the
   page visibility state in JavaScript logic and improve browser performance or improve
@@ -55,17 +55,17 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23