leaflet_helper 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c6c2bfb061ed25ac3ffdf96fef9e873cac10ff3
-  data.tar.gz: d23001011f855ba51e1b97ae012ea53e2cc57c25
+  metadata.gz: 83b213676f1fe561a3231121f948a1701a2f525e
+  data.tar.gz: d25a23c9184dd00302b9ae6113f67840d40b3523
 SHA512:
-  metadata.gz: eb415d972d817fb45f1238c9364dc573b6673516b81982719bb01e6815645b2221c11dc8eb4240b966be9dc9b7e943a744b490b058db3d30ac062245488c28dd
-  data.tar.gz: d90dcb14eb057a44ebe7b6c6ccf276f4f13d48cf44e881e694c0c4c52c94563b8e0f42fbc102de094a0406f092969b2e0f70c5532bb7e51f89626a5714bf9476
+  metadata.gz: d0e9e1cf5313422f3c291826c825dadabe7ecf0c7fc3797932f9a95431c8df465ace04659c28519b6efb6d5adf8534004c729b51cc3f19e8afb24ebf5149c810
+  data.tar.gz: 84818a516214faa0bfdab9a793667b47784ca3e16d48bfef002b2d876214c4509696ca3bc1af70b846d0bfd80a3c8bdaf46f50a5ebbe8df43f68ffba57316a27

data/README.md

@@ -1,9 +1,15 @@
 # LeafletHelper
 
-I couldn't find any libraries that were ruby-centric geospatial map knowledgable that were 
-framework agnostic.  
+For those of us who don't want to get our hands dirty writing JavaScript (shutter) this library is
+for you.  Actually, its for me, but you can use it if you like.  Once you have installed the gem
+do this:
 
-Look at my experiments/maps repo to see how leafelet_helpers is used with a sinatra-based web app.
+```bash
+  gem which leaflet_helper
+```
+
+The `cd` to the root directory of the gem.  There you will find a subdirectory named `example` in
+which there is a simple Sinatra-based web application that makes use of the LeafletHelper.
 
 ## Installation
 
@@ -23,7 +29,7 @@ Or install it yourself as:
 
 ## Usage
 
