blacklight-maps 0.2.0 → 0.3.0

data/spec/lib/blacklight/maps/controller_override_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe BlacklightMaps::ControllerOverride do
+
+  class BlacklightMapsControllerTestClass < CatalogController
+  end
+
+  before(:each) do
+    CatalogController.blacklight_config = Blacklight::Configuration.new
+    @fake_controller = BlacklightMapsControllerTestClass.new
+    @fake_controller.extend(BlacklightMaps::ControllerOverride)
+  end
+
+  let(:solr_params) { Hash.new }
+  let(:req_params) { Hash.new }
+
+  describe "add_spatial_search_to_solr" do
+
+    it "should return a coordinate point spatial search if coordinates are given" do
+      req_params[:coordinates] = "35.86166,104.195397"
+      req_params[:spatial_search_type] = "point"
+      expect(@fake_controller.add_spatial_search_to_solr(solr_params, req_params)[:fq].first).to include('geofilt')
+      expect(@fake_controller.add_spatial_search_to_solr(solr_params, req_params)[:pt]).to eq(req_params[:coordinates])
+    end
+
+    it "should return a bbox spatial search if a bbox is given" do
+      req_params[:coordinates] = "[6.7535159,68.162386 TO 35.5044752,97.395555]"
+      req_params[:spatial_search_type] = "bbox"
+      expect(@fake_controller.add_spatial_search_to_solr(solr_params, req_params)[:fq].first).to include(CatalogController.blacklight_config.view.maps.coordinates_field)
+    end
+
+  end
+
+end

data/spec/lib/blacklight/maps/export_spec.rb

@@ -4,66 +4,209 @@ describe "BlacklightMaps::GeojsonExport" do
 
   before do
     CatalogController.blacklight_config = Blacklight::Configuration.new
-    CatalogController.configure_blacklight do |config|
-      config.view.maps.type = 'placename_coord'
-
-      # These fields also need to be added for some reason for the tests to pass
-      # Link in list is not being generated correctly if not passed
-      config.index.title_field = 'title_display'
-    end
     @controller = CatalogController.new
+    @action = "index"
     @request = ActionDispatch::TestRequest.new
     @controller.request = @request
     @response = ActionDispatch::TestResponse.new
-    @response.stub(:docs) {[{ "published_display"=>["Dharamsala, Distt. Kangra, H.P."], "pub_date"=>["2007"], "format"=>"Book", "title_display"=>"Ses yon", "material_type_display"=>["xii, 419 p."], "id"=>"2008308478", "subject_geo_facet"=>["China", "Tibet", "India"], "subject_topic_facet"=>["Education and state", "Tibetans", "Tibetan language", "Teaching"], "language_facet"=>["Tibetan"], "placename_coords"=>["China-|-35.86166-|-104.195397", "Tibet-|-29.646923-|-91.117212", "India-|-20.593684-|-78.96288"], "place_bbox"=>["68.162386 6.7535159 97.395555 35.5044752"], "score"=>0.0026767207 }]}
+    @response.stub(:docs) {[{ "published_display"=>["Dharamsala, Distt. Kangra, H.P."], "pub_date"=>["2007"], "format"=>"Book", "title_display"=>"Ses yon", "material_type_display"=>["xii, 419 p."], "id"=>"2008308478", "placename_field"=>["China", "Tibet", "India"], "subject_topic_facet"=>["Education and state", "Tibetans", "Tibetan language", "Teaching"], "language_facet"=>["Tibetan"], "geojson"=>["{\"type\":\"Feature\",\"geometry\":{\"type\":\"Point\",\"coordinates\":[104.195397,35.86166]},\"properties\":{\"placename\":\"China\"}}", "{\"type\":\"Feature\",\"geometry\":{\"type\":\"Point\",\"coordinates\":[91.117212,29.646923]},\"properties\":{\"placename\":\"Tibet\"}}", "{\"type\":\"Feature\",\"geometry\":{\"type\":\"Point\",\"coordinates\":[78.96288,20.593684]},\"properties\":{\"placename\":\"India\"}}"], "coordinates"=>["68.162386 6.7535159 97.395555 35.5044752", "104.195397 35.86166", "91.117212 29.646923", "20.593684,78.96288"], "score"=>0.0026767207 }]}
   end
 
