visibilityjs 0.3

data/ChangeLog

@@ -0,0 +1,11 @@
+== 0.3 (Explorer 1, answer)
+* Rename gem to visibilityjs.
+* Fix gem integration with Asset Pipeline paths.
+
+== 0.2 (Sputnik 2, Laika)
+* Rename support() to isSupported() and notPrerender() to afterPrerendering().
+* Fix IE 6 and 7 support.
+* Documentation fixes by Peter Zotov.
+
+== 0.1 (Sputnik 1, the first)
+* initial release.

data/LICENSE

@@ -0,0 +1,166 @@
+		   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions. 
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version. 
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.
+

data/README.md

@@ -0,0 +1,267 @@
+# Visibility.js – a wrapper for the Page Visibility API
+
+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 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
+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.
+
+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]: http://www.w3.org/TR/2011/WD-page-visibility-20110602/
+[prerendering]: http://code.google.com/chrome/whitepapers/prerender.html
+
+## States
+
+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.
+
+## 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.
+
+`Visibility.every(interval, callback)` is similar to
+`setInterval(callback, interval)`, but calls `callback` every `interval` ms only
+if the page is visible. For example, let’s create a countdown timer:
+
+```js
+Visibility.every(1000, function () {
+    updateCountdownAnimation();
+});
+```
+
+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
+for a visible page and every 5 minutes for a hidden one:
+
+```js
+var minute = 60 * 1000;
+Visibility.every(minute, 5 * minute, function () {
+    checkForEmail();
+});
+```
+
+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
+`Visibility.stop(id)` to stop the timer.
+
+```js
+slideshow = Visibility.every(5 * 1000, function () {
+    nextSlide();
+});
+
+$('.stopSlideshow').click(function () {
+    Visibility.stop(slideshow);
+});
+```
+
+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
+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
+particular visibility state.
+
+### Waiting until the page becomes visible
+
+`Visibility.onVisible(callback)` checks current state of the page. If it is
+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:
+
+```js
+Visibility.onVisible(function () {
+    Notification.animateNotice("Hello");
+});
+```
+
+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
+not wait after actually going via the like.
+
+But you may not want to count the browser prerendering a page as a visitor in
+your analytics system. Moreover, the browser will disable prerendering if you
+will try to do heavy computations or use audio/video tags on the page. So, you
+may decide to not run parts of the code while prerendering and wait until the
+user actually opens the link.
+
+You can use `Visibility.afterPrerendering(callback)` in this cases. For example,
+this code will only take real visitors (and not page prerenderings) into
+account:
+
+```js
+Visibility.afterPrerendering(function () {
+    Statistics.countVisitor();
+});
+```
+
+If the browser doesn’t support Page Visibility API,
+`Visibility.afterPrerendering` will run `callback` immediately.
+
+## 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
+background.
+
+`Visibility.isSupported()` will return `true` if browser supports the
+Page Visibility API:
+
+```js
+if( Visibility.isSupported() ) {
+    Statistics.startTrackingVisibility();
+}
+```
+
+`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.
+For example, while prerendering, `Visibility.state()` will return `"prerender"`,
+but `Visibility.hidden()` will return `true`.
+
+This code will aid in collecting page visibility statistics:
+
+```js
+$(document).load(function () {
+
+    if ( 'hidden' == Visibility.state() ) {
+        Statistics.userOpenPageInBackgroundTab();
+    }
+    if ( 'prerender' == Visibility.state() ) {
+        Statistics.pageIsPrerendering();
+    }
+
+});
+```
+
+And this example will only enable auto-playing when the page is opening as a
+visible tab (not a background one):
+
+```js
+$(document).load(function () {
+
+   if ( !Visibility.hidden() ) {
+       VideoPlayer.play();
+   }
+
+});
+```
+
+Using `Visibility.change(callback)` you can listen to visibility state changing
+events. The `callback` takes 2 arguments: an event object and a state name.
+
+Let’s collect some statistics with this evented approach:
+
+```js
+Visibility.change(function (e, state) {
+    Statistics.visibilityChange(state);
+});
+```
+
+## Installing
+
+### Rails 3.1
+
+In Rails 3.1 just add `visibilityjs` gem to `Gemfile`:
+
+```ruby
+gem 'visibilityjs'
+```
+
+and require it in `app/assets/javascripts/application.js.coffee`:
+
+```coffee
+#= require visibility
+```
+
+### Jammit
+
+If you use Jammit or another package manager, you’ll need to copy
+`lib/visibility.js` to `public/javascripts/lib` in your project and add the
+library to `config/assets.yml`:
+
+```yaml
+javascripts:
+  application:
+    - public/javascripts/lib/visibility.js
+```
+
+### Other
+
+If you don’t use Rails 3.1 or assets packaging manager you can use an already
+minified version of the library, located in repository as
+`lib/visibility.min.js`.
+
+## Contributing
+
+To run project tests and minimize source you’ll need to have Ruby and Bundler
+installed. For example, in a Debian-based (e.g. Ubuntu) environment:
+
+```
+sudo apt-get install ruby rubygems
+sudo gem install bundler
+```
+
+Then, you will need to install Jasmine, UglifyJS and other dependencies with
+Bundler. Run in root of the project repository:
+
+```
+bundle install --path=.bundle
+```
+
+That’s all. To run tests, start server and open <http://localhost:8888/>:
+
+```
+bundle exec rake server
+```
+
+Minimize the source before commiting:
+
+```
+bundle exec rake min
+```

data/lib/visibilityjs.rb

@@ -0,0 +1,8 @@
+# Used only for Ruby on Rails gem to tell, that gem contain `vendor/assets` with
+# visibility.js file.
+module VisibilityJs
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/vendor/assets/javascripts/visibility.js

@@ -0,0 +1,385 @@
+/*
+ * Copyright 2011 Andrey “A.I.” Sitnik <andrey@sitnik.ru>,
+ * sponsored by Evil Martians.
+ * 
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * 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 Lesser General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+;(function() {
+    "use strict";
+
+    var defined = function(variable) {
+        return ('undefined' != typeof(variable));
+    };
+
+    // Visibility.js allow you to know, that your web page is in the background
+    // tab and thus not visible to the user. This library is wrap under
+    // Page Visibility API. It fix problems with different vendor prefixes and
+    // add high-level useful functions.
+    window.Visibility = {
+
+        // Link to document object to change it in tests.
+        _doc: window.document,
+
+        // Vendor prefixes to create event and properties names.
+        _prefixes: ['webkit', 'moz', 'o', 'ms'],
+
+        // Vendor prefix cached by `_prefix` function.
+        _chechedPrefix: null,
+
+        // Is listener for `visibilitychange` event is already added
+        // by `_setListener` method.
+        _listening: false,
+
+        // Callbacks from `change` method, that wait visibility changes.
+        _changeCallbacks: [],
+
+        // Callbacks from `onVisible` method, that wait when page become to be
+        // visible.
+        _onVisibleCallbacks: [],
+
+        // Callbacks from `afterPrerendering` method, that wait when visibility
+        // state change from “prerender”.
+        _afterPrerenderingCallbacks: [],
+
+        // Last timer number.
+        _lastTimer: 0,
+
+        // Callbacks and intervals added by `every` method.
+        _timers: { },
+
+        // Variable to check hidden-visible state changes.
+        _hiddenBefore: false,
+
+        // Initialize variables on page loading.
+        _init: function () {
+            this._hiddenBefore = this.hidden();
+
+            if ( defined(window.jQuery) && defined(jQuery.every) ) {
+                this._setInterval = this._chronoSetInterval;
+            } else {
+                this._setInterval = this._originalSetInterval;
+            }
+        },
+
+        // Detect vendor prefix and return it.
+        _prefix: function () {
+            if ( null !== this._chechedPrefix ) {
+                return this._chechedPrefix;
+            }
+            if ( defined(this._doc.visibilityState) ) {
+                return this._chechedPrefix = '';
+            }
+            var name;
+            for ( var i = 0; i < this._prefixes.length; i++ ) {
+                name = this._prefixes[i] + 'VisibilityState';
+                if ( defined(this._doc[name]) ) {
+                    return this._chechedPrefix = this._prefixes[i];
+                }
+            }
+        },
+
+        // Return property name with vendor prefix.
+        _name: function (name) {
+            var prefix = this._prefix();
+            if ( '' == prefix ) {
+                return name;
+            } else {
+                return prefix +
+                    name.substr(0, 1).toUpperCase() + name.substr(1);
+            }
+        },
+
+        // Return document’s property value with name with vendor prefix.
+        _prop: function (name) {
+            return this._doc[this._name(name)]
+        },
+
+        // Listener for `visibilitychange` event.
+        _onVisibilityChange: function(event) {
+            var isHidden = this.hidden(),
+                state    = this.state();
+
+            for ( var i = 0; i < this._changeCallbacks.length; i++ ) {
+                this._changeCallbacks[i].call(this._doc, event, state);
+            }
+
+            var hiddenBefore = this._hiddenBefore;
+            if ( (isHidden && !hiddenBefore) || (!isHidden && hiddenBefore) ) {
+                for ( i in this._timers ) {
+                    this._stopTimer(i);
+                    this._runTimer(i, !isHidden);
+                }
+            }
+
+            if ( !isHidden ) {
+                for ( var i = 0; i < this._onVisibleCallbacks.length; i++ ) {
+                    this._onVisibleCallbacks[i]();
+                }
+                this._onVisibleCallbacks = [];
+            }
+
+            if ( 'prerender' != this.state() ) {
+                var after = this._afterPrerenderingCallbacks.length
+                for ( var i = 0; i < after; i++ ) {
+                    this._afterPrerenderingCallbacks[i]();
+                }
+                this._afterPrerenderingCallbacks = [];
+            }
+
+            this._hiddenBefore = isHidden;
+        },
+
+        // Set listener for `visibilitychange` event.
+        _setListener: function () {
+            if ( this._listening ) {
+                return;
+            }
+            var event = this._prefix() + 'visibilitychange';
+            this._doc.addEventListener(event, function () {
+                Visibility._onVisibilityChange.apply(Visibility, arguments);
+            }, false);
+            this._listening = true;
+            this._hiddenBefore = this.hidden();
+        },
+
+        // Set interval directly by `setInterval` function without any syntax
+        // sugar.
+        _originalSetInterval: 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.
+        _chronoSetInterval: 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,
+
+        // Try to run timer from every method by it’s ID. It will be use
+        // `interval` or `hiddenInterval` depending on visibility state.
+        // If page is hidden and `hiddenInterval` is null,
+        // it will not run timer.
+        //
+        // Argument `now` say, that timers must be execute now too.
+        _runTimer: function (id, now) {
+            var interval,
+                timer = this._timers[id];
+            if ( this.hidden() ) {
+                if ( null === timer.hiddenInterval ) {
+                    return;
+                }
+                interval = timer.hiddenInterval;
+            } else {
+                interval = timer.interval;
+            }
+            if ( now ) {
+                timer.callback.call(window);
+            }
+            timer.intervalID = this._setInterval(timer.callback, interval);
+        },
+
+        // Stop timer from `every` method by it’s ID.
+        _stopTimer: function (id) {
+            var timer = this._timers[id];
+            clearInterval(timer.intervalID);
+            delete timer.intervalID;
+        },
+
+        // Return true if browser support Page Visibility API.
+        //
+        //   if ( Visibility.isSupported() ) {
+        //       Statistics.startTrackingVisibility();
+        //       Visibility.change(function(e, state)) {
+        //           Statistics.trackVisibility(state);
+        //       });
+        //   }
+        isSupported: function () {
+            return defined(this._prefix());
+        },
+
+        // Return true if page now isn’t visible to user.
+        //
+        //   if ( !Visibility.hidden() ) {
+        //       VideoPlayer.play();
+        //   }
+        //
+        // It is just proxy to `document.hidden`, but use vendor prefix.
+        hidden: function () {
+            if ( !this.isSupported() ) {
+                return false;
+            }
+            return this._prop('hidden');
+        },
+
+        // Return visibility state: 'visible', 'hidden' or 'prerender'.
+        //
+        //   if ( 'prerender' == Visibility.state() ) {
+        //       Statistics.pageIsPrerendering();
+        //   }
+        //
+        // Don’t use `Visibility.state()` to detect, is page visible, because
+        // visibility states can extend in next API versions.
+        // Use more simpler and general `Visibility.hidden()` for this cases.
+        //
+        // It is just proxy to `document.visibilityState`, but use
+        // vendor prefix.
+        state: function () {
+            if ( !this.isSupported() ) {
+                return 'visible';
+            }
+            return this._prop('visibilityState');
+        },
+
+        // Call callback when visibility will be changed. First argument for
+        // callback will be original event object, second will be visibility
+        // state name.
+        //
+        // If Page Visibility API doesn’t supported method will be return false
+        // and callback never will be called.
+        //
+        //   Visibility.change(function(e, state) {
+        //       Statistics.visibilityChange(state);
+        //   });
+        //
+        // It is just proxy to `visibilitychange` event, but use vendor prefix.
+        change: function (callback) {
+            if ( !this.isSupported() ) {
+                return false;
+            }
+            this._changeCallbacks.push(callback);
+            this._setListener();
+            return true;
+        },
+
+        // Call callback only when page become to visible for user or
+        // call it now if page is visible now or Page Visibility API
+        // doesn’t supported.
+        //
+        // Return true if callback if called now.
+        //
+        //   Visibility.onVisible(function() {
+        //       Notification.animateNotice("Hello");
+        //   });
+        onVisible: function (callback) {
+            if ( !this.isSupported() || !this.hidden() ) {
+                callback();
+                return true;
+            }
+            this._onVisibleCallbacks.push(callback);
+            this._setListener();
+        },
+
+        // Call `callback` in any state, expect “prerender”. If current state
+        // is “prerender” it will wait until state will be changed.
+        // If Page Visibility API doesn’t supported, it will call `callback`
+        // immediately.
+        //
+        //   Visibility.afterPrerendering(function () {
+        //       Statistics.countVisitor();
+        //   });
+        afterPrerendering: function (callback) {
+            if ( !this.isSupported() || 'prerender' != this.state() ) {
+                callback();
+                return true;
+            }
+            this._afterPrerenderingCallbacks.push(callback);
+            this._setListener();
+        },
+
+        // Run callback every `interval` milliseconds if page is visible and
+        // every `hiddenInterval` milliseconds if page is hidden.
+        //
+        //   Visibility.every(60 * 1000, 5 * 60 * 1000, function() {
+        //       checkNewMails();
+        //   });
+        //
+        // You can skip `hiddenInterval` and callback will be called only if
+        // page is visible.
+        //
+        //   Visibility.every(1000, function() {
+        //       updateCountdown();
+        //   });
+        //
+        // It is analog of `setInterval(callback, interval)` but use visibility
+        // state.
+        //
+        // It return timer ID, that you can use in `Visibility.stop(id)` to stop
+        // timer (`clearInterval` analog).
+        // Warning: timer ID is different from intervalID from `setInterval`,
+        // 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) {
+            if ( !defined(callback) ) {
+                callback = hiddenInterval;
+                hiddenInterval = null;
+            }
+            this._lastTimer += 1;
+            var number = this._lastTimer;
+            this._timers[number] = ({
+                interval:       interval,
+                hiddenInterval: hiddenInterval,
+                callback:       callback
+            });
+            this._runTimer(number, false);
+            if ( this.isSupported() ) {
+                this._setListener();
+            }
+            return number;
+        },
+
+        // Stop timer from `every` method by it ID (`every` method return it).
+        //
+        //   slideshow = Visibility.every(5 * 1000, function() {
+        //       changeSlide();
+        //   });
+        //   $('.stopSlideshow').click(function() {
+        //       Visibility.stop(slideshow);
+        //   });
+        stop: function(id) {
+            var timer = this._timers[id]
+            if ( !defined(timer) ) {
+                return false;
+            }
+            this._stopTimer(id);
+            delete this._timers[id];
+            return timer;
+        }
+
+    };
+
+    Visibility._init();
+
+})();

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: visibilityjs
+version: !ruby/object:Gem::Version 
+  hash: 13
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  version: "0.3"
+platform: ruby
+authors: 
+- "Andrey \xE2\x80\x9CA.I.\xE2\x80\x9D Sitnik"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-31 00:00:00 +04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 62196457
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 5
+        version: 2.0.0.beta.5
+  requirement: *id001
+  type: :runtime
+  name: sprockets
+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 user interface experience.
+email: 
+- andrey@sitnik.ru
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+- ChangeLog
+files: 
+- vendor/assets/javascripts/visibility.js
+- lib/visibilityjs.rb
+- LICENSE
+- README.md
+- ChangeLog
+has_rdoc: true
+homepage: https://github.com/evilmartians/visibility.js
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: "Visibility.js \xE2\x80\x93 a wrapper for the Page Visibility API."
+test_files: []
+