blacklight-marc 5.10.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8e43d7c8a9b57de3e972546f7c341ca55545a30
-  data.tar.gz: fe618a0f2c13669d32457b783c47700096ca9ef0
+  metadata.gz: 3a674be3c4819a0ea53a8c949f68dc305adc2715
+  data.tar.gz: b2b7608c6e893f43fce519908d35f257a759a14f
 SHA512:
-  metadata.gz: d55e417c12342255ba4839a1baa6364324e52141039adab7860fa02638734e9711611a5f3eb63df8404c073eeb02a6f38d6ed098d213cdcaa8a6339fae366d38
-  data.tar.gz: 9050cf52fad6e56be7900fd07b53c9bdd8513ad807f2426f5e16565c81e7c578b17f61ed9795970cc0f152cf14b6a44443b0a243abcbfc3352be09533a84735f
+  metadata.gz: 506c0334c905f179256b15044a46c0bf6a8cc0b71d49af5fc482a8e24b0cf9fbc402612486b3a3a01fc926ee6a20ad4acd1e32b79c06d69e0fe4e0333bd6cb90
+  data.tar.gz: 00399aeb90e6f0098849378eb99155f1b9f07d476e0970af1b39f9ca654c5e636d080033347f82f9509bf4d2d360738d002fab3e40b36d126cee5b06bd7774bf

data/.gitignore

@@ -16,5 +16,7 @@ test/tmp
 test/version_tmp
 tmp
 lib/solrmarc.log
+lib/solrmarc.log.*
 spec/internal
-jetty
+jetty
+.internal_test_app

data/.travis.yml

@@ -1,34 +1,29 @@
+language: ruby
+sudo: false
+
 notifications:
   email: false
 
-
 rvm:
-  - 2.1.4
+  - 2.2.3
 
 matrix:
   include:
-    - rvm: 2.1.4
-      env: "RAILS_VERSION=4.0.12"
-    - rvm: 2.0.0
-      env: "RAILS_VERSION=4.1.8"
-    - rvm: 1.9.3
-      env: "RAILS_VERSION=4.1.8"
-    - rvm: jruby
-      env: "RAILS_VERSION=4.1.8 JRUBY_OPTS=\"-J-Xms512m -J-Xmx1024m\""
-    - rvm: 2.1.4
-      env: "RAILS_VERSION=4.2.0.rc3"
+    - rvm: 2.2.2
+      env: "RAILS_VERSION=4.1.13"
+    - rvm: 2.1.6
+      env: "RAILS_VERSION=4.2.4"
 
 before_install:
   - gem install bundler
 
 env:
- - "RAILS_VERSION=3.2.21"
- - "RAILS_VERSION=4.1.8"
+ - "RAILS_VERSION=4.2.4"
 
 notifications:
   irc: "irc.freenode.org#blacklight"
   email:
       - blacklight-commits@googlegroups.com
-env:
-  global:
-    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+
+global_env:
+  - NOKOGIRI_USE_SYSTEM_LIBRARIES=true

data/Gemfile

@@ -3,26 +3,33 @@ source 'https://rubygems.org'
 # Please see blacklight_marc.gemspec for dependency information.
 gemspec path: File.expand_path('..', __FILE__)
 
-
-# Peg simplecov to < 0.8 until this is resolved:
-# https://github.com/colszowka/simplecov/issues/281
-gem 'simplecov', '~> 0.7.1', require: false
+gem 'simplecov', '~> 0.10', require: false
 gem 'coveralls', require: false
 
-file = File.expand_path("Gemfile", ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path("../spec/internal", __FILE__))
-if File.exists?(file)
-  puts "Loading #{file} ..." if $DEBUG # `ruby -d` or `bundle -v`
-  instance_eval File.read(file)
+# BEGIN ENGINE_CART BLOCK
+# engine_cart: 0.8.0
+# engine_cart stanza: 0.8.0
+# the below comes from engine_cart, a gem used to test this Rails engine gem in the context of a Rails app.
+file = File.expand_path("Gemfile", ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path(".internal_test_app", File.dirname(__FILE__)))
+if File.exist?(file)
+  begin
+    eval_gemfile file
+  rescue Bundler::GemfileError => e
+    Bundler.ui.warn '[EngineCart] Skipping Rails application dependencies:'
+    Bundler.ui.warn e.message
+  end
 else