-  subject {BlacklightMaps::GeojsonExport.new(@controller, @response.docs)}
+  # TODO: use @response.facet_by_field_name('geojson').items instead of @response
+  #       then refactor build_geojson_features and to_geojson specs
+  subject {BlacklightMaps::GeojsonExport.new(@controller, @action, @response.docs)}
 
   it "should instantiate GeojsonExport" do
     expect(subject.class).to eq(::BlacklightMaps::GeojsonExport)
   end
 
-  it "should return maps config" do
-    expect(subject.send(:blacklight_maps_config).class).to eq(::Blacklight::Configuration::ViewConfig)
-  end
+  describe "return config settings" do
 
-  it "should return type" do
-    expect(subject.send(:type)).to eq('placename_coord')
-  end
+    it "should return maps config" do
+      expect(subject.send(:blacklight_maps_config).class).to eq(::Blacklight::Configuration::ViewConfig)
+    end
 
-  it "should return placename field" do
-    expect(subject.send(:placename_coord_field)).to eq('placename_coords')
-  end
+    it "should return geojson_field" do
+      expect(subject.send(:geojson_field)).to eq('geojson')
+    end
 
-  it "should return placename delimiter" do
-    expect(subject.send(:placename_coord_delimiter)).to eq('-|-')
-  end
+    it "should return coordinates_field" do
+      expect(subject.send(:coordinates_field)).to eq('coordinates')
+    end
 
-  it "should return bbox field" do
-    expect(subject.send(:bbox_field)).to eq('place_bbox')
-  end
+    it "should return search_mode" do
+      expect(subject.send(:search_mode)).to eq('placename')
+    end
+
+    it "should return facet_mode" do
+      expect(subject.send(:facet_mode)).to eq('geojson')
+    end
+
+    it "should return placename_property" do
+      expect(subject.send(:placename_property)).to eq('placename')
+    end
 
-  it "should return point feature with no properties" do
-    expect(subject.send(:build_point_feature, 100, -50)).to eq({:type=>"Feature", :geometry=>{:type=>"Point", :coordinates=>[100.0, -50.0]}, :properties=>{}})
   end
 
-  it "should return point feature with properties" do
-    expect(subject.send(:build_point_feature, 100, -50, { name: 'Jane Smith' })[:properties]).to have_key(:name)
+  describe "build_feature_from_geojson" do
+
+    describe "point feature" do
+
+      before do
+        @output = subject.send(:build_feature_from_geojson, '{"type":"Feature","geometry":{"type":"Point","coordinates":[104.195397,35.86166]},"properties":{"placename":"China"}}', 1)
+      end
+
+      it "should have a hits property with the right value" do
+        expect(@output[:properties]).to have_key(:hits)
+        expect(@output[:properties][:hits]).to eq(1)
+      end
+
+      it "should have a popup property" do
+        expect(@output[:properties]).to have_key(:popup)
+      end
+
+    end
+
+    describe "bbox feature" do
+
+      describe "catalog#index view" do
+
+        before do
+          @output = subject.send(:build_feature_from_geojson, '{"type":"Feature","geometry":{"type":"Polygon","coordinates":[[[68.162386, 6.7535159], [97.395555, 6.7535159], [97.395555, 35.5044752], [68.162386, 35.5044752], [68.162386, 6.7535159]]]},"bbox":[68.162386, 6.7535159, 97.395555, 35.5044752]}', 1)
+        end
+
+        it "should set the center point as the coordinates" do
+          expect(@output[:geometry][:coordinates]).to eq([82.7789705, 21.12899555])
+        end
+
+        it "should change the geometry type to 'Point'" do
+          expect(@output[:geometry][:type]).to eq("Point")
+          expect(@output[:bbox]).to be_nil
+        end
+
+      end
+
+    end
+
   end
 
