google-map: use on page location by default

- change options syntax

Author: ayastreb

lib/jekyll-maps.rb

@@ -1,4 +1,5 @@
 require "securerandom"
+require "ostruct"
 require "jekyll-maps/google_map_api"
 require "jekyll-maps/google_map_tag"
 require "jekyll-maps/location_finder"

lib/jekyll-maps/location_finder.rb

@@ -7,16 +7,40 @@ def initialize(options)
       end
 
       def find(site, page)
-        if @options[:flags][:on_page]
+        if @options[:filters].empty?
           @documents << page if location?(page)
         else
           site.collections.each { |_, collection| filter(collection.docs) }
-          site.data.each { |_, docs| filter(docs) }
+          site_data(site).each { |_, items| traverse(items) }
         end
 
         convert
       end
 
+      private
+      def site_data(site)
+        return {} unless data_source?
+
+        path = @options[:filters]["src"].scan(%r!_data\/([^\/]+)!).join(".")
+        return site.data if path.empty?
+
+        data = OpenStruct.new(site.data)
+        data[path]
+      end
+
+      private
+      def data_source?
+        filters = @options[:filters]
+        filters.key?("src") && filters["src"].start_with?("_data")
+      end
+
+      private
+      def traverse(items)
+        return filter(items) if items.is_a?(Array)
+
+        items.each { |_, children| traverse(children) } if items.is_a?(Hash)
+      end
+
       private
       def filter(docs)
         docs.each do |doc|
@@ -31,8 +55,13 @@ def location?(doc)
 
       private
       def match_filters?(doc)
-        @options[:filters].each do |key, value|
-          return false if doc[key].nil? || doc[key] != value
+        @options[:filters].each do |filter, value|
+          if filter == "src"
+            return true unless doc.respond_to?(:relative_path)
+            return false unless doc.relative_path.start_with?(value)
+          elsif doc[filter].nil? || doc[filter] != value
+            return false
+          end
         end
       end
 

lib/jekyll-maps/options_parser.rb

@@ -1,10 +1,9 @@
 module Jekyll
   module Maps
     class OptionsParser
