jekyll-geocode 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a800dd5ba8b97233bf43ad3cb8e47ba0dd2b7f4
+  data.tar.gz: 0dcf7e2d742bfeec6e1174ac6ec8e7cde0a7ae55
+SHA512:
+  metadata.gz: c448b250b9aa67f690f8613cb459bf8557a6180d98e41aba159fe8ef7f9c979f7949014d8a562843fe4e6c9e1ed063007b3fbbc5b2fb2152773c2df87f792051
+  data.tar.gz: 8a3ca5bef05ccc9de67de4c8d4eeba1f6306a37804f8a284ee81e267210d594a2e032dcce029479929f856bebaf6d86265f7e8994e1ee20d22f3d0609b82b2f1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jekyll-post-files.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nicolas Hoizey
+
+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 @@
+# Jekyll Geocode
+
+Making a interactive maps with adresses is impossible you need the coordinates.  
+Making a file writing by redactors with directly the coordinates of your data is impossible or too slow.
+
+So you need a processus for generating coordinates form addresses by calling a service. 
+
+For speed reasons you‘d rather writing the coordinates in files during the build. You will probably generate a JSON file with coordinates in your HTML page displaying map.
+
+I took the [Nominatim](https://nominatim.openstreetmap.org/) open source service from Open Street Map for calling the data. 
+
+## Example of YAML : _data/members.yml
+
+```yaml
+- name: "John Doe"
+  address: "rue Mendès France"
+  postcode: 76190
+  city: "Yvetot"
+  region: "normandy"
+  country: "france"  
+- name: "Samuel Le Bihan"
+  address: "place du général de Gaulle France"
+  postcode: 76000
+  city: "Rouen"
+  region: "Normandy"
+  country: "france"
+```
+
+> For key matching, avoid accent in name or create a key in members.yml (ex: geoname) without space and accent.
+
+## Example of configuration _config.yml
+
+```yaml
+jekyll_geocode:
+  file-name: members.yml # Name of the YML store inside _data with a list of datas (required)
+  file-path: _data # Path of the YML file, folder of your data (_data) by default (optional)
+  name: name # Name of the field from the YML that will gave the name of the generated file (the name will be downcase and space replace by a dash) (required)
+  address: address # Name of the address (street + city) or only street field (if city field exists) from the YML (required)
+  postcode: postcode # Postcode from the YML (optional)
+  city: city # Name of the town field from the YML, if you have a separated field address and city (optional)
+  region: region # Name of the region, county or state or all in the same field from the YML (optional)
+  country: country # Name of the country from the YML (optional)
+  cache: true # Test if a file already exist
+  outputfile: place.yml # Give the name of the file for an yml output (otherwise it will be JSON) <= usefull for jekyll-map
+```
+> The service is very slow (when you have lot of entries) but you can generate files with the cache option. Be carefull, ignore this files in your git tracking files !
+
+## Example of loop with JSON : map.html with google map
+
+```liquid
+{% for row in site.data.members | sort: 'name' %}
+    {% assign geoname = row.name | replace: ' ', '-' | downcase %}
+    var point = new google.maps.LatLng({% for coordinates in site.data.[geoname] %}{{ coordinates.lat }}, {{ coordinates.lon }}{% endfor %});
+{% endfor %}
+```
+
+## Example of loop with YAML : map.html with google map
+```liquid
+{% for row in site.data.members | sort: 'name' %} 
+    {% assign geoname = row.name | replace: ' ', '-' | downcase %}    
+    {% assign places = site.data.place | where:"title", geoname %} 
+    {% for coordinates in places %}
+      var point = new google.maps.LatLng({{ coordinates.location.latitude }}, {{ coordinates.location.longitude }});
+    {% endfor %}
+{% endfor %}
+```
+
+This plugin is used in a production website and working well. You are invited for improvement proposals.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/lib/jekyll_geocode.rb

@@ -0,0 +1,114 @@
+require "rubygems"
+require 'json'
+require 'yaml'
+require 'open-uri'
+require "i18n"
+
+module Jekyll_Get
+  class Generator < Jekyll::Generator
+    safe true
+    priority :highest
+
+    def generate(site)
+
+      #regEx for removing empty line
+      regEx = /^[\s]*$\n/
+
+      #force locale
+      I18n.config.available_locales = :en
+
+      #Get Geo service
+      geo_service = 'https://nominatim.openstreetmap.org/?format=json&q='
+    
+      #Get Config
+      config = site.config['jekyll_geocode']
+
+      if !config
+        return
+      end
+      if !config.kind_of?(Array)
+        filename       = site.config['jekyll_geocode']['file-name']
+        filepath       = site.config['jekyll_geocode']['file-path']
+        outputfile     = site.config['jekyll_geocode']['outputfile']
+        geo_name       = site.config['jekyll_geocode']['name']
+        geo_address    = site.config['jekyll_geocode']['address']
+        geo_postcode   = site.config['jekyll_geocode']['postcode']
+        geo_city       = site.config['jekyll_geocode']['city']
+        geo_region     = site.config['jekyll_geocode']['region']
+        geo_country    = site.config['jekyll_geocode']['country']
+      end
+
+      # Define data source
+      if !filepath
+        data_source = (site.config['data_source'])
+      else
+        data_source = (filepath)
+      end
+
+      #Path
+      path_yaml = "#{data_source}/#{outputfile}"
+
+      # if File.file?(path_yaml) && outputfile
+      #   File.open(path_yaml, 'w') {|file| file.truncate(0) }
+      # end
+
+      # Load YML file
+      members = YAML.load_file("#{data_source}/#{filename}")
+
+      # Loop YML file
+      members.each do |d|
+        # Test if a JSON file exists for performance issues
+        if !File.file?("#{data_source}/#{d[geo_name]}.json")
+          geo_name_field = d[geo_name].downcase.tr(" ", "-")
+          if d[geo_postcode]
+            geo_postcode_field = ",#{d[geo_postcode]}"
+          end
+          if d[geo_city]
+            geo_city_field = ",#{d[geo_city]}"
+          end
+          if d[geo_region]
+            geo_region_field = ",#{d[geo_region]}"
+          end
+          if d[geo_country]
+            geo_country_field = ",#{d[geo_country]}"
+          end
+          json = URI.encode("#{geo_service}#{d[geo_address]}#{geo_postcode_field}#{geo_city_field}#{geo_region_field}#{geo_country_field}&limit=1")
+          source = JSON.load(open(json))
+
+          # Loop for an YML output
+          if outputfile
+            source.each do |coordinates|
+              data = [ "title" => "#{d[geo_name]}", "url" => "#places-01", "data_set" => "01", "location" => { "latitude" => "#{coordinates["lat"]}","longitude" => "#{coordinates["lon"]}" } ]
+              data_yml = data.to_yaml
+              # Test if there is any yaml files and create file
+              if !File.file?(path_yaml)
+                File.open(path_yaml, "w") {|f| f.write(data_yml) }
+              end
+              # Test if there is yaml files and add data recursively
+              if File.file?(path_yaml)
+                File.open(path_yaml, 'a') { |f|
+                  data_yml_simple = data_yml.gsub("---", "").gsub(regEx, '')
+                  f.puts data_yml_simple
+                }
+                # Load YML file and remove duplicate entries
+                file_yaml = YAML.load(File.open(path_yaml))
+                file_yaml_uniq = file_yaml.uniq { |s| s.first }
+                File.open(path_yaml, "w") {|f| f.write(file_yaml_uniq.to_yaml) }
+              end
+            end
+          # Loop for an JSON output
+          else
+            site.data[geo_name_field] = source
+            #Create a JSON  files if cache is enabled
+            if site.config['jekyll_geocode']['cache']
+              path_json = "#{data_source}/#{geo_name_field}.json"
+              open(path_json, 'wb') do |file|
+                file << JSON.generate(site.data[geo_name_field])
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-geocode
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Bertrand Keller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+description: "    Geocode addresses from a YAML for drawing maps (with https://nominatim.openstreetmap.org)\n"
+email:
+- bertrand.keller@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/jekyll_geocode.rb
+homepage: https://bertrandkeller.github.io/jekyll-geocode/
+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.6.7
+signing_key: 
+specification_version: 4
+summary: Geocode addresses from a YAML for drawing maps
+test_files: []