-  it "should build bbox correct features" do
-    expect(subject.send(:build_bbox_features).length).to eq(1)
-    expect(subject.send(:build_bbox_features)[0][:geometry][:type]).to eq('Point')
+  describe "build_feature_from_coords" do
+
+    describe "point feature" do
+
+      before do
+        @output = subject.send(:build_feature_from_coords, '35.86166,104.195397', 1)
+      end
+
+      it "should create a GeoJSON feature hash" do
+        expect(@output.class).to eq(Hash)
+        expect(@output[:type]).to eq("Feature")
+      end
+
+      it "should have the right coordinates" do
+        expect(@output[:geometry][:coordinates]).to eq([104.195397, 35.86166])
+      end
+
+      it "should have a hits property with the right value" do
+        expect(@output[:properties]).to have_key(:hits)
+        expect(@output[:properties][:hits]).to eq(1)
+      end
+
+      it "should have a popup property" do
+        expect(@output[:properties]).to have_key(:popup)
+      end
+
+    end
+
+    describe "bbox feature" do
+
+      describe "catalog#index view" do
+
+        before do
+          @output = subject.send(:build_feature_from_coords, '68.162386 6.7535159 97.395555 35.5044752', 1)
+        end
+
+        it "should set the center point as the coordinates" do
+          expect(@output[:geometry][:type]).to eq("Point")
+          expect(@output[:geometry][:coordinates]).to eq([82.7789705, 21.12899555])
+        end
+
+      end
+
+      describe "catalog#show view" do
+
+        before do
+          @action = "show"
+          @output = subject.send(:build_feature_from_coords, '68.162386 6.7535159 97.395555 35.5044752', 1)
+        end
+
+        it "should convert the bbox string to a polygon coordinate array" do
+          expect(@output[:geometry][:type]).to eq("Polygon")
+          expect(@output[:geometry][:coordinates]).to eq([[[68.162386, 6.7535159], [97.395555, 6.7535159], [97.395555, 35.5044752], [68.162386, 35.5044752], [68.162386, 6.7535159]]])
+        end
+
+        it "should set the bbox member" do
+          expect(@output[:bbox]).to eq([68.162386, 6.7535159, 97.395555, 35.5044752])
+        end
+
+      end
+
+    end
+
   end
 
-  it "should render correct sidebar div" do
-    expect(subject.send(:render_leaflet_sidebar_partial, @response.docs[0])).to include('href="/catalog/2008308478')
+  describe "render_leaflet_popup_content" do
+
+    describe "placename_facet search_mode" do
+
+      it "should render the map_placename_search partial if the placename is present" do
+        expect(subject.send(:render_leaflet_popup_content, {type:"Feature",geometry:{type:"Point",coordinates:[104.195397,35.86166]},properties:{placename:"China", hits:1}})).to include('href="/catalog?f%5Bplacename_field%5D%5B%5D=China')
+      end
+
+      it "should render the map_spatial_search partial if the placename is not present" do
+        expect(subject.send(:render_leaflet_popup_content, {type:"Feature",geometry:{type:"Point",coordinates:[104.195397,35.86166]},properties:{hits:1}})).to include('href="/catalog?coordinates=35.86166%2C104.195397&spatial_search_type=point')
+      end
+
+    end
+
+    describe "coordinates search_mode" do
+
+      before do
+        CatalogController.configure_blacklight do |config|
+          config.view.maps.search_mode = 'coordinates'
+        end
+      end
+
+      it "should render the map_spatial_search partial" do
+        expect(subject.send(:render_leaflet_popup_content, {type:"Feature",geometry:{type:"Point",coordinates:[104.195397,35.86166]},properties:{hits:1}})).to include('href="/catalog?coordinates=35.86166%2C104.195397&spatial_search_type=point')
+      end
+
+    end
+
   end
 
