blacklight 3.0pre1

data/lib/blacklight/version.rb

@@ -0,0 +1,3 @@
+module Blacklight
+  VERSION = "3.0pre1"
+end

data/lib/colorize.rb

@@ -0,0 +1,196 @@
+# == colorize
+#     http://colorize.rubyforge.org
+#     http://fazibear.prv.pl
+#     
+
+#
+# Colorize String class extension.
+#
+class String
+
+  #
+  # Colors Hash
+  #
+  COLORS = {
+    :black          => 0,
+    :red            => 1,
+    :green          => 2,
+    :yellow         => 3,
+    :blue           => 4,
+    :magenta        => 5,
+    :cyan           => 6,
+    :white          => 7,
+    :default        => 9,
+    
+    :light_black    => 10,
+    :light_red      => 11,
+    :light_green    => 12,
+    :light_yellow   => 13,
+    :light_blue     => 14,
+    :light_magenta  => 15,
+    :light_cyan     => 16,
+    :light_white    => 17
+  }
+
+  #
+  # Modes Hash
+  #
+  MODES = {
+    :default        => 0, # Turn off all attributes
+    #:bright        => 1, # Set bright mode
+    :underline      => 4, # Set underline mode
+    :blink          => 5, # Set blink mode
+    :swap           => 7, # Exchange foreground and background colors
+    :hide           => 8  # Hide text (foreground color would be the same as background)
+  }
+  
+  protected
+  
+  #
+  # Set color values in new string intance
+  #
+  def set_color_parameters( params )
+    if (params.instance_of?(Hash))
+      @color = params[:color]
+      @background = params[:background]
+      @mode = params[:mode]
+      @uncolorized = params[:uncolorized]
+      self
+    else
+      nil
+    end
+  end
+  
+  public
+
+  #
+  # Change color of string
+  #
+  # Examples:
+  #
+  #   puts "This is blue".colorize( :blue )
+  #   puts "This is light blue".colorize( :light_blue )
+  #   puts "This is also blue".colorize( :color => :blue )
+  #   puts "This is light blue with red background".colorize( :color => :light_blue, :background => :red )
+  #   puts "This is light blue with red background".colorize( :light_blue ).colorize( :background => :red )
+  #   puts "This is blue text on red".blue.on_red
+  #   puts "This is red on blue".colorize( :red ).on_blue
+  #   puts "This is red on blue and underline".colorize( :red ).on_blue.underline
+  #   puts "This is blue text on red".blue.on_red.blink
+  #   puts "This is uncolorized".blue.on_red.uncolorize
+  #
+  def colorize( params )
+    return self unless STDOUT.isatty
+    
+    begin
+      require 'Win32/Console/ANSI' if RUBY_PLATFORM =~ /win32/
+    rescue LoadError
+      raise 'You must gem install win32console to use colorize on Windows'
+    end
+    
+    color_parameters = {}
+
+    if (params.instance_of?(Hash))
+      color_parameters[:color] = COLORS[params[:color]]
+      color_parameters[:background] = COLORS[params[:background]]
+      color_parameters[:mode] = MODES[params[:mode]]
+    elsif (params.instance_of?(Symbol))
+      color_parameters[:color] = COLORS[params]
+    end
+    
+    color_parameters[:color] ||= @color ||= COLORS[:default]
+    color_parameters[:background] ||= @background ||= COLORS[:default]
+    color_parameters[:mode] ||= @mode ||= MODES[:default]
+
+    color_parameters[:uncolorized] ||= @uncolorized ||= self.dup
+   
+    # calculate bright mode
+    color_parameters[:color] += 50 if color_parameters[:color] > 10
+
+    color_parameters[:background] += 50 if color_parameters[:background] > 10
+
+    "\033[#{color_parameters[:mode]};#{color_parameters[:color]+30};#{color_parameters[:background]+40}m#{color_parameters[:uncolorized]}\033[0m".set_color_parameters( color_parameters )
+  end
+
+  #
+  # Return uncolorized string
+  #
+  def uncolorize
+    @uncolorized || self
+  end
+  
+  #
+  # Return true if sting is colorized
+  #
+  def colorized?
+    !defined?(@uncolorized).nil?
+  end
+
+  #
+  # Make some color and on_color methods
+  #
+  COLORS.each_key do | key |
+    next if key == :default
+
+    define_method key do
+      self.colorize( :color => key )
+    end
+    
+    define_method "on_#{key}" do
+      self.colorize( :background => key )
+    end
+  end
+
+  #
+  # Methods for modes
+  #
+  MODES.each_key do | key |
+    next if key == :default
+    
+    define_method key do
+      self.colorize( :mode => key )
+    end
+  end
+
+  class << self
+    
+    #
+    # Return array of available modes used by colorize method
+    #
+    def modes
+      keys = []
+      MODES.each_key do | key |
+        keys << key
+      end
+      keys
+    end
+
+    #
+    # Return array of available colors used by colorize method
+    #
+    def colors
+      keys = []
+      COLORS.each_key do | key |
+        keys << key
+      end
+      keys
+    end 
+
+    #
+    # Display color matrix with color names.
+    #
+    def color_matrix( txt = "[X]" )
+      size = String.colors.length
+      String.colors.each do | color |
+        String.colors.each do | back |
+         print txt.colorize( :color => color, :background => back )
+        end
+        puts " < #{color}"
+      end
+      String.colors.reverse.each_with_index do | back, index |
+        puts "#{"|".rjust(txt.length)*(size-index)} < #{back}"
+      end 
+      ""
+    end
+  end
+end

