blacklight-citeproc 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 58728c3ed06908d2c5fea28545abcef6d99e57dc65c783b59b9f94f036f2b6f7
+  data.tar.gz: b3489bf8ab8a75996200af7dcf440a1b23911533d01841ac1880d2cd1dbc823f
+SHA512:
+  metadata.gz: 91d78c9b8154b1bf72d80dea5e24eaee1f129a5ab6532728853804d555eb947eaee46b4b133cd8b8fa6704c15ec9f8e10fce1fe0eb32c6f1b7d799f6d49c40aa
+  data.tar.gz: ceb6103e2cb503ebb91e6c4ce21e0529ab3d2ccc0018397f68a1cc922c1f96a460ab07b0c332dd9a925ab6c9b12208f56fc8b671e884ddfaeebbd495905f658b

data/README.md

@@ -0,0 +1,86 @@
+# Blacklight::Citeproc
+Swap in really accurate citations using a wide variety of citation styles to your Blacklight app.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'blacklight-citeproc'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+And then run the install generator:
+```bash
+$ rails generate blacklight:citeproc:install
+```
+
+Go into your application's catalog controller, and set the correct fields:
+```ruby
+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
+  # If no bibtex_field defined, or if it is not found in the solr document, use these fields instead:
+  fields: {
+    address: 'published_ssm',
+    annote: 'annotation_tsim',
+    author: 'author_tsim',
+    booktitle: 'booktitle_tsim',
+    chapter: 'chapter_tsim',
+    doi: 'doi_tsim',
+    edition: 'edition_tsim',
+    editor: 'editor_tsim',
+    how_published: 'how_published_tsim',
+    institution: 'institution_tsim',
+    journal: 'journal_tsim',
+    key: 'id',
+    month: 'month_tsim',
+    note: 'note_tsim',
+    number: 'number_tsim',
+    organization: 'organization_tsim',
+    pages: 'pages_tsim',
+    publisher: 'publisher_tsim',
+    school: 'school_tsim',
+    series: 'series_tsim',
+    title: 'title_tsim',
+    type: 'type_tsim',
+    url: 'url_tsim',
+    volume: 'number_tsim',
+    year: 'pub_date_ssim'
+  },
+  styles: %w(apa chicago-fullnote-bibliography modern-language-association ieee council-of-science-editors),
+  format: {
+    field: format
+    default_format: :book
+    mappings: {
+      article: [],
+      book: ['Book', 'Musical Score', 'Ebook'],
+      booklet: [],
+      conference: [],
+      inbook: [],
+      incollection: [],
+      inproceedings: [],
+      manual: [],
+      mastersthesis: [],
+      misc: ['Map/Globe', 'Non-musical Recording', 'Musical Recording', 'Image', 'Software/Data', 'Video/Film'],
+     phdthesis: [],
+     proceedings: [],
+     techreport: [],
+     unpublished: []
+    }
+  }
+}
+```
+
+Finally, go into your locale files and make sure to add friendly versions of the citations styles you are using for each locale your app uses.
+
+```yaml
+en:
+  blacklight:
+    citeproc:
+      styles:
+        apa: APA 6th Edition
+```
+

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

@@ -0,0 +1,37 @@
+require 'bibtex'
+require 'citeproc'
+require 'csl/styles'
+
+module Blacklight::Citeproc
+  class BadConfigError < StandardError
+  end
+
+  class CitationController < ApplicationController
+    include Blacklight::Searchable
+
+    def initialize
+      @processors = []
+      @citations = []
+
+      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: 'html', style: style)
+      end
+    end
+
+    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]}
+      end
+      render layout: false
+    end
+
+  end
+end

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

@@ -0,0 +1,56 @@
+# This is a document extension meant to be mixed into a
+# Blacklight::Solr::Document class, such as SolrDocument. It provides support
+# for creating bibtex format from a Solr document.
+#
+# This extension would normally be registered using
+# Blacklight::Solr::Document#use_extension.  eg:
+#
+# SolrDocument.use_extension( Blacklight::Document::BibTeX )
+#
+# This extension also expects some data from blacklight_config (set in Catalog Controller)
+
+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 = self.id
+    entry.title = self.first config[:fields][:title]
+    multiple_valued_fields = %i{author editor}
+    multiple_valued_fields.each do |field|
+      entry.send("#{field}=", self.fetch(config[:fields][field])) if self.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}=", self.first(config[:fields][field])) if self.has? config[:fields][field]
+    end
+
+    return entry
+  end
+
+  private
+  def bibtex_type config
+    config[:format][:mappings].each do |bibtex, solr|
+      if solr.include? self.first config[:format][:field]
+        return bibtex
+      end
+    end
+    default_type = config[:format][:default_format] || :book
+    return default_type
+  end
+
+end
+

data/app/views/blacklight/citeproc/citation/print_single.html.erb

@@ -0,0 +1,6 @@
+<div class="modal-body">
+<% @citations.each do |citation| %>
+  <h3><%= t("blacklight.citeproc.styles.#{citation[:label]}") %></h3>
+  <%= citation[:citation] %>
+<% end %>
+</div>

data/blacklight-citeproc.gemspec

@@ -0,0 +1,33 @@
+$:.push File.expand_path("lib", __dir__)
+
+# Maintain your gem's version:
+require "blacklight/citeproc/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |spec|
+  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|
+    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"
+
+end
+

data/config/locales/blacklight-citeproc.en.yml

@@ -0,0 +1,5 @@
+en:
+  blacklight:
+    citeproc:
+      styles:
+        apa: APA 6th edition

data/config/routes.rb

@@ -0,0 +1,3 @@
+Blacklight::Citeproc::Engine.routes.draw do
+  get '/catalog/:id/citation' => 'blacklight/citeproc/citation#print_single'
+end

data/lib/blacklight/citeproc.rb

@@ -0,0 +1,6 @@
+require 'blacklight/citeproc/engine'
+
+module Blacklight
+  module Citeproc
+  end
+end

data/lib/blacklight/citeproc/engine.rb

@@ -0,0 +1,6 @@
+module Blacklight
+  module Citeproc
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/blacklight/citeproc/version.rb

@@ -0,0 +1,5 @@
+module Blacklight
+  module Citeproc
+    VERSION = '0.0.2'
+  end
+end

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

@@ -0,0 +1,45 @@
+require 'rails/generators'
+
+module Blacklight::Citeproc
+  class Install < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+    def inject_routes
+      inject_into_file 'config/routes.rb', after: /mount Blacklight::Engine.*$/ do
+        "\n  mount Blacklight::Citeproc::Engine => '/'\n"
+      end
+    end
+    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: {
+        address: 'published_ssm',
+        author: 'author_tsim',
+        edition: 'edition_tsim',
+        publisher: 'publisher_tsim',
+        title: 'title_tsim',
+        url: 'url_tsim',
+        year: 'pub_date_ssim'
+      },
+      styles: %w(apa chicago-fullnote-bibliography modern-language-association ieee council-of-science-editors),
+      format: {
+        field: 'format',
+        default_format: :book,
+        mappings: {
+          book: ['Book', 'Musical Score', 'Ebook'],
+          misc: ['Map/Globe', 'Non-musical Recording', 'Musical Recording', 'Image', 'Software/Data', 'Video/Film'],
+        }
+      }
+    }
+        CONFIG
+      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"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: blacklight-citeproc
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Jane Sandberg
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bibtex-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.4.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.4.6
+- !ruby/object:Gem::Dependency
+  name: citeproc-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: csl-styles
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1.9
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: engine_cart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  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: ''
+email:
+- sandbej@linnbenton.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- app/controllers/blacklight/citeproc/citation_controller.rb
+- app/models/concerns/blacklight/document/bibtex.rb
+- app/views/blacklight/citeproc/citation/print_single.html.erb
+- blacklight-citeproc.gemspec
+- config/locales/blacklight-citeproc.en.yml
+- config/routes.rb
+- lib/blacklight/citeproc.rb
+- lib/blacklight/citeproc/engine.rb
+- lib/blacklight/citeproc/version.rb
+- lib/generators/blacklight/citeproc/install_generator.rb
+homepage: https://github.com/sandbergja/blacklight-citeproc
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []