jekyll-maps 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c779e67a99b76a3655d973fd5671d068d0709d7a
-  data.tar.gz: f5a9d0b3a557ec8c00cd7193b592b9c4f384fbfc
+  metadata.gz: 2a74fcbcd8ef290f24136b57ed4c40426c8dcbbb
+  data.tar.gz: 6efa49c7799005c02fd2c9871bf57bb8248fe20f
 SHA512:
-  metadata.gz: fd731507ed453f4f7d097f615a1373b8d3ed37fa6e2e9207e2bf996d27fce64d2790f633fb6c55f0bc2856fe5c8d995bc8f6643c202c9341522ad06a637c861e
-  data.tar.gz: 0b4c9c70d6894ea3354da45fa0f02050e8abde7d4dad9c9e618f20b8aa9daa9ca5c79a9670b8e7e143d358265e822080b517aa73ffdf10fe4c0658489033705c
+  metadata.gz: eb263df2652df18d22ab3c1e45bcdf2e4970f66c00f12bbb06278883b4cba1e6fffcf2b5a3225916448550fa21f8989fe9fef1ce0e2fc4a62894e40fdaf3d534
+  data.tar.gz: f32958144f5e1b24ea21d63dba885dc6ab2e44eab3f2066295c95bbbf7f9e026f3f8471fed452e77a16c580683b4a9d5e513a6d6a2f8b556e656dbc65e480ac1

data/History.md

@@ -1,3 +1,7 @@
+## 1.1.2 / 2016-07-22
+
+* configurable marker cluster
+
 ## 1.1.1 / 2016-07-20
 
 * configure GoogleMaps API key from _config.yml

data/README.md