-  it "should render feature collection as json" do
-    expect(subject.to_geojson).to include('{"type":"FeatureCollection","features":[{"type":"Feature","geometry":{"type":"Point"')
+  describe "build_geojson_features" do
+
+    before do
+      @action = "show"
+    end
+
+    it "should create an array of features" do
+      expect(BlacklightMaps::GeojsonExport.new(@controller, @action, @response.docs[0]).send(:build_geojson_features).blank?).to be false
+    end
+
   end
 
+  describe "to_geojson" do
+
+    before do
+      @action = "show"
+    end
+
+    it "should render feature collection as json" do
+      expect(BlacklightMaps::GeojsonExport.new(@controller, @action, @response.docs[0]).send(:to_geojson)).to include('{"type":"FeatureCollection","features":[{"type":"Feature","geometry":{"type":"Point"')
+    end
+
+  end
 
 end

data/spec/lib/blacklight/maps/render_constraints_override_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+describe BlacklightMaps::RenderConstraintsOverride do
+
+  class BlacklightMapsControllerTestClass < CatalogController
+    attr_accessor :params
+  end
+
+  before(:each) do
+    @fake_controller = BlacklightMapsControllerTestClass.new
+    @fake_controller.extend(BlacklightMaps::RenderConstraintsOverride)
+    @fake_controller.params = { coordinates: "35.86166,104.195397", spatial_search_type: "point" }
+  end
+
+  describe "testing for spatial parameters" do
+
+    describe "has_spatial_parameters?" do
+
+      it "should be true if coordinate params are present" do
+        expect(@fake_controller.has_spatial_parameters?).to be true
+      end
+
+    end
+
+    describe "has_search_parameters?" do
+
+      it "should be true if coordinate params are present" do
+        expect(@fake_controller.has_search_parameters?).to be true
+      end
+
+    end
+
+  end
+
+  describe "render spatial constraints" do
+
+    before do
+      @test_params = @fake_controller.params
+    end
+
+    describe "query_has_constraints?" do
+
+      it "should be true if there are coordinate params" do
+        expect(@fake_controller.query_has_constraints?).to be true
+      end
+
+    end
+
+    describe "spatial_constraint_label" do
+
+      it "should return the point label" do
+        expect(@fake_controller.spatial_constraint_label(@test_params)).to eq(I18n.t('blacklight.search.filters.coordinates.point'))
+      end
+
+      it "should return the bbox label" do
+        @test_params = { spatial_search_type: "bbox" }
+        expect(@fake_controller.spatial_constraint_label(@test_params)).to eq(I18n.t('blacklight.search.filters.coordinates.bbox'))
+      end
+
+    end
+
+    describe "render_spatial_query" do
+
+      before :each do
+        # have to create a request or call to 'url _for' returns an error
+        @fake_controller.request = ActionDispatch::Request.new(params:{controller: 'catalog', action: 'index'})
+        @fake_controller.request.path_parameters[:controller] = 'catalog'
+      end
+
+      # TODO: can't get these specs to pass, getting error:
+      # NoMethodError: undefined method `render_constraint_element'
+
+      it "should render the coordinates" #do
+        #expect(@fake_controller.render_spatial_query(@test_params)).to have_content(@fake_controller.params[:coordinates])
+      #end
+
+      it "should remove spatial params in the 'remove' link" #do
+        #expect(@fake_controller.render_spatial_query(@test_params)).to_not have_content("spatial_search_type")
+      #end
+
+    end
+
+    describe "render_search_to_s_coord" do
+
+      it "should return render_search_to_s_element when coordinates are present" do
+        expect(@fake_controller).to receive(:render_search_to_s_element)
+        expect(@fake_controller).to receive(:render_filter_value)
+        @fake_controller.render_search_to_s_coord(@test_params)
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -34,5 +34,5 @@ require 'capybara/rspec'
 
 
 RSpec.configure do |config|
