geoblacklight 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1ec7051ebc8d380e573700819f8dace0ca4c61b
-  data.tar.gz: c903cc4bebe11b8502b502c056377e5b053b7f5b
+  metadata.gz: fb161150e767dc710a684cfc1b1ce58c50fdb432
+  data.tar.gz: 8d6fee0b74b5b103065a504f2d0e2c10d6ef0ee2
 SHA512:
-  metadata.gz: 5ae9176ca20b2d55e9586ac3346bd9384a792feab18038068759d93fbf293e2438316b75bbad557c54dc9aaa7477ce30d75b691bbf83db450c38869f7685bed8
-  data.tar.gz: 90a8a7f6d0836228781571d232aebd0b82c7eb5b114139abfd5a0509a10413dd1ef53b99b7ce322bf30a92bb2b08b2352808ead8ac550f601e3a860f86b79607
+  metadata.gz: 33ee645d8ed2522561f4fdc9614bde529c0ad3d02dbce805a0969f1427486222f63d874cb8070ac3e8661ebed69849999a8ebeadbd17457c0c2a4f7f2a4edfb1
+  data.tar.gz: 25d38f1a47e47bb05901a0720069a83266a5514c8797d69e1fff4bc65427539bada76dfe1dfa98c1ece3d073ee4539b3f021087dde7be74125b3f31d47d00b8b

data/lib/geoblacklight.rb

@@ -1,6 +1,7 @@
 require "geoblacklight/engine"
 
 module Geoblacklight
+  require 'geoblacklight/bounding_box'
   require 'geoblacklight/catalog_helper_override'
   require 'geoblacklight/config'
   require 'geoblacklight/constants'

data/lib/geoblacklight/bounding_box.rb

@@ -0,0 +1,44 @@
+module Geoblacklight
+  ##
+  # Transforms and parses a bounding box for various formats
+  class BoundingBox
+    ##
+    # @param [String, Integer, Float] west
+    # @param [String, Integer, Float] south
+    # @param [String, Integer, Float] east
+    # @param [String, Integer, Float] north
+    def initialize(west, south, east, north)
+      @west = west
+      @south = south
+      @east = east
+      @north = north
+      # TODO: check for valid Geometry and raise if not
+    end
+
+    ##
+    # Returns a bounding box in ENVELOPE syntax
+    # @return [String]
+    def to_envelope
+      "ENVELOPE(#{west}, #{east}, #{north}, #{south})"
+    end
+
+    ##
+    # Create a Geoblacklight::BoundingBox from a Solr rectangle syntax
+    # @param [String] bbox as "W S E N"
+    # @return [Geoblacklight::BoundingBox]
+    def self.from_rectangle(rectangle)
+      rectangle_array = rectangle.split(' ')
+      fail Geoblacklight::Exceptions::WrongBoundingBoxFormat, 'Bounding box should be a string in Solr rectangle syntax e.g."W S E N"' if rectangle_array.count != 4
+      new(
+        rectangle_array[0],
+        rectangle_array[1],
+        rectangle_array[2],
+        rectangle_array[3]
+      )
+    end
+
+    private
+
+    attr_reader :west, :south, :east, :north
+  end
+end

data/lib/geoblacklight/exceptions.rb

@@ -21,5 +21,7 @@ module Geoblacklight
     end
     class WrongDownloadFormat < StandardError
     end
+    class WrongBoundingBoxFormat < StandardError
+    end
   end
 end

data/lib/geoblacklight/search_builder.rb

@@ -7,14 +7,36 @@ module Geoblacklight
       @processor_chain += [:add_spatial_params] unless @processor_chain.include?(:add_spatial_params)
     end
 
+    ##
+    # Adds spatial parameters to a Solr query if :bbox is present.
+    # @param [Blacklight::Solr::Request] solr_params :bbox should be in Solr
+    # :bbox should be passed in using Solr lat-lon rectangle format e.g.
+    # "minX minY maxX maxY"
+    # @return [Blacklight::Solr::Request]
     def add_spatial_params(solr_params)
       if blacklight_params[:bbox]
         solr_params[:bq] ||= []
-        solr_params[:bq] = ["#{Settings.GEOMETRY_FIELD}:\"IsWithin(#{blacklight_params[:bbox]})\"^10"]
+        solr_params[:bq] = ["#{Settings.GEOMETRY_FIELD}:\"IsWithin(#{envelope_bounds})\"^10"]
         solr_params[:fq] ||= []
-        solr_params[:fq] << "#{Settings.GEOMETRY_FIELD}:\"Intersects(#{blacklight_params[:bbox]})\""
+        solr_params[:fq] << "#{Settings.GEOMETRY_FIELD}:\"Intersects(#{envelope_bounds})\""
       end
       solr_params
+    rescue Geoblacklight::Exceptions::WrongBoundingBoxFormat
+      # TODO: Potentially delete bbox params here so that its not rendered as search param
+      solr_params
+    end
+
+    ##
+    # @return [String]
+    def envelope_bounds
+      bounding_box.to_envelope
+    end
+
+    ##
+    # Returns a Geoblacklight::BoundingBox built from the blacklight_params
+    # @return [Geoblacklight::BoundingBox]
+    def bounding_box
+      Geoblacklight::BoundingBox.from_rectangle(blacklight_params[:bbox])
     end
   end
 end

