rails_admin_map_field 0.0.1

data/README.md

@@ -0,0 +1,80 @@
+Rails Admin Map Field
+=====================
+
+rails_admin_map_field is a gem that works with sferik's **rails_admin** (https://github.com/keitoaino/rails_admin) to provide an easy to use Google Maps interface for displaying and setting geographic co-ordinates in a model.
+
+Where a latitude and longitude is set on the model, it is indicated by a marker shown on a Google map centered at the marker. The administrator can change the value of these fields by clicking on the desired new location on the map.
+
+Usage
+=====
+
+rails_admin_map_field expects that the model will have two attributes, one for latitude and one for longitude of the point represented. To enable rails_admin_map_field, add the following to your `Gemfile`:
+
+```ruby
+gem 'rails_admin_map_field', git: 'git://github.com/keitoaino/rails_admin_map_field.git'
+```
+
+Then, add in your `config/initializers/rails_admin.rb` initializer:
+
+```ruby
+RailsAdmin.config do |config|
+  config.model User do
+    edit do
+      field :latitude, :map
+    end
+  end
+end
+```
+
+**Note**: The field which is set as a map-type field must be the latitude field, not the longitude. By default, rails_admin_map_field will guess that the longitude field is called "longitude".
+
+Configuration
+=============
+
+For different configurations, rails_admin_map_field can be configured with the following:
+
+- `longitude_field` - the name of the longitude field that forms the the co-ordinate with the latitude field specified. Defaults to "longitude"
+- `google_api_key` - if you use a Google Maps API Key, it can be specified here.
+- `default_latitude` - the latitude to center the map shown on if the latitude field is blank. Defaults to 51.5, the latitude of London, UK.
+- `default_longitude` - the longitude used if the longitude field is blank. Defaults to -0.126, the longitude of London, UK.
+
+A more complicated configuration example:
+
+```ruby
+RailsAdmin.config do |config|
+  config.model Point do
+    edit do
+      field :lat, :map do
+        longitude_field :lon
+        google_api_key "a1b2c3d4e5f6deadbeef"
+        default_latitude -34.0  # Sydney, Australia
+        default_longitude 151.0
+      end
+    end
+  end
+end
+```
+
+LICENSE
+=======
+rails_admin_map_field is licensed under the MIT license.
+
+Copyright (C) 2011 by Jason Langenauer
+
+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/app/assets/javascript/map.coffee

@@ -0,0 +1,43 @@
+address = document.getElementById window.address
+lat = document.getElementById window.lat
+lng = document.getElementById window.lng
+
+geocoder = new google.maps.Geocoder()
+marker = null
+
+mapOptions = {
+  zoom: 8,
+  mapTypeId: google.maps.MapTypeId.ROADMAP
+}
+
+map_element = document.getElementById 'map'
+map = new google.maps.Map map_element, mapOptions
+
+google.maps.event.addListener map, 'click', (event) ->
+  updateLocation event.latLng
+
+updateLocation = (location, center) ->
+  if marker
+    marker.setPosition location
+  else
+    marker = new google.maps.Marker
+      position: location,
+      map: map
+
+  lat.value = location.lat()
+  lng.value = location.lng()
+
+  if center
+    map.setCenter location
+
+setInterval ->
+  google.maps.event.trigger map, 'resize'
+  , 100
+
+address.addEventListener 'keyup', ->
+  geocoder.geocode {address: this.value}, (results, status) ->
+    if status == google.maps.GeocoderStatus.OK
+      updateLocation results[0].geometry.location, true
+
+
+updateLocation new google.maps.LatLng(lat.value, lng.value), true

data/app/assets/stylesheets/map.css.sass

@@ -0,0 +1,3 @@
+#map
+  width: 500px
+  height: 300px

data/app/views/rails_admin/main/_form_map.html.slim

