rails_admin_yamap_field 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b0993ff3f9e0dc7202df5dbe87d40197345e9a89b8f850921d601efe76ea4440
+  data.tar.gz: fe67fdb59d52090f87ae17762cc9a8f7d20f84370719da24eb25845af8b2acd8
+SHA512:
+  metadata.gz: 27ddcf593415c1a4b2ced964392689ce42ff2f8edc0900fdb43dbc07578a7f896e46bbe52c8650a9801d223e066103bd8b9b10c05f48b2a56d599f709a30876a
+  data.tar.gz: 5a30087b047f3121b5795e058fa4c54c0d3f43ad715ee3815dbe9bd64d03be934ed9311ea3cf7b16e124e53f3c3ae15d127ff0639abe11002f3d713c08e37070

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Artem
+
+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,89 @@
+# RailsAdminYamapField
+
+Simple implementation of Yandex maps in rails admin.
+
+Inspired by these projects:
+* [Rails Admin Map Field](https://github.com/beyondthestory/rails_admin_map_field)
+* [RailsAdminGoogleMap](https://github.com/nicovak/rails_admin_google_map)
+* [Rails Admin Place Field](https://github.com/thinkclay/rails_admin_place_field/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_admin_yamap_field'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Usage
+
+Add `attr_accessor ya_map` to you model for which you need to show the map or define
+`ya_map` and `ya_map=` methods as you wish, for example:
+
+```ruby
+class Address < ApplicationRecord
+  # others methods
+  def ya_map=(lat_lon)
+    self[:lat], self[:lon] = lat_lon.split(",")
+  end
+  def ya_map
+    [lat, lon].join(",")
+  end
+  # others methods
+end
+```
+
+### Available options for configure in rails_admin:
+
+* center_lat - map center latitude
+* center_long - map center longitude
+* zoom_level - map zoom level
+* map_html_width - width div map container: default '100%'
+* map_html_height - height div map container: default '500px'
+* map_lang - language map: default 'ru_RU', for other values see [this ref](https://tech.yandex.ru/maps/doc/jsapi/2.1/dg/concepts/load-docpage/#load__param)
+* api_key - api key for enterprise version: default 'nil'
+* latitude_field - latitude attribute name in you model: default 'latitude'
+* longitude_field - longitude attribute name in you model: default 'longitude'
+
+### Example:
+
+```ruby
+class Address < ApplicationRecord
+  attr_accessor :ya_map
+
+  rails_admin do
+    field :lat, :hidden
+    field :lon, :hidden
+    field :ya_map, :yamap_field do
+      map_html_width "600px"
+      latitude_field :lat
+      longitude_field :lon
+     end
+  end
+end
+```
+
+### Screenshot
+
+![Sample screenshot](/wiki/screenshot_1.png)
+
+## References
+
+* [API Yandex map](https://tech.yandex.ru/maps/doc/jsapi/2.1/quick-start/index-docpage/)
+  * [Placemark docpage](https://tech.yandex.ru/maps/doc/jsapi/2.1/ref/reference/Placemark-docpage/)
+* [API Yandex map. DragEnd event](https://yandex.ru/blog/mapsapi/24027)
+* [Create custom field in rails_admin](https://github.com/sferik/rails_admin/wiki/Custom-field)
+  * [rails_admin base field class](https://github.com/sferik/rails_admin/blob/master/lib/rails_admin/config/fields/base.rb)
+
+## Contributing
+
+Feel free to send pull requests or write issue.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,19 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RailsAdminYamapField'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'

data/app/views/rails_admin/main/_form_yamap_field.html.haml

@@ -0,0 +1,45 @@
+= render 'yamap_field', field: field
+= form.send field.view_helper, field.method_name, field.html_attributes
+
+:javascript
+  function errorMap(error) {
+    console.log("Error in loading Yandex map!");
+    console.log(error);
+  }
+
+  function initMap(ymaps){
+    var mapCenterLat = "#{field.center_lat}";
+    var mapCenterLong = "#{field.center_long}";
+    var zoomLevel = "#{field.zoom_level}";
+    var yaMap = new ymaps.Map("yamap_field", {
+        center: [mapCenterLat, mapCenterLong],
+        zoom: zoomLevel
+    });
+
+    var lat = "#{field.bindings[:object].send(field.latitude_field)}";
+    var long = "#{field.bindings[:object].send(field.longitude_field)}";
+    var myPlacemark = new ymaps.Placemark([lat, long], {}, {
+      preset: 'islands#redDotIcon',
+      draggable: true
+    });
+    yaMap.geoObjects.add(myPlacemark);
+
+    function setCoordinates(position) {
+      //console.log(position);
+      //console.log($("##{field.latitude_dom_name}"));
+      $("##{field.dom_name}").val(position.join(","));
+      $("##{field.latitude_dom_name}").val(position[0]);
+      $("##{field.longitude_dom_name}").val(position[1]);
+    }
+
+    yaMap.events.add('click', function(e) {
+      var position = e.get('coords');
+      myPlacemark.geometry.setCoordinates(position);
+      setCoordinates(position);
+    });
+
+    myPlacemark.events.add('dragend', function(e) {
+      var position = myPlacemark.geometry.getCoordinates();
+      setCoordinates(position);
+    });
+  }

data/app/views/rails_admin/main/_show_yamap_field.html.haml

@@ -0,0 +1,22 @@
+= render 'yamap_field', field: field
+
+:javascript
+  function errorMap(error) {
+    console.log("Error in loading Yandex map!");
+    console.log(error);
+  }
+
+  function initMap(ymaps){
+    var mapCenterLat = "#{field.center_lat}";
+    var mapCenterLong = "#{field.center_long}";
+    var zoomLevel = "#{field.zoom_level}";
+    var yaMap = new ymaps.Map("yamap_field", {
+        center: [mapCenterLat, mapCenterLong],
+        zoom: zoomLevel
+    });
+
+    var lat = "#{field.bindings[:object].send(field.latitude_field)}";
+    var long = "#{field.bindings[:object].send(field.longitude_field)}";
+    var myPlacemark = new ymaps.Placemark([lat, long]);
+    yaMap.geoObjects.add(myPlacemark);
+  }

data/app/views/rails_admin/main/_yamap_field.html.haml

@@ -0,0 +1,3 @@
+= javascript_include_tag field.javascript_url
+
+%div{id: "yamap_field", style: "width: #{field.map_html_width}; height: #{field.map_html_height}"}

data/lib/rails_admin_yamap_field.rb

@@ -0,0 +1,109 @@
+require "rails_admin_yamap_field/engine"
+
+module RailsAdminYamapField
+end
+
+require 'rails_admin/config/fields'
+require 'rails_admin/config/fields/base'
+
+module RailsAdmin
+  module Config
+    module Fields
+      module Types
+        class YamapField < RailsAdmin::Config::Fields::Base
+          RailsAdmin::Config::Fields::Types::register(self)
+
+          register_instance_option(:partial) do
+            :form_yamap_field
+          end
+
+          register_instance_option(:formatted_value) do
+            if bindings[:controller].action_name == "show"
+              bindings[:view].render "rails_admin/main/show_yamap_field", field: self
+            else
+              value
+            end
+          end
+
+          # If the point is presented, she is the center of the map
+          # else center of the map 0 km in Moscow
+          register_instance_option(:center_lat) do
+            bindings[:object].send(self.latitude_field) || 55.767461
+          end
+
+          register_instance_option(:center_long) do
+            bindings[:object].send(self.longitude_field) || 37.631422
+          end
+
+          register_instance_option(:zoom_level) do
+            7
+          end
+
+          register_instance_option(:map_html_width) do
+            '100%'
+          end
+          register_instance_option(:map_html_height) do
+            '500px'
+          end
+          register_instance_option(:map_lang) do
+             'ru_RU'
+          end
+          register_instance_option(:api_key) do
+            nil
+          end
+
+          register_instance_option(:latitude_field) do
+            :latitude
+          end
+
+          register_instance_option(:longitude_field) do
+            :longitude
+          end
+
+          def dom_name
+            # @dom_name ||= "#{bindings[:form].try(:object_name)}_#{name}"
+            #               .gsub /\[|\]\[|\]_|\]/, "_"
+            bindings[:form].instance_variable_get(:@dom_id)[:"#{name}"]
+          end
+
+          def latitude_dom_name
+            # @lat_dom_name ||= "#{bindings[:form].try(:object_name)}_#{latitude_field}"
+            #                   .gsub /\[|\]\[|\]_|\]/, "_"
+            bindings[:form].instance_variable_get(:@dom_id)[:"#{latitude_field}"]
+          end
+
+          def longitude_dom_name
+            # @lon_dom_name ||= "#{bindings[:form].try(:object_name)}_#{longitude_field}"
+            #                   .gsub /\[|\]\[|\]_|\]/, "_"
+            bindings[:form].instance_variable_get(:@dom_id)[:"#{longitude_field}"]
+          end
+
+          def javascript_url
+            return @javascript_url if @javascript_url.present?
+            api_key = api_key.present? ? "&apikey=#{field.api_key}" : ""
+            host = if api_key.present?
+              "enterprise.api-maps.yandex.ru"
+            else
+              "api-maps.yandex.ru"
+            end
+            @javascript_url = "https://#{host}/2.1/?lang=#{map_lang}" \
+                              "&onload=initMap&onerror=errorMap#{api_key}"
+          end
+
+        end
+      end
+    end
+  end
+end
+
+RailsAdmin::Config::Fields.register_factory do |parent, properties, fields|
+  # puts parent, properties, fields
+  # if properties[:name] == :yamap_field
+  #   fields << RailsAdmin::Config::Fields::Types::YamapField.new(parent, properties[:name], properties)
+  #   true
+  # else
+  #   false
+  # end
+end
+
+

data/lib/rails_admin_yamap_field/engine.rb

@@ -0,0 +1,4 @@
+module RailsAdminYamapField
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/rails_admin_yamap_field/version.rb

@@ -0,0 +1,3 @@
+module RailsAdminYamapField
+  VERSION = '0.1.2'
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: rails_admin_yamap_field
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Artem Yegorov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+description: Simple implementation of Yandex maps in rails admin.
+email:
+- yegorov0725@yandex.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/views/rails_admin/main/_form_yamap_field.html.haml
+- app/views/rails_admin/main/_show_yamap_field.html.haml
+- app/views/rails_admin/main/_yamap_field.html.haml
+- lib/rails_admin_yamap_field.rb
+- lib/rails_admin_yamap_field/engine.rb
+- lib/rails_admin_yamap_field/version.rb
+- wiki/screenshot_1.png
+homepage: https://github.com/yegorov/rails_admin_yamap_field
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Simple implementation of Yandex maps in rails admin.
+test_files: []