blacklight-ris 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1a8d3a0519f3934e4ebddfdee72cc123c323bc0ec8085223d81cf093f4cd9f1b
+  data.tar.gz: 87422585dffe4625444aa94964cc54bd8e63431a560c20fb3bc2d33befdae2cf
+SHA512:
+  metadata.gz: 5608cfed0c79ae83532160aeeb67191ad6c55f7dd2b6fc7700965b191d8824076c31a062acc91b9bd7de1497f3b78a9be9d3bce7c270051090faad4773f8d332
+  data.tar.gz: 0ab726f67034f0465017cc5c9f20a35424c16e5dd7068e43b7dacd0f49690bc225630748e3706d1d05b4fa6d5b11705a057c81a8503e7144433ca3d04210b949

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Jeff Chiu
+
+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/README.md

@@ -0,0 +1,81 @@
+# blacklight-ris
+
+Adds "Download in RIS format" functionality to [Blacklight](https://github.com/projectblacklight/blacklight).
+
+## Description
+Blacklight plugin that adds the ability to download a [RIS representation](https://en.wikipedia.org/wiki/RIS_(file_format)) of a record from a catalog show page and a set of records from the bookmarks index page.
+
+### Versioning
+`v0.1.0` -> Known to work with Blacklight v6 and Rails 4
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'blacklight-ris', '0.1.0'
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+## Usage
+
+Modify your `SolrDocument` class with the extension modules for RIS,
+and define your field mappings using the `ris_field_mappings` hash.
+
+```ruby
+class SolrDocument
+
+  # ...existing code...
+
+  include Blacklight::Solr::Document::RisFields
+  use_extension(Blacklight::Solr::Document::RisExport)
+
+  ris_field_mappings.merge!(
+    # Procs are evaluated in context of SolrDocument instance
+    :TY => Proc.new {
+      format = fetch('format_a', [])
+      if format.member?('Book')
+        'BOOK'
+      elsif format.member?('Journal/Periodical')
+        'JOUR'
+      else
+        'GEN'
+      end
+    },
+    # use solr field named 'title'
+    :TI => 'title',
+    :AU => 'author_creator_a',
+    :PY => 'publication_date_a',
+    # this assumes you're using blacklight-marc
+    :CY => Proc.new { marclibrary.get_ris_cy_field(to_marc) },
+    :PB => Proc.new { marclibrary.get_ris_pb_field(to_marc) },
+    :ET => 'edition',
+    :SN => Proc.new { marclibrary.get_ris_sn_field(to_marc) },
+  )
+end
+```
+
+Modify your `CatalogController` to include the
+`Blacklight::Ris::Catalog` module. Put this at the end of any existing
+includes.
+
+```ruby
+class CatalogController < ApplicationController
+  # ...existing includes...
+  include Blacklight::Catalog
+  
+  # add this line
+  include Blacklight::Ris::Catalog
+end
+```
+
+The show view and bookmarks page should now display links for
+downloading records in RIS format.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Blacklight::Ris'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/helpers/blacklight_ris_helper.rb

@@ -0,0 +1,17 @@
+
+module BlacklightRisHelper
+
+  # this helper is called from the Show view and Bookmarks view
+  def ris_path(opts = {})
+    if controller_name == "bookmarks"
+      bookmarks_path(opts.merge(format: 'ris'))
+    else
+      solr_document_path(opts.merge(format: 'ris'))
+    end
+  end
+
+  def render_ris(documents)
+    documents.map {|x| x.export_as(:ris)}.compact.join("\n")
+  end
+
+end

data/app/models/concerns/blacklight/solr/document/ris_export.rb

@@ -0,0 +1,37 @@
+
+module Blacklight::Solr::Document::RisExport
+
+  def self.extended(document)
+    document.will_export_as(:ris, 'application/x-research-info-systems')
+  end
+
+  def export_as_ris
+    ris_hash = to_ris_hash
+    lines = ris_hash.keys
+      .select { |key| ris_hash[key].present? }
+      .flat_map { |key| render_ris_key_value(key, ris_hash[key]) }
+    lines << 'ER  - '
+    lines.compact.join("\n")
+  end
+
+  def render_ris_key_value(key, val)
+    if val.is_a?(Array)
+      val.map { |v| "#{key}  - #{v}" }
+    else
+      "#{key}  - #{val}"
+    end
+  end
+
+  def to_ris_hash
+    h = Hash.new
+    self.class.ris_field_mappings.each do |key, val|
+      if val.is_a?(Proc)
+        h[key] = instance_eval(&val)
+      else
+        h[key] = fetch(val, '')
+      end
+    end
+    h
+  end
+
+end

data/app/models/concerns/blacklight/solr/document/ris_fields.rb

@@ -0,0 +1,12 @@
+
+module Blacklight::Solr::Document::RisFields
+
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def ris_field_mappings
+      @ris_field_mappings ||= {}
+    end
+  end
+
+end

data/app/views/bookmarks/index.ris.erb

@@ -0,0 +1 @@
+<%= render_ris(@document_list) %>

data/config/routes.rb

@@ -0,0 +1,2 @@
+Blacklight::Ris::Engine.routes.draw do
+end

data/lib/blacklight/ris/catalog.rb

@@ -0,0 +1,21 @@
+
+module Blacklight::Ris
+
+  # mix-in for CatalogController
+  module Catalog
+    extend ActiveSupport::Concern
+
+    included do
+      # this also causes Blacklight's show endpoint to handle .ris
+      add_show_tools_partial(:ris, label: 'Download in RIS format', if: :render_ris_action?, modal: false, path: :ris_path)
+    end
+
+    private
+
+    def render_ris_action? config, options = {}
+      doc = options[:document] || (options[:document_list] || []).first
+      doc && doc.respond_to?(:export_formats) && doc.export_formats.keys.include?(:ris )
+    end
+
+  end
+end

data/lib/blacklight/ris/engine.rb

@@ -0,0 +1,16 @@
+module Blacklight
+  module Ris
+    class Engine < ::Rails::Engine
+      isolate_namespace Blacklight::Ris
+
+      initializer 'blacklight-ris.initialize' do |app|
+        Mime::Type.register 'application/x-research-info-systems', :ris
+      end
+
+      initializer 'blacklight-ris.helpers' do |app|
+        ActionView::Base.send :include, BlacklightRisHelper
+      end
+
+    end
+  end
+end

data/lib/blacklight/ris/version.rb

@@ -0,0 +1,5 @@
+module Blacklight
+  module Ris
+    VERSION = '0.1.0'
+  end
+end

data/lib/blacklight/ris.rb

@@ -0,0 +1,8 @@
+
+require 'blacklight/ris/engine'
+
+module Blacklight
+  module Ris
+    autoload :Catalog, 'blacklight/ris/catalog'
+  end
+end

data/lib/tasks/blacklight/ris_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :blacklight_ris do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: blacklight-ris
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeff Chiu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: RIS format export for Blacklight
+email:
+- jeffchiu@upenn.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/helpers/blacklight_ris_helper.rb
+- app/models/concerns/blacklight/solr/document/ris_export.rb
+- app/models/concerns/blacklight/solr/document/ris_fields.rb
+- app/views/bookmarks/index.ris.erb
+- config/routes.rb
+- lib/blacklight/ris.rb
+- lib/blacklight/ris/catalog.rb
+- lib/blacklight/ris/engine.rb
+- lib/blacklight/ris/version.rb
+- lib/tasks/blacklight/ris_tasks.rake
+homepage: https://github.com/upenn-libraries/blacklight-ris
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'false'
+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: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: RIS format export for Blacklight
+test_files: []