blacklight-maps 0.0.1 → 0.1.0

data/lib/blacklight/maps.rb

@@ -3,5 +3,7 @@ require "blacklight/maps/version"
 module Blacklight
   module Maps
     require 'blacklight/maps/engine'
+    require 'blacklight/maps/export'
+    require 'blacklight/maps/geometry'
   end
 end

data/lib/blacklight/maps/engine.rb

@@ -3,16 +3,17 @@ require 'leaflet-rails'
 require 'leaflet-markercluster-rails'
 require 'leaflet-sidebar-rails'
 
-
 module Blacklight
   module Maps
     class Engine < Rails::Engine
-
       # Set some default configurations
-      Blacklight::Configuration.default_values[:view].maps.placename_coord_field = "placename_coords"
+      Blacklight::Configuration.default_values[:view].maps.type = 'bbox'
+      Blacklight::Configuration.default_values[:view].maps.bbox_field = 'place_bbox'
+      Blacklight::Configuration.default_values[:view].maps.placename_coord_field = 'placename_coords'
       Blacklight::Configuration.default_values[:view].maps.tileurl = "http://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png"
       Blacklight::Configuration.default_values[:view].maps.mapattribution = 'Map data &copy; <a href="http://openstreetmap.org">OpenStreetMap</a> contributors, <a href="http://creativecommons.org/licenses/by-sa/2.0/">CC-BY-SA</a>'
       Blacklight::Configuration.default_values[:view].maps.maxzoom = 8
+      Blacklight::Configuration.default_values[:view].maps.placename_coord_delimiter = '-|-'
 
       # Add our helpers
       initializer 'blacklight-maps.helpers' do |app|
@@ -29,4 +30,4 @@ module Blacklight
       end
     end
   end
-end
+end

data/lib/blacklight/maps/export.rb

@@ -0,0 +1,111 @@
+module BlacklightMaps
+
+  # This class provides the ability to export a response document to GeoJSON.
+  # The export is formated as a GeoJSON FeatureCollection, where the features
+  # consist of an array of Point features.  For more on the GeoJSON
+  # specification see http://geojson.org/geojson-spec.html.
+  #
+  class GeojsonExport
+    include BlacklightMaps
+
+    # controller is a Blacklight CatalogController object passed by a helper
+    # response_docs is an array of documents passed by a helper
+    def initialize(controller, response_docs)
+      @controller = controller
+      @response_docs = response_docs
+    end
+
+    def to_geojson
+      geojson_docs = { type: 'FeatureCollection',
+                       features: build_geojson_features }
+      geojson_docs.to_json
+    end
+
+    private
+
+    def blacklight_maps_config
+      @controller.blacklight_config.view.maps
+    end
+
+    def type
+      blacklight_maps_config.type
+    end
+
+    def placename_coord_field
+      blacklight_maps_config.placename_coord_field
+    end
+
+    def placename_coord_delimiter
+      blacklight_maps_config.placename_coord_delimiter
+    end
+
+    def bbox_field
+      blacklight_maps_config.bbox_field
+    end
+
+    def build_geojson_features
+      case type
+      when 'placename_coord'
+        build_placename_coord_features
+      when 'bbox'
+        build_bbox_features
+      else
+        Rails.logger.error("Your Solr field type was not configured with a recognized type, '#{type}' is not yet supported")
+      end
+    end
+
+    # Builds the features structure for placename_coord type documents
+    def build_placename_coord_features
+      features = []
+      @response_docs.each do |doc|
+        next if doc[placename_coord_field].nil?
+        doc[placename_coord_field].uniq.each do |loc|
+          values = loc.split(placename_coord_delimiter)
+          features.push(
+            build_point_feature(values[2], values[1],
+                                name: values[0],
+                                html: render_leaflet_sidebar_partial(doc)))
+        end
+      end
+      features
+    end
+
+    # Builds the features structure for bbox type documents
+    def build_bbox_features
+      features = []
+      @response_docs.each do |doc|
+        next if doc[bbox_field].nil?
+        doc[bbox_field].uniq.each do |loc|
+          lnglat = Geometry::BoundingBox.from_lon_lat_string(loc).find_center
+          features.push(
+            build_point_feature(lnglat[0], lnglat[1],
+                                html: render_leaflet_sidebar_partial(doc)))
+        end
+      end
+      features
+    end
+
+    # Render to string the partial for each individual doc
+    def render_leaflet_sidebar_partial(doc)
+      @controller.render_to_string partial: 'catalog/index_maps',
+                                   locals: { document: SolrDocument.new(doc) }
+    end
+
+    # Build the individual feature which is added to the FeatureCollection.
+    # lng is the longitude of the feature
+    # lat is the latitude of the feature
+    # *args additional arguments can be passed to the feature, these arguments
+    # will be reflected in the 'properties' member.
+    # html: "html string to show up" must be passed for the sidebar to display
+    # list items
+    def build_point_feature(lng, lat, *args)
+      properties = args.extract_options!
+      feature = { type: 'Feature',
+                  geometry: {
+                    type: 'Point',
+                    coordinates: [lng.to_f, lat.to_f] },
+                  properties: properties }
+      feature
+    end
+  end
+end

data/lib/blacklight/maps/geometry.rb

@@ -0,0 +1,35 @@
+module BlacklightMaps
+
+  # Parent class of geospatial objects used in BlacklightMaps
+  class Geometry
+
+    # This class contains Bounding Box objects and methods for interacting with
+    # them.
+    class BoundingBox
+
+      # points is an array containing longitude and latitude values which
+      # relate to the southwest and northeast points of a bounding box
+      # [west, south, east, north] ([swlng, swlat, nelng, nelat]).
+      def initialize(points)
+        @west = points[0].to_f
+        @south = points[1].to_f
+        @east = points[2].to_f
+        @north = points[3].to_f
+      end
+
+      # Returns an array [lng, lat] which is the centerpoint of a BoundingBox.
+      def find_center
+        center = []
+        center[0] = (@west + @east) / 2
+        center[1] = (@south + @north) / 2
+        center
+      end
+
+      # Creates a new bounding box from from a string of points
+      # "-100 -50 100 50" (south west north east)
+      def self.from_lon_lat_string(points)
+        new(points.split(' '))
+      end
+    end
+  end
+end

data/lib/blacklight/maps/version.rb

@@ -1,5 +1,5 @@
 module Blacklight
   module Maps
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end

data/solr_conf/conf/schema.xml

@@ -16,10 +16,10 @@
  limitations under the License.
 -->
 
-<!--  
+<!--
  This is the Solr schema file. This file should be named "schema.xml" and
  should be in the conf directory under the solr home
- (i.e. ./solr/conf/schema.xml by default) 
+ (i.e. ./solr/conf/schema.xml by default)
  or located where the classloader for the Solr webapp can find it.
 
  This example schema is the recommended starting point for users.
@@ -51,7 +51,7 @@
        version="1.4" is Solr's version number for the schema syntax and semantics.  It should
        not normally be changed by applications.
        1.0: multiValued attribute did not exist, all fields are multiValued by nature
-       1.1: multiValued attribute introduced, false by default 
+       1.1: multiValued attribute introduced, false by default
        1.2: omitTermFreqAndPositions attribute introduced, true by default except for text fields.
        1.3: removed optional field compress feature
        1.4: default auto-phrase (QueryParser feature) to off
@@ -88,7 +88,7 @@
        - If sortMissingLast="false" and sortMissingFirst="false" (the default),
          then default lucene sorting will be used which places docs without the
          field first in an ascending sort and last in a descending sort.
-    -->    
+    -->
 
     <!--
       Default numeric field types. For faster range queries, consider the tint/tfloat/tlong/tdouble types.
@@ -115,7 +115,7 @@
 
     <!-- The format for this date field is of the form 1995-12-31T23:59:59Z, and
          is a more restricted form of the canonical representation of dateTime
-         http://www.w3.org/TR/xmlschema-2/#dateTime    
+         http://www.w3.org/TR/xmlschema-2/#dateTime
          The trailing "Z" designates UTC time and is mandatory.
          Optional fractional seconds are allowed: 1995-12-31T23:59:59.999Z
          All other components are mandatory.
@@ -130,7 +130,7 @@
                NOW/DAY+6MONTHS+3DAYS
                   ... 6 months and 3 days in the future from the start of
                       the current day
-                      
+
          Consult the DateField javadocs for more information.
 
          Note: For faster range queries, consider the tdate type
@@ -158,11 +158,11 @@
 
     <!-- The "RandomSortField" is not used to store or search any
          data.  You can declare fields of this type it in your schema
-         to generate pseudo-random orderings of your docs for sorting 
-         purposes.  The ordering is generated based on the field name 
+         to generate pseudo-random orderings of your docs for sorting
+         purposes.  The ordering is generated based on the field name
          and the version of the index, As long as the index version
          remains unchanged, and the same field name is reused,
-         the ordering of the docs will be consistent.  
+         the ordering of the docs will be consistent.
          If you want different psuedo-random orderings of documents,
          for the same version of the index, use a dynamicField and
          change the name
@@ -391,13 +391,13 @@
         <filter class="solr.TrimFilterFactory" />
         <!-- The PatternReplaceFilter gives you the flexibility to use
              Java Regular expression to replace any sequence of characters
