compassjs 0.1.0

data/ChangeLog

@@ -0,0 +1,2 @@
+== 0.1 (James Cook)
+* Initial release.

data/LICENSE

@@ -0,0 +1,165 @@
+                   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,147 @@
+# Compass.js
+
+Compass.js allows you to get compass heading in JavaScript.
+Today we haven’t any standard way to get compass data,
+but there are two proprietary APIs and one hack:
+
+* [PhoneGap has] `navigator.compass` API.
+* iOS [Safari adds] `webkitCompassHeading` property to `deviceorientation` event.
+* We can enable GPS and ask user to go forward. GPS will send current heading,
+  so we can calculate difference between real North and zero in
+  `deviceorientation` event. Next we use this difference to get compass heading
+  only by device orientation.
+
+This library hides all this magic and APIs from you, autodetects available
+way and provides clean and simple API for your geolocation web app.
+
+Sponsored by [Evil Martians].
+
+[PhoneGap has]:  http://docs.phonegap.com/phonegap_compass_compass.md.html
+[Safari adds]:   http://developer.apple.com/library/safari/#documentation/SafariDOMAdditions/Reference/DeviceOrientationEventClassRef/DeviceOrientationEvent/DeviceOrientationEvent.html
+[Evil Martians]: http://evilmartians.com/
+
+## Usage
+
+
+Hide compass for desktop users (without compass, GPS and accelerometers):
+
+```js
+Compass.noSupport(function () {
+  $('.compass').hide();
+});
+```
+
+Show instructions for Android users:
+
+```js
+Compass.needGPS(function () {
+  $('.go-outside-message').show();          // Step 1: we need GPS signal
+}).needMove(function () {
+  $('.go-outside-message').hide()
+  $('.move-and-hold-ahead-message').show(); // Step 2: user must go forward
+}).init(function () {
+  $('.move-and-hold-ahead-message').hide(); // GPS hack is enabled
+});
+```
+
+Add compass heading listener:
+
+```js
+Compass.watch(function (heading) {
+  $('.degrees').text(heading);
+  $('.compass').css({ transform: 'rotate(' + (-heading) + 'deg)' });
+});
+```
+
+### Method Name
+
+Library will detect method asynchronously, so you can’t just read
+`Compass.method`, because it can be empty yet. It will be better to
+use `Compass.init` method:
+
+```js
+Compass.init(function (method) {
+  console.log('Compass heading by ' + method);
+});
+```
+
+If library is already initialized, callback will be executed instantly,
+without reinitialization.
+
+### Unwatch
+
+You can remove compass listener by `Compass.unwatch` method:
+
+```js
+var watchID = Compass.watch(function (heading) {
+  $('.degrees').text(heading);
+});
+
+Compass.unwatch(watchID);
+```
+
+## Installing
+
+### Ruby on Rails
+
+For Ruby on Rails you can use gem for Assets Pipeline.
+
+1. Add `compassjs` gem to `Gemfile`:
+
+   ```ruby
+   gem "compassjs"
+   ```
+
+2. Install gems:
+
+   ```sh
+   bundle install
+   ```
+
+3. Include Pages.js to your `application.js.coffee`:
+
+   ```coffee
+   #= require compass
+   ```
+
+### Others
+
+If you don’t use any assets packaging manager (it’s very bad idea), you can use
+already minified version of the library.
+
+Take it from: [github.com/ai/compass.js/downloads].
+
+[github.com/ai/compass.js/downloads]: https://github.com/ai/compass.js/downloads
+
+## Contributing
+
+1. To run tests you need node.js and npm. For example, in Ubuntu run:
+
+   ```sh
+   sudo apt-get install nodejs npm
+   ```
+
+2. Next install npm dependencies:
+
+   ```sh
+   npm install
+   ```
+
+3. Run all tests:
+
+   ```sh
+   ./node_modules/.bin/cake test
+   ```
+
+4. Run test server:
+
+   ```sh
+   ./node_modules/.bin/cake server
+   ```
+
+5. Open tests in browser: [localhost:8000].
+6. Also you can see real usage example in integration test:
+   [localhost:8000/integration].
+
+[localhost:8000]: http://localhost:8000
+[localhost:8000/integration]: http://localhost:8000/integration

data/lib/assets/javascripts/compass.js

