blacklight_marc 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee7757c3f37cf9db1d1a00da948280b41ed8a620
-  data.tar.gz: 99421600b8295c1812213bbc93e2872093c4f365
+  metadata.gz: 37e22ed6ab9f48e7660d6ff4e7fc96842dce788f
+  data.tar.gz: ef49ae16306b08c3264829b6376e1f87a5ac7e90
 SHA512:
-  metadata.gz: d358663f6daefb580f88a5f44ba018cfccf912d072a84fd3231d75d009e45c3b1b64e0192186dfa9230af20b63f13abc0528e86198b87f1d331045687651e875
-  data.tar.gz: a1f73ff2ece8a3a43b21b2835cd8cf037c82fcb140c5931cbdc121dd5630416aa28f2a3f19dd727c8836d6d1a620c71ee375ac23d8bfd0328f3e02369a385788
+  metadata.gz: 6976d71575ef6834d2cfab14a6f650266b7c9bd31c9aff9be72e2925108925c78769f72cb0722099803923ca12a01da2dca583bfc4de49e998e652a634e2a9dd
+  data.tar.gz: 853de50d49f2d36e9acfae99b6f1e21cbb06418a504879d404e6fc1ba92cc058e4195ede550d64136186b2fa4af69c117cc1e05208e655bbcd3c3f9ba633a662

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,12 @@
+notifications:
+  email: false
+
+rvm:
+  - 1.9.3
+  - jruby-19mode
+  - 2.0.0
+
+notifications:
+  irc: "irc.freenode.org#blacklight"
+  email:
+      - blacklight-commits@googlegroups.com

data/Gemfile

@@ -2,3 +2,18 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in blacklight_marc.gemspec
 gemspec
+
+gem 'simplecov', :platform => :mri
+
+group :test do
+  gem 'devise'
+  gem 'devise-guests'
+  gem "bootstrap-sass"
+  gem 'turbolinks'
+  gem "unicode", :platforms => [:mri_18, :mri_19]
+  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/README.md

@@ -1,6 +1,8 @@
+[![Build Status](https://travis-ci.org/projectblacklight/blacklight_marc.png?branch=master)](https://travis-ci.org/projectblacklight/blacklight_marc)
+
 # BlacklightMarc
 
-TODO: Write a gem description
+MARC-specific enhancements for [Blacklight](https://github.com/projectblacklight/blacklight)
 
 ## Installation
 
@@ -12,13 +14,11 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install blacklight_marc
-
-## Usage
+## Documentation, Information and Support
 
-TODO: Write usage instructions here
+* [Project Homepage](http://projectblacklight.org)
+* [Developer Documentation](https://github.com/projectblacklight/blacklight/wiki)
+* [Quickstart Guide](https://github.com/projectblacklight/blacklight/wiki/Quickstart)
 
 ## Contributing
 

data/Rakefile

@@ -1 +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/views/catalog/_marc_view.html.erb

@@ -0,0 +1,32 @@
+<div id="marc_view">
+  <% 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/librarian_view.html.erb

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

data/blacklight_marc.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'blacklight_marc/version'
@@ -20,7 +19,10 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_dependency "railties", ">= 3.2.6", "< 5"
+  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.

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/solr/document/marc.rb

@@ -17,6 +17,7 @@
 # SolrDocument.extension_paramters[:marc_source_field] = "name_of_solr_stored_field"
 # SolrDocument.extension_parameters[:marc_format_type] = :marc21 # or :marcxml
 require 'marc'
+
 module Blacklight::Solr::Document::Marc
 
   include Blacklight::Solr::Document::MarcExport # All our export_as stuff based on to_marc. 

data/lib/blacklight/solr/document/marc_export.rb

@@ -104,14 +104,6 @@ module Blacklight::Solr::Document::MarcExport
   # proprietary marc-ish in text/plain format. See
   # http://robotlibrarian.billdueber.com/sending-marcish-data-to-refworks/
   def export_as_refworks_marc_txt
-    # plugin/gem weirdness means we do need to manually require
-    # here.
-    # As of 11 May 2010, Refworks has a problem with UTF-8 if it's decomposed,
-    # it seems to want C form normalization, although RefWorks support
-    # couldn't tell me that. -jrochkind
-    # DHF: moved this require a little lower in the method.
-    # require 'unicode'    
-  
     fields = to_marc.find_all { |f| ('000'..'999') === f.tag }
     text = "LEADER #{to_marc.leader}"
     fields.each do |field|
@@ -129,19 +121,12 @@ module Blacklight::Solr::Document::MarcExport
         end
     end
 
-    if Blacklight.jruby? 
-      require 'java'
-      java_import java.text.Normalizer
-      Normalizer.normalize(text, Normalizer::Form::NFC).to_s
-    else 
-      begin
-        require 'unicode'
-        Unicode.normalize_C(text)
-      rescue LoadError
-        Blacklight.logger.warn "Unable to load unicode library in #export_as_refworks_marc_txt; skipping unicode normalization"
-        text
-      end
-    end
+    # As of 11 May 2010, Refworks has a problem with UTF-8 if it's decomposed,
+    # it seems to want C form normalization, although RefWorks support
+    # couldn't tell me that. -jrochkind
+    text = ActiveSupport::Multibyte::Unicode.normalize(text, :c)
+    
+    return text
   end 
 
   # Endnote Import Format. See the EndNote User Guide at:
@@ -599,4 +584,4 @@ module Blacklight::Solr::Document::MarcExport
     return temp_name.last + " " + temp_name.first
   end 
   
-end
+end

data/lib/blacklight_marc.rb

@@ -1,14 +1,15 @@
 require "blacklight_marc/version"
-
+require 'blacklight'
 module BlacklightMarc
-  class Railtie < Rails::Railtie
-    rake_tasks do
-      load "railties/solr_marc.rake"
-    end
+  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'
 
-    initializer "blacklight MARC" do
-      Blacklight::Solr::Document.autoload :Marc, 'blacklight/solr/document/marc'
-      Blacklight::Solr::Document.autoload :MarcExport, 'blacklight/solr/document/marc_export'
-    end
+  def self.add_routes(router, options = {})
+    BlacklightMarc::Routes.new(router, options).draw
   end
 end

data/lib/blacklight_marc/catalog.rb

@@ -0,0 +1,12 @@
+module BlacklightMarc
+  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
+  end
+end

data/lib/blacklight_marc/engine.rb

@@ -0,0 +1,8 @@
+require "blacklight_marc"
+require "rails"
+
+module BlacklightMarc
+  class Engine < Rails::Engine
+
+  end
+end

data/lib/blacklight_marc/railtie.rb

@@ -0,0 +1,17 @@
+module BlacklightMarc
+  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,41 @@
+# -*- encoding : utf-8 -*-
+module BlacklightMarc
+  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"
+        end
+      end
+   end
+   
+  include RouteSets
+  end
+end

data/lib/blacklight_marc/version.rb

@@ -1,3 +1,3 @@
 module BlacklightMarc
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end