@@ -6,7 +6,10 @@
 [![Test Coverage](https://codeclimate.com/github/ayastreb/jekyll-maps/badges/coverage.svg)](https://codeclimate.com/github/ayastreb/jekyll-maps/coverage)
 [![Dependency Status](https://gemnasium.com/badges/github.com/ayastreb/jekyll-maps.svg)](https://gemnasium.com/github.com/ayastreb/jekyll-maps)
 
-Easily embed Google Maps with locations from your Jekyll posts, pages or data files.
+Jekyll Maps is a plugin that allows you to easily create different maps on your Jekyll site pages.
+It allows you to select which points to display on the map with different filters.
+
+GoogleMaps Marker Clusterer can be used if you have many points within close proximity.
 
 ## Installation
 
@@ -25,6 +28,8 @@ Easily embed Google Maps with locations from your Jekyll posts, pages or data fi
 
 ## Usage
 
+### Data Source
+
 First, add location information to your posts YAML front-matter:
 
   ```yml
@@ -60,17 +65,42 @@ You can configure map's dimensions and assign custom CSS class to the element:
   ```
   {% google_map width:100% height:400 class:my-map %}
   ```
+  
+### Filters
 
-You can also filter which locations to display on the map!
-
-For instance, following tag will only display points from documents which have `lang: en` in their front-matter data.
+You can also filter which locations to display on the map!<br/>
+For instance, following tag will only display locations from documents which have `lang: en` in their front-matter data.
 
   ```
   {% google_map lang:en %}
   ```
 
+### Marker Cluster
+
+By default [Marker Clusterer](https://github.com/googlemaps/js-marker-clusterer) is enabled.
+If you have many markers on the map, it will group them and show icon with the count of markers in each cluster - [See example](https://googlemaps.github.io/js-marker-clusterer/examples/advanced_example.html)
+
+If you don't want to use marker cluster, you can disable it globally in `_config.yml`:
+
+  ```yml
+  maps:
+    google:
+      marker_cluster:
+        enabled: false
+  ```
+
+Or you can disable it per single map tag:
+
+  ```
+  {% google_map no_cluster %}
+  ```
+
 If you have any questions or proposals - open up an [issue](https://github.com/ayastreb/jekyll-maps/issues/new)!
 
+## Examples
+
+Want to see it in action? Check out [Demo Page](https://ayastreb.github.io/jekyll-maps/#examples)!
+
 ## Contributing
 
 1. Fork it (https://github.com/ayastreb/jekyll-maps/fork)

data/jekyll-maps.gemspec

@@ -19,6 +19,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "jekyll", "~> 3.0"
 
   spec.add_development_dependency "rake", "~> 11.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec", "~> 3.5"
   spec.add_development_dependency "rubocop", "~> 0.41"
 end

data/lib/jekyll-maps/google_map_api.js

@@ -29,9 +29,10 @@ var jekyllMaps = (function () {
      *
      * @param String id
      * @param Array locations
+     * @param Boolean useCluster
      */
-    function register(id, locations) {
-        this.data.push({id: id, locations: locations});
+    function register(id, locations, useCluster) {
+        this.data.push({id: id, locations: locations, useCluster: useCluster});
         this.render();
     }
 
@@ -48,8 +49,10 @@ var jekyllMaps = (function () {
                 markers = data.locations.map(createMarker);
 
             map.fitBounds(bounds);
-            this.maps.push({map: map, markers: markers});
-            this.processCluster();
+            if (data.useCluster) {
+                this.maps.push({map: map, markers: markers});
+                this.processCluster();
+            }
         }
 
         function createMarker(location) {
@@ -70,8 +73,9 @@ var jekyllMaps = (function () {
         }
     }
 
-    function initializeCluster() {
+    function initializeCluster(settings) {
         this.clusterReady = true;
+        this.clusterSettings = settings || {};
         this.processCluster();
     }
 
@@ -81,7 +85,7 @@ var jekyllMaps = (function () {
         while (this.maps.length > 0) {
             var obj = this.maps.pop();
             new MarkerClusterer(obj.map, obj.markers, {
-                gridSize: 25,
+                gridSize: this.clusterSettings.grid_size || 25,
                 imagePath: 'https://cdn.rawgit.com/googlemaps/js-marker-clusterer/gh-pages/images/m'
             });
         }

data/lib/jekyll-maps/google_map_api.rb

@@ -16,14 +16,34 @@ module Jekyll
 
         private
         def api_code
-          api_key = @config.fetch("maps", {}).fetch("google", {}).fetch("api_key", "")
           <<HTML
 <script type='text/javascript'>
   #{js_lib_contents}
 </script>
+#{load_google_maps_api}
+#{load_marker_cluster}
+HTML
+        end
+
+        private
+        def load_google_maps_api
+          api_key = @config.fetch("maps", {})
+            .fetch("google", {})
+            .fetch("api_key", "")
+          <<HTML
 <script async defer src='https://maps.googleapis.com/maps/api/js?key=#{api_key}&callback=jekyllMaps.initializeMap'></script>
+HTML
+        end
+
+        private
+        def load_marker_cluster
+          settings = @config.fetch("maps", {})
+            .fetch("google", {})
+            .fetch("marker_cluster", {})
+          return unless settings.fetch("enabled", true)
+          <<HTML
 <script async defer src='https://cdn.rawgit.com/googlemaps/js-marker-clusterer/gh-pages/src/markerclusterer.js'
-        onload='jekyllMaps.initializeCluster()'></script>
+        onload='jekyllMaps.initializeCluster(#{settings.to_json})'></script>
 HTML
         end
 

data/lib/jekyll-maps/google_map_tag.rb

@@ -13,12 +13,13 @@ module Jekyll
 
       def render(context)
         locations               = @finder.find(context.registers[:site])
+        use_cluster             = @args[:flags][:no_cluster] ? "false" : "true"
         @args[:attributes][:id] ||= SecureRandom.uuid
 
         <<HTML
 <div #{render_attributes}></div>
 <script type='text/javascript'>
-  #{JS_LIB_NAME}.register('#{@args[:attributes][:id]}', #{locations.to_json});
+  #{JS_LIB_NAME}.register('#{@args[:attributes][:id]}', #{locations.to_json}, #{use_cluster});
 </script>
 HTML
       end

data/lib/jekyll-maps/options_parser.rb

@@ -2,6 +2,9 @@ module Jekyll
   module Maps
     class OptionsParser
       OPTIONS_SYNTAX     = %r!([^\s]+)\s*:\s*([^\s]+)!
+      ALLOWED_FLAGS      = %w(
+        no_cluster
+      ).freeze
       ALLOWED_ATTRIBUTES = %w(
         id
         width
@@ -13,7 +16,8 @@ module Jekyll
         def parse(raw_options)
           options = {
             :attributes => {},
-            :filters    => {}
+            :filters    => {},
+            :flags      => {}
           }
           raw_options.scan(OPTIONS_SYNTAX).each do |key, value|
             value = value.split(",") if value.include?(",")
@@ -23,6 +27,9 @@ module Jekyll
               options[:filters][key] = value
             end
           end
+          ALLOWED_FLAGS.each do |key|
+            options[:flags][key.to_sym] = true if raw_options.include?(key)
+          end
           options
         end
       end

data/lib/jekyll-maps/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Maps
-    VERSION = "1.1.1".freeze
+    VERSION = "1.1.2".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-maps
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Anatoliy Yastreb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-20 00:00:00.000000000 Z
+date: 2016-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement