blacklight-marc 5.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1d908859e48042b0e0b642132ae5ddfbf981897f
+  data.tar.gz: 8120bcb5ea2d3d1735bde7396193e5dfc1aa68d4
+SHA512:
+  metadata.gz: 9c4e5a0134edfbe5f648dab763a857df5e7797cf664f607379ce6e45e2170b1b7a5279a2482706f88337d4c5d3e3ea6d6fef400016e2b4a9e3cb7e9a3b6d9495
+  data.tar.gz: ced6d727659b9f0e2bad8f969d5f840a7a614f50fc8c65c660024768f4a9ae7c041fad71f625729b0b7076938881bc5469ff9f4b9b1058170a89ea2ba6eacadd

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+lib/solrmarc.log
+spec/internal
+jetty

data/.travis.yml

@@ -0,0 +1,19 @@
+notifications:
+  email: false
+
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode
+
+before_install:
+  - gem install bundler
+
+notifications:
+  irc: "irc.freenode.org#blacklight"
+  email:
+      - blacklight-commits@googlegroups.com
+env:
+  global:
+    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in blacklight_marc.gemspec
+gemspec
+
+group :test do
+  gem 'devise'
+  gem "bootstrap-sass"
+  gem 'turbolinks'
+  gem 'activerecord-jdbcsqlite3-adapter', :platforms => :jruby
+end
+
+if File.exists?('spec/test_app_templates/Gemfile.extra')
+  eval File.read('spec/test_app_templates/Gemfile.extra'), nil, 'spec/test_app_templates/Gemfile.extra'
+end

data/LICENSE

@@ -0,0 +1,15 @@
+##########################################################################
+# Copyright 2008-2014 Rector and Visitors of the University of Virginia, The Board of Trustees of the Leland Stanford Junior University, Johns Hopkins Universities, and Data Curation Experts
+# Additional copyright may be held by others, as reflected in the commit log
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.

data/README.md

