blacklight_marc 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1171cfeb002f676e5d9968eb3f14add4c283f9c2
-  data.tar.gz: 10bc0cc3965242b2a567bd7d0fd6b766ef8700b7
+  metadata.gz: a60af104e098faf23df159fc6b40d969930e1dcf
+  data.tar.gz: 282afc9c475de163651aec56541ca89dca089a10
 SHA512:
-  metadata.gz: f2635c66af2756dd4c1e0d29c464a8e22f0517fe319d325ab33d34082fb84b43867e92e74d9e4dc8f2de6c1a46f8060f25ce738117eec7126bc4df73c502a273
-  data.tar.gz: 13e52192af75956a56136db04552a008394a8a7ae714a2643e672dcaa699c88d9c916e3452d29bd4e9d5e52c9d4811790b7981bfeec22394f9b66e206cdbbbec
+  metadata.gz: 7f4efd8d66bbd5c9943fda14bc4269b93cc807dde946ce3a2442bf69f306c1ba633dd004fc5407651ba3cdab60f562f1c8f8ffe396cf48765ff26350bc63fc4e
+  data.tar.gz: deededf0ded38297e41e159c2b8c4eece7acf741991ebc839869d84f408be3b5cf0b54e982a55b66375297ffb5e3584af8e378fc82f32ca52920b7ac9114fd4e

data/lib/blacklight_marc.rb

@@ -6,5 +6,4 @@ module BlacklightMarc
       load "railties/solr_marc.rake"
     end
   end
-  
 end

data/lib/blacklight_marc/version.rb

@@ -1,3 +1,3 @@
 module BlacklightMarc
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/generators/blacklight_marc/marc_generator.rb

@@ -0,0 +1,66 @@
+require 'rails/generators'
+
+module BlacklightMarc
+  class MarcGenerator < Rails::Generators::Base
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    desc """
+     1. Adds additional mime types to you application in the file '/config/initializers/mime_types.rb'
+     2. Creates config/SolrMarc/... with settings for SolrMarc
+     3. Creates a CatalogController with some some demo fields for MARC-like data
+     4. Injects MARC-specific behaviors into the SolrDocument
+    """
+
+    # Content types used by Marc Document extension, possibly among others.
+    # Registering a unique content type with 'register' (rather than
+    # register_alias) will allow content-negotiation for the format. 
+    def add_mime_types
+      puts "Updating Mime Types"
+      insert_into_file "config/initializers/mime_types.rb", :after => "# Be sure to restart your server when you modify this file." do <<EOF
+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"]
+EOF
+      end
+    end 
+    
+    # Copy all files in templates/config directory to host config
+    def create_configuration_files
+      directory("config/SolrMarc")
+    end
+
+    # Generate blacklight catalog controller
+    def create_blacklight_catalog
+      copy_file "catalog_controller.rb", "app/controllers/catalog_controller.rb"
+    end   
+
+    # add MARC-specific extensions to the solr document
+    def add_marc_extension_to_solrdocument
+
+      insert_into_file "app/models/solr_document.rb", :after => "include Blacklight::Solr::Document" do <<EOF
+    
+      # The following shows how to setup this blacklight document to display marc documents
+  extension_parameters[:marc_source_field] = :marc_display
+  extension_parameters[:marc_format_type] = :marcxml
+  use_extension( Blacklight::Solr::Document::Marc) do |document|
+    document.key?( :marc_display  )
+  end
+  
+  field_semantics.merge!(    
+                         :title => "title_display",
+                         :author => "author_display",
+                         :language => "language_facet",
+                         :format => "format"
+                         )
+
+EOF
+      end
+    end
+
+  end
+end

data/lib/generators/blacklight_marc/templates/catalog_controller.rb

