visibilityjs 1.0.0 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7a9ba4d047ee0acc40d0d22d42616c46bd4bfb51
+  data.tar.gz: f663938cead70fd0e1059d7a8f0183712f55e77e
+SHA512:
+  metadata.gz: b4ffa46278c837e7aeae670815bde746294c3c52c6ab900677aa4077efaf57bdf1565855903684bc3327d2b51d3b183834d6939fabb4cc73a5ce86e06aff6022
+  data.tar.gz: c55f49573bc8cf75db252692e4a57f2d4d7385f2b409fa72c0c40fa0b3148b8d9c4d992270d7b6e972bfcdeb1351a07ebc774c89aac96f2a7e42249555b59e78

data/{ChangeLog → ChangeLog.md}

@@ -1,54 +1,60 @@
-== 1.0.0 (Discoverer 2, stable)
+## 1.1.0 “Explorer 6, photo”
+* Prevent to run timer often, that it’s interval, when visibility was changed.
+* Allow to install by Bower package manager.
+* Change license to MIT.
+* Reduce library size.
+
+## 1.0.0 “Discoverer 2, stable”
 * Remove jQuery.Chrono integration.
 * Remove outdated Firefox prefix.
 
-== 0.6.2 (Pioneer 4, american sun)
+## 0.6.2 “Pioneer 4, american sun”
 * Decrease files size (by compressible code and UnglifyJS 2).
 * Remove unnecessary vendor prefixes from fallback.
 
-== 0.6.1 (Vanguard 2, weather)
+## 0.6.1 “Vanguard 2, weather”
 * Remove unnecessary vendor prefixes.
 
-== 0.6 (Luna 1, Mechta)
+## 0.6 “Luna 1, Mechta”
 * Methods onVisible and afterPrerendering return listener ID (by mcfedr).
 * Fix documentation (by Erwann Mest).
 
-== 0.5 (SCORE, communication)
+## 0.5 “SCORE, communication”
 * Split library to core and timers modules.
 * Allow to unbind change listener.
 * Use common logic in change(), afterPrerendering() and onVisible().
 
-== 0.4.5 (Pioneer 3, closer)
+## 0.4.5 “Pioneer 3, closer”
 * Fix gem assets directory.
 * Update development dependencies.
 
-== 0.4.4 (Pioneer 1, deeper into space)
+## 0.4.4 “Pioneer 1, deeper into space”
 * Remove non-ASCII symbols from gemspec.
 * Print testing URL in test task.
 
-== 0.4.3 (Explorer 4, short)
+## 0.4.3 “Explorer 4, short”
 * Fix gemspec issue with Bundler.
 
-== 0.4.2 (Sputnik 3, real)
+## 0.4.2 “Sputnik 3, real”
 * Reorder code to show first public and common methods.
 * Use node.js Cake instead of Ruby’s Rake to build tasks.
 * Move to Mocha, Chai and Sinon.JS for tests.
 * Move autogenerated minified to GitHub downloads.
 
-== 0.4.1 (Explorer 3, repeat)
+## 0.4.1 “Explorer 3, repeat”
 * Fix documentation and gemspec.
 
-== 0.4 (Vanguard 1, alternative)
+## 0.4 “Vanguard 1, alternative”
 * Add fallback API support by focus/blur hack to all browsers.
 
-== 0.3 (Explorer 1, answer)
+## 0.3 “Explorer 1, answer”
 * Rename gem to visibilityjs.
 * Fix gem integration with Asset Pipeline paths.
 
-== 0.2 (Sputnik 2, Laika)
+## 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)
+## 0.1 “Sputnik 1, the first”
 * Initial release.

data/LICENSE

@@ -1,165 +1,20 @@
-                   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.
+The MIT License (MIT)
+
+Copyright 2011 Andrey Sitnik <andrey@sitnik.ru>
+
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,8 +1,12 @@
-# Visibility.js: a wrapper for the Page Visibility API
+# Visibility.js
 
-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
+<img align="right" width="100" src="http://ai.github.io/visibility.js/logo.svg" title="Visibility.js logo by Eugenia Tuchapets">
+
+Visibility.js is a wrapper for the [Page Visibility API]. It hides vendor prefixes and adds high level functions.
+
+Page Visibility API 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
 switches to another browser tab).
@@ -12,15 +16,6 @@ the user has not still opened the link, and don’t count this as a visit in yo
 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 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