@@ -0,0 +1,40 @@
+[![Build Status](https://travis-ci.org/projectblacklight/blacklight_marc.png?branch=master)](https://travis-ci.org/projectblacklight/blacklight_marc)
+
+# Blacklight::Marc
+
+MARC-specific enhancements for [Blacklight](https://github.com/projectblacklight/blacklight)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'blacklight-marc'
+
+And then execute:
+
+    $ bundle
+
+After running the blacklight generator, run the blacklight_marc generator:
+
+    $ rails generate blacklight_marc:marc
+
+## Features
+* Rake task `solr:marc:index` to import .mrc files using SolrMarc
+* Librarian view at `catalog/:id/librarian_view`
+* Export records to refworks and endnote
+* Blacklight::Solr::Document mixins for exporting and transforming MARC data from a stored Solr field
+
+
+## Documentation, Information and Support
+
+* [Project Homepage](http://projectblacklight.org)
+* [Developer Documentation](https://github.com/projectblacklight/blacklight/wiki)
+* [Quickstart Guide](https://github.com/projectblacklight/blacklight/wiki/Quickstart)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,68 @@
+require "bundler/gem_tasks"
+ZIP_URL = "https://github.com/projectblacklight/blacklight-jetty/archive/v4.0.0.zip"
+APP_ROOT = File.expand_path("..", __FILE__)
+
+TEST_APP_TEMPLATES = 'spec/test_app_templates'
+TEST_APP = 'spec/internal'
+
+require 'jettywrapper'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => [:ci]
+
+task :ci => ['blacklight_marc:generate', 'jetty:clean'] do
+  ENV['environment'] = "test"
+  jetty_params = Jettywrapper.load_config
+  jetty_params[:startup_wait]= 60
+  error = Jettywrapper.wrap(jetty_params) do
+    Rake::Task["blacklight_marc:fixtures"].invoke
+    Rake::Task['spec'].invoke
+  end
+  raise "test failures: #{error}" if error
+end
+
+
+namespace :blacklight_marc do
+
+  desc "Load fixtures"
+  task :fixtures => [:generate] do
+    within_test_app do
+      system "rake solr:marc:index_test_data RAILS_ENV=test"
+      abort "Error running fixtures" unless $?.success?
+    end
+  end
+
+  desc "Create the test rails app"
+  task :generate do
+    unless File.exists?('spec/internal/Rakefile')
+      puts "Generating rails app"
+      `rails new #{TEST_APP}`
+      puts "Copying gemfile"
+      open("#{TEST_APP}/Gemfile", 'a') do |f|
+        f.write File.read(TEST_APP_TEMPLATES + "/Gemfile.extra")
+        f.write "gem 'blacklight-marc', :path => '../../'" 
+      end
+      puts "Copying generator"
+      `cp -r #{TEST_APP_TEMPLATES}/lib/generators #{TEST_APP}/lib`
+      within_test_app do
+        puts "Bundle install"
+        `bundle install`
+        puts "running test_app_generator"
+        system "rails generate test_app"
+
+        puts "running migrations"
+        puts `rake db:migrate db:test:prepare`
+      end
+    end
+    puts "Done generating test app"
+  end
+end
+def within_test_app
+  FileUtils.cd(TEST_APP)
+  Bundler.with_clean_env do
+    yield
+  end
+  FileUtils.cd(APP_ROOT)
+end

data/app/helpers/blacklight_marc_helper.rb

@@ -0,0 +1,24 @@
+module BlacklightMarcHelper
+  
+  # puts together a collection of documents into one refworks export string
+  def render_refworks_texts(documents)
+    val = ''
+    documents.each do |doc|
+      if doc.respond_to?(:to_marc)
+        val += doc.export_as_refworks_marc_txt + "\n"
+      end
+    end
+    val
+  end
+
+  # puts together a collection of documents into one endnote export string
+  def render_endnote_texts(documents)
+    val = ''
+    documents.each do |doc|
+      if doc.respond_to?(:to_marc)
+        val += doc.export_as_endnote + "\n"
+      end
+    end
+    val
+  end
+end

data/app/views/bookmarks/_endnote.html.erb

@@ -0,0 +1,3 @@
+      <li class="endnote">
+        <%= link_to t('blacklight.tools.endnote'), endnote_catalog_path(:sort=>params[:sort], :per_page=>params[:per_page], :id => @bookmarks.collect {|doc| doc.document_id}, :format => 'endnote'), {:class => 'btn btn-default'}%>
+      </li>

data/app/views/bookmarks/_refworks.html.erb

@@ -0,0 +1,3 @@
+      <li class="refworks">
+        <%= render :partial => 'catalog/refworks_form', :locals => {:documents=>@document_list} %>
+      </li>

data/app/views/catalog/_marc_view.html.erb

@@ -0,0 +1,32 @@
+<div id="marc_view" class="modal-body">
+  <% fields = @document.to_marc.find_all{|f| ('000'..'999') === f.tag }  %>
+  <div class="field"><%= t('blacklight.search.librarian_view.leader', :leader => @document.to_marc.leader) %></div>
+  <%- fields.each do |field| -%>
+  <%- unless field.tag.to_s == "940" -%>
+    <div class="field">
+      <div class="tag_ind">
+        <span class="tag">
+          <%= h(field.tag) %>
+        </span>
+      <%- if field.is_a?(MARC::ControlField) -%>
+        <span class="control_field_values">
+          <%= h(field.value) %>
+        </span>
+      <%- else -%>
+        <div class="ind1">
+          <%= !field.indicator1.blank? ? field.indicator1 : "&nbsp;&nbsp;".html_safe -%>
+        </div>
+        <div class="ind2">
+          <%= !field.indicator2.blank? ? field.indicator2 : "&nbsp;&nbsp;".html_safe -%>
+        </div>
+      </div>
+      <div class="subfields">
+        <%- field.each do |sub| -%>
+        <span class="sub_code"><%= h(sub.code) %>|</span> <%= h(sub.value) %>
+      <%- end -%>
+      <%- end -%>
+      </div>
+    </div>
+  <%- end-%>
+  <%- end -%>
+</div>

data/app/views/catalog/endnote.endnote.erb

@@ -0,0 +1 @@
+<%= render_endnote_texts(@documents) %>

data/app/views/catalog/librarian_view.html.erb

@@ -0,0 +1,10 @@
+
+<div class="modal-header">
+  <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
+  <h3 class="modal-title"><%= t('blacklight.search.librarian_view.title') %></h3>
+</div>
+<%- if @document.respond_to?(:to_marc) -%>
+  <%= render "marc_view" %>
+<%- else %>
+  <%= t('blacklight.search.librarian_view.empty') %>
+<%- end -%>

data/blacklight-marc.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'blacklight/marc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "blacklight-marc"
+  spec.version       = Blacklight::Marc::VERSION
+  spec.authors       = ["Justin Coyne"]
+  spec.email         = ["justin@curationexperts.com"]
+  spec.description   = %q{MARC support for Blacklight}
+  spec.summary       = %q{MARC support for Blacklight}
+  spec.homepage      = "https://github.com/projectblacklight/blacklight_marc"
+  spec.license       = "Apache 2.0"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "blacklight", "~> 5.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "jettywrapper"
+  spec.add_dependency "rails"
+  # Let's allow future versions of marc, count on
+  # them to be backwards compat until 1.1
+  spec.add_dependency "marc",      ">= 0.4.3", "< 1.1"  # Marc record parser.
+end

data/config/jetty.yml

@@ -0,0 +1,4 @@
+default:
+  startup_wait: 15
+  jetty_port: <%= ENV['TEST_JETTY_PORT'] || 8888 %> 
+  <%= ENV['TEST_JETTY_PATH'] ? "jetty_home: " + ENV['TEST_JETTY_PATH'] : '' %>

data/config/locales/blacklight.en.yml

@@ -0,0 +1,13 @@
+en:
+
+  blacklight:
+    tools:
+      librarian_view: 'Librarian View'
+
+
+    search:
+      librarian_view:
+        title: 'Librarian View'
+        leader: 'LEADER %{leader}'
+        empty: 'No MARC data found.'
+

data/config/locales/blacklight.fr.yml

@@ -0,0 +1,13 @@
+fr:
+
+  blacklight:
+
+    tools:
+      librarian_view: 'Vue UNIMARC'
+
+    search:
+
+      librarian_view:
+        title: 'Vue UNIMARC'
+        leader: 'LABEL %{leader}'
+        empty: 'Pas MARC trouvé.'

data/config/routes.rb

@@ -0,0 +1,17 @@
+# -*- encoding : utf-8 -*-
+Rails.application.routes.draw do
+  # A Note on User Sessions:
+  # Blacklight expects the following named routes or at least the associated path helper methods to be defined.
+  # new_user_session   (for logging in) - pages that require a log in will redirect users here.
+  # destroy_user_session (for logging out)
+
+  # Routes for the Blacklight application are defined in Blacklight::Routes
+  #
+  # These routes can be injected into your Rails application by adding
+  #     Blacklight.add_routes(self)
+  # to the application's ./config/routes.rb. The injected routes can be 
+  # customized as well, e.g.:
+  #     Blacklight.add_routes(self, :only => [:bookmarks]) # will only look bookmark routes
+  #     Blacklight.add_routes(self, :except => [:catalog]) # will not load catalog routes
+end
+

data/lib/blacklight/marc.rb

@@ -0,0 +1,18 @@
+require "blacklight/marc/version"
+require 'blacklight'
+
+module Blacklight
+  module Marc
+    Blacklight::Solr::Document.autoload :Marc, 'blacklight/solr/document/marc'
+    Blacklight::Solr::Document.autoload :MarcExport, 'blacklight/solr/document/marc_export'
+  
+    require 'blacklight/marc/engine'
+    require 'blacklight/marc/railtie'
+    autoload :Routes, 'blacklight/marc/routes'
+    autoload :Catalog, 'blacklight/marc/catalog'
+
+    def self.add_routes(router, options = {})
+      Blacklight::Marc::Routes.new(router, options).draw
+    end
+  end
+end

data/lib/blacklight/marc/catalog.rb

@@ -0,0 +1,20 @@
+module Blacklight::Marc
+  module Catalog
+    def librarian_view
+      @response, @document = get_solr_response_for_doc_id
+
+      respond_to do |format|
+        format.html
+        format.js { render :layout => false }
+      end
+    end
+
+    # grabs a bunch of documents to export to endnote
+    def endnote
+      @response, @documents = get_solr_response_for_field_values(SolrDocument.unique_key,params[:id])
+      respond_to do |format|
+        format.endnote { render :layout => false }
+      end
+    end
+  end
+end

data/lib/blacklight/marc/engine.rb

@@ -0,0 +1,8 @@
+require "blacklight/marc"
+require "rails"
+
+module Blacklight::Marc
+  class Engine < Rails::Engine
+
+  end
+end

data/lib/blacklight/marc/railtie.rb

@@ -0,0 +1,17 @@
+module Blacklight::Marc
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "railties/solr_marc.rake"
+    end
+
+    initializer 'blacklight_marc.initialize' do |app|
+      Mime::Type.register_alias "text/plain", :refworks_marc_txt
+      Mime::Type.register_alias "text/plain", :openurl_kev
+      Mime::Type.register "application/x-endnote-refer", :endnote
+      Mime::Type.register "application/marc", :marc
+      Mime::Type.register "application/marcxml+xml", :marcxml, 
+      ["application/x-marc+xml", "application/x-marcxml+xml", 
+       "application/marc+xml"]
+     end
+  end
+end

data/lib/blacklight/marc/routes.rb

@@ -0,0 +1,43 @@
+# -*- encoding : utf-8 -*-
+module Blacklight::Marc
+  class Routes
+
+    def initialize(router, options)
+      @router = router
+      @options = options
+    end
+
+    def draw
+      route_sets.each do |r|
+        self.send(r)
+      end
+    end
+
+    protected
+
+    def add_routes &blk
+      @router.instance_exec(@options, &blk)
+    end
+
+    def route_sets
+      (@options[:only] || default_route_sets) - (@options[:except] || [])
+    end
+
+    def default_route_sets
+      [:catalog]
+    end
+
+    module RouteSets
+      def catalog
+        add_routes do |options|
+          # Catalog stuff.
+          get 'catalog/:id/librarian_view', :to => "catalog#librarian_view", :as => "librarian_view_catalog"
+          get "catalog/endnote", :as => "endnote_catalog"
+          
+        end
+      end
+   end
+   
+  include RouteSets
+  end
+end