-      OPTIONS_SYNTAX     = %r!([^\s]+)\s*:\s*([^\s]+)!
+      OPTIONS_SYNTAX     = %r!([^\s]+)\s*=\s*['"]+([^\s'"]+)['"]+!
       ALLOWED_FLAGS      = %w(
         no_cluster
-        on_page
       ).freeze
       ALLOWED_ATTRIBUTES = %w(
         id

spec/fixtures/_data/france/places.yml

@@ -0,0 +1,8 @@
+- title: Paris
+  url: http://google.fr
+  location:
+    latitude: 48.8587741
+    longitude: 2.2074741
+
+- title: Not a place
+  url: http://yahoo.com

spec/fixtures/_data/places.yml renamed to spec/fixtures/_data/spain/places.yml

@@ -1,9 +1,3 @@
-- title: Paris
-  url: http://google.fr
-  location:
-    latitude: 48.8587741
-    longitude: 2.2074741
-
 - title: Madrid
   url: http://google.es
   location:

spec/fixtures/page.md

@@ -5,4 +5,4 @@ layout: default
 
 ** Jekyll Maps Plugin **
 
-{% google_map width:600 height:400 %}
+{% google_map src="_posts" width="600" height="400" %}

spec/fixtures/page_without_layout.md

@@ -4,4 +4,4 @@ title: Test Page
 
 ** Jekyll Maps Plugin **
 
-{% google_map width:100% height:100% %}
+{% google_map src="_posts" width="100%" height="100%" %}

spec/google_map_tag_spec.rb

@@ -62,7 +62,9 @@
     let(:tag) { "google_map" }
 
     context "render all attributes" do
-      let(:options) { "id:foo width:100 height:50% class:baz,bar ignored:bad zoom:5" }
+      let(:options) do
+        "id='foo' width='100' height='50%' class='baz,bar' ignored='bad' zoom='5'"
+      end
       let(:output) do
         Liquid::Template.parse("{% #{tag} #{options} %}").render!(context, {})
       end
@@ -79,7 +81,7 @@
     end
 
     context "render default dimensions" do
-      let(:options) { "id:foo" }
+      let(:options) { "id='foo'" }
       let(:output) do
         Liquid::Template.parse("{% #{tag} #{options} %}").render!(context, {})
       end

spec/location_finder_spec.rb

@@ -8,8 +8,8 @@
     site.process
   end
 
-  context "looking for locations" do
-    let(:options) { Jekyll::Maps::OptionsParser.parse("") }
+  context "looking for locations in posts" do
+    let(:options) { Jekyll::Maps::OptionsParser.parse("src='_posts'") }
     let(:finder)  { Jekyll::Maps::LocationFinder.new(options) }
     let(:actual)  { finder.find(site, page) }
 
@@ -18,23 +18,56 @@
       expect(actual).to all(include(:latitude, :longitude, :title, :url))
     end
 
+    it "finds location in post" do
+      expect(actual.find { |l| l[:title] == "London" }).to be_a(Hash)
+    end
+
     it "skips posts without location" do
       actual.each do |location|
         expect(location).not_to include(:title => "post without location")
       end
     end
+  end
+
+  context "looking for locations in custom collections" do
+    let(:options) { Jekyll::Maps::OptionsParser.parse("src='_my_collection'") }
+    let(:finder)  { Jekyll::Maps::LocationFinder.new(options) }
+    let(:actual)  { finder.find(site, page) }
 
     it "finds location in custom collections" do
       expect(actual.find { |l| l[:title] == "Tokyo" }).to be_a(Hash)
     end
+  end
+
+  context "looking for locations in data files with deep source" do
+    let(:options) { Jekyll::Maps::OptionsParser.parse("src='_data/france'") }
+    let(:finder)  { Jekyll::Maps::LocationFinder.new(options) }
+    let(:actual)  { finder.find(site, page) }
+
+    it "finds location from France" do
+      expect(actual.find { |l| l[:title] == "Paris" }).to be_a(Hash)
+    end
+
+    it "doesn't find location from Spain" do
+      actual.each do |location|
+        expect(location).not_to include(:title => "Madird")
+      end
+    end
+  end
+
+  context "looking for locations in data files with shallow source" do
+    let(:options) { Jekyll::Maps::OptionsParser.parse("src='_data'") }
+    let(:finder)  { Jekyll::Maps::LocationFinder.new(options) }
+    let(:actual)  { finder.find(site, page) }
 
-    it "finds location in data files" do
+    it "finds locations in all data files" do
       expect(actual.find { |l| l[:title] == "Paris" }).to be_a(Hash)
+      expect(actual.find { |l| l[:title] == "Madrid" }).to be_a(Hash)
     end
   end
 
   context "filtering locations" do
-    let(:options) { Jekyll::Maps::OptionsParser.parse("country:de") }
+    let(:options) { Jekyll::Maps::OptionsParser.parse("src='_posts' country='de'") }
     let(:finder)  { Jekyll::Maps::LocationFinder.new(options) }
     let(:actual)  { finder.find(site, page) }
 
@@ -46,10 +79,10 @@
     end
   end
 
-  context "looking for on_page locations" do
+  context "by default look for locations on current page" do
     let(:location) { { "location" => { "latitude" => 1, "longitude" => -1 } } }
     let(:page)     { make_page(location) }
-    let(:options)  { Jekyll::Maps::OptionsParser.parse("on_page") }
+    let(:options)  { Jekyll::Maps::OptionsParser.parse("") }
     let(:finder)   { Jekyll::Maps::LocationFinder.new(options) }
     let(:actual)   { finder.find(site, page) }
 

spec/options_parser_spec.rb

@@ -3,7 +3,7 @@
 describe Jekyll::Maps::OptionsParser do
   context "parses filters" do
     it "ignores extra whitespaces" do
-      actual   = Jekyll::Maps::OptionsParser.parse(" foo_key : bar moo :  baz")
+      actual   = Jekyll::Maps::OptionsParser.parse(" foo_key = 'bar' moo  = 'baz'")
       expected = {
         "foo_key" => "bar",
         "moo"     => "baz"
@@ -12,8 +12,17 @@
       expect(actual[:filters]).to eq(expected)
     end
 
+    it "parses double quotes" do
+      actual   = Jekyll::Maps::OptionsParser.parse('foo="bar"')
+      expected = {
+        "foo" => "bar"
+      }
+
+      expect(actual[:filters]).to eq(expected)
+    end
+
     it "parses single argument" do
-      actual   = Jekyll::Maps::OptionsParser.parse("foo:bar")
+      actual   = Jekyll::Maps::OptionsParser.parse("foo='bar'")
       expected = {
         "foo" => "bar"
       }
@@ -22,7 +31,7 @@
     end
 
     it "parses multiple arguments" do
-      actual   = Jekyll::Maps::OptionsParser.parse("foo:bar moo:baz")
+      actual   = Jekyll::Maps::OptionsParser.parse("foo='bar' moo='baz'")
       expected = {
         "foo" => "bar",
         "moo" => "baz"
@@ -32,7 +41,7 @@
     end
 
     it "parses multiple values in argument" do
-      actual   = Jekyll::Maps::OptionsParser.parse("foo:bar,baz")
+      actual   = Jekyll::Maps::OptionsParser.parse("foo='bar,baz'")
       expected = {
         "foo" => %w(bar baz)
       }
@@ -44,7 +53,7 @@
   context "parses attributes" do
     it "parses predefined attributes" do
       actual   = Jekyll::Maps::OptionsParser.parse(
-        "id:foo width:100 height:50% class:my-css-class,another-class"
+        "id='foo' width='100' height='50%' class='my-css-class,another-class'"
       )
       expected = {
         :id     => "foo",
@@ -59,9 +68,8 @@
 
   context "parses flags" do
     it "parses all allowed flags correctly" do
-      actual   = Jekyll::Maps::OptionsParser.parse("on_page no_cluster")
+      actual   = Jekyll::Maps::OptionsParser.parse("no_cluster")
       expected = {
-        :on_page    => true,
         :no_cluster => true
       }