@@ -0,0 +1,180 @@
+# -*- encoding : utf-8 -*-
+require 'blacklight/catalog'
+
+class CatalogController < ApplicationController  
+
+  include Blacklight::Catalog
+
+  configure_blacklight do |config|
+    ## Default parameters to send to solr for all search-like requests. See also SolrHelper#solr_search_params
+    config.default_solr_params = { 
+      :qt => 'search',
+      :rows => 10 
+    }
+
+    ## Default parameters to send on single-document requests to Solr. These settings are the Blackligt defaults (see SolrHelper#solr_doc_params) or 
+    ## parameters included in the Blacklight-jetty document requestHandler.
+    #
+    #config.default_document_solr_params = {
+    #  :qt => 'document',
+    #  ## These are hard-coded in the blacklight 'document' requestHandler
+    #  # :fl => '*',
+    #  # :rows => 1
+    #  # :q => '{!raw f=id v=$id}' 
+    #}
+
+    # solr field configuration for search results/index views
+    config.index.show_link = 'title_display'
+    config.index.record_display_type = 'format'
+
+    # solr field configuration for document/show views
+    config.show.html_title = 'title_display'
+    config.show.heading = 'title_display'
+    config.show.display_type = 'format'
+
+    # solr fields that will be treated as facets by the blacklight application
+    #   The ordering of the field names is the order of the display
+    #
+    # Setting a limit will trigger Blacklight's 'more' facet values link.
+    # * If left unset, then all facet values returned by solr will be displayed.
+    # * If set to an integer, then "f.somefield.facet.limit" will be added to
+    # solr request, with actual solr request being +1 your configured limit --
+    # you configure the number of items you actually want _displayed_ in a page.    
+    # * If set to 'true', then no additional parameters will be sent to solr,
+    # but any 'sniffed' request limit parameters will be used for paging, with
+    # paging at requested limit -1. Can sniff from facet.limit or 
+    # f.specific_field.facet.limit solr request params. This 'true' config
+    # can be used if you set limits in :default_solr_params, or as defaults
+    # on the solr side in the request handler itself. Request handler defaults
+    # sniffing requires solr requests to be made with "echoParams=all", for
+    # app code to actually have it echo'd back to see it.  
+    #
+    # :show may be set to false if you don't want the facet to be drawn in the 
+    # facet bar
+    config.add_facet_field 'format', :label => 'Format'
+    config.add_facet_field 'pub_date', :label => 'Publication Year', :single => true
+    config.add_facet_field 'subject_topic_facet', :label => 'Topic', :limit => 20 
+    config.add_facet_field 'language_facet', :label => 'Language', :limit => true 
+    config.add_facet_field 'lc_1letter_facet', :label => 'Call Number' 
+    config.add_facet_field 'subject_geo_facet', :label => 'Region' 
+    config.add_facet_field 'subject_era_facet', :label => 'Era'  
+
+    config.add_facet_field 'example_pivot_field', :label => 'Pivot Field', :pivot => ['format', 'language_facet']
+
+    config.add_facet_field 'example_query_facet_field', :label => 'Publish Date', :query => {
+       :years_5 => { :label => 'within 5 Years', :fq => "pub_date:[#{Time.now.year - 5 } TO *]" },
+       :years_10 => { :label => 'within 10 Years', :fq => "pub_date:[#{Time.now.year - 10 } TO *]" },
+       :years_25 => { :label => 'within 25 Years', :fq => "pub_date:[#{Time.now.year - 25 } TO *]" }
+    }
+
+
+    # Have BL send all facet field names to Solr, which has been the default
+    # previously. Simply remove these lines if you'd rather use Solr request
+    # handler defaults, or have no facets.
+    config.add_facet_fields_to_solr_request!
+
+    # solr fields to be displayed in the index (search results) view
+    #   The ordering of the field names is the order of the display 
+    config.add_index_field 'title_display', :label => 'Title:' 
+    config.add_index_field 'title_vern_display', :label => 'Title:' 
+    config.add_index_field 'author_display', :label => 'Author:' 
+    config.add_index_field 'author_vern_display', :label => 'Author:' 
+    config.add_index_field 'format', :label => 'Format:' 
+    config.add_index_field 'language_facet', :label => 'Language:'
+    config.add_index_field 'published_display', :label => 'Published:'
+    config.add_index_field 'published_vern_display', :label => 'Published:'
+    config.add_index_field 'lc_callnum_display', :label => 'Call number:'
+
+    # solr fields to be displayed in the show (single result) view
+    #   The ordering of the field names is the order of the display 
+    config.add_show_field 'title_display', :label => 'Title:' 
+    config.add_show_field 'title_vern_display', :label => 'Title:' 
+    config.add_show_field 'subtitle_display', :label => 'Subtitle:' 
+    config.add_show_field 'subtitle_vern_display', :label => 'Subtitle:' 
+    config.add_show_field 'author_display', :label => 'Author:' 
+    config.add_show_field 'author_vern_display', :label => 'Author:' 
+    config.add_show_field 'format', :label => 'Format:' 
+    config.add_show_field 'url_fulltext_display', :label => 'URL:'
+    config.add_show_field 'url_suppl_display', :label => 'More Information:'
+    config.add_show_field 'language_facet', :label => 'Language:'
+    config.add_show_field 'published_display', :label => 'Published:'
+    config.add_show_field 'published_vern_display', :label => 'Published:'
+    config.add_show_field 'lc_callnum_display', :label => 'Call number:'
+    config.add_show_field 'isbn_t', :label => 'ISBN:'
+
+    # "fielded" search configuration. Used by pulldown among other places.
+    # For supported keys in hash, see rdoc for Blacklight::SearchFields
+    #
+    # Search fields will inherit the :qt solr request handler from
+    # config[:default_solr_parameters], OR can specify a different one
+    # with a :qt key/value. Below examples inherit, except for subject
+    # that specifies the same :qt as default for our own internal
+    # testing purposes.
+    #
+    # The :key is what will be used to identify this BL search field internally,
+    # as well as in URLs -- so changing it after deployment may break bookmarked
+    # urls.  A display label will be automatically calculated from the :key,
+    # or can be specified manually to be different. 
+
+    # This one uses all the defaults set by the solr request handler. Which
+    # solr request handler? The one set in config[:default_solr_parameters][:qt],
+    # since we aren't specifying it otherwise. 
+    
+    config.add_search_field 'all_fields', :label => 'All Fields'
+    
+
+    # Now we see how to over-ride Solr request handler defaults, in this
+    # case for a BL "search field", which is really a dismax aggregate
+    # of Solr search fields. 
+    
+    config.add_search_field('title') do |field|
+      # solr_parameters hash are sent to Solr as ordinary url query params. 
+      field.solr_parameters = { :'spellcheck.dictionary' => 'title' }
+
+      # :solr_local_parameters will be sent using Solr LocalParams
+      # syntax, as eg {! qf=$title_qf }. This is neccesary to use
+      # Solr parameter de-referencing like $title_qf.
+      # See: http://wiki.apache.org/solr/LocalParams
+      field.solr_local_parameters = { 
+        :qf => '$title_qf',
+        :pf => '$title_pf'
+      }
+    end
+    
+    config.add_search_field('author') do |field|
+      field.solr_parameters = { :'spellcheck.dictionary' => 'author' }
+      field.solr_local_parameters = { 
+        :qf => '$author_qf',
+        :pf => '$author_pf'
+      }
+    end
+    
+    # Specifying a :qt only to show it's possible, and so our internal automated
+    # tests can test it. In this case it's the same as 
+    # config[:default_solr_parameters][:qt], so isn't actually neccesary. 
+    config.add_search_field('subject') do |field|
+      field.solr_parameters = { :'spellcheck.dictionary' => 'subject' }
+      field.qt = 'search'
+      field.solr_local_parameters = { 
+        :qf => '$subject_qf',
+        :pf => '$subject_pf'
+      }
+    end
+
+    # "sort results by" select (pulldown)
+    # label in pulldown is followed by the name of the SOLR field to sort by and
+    # whether the sort is ascending or descending (it must be asc or desc
+    # except in the relevancy case).
+    config.add_sort_field 'score desc, pub_date_sort desc, title_sort asc', :label => 'relevance'
+    config.add_sort_field 'pub_date_sort desc, title_sort asc', :label => 'year'
+    config.add_sort_field 'author_sort asc, title_sort asc', :label => 'author'
+    config.add_sort_field 'title_sort asc, pub_date_sort desc', :label => 'title'
+
+    # If there are more than this many search results, no spelling ("did you 
+    # mean") suggestion is offered.
+    config.spell_max = 5
+  end
+
+
+
+end 

data/lib/generators/blacklight_marc/templates/config/SolrMarc/config-test.properties

@@ -0,0 +1,37 @@
+# If using the solr:marc:index task, you can define environment-specific
+# config files that will be used instead of 'config.properties' for
+# a specific environment. config-development.properties, 
+# config-production.properties, etc. 
+
+# Relative paths for solrmarc.solr.war.path and solr.path are relative
+# to the location of SolrMarc.jar, which for blacklight is by default
+# in blacklight/config/solr_marc.    
+
+# solrmarc.solr.war.path - must point to either a war file for the version of
+# Solr that you want to use, or to a directory of jar files extracted from a
+# Solr war files.  If this is not provided, SolrMarc can only work by
+# communicating with a running Solr server.
+#solrmarc.solr.war.path=../jetty/webapps/solr.war
+# Path to your solr instance
+#solr.path = ../jetty/solr
+
+# Relative paths for solr.indexer can be relative to the location of
+# this config.properties file. 
+solr.indexer = org.solrmarc.index.SolrIndexer
+solr.indexer.properties = index.properties
+
+# URL of running solr search engine to cause updates to be recognized.
+# * When solr.path and solrmarc.solr.war.path are defined, this is optional,
+# but if defined SolrMarc will issue a 'commit' after it's done indexing. 
+# * Alternately, do not define solr.path or solrmarc.solr.war.path to have
+# SolrMarc use HTTP Post to add documents. 
+# NOTE: 
+# When using the solr:marc:index rake task, this value will be automatically
+# looked up from your solr.yml, and the value here will NOT be used. 
+solr.hosturl = http://localhost:8888/solr/update
+
+# MARC handling parameters
+marc.to_utf_8 = true
+marc.permissive = true
+marc.default_encoding = MARC8
+marc.include_errors = false