data/lib/generators/blacklight/blacklight_generator.rb

@@ -0,0 +1,134 @@
+require 'rails/generators'
+require 'rails/generators/migration'     
+
+class BlacklightGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  source_root File.expand_path('../templates', __FILE__)
+  
+  argument     :model_name, :type => :string , :default => "user"
+  class_option :devise    , :type => :boolean, :default => false, :aliases => "-d", :desc => "Use Devise as authentication logic (this is default)."
+  
+  desc """
+This generator makes the following changes to your application:
+ 1. Creates several database migrations if they do not exist in /db/migrate
+ 2. Adds additional mime types to you application in the file '/config/initializers/mime_types.rb'
+ 3. Creates config/initializers/blacklight_config.rb which you should then modify for your instance
+ 4. Creates config/solr.yml with a default solr configuration that should work with standard marc records
+ 5. Creates congig/SolrMarc/... with settings for SolrMarc
+ 6. Creates a number of public assets, including images, stylesheets, and javascript
+ 7. Adds a solr_marc.jar file to your lib/ directory 
+ 9. Injects behavior into your user application_controller.rb
+ 9. Injects behavior into your user model
+10. Creates a blacklight catalog controller in your /app/controllers directory
+11. Creates a blacklight document in your /app/models directory
+Thank you for Installing Blacklight.
+       """ 
+  # Implement the required interface for Rails::Generators::Migration.
+  # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
+  def self.next_migration_number(path)
+    unless @prev_migration_nr
+      @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+    else
+      @prev_migration_nr += 1
+    end
+    @prev_migration_nr.to_s
+  end
+
+  # 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
+
+  # Install Devise? 
+  def generate_devise_assets
+    if options[:devise]
+      gem "devise"
+      run "bundle install"      
+      generate "devise:install"
+      generate "devise", model_name.classify
+      generate "devise:views"
+    end
+  end
+
+  # Copy all files in templates/config directory to host config
+  def create_configuration_files
+    copy_file "config/blacklight_config.rb", "config/initializers/blacklight_config.rb"
+    copy_file "config/solr.yml", "config/solr.yml"
+    directory("config/SolrMarc")
+  end
+  
+  # Copy all files in templates/public/ directory to public/
+  def copy_public_assets 
+    directory("public")
+  end
+  
+  # Setup the database migrations
+  def copy_migrations
+    # Can't get this any more DRY, because we need this order.
+    better_migration_template "create_searches.rb"
+    better_migration_template "create_bookmarks.rb"
+    better_migration_template "remove_editable_fields_from_bookmarks.rb"
+    better_migration_template "add_user_types_to_bookmarks_searches.rb"
+  end
+
+  # Copy ocver the solr_marc.jar file
+  def copy_solr_marc 
+    copy_file "SolrMarc.jar", "lib/SolrMarc.jar"
+  end
+
+  # Add Blacklight to the user model
+  def inject_blacklight_user_behavior
+    file_path = "app/models/#{model_name.underscore}.rb"
+    if File.exists?(file_path) 
+      inject_into_class file_path, model_name.classify do 
+        "# Connects this user object to Blacklights Bookmarks and Folders. " +
+        "\n include Blacklight::User\n"        
+      end
+    else
+      puts "     \e[31mFailure\e[0m  Blacklight requires a user object in order to presist bookmarks and saved searches. This generators assumes that the model is defined in the file /app/models/user.rb, which does not exist.  If you used a different name, please re-run the migration and provide that name as an argument. Such as \b  rails -g blacklight client" 
+    end    
+  end
+
+  # Add Blacklight to the application controller
+  def inject_blacklight_controller_behavior    
+#    prepend_file("app/controllers/application_controller.rb", "require 'blacklight/controller'\n\n")
+    inject_into_class "app/controllers/application_controller.rb", "ApplicationController" do
+      "  # Adds a few additional behaviors into the application controller \n " +        
+        "  include Blacklight::Controller\n" + 
+        "  # Please be sure to impelement current_user and user_session. Blacklight depends on \n" +
+        "  # these methods in order to perform user specific actions. \n\n"
+    end
+  end
+  
+  # Generate blacklight document and the catalog controller
+  def create_blacklight_catalog_and_document
+    copy_file "solr_document.rb", "app/models/solr_document.rb"
+    copy_file "catalog_controller.rb", "app/controllers/catalog_controller.rb"
+  end
+
+  private  
+  
+  def better_migration_template (file)
+    begin
+      migration_template "migrations/#{file}", "db/migrate/#{file}"
+      sleep 1 # ensure scripts have different time stamps
+    rescue
+      puts "  \e[1m\e[34mMigrations\e[0m  " + $!.message
+    end
+  end
+
+end  
+

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

@@ -0,0 +1,8 @@
+require 'blacklight/catalog'
+
+class CatalogController < ApplicationController  
+
+  include Blacklight::SolrHelper
+  include Blacklight::Catalog
+
+end 

data/lib/generators/blacklight/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/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/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