-Look at [https://github.com/MadBomber/experiments/tree/master/maps]
+Here is another example of how to use LeafletHelper with multiple maps on a webpage [https://github.com/MadBomber/experiments/tree/master/maps]
 
 The views/layout.haml and views/index.haml show how to use the leaflet_helper.  Of course you
 have to require the gem in the main app.rb file in order for it to be available in the views.  This

data/example/Gemfile

@@ -0,0 +1,15 @@
+# Gemfile
+
+source "https://rubygems.org"
+
+ruby "2.3.1"
+
+# Special Libraries
+gem 'leaflet_helper'  # A Ruby-wrapper around leaflet.js
+
+# Web-app framework
+gem 'sinatra', require: 'sinatra/base'  # Classy web-development dressed in a DSL
+gem 'sinatra-partial'                   # A sinatra extension for render partials.
+gem 'haml'                              # An elegant, structured (X)HTML/XML templating engine.
+gem 'puma'                              # Puma is a simple, fast, threaded, and highly concurrent HTTP 1.1 server for Ruby/Rack application
+

data/example/Gemfile.lock

@@ -0,0 +1,33 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    haml (4.0.7)
+      tilt
+    leaflet_helper (0.0.6)
+    puma (3.4.0)
+    rack (1.6.4)
+    rack-protection (1.5.3)
+      rack
+    sinatra (1.4.7)
+      rack (~> 1.5)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
+    sinatra-partial (1.0.0)
+      sinatra (~> 1.4)
+    tilt (2.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  haml
+  leaflet_helper
+  puma
+  sinatra
+  sinatra-partial
+
+RUBY VERSION
+   ruby 2.3.1p112
+
+BUNDLED WITH
+   1.12.5

data/example/README.md

@@ -0,0 +1,34 @@
+# __application_name__ #
+
+## Description
+
+__description__
+
+Remainder of this file is TBD ...
+
+## Details
+
+### What is this application? ###
+
+* Quick summary
+* Version
+
+### How do I get set up? ###
+
+* Summary of set up
+* Configuration
+* Dependencies
+* Database configuration
+* How to run tests
+* Deployment instructions
+
+### Contribution guidelines ###
+
+* Writing tests
+* Code review
+* Other guidelines
+
+### Who do I talk to? ###
+
+* Repo owner or admin
+* Other community or team contact

data/example/app.rb

@@ -0,0 +1,139 @@
+#!/usr/bin/env ruby
+#########################################################
+###
+##  File: app.rb
+##  Desc: An example Sinatra app using LeafletHelper 
+#
+
+require 'leaflet_helper'
+
+$markers = Hash.new(LeafletHelper::ManageMarkers.new)
+
+module TestData
+
+  AREA51_LOCATION   = [37.242, -115.8191]         # Lat, Long
+  DELTA             = [15, 15]  # NOTE: expresed as integer of real delta +/- 1.5 in lat, long
+                                #       in order to use rand() method
+
+  CODE_WORDS    = [
+    "Magic Carpet",
+    "Desert Storm",
+    "Bayonet Lightning",
+    "Valiant Guardian",
+    "Urgent Fury",
+    "Eagle Claw",
+    "Crescent Wind",
+    "Spartan Scorpion",
+    "Overlord",
+    "Rolling Thunder"
+  ]
+
+  class << self
+
+    def get_random_codeword
+      CODE_WORDS.sample
+    end
+
+
+    def get_random_location( fixed_point=AREA51_LOCATION, delta=DELTA )
+      offset  = []
+      dir     = rand(2) == 0 ? -1.0 : 1.0
+      offset << dir * rand(delta.first).to_f  / 10.0
+      dir     = rand(2) == 0 ? -1.0 : 1.0
+      offset << dir * rand(delta.last).to_f / 10.0
+      point   = fixed_point.each_with_index.map {|v, x| v + offset[x]}
+
+      return { 'lat' => point.first, 'lon' => point.last } 
+
+    end # def get_random_location( fixed_point=AREA51_LOCATION, delta=DELTA )
+  end # class < self
+
+end # module TestData
+
+
+
+require 'pathname'
+
+ROOT = Pathname.new(__FILE__).realpath.parent
+
+class MissingSystemEnvironmentVariable < RuntimeError; end
+
+unless defined?(APP_BIND)
+  raise APP_BIND, "APP_BIND is undefined" if ENV['APP_BIND'].nil?
+  APP_BIND = ENV['APP_BIND']
+end
+
+unless defined?(APP_PORT)
+  raise MissingSystemEnvironmentVariable, "APP_PORT is undefined" if ENV['APP_PORT'].nil?
+  APP_PORT = ENV['APP_PORT']
+end
+
+require 'json'
+
+
+require 'sinatra/base'
+require 'sinatra/partial'
+
+
+module APP
+
+  class DemoError < RuntimeError; end
+
+  class App < Sinatra::Base
+    register Sinatra::Partial
+
+    set :bind,            APP_BIND
+    set :port,            APP_PORT
+    set :server,          :puma
+
+    set :haml,            :format => :html5
+    set :views,           settings.root + '/views'
+
+    set :partial_template_engine, :haml
+  
+    configure do
+      mime_type :html, 'text/html'
+    end
+
+
+    before do
+      content_type :html
+    end
+
+
+    # A marketting landing page
+    get '/' do
+      haml :index
+    end
+
+
+    # Provide some JSON markers
+    # Since everything is randomized, every time the map is
+    # changed a new set of markers is generated.
+    get '/:map_id/markers' do |map_id|
+      content_type :json
+      $markers[map_id].clear
+      (rand(10)+1).times do |x|
+        code_word = TestData.get_random_codeword
+        location  = TestData.get_random_location
+        $markers[map_id].add id: code_word,
+          lat:    location['lat'],
+          lon:    location['lon'],
+          html:   <<~EOS
+            <h3>Crash ##{x}</h3>
+            <p>During #{code_word} rehearsals, programmer error resulted in an unexpected hard landing at this location</p>
+          EOS
+      end
+      $markers[map_id].to_json
+    end
+
+
+
+############################################################
+
+  end # class App < Sinatra::Base
+end # module APP
+
+
+# APP::App.run!
+

data/example/config.ru

@@ -0,0 +1,2 @@
+require './app'
+run APP::App

data/example/start

@@ -0,0 +1,7 @@
+# start
+
+export APP_BIND='0.0.0.0'
+export APP_PORT=4567
+
+rackup --port $APP_PORT --host $APP_BIND --server puma
+

data/example/views/footer.haml

@@ -0,0 +1,3 @@
+-# footer.haml
+
+%p Copyright © 2016 - MadBomber Software - All Rights Reserved

data/example/views/index.haml

@@ -0,0 +1,5 @@
+-# index.haml
+
+%h2 Checkout the Map
+
+= LeafletHelper::L.place_map_here('my_wonderful_map')

data/example/views/layout.haml

@@ -0,0 +1,25 @@
+-# layout.haml
+!!!
+%html
+  %head
+    %title Application by VanHoozer
+    = LeafletHelper::L.init
+  %body
+
+    #logo_header
+
+      %h1 
+        Application by VanHoozer
+
+    #main
+
+      = yield
+
+    #footer
+      = partial :footer
+
+    - map_id = 'my_wonderful_map'
+    - map_options = { latitude: 37.235, longitude: -115.811111, min_zoom: 2, max_zoom: 18}
+    = LeafletHelper::L.show_map(map_id, map_options)
+    = LeafletHelper::L.add_openstreetmap_layer(map_id, map_options)
+    = LeafletHelper::L.add_support_for_markers(map_id, route: "#{map_id}/markers")

data/leaflet_helper.gemspec

@@ -1,11 +1,10 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'leaflet_helper/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "leaflet_helper"
-  spec.version       = '0.0.5'
+  spec.version       = '0.0.6'
   spec.authors       = ["Dewayne VanHoozer"]
   spec.email         = ["dvanhoozer@gmail.com"]
 
@@ -23,11 +22,10 @@ Gem::Specification.new do |spec|
   # end
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
+
 end

data/lib/leaflet_helper/manage_markers.rb

@@ -0,0 +1,102 @@
+# manage_markers.rb
+
+require 'json'
+
+module LeafletHelper
+
+  # Marker encapsulates an Array of Hashes where each Hash
+  # is a marker structure which can be used to add content to
+  # a LeafletJS-managed map image.
+  class ManageMarkers
+
+    # Manage an Array of Hashes
+    def initialize()
+      @markers = Array.new
+    end # def initialize
+
+
+    # a marker consists of an identification (not unique),
+    # a location expressed as decimal latitude longitude and
+    # an html component.
+    def add(id:, lat:, lon:, html: 'Marker')
+      @markers << {
+        id:   id,
+        lat:  lat,
+        lon:  lon,
+        html: html
+      }
+    end
+    alias :insert :add
+    alias :<< :add
+    alias :push :add
+
+
+    # Remove all marker entries that have the given id
+    def remove(id)
+      return() if @markers.empty?
+      @markers.each_index do |x|
+        @markersp[x] = nil if id == @markers[x][:id]
+      end
+      @markers.compact!
+    end
+    alias :delete :remove
+    alias :rm :remove
+    alias :pull :remove
+
+
+    # Clear out the array so we can start over
+    def clear
+      @markers = Array.new
+    end
+    alias :clean :clear
+
+
+    # Turn the array of markers into a JSON structure
+    def to_json
+      @markers.to_json
+    end
+
+  end # class ManageMarkers
+end # module LeafletHelper
+
+
+
+__END__
+
+Example: One Map
+
+my_map = LeafletHelper::ManageMarkers.new
+
+my_map.add  id:   'Secret Place', 
+            lat:  AREA51.latitude, 
+            lon:  AREA51.longitude, 
+            html: <<~EOS
+              <h3>Area 51</h3>
+              <img src='ufo.png'>
+              <p>For Sale <em>Low Mileage</em>, owner is medicated.  Must see to appriciate!  Come by after sunset; beware of guards!</p>
+            EOS
+
+puts my_map.to_json #=> [{"id":"Secret Place","lat":37.235,"lon":-115.811111,"html":"<h3>Area 51</h3>\n<img src='ufo.png'>\n<p>For Sale <em>Low Mileage</em>, owner is modicated.  Must see to appriciate!  Come by after sunset; beware of guards</p>\n"}]
+
+
+Example: Multiple Maps
+
+markers = Hash.new(LeafletHelper::ManageMarkers.new)
+
+markers['map'].add  id:   'Secret Place', 
+            lat:  AREA51.latitude, 
+            lon:  AREA51.longitude, 
+            html: <<~EOS
+              <h3>Area 51</h3>
+              <img src='ufo.png'>
+              <p>For Sale <em>Low Mileage</em>, owner is modivated.  Must see to appriciate!  Come by after sunset; beware of guards!</p>
+            EOS
+
+markers['map2'].add  id:   'Secret Place', 
+            lat:  AREA51.latitude, 
+            lon:  AREA51.longitude, 
+            html: <<~EOS
+              <h3>Area 51</h3>
+              <img src='ufo.png'>
+              <p>For Sale <em>Low Mileage</em>, owner is modivated.  Must see to appriciate!  Come by after sunset; beware of guards!</p>
+            EOS

data/lib/leaflet_helper.rb

@@ -21,6 +21,9 @@ AREA51 = Struct.new('Location', :latitude, :longitude).new
 AREA51.latitude   = 37.235
 AREA51.longitude  = -115.811111
 
+require 'leaflet_helper/manage_markers'
+
+
 module LeafletHelper
   class L
     VERSION   = '0.7.7'       # of leaflet.js
@@ -29,7 +32,6 @@ module LeafletHelper
 
     # TODO: Why are these desired?
     @@map_ids   = []            # the div ids of all of the maps
-    @@markers   = Hash.new([])  # An array of markers for each map id
 
     class << self
 
@@ -131,7 +133,7 @@ module LeafletHelper
 
 
       # Intended for the body at the bottom
-      # SMELL: why the bottom?  Because that's they way we did it in the old days
+      # SMELL: why the bottom?  Because that's the way we did it in the old days
       #        so that the entire web page would have been loaded by then.
       def add_openstreetmap_layer(id="map", options={})
         o = {
@@ -265,7 +267,7 @@ module LeafletHelper
                     plotmark.data = plotlist[i];
 
                     #{var_name}.addLayer(plotmark);
-                    plotmark.bindPopup("<h3>" + plotlist[i].name + "</h3>" + plotlist[i].details);
+                    plotmark.bindPopup(plotlist[i].html);
                     plotlayersFor#{id}.push(plotmark);
                   } // for
 
@@ -301,43 +303,6 @@ module LeafletHelper
         return "<!-- #{a_string}  -->"
       end
 
-
-      # TODO: Marker management is something that could be abstracted into
-      #       its own class.
-
-      # Can't think of a way to use add_marker and delete_marker.
-      # They may not be necessary.
-      def add_marker(marker={}, map_id='map')
-        # TODO: add_marker
-      end
-
-
-      # delete/remove a specific marker from a given map id
-      def delete_marker(marker={}, map_id='map')
-        # TODO: delete_marker
-      end
-
-
-      # clear/remove all markers for a given map id
-      def clear_markers(map_id='map')
-        @@markers[map_id] = []
-      end
-
     end # class << self
   end # class L
 end # module LeafletHelper
-
-
-__END__
-
-A JSON marker array with one entry looks like this:
-
-[
-  {
-    "name":"Tunbridge Wells, Langton Road, Burnt Cottage",
-    "lon":"0.213102", // SMELL: a string? really?
-    "lat":"51.1429",  // SMELL: ditto
-    "details":"A Grade II listed five bedroom wing in need of renovation."
-  }
-]
-

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: leaflet_helper
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 2016-06-10 00:00:00.000000000 Z
 dependencies:
@@ -65,11 +65,19 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
+- example/Gemfile
+- example/Gemfile.lock
+- example/README.md
+- example/app.rb
+- example/config.ru
+- example/start
+- example/views/.keep
+- example/views/footer.haml
+- example/views/index.haml
+- example/views/layout.haml
 - leaflet_helper.gemspec
 - lib/leaflet_helper.rb
-- lib/leaflet_helper/version.rb
+- lib/leaflet_helper/manage_markers.rb
 homepage: http://github.com/MadBomber/leaflet_helper
 licenses:
 - You want it?  Its yours!

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "leaflet_helper"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/lib/leaflet_helper/version.rb

@@ -1,3 +0,0 @@
-module LeafletHelper
-  VERSION = "0.1.0"
-end