data/lib/generators/blacklight_marc/templates/config/SolrMarc/config.properties

@@ -0,0 +1,37 @@
+# If using the solr:marc:index task, you can define environment-specific
+# config files that will be used instead of 'config.properties' for
+# a specific environment. config-development.properties, 
+# config-production.properties, etc. 
+
+# Relative paths for solrmarc.solr.war.path and solr.path are relative
+# to the location of SolrMarc.jar, which for blacklight is by default
+# in blacklight/config/solr_marc.    
+
+# solrmarc.solr.war.path - must point to either a war file for the version of
+# Solr that you want to use, or to a directory of jar files extracted from a
+# Solr war files.  If this is not provided, SolrMarc can only work by
+# communicating with a running Solr server.
+# solrmarc.solr.war.path= ../../../../jetty/webapps/solr.war
+# Path to your solr instance
+# solr.path = ../../../../jetty/solr
+
+# Relative paths for solr.indexer can be relative to the location of
+# this config.properties file. 
+solr.indexer = org.solrmarc.index.SolrIndexer
+solr.indexer.properties = index.properties
+
+# URL of running solr search engine to cause updates to be recognized.
+# * When solr.path and solrmarc.solr.war.path are defined, this is optional,
+# but if defined SolrMarc will issue a 'commit' after it's done indexing. 
+# * Alternately, do not define solr.path or solrmarc.solr.war.path to have
+# SolrMarc use HTTP Post to add documents. 
+# NOTE: 
+# When using the solr:marc:index rake task, this value will be automatically
+# looked up from your solr.yml, and the value here will NOT be used. 
+solr.hosturl = http://localhost:8983/solr/update
+
+# MARC handling parameters
+marc.to_utf_8 = true
+marc.permissive = true
+marc.default_encoding = MARC8
+marc.include_errors = false

data/lib/generators/blacklight_marc/templates/config/SolrMarc/index.properties

