jekyll-maps 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d991367839c14b8f67ff64821219fc0ebcf9290
-  data.tar.gz: ab2ab30d54e9f1ed120f377f0350cc53d5f52d12
+  metadata.gz: 0e93f2ab559d3a815471eb4785a05b30239a88b7
+  data.tar.gz: 742dd19383883194546ff1d121ef1bce0209c28e
 SHA512:
-  metadata.gz: 34ee237acea3325e5c7fa62defb1f41b829586bafa05135c917cd54e8ab085fe98fdf177cd1f1299b8467843777c24662ad841331cabe119e94371310538ec62
-  data.tar.gz: e31ce264d925ae834ae80e0ae9fb2e0b8b1cee5ab15cf94bd1a38c0e4d0b074521aa2f3095c1f1cb619304c470d52b206df9317ae8377ad831fa8a5ecf1a4bfb
+  metadata.gz: 16e36155f5f2f59d08b2e6a93dd2378aade5d95897a161b6849778b86c41c08916f06e0b38d3dec349c99a86f4120eb2604ed7a44682562dc2143c4dfb03be69
+  data.tar.gz: 0b203611ebfef3cf6f7d970ae5bc81dcb62b0e653c6eb3157357978569fa30283e091b8b2d5391b226c98f6d9a178c3b19fdbbcfd9e79f93831c9c43457fb90b

data/.codeclimate.yml

@@ -0,0 +1,26 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+      - javascript
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+  eslint:
+    enabled: true
+ratings:
+  paths:
+  - "**.inc"
+  - "**.js"
+  - "**.jsx"
+  - "**.module"
+  - "**.php"
+  - "**.py"
+  - "**.rb"
+exclude_paths:
+- script/
+- spec/

data/History.md

@@ -1,3 +1,9 @@
+## 1.1.0 / 2016-07-19
+
+* add multiple maps to single page
+* load external JavaScript asynchronously
+* configure map element's id, CSS class and dimensions
+
 ## 1.0.2 / 2016-07-18
 
 * fix script loading

data/README.md