@@ -0,0 +1,13 @@
+= form.send :text_field, field.address_field, id: field.address_dom_name
+#map
+= form.send :hidden, field.lat_field, id: field.lat_dom_name
+= form.send :hidden, field.lng_field, id: field.lng_dom_name
+
+javascript:
+  window.address = "#{field.address_dom_name}";
+  window.lat = "#{field.lat_dom_name}";
+  window.lng = "#{field.lng_dom_name}";
+
+= javascript_include_tag 'https://maps.googleapis.com/maps/api/js?v=3.exp&sensor=false'
+= javascript_include_tag 'map'
+= stylesheet_link_tag 'map'

data/gem.gemspec

@@ -0,0 +1,31 @@
+# coding: UTF-8
+
+Gem::Specification.new do |s|
+  s.add_development_dependency('devise', '>= 1.1')
+  s.add_development_dependency('rspec-rails', '>= 2.4')
+  s.add_development_dependency('yard', '>= 0.6')
+  s.add_development_dependency('sqlite3')
+  s.add_development_dependency('gmaps4rails')
+
+  # If you add a runtime dependency, please maintain alphabetical order
+  s.add_runtime_dependency('rails', '>= 3.0.0')
+
+  # TODO: uncomment next line when rails_admin gem will be released
+  # s.add_runtime_dependency('rails_admin', '> 0.0.1')
+
+
+  s.name              = "rails_admin_map_field"
+  s.version           = "0.0.1"
+  s.platform          = Gem::Platform::RUBY
+  s.authors           = ["Keito Aino"]
+  s.email             = ["keitoaino@gmail.com"]
+  s.homepage          = "http://github.com/keitoaino/"
+  s.summary           = "Adds a map field using the Google Maps API to rails_admin"
+  s.description       = "A map field for RailsAdmin that can be used to manipulate a latitude/longitude field pair"
+  s.rubyforge_project = s.name
+
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.files             = `git ls-files`.split("\n")
+  s.require_path      = 'lib'
+end

data/lib/rails_admin_map_field/engine.rb

@@ -0,0 +1,7 @@
+require 'rails'
+require 'rails_admin_map_field'
+
+module RailsAdminMapField
+  class Engine < Rails::Engine
+  end
+end

data/lib/rails_admin_map_field/rails_admin/config/fields/types/map.rb

@@ -0,0 +1,42 @@
+module RailsAdmin::Config::Fields::Types
+  class Map < RailsAdmin::Config::Fields::Base
+    RailsAdmin::Config::Fields::Types::register(:map, self)
+
+    def allowed_methods
+      [@name, address_field, lat_field, lng_field]
+    end
+
+    register_instance_option :address_field do
+      :address
+    end
+
+    register_instance_option :lat_field do
+      :lat
+    end
+
+    register_instance_option :lng_field do
+      :lng
+    end
+
+
+    register_instance_option(:partial) do
+      :form_map
+    end
+
+    register_instance_option(:google_api_key) do
+      nil
+    end
+
+    def address_dom_name
+      @dom_name ||= "#{bindings[:form].object_name}_#{address_field}"
+    end
+
+    def lat_dom_name
+      @lat_dom_name ||= "#{bindings[:form].object_name}_#{lat_field}"
+    end
+
+    def lng_dom_name
+      @lng_dom_name ||= "#{bindings[:form].object_name}_#{lng_field}"
+    end
+  end
+end

data/lib/rails_admin_map_field.rb

@@ -0,0 +1,6 @@
+require 'rails_admin'
+require 'rails_admin_map_field/rails_admin/config/fields/types/map'
+load 'rails_admin_map_field/engine.rb'
+
+# load 'rails_admin_map_field/factory.rb'
+

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: rails_admin_map_field
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Keito Aino
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gmaps4rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: A map field for RailsAdmin that can be used to manipulate a latitude/longitude
+  field pair
+email:
+- keitoaino@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- app/assets/javascript/map.coffee
+- app/assets/stylesheets/map.css.sass
+- app/views/rails_admin/main/_form_map.html.slim
+- gem.gemspec
+- lib/rails_admin_map_field.rb
+- lib/rails_admin_map_field/engine.rb
+- lib/rails_admin_map_field/rails_admin/config/fields/types/map.rb
+homepage: http://github.com/keitoaino/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: rails_admin_map_field
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Adds a map field using the Google Maps API to rails_admin
+test_files: []