@@ -0,0 +1,97 @@
+# for more information on solrmarc mappings, 
+#  see http://code.google.com/p/solrmarc/w/list 
+#
+# GenericBlacklight uses these conventions, mostly. 
+#   _t for indexed fields (for searching)
+#   _display for stored fields (for display in UI)
+#   _facet for facet fields 
+#   _sort for sorting fields (fields used to sort results)
+#
+#   see jetty/solr/conf/schema.xml in Blacklight demo project
+#   see http://blacklight.rubyforge.org/  DEMO_README file
+
+id = 001, first
+marc_display = FullRecordAsXML
+text = custom, getAllSearchableFields(100, 900)
+
+language_facet = 008[35-37]:041a:041d, language_map.properties
+# format is for facet, display, and selecting partial for display in show view
+format = 007[0-1]:000[6-7]:000[6], (map.format), first
+isbn_t = 020a, (pattern_map.isbn_clean)
+material_type_display = custom, removeTrailingPunct(300aa)
+
+# Title fields
+#    primary title 
+title_t = custom, getLinkedFieldCombined(245a)
+title_display = custom, removeTrailingPunct(245a)
+title_vern_display = custom, getLinkedField(245a)
+#    subtitle
+subtitle_t = custom, getLinkedFieldCombined(245b)
+subtitle_display = custom, removeTrailingPunct(245b)
+subtitle_vern_display = custom, getLinkedField(245b)
+#    additional title fields
+title_addl_t = custom, getLinkedFieldCombined(245abnps:130[a-z]:240[a-gk-s]:210ab:222ab:242abnp:243[a-gk-s]:246[a-gnp]:247[a-gnp])
+title_added_entry_t = custom, getLinkedFieldCombined(700[gk-pr-t]:710[fgk-t]:711fgklnpst:730[a-gk-t]:740anp)
+title_series_t = custom, getLinkedFieldCombined(440anpv:490av)
+title_sort = custom, getSortableTitle
+
+# Author fields
+author_t = custom, getLinkedFieldCombined(100abcegqu:110abcdegnu:111acdegjnqu)
+author_addl_t = custom, getLinkedFieldCombined(700abcegqu:710abcdegnu:711acdegjnqu)
+author_display = custom, removeTrailingPunct(100abcdq:110[a-z]:111[a-z])
+author_vern_display = custom, getLinkedField(100abcdq:110[a-z]:111[a-z])
+author_sort = custom, getSortableAuthor
+
+# Subject fields
+subject_t = custom, getLinkedFieldCombined(600[a-u]:610[a-u]:611[a-u]:630[a-t]:650[a-e]:651ae:653aa:654[a-e]:655[a-c])
+subject_addl_t = custom, getLinkedFieldCombined(600[v-z]:610[v-z]:611[v-z]:630[v-z]:650[v-z]:651[v-z]:654[v-z]:655[v-z])
+subject_topic_facet = custom, removeTrailingPunct(600abcdq:610ab:611ab:630aa:650aa:653aa:654ab:655ab)
+subject_era_facet = custom, removeTrailingPunct(650y:651y:654y:655y)
+subject_geo_facet = custom, removeTrailingPunct(651a:650z)
+
+# Publication fields
+published_display = custom, removeTrailingPunct(260a)
+published_vern_display = custom, getLinkedField(260a)
+# used for facet and display, and copied for sort
+pub_date = custom, getDate
+
+# Call Number fields
+lc_callnum_display = 050ab, first
+lc_1letter_facet = 050a[0], callnumber_map.properties, first
+lc_alpha_facet = 050a, (pattern_map.lc_alpha), first
+lc_b4cutter_facet = 050a, first
+
+# URL Fields
+url_fulltext_display = custom, getFullTextUrls
+url_suppl_display = custom, getSupplUrls
+
+
+# MAPPINGS
+
+# format mapping
+#    leader 06-07
+map.format.aa = Book
+map.format.ab = Serial
+map.format.am = Book
+map.format.as = Serial
+map.format.ta = Book
+map.format.tm = Book
+#    leader 06
+map.format.c = Musical Score
+map.format.d = Musical Score
+map.format.e = Map or Globe
+map.format.f = Map or Globe
+map.format.i = Non-musical Recording
+map.format.j = Musical Recording
+map.format.k = Image
+map.format.m = Computer File
+#    007[0]  when it doesn't clash with above
+map.format.h = Microform
+map.format.q = Musical Score
+map.format.v = Video
+#    none of the above
+map.format = Unknown
+
+pattern_map.lc_alpha.pattern_0 = ^([A-Z]{1,3})\\d+.*=>$1
+
+pattern_map.isbn_clean.pattern_0 = ([- 0-9]*[0-9]).*=>$1