-  gem 'rails', ENV['RAILS_VERSION']
+  Bundler.ui.warn "[EngineCart] Unable to find test application dependencies in #{file}, using placeholder dependencies"
+
+  gem 'rails', ENV['RAILS_VERSION'] if ENV['RAILS_VERSION']
 
-  # explicitly include sass-rails to get compatible sprocket dependencies
-  if ENV['RAILS_VERSION'] and ENV['RAILS_VERSION'] =~ /^4.2/
-    gem 'sass-rails', ">= 5.0.0.beta1"
+  if ENV['RAILS_VERSION'].nil? || ENV['RAILS_VERSION'] =~ /^4.2/
+    gem 'bootstrap-sass', '>= 3.3.5.1'
     gem 'responders', "~> 2.0"
+    gem 'sass-rails', ">= 5.0"
   else
+    gem 'bootstrap-sass', '< 3.3.5' # 3.3.5 requires sass 3.3, incompatible with sass-rails 4.x
     gem 'sass-rails', "< 5.0"
-    gem 'coffee-rails', "~> 4.0.0"
   end
 end
-gem 'transpec'
+# END ENGINE_CART BLOCK

data/README.md

@@ -18,8 +18,25 @@ After running the blacklight generator, run the blacklight_marc generator:
 
     $ rails generate blacklight_marc:marc
 
+The generator will create a model called MarcIndexer. This model can be customized by modifying
+the field configurations in its initializer as a Traject 2 indexer; new indexing behaviors can
+be added to it via mixins or inline methods. Two example mixins are provided:
+```ruby
+MarcIndexer
+  # you would add one or both of the mixins below
+  include Blacklight::Marc::Indexer::Formats
+  include Blacklight::Marc::Indexer::Dewey
+  def initialize
+    # and define fields as normal with the mixed-in methods
+    to_field 'format', get_format
+    to_field 'dewey100', dewey_facets(base: :hundreds)
+    to_field 'dewey010', dewey_facets(base: :tens)
+    to_field 'dewey_text', dewey_text
+  end
+end
+```
 ## Features
-* Rake task `solr:marc:index` to import .mrc files using SolrMarc
+* Rake task `solr:marc:index` to import .mrc files using Traject and app/models/marc_indexer
 * 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

data/Rakefile

@@ -1,5 +1,5 @@
 require "bundler/gem_tasks"
-ZIP_URL = "https://github.com/projectblacklight/blacklight-jetty/archive/v4.10.3.zip"
+ZIP_URL = "https://github.com/projectblacklight/blacklight-jetty/archive/v4.10.4.zip"
 
 require 'jettywrapper'
 require 'rspec/core/rake_task'
@@ -26,7 +26,7 @@ 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"
+      system "bundle exec rake solr:marc:index_test_data RAILS_ENV=test"
       abort "Error running fixtures" unless $?.success?
     end
   end

data/app/assets/stylesheets/blacklight_marc.scss

@@ -0,0 +1,42 @@
+/* border between items on marc view */
+$marc_item_separator: 1px solid $text-muted !default;
+
+#librarian_view
+{
+	left:-17%;
+	text-align:left;
+	top:10%;
+	width:700px;
+}
+
+#marc_view
+{
+	text-align:left;
+
+  .field
+  {
+    border-bottom: $marc_item_separator;
+    clear:both;
+  }
+
+  .ind1, .ind2
+  {
+    display:inline;
+    padding:0 $padding-xs-horizontal;
+  }
+
+  .subfields
+  {
+    padding-left:5em;
+  }
+
+  .tag_ind
+  {
+    float:left;
+  }
+}
+
+/* refworks uses a form; we need to give it some additional padding to make it look like a link */
+#refworks-form .btn {
+  padding: $nav-link-padding;
+}

data/app/helpers/blacklight_marc_helper.rb

@@ -1,5 +1,22 @@
 module BlacklightMarcHelper
 
+  # This method should move to BlacklightMarc in Blacklight 6.x
+  def refworks_export_url params = {}
+    "http://www.refworks.com/express/expressimport.asp?vendor=#{CGI.escape(params[:vendor] || application_name)}&filter=#{CGI.escape(params[:filter] || "MARC Format")}&encoding=65001" + (("&url=#{CGI.escape(params[:url])}" if params[:url]) || "")
+  end
+
+  def refworks_solr_document_path opts = {}
+    if opts[:id]
+      refworks_export_url(url: solr_document_url(opts[:id], format: :refworks_marc_txt))
+    end
+  end
+
+  # For exporting a single endnote document. (endnote_catalog_path is defined by blacklight-marc and it is used for multiple document export)
+  def single_endnote_catalog_path opts = {}
+    solr_document_path(opts.merge(format: 'endnote'))
+  end
+
+
   # puts together a collection of documents into one refworks export string
   def render_refworks_texts(documents)
     val = ''

data/{lib → app/models/concerns}/blacklight/solr/document/marc_export.rb

@@ -154,7 +154,6 @@ module Blacklight::Solr::Document::MarcExport
       "%7" => "250.a"
     }
     marc_obj = to_marc
-
     # TODO. This should be rewritten to guess
     # from actual Marc instead, probably.
     format_str = 'Generic'
@@ -190,25 +189,6 @@ module Blacklight::Solr::Document::MarcExport
     text
   end
 
-  ## DEPRECATED stuff left in for backwards compatibility, but should
-  # be gotten rid of eventually.
-
-  def to_zotero(format)
-    warn("[DEPRECATION]  Simply call document.export_as_openurl_kev to get an openURL kev context object suitable for including in a COinS; then have view code make the span for the COinS. ")
-    "<span class=\"Z3988\" title=\"#{export_as_openurl_kev(format)}\"></span>"
-  end
-
-  def to_apa
-    warn("[DEPRECATION] Call document.export_as_apa_citation instead.")
-    export_as_apa_citation
-  end
-
-  def to_mla
-    warn("[DEPRECATION] Call document.export_as_mla_citation instead.")
-  end
-  
-  
-
   protected
   
   # Main method for defining chicago style citation.  If we don't end up converting to using a citation formatting service

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

@@ -1,5 +1,5 @@
 <% if @document_list.any? {|d| d.exports_as? :endnote } %>
   <li class="endnote">
-    <%= link_to t('blacklight.tools.endnote'), bookmarks_path(:endnote, params_for_search), :class => "btn btn-default", :id => "endnoteLink" %>
+    <%= link_to t('blacklight.tools.endnote'), bookmarks_path(:endnote, search_state.params_for_search), :class => "btn btn-default", :id => "endnoteLink" %>
   </li>
 <% end %>

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

@@ -1,5 +1,5 @@
 <% if @document_list.any? {|d| d.exports_as? :refworks_marc_txt } %>
   <li class="refworks">
-    <%= link_to t('blacklight.tools.refworks'), refworks_export_url(url: bookmarks_export_url(:refworks_marc_txt, params_for_search)), :class => "btn btn-default", :id => "refworksLink" %>
+    <%= link_to t('blacklight.tools.refworks'), refworks_export_url(url: bookmarks_export_url(:refworks_marc_txt, search_state.params_for_search)), :class => "btn btn-default", :id => "refworksLink" %>
   </li>
 <% end %>

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

@@ -0,0 +1,6 @@
+<%# this partial is used by blacklight-marc 5.0 %>
+<%= form_tag refworks_export_url, :name => "refworks", :role => 'form', :target => "_blank", :id => "refworks-form" do %>
+
+<%= hidden_field_tag "ImportData", render_refworks_texts(documents) %>
+<%= submit_tag t('blacklight.tools.refworks'), :class => 'submit btn btn-default'%>
+<% end %>

data/app/views/catalog/show.refworks.erb

@@ -0,0 +1 @@
+<%= render_refworks_text(@document) %>

data/blacklight-marc.gemspec

@@ -9,15 +9,16 @@ Gem::Specification.new do |spec|
   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.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.files         = `git ls-files -z`.split("\x0")
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "blacklight", "~> 5.10"
+  spec.add_dependency 'blacklight', '>= 6.0.0.pre3', '< 7'
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
@@ -25,10 +26,13 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec-activemodel-mocks"
   spec.add_development_dependency "jettywrapper"
   spec.add_development_dependency "capybara"
-  spec.add_development_dependency "engine_cart", "~> 0.6"
+  spec.add_development_dependency "engine_cart", "~> 0.8"
 
+  spec.add_dependency "library_stdnums"
   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.
+  spec.add_dependency "traject", "~>2.1"
+  spec.add_dependency 'marc-fastxmlwriter' # NO REXML
 end

data/config/locales/blacklight_marc.de.yml

@@ -0,0 +1,5 @@
+de:
+  blacklight:
+    tools:
+      endnote: 'Export nach EndNote'
+      refworks: 'Export nach Refworks'

data/config/locales/{blacklight.en.yml → blacklight_marc.en.yml}

@@ -1,8 +1,9 @@
 en:
-
   blacklight:
     tools:
       librarian_view: 'Librarian View'
+      endnote: 'Export to EndNote'
+      refworks: 'Export to Refworks'
 
 
     search:
@@ -10,4 +11,3 @@ en:
         title: 'Librarian View'
         leader: 'LEADER %{leader}'
         empty: 'No MARC data found.'
-

data/config/locales/blacklight_marc.es.yml

@@ -0,0 +1,5 @@
+es:
+  blacklight:
+    tools:
+      endnote: 'Exportar a EndNote'
+      refworks: 'Exportar a Refworks'

data/config/locales/blacklight_marc.it.yml

@@ -0,0 +1,5 @@
+it:
+  blacklight:
+    tools:
+      endnote: 'Esporta in EndNote'
+      refworks: 'Esporta in Refworks'

data/config/locales/blacklight_marc.pt-BR.yml

@@ -0,0 +1,5 @@
+pt-BR:
+  blacklight:
+    tools:
+      endnote: 'Exportar para EndNote'
+      refworks: 'Exportar para Refworks'

data/lib/blacklight/marc.rb

@@ -3,13 +3,11 @@ 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'
+    autoload :Indexer, 'blacklight/marc/indexer'
 
     def self.add_routes(router, options = {})
       Blacklight::Marc::Routes.new(router, options).draw

data/lib/blacklight/marc/catalog.rb

@@ -1,5 +1,13 @@
 module Blacklight::Marc
   module Catalog
+    extend ActiveSupport::Concern
+
+    included do
+      add_show_tools_partial(:librarian_view, if: :render_librarian_view_control?, define_method: false)
+      add_show_tools_partial(:refworks, if: :render_refworks_action?, modal: false)
+      add_show_tools_partial(:endnote, if: :render_endnote_action?, modal: false, path: :single_endnote_catalog_path, define_method: false)
+    end
+
     def librarian_view
       @response, @document = fetch params[:id]
 
@@ -16,5 +24,20 @@ module Blacklight::Marc
         format.endnote { render :layout => false }
       end
     end
+
+    private
+
+    def render_refworks_action? config, options = {}
+      options[:document] && options[:document].respond_to?(:export_formats) && options[:document].export_formats.keys.include?(:refworks_marc_txt )
+    end
+
+    def render_endnote_action? config, options = {}
+      options[:document] && options[:document].respond_to?(:export_formats) && options[:document].export_formats.keys.include?(:endnote )
+    end
+
+    def render_librarian_view_control? config, options = {}
+      respond_to? :librarian_view_solr_document_path and options[:document] and options[:document].respond_to?(:to_marc)
+    end
+
   end
 end

data/lib/blacklight/marc/engine.rb

@@ -3,6 +3,24 @@ require "rails"
 
 module Blacklight::Marc
   class Engine < Rails::Engine
+    config.autoload_paths += %W(
+      #{config.root}/app/presenters
+      #{config.root}/app/controllers/concerns
+      #{config.root}/app/models/concerns
+    )
 
+    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