administrate-field-lat_lng 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd05f2c706f9d1a5ae17d96579c12b349c4230be
+  data.tar.gz: a07039d2a865715cc923912acc850250b05c34ff
+SHA512:
+  metadata.gz: f5ab5557ff5a31e1cccff462f9c5b17fb07da9f06780b9ddccf1b15f40bc45513e14c749f8054a296302464a248f5a4ae5cfe6468b560539976077a545592dbe
+  data.tar.gz: a939b9f777e3c8c53ed6daf77235cf7822a240b9b1a8e3bc008f8f3e0db44a356d5ad625bf3952b1f6a9687642b92122c731a394477db506c5ce79bdf7b56232

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.3.1
+  - 2.2.5
+  - 2.1.9
+before_install: gem install bundler -v 1.12.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at rich@fishpercolator.co.uk. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in administrate-field-select.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Rich Daley
+
+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

@@ -0,0 +1,68 @@
+# Administrate::Field::LatLng
+
+Adds fields for displaying/editing latitude/longitude fields on a map to ThoughtBot's [Administrate](https://github.com/thoughtbot/administrate)
+
+[![Gem Version](https://img.shields.io/gem/v/administrate-field-lat_lng.svg?style=flat)](https://rubygems.org/gems/administrate-field-lat_lng)
+[![Build Status](https://img.shields.io/travis/fishpercolator/administrate-field-lat_lng/master.svg?style=flat)](https://travis-ci.org/fishpercolator/administrate-field-lat_lng)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'administrate-field-lat_lng'
+```
+
+And then execute:
+
+    $ bundle
+
+**Note for Administrate 0.2.0 users**: This gem depends on Administrate's `content_for :stylesheet` which, at the time of writing, has not yet been released. If 0.2.0 is still the latest version, you'll want to update your Gemfile to point at the bleeding-edge of Administrate:
+
+```ruby
+gem 'administrate', '~> 0.2.0', github: 'thoughtbot/administrate'
+```
+
+## Usage
+
+In your dashboard's `ATRRIBUTE_TYPES`, use the type `Field::LatLng` with options:
+
+```ruby
+ATTRIBUTE_TYPES = {
+  lat: Field::LatLng,
+  lng: Field::LatLng,
+}
+```
+
+On show pages, you will now see a map directly below the `lng` field, which shows the location on a map. On edit pages, you can click this map to change the values of `lat` and `lng` in the form.
+
+**Important**: Your `lat` and `lng` fields must appear in the right order (`lat` first) in `SHOW_PAGE_ATTRIBUTES` and `FORM_ATTRIBUTES`. This is because each field generates a piece of the final javascript so they must be evaluated in the correct order.
+
+If your fields are not called `lat` and `lng`, you must specify options to make it clear which is which, e.g.:
+
+```ruby
+ATTRIBUTE_TYPES = {
+  latitude:  Field::LatLng.with_options({lat: true}),
+  longitude: Field::LatLng.with_options({lng: true}),
+}
+```
+
+Additional options that are available:
+
+* `initial`: Set to an array like `[53.8003,-1.5519]`. Will cause the center of the map to be this point if the lat/lng have not yet been set (e.g. for new records). Defaults to Leeds, UK (because that's where the author is from).
+* `zoom`: Set the default zoom level for maps drawn (defaults to 11).
+
+## Usage notes
+
+This gem depends on being able to access `cdn.leafletjs.com` for the Leaflet JS and CSS. Let me know if you want this to change and be based on the asset pipeline.
+
+Currently you can only have one pair of lat/lng per model type. Supporting multiple pairs would not be hard, so let me know if you need that functionality.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fishpercolator/administrate-field-lat_lng. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/administrate-field-lat_lng.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "administrate-field-lat_lng"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Rich Daley"]
+  spec.email         = ["rich@fishpercolator.co.uk"]
+
+  spec.summary       = %q{Administrate field for latitude/longitude}
+  spec.description   = %q{Adds an Administrate::Field::LatLng for viewing & editing latitude/longitude fields on a map}
+  spec.homepage      = "https://github.com/fishpercolator/administrate-field-lat_lng"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'administrate', '~> 0.2.0'
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.10.3"
+end

data/app/views/fields/lat_lng/_form.html.erb

@@ -0,0 +1,9 @@
+<%= render 'fields/lat_lng/includes' if field.lng? %>
+<div class="field-unit__label">
+  <%= f.label field.attribute %>
+</div>
+<div class="field-unit__field">
+  <%= f.text_field field.attribute, class: "latlng-#{field.which}" %>
+</div>
+<%= render 'fields/lat_lng/var', field: field %>
+<%= render 'fields/lat_lng/map', edit: true, field: field if field.lng? %>

data/app/views/fields/lat_lng/_includes.html.erb

@@ -0,0 +1,23 @@
+<% content_for :stylesheet do %>
+  <link rel="stylesheet" href="<%= Administrate::Field::LatLng::CSS_URL %>" />
+  <style text="text/css">
+  .field-unit {
+    flex-flow: row wrap;
+  }
+  .map-container {
+    clear: both;
+    width: 100%;
+  }
+  #latlngmap {
+    margin-top: 1.5em;
+    width: 500px;
+    height: 500px;
+  }
+  .field-unit #latlngmap {
+    margin-left: 17.0596086%;
+  }
+  </style>
+<% end %> 
+<% content_for :javascript do %>
+  <script src="<%= Administrate::Field::LatLng::JS_URL %>"></script>
+<% end %>

data/app/views/fields/lat_lng/_index.html.erb

@@ -0,0 +1 @@
+<%= field.to_s %>

data/app/views/fields/lat_lng/_map.html.erb

@@ -0,0 +1,44 @@
+<div class="map-container">
+  <div id="latlngmap"></div>
+</div>
+<% content_for :javascript do %>
+  <script type="text/javascript">
+    // Attach a leaflet.js map to the div above
+    var map = L.map('latlngmap');
+    var osm = new L.TileLayer('https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png', {
+      attribution: 'Map data © <a href="http://openstreetmap.org">OpenStreetMap</a> contributors'
+    });
+    map.addLayer(osm);
+    
+    // Get the centre lat/lng from the field or the initial default if the field
+    // hasn't been set yet
+    var latlng = [];
+    if (lng === undefined) {
+      latlng = <%= field.initial.to_json %>;
+    } else {
+      latlng = [lat, lng];
+    }
+    map.setView(latlng, <%= field.zoom %>);
+    
+    // Add a marker if the field has been set already
+    var marker;
+    if (lng !== undefined) {
+      marker = L.marker(latlng);
+      marker.addTo(map);
+    }
+    <% if edit %>
+    // In edit mode, move the marker and update the fields when a user clicks
+    // inside the map
+    map.on('click', function (e) {
+      if (marker === undefined) {
+        marker = L.marker(e.latlng);
+        marker.addTo(map);
+      } else {
+        marker.setLatLng(e.latlng);
+      }
+      $('.latlng-lat').val(e.latlng.lat);
+      $('.latlng-lng').val(e.latlng.lng);
+    });
+    <% end %>
+  </script>
+<% end %>

data/app/views/fields/lat_lng/_show.html.erb

@@ -0,0 +1,4 @@
+<%= render 'fields/lat_lng/includes' if field.lat? %>
+<%= field.to_s %>
+<%= render 'fields/lat_lng/var', field: field %>
+<%= render 'fields/lat_lng/map', edit: false, field: field if field.lng? %>

data/app/views/fields/lat_lng/_var.html.erb

@@ -0,0 +1,5 @@
+<% content_for :javascript do %>
+  <script type="text/javascript">
+    var <%= field.which %> = <%= field.data || 'undefined' %>;
+  </script>
+<% end %>

data/lib/administrate/field/lat_lng.rb

@@ -0,0 +1,44 @@
+require 'administrate/field/base'
+require 'rails'
+
+module Administrate
+  module Field
+    class LatLng < Base
+      class Engine < ::Rails::Engine
+      end
+      
+      JS_URL  = "http://cdn.leafletjs.com/leaflet/v0.7.7/leaflet.js"
+      CSS_URL = "http://cdn.leafletjs.com/leaflet/v0.7.7/leaflet.css"
+      
+      # True if the :lat option has been provided, or field is called :lat
+      def lat?
+        options.fetch(:lat, attribute == :lat)
+      end
+  
+      # True if the :lng option has been provided, or field is called :lng
+      def lng?
+        options.fetch(:lng, attribute == :lng)
+      end
+      
+      # Returns :lat or :lng depending on which type this is
+      def which
+        lat? ? :lat : :lng
+      end
+      
+      # Returns the initial co-ordinates of blank maps (defaults to Leeds, UK)
+      def initial
+        options.fetch(:initial, [53.8003,-1.5519])
+      end
+      
+      # Returns the initial zoom level for maps (defaults to 11)
+      def zoom
+        options.fetch(:zoom, 11)
+      end
+      
+      def to_s
+        data
+      end
+      
+    end
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: administrate-field-lat_lng
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Rich Daley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: administrate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+description: Adds an Administrate::Field::LatLng for viewing & editing latitude/longitude
+  fields on a map
+email:
+- rich@fishpercolator.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- administrate-field-lat_lng.gemspec
+- app/views/fields/lat_lng/_form.html.erb
+- app/views/fields/lat_lng/_includes.html.erb
+- app/views/fields/lat_lng/_index.html.erb
+- app/views/fields/lat_lng/_map.html.erb
+- app/views/fields/lat_lng/_show.html.erb
+- app/views/fields/lat_lng/_var.html.erb
+- lib/administrate/field/lat_lng.rb
+homepage: https://github.com/fishpercolator/administrate-field-lat_lng
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Administrate field for latitude/longitude
+test_files: []