gmaps-autocomplete-rails 0.1.1 → 0.1.2

data/CHANGELOG

@@ -0,0 +1,6 @@
+## 0.1.2
+
+- Fixed some bugs
+- Made defaultOptions directly accessible via GmapsAutoComplete.defaultOptions
+- Added country option in order to allow for shorter addresses
+- Added debug functionality that can be enabled via debugOn option

data/README.md

@@ -40,18 +40,26 @@ defaultOptions = {
   pos: [51.751724, -1.255284],
   inputField: '#gmaps-input-address',
   errorField: '#gmaps-error',
+  debugOn: false
+};
+```
+
+The following default methods can be replaced by configuration:
+
+```javascript
   positionOutputter: this.defaultPositionOutputter,
   updateUI : this.defaultUpdateUI,
   updateMap : this.defaultUpdateMap
-};
 ```
 
-`autoCompleteInit` also takes an option hash, but currently only [region](https://developers.google.com/maps/documentation/geocoding/#RegionCodes) is used.
+`autoCompleteInit` also takes an option hash, but currently only [region](https://developers.google.com/maps/documentation/geocoding/#RegionCodes) and country can be used.
 
 ```javascript
-autoCompleteInit({region: 'USA'});
+autoCompleteInit({region: 'DK', country: 'Denmark'});
 ```
 
+Will make searches in the DK region and remove `', Denmark'` from the result.
+
 # Examples
 
 See `spec/index.html` for an example page using this "plugin". Note that if you set `mapElem`to null or leave out that element on the page, the autocomplete will function without attempting to update the map :)

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/gmaps-autocomplete-rails.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "gmaps-autocomplete-rails"
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
-  s.date = "2012-09-07"
+  s.date = "2012-09-10"
   s.description = "Easily add autocomplete geo-functionality to your Rails app :)"
   s.email = "kmandrup@gmail.com"
   s.extra_rdoc_files = [
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
     ".rspec",
+    "CHANGELOG",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",

data/vendor/assets/javascripts/gmaps-autocomplete.js

@@ -8,6 +8,8 @@ var GmapsAutoComplete = {
   updateUI: null,
   updateMap: null,
   region: null,
+  country: null,
+  debugOn: false,
 
   // initialise the google maps objects, and add listeners
   mapElem: document.getElementById("gmaps-canvas"), 
@@ -18,22 +20,20 @@ var GmapsAutoComplete = {
   errorField: '#gmaps-error',
   positionOutputter: this.defaultPositionOutputter,
 
+  defaultOptions: {
+    mapElem: "#gmaps-canvas", 
+    zoomLevel: 2, 
+    mapType: google.maps.MapTypeId.ROADMAP,
+    pos: [51.751724, -1.255284],
+    inputField: '#gmaps-input-address',
+    errorField: '#gmaps-error',
+    debugOn: false
+  },
+
   init: function(opts){
     opts = opts || {};
-
-    defaultOptions = {
-      mapElem: "#gmaps-canvas", 
-      zoomLevel: 2, 
-      mapType: google.maps.MapTypeId.ROADMAP,
-      pos: [51.751724, -1.255284],
-      inputField: '#gmaps-input-address',
-      errorField: '#gmaps-error',
-      positionOutputter: this.defaultPositionOutputter,
-      updateUI : this.defaultUpdateUI,
-      updateMap : this.defaultUpdateMap
-    };
-
-    $.extend(opts, defaultOptions);
+    var callOpts = jQuery.extend(true, {}, opts);
+    var opts = $.extend(true, {}, this.defaultOptions, opts);
 
     var pos = opts['pos'];
     var lat = pos[0];
@@ -50,33 +50,43 @@ var GmapsAutoComplete = {
     
     this.inputField = opts['inputField'];
     this.errorField = opts['#gmaps-error'];
+    this.debugOn = opts['debugOn'];
+
+    this.positionOutputter = opts['positionOutputter'] || this.defaultPositionOutputter;
+    this.updateUI = opts['updateUI'] || this.defaultUpdateUI;
+    this.updateMap = opts['updateMap'] || this.defaultUpdateMap;
 
-    this.positionOutputter = opts['positionOutputter'];
-    this.updateUI = opts['updateUI'];
-    this.updateMap = opts['updateMap'];
+    this.debug('called with opts', callOpts); 
+    this.debug('defaultOptions', this.defaultOptions);
+    this.debug('options after merge with defaults', opts);
 
     // center of the universe
     var latlng = new google.maps.LatLng(lat, lng);
+    this.debug('lat,lng', latlng);
 
-    var options = {
+    var mapOptions = {
       zoom: zoomLevel,
       center: latlng,
       mapTypeId: mapType
     };
 
+    this.debug('map options', mapOptions);
+
     // the geocoder object allows us to do latlng lookup based on address
-    geocoder = new google.maps.Geocoder();
+    this.geocoder = new google.maps.Geocoder();
 
     var self = this;
 
     if (typeof(mapElem) == 'undefined') {
-      self.showError("Map element " + opts['mapElem'] + " could not be resolved!");
+      this.showError("Map element " + opts['mapElem'] + " could not be resolved!");
     }
 
+    self.debug('mapElem', this.mapElem);
+
     if (!mapElem) { return }
     
     // create our map object
-    this.map = new google.maps.Map(mapElem, options);
+    this.map = new google.maps.Map(mapElem, mapOptions);
 
     if (!this.map) { return }
 
@@ -89,6 +99,11 @@ var GmapsAutoComplete = {
     self.addMapListeners(this.marker, this.map);
   },
 
+  debug: function(label, obj) {
+    if (!this.debugOn) { return }
+    console.log(label, obj);
+  },
+
   addMapListeners: function(marker, map) {
     self = this;
     // event triggered when marker is dragged and dropped
@@ -120,7 +135,13 @@ var GmapsAutoComplete = {
   // fill in the UI elements with new position data
   defaultUpdateUI: function( address, latLng ) {
     $(this.inputField).autocomplete("close");
-    $(this.inputField).val(address);
+
+    this.debug('country', this.country);
+    var updateAdr = address.replace(", " + this.country, '');
+    var updateAdr = address;
+    this.debug('updateAdr', updateAdr);
+
+    $(this.inputField).val(updateAdr);
 
     this.positionOutputter(latLng);
   },
@@ -144,12 +165,13 @@ var GmapsAutoComplete = {
 
     request = {};
     request[type] = value;
-    var self = this;
 
-    geocoder.geocode(request, performGeocode);
+    this.geocoder.geocode(request, performGeocode);
   },
 
   performGeocode: function(results, status) {
+    this.debug('performGeocode', status);
+
     $(self.errorField).html('');
     if (status == google.maps.GeocoderStatus.OK) {
       self.geocodeSuccess(results);
@@ -159,6 +181,7 @@ var GmapsAutoComplete = {
   },
 
   geocodeSuccess: function(results) {
+    this.debug('geocodeSuccess', results);
     // Google geocoding has succeeded!
     if (results[0]) {
       // Always update the UI elements with new location data
@@ -174,6 +197,7 @@ var GmapsAutoComplete = {
   },
 
   geocodeFailure: function(type, value) {
+    this.debug('geocodeFailure', type);
     // Google Geocoding has failed. Two common reasons:
     //   * Address not recognised (e.g. search for 'zxxzcxczxcx')
     //   * Location doesn't map to address (e.g. click in middle of Atlantic)
@@ -213,13 +237,49 @@ var GmapsAutoComplete = {
   autoCompleteInit: function (opts) {
     opts = opts || {};
     this.region = opts['region'] || 'DK';
+    this.country = opts['country'] || 'Denmark';
+    this.debug('region', this.region)
+
+    var self = this;
 
     $(this.inputField).autocomplete({
+      // event triggered when drop-down option selected
+      select: function(event,ui){
+        self.updateUI(  ui.item.value, ui.item.geocode.geometry.location )
+        self.updateMap( ui.item.geocode.geometry )
+      },
+
       // source is the list of input options shown in the autocomplete dropdown.
       // see documentation: http://jqueryui.com/demos/autocomplete/
-      source: this.autoCompleteSource,
-      // event triggered when drop-down option selected
-      select: this.autoCompleteSelect
+      source: function(request,response) {
+        // https://developers.google.com/maps/documentation/geocoding/#RegionCodes
+        var region_postfix = ''
+        var region = self.region;
+        
+        if (region) {
+          region_postfix = ', ' + region
+        }
+        var address = request.term + region_postfix;
+
+        self.debug('geocode address', address);
+        
+        var geocodeOpts = {'address': address }
+
+        // the geocode method takes an address or LatLng to search for
+        // and a callback function which should process the results into
+        // a format accepted by jqueryUI autocomplete
+        self.geocoder.geocode(geocodeOpts, function(results, status) {
+          response($.map(results, function(item) {
+            var uiAddress = item.formatted_address.replace(", " + self.country, '');
+            // var uiAddress = item.formatted_address;
+            return {
+              label: uiAddress, // appears in dropdown box
+              value: uiAddress, // inserted into input element when selected
+              geocode: item                  // all geocode data: used in select callback event
+            }
+          }));
+        })
+      } 
     });
 
     // triggered when user presses a key in the address box
@@ -236,37 +296,5 @@ var GmapsAutoComplete = {
       // re-enable if previously disabled above
       $(this.inputField).autocomplete("enable")
     }
-  },
-
-  // self grants access to caller scope
-  autoCompleteSelect: function(event,ui){
-      self.updateUI(  ui.item.value, ui.item.geocode.geometry.location )
-      self.updateMap( ui.item.geocode.geometry )
-  },
-
-  // self grants access to caller scope
-  autoCompleteSource: function(request,response) {
-    // https://developers.google.com/maps/documentation/geocoding/#RegionCodes
-    var region_postfix = ''
-    var region = self.region;
-
-    if (region) {
-      region_postfix = ', ' + region
-    }
-
-    geocode_opts = {'address': request.term + region_postfix }
-
-    // the geocode method takes an address or LatLng to search for
-    // and a callback function which should process the results into
-    // a format accepted by jqueryUI autocomplete
-    geocoder.geocode(geocode_opts, function(results, status) {
-      response($.map(results, function(item) {
-        return {
-          label: item.formatted_address, // appears in dropdown box
-          value: item.formatted_address, // inserted into input element when selected
-          geocode: item                  // all geocode data: used in select callback event
-        }
-      }));
-    })
-  }  
+  } 
 }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gmaps-autocomplete-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-07 00:00:00.000000000 Z
+date: 2012-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -117,6 +117,7 @@ extra_rdoc_files:
 files:
 - .document
 - .rspec
+- CHANGELOG
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -162,7 +163,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4192616330667044491
+      hash: 3011531713176015454
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: