blacklight-citeproc 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: eeff00991e1cd29a95fe8147f0e7635d62750285
-  data.tar.gz: 455a044d6ea8c8ca95953f35caa5ab1cd36fd282
+SHA256:
+  metadata.gz: 600dabd32addc71318e3fdcf9a02649171bde0d687ee914f3e742815d18c1127
+  data.tar.gz: 61cc4259a5b90ab78d1a1f725b8fc1fda584deb9f1a550c4db4f6c61334a9896
 SHA512:
-  metadata.gz: c7a4157599e2b518ce56300ce7210f831a4c249300890a51b6f9bb277f962b369295a2476345c9ba53f9d0c39289a05b677e96017f6cc50e11b0e1f0ed247959
-  data.tar.gz: '09d0957858f97fc340b180e45fc4afbab39a789937590192864721ccc93284ac921a7298a45be81c0fc229fd4d049f75b2c01c96a47b6f6423e3a443f553a08e'
+  metadata.gz: 4258faae4916dfbc84637fdcf2162a7fd3f50b77c891aea65762ceefd09d3e88edc44a0d4fee33a163a726b59b324e9e4783e9c3f857120363907a65aa9964fa
+  data.tar.gz: 6c970c6eddacd46c20d1030d9dcff4186e6b186717973be91f340c9039f7ac4ed696e0a0d570c70809c4e1b2f17f261063153b2f523303f307c5239fb27b6b21

data/.env

@@ -1,3 +1,3 @@
-RAILS_VERSION=6.1.4.1
+RAILS_VERSION=6.1.6
 SOLR_URL=http://solr:8983/solr/blacklight-core
-BLACKLIGHT_VERSION=7.21.2
+BLACKLIGHT_VERSION=7.24.0

data/.github/workflows/test.yml

@@ -0,0 +1,25 @@
+name: Test
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  schedule:
+    - cron: '30 6 5 * *'
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+      - name: Install dependencies
+        run: bundle install
+      - name: Run linter
+        run: bundle exec rubocop

data/.rubocop.yml

@@ -0,0 +1,4 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.7

data/.rubocop_todo.yml

@@ -0,0 +1,40 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2022-05-09 22:37:34 UTC using RuboCop version 1.29.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: 1
+Lint/MissingSuper:
+  Exclude:
+    - 'app/controllers/blacklight/citeproc/citation_controller.rb'
+
+# Offense count: 2
+# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 28
+
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+Metrics/MethodLength:
+  Max: 24
+
+# Offense count: 4
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'app/controllers/blacklight/citeproc/citation_controller.rb'
+    - 'app/models/concerns/blacklight/document/bibtex.rb'
+    - 'lib/blacklight/citeproc.rb'
+    - 'lib/generators/blacklight/citeproc/install_generator.rb'
+
+# Offense count: 1
+# This cop supports safe auto-correction (--auto-correct).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 123

data/Dockerfile

@@ -6,6 +6,7 @@ ARG BLACKLIGHT_VERSION
 RUN apk add --update --no-cache \
   bash \
   build-base \
+  gcompat \
   git \
   libxml2-dev \
   libxslt-dev \
@@ -22,8 +23,7 @@ RUN chown -R blacklight /app /gem
 
 USER blacklight
 
-RUN gem update --system && \
-  gem install bundler && \
+RUN gem install bundler && \
   bundle config build.nokogiri --use-system-libraries && \
   gem install rails -v $RAILS_VERSION
 

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Jane Sandberg
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/app/controllers/blacklight/citeproc/citation_controller.rb

@@ -5,57 +5,59 @@ require 'citeproc'
 require 'citeproc/ruby'
 require 'csl/styles'
 
-module Blacklight::Citeproc
-  class BadConfigError < StandardError
-  end
+module Blacklight
+  module Citeproc
+    class BadConfigError < StandardError
+    end
 
-  class CitationController < ApplicationController
-    include Blacklight::Bookmarks
-    include Blacklight::Searchable
+    class CitationController < ApplicationController
+      include Blacklight::Bookmarks
+      include Blacklight::Searchable
 
-    def initialize
-      @processors = []
-      @citations = []
-      format = ::CiteProc::Ruby::Formats::Html.new bib_container: 'div', bib_entry: 'p'
+      def initialize
+        @processors = []
+        @citations = []
+        format = ::CiteProc::Ruby::Formats::Html.new bib_container: 'div', bib_entry: 'p'
 
-      throw BadConfigError, 'Catalog controller needs a config.citeproc section' unless blacklight_config.citeproc
-      @config = blacklight_config.citeproc
-      @config[:styles].each do |style|
-        @processors << ::CiteProc::Processor.new(format: format, style: style)
+        throw BadConfigError, 'Catalog controller needs a config.citeproc section' unless blacklight_config.citeproc
+        @config = blacklight_config.citeproc
+        @config[:styles].each do |style|
+          @processors << ::CiteProc::Processor.new(format: format, style: style)
+        end
       end
-    end
 
-    def print_single
-      _, document = search_service.fetch(params[:id])
-      bibtex = ::BibTeX::Bibliography.new
-      bibtex << document.export_as(:bibtex)
+      def print_single
+        _, document = search_service.fetch(params[:id])
+        bibtex = ::BibTeX::Bibliography.new
+        bibtex << document.export_as(:bibtex)
 
-      @processors.each do |processor|
-        processor.import bibtex.to_citeproc
-        citation = processor.render(:bibliography, id: params[:id]).first.tr('{}', '')
-        @citations << { citation: citation.html_safe, label: processor.options[:style] }
+        @processors.each do |processor|
+          processor.import bibtex.to_citeproc
+          citation = processor.render(:bibliography, id: params[:id]).first.tr('{}', '')
+          @citations << { citation: citation.html_safe, label: processor.options[:style] }
+        end
+        render layout: false
       end
-      render layout: false
-    end
 
-    def print_multiple(ids)
-      _, documents = search_service.fetch(ids)
-      bibtex = ::BibTeX::Bibliography.new
-      documents.each do |document|
-        bibtex << document.export_as(:bibtex)
+      def print_multiple(ids)
+        _, documents = search_service.fetch(ids)
+        bibtex = ::BibTeX::Bibliography.new
+        documents.each do |document|
+          bibtex << document.export_as(:bibtex)
+        end
+
+        @processors.each do |processor|
+          processor.import bibtex.to_citeproc
+          @citations << { citation: processor.bibliography.join.html_safe, label: processor.options[:style] }
+        end
+        render :print_single, layout: false
       end
 
-      @processors.each do |processor|
-        processor.import bibtex.to_citeproc
-        @citations << { citation: processor.bibliography.join.html_safe, label: processor.options[:style] }
+      def print_bookmarks
+        bookmarks = token_or_current_or_guest_user.bookmarks
+        bookmark_ids = bookmarks.collect { |b| b.document_id.to_s }
+        print_multiple bookmark_ids
       end
-      render :print_single, layout: false
-    end
-
-    def print_bookmarks
-      bookmarks = token_or_current_or_guest_user.bookmarks
-      bookmark_ids = bookmarks.collect { |b| b.document_id.to_s }
-      print_multiple bookmark_ids
     end
   end
 end

data/app/models/concerns/blacklight/document/bibtex.rb

@@ -13,43 +13,46 @@
 
 require 'bibtex'
 
-module Blacklight::Document::Bibtex
-  def self.extended(document)
-    Blacklight::Document::Bibtex.register_export_formats(document)
-  end
-
-  def self.register_export_formats(document)
-    document.will_export_as(:bibtex, 'application/x-bibtex')
-  end
-
-  def export_as_bibtex
-    config = ::CatalogController.blacklight_config.citeproc
-
-    entry = ::BibTeX::Entry.new
-    entry.type = :book
-    entry.key = id
-    entry.title = first config[:fields][:title]
-    multiple_valued_fields = %i[author editor]
-    multiple_valued_fields.each do |field|
-      entry.send("#{field}=", fetch(config[:fields][field])) if has? config[:fields][field]
-    end
-
-    single_valued_fields = %i[address annote booktitle chapter doi edition how_published institution
-                              journal key month note number organization pages publisher school series url volume year]
-    single_valued_fields.each do |field|
-      entry.send("#{field}=", first(config[:fields][field])) if has? config[:fields][field]
-    end
-
-    entry
-  end
-
-  private
-
-  def bibtex_type(config)
-    config[:format][:mappings].each do |bibtex, solr|
-      return bibtex if solr.include? first config[:format][:field]
+module Blacklight
+  module Document
+    module Bibtex
+      def self.extended(document)
+        Blacklight::Document::Bibtex.register_export_formats(document)
+      end
+
+      def self.register_export_formats(document)
+        document.will_export_as(:bibtex, 'application/x-bibtex')
+      end
+
+      def export_as_bibtex
+        config = ::CatalogController.blacklight_config.citeproc
+
+        entry = ::BibTeX::Entry.new
+        entry.type = :book
+        entry.key = id
+        entry.title = first config[:fields][:title]
+        multiple_valued_fields = %i[author editor]
+        multiple_valued_fields.each do |field|
+          entry.send("#{field}=", fetch(config[:fields][field])) if has? config[:fields][field]
+        end
+
+        single_valued_fields = %i[address annote booktitle chapter doi edition how_published institution
+                                  journal key month note number organization pages publisher school series url volume year]
+        single_valued_fields.each do |field|
+          entry.send("#{field}=", first(config[:fields][field])) if has? config[:fields][field]
+        end
+
+        entry
+      end
+
+      private
+
+      def bibtex_type(config)
+        config[:format][:mappings].each do |bibtex, solr|
+          return bibtex if solr.include? first config[:format][:field]
+        end
+        config[:format][:default_format] || :book
+      end
     end
-    default_type = config[:format][:default_format] || :book
-    default_type
   end
 end

data/blacklight-citeproc.gemspec

@@ -1,33 +1,33 @@
-$:.push File.expand_path("lib", __dir__)
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 
 # Maintain your gem's version:
-require "blacklight/citeproc/version"
+require 'blacklight/citeproc/version'
 
 # Describe your gem and declare its dependencies:
 Gem::Specification.new do |spec|
-  spec.name        = "blacklight-citeproc"
+  spec.name        = 'blacklight-citeproc'
   spec.version     = Blacklight::Citeproc::VERSION
-  spec.authors     = ["Jane Sandberg"]
-  spec.email       = ["sandbej@linnbenton.edu"]
-  spec.homepage    = "https://github.com/sandbergja/blacklight-citeproc"
-  spec.summary     = ""
-  spec.description = ""
-  spec.license     = "Apache-2.0"
-  
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.authors     = ['Jane Sandberg']
+  spec.email       = ['sandbergja@gmail.com']
+  spec.homepage    = 'https://github.com/sandbergja/blacklight-citeproc'
+  spec.summary     = 'Generate and display citeproc citations in a Blacklight app'
+  spec.description = 'Swap in really accurate citations using a wide variety of citation styles to your Blacklight app'
+  spec.license     = 'MIT'
+  spec.required_ruby_version = '>= 2.7'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency "bibtex-ruby", ">= 4.4.6"
-  spec.add_dependency "citeproc-ruby", "~> 1.1"
-  spec.add_dependency "csl-styles", "~> 1.0.1.9"
-
-  spec.add_development_dependency "rspec-rails", "~> 3.0"
-  spec.add_development_dependency "engine_cart", "~> 2.0"
-  spec.add_development_dependency "solr_wrapper"
+  spec.add_dependency 'bibtex-ruby', '>= 4.4.6', '< 7'
+  spec.add_dependency 'citeproc-ruby', '~> 1.1'
+  spec.add_dependency 'csl-styles', '~> 1.0'
 
+  spec.add_development_dependency 'rspec-rails', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 1.29'
 end
-

data/config/routes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Blacklight::Citeproc::Engine.routes.draw do
   get '/catalog/:id/citation' => 'blacklight/citeproc/citation#print_single'
   get '/bookmarks/citation' => 'blacklight/citeproc/citation#print_bookmarks'

data/lib/blacklight/citeproc/version.rb

@@ -2,6 +2,6 @@
 
 module Blacklight
   module Citeproc
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/lib/generators/blacklight/citeproc/install_generator.rb

@@ -2,18 +2,19 @@
 
 require 'rails/generators'
 
-module Blacklight::Citeproc
-  class Install < Rails::Generators::Base
-    source_root File.expand_path('templates', __dir__)
-    def inject_routes
-      inject_into_file 'config/routes.rb', after: /mount Blacklight::Engine.*$/ do
-        "\n  mount Blacklight::Citeproc::Engine => '/'\n"
+module Blacklight
+  module Citeproc
+    class Install < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+      def inject_routes
+        inject_into_file 'config/routes.rb', after: /mount Blacklight::Engine.*$/ do
+          "\n  mount Blacklight::Citeproc::Engine => '/'\n"
+        end
       end
-    end
 
-    def add_blacklight_citeproc_config
-      insert_into_file 'app/controllers/catalog_controller.rb', after: "  configure_blacklight do |config|\n" do
-        <<-CONFIG
+      def add_blacklight_citeproc_config
+        insert_into_file 'app/controllers/catalog_controller.rb', after: "  configure_blacklight do |config|\n" do
+          <<-CONFIG
     config.citeproc = {
       #bibtex_field: 'bibtex_s' # Optional. If you are already indexing BibTeX into solr, this will be the preferred way to get bibliographic data
       fields: {
@@ -35,13 +36,14 @@ module Blacklight::Citeproc
         }
       }
     }
-        CONFIG
+          CONFIG
+        end
       end
-    end
 
-    def add_marc_extension_to_solrdocument
-      insert_into_file 'app/models/solr_document.rb', after: 'include Blacklight::Solr::Document' do
-        "\n  use_extension(Blacklight::Document::Bibtex)\n"
+      def add_marc_extension_to_solrdocument
+        insert_into_file 'app/models/solr_document.rb', after: 'include Blacklight::Solr::Document' do
+          "\n  use_extension(Blacklight::Document::Bibtex)\n"
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-citeproc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jane Sandberg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-24 00:00:00.000000000 Z
+date: 2022-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bibtex-ruby
@@ -17,6 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.4.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.4.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: citeproc-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1.9
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1.9
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -67,41 +73,29 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: engine_cart
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.29'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: solr_wrapper
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: ''
+        version: '1.29'
+description: Swap in really accurate citations using a wide variety of citation styles
+  to your Blacklight app
 email:
-- sandbej@linnbenton.edu
+- sandbergja@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".env"
+- ".github/workflows/test.yml"
 - ".internal_test_app/solr/conf/_rest_managed.json"
 - ".internal_test_app/solr/conf/admin-extra.html"
 - ".internal_test_app/solr/conf/currency.xml"
@@ -179,8 +173,13 @@ files:
 - ".internal_test_app/solr/conf/xslt/example_atom.xsl"
 - ".internal_test_app/solr/conf/xslt/example_rss.xsl"
 - ".internal_test_app/solr/conf/xslt/luke.xsl"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - Dockerfile
+- Gemfile
+- LICENSE.md
 - README.md
+- Rakefile
 - app/controllers/blacklight/citeproc/citation_controller.rb
 - app/models/concerns/blacklight/document/bibtex.rb
 - app/views/blacklight/citeproc/citation/print_single.html.erb
@@ -195,7 +194,7 @@ files:
 - lib/generators/blacklight/citeproc/install_generator.rb
 homepage: https://github.com/sandbergja/blacklight-citeproc
 licenses:
-- Apache-2.0
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -205,16 +204,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.3.12
 signing_key: 
 specification_version: 4
-summary: ''
+summary: Generate and display citeproc citations in a Blacklight app
 test_files: []