-             matching a pattern with an arbitrary replacement string, 
+             matching a pattern with an arbitrary replacement string,
              which may include back references to portions of the original
              string matched by the pattern.
-             
+
              See the Java Regular Expression documentation for more
              information on pattern and replacement string syntax.
-             
+
              http://java.sun.com/j2se/1.5.0/docs/api/java/util/regex/package-summary.html
           -->
         <filter class="solr.PatternReplaceFilterFactory"
@@ -405,7 +405,7 @@
         />
       </analyzer>
     </fieldType>
-    
+
     <fieldtype name="phonetic" stored="false" indexed="true" class="solr.TextField" >
       <analyzer>
         <tokenizer class="solr.StandardTokenizerFactory"/>
@@ -419,7 +419,7 @@
         <!--
         The DelimitedPayloadTokenFilter can put payloads on tokens... for example,
         a token of "foo|1.4"  would be indexed as "foo" with a payload of 1.4f
-        Attributes of the DelimitedPayloadTokenFilterFactory : 
+        Attributes of the DelimitedPayloadTokenFilterFactory :
          "delimiter" - a one character delimiter. Default is | (pipe)
 	 "encoder" - how to encode the following value into a playload
 	    float -> org.apache.lucene.analysis.payloads.FloatEncoder,
@@ -446,12 +446,12 @@
     </fieldType>
 
     <!-- since fields of this type are by default not stored or indexed,
-         any data added to them will be ignored outright.  --> 
+         any data added to them will be ignored outright.  -->
     <fieldtype name="ignored" stored="false" indexed="false" multiValued="true" class="solr.StrField" />
 
     <!-- This point type indexes the coordinates as separate fields (subFields)
       If subFieldType is defined, it references a type, and a dynamic field
-      definition is created matching *___<typename>.  Alternately, if 
+      definition is created matching *___<typename>.  Alternately, if
       subFieldSuffix is defined, that is used to create the subFields.
       Example: if subFieldType="double", then the coordinates would be
         indexed in fields myloc_0___double,myloc_1___double.
@@ -470,13 +470,19 @@
     See http://wiki.apache.org/solr/SpatialSearch
    -->
     <fieldtype name="geohash" class="solr.GeoHashField"/>
+
+    <fieldType name="location_rpt" class="solr.SpatialRecursivePrefixTreeFieldType"
+               distErrPct="0.025"
+               maxDistErr="0.000009"
+               units="degrees"
+            />
  </types>
 
 
  <fields>
    <!-- Valid attributes for fields:
      name: mandatory - the name for the field
-     type: mandatory - the name of a previously defined type from the 
+     type: mandatory - the name of a previously defined type from the
        <types> section
      indexed: true if this field should be indexed (searchable or sortable)
      stored: true if this field should be retrievable
@@ -489,9 +495,9 @@
        given field.
        When using MoreLikeThis, fields used for similarity should be
        stored for best performance.
-     termPositions: Store position information with the term vector.  
+     termPositions: Store position information with the term vector.
        This will increase storage costs.
-     termOffsets: Store offset information with the term vector. This 
+     termOffsets: Store offset information with the term vector. This
        will increase storage costs.
      default: a value that should be used if no value is specified
        when adding a document.
@@ -502,7 +508,7 @@
    <field name="timestamp" type="date" indexed="true" stored="true" default="NOW" multiValued="false"/>
    <!-- default, catch all search field -->
    <field name="text" type="text" indexed="true" stored="false" multiValued="true"/>
-   
+
    <!-- these display fields are NOT multi-valued -->
    <field name="marc_display" type="string" indexed="false" stored="true" multiValued="false"/>
    <field name="title_display" type="string" indexed="false" stored="true" multiValued="false"/>
@@ -511,7 +517,7 @@
    <field name="subtitle_vern_display" type="string" indexed="false" stored="true" multiValued="false"/>
    <field name="author_display" type="string" indexed="false" stored="true" multiValued="false"/>
    <field name="author_vern_display" type="string" indexed="false" stored="true" multiValued="false"/>
-   
+
    <!-- these fields are also used for display, so they must be stored -->
    <field name="isbn_t" type="text" indexed="true" stored="true" multiValued="true"/>
    <field name="language_facet" type="string" indexed="true" stored="true" multiValued="true" />
@@ -523,7 +529,7 @@
    <!-- pub_date sort uses new trie-based int fields, which are recommended for any int and are displayable, sortable, and range-quer
    we use 'tint' for faster range-queries. -->
    <field name="pub_date_sort" type="tint" indexed="true" stored="true" multiValued="false"/>