@@ -0,0 +1,367 @@
+/*
+ * Copyright 2012 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";
+
+  // Shortcut to check, that `variable` is not `undefined` or `null`.
+  var defined = function (variable) {
+    return (variable != null || variable != undefined);
+  };
+
+  // Fire `type` callbacks with `args`.
+  var fire = function (type, args) {
+    var callbacks = self._callbacks[type];
+    for (var i = 0; i < callbacks.length; i++) {
+      callbacks[i].apply(window, args);
+    }
+  };
+
+  // Calculate average value for last 5 `array` items;
+  var average5 = function (array) {
+    var sum = 0;
+    for (var i = array.length - 1; i > array.length - 6; i--) {
+      sum += array[i];
+    }
+    return sum / 5;
+  };
+
+  // Compass.js allow you to get compass heading in JavaScript.
+  // We can get compass data by two proprietary APIs and one hack:
+  // * PhoneGap have `navigator.compass` API.
+  // * iOS Safari add `webkitCompassHeading` to `deviceorientation` event.
+  // * We can enable GPS and ask user to go forward. GPS will send current heading,
+  //   so we can calculate difference between real North and zero in
+  //   `deviceorientation` event. Next we use this difference to get compass heading
+  //   only by device orientation.
+  //
+  // Hide compass, when there isn’t any method:
+  //
+  //   Compass.noSupport(function () {
+  //     $('.compass').hide();
+  //   });
+  //
+  // Show instructions for GPS hack:
+  //
+  //   Compass.needGPS(function () {
+  //     $('.go-outside-message').show();
+  //   }).needMove(function () {
+  //     $('.go-outside-message').hide()
+  //     $('.move-and-hold-ahead-message').show();
+  //   }).init(function () {
+  //     $('.move-and-hold-ahead-message').hide();
+  //   });
+  var self = window.Compass = {
+
+    // Name of method to get compass heading. It will have value only after
+    // library initialization from `init` method. So better way to get
+    // method name is to use `init`:
+    //
+    //   Compass.init(function (method) {
+    //     console.log('Compass by ' + method);
+    //   });
+    //
+    // Available methods:
+    // * `phonegap` take from PhoneGap’s `navigator.compass`.
+    // * `webkitOrientation` take from iPhone’s proprietary
+    //   `webkitCompassHeading` proprerty in `DeviceOrientationEvent`.
+    // * `orientationAndGPS` take from device orientation with GPS hack.
+    //
+    // If browser hasn’t access to compass, `method` will be `false`.
+    method: undefined,
+
+    // Watch for compass heading changes and execute `callback` with degrees
+    // relative to magnetic north (from 0 to 360).
+    //
+    // Method return watcher ID to use it in `unwatch`.
+    //
+    //   var watchID = Compass.watch(function (heading) {
+    //     $('.degrees').text(heading);
+    //     // Don’t forget to change degree sign, when rotate compass.
+    //     $('.compass').css({ transform: 'rotate(' + (-heading) + 'deg)' });
+    //   });
+    //
+    //   someApp.close(function () {
+    //     Compass.unwatch(watchID);
+    //   });
+    watch: function (callback) {
+      var id = ++self._lastId;
+
+      self.init(function (method) {
+
+        if ( method == 'phonegap' ) {
+          self._watchers[id] = self._nav.compass.watchHeading(callback);
+
+        } else if ( method == 'webkitOrientation' ) {
+          var watcher = function (e) {
+            callback(e.webkitCompassHeading);
+          };
+          self._win.addEventListener('deviceorientation', watcher);
+          self._watchers[id] = watcher;
+
+        } else if ( method == 'orientationAndGPS' ) {
+          var degrees;
+          var watcher = function (e) {
+            degrees = -e.alpha + self._gpsDiff;
+            if ( degrees < 0 ) {
+              degrees += 360;
+            } else if ( degrees > 360 ) {
+              degrees -= 360;
+            }
+            callback(degrees);
+          };
+          self._win.addEventListener('deviceorientation', watcher);
+          self._watchers[id] = watcher;
+
+        }
+      });
+
+      return id;
+    },
+
+    // Remove watcher by watcher ID from `watch`.
+    //
+    //   Compass.unwatch(watchID)
+    unwatch: function (id) {
+      self.init(function (m) {
+
+        if ( m == 'phonegap' ) {
+          self._nav.compass.clearWatch(self._watchers[id]);
+
+        } else if ( m == 'webkitOrientation' || m == 'orientationAndGPS' ) {
+          self._win.removeEventListener('deviceorientation', self._watchers[id]);
+
+        }
+        delete self._watchers[id];
+      });
+      return self;
+    },
+
+    // Execute `callback`, when GPS hack activated to detect difference between
+    // device orientation and real North from GPS.
+    //
+    // You need to show to user some message, that he must go outside to be able
+    // to receive GPS signal.
+    //
+    // Callback must be set before `init` or `watch` executing.
+    //
+    //   Compass.needGPS(function () {
+    //     $('.go-outside-message').show();
+    //   });
+    //
+    // Don’t forget to hide message by `needMove` callback in second step.
+    needGPS: function (callback) {
+      self._callbacks.needGPS.push(callback);
+      return self;
+    },
+
+    // Execute `callback` on second GPS hack step, when library has GPS signal,
+    // but user must move and hold the device straight ahead. Library will use
+    // `heading` from GPS movement tracking to detect difference between
+    // device orientation and real North.
+    //
+    // Callback must be set before `init` or `watch` executing.
+    //
+    //   Compass.needMove(function () {
+    //     $('.go-outside-message').hide()
+    //     $('.move-and-hold-ahead-message').show();
+    //   });
+    //
+    // Don’t forget to hide message in `init` callback:
+    //
+    //   Compass.init(function () {
+    //     $('.move-and-hold-ahead-message').hide();
+    //   });
+    needMove: function (callback) {
+      self._callbacks.needMove.push(callback);
+      return self;
+    },
+
+    // Execute `callback` if browser hasn’t any way to get compass heading.
+    //
+    //   Compass.noSupport(function () {
+    //     $('.compass').hide();
+    //   });
+    //
+    // On Firefox detecting can take about 0.5 second. So, it will be better
+    // to show compass in `init`, than to hide it in `noSupport`.
+    noSupport: function (callback) {
+      if ( self.method === false ) {
+        callback();
+      } else if ( !defined(self.method) ) {
+        self._callbacks.noSupport.push(callback);
+      }
+      return self;
+    },
+
+    // Detect compass method and execute `callback`, when library will be
+    // initialized. Callback will get method name (or `false` if library can’t
+    // detect compass) in first argument.
+    //
+    // It is best way to check `method` property.
+    //
+    //   Compass.init(function (method) {
+    //     console.log('Compass by ' + method);
+    //   });
+    init: function (callback) {
+      if ( defined(self.method) ) {
+        callback(self.method);
+        return;
+      }
+      self._callbacks.init.push(callback);
+
+      if ( self._initing ) {
+        return;
+      }
+      self._initing = true;
+
+      if ( self._nav.compass ) {
+        self._start('phonegap');
+
+      } else if ( self._win.DeviceOrientationEvent ) {
+        self._win.addEventListener('deviceorientation', self._checkEvent);
+        setTimeout(function () {
+          if ( !self._checked ) {
+            self._start(false)
+          }
+        }, 500);
+
+      } else {
+        self._start(false);
+      }
+      return self;
+    },
+
+    // Last watch ID.
+    _lastId: 0,
+
+    // Hash of internal ID to watcher to use it in `unwatch`.
+    _watchers: { },
+
+    // Window object for testing.
+    _win: window,
+
+    // Navigator object for testing.
+    _nav: navigator,
+
+    // List of callbacks.
+    _callbacks: {
+
+      // Callbacks from `init` method.
+      init: [],
+
+      // Callbacks from `noSupport` method.
+      noSupport: [],
+
+      // Callbacks from `needGPS` method.
+      needGPS: [],
+
+      // Callbacks from `needMove` method.
+      needMove: []
+
+    },
+
+    // Is library now try to detect compass method.
+    _initing: false,
+
+    // Difference between `alpha` orientation and real North from GPS.
+    _gpsDiff: undefined,
+
+    // Finish library initialization and use `method` to get compass heading.
+    _start: function (method) {
+      self.method   = method;
+      self._initing = false;
+
+      fire('init', [method]);
+      self._callbacks.init = [];
+
+      if ( method === false ) {
+        fire('noSupport', []);
+      }
+      self._callbacks.noSupport = [];
+    },
+
+    // Tell, that `DeviceOrientationEvent` was fired.
+    _checked: undefined,
+
+    // Check `DeviceOrientationEvent` to detect compass method.
+    _checkEvent: function (e) {
+      self._checked = true;
+
+      if ( defined(e.webkitCompassHeading) ) {
+        self._start('webkitOrientation');
+
+      } else if ( defined(e.alpha) && self._nav.geolocation ) {
+        self._gpsHack();
+
+      } else {
+        self._start(false);
+      }
+
+      self._win.removeEventListener('deviceorientation', self._checkEvent);
+    },
+
+    // Use GPS to detect difference  between `alpha` orientation and real North.
+    _gpsHack: function () {
+      var first    = true;
+      var alphas   = [];
+      var headings = [];
+
+      fire('needGPS');
+
+      var saveAlpha = function (e) {
+        alphas.push(e.alpha);
+      }
+      self._win.addEventListener('deviceorientation', saveAlpha);
+
+      var success = function (position) {
+        var coords = position.coords
+        if ( !defined(coords.heading) ) {
+          return; // Position not from GPS
+        }
+
+        if ( first ) {
+          first = false;
+          fire('needMove');
+        }
+
+        if ( coords.speed > 1 ) {
+          headings.push(coords.heading);
+          if ( headings.length >= 5 && alphas.length >= 5 ) {
+            self._win.removeEventListener('deviceorientation', saveAlpha);
+            self._nav.geolocation.clearWatch(watcher);
+
+            self._gpsDiff = average5(headings) + average5(alphas);
+            self._start('orientationAndGPS');
+          }
+        } else {
+          headings = [];
+        }
+      };
+      var error = function () {
+        self._win.removeEventListener('deviceorientation', saveAlpha);
+        self._start(false);
+      };
+
+      var watcher = self._nav.geolocation.
+        watchPosition(success, error, { enableHighAccuracy: true });
+    }
+
+  };
+
+})();

data/lib/compassjs.rb

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

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: compassjs
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrey "A.I." Sitnik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  name: sprockets
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2'
+    none: false
+description: Compass.js allow you to get compass heading in JavaScript by PhoneGap,
+  iOS API or GPS hack.
+email:
+- andrey@sitnik.ru
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+- ChangeLog
+files:
+- lib/assets/javascripts/compass.js
+- lib/compassjs.rb
+- LICENSE
+- README.md
+- ChangeLog
+homepage: https://github.com/ai/compass.js
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Compass.js allow you to get compass heading in JavaScript
+test_files: []