-
+  config.infer_spec_type_from_file_location!
 end

data/spec/test_app_templates/Gemfile.extra

@@ -3,5 +3,3 @@
 gem 'leaflet-rails'
 
 gem 'leaflet-markercluster-rails'
-
-gem 'leaflet-sidebar-rails', '0.0.1', git: 'https://github.com/mejackreed/leaflet-sidebar-rails'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-maps
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Chris Beer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-03 00:00:00.000000000 Z
+date: 2015-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -81,20 +81,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: leaflet-sidebar-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -129,14 +115,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: jettywrapper
   requirement: !ruby/object:Gem::Requirement
@@ -211,30 +197,42 @@ files:
 - app/assets/javascripts/blacklight-maps/blacklight-maps-browse.js
 - app/assets/stylesheets/blacklight_maps/blacklight-maps.css.scss
 - app/assets/stylesheets/blacklight_maps/default.css.scss
+- app/helpers/blacklight/blacklight_maps_helper_behavior.rb
 - app/helpers/blacklight_maps_helper.rb
 - app/views/catalog/_document_maps.html.erb
-- app/views/catalog/_index_maps.html.erb
+- app/views/catalog/_index_map.html.erb
+- app/views/catalog/_map_placename_search.html.erb
+- app/views/catalog/_map_spatial_search.html.erb
+- app/views/catalog/_show_maplet_default.html.erb
+- app/views/catalog/map.html.erb
 - blacklight-maps.gemspec
 - config/jetty.yml
 - config/locales/blacklight-maps.en.yml
 - config/routes.rb
-- docs/map-sidebar.png
-- docs/map-view.png
+- docs/blacklight-maps_index-view.png
+- docs/blacklight-maps_map-view.png
+- docs/blacklight-maps_search-control.png
+- docs/blacklight-maps_show-view.png
 - lib/blacklight/maps.rb
+- lib/blacklight/maps/controller_override.rb
 - lib/blacklight/maps/engine.rb
 - lib/blacklight/maps/export.rb
 - lib/blacklight/maps/geometry.rb
+- lib/blacklight/maps/render_constraints_override.rb
 - lib/blacklight/maps/version.rb
 - lib/generators/blacklight_maps/install_generator.rb
 - lib/generators/blacklight_maps/templates/blacklight_maps.css.scss
 - lib/railties/blacklight_maps.rake
 - solr_conf/conf/schema.xml
 - solr_conf/conf/solrconfig.xml
+- spec/controllers/catalog_controller_spec.rb
 - spec/features/maps_spec.rb
 - spec/fixtures/sample_solr_documents.yml
 - spec/helpers/blacklight_maps_helper_spec.rb
+- spec/lib/blacklight/maps/controller_override_spec.rb
 - spec/lib/blacklight/maps/export_spec.rb
 - spec/lib/blacklight/maps/geometry_spec.rb
+- spec/lib/blacklight/maps/render_constraints_override_spec.rb
 - spec/spec_helper.rb
 - spec/test_app_templates/Gemfile.extra
 - spec/test_app_templates/lib/generators/test_app_generator.rb
@@ -263,11 +261,14 @@ signing_key:
 specification_version: 4
 summary: Maps for Blacklight
 test_files:
+- spec/controllers/catalog_controller_spec.rb
 - spec/features/maps_spec.rb
 - spec/fixtures/sample_solr_documents.yml
 - spec/helpers/blacklight_maps_helper_spec.rb
+- spec/lib/blacklight/maps/controller_override_spec.rb
 - spec/lib/blacklight/maps/export_spec.rb
 - spec/lib/blacklight/maps/geometry_spec.rb
+- spec/lib/blacklight/maps/render_constraints_override_spec.rb
 - spec/spec_helper.rb
 - spec/test_app_templates/Gemfile.extra
 - spec/test_app_templates/lib/generators/test_app_generator.rb