blacklight_oai_provider 6.1.1 → 7.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b8abebeaa16868fc1ad106d29bc74be140a2c3bcd1452ca77d80a305c54ff71
-  data.tar.gz: fa4142efe30c1183c79b4f5a96a74ed7b6c8fa4c13d9622b1f8aa3e644b9fceb
+  metadata.gz: 39f7c456bbf8371097aace1c69c879de3c82cae03abe1102a45947a3f99dbc22
+  data.tar.gz: e4482b6884c20cd0abf3cd5f623ed31cba3a1d9294dd1fff1373dbd8d7856043
 SHA512:
-  metadata.gz: 951af42d0f21f58fd0af44277b59c640e6de517da49fc4eaa2e06ada02627be0c8465aa080b6924f8ef13062795718bff8f9d90bfd16e736cfbf4205d26ba36b
-  data.tar.gz: 24bbe4772cd6cead1db8519c9719b294b1439ffe314e472e82455cfd39135a5c5cdf53c8746d7b59d99d014015ee37a40026903e1ad5928540ab233ecd08a0df
+  metadata.gz: 721117f9ed5c2a0c15fd76bf5d2e7dd89df953f42229b63b8d4534ffd5167a8341c2770eb8dc514d0c28488581bf075482f05115b770e560c699b4f582108c5b
+  data.tar.gz: cb176cc115eb16e5bc06e0b46b84e673cb8be3713bb24babeb671601612ae6c15e75de2f9f7176d04f12fbfda420be398633bafbb5329ca52880155cf6bdf8da

data/.github/workflows/ci.yml

@@ -10,57 +10,28 @@ name: CI
 on: push
 
 jobs:
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 2.6
-      - name: Install dependencies
-        run: bundle install
-        env:
-          RAILS_VERSION: 5.2.4.4
-      - name: Run linter
-        run: bundle exec rubocop
-  test_rails5_2:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby: [2.6]
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-      - name: Install dependencies
-        run: bundle install
-        env:
-          RAILS_VERSION: 5.2.4.4
-      - name: Run tests
-        run: bundle exec rake ci
-        env:
-          RAILS_VERSION: 5.2.4.4
-          ENGINE_CART_RAILS_OPTIONS: '--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test'
-  test_rails5_1:
+  test:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: [2.5]
+        rails_version: [6.1.4.7, 7.0.2.3]
+        ruby: [2.7, '3.0']
+        include:
+          - ruby: 2.7
+            rails: 5.2.6.3
+          - ruby: 2.7
+            rails: 6.0.3.7
+    env:
+      RAILS_VERSION: ${{ matrix.rails_version }}
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-      - name: Install dependencies
-        run: bundle install
-        env:
-          RAILS_VERSION: 5.1.7
-      - name: Run tests
-        run: bundle exec rake ci
-        env:
-          RAILS_VERSION: 5.1.7
-          ENGINE_CART_RAILS_OPTIONS: '--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test'
+    - uses: actions/checkout@v2
+    - name: Set up Ruby ${{ matrix.ruby }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies with Rails ${{ matrix.rails_version }}
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake
+      env:
+        ENGINE_CART_RAILS_OPTIONS: '--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test'

data/.rubocop.yml

@@ -4,8 +4,8 @@ inherit_from:
   - .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 2.3
   DisplayCopNames: true
+  TargetRubyVersion: 2.2
   Exclude:
   - "blacklight_oai_provider.gemspec"
 
@@ -50,6 +50,3 @@ Style/Documentation:
 Lint/UnusedMethodArgument:
   Exclude:
   - 'lib/blacklight_oai_provider/set.rb'
-
-RSpec/NestedGroups:
-  Enabled: false

data/.rubocop_todo.yml

@@ -1,14 +1,22 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2017-11-09 12:27:39 -0500 using RuboCop version 0.50.0.
+# on 2022-04-26 10:02:10 -0400 using RuboCop version 0.64.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 4
+# Cop supports --auto-correct.
+Layout/EmptyLineAfterGuardClause:
+  Exclude:
+    - 'app/models/concerns/blacklight_oai_provider/solr_document.rb'
+    - 'lib/blacklight_oai_provider/solr_document_wrapper.rb'
+    - 'lib/blacklight_oai_provider/solr_set.rb'
+
 # Offense count: 2
 # Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
+# Configuration parameters: EnforcedStyle.
 # SupportedStyles: empty_lines, no_empty_lines
 Layout/EmptyLinesAroundBlockBody:
   Exclude:
@@ -18,10 +26,10 @@ Layout/EmptyLinesAroundBlockBody:
 Metrics/AbcSize:
   Max: 28
 
-# Offense count: 3
-# Configuration parameters: CountComments.
+# Offense count: 4
+# Configuration parameters: CountComments, ExcludedMethods.
 Metrics/MethodLength:
-  Max: 47
+  Max: 46
 
 # Offense count: 2
 RSpec/BeforeAfterAll:
@@ -31,6 +39,16 @@ RSpec/BeforeAfterAll:
     - 'spec/support/**/*.rb'
     - 'spec/requests/list_identifiers_spec.rb'
 
+# Offense count: 15
+# Configuration parameters: Prefixes.
+# Prefixes: when, with, without
+RSpec/ContextWording:
+  Exclude:
+    - 'spec/lib/blacklight_oai_provider/solr_document_wrapper_spec.rb'
+    - 'spec/lib/blacklight_oai_provider/solr_set_spec.rb'
+    - 'spec/requests/list_identifiers_spec.rb'
+    - 'spec/requests/list_records_spec.rb'
+
 # Offense count: 1
 # Configuration parameters: CustomIncludeMethods.
 RSpec/EmptyExampleGroup:
@@ -49,12 +67,19 @@ RSpec/InstanceVariable:
   Exclude:
     - 'spec/lib/blacklight_oai_provider/solr_document_wrapper_spec.rb'
 
-# Offense count: 9
+# Offense count: 1
+# Cop supports --auto-correct.
+RSpec/LeadingSubject:
+  Exclude:
+    - 'spec/models/solr_document_spec.rb'
+
+# Offense count: 14
+# Configuration parameters: AggregateFailuresByDefault.
 RSpec/MultipleExpectations:
   Max: 2
 
 # Offense count: 2
-# Configuration parameters: EnforcedStyle, SupportedStyles.
+# Configuration parameters: EnforcedStyle.
 # SupportedStyles: strict, flexible
 Rails/TimeZone:
   Exclude:
@@ -62,7 +87,7 @@ Rails/TimeZone:
 
 # Offense count: 1
 # Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles, ProceduralMethods, FunctionalMethods, IgnoredMethods.
+# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, IgnoredMethods.
 # SupportedStyles: line_count_based, semantic, braces_for_chaining
 # ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
 # FunctionalMethods: let, let!, subject, watch
@@ -71,21 +96,25 @@ Style/BlockDelimiters:
   Exclude:
     - 'spec/models/solr_document_spec.rb'
 
-# Offense count: 3
+# Offense count: 1
 # Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
+# Configuration parameters: EnforcedStyle.
 # SupportedStyles: braces, no_braces, context_dependent
 Style/BracesAroundHashParameters:
   Exclude:
-    - 'lib/blacklight_oai_provider/solr_document_wrapper.rb'
     - 'spec/models/solr_document_spec.rb'
 
-# Offense count: 31
+# Offense count: 2
+Style/CommentedKeyword:
+  Exclude:
+    - 'lib/blacklight_oai_provider/solr_document_wrapper.rb'
+    - 'lib/blacklight_oai_provider/solr_set.rb'
+
+# Offense count: 1
 # Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-# SupportedStyles: when_needed, always, never
-Style/FrozenStringLiteralComment:
-  Enabled: false
+Style/ExpandPathArguments:
+  Exclude:
+    - 'spec/test_app_templates/lib/generators/test_app_generator.rb'
 
 # Offense count: 2
 # Configuration parameters: MinBodyLength.
@@ -93,9 +122,15 @@ Style/GuardClause:
   Exclude:
     - 'lib/generators/blacklight_oai_provider/install_generator.rb'
 
-# Offense count: 2
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/IfUnlessModifier:
+  Exclude:
+    - 'lib/blacklight_oai_provider/solr_document_wrapper.rb'
+
+# Offense count: 3
 # Cop supports --auto-correct.
-# Configuration parameters: MinSize, SupportedStyles.
+# Configuration parameters: MinSize.
 # SupportedStyles: percent, brackets
 Style/SymbolArray:
   EnforcedStyle: brackets

data/.solr_wrapper

@@ -1,7 +1,6 @@
 # Place any default configuration for solr_wrapper here
 port: 8983
 verbose: true
-version: 8.6.2
 managed: true
 collection:
   dir: solr/conf/

data/README.md

@@ -13,8 +13,14 @@ A few maintenance branches have been left in place in case there is interest to
 
 `v4.x` -> Support for Blacklight 4.0 and Rails 3.0
 
+`release-5.x` -> Support for Blacklight 5.x
+
+`release-6.x` -> Support for Blacklight 6.x
+
+`release-7.x` -> Support for Blacklight 7.x
+
 ## Requirements
-A Rails app running Rails 4.x and Blacklight 4.x.
+A Rails app running Rails 6.x and Blacklight 7.x.
 
 OAI-PMH requires a timestamp field for all records. The Solr index should include an appropriate field. This field should be able to support date range queries. By default, the name of this field is `timestamp` (more on how to configure this [below](#solrdocument-configuration)).
 
@@ -75,7 +81,7 @@ configure_blacklight do |config|
       sample_id: '109660'
     },
     document: {
-      limit: 25            # number of records returned with each request, default: 15
+      limit: 25,            # number of records returned with each request, default: 15
       set_fields: [        # ability to define ListSets, optional, default: nil
         { label: 'language', solr_field: 'language_facet' }
       ]
@@ -86,7 +92,7 @@ configure_blacklight do |config|
 end
 ```
 
-The "provider" configuration is documented as part of the ruby-oai gem at http://oai.rubyforge.org/
+The "provider" configuration is documented as part of the ruby-oai gem at https://github.com/code4lib/ruby-oai and can be lambdas for dynamic configuration (e.g. `repository_name: ->(controller) { controller.send(:repository_name) }`).
 
 A basic set model is included that maps Solr fields to OAI sets. Provide `set_fields` with an array of hashes defining the solr_field, and optionally a label and description. The configuration above will cause the `ListSets` verb to query Solr for unique values of the `language_facet` field and present each value as a set using a spec format of `language:value`. When the `set` parameter is supplied to the `ListRecords` verb, it will append a filter to the Solr query of the form `fq=language_facet:value`. If no label is provided, the set will use the `solr_field` name. To customize the ListSet implementation, see [customizing listsets](#customizing-listsets).
 
@@ -144,6 +150,21 @@ config.oai = {
 }
 ```
 
+### Disable pretty print stylesheet
+
+By default, this gem pretty prints results in the browser using an XSLT stylesheet. You can change this behavior by overriding this stylesheet with a custom stylesheet containing an identity transform. In your app, create a file named `app/assets/stylesheets/blacklight_oai_provider/oai2.xsl` containing the following XSLT:
+
+```xml
+<?xml version="1.0" ?>
+<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+  <xsl:template match="/ | @* | node()">
+  <xsl:copy>
+    <xsl:apply-templates select="@* | node()" />
+  </xsl:copy>
+  </xsl:template>
+</xsl:stylesheet>
+```
+
 ## Tests
 We use `engine_cart` and `solr_wrapper` to run tests on a dummy instance of an app using this plugin.
 

data/VERSION

@@ -1 +1 @@
-6.1.1
+7.0.2

data/blacklight_oai_provider.gemspec

@@ -16,8 +16,9 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency "blacklight", "~> 6.0"
-  s.add_dependency "oai", "~> 1.0"
+  s.add_dependency "blacklight", "~> 7.0"
+  s.add_dependency "oai", "~> 1.2"
+  s.add_dependency "rexml"
   s.add_development_dependency 'rspec-rails'
   s.add_development_dependency 'capybara'
   s.add_development_dependency 'solr_wrapper'
@@ -25,6 +26,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'webdrivers', '~> 3.0'
   s.add_development_dependency 'selenium-webdriver', '>= 3.13.1'
   s.add_development_dependency 'byebug'
-  s.add_development_dependency 'rubocop', '~> 0.50.0'
-  s.add_development_dependency "rubocop-rspec", '~> 1.18.0'
+  s.add_development_dependency 'rubocop', '~> 0.64.0'
+  s.add_development_dependency "rubocop-rspec", '~> 1.8'
 end

data/lib/blacklight_oai_provider/solr_document_provider.rb

@@ -2,23 +2,42 @@ module BlacklightOaiProvider
   class SolrDocumentProvider < ::OAI::Provider::Base
     attr_accessor :options
 
-    def initialize(controller, options = {})
-      options[:provider] ||= {}
-      options[:document] ||= {}
-
-      self.class.model = SolrDocumentWrapper.new(controller, options[:document])
+    PROVIDER_INSTANCE_ATTRS = {
+      name: :repository_name,
+      url: :repository_url,
+      prefix: :record_prefix,
+      email: :admin_email,
+      delete_support: :deletion_support,
+      granularity: :update_granularity,
+      model: :source_model,
+      identifier: :sample_id,
+      description: :extra_description
+    }.freeze
 
-      options[:provider][:repository_name] ||= controller.view_context.application_name
-      options[:provider][:repository_url] ||= controller.view_context.oai_catalog_url
+    def initialize(controller, options = {})
+      super(options.merge(provider_context: :instance_based))
 
-      options[:provider].each do |k, v|
+      provider_options = convert_to_instance_options(options.fetch(:provider, {}))
+      provider_options[:granularity] ||= OAI::Const::Granularity::HIGH
+      wrapper_options = options.fetch(:document, {}).dup.merge(granularity: provider_options[:granularity])
+      provider_options[:model] ||= SolrDocumentWrapper.new(controller, wrapper_options)
+      provider_options[:name] ||= controller.view_context.application_name
+      provider_options[:url] ||= controller.view_context.oai_catalog_url
+      provider_options.each do |k, v|
         v = v.call(controller) if v.is_a?(Proc)
-        self.class.send k, v
+        send :"#{k}=", v
       end
     end
 
     def list_sets(options = {})
-      Response::ListSets.new(self.class, options).to_xml
+      BlacklightOaiProvider::Response::ListSets.new(self, options).to_xml
+    end
+
+    def convert_to_instance_options(controller_options)
+      instance_options = controller_options.dup
+      PROVIDER_INSTANCE_ATTRS.each { |inst_att, class_att| instance_options[inst_att] ||= instance_options.delete(class_att) }
+      instance_options.delete_if { |k, _v| PROVIDER_INSTANCE_ATTRS[k].nil? }
+      instance_options
     end
   end
 end

data/lib/blacklight_oai_provider/solr_document_wrapper.rb

@@ -1,6 +1,6 @@
 module BlacklightOaiProvider
   class SolrDocumentWrapper < ::OAI::Provider::Model
-    attr_reader :document_model, :timestamp_field, :solr_timestamp, :limit
+    attr_reader :document_model, :timestamp_field, :solr_timestamp, :limit, :granularity
 
     def initialize(controller, options = {})
       @controller      = controller
@@ -9,6 +9,7 @@ module BlacklightOaiProvider
       @timestamp_field = 'timestamp' # method name used by ruby-oai
       @limit           = options[:limit] || 15
       @set             = options[:set_model] || BlacklightOaiProvider::SolrSet
+      @granularity = options[:granularity] || OAI::Const::Granularity::HIGH
 
       @set.controller = @controller
       @set.fields = options[:set_fields]
@@ -18,36 +19,41 @@ module BlacklightOaiProvider
       @set.all
     end
 
+    def search_service
+      @controller.search_service
+    end
+
     def earliest
-      builder = @controller.search_builder.merge(fl: solr_timestamp, sort: "#{solr_timestamp} asc", rows: 1)
-      response = @controller.repository.search(builder)
-      response.documents.first.timestamp
+      builder = search_service.search_builder.merge(fl: solr_timestamp, sort: "#{solr_timestamp} asc", rows: 1)
+      response = search_service.repository.search(builder)
+      timestamp_presence(response.documents.first)
     end
 
     def latest
-      builder = @controller.search_builder.merge(fl: solr_timestamp, sort: "#{solr_timestamp} desc", rows: 1)
-      response = @controller.repository.search(builder)
-      response.documents.first.timestamp
+      builder = search_service.search_builder.merge(fl: solr_timestamp, sort: "#{solr_timestamp} desc", rows: 1)
+      response = search_service.repository.search(builder)
+      timestamp_presence(response.documents.first)
     end
 
     def find(selector, options = {})
       return next_set(options[:resumption_token]) if options[:resumption_token]
 
       if selector == :all
-        response = @controller.repository.search(conditions(options))
+        response = search_service.repository.search(conditions(options))
 
         if limit && response.total > limit
           return select_partial(BlacklightOaiProvider::ResumptionToken.new(options.merge(last: 0), nil, response.total))
         end
         response.documents
       else
-        query = @controller.search_builder.where(document_model.unique_key => selector).query
-        @controller.repository.search(query).documents.first
+        # search_service.fetch(selector).first.documents.first
+        query = search_service.search_builder.where(id: selector).query
+        search_service.repository.search(query).documents.first
       end
     end
 
     def select_partial(token)
-      records = @controller.repository.search(token_conditions(token)).documents
+      records = search_service.repository.search(token_conditions(token)).documents
 
       raise ::OAI::ResumptionTokenException unless records
 
@@ -61,33 +67,59 @@ module BlacklightOaiProvider
       select_partial(token)
     end
 
+    def conditions(constraints) # conditions/query derived from options
+      query = search_service.search_builder.merge(sort: "#{solr_timestamp} asc", rows: limit).query
+
+      if constraints[:from].present? || constraints[:until].present?
+        from_val = solr_date(constraints[:from])
+        to_val = solr_date(constraints[:until], true)
+        if from_val == to_val
+          query.append_filter_query("#{solr_timestamp}:\"#{from_val}\"")
+        else
+          query.append_filter_query("#{solr_timestamp}:[#{from_val} TO #{to_val}]")
+        end
+      end
+
+      query.append_filter_query(@set.from_spec(constraints[:set])) if constraints[:set].present?
+      query
+    end
+
     private
 
     def token_conditions(token)
       conditions(token.to_conditions_hash).merge(start: token.last)
     end
 
-    def conditions(options) # conditions/query derived from options
-      query = @controller.search_builder.merge(sort: "#{solr_timestamp} asc", rows: limit).query
-
-      if options[:from].present? || options[:until].present?
-        query.append_filter_query(
-          "#{solr_timestamp}:[#{solr_date(options[:from])} TO #{solr_date(options[:until]).gsub('Z', '.999Z')}]"
-        )
+    def solr_date(time, end_val = false)
+      return '*' if time.blank?
+      case time
+      when Date
+        return granularize_date_value(time, end_val)
+      when Time
+        return granularize_time_value(time, end_val)
+      else
+        return time.to_s
       end
+    end
 
-      query.append_filter_query(@set.from_spec(options[:set])) if options[:set].present?
-      query
+    def granularize_date_value(value, end_val)
+      return value.xmlschema[0..9] if granularity == OAI::Const::Granularity::LOW
+
+      # get last second of the day if end of range, else use first second of day
+      value = end_val ? Time.xmlschema((value + 1).xmlschema) - 1 : Time.xmlschema(value.xmlschema)
+      granularize_time_value(value, end_val)
     end
 
-    def solr_date(time)
-      if time.respond_to?(:xmlschema)
-        time.utc.xmlschema # Force UTC.
-      elsif time.blank?
-        '*'
-      else
-        time.to_s
-      end
+    def granularize_time_value(value, end_val)
+      value = value.utc
+      return value.xmlschema[0..9] if granularity == OAI::Const::Granularity::LOW
+
+      end_val ? value.xmlschema.sub(/(\:\d{2})Z$/, '\1.999Z') : value.xmlschema
+    end
+
+    def timestamp_presence(solr_doc)
+      return solr_doc.timestamp.presence if solr_doc && solr_doc.timestamp
+      Time.now.utc.to_s
     end
   end
 end

data/lib/blacklight_oai_provider/solr_set.rb

@@ -1,6 +1,10 @@
 module BlacklightOaiProvider
   class SolrSet < BlacklightOaiProvider::Set
     class << self
+      def search_service
+        @controller.search_service
+      end
+
       # Return an array of all sets, or nil if sets are not supported
       def all
         return if @fields.nil?
@@ -8,8 +12,8 @@ module BlacklightOaiProvider
         params = { rows: 0, facet: true, 'facet.field' => solr_fields }
         solr_fields.each { |field| params["f.#{field}.facet.limit"] = -1 } # override any potential blacklight limits
 
-        builder = @controller.search_builder.merge(params)
-        response = @controller.repository.search(builder)
+        builder = search_service.search_builder.merge(params)
+        response = search_service.repository.search(builder)
 
         sets_from_facets(response.facet_fields) if response.facet_fields
       end

data/lib/generators/blacklight_oai_provider/install_generator.rb

@@ -31,8 +31,8 @@ module BlacklightOaiProvider
         "\n  concern :oai_provider, BlacklightOaiProvider::Routes.new\n"
       end
 
-      inject_into_file file_path, after: /resource :catalog,+(.*)do$/ do
-        "\n    concerns :oai_provider\n"
+      gsub_file file_path, /concerns :searchable$/ do
+        "concerns :oai_provider\n    concerns :searchable\n"
       end
     end
   end