@@ -4,5 +4,6 @@
 [![Build Status](https://travis-ci.org/ayastreb/jekyll-maps.svg?branch=master)](https://travis-ci.org/ayastreb/jekyll-maps)
 [![Code Climate](https://codeclimate.com/github/ayastreb/jekyll-maps/badges/gpa.svg)](https://codeclimate.com/github/ayastreb/jekyll-maps)
 [![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)
 
 Google Maps support in Jekyll blog to easily embed maps with posts' locations

data/jekyll-maps.gemspec

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

data/lib/jekyll-maps/google_map_api.js

@@ -0,0 +1,89 @@
+var jekyllMaps = (function () {
+    'use strict';
+
+    return {
+        data: [],
+        maps: [],
+        initializeMap: initializeMap,
+        initializeCluster: initializeCluster,
+        register: register,
+        render: render,
+        processCluster: processCluster
+    };
+
+    /**
+     * Setup Google Maps options and call renderer.
+     */
+    function initializeMap() {
+        this.options = {
+            mapTypeId: google.maps.MapTypeId.ROADMAP,
+            center: new google.maps.LatLng(0, 0),
+            zoom: 3
+        }
+        this.mapReady = true;
+        this.render();
+    }
+
+    /**
+     * Register map data to be rendered once Google Maps API is loaded.
+     *
+     * @param String id
+     * @param Array locations
+     */
+    function register(id, locations) {
+        this.data.push({id: id, locations: locations});
+        this.render();
+    }
+
+    /**
+     * Render maps data if Google Maps API is loaded.
+     */
+    function render() {
+        if (!this.mapReady) return;
+
+        while (this.data.length > 0) {
+            var data = this.data.pop(),
+                bounds = new google.maps.LatLngBounds(),
+                map = new google.maps.Map(document.getElementById(data.id), this.options),
+                markers = data.locations.map(createMarker);
+
+            map.fitBounds(bounds);
+            this.maps.push({map: map, markers: markers});
+            this.processCluster();
+        }
+
+        function createMarker(location) {
+            var position = new google.maps.LatLng(location.latitude, location.longitude),
+                marker = new google.maps.Marker({
+                    position: position,
+                    title: location.title,
+                    url: location.url,
+                    map: map
+                });
+
+            bounds.extend(position);
+            marker.addListener('click', function () {
+                window.location.href = this.url
+            });
+
+            return marker;
+        }
+    }
+
+    function initializeCluster() {
+        this.clusterReady = true;
+        this.processCluster();
+    }
+
+    function processCluster() {
+        if (!this.clusterReady) return;
+
+        while (this.maps.length > 0) {
+            var obj = this.maps.pop();
+            new MarkerClusterer(obj.map, obj.markers, {
+                gridSize: 25,
+                imagePath: 'https://cdn.rawgit.com/googlemaps/js-marker-clusterer/gh-pages/images/m'
+            });
+        }
+    }
+}());

data/lib/jekyll-maps/google_map_api.rb

@@ -0,0 +1,50 @@
+module Jekyll
+  module Maps
+    class GoogleMapApi
+      HEAD_END_TAG = %r!</.*head.*>!
+
+      class << self
+        def prepend_api_code(doc)
+          if doc.output =~ HEAD_END_TAG
+            # Insert API code before header's end if this document has one.
+            doc.output.gsub!(HEAD_END_TAG, %(#{api_code}#{Regexp.last_match}))
+          else
+            doc.output.prepend(api_code)
+          end
+        end
+
+        private
+        def api_code
+          <<HTML
+<script type='text/javascript'>
+  #{js_lib_contents}
+</script>
+<script async defer src='https://maps.googleapis.com/maps/api/js?callback=jekyllMaps.initializeMap'></script>
+<script async defer src='https://cdn.rawgit.com/googlemaps/js-marker-clusterer/gh-pages/src/markerclusterer.js'
+        onload='jekyllMaps.initializeCluster()'></script>
+HTML
+        end
+
+        private
+        def js_lib_contents
+          @js_lib_contents ||= begin
+            File.read(js_lib_path)
+          end
+        end
+
+        private
+        def js_lib_path
+          @js_lib_path ||= begin
+            File.expand_path("./google_map_api.js", File.dirname(__FILE__))
+          end
+        end
+      end
+    end
+  end
+end
+
+Jekyll::Hooks.register [:pages, :documents], :post_render do |doc|
+  if doc.output =~ %r!#{Jekyll::Maps::GoogleMapTag::JS_LIB_NAME}!
+    Jekyll::Maps::GoogleMapApi.prepend_api_code(doc)
+  end
+end

data/lib/jekyll-maps/google_map_tag.rb

@@ -1,35 +1,51 @@
 module Jekyll
   module Maps
     class GoogleMapTag < Liquid::Tag
+      JS_LIB_NAME        = "jekyllMaps".freeze
+      DEFAULT_MAP_WIDTH  = 600
+      DEFAULT_MAP_HEIGHT = 400
+
       def initialize(_, args, _)
-        options = OptionsParser.parse(args)
-        @finder = LocationFinder.new(options)
+        @args   = OptionsParser.parse(args)
+        @finder = LocationFinder.new(@args)
         super
       end
 
       def render(context)
-        template.render!({
-          "locations" => @finder.find(context.registers[:site]).to_json
-        })
+        locations               = @finder.find(context.registers[:site])
+        @args[:attributes][:id] ||= SecureRandom.uuid
+
+        <<HTML
+<div #{render_attributes}></div>
+<script type='text/javascript'>
+  #{JS_LIB_NAME}.register('#{@args[:attributes][:id]}', #{locations.to_json});
+</script>
+HTML
       end
 
       private
-      def template
-        @template ||= Liquid::Template.parse(template_contents)
+      def render_attributes
+        attributes = []
+        attributes << "id='#{@args[:attributes][:id]}'"
+        attributes << render_dimensions
+        attributes << render_class if @args[:attributes][:class]
+        attributes.join(" ")
       end
 
       private
-      def template_contents
-        @template_contents ||= begin
-          File.read(template_path)
-        end
+      def render_dimensions
+        width       = @args[:attributes][:width] || DEFAULT_MAP_WIDTH
+        height      = @args[:attributes][:height] || DEFAULT_MAP_HEIGHT
+        width_unit  = width.to_s.include?("%") ? "" : "px"
+        height_unit = height.to_s.include?("%") ? "" : "px"
+        %(style='width:#{width}#{width_unit};height:#{height}#{height_unit};')
       end
 
       private
-      def template_path
-        @template_path ||= begin
-          File.expand_path("./google_map.html", File.dirname(__FILE__))
-        end
+      def render_class
+        css = @args[:attributes][:class]
+        css = css.join(" ") if css.is_a?(Array)
+        %(class='#{css}')
       end
     end
   end

data/lib/jekyll-maps/location_finder.rb

@@ -2,29 +2,29 @@ module Jekyll
   module Maps
     class LocationFinder
       def initialize(options)
-        @options = options
+        @documents = []
+        @options   = options
       end
 
       def find(site)
-        matching_documents(site).map do |document|
+        site.collections.each { |_, collection| filter(collection.docs) }
+        site.data.each { |_, docs| filter(docs) }
+
+        @documents.map do |document|
           {
             :latitude  => document["location"]["latitude"],
             :longitude => document["location"]["longitude"],
             :title     => document["title"],
-            :url       => document.url
+            :url       => document["url"] || document.url
           }
         end
       end
 
       private
-      def matching_documents(site)
-        documents = []
-        site.collections.each do |_, collection|
-          collection.docs.each do |doc|
-            documents << doc if location?(doc) && match_filters?(doc)
-          end
+      def filter(docs)
+        docs.each do |doc|
+          @documents << doc if location?(doc) && match_filters?(doc)
         end
-        documents
       end
 
       private

data/lib/jekyll-maps/options_parser.rb

@@ -1,14 +1,27 @@
 module Jekyll
   module Maps
     class OptionsParser
+      OPTIONS_SYNTAX     = %r!([^\s]+)\s*:\s*([^\s]+)!
+      ALLOWED_ATTRIBUTES = %w(
+        id
+        width
+        height
+        class
+      ).freeze
+
       class << self
         def parse(raw_options)
-          options = { :filters => {} }
-          raw_options.strip.split(" ").each do |pair|
-            key   = pair.split(":").first.strip
-            value = pair.split(":").last.strip
+          options = {
+            :attributes => {},
+            :filters    => {}
+          }
+          raw_options.scan(OPTIONS_SYNTAX).each do |key, value|
             value = value.split(",") if value.include?(",")
-            options[:filters][key] = value
+            if ALLOWED_ATTRIBUTES.include?(key)
+              options[:attributes][key.to_sym] = value
+            else
+              options[:filters][key] = value
+            end
           end
           options
         end

data/lib/jekyll-maps/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Maps
-    VERSION = "1.0.2".freeze
+    VERSION = "1.1.0".freeze
   end
 end

data/lib/jekyll-maps.rb

@@ -1,3 +1,5 @@
+require "securerandom"
+require "jekyll-maps/google_map_api"
 require "jekyll-maps/google_map_tag"
 require "jekyll-maps/location_finder"
 require "jekyll-maps/options_parser"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-maps
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Anatoliy Yastreb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-18 00:00:00.000000000 Z
+date: 2016-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -73,6 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -83,7 +84,8 @@ files:
 - Rakefile
 - jekyll-maps.gemspec
 - lib/jekyll-maps.rb
-- lib/jekyll-maps/google_map.html
+- lib/jekyll-maps/google_map_api.js
+- lib/jekyll-maps/google_map_api.rb
 - lib/jekyll-maps/google_map_tag.rb
 - lib/jekyll-maps/location_finder.rb
 - lib/jekyll-maps/options_parser.rb

data/lib/jekyll-maps/google_map.html

@@ -1,53 +0,0 @@
-<div id='google-map'></div>
-
-<script type='text/javascript'>
-  var jekyllMaps = (function () {
-    'use strict';
-
-    return {
-      loadScript: function (url) {
-        var script = document.createElement('script');
-        script.type = 'text/javascript';
-        script.src = url;
-        document.body.appendChild(script);
-      },
-      initialize: function () {
-        this.options = {
-          center: new google.maps.LatLng(0, 0),
-          mapTypeId: google.maps.MapTypeId.ROADMAP,
-          zoom: 3
-        }
-        this.map = new google.maps.Map(document.getElementById('google-map'), this.options);
-        this.showMarkers({{ locations }});
-      },
-      showMarkers: function (locations) {
-        var map = this.map,
-            bounds = new google.maps.LatLngBounds(),
-            markers = locations.map(function (location) {
-              var position = new google.maps.LatLng(location.latitude, location.longitude);
-              var marker = new google.maps.Marker({
-                position: position,
-                title:    location.title,
-                url:      location.url,
-                map:      map
-              });
-
-              marker.addListener('click', function () {
-                window.location.href = this.url
-              });
-              bounds.extend(position);
-
-              return marker;
-            });
-
-        new MarkerClusterer(map, markers, {
-          gridSize: 25,
-          imagePath: 'https://raw.githubusercontent.com/googlemaps/js-marker-clusterer/gh-pages/images/m'
-        });
-        map.fitBounds(bounds);
-      },
-    };
-  }());
-</script>
-<script src='https://googlemaps.github.io/js-marker-clusterer/src/markerclusterer.js'></script>
-<script src='https://maps.googleapis.com/maps/api/js?callback=jekyllMaps.initialize'></script>