blacklight_dynamic_sitemap 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efd092440ea6b487972636c1b219cf17a6d1afcf2f10f75d2892125719ce7772
-  data.tar.gz: 96b2a345f4b6b03cf39b3316bb6581b439511214e245c8d6ab47c674ec2d74bf
+  metadata.gz: 0431ca04258abb8bdf5be705182e582d055b095a958ac9d6c5d241a05e50d598
+  data.tar.gz: ad93828dbb262af9346ba3c7dd1fc1b78d86edcc46986c0ba0a06009212a024d
 SHA512:
-  metadata.gz: 017c6c3459d3fb722cf3bc05eea855c8c33f8f63d622cfa3713149f20a932a31b6620b03f865a6f78a02658b631a67071f14780a524503e8e3b244e036888949
-  data.tar.gz: 11ea817570658dffaf136c425dddc374dcba98d49fab21808d6250e37c7f168d03ceb274f91f0edd1f864299eb5c9dbf3139a2c5a7dda60fad5640462c6dc685
+  metadata.gz: 25eb795290afff88d8fc55b597dcc6dd8f0eacb91ca4010a62c0c179324862749918dbe6898f8e27a6edb972e6acf9f84c5f9ceecc208a5a067e34f6e27cc877
+  data.tar.gz: ed8d361d36c650df61fc761316a53f35c1689daac1545e09f6fe8a925fa0e9dcf0d27de4614087e40baf3c2ee918583b28b660057f6fd64db5782cfe7411d856

data/.github/workflows/ruby.yml

@@ -0,0 +1,37 @@
+
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  tests:
+    strategy:
+      fail-fast: false
+      matrix:
+        rails: ['5.2.4.4', '6.0.3.4']
+
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+    - uses: actions/cache@v2
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-gems-
+    - name: Bundle install
+      env:
+        RAILS_VERSION: ${{ matrix.rails }}
+      run: |
+        bundle config path vendor/bundle
+        bundle install
+    - name: Run tests
+      run: bundle exec rake

data/README.md

@@ -44,6 +44,9 @@ This gem offers several configuration options that can be configured in a Rails
 
 See [engine.rb](https://github.com/sul-dlss/blacklight_dynamic_sitemap/blob/master/lib/blacklight_dynamic_sitemap/engine.rb) for available configurations.
 
+### Rails version compatibility note
+Note that the gemspec does not list a lower threshold for Rails version compatibility. This gem has been anecdotally demonstrated to work fine as low as Rails 4.2, but maintaining compatibility of the test suite with rails <5.0 was more complex than practical benefits warranted. Exercise caution when using with Rails <5.0.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake ci` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/app/models/blacklight_dynamic_sitemap/sitemap.rb

@@ -7,14 +7,19 @@ module BlacklightDynamicSitemap
     delegate :hashed_id_field, :unique_id_field, :last_modified_field, to: :engine_config
 
     def get(id)
+      # if someone's hacking URLs (in ways that could potentially generate enormous requests),
+      # just return an empty response
+      return [] if id.length != exponent
+
       index_connection.select(
-        params: {
-          q: "{!prefix f=#{hashed_id_field} v=#{id}}",
+        params: show_params(id, {
+          q: '*:*',
+          fq: ["{!prefix f=#{hashed_id_field} v=#{id}}"],
           fl: [unique_id_field, last_modified_field].join(','),
           rows: 2_000_000, # Ensure that we do not page this result
           facet: false,
           defType: 'lucene'
-        }
+        })
       ).dig('response', 'docs')
     end
 
@@ -24,6 +29,14 @@ module BlacklightDynamicSitemap
 
     private
 
+    def show_params(id, default_params)
+      engine_config.modify_show_params&.call(id, default_params) || default_params
+    end
+
+    def index_params(default_params)
+      engine_config.modify_index_params&.call(default_params) || default_params
+    end
+
     def index_connection
       @index_connection ||= Blacklight.default_index.connection
     end
@@ -34,10 +47,10 @@ module BlacklightDynamicSitemap
 
     def max_documents
       key = 'blacklight_dynamic_sitemap.index_max_docs'
-      expiration = BlacklightDynamicSitemap::Engine.config.max_documents_expiration
+      expiration = engine_config.max_documents_expiration
       Rails.cache.fetch(key, expires_in: expiration) do
-        Blacklight.default_index.connection.select(
-          params: { q: '*:*', rows: 0, facet: false }
+        index_connection.select(
+          params: index_params({ q: '*:*', rows: 0, facet: false })
         )['response']['numFound']
       end
     end

data/app/views/blacklight_dynamic_sitemap/sitemap/show.xml.builder

@@ -6,10 +6,12 @@ xml.urlset(
   'xsi:schemaLocation' => 'http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd',
   'xmlns' => 'http://www.sitemaps.org/schemas/sitemap/0.9'
 ) do
+  config = BlacklightDynamicSitemap::Engine.config
   @sitemap_entries.each do |doc|
     xml.url do
-      xml.loc(main_app.solr_document_url(doc[BlacklightDynamicSitemap::Engine.config.unique_id_field]))
-      xml.lastmod(doc[BlacklightDynamicSitemap::Engine.config.last_modified_field])
+      xml.loc(main_app.solr_document_url(doc[config.unique_id_field]))
+      last_modified = doc[config.last_modified_field]
+      xml.lastmod(config.format_last_modified&.call(last_modified) || last_modified)
     end
   end
 end

data/blacklight_dynamic_sitemap.gemspec

@@ -24,7 +24,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'rails', '>= 5.2', '<= 6.1'
+  # Rails <5.0 is not covered by the automated test suite (see `.github/workflows/ruby.yml`).
+  # Anecdotally demonstrated to work fine on Rails as low as 4.2, but any lower version
+  # threshold would be arbitrary.
+  spec.add_dependency 'rails', '<= 6.1'
   spec.add_dependency 'blacklight', '> 6.0'
 
   spec.add_development_dependency 'capybara'

data/lib/blacklight_dynamic_sitemap/engine.rb

@@ -8,5 +8,8 @@ module BlacklightDynamicSitemap
     config.hashed_id_field = 'hashed_id_ssi'
     config.unique_id_field = 'id'
     config.last_modified_field = 'timestamp'
+    config.modify_show_params = nil # lambda { |id, default_params| default_params }
+    config.modify_index_params = nil # lambda { |default_params| default_params }
+    config.format_last_modified = nil # lambda { |raw_last_modified| raw_last_modified }
   end
 end

data/lib/blacklight_dynamic_sitemap/version.rb

@@ -1,3 +1,3 @@
 module BlacklightDynamicSitemap
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,22 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: blacklight_dynamic_sitemap
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jack Reed
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-29 00:00:00.000000000 Z
+date: 2020-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.2'
     - - "<="
       - !ruby/object:Gem::Version
         version: '6.1'
@@ -24,9 +21,6 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.2'
     - - "<="
       - !ruby/object:Gem::Version
         version: '6.1'
@@ -107,10 +101,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".solr_wrapper"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md

data/.travis.yml

@@ -1,14 +0,0 @@
----
-language: ruby
-cache: bundler
-
-matrix:
-  include:
-    - env: RAILS_VERSION=6.0.3.2
-    - env: RAILS_VERSION=5.2.4.3
-
-rvm:
-  - 2.7.1
-notifications:
-  email: false
-jdk: openjdk11