@@ -73,10 +68,7 @@ Visibility.every(minute, 5 * minute, function () {
 });
 ```
 
-Note that the callback will also be executed on every `hidden`->`visible` state
-change to update old contents.
-
-`Visibility.every` returns a timer identifier, much like the `setTimeout`
+`Visibility.every` returns a timer identifier, much like the `setInterval`
 function. It cannot be passed to `clearInterval`, through, and you should use
 `Visibility.stop(id)` to stop the timer.
 
@@ -197,7 +189,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.
 
-Let’s collect some statistics with this evented approach:
+Let’s collect some statistics with this events approach:
 
 ```js
 Visibility.change(function (e, state) {
@@ -244,13 +236,21 @@ notification.onOutOfDate(function () {
 Visibility.js is shipped with 4 files:
 
 * `visibility.core` – core module.
-* `visibility.timers` – `every` and `stop` methods to set `setTimeout` depend
+* `visibility.timers` – `every` and `stop` methods to set `setInterval` depend
   on visibility state.
 * `visibility` – `visibility.core` and `visibility.timers` together.
 * `visibility.fallback` – fallback for browser without Page Visibility API.
   It use document `focus`/`blur` events, so document become to be hidden,
   when browser just lose focus, but still visible for user.
 
+### Bower
+
+Visibility.js is available by Bower package manager:
+
+```
+bower install --save visibilityjs
+```
+
 ### Ruby on Rails
 
 For Ruby on Rails you can use gem for Assets Pipeline.
@@ -286,7 +286,7 @@ 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/1.0.0/visibility.min.js"></script>
+<script src="//cdnjs.cloudflare.com/ajax/libs/visibility.js/1.1.0/visibility.min.js"></script>
 ```
 
 ### Other

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

@@ -1,21 +1,3 @@
-/*
- * 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 (undefined) {
     "use strict";
 
@@ -73,10 +55,10 @@
             if ( !self.isSupported() ) {
                 return false;
             }
-            self._lastCallback += 1;
-            var number = self._lastCallback;
+            self._lastId += 1;
+            var number = self._lastId;
             self._callbacks[number] = callback;
-            self._setListener();
+            self._listen();
             return number;
         },
 
@@ -160,36 +142,36 @@
         _doc: window.document,
 
         // Vendor prefix cached by `_prefix` function.
-        _chechedPrefix: null,
+        _cached: null,
 
         // Is listener for `visibilitychange` event is already added
-        // by `_setListener` method.
-        _listening: false,
+        // by `_listen` method.
+        _enable: false,
 
         // Last timer number.
-        _lastCallback: -1,
+        _lastId: -1,
 
         // Callbacks from `change` method, that wait visibility changes.
         _callbacks: { },
 
         // Variable to check hidden-visible state changes.
-        _hiddenBefore: false,
+        _wasHidden: false,
 
         // Initialize variables on page loading.
         _init: function () {
-            self._hiddenBefore = self.hidden();
+            self._wasHidden = self.hidden();
         },
 
         // Detect vendor prefix and return it.
         _prefix: function () {
-            if ( null !== self._chechedPrefix ) {
-                return self._chechedPrefix;
+            if ( null !== self._cached ) {
+                return self._cached;
             }
             if ( defined(self._doc.visibilityState) ) {
-                return self._chechedPrefix = '';
+                return self._cached = '';
             }
             if ( defined(self._doc.webkitVisibilityState) ) {
-                return self._chechedPrefix = 'webkit';
+                return self._cached = 'webkit';
             }
         },
 
@@ -214,32 +196,32 @@
         },
 
         // Listener for `visibilitychange` event.
-        _onChange: function(event) {
+        _change: function(event) {
             var state = self.state();
 
             for ( var i in self._callbacks ) {
                 self._callbacks[i].call(self._doc, event, state);
             }
 
-            self._hiddenBefore = self.hidden();
+            self._wasHidden = self.hidden();
         },
 
         // Set listener for `visibilitychange` event.
-        _setListener: function () {
-            if ( self._listening ) {
+        _listen: function () {
+            if ( self._enable ) {
                 return;
             }
             var event = self._prefix() + 'visibilitychange';
             var listener = function () {
-                self._onChange.apply(Visibility, arguments);
+                self._change.apply(Visibility, arguments);
             };
             if ( self._doc.addEventListener ) {
                 self._doc.addEventListener(event, listener, false);
             } else {
                 self._doc.attachEvent(event, listener);
             }
-            self._listening = true;
-            self._hiddenBefore = self.hidden();
+            self._enable    = true;
+            self._wasHidden = self.hidden();
         }
 
     };

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

@@ -1,21 +1,3 @@
-/*
- * 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/>.
- */
-
 // Add Page Visibility API support to old browsers by focus/blur hack.
 //
 // Include this script _before_ Visibility.js.
@@ -29,8 +11,7 @@
 ;(function () {
     "use strict";
 
-    if ( document.visibilityState   || document.webkitVisibilityState ||
-         document.mozVisibilityState ) {
+    if ( document.visibilityState || document.webkitVisibilityState ) {
          return;
     }
 
@@ -48,7 +29,7 @@
             document.dispatchEvent(event);
         } else {
             if ( typeof(Visibility) == 'object' ) {
-                Visibility._onChange.call(Visibility, { })
+                Visibility._change.call(Visibility, { });
             }
         }
     }