leaflet_helper 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5650a8adc68441642df6c25ca2b01dba2a7d3b27
-  data.tar.gz: 1cdd5e5a22646db9406608f8e29895e37106c342
+  metadata.gz: 6f0a6f20aeb1a990f29061044ced274fae566267
+  data.tar.gz: 538a63485b9c432f7d8d0374f3bd7250e25d199d
 SHA512:
-  metadata.gz: f6fba4557327c9c3302c3e00fc781b5794673f80ec21dc3e69ec1dbf81413038c572dd6c5753343054e4eaba7b72a25ab2bbc12262f6da4b296fbd9ef7200ab0
-  data.tar.gz: 2e50c27dc53be78a08a08f8304895cc17cd1bd2bac6377cc7dfd3b5f1baa53059193ebfae48f79460150e6bd20bd39606bb197a007f60f0423e5d5b596d78c1f
+  metadata.gz: 400b40208c8f2219f6b921a93c4b9183bd6b8d5728c4b61f1dfee65efc50300677e5e02ae1657e42a97799d08c6ecc9a387921008fa8a35349ced75d3dffb4d9
+  data.tar.gz: 4ae029f4525beed6e476fe921131be854d6dfd8c72f3904d0faddf5ac2a6f47ce715124fad53ed5b1b56ddd9e6b342bf91a299b477bf0be11a5354226cbf427b

data/README.md

@@ -1,8 +1,9 @@
 # LeafletHelper
 
-I couldn't find any libraries that were ruby-centric geospatial map knowledgable that were not
-specifically constructed for the rails framework.  I wanted something more generic that could be used
-with any framework.
+I couldn't find any libraries that were ruby-centric geospatial map knowledgable that were 
+framework agnostic.  
+
+Look at my experiments/maps repo to see how leafelet_helpers is used with a sinatra-based web app.
 
 ## Installation
 
@@ -22,7 +23,11 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Look at 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
+sinatra app also shows how to use markers on top of the main map layers.
 
 ## Development
 
@@ -30,7 +35,7 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-Of if that doesn't work try something.
+Of course if that doesn't work try something else.  I'm not any good a javascript; if you are, send me some pull requests to improve my naive notions.
 
 ## Contributing
 

data/leaflet_helper.gemspec

@@ -5,7 +5,7 @@ require 'leaflet_helper/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "leaflet_helper"
-  spec.version       = '0.0.3'
+  spec.version       = '0.0.4'
   spec.authors       = ["Dewayne VanHoozer"]
   spec.email         = ["dvanhoozer@gmail.com"]
 

data/lib/leaflet_helper.rb

@@ -3,25 +3,24 @@
 module LeafletHelper
   class L
     VERSION         = '0.7.3'       # of leaflet.js
+
+    # 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
-    @@initialized   = false
 
     class << self
 
       # intended for the the head section
       def init(options={})
         o = {
-            markers:   false 
-          }.merge(options)
-
-        # raise RuntimeError, 'Already initialized' if initialized?
-        initialized!
+              author:   "@madbomber"
+            }.merge(options)
 
         leaflet_script = <<~EOS
           <script type="text/javascript" src="//cdn.leafletjs.com/leaflet-#{VERSION}/leaflet.js"></script>
           <link rel="stylesheet" href="//cdn.leafletjs.com/leaflet-#{VERSION}/leaflet.css">
         
+          // SMELL: I'm not sure this script section is needed.
           <script>
 
             // set up AJAX request
@@ -48,8 +47,10 @@ module LeafletHelper
 
 
       # intended for the body of a web page
-      # hope to support multiple maps on a page
+      # can support multiple maps on a page; each
+      # map must have a unique id
       def place_map_here(id='map', options={})
+        # SMELL: This may happen every time the page is refreshed
         @@map_ids << id
         o = {
           style: "width: 800px; height: 400px"
@@ -61,7 +62,7 @@ module LeafletHelper
         return <<~EOS
           <div id="#{id}"#{div_options}></div>
         EOS
-      end # def map(id='map')
+      end # def place_map_here(id='map')
 
 
       # Intended for the body at the bottom
@@ -126,9 +127,9 @@ module LeafletHelper
       end # def add_openstreetmap_layer(id="map", options={})
 
 
+      # Allows for the generation of markers on top of the map
       def add_support_for_markers(id="map", options={})
         o = {
-            markers:   true,
             route:     "#{id}/markers"
           }.merge(options)
 
@@ -143,26 +144,27 @@ module LeafletHelper
             function on#{id}Move(e) { getMarkersFor#{id}(); }
 
 
-
-            // request the marker info with AJAX for the current bounds
+            // request the marker info for the current bounds
             function getMarkersFor#{id}() { // was: askForPlots
 
+              // TODO: Currently the displayed map bounds is not being used
+              //       to get the new set of markers.  This could be ugly for
+              //       lots of markers.  Need a way to insert the bounds into the route.
               var bounds  = #{var_name}.getBounds();
               var minll   = bounds.getSouthWest();
               var maxll   = bounds.getNorthEast();
 
-              // FIXME: msg is the URL from which to get markers
-              // var msg     = 'leaflet/findbybbox.cgi?format=leaflet&bbox='+minll.lng+','+minll.lat+','+maxll.lng+','+maxll.lat;
-              
-              var msg = '#{o[:route]}';
+              // this is the place from which the markers JSON array is obtained
+              var route = '#{o[:route]}';
 
               ajaxRequest.onreadystatechange =  stateChangedFor#{id};
-              ajaxRequest.open('GET', msg, true);
+              ajaxRequest.open('GET', route, true);
               ajaxRequest.send(null);
             }
 
 
-            function stateChangedFor#{id}() { // was: stateChanged
+            // The map changed so get new markers
+            function stateChangedFor#{id}() {
 
               // if AJAX returned a list of markers, add them to the map
               if (ajaxRequest.readyState == 4) {
@@ -189,7 +191,8 @@ module LeafletHelper
             } // function stateChangedFor#{id}()
 
 
-            function removeMarkersFrom#{id}() { // was: removeMarkers
+            // remove all of the markers from the map
+            function removeMarkersFrom#{id}() {
               for (i=0; i<plotlayersFor#{id}.length; i++) {
                 #{var_name}.removeLayer(plotlayersFor#{id}[i]);
               }
@@ -203,7 +206,8 @@ module LeafletHelper
       end # def add_support_for_markers(map_id, map_options) 
 
 
-      # TODO: extrach marker methods into a Marker 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
@@ -214,6 +218,7 @@ module LeafletHelper
       end
 
 
+      # The "var name" is the Javascript container that has the map
       def get_var_name(id="map")
         return "lh_#{id}"
       end
@@ -224,19 +229,6 @@ module LeafletHelper
       end
 
 
-      private
-
-      def initialized!
-        @@initialized = true
-      end
-
-
-      def initialized?
-        @@initialized
-      end
-
-
-
     end # class << self
   end # class L
 end # module LeafletHelper

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leaflet_helper
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Dewayne VanHoozer