-     
+
    <!-- format is used for facet, display, and choosing which partial to use for the show view, so it must be stored and indexed -->
    <field name="format" type="string" indexed="true" stored="true"/>
 
@@ -558,7 +564,7 @@
    <dynamicField name="*_tf" type="tfloat"  indexed="true"  stored="true"/>
    <dynamicField name="*_td" type="tdouble" indexed="true"  stored="true"/>
    <dynamicField name="*_tdt" type="tdate"  indexed="true"  stored="true"/>
-   
+
    <dynamicField name="*_pi"  type="pint"    indexed="true"  stored="true"/>
 
    <dynamicField name="ignored_*" type="ignored" multiValued="true"/>
@@ -572,15 +578,18 @@
    <dynamicField name="*_unstem_search" type="text_general" indexed="true" stored="false" multiValued="true" />
    <dynamicField name="*spell" type="textSpell" indexed="true" stored="false" multiValued="true" />
 
-   <!-- uncomment the following to ignore any fields that don't already match an existing 
-        field name or dynamic field, rather than reporting them as an error. 
-        alternately, change the type="ignored" to some other type e.g. "text" if you want 
-        unknown fields indexed and/or stored by default --> 
+   <dynamicField name="*_pt"     type="location"     stored="true" indexed="true"/>
+   <dynamicField name="*_bbox"   type="location_rpt" stored="true" indexed="true" multiValued="true"/>
+
+   <!-- uncomment the following to ignore any fields that don't already match an existing
+        field name or dynamic field, rather than reporting them as an error.
+        alternately, change the type="ignored" to some other type e.g. "text" if you want
+        unknown fields indexed and/or stored by default -->
    <!--dynamicField name="*" type="ignored" multiValued="true" /-->
-   
+
  </fields>
 
- <!-- Field to use to determine and enforce document uniqueness. 
+ <!-- Field to use to determine and enforce document uniqueness.
       Unless this field is marked with required="false", it will be a required field
    -->
  <uniqueKey>id</uniqueKey>
@@ -595,7 +604,7 @@
         is added to the index.  It's used either to index the same field differently,
         or to add multiple fields to the same field for easier/faster searching.  -->
    <!-- Copy Fields -->
-        
+
    <!-- unstemmed fields -->
    <copyField source="title_t" dest="title_unstem_search"/>
    <copyField source="subtitle_t" dest="subtitle_unstem_search"/>
@@ -607,11 +616,11 @@
    <copyField source="subject_t" dest="subject_unstem_search"/>
    <copyField source="subject_addl_t" dest="subject_addl_unstem_search"/>
    <copyField source="subject_topic_facet" dest="subject_topic_unstem_search"/>
-   
+
    <!-- sort fields -->
    <copyField source="pub_date" dest="pub_date_sort"/>
-   
-        
+
+
    <!-- spellcheck fields -->
    <!-- default spell check;  should match fields for default request handler -->
    <!-- it won't work with a copy of a copy field -->
@@ -629,8 +638,8 @@
    <!-- subject spell check; should match fields for subject request handler -->
    <copyField source="subject_topic_facet" dest="subject_spell"/>
    <copyField source="subject_t" dest="subject_spell"/>
-   <copyField source="subject_addl_t" dest="subject_spell"/>  
-   
+   <copyField source="subject_addl_t" dest="subject_spell"/>
+
    <!-- OpenSearch query field should match request handler search fields -->
    <copyField source="title_t" dest="opensearch_display"/>
    <copyField source="subtitle_t" dest="opensearch_display"/>
@@ -641,19 +650,19 @@
    <copyField source="author_addl_t" dest="opensearch_display"/>
    <copyField source="subject_topic_facet" dest="opensearch_display"/>
    <copyField source="subject_t" dest="opensearch_display"/>
-   <copyField source="subject_addl_t" dest="opensearch_display"/>  
+   <copyField source="subject_addl_t" dest="opensearch_display"/>
 
 
-   <!-- Above, multiple source fields are copied to the [text] field. 
-	  Another way to map multiple source fields to the same 
-	  destination field is to use the dynamic field syntax. 
+   <!-- Above, multiple source fields are copied to the [text] field.
+	  Another way to map multiple source fields to the same
+	  destination field is to use the dynamic field syntax.
 	  copyField also supports a maxChars to copy setting.  -->
-	   
+
    <!-- <copyField source="*_t" dest="text" maxChars="3000"/> -->
 
    <!-- copy name to alphaNameSort, a field designed for sorting by name -->
    <!-- <copyField source="name" dest="alphaNameSort"/> -->
- 
+
 
  <!-- Similarity is the scoring routine for each document vs. a query.
       A custom similarity may be specified here, but the default is fine