data/lib/geoblacklight/version.rb

@@ -1,3 +1,3 @@
 module Geoblacklight
-  VERSION = '0.10.0'
+  VERSION = '0.10.1'
 end

data/spec/features/search_bar_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 feature 'search bar' do
   scenario 'present on a spatial search' do
-    visit catalog_index_path(bbox: '25, 3, 75, 35')
+    visit catalog_index_path(bbox: '25 3 75 35')
     expect(page).to have_css '#search-navbar'
   end
   scenario 'present on a text search' do

data/spec/lib/geoblacklight/bounding_box_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Geoblacklight::BoundingBox do
+  describe '#initialize' do
+    it 'handles multiple input types as arguments' do
+      expect(Geoblacklight::BoundingBox.new('1', '1', '1', '1')).to be_an Geoblacklight::BoundingBox
+      expect(Geoblacklight::BoundingBox.new(1, 2, 3, 3)).to be_an Geoblacklight::BoundingBox
+      expect(Geoblacklight::BoundingBox.new(1.1, 2.1, 3.1, 3.1)).to be_an Geoblacklight::BoundingBox
+    end
+  end
+  describe '#to_envelope' do
+    let(:example_box) { Geoblacklight::BoundingBox.new(-160, -80, 120, 70) }
+    it 'creates an envelope syntax version of the bounding box' do
+      expect(example_box.to_envelope).to eq 'ENVELOPE(-160, 120, 70, -80)'
+    end
+  end
+  describe '#from_rectangle' do
+    let(:example_box) { Geoblacklight::BoundingBox.from_rectangle('-160 -80 120 70') }
+    it 'parses and creates a Geoblacklight::BoundingBox from a Solr lat-lon' do
+      expect(example_box).to be_an Geoblacklight::BoundingBox
+      expect(example_box.to_envelope).to eq 'ENVELOPE(-160, 120, 70, -80)'
+    end
+    it 'checks for valididity' do
+      expect { Geoblacklight::BoundingBox.from_rectangle('-160 -80 120') }.to raise_error Geoblacklight::Exceptions::WrongBoundingBoxFormat
+    end
+  end
+end

data/spec/lib/geoblacklight/search_builder_spec.rb

@@ -36,10 +36,23 @@ describe Geoblacklight::SearchBuilder do
     end
 
     it 'should return a spatial search if bbox is given' do
-      params = { :bbox => '123' }
+      params = { bbox: '-180 -80 120 80' }
       subject.with(params)
-      expect(subject.add_spatial_params(solr_params)[:fq].to_s).to include("Intersects")
+      expect(subject.add_spatial_params(solr_params)[:fq].to_s).to include('Intersects')
+    end
+  end
+  describe '#envelope_bounds' do
+    it 'calls to_envelope on the bounding box' do
+      bbox = double('bbox', to_envelope: 'test')
+      expect(subject).to receive(:bounding_box).and_return bbox
+      expect(subject.envelope_bounds).to eq 'test'
+    end
+  end
+  describe '#bounding_box' do
+    it 'creates a bounding box from a Solr lat-lon rectangle format' do
+      params = { bbox: '-120 -80 120 80' }
+      subject.with(params)
+      expect(subject.bounding_box).to be_an Geoblacklight::BoundingBox
     end
   end
 end
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geoblacklight
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Mike Graves
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-18 00:00:00.000000000 Z
+date: 2015-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blacklight
@@ -343,6 +343,7 @@ files:
 - lib/generators/geoblacklight/templates/geoblacklight.js
 - lib/generators/geoblacklight/templates/settings.yml
 - lib/geoblacklight.rb
+- lib/geoblacklight/bounding_box.rb
 - lib/geoblacklight/catalog_helper_override.rb
 - lib/geoblacklight/config.rb
 - lib/geoblacklight/constants.rb
@@ -395,6 +396,7 @@ files:
 - spec/fixtures/solr_documents/public_polygon_mit.json
 - spec/fixtures/solr_documents/restricted-line.json
 - spec/helpers/geoblacklight_helpers_spec.rb
+- spec/lib/geoblacklight/bounding_box_spec.rb
 - spec/lib/geoblacklight/controller_override_spec.rb
 - spec/lib/geoblacklight/download/geojson_download_spec.rb
 - spec/lib/geoblacklight/download/geotiff_download_spec.rb
@@ -473,6 +475,7 @@ test_files:
 - spec/fixtures/solr_documents/public_polygon_mit.json
 - spec/fixtures/solr_documents/restricted-line.json
 - spec/helpers/geoblacklight_helpers_spec.rb
+- spec/lib/geoblacklight/bounding_box_spec.rb
 - spec/lib/geoblacklight/controller_override_spec.rb
 - spec/lib/geoblacklight/download/geojson_download_spec.rb
 - spec/lib/geoblacklight/download/geotiff_download_spec.rb