Blacklight 2.3

Author: cbeer

.gitignore

@@ -0,0 +1,114 @@
+== Pre-requisites
+
+===Ruby
+
+Ruby version 1.8.7 (or 1.8.6 enterprise) is required. You can find out which version you are running by executing:
+	ruby -v
+Information on installing Ruby can be found here:
+http://www.ruby-lang.org/en/downloads
+
+===Ruby Gems
+
+You'll need Ruby Gems version 1.3.1 or later. You can check which version of “gem” you have by running:
+	gem -v
+Information on installing Ruby Gems can be found here:
+	http://www.rubygems.org/read/chapter/3
+
+To update your Ruby Gems, run (YMMV for various operating systems):
+	sudo gem install rubygems-update
+	sudo update_rubygems
+
+You can also manually install Ruby Gems:
+	wget http://rubyforge.org/frs/download.php/45905/rubygems-1.3.1.tgz
+	tar xzf rubygems-1.3.1.tgz
+	cd rubygems-1.3.1
+	sudo ruby setup.rb
+	gem -v
+
+These commands should work for Linux and OSX, but we haven't yet written any instructions for Windows installation. If anyone is able to volunteer for this task, please let us know! 
+
+===Ruby Gems Sources
+
+Make sure you have the standard ruby gem sources available: 
+	gem sources -l
+should show
+	http://gems.rubyforge.org
+	http://gems.rubyonrails.org
+
+If you're missing those gem sources, add them like this:
+	gem sources -a http://gems.rubyforge.org
+	gem sources -a http://gems.rubyonrails.org
+	gem sources -a http://gems.github.com
+
+===Git Client
+
+	Some of the rubygems required by blacklight are hosted in git repositories. Information on getting the git client installed can be found here:
+
+	http://git-scm.com/
+	http://book.git-scm.com/2_installing_git.html
+
+	If you are behind a firewall, you may need to open port 9418 for Git.
+
+
+===Install Blacklight's Ruby Gem dependencies:
+First, build the bundled gems for your local system:
+	rake gems:build
+
+Now see if you have all of the required gems installed, or whether you're still missing some: 
+	rake gems
+	
+The ''rake gems'' command will give you a list of the required gems and their version numbers, and will tell you which ones are installed already. 
+You can also see vendor/plugins/blacklight/init.rb for the Blacklight plugin dependencies' versions.
+An example of a versioned install: sudo gem install rails --version '2.3.2')
+
+You can confirm your gem installations and their release numbers with
+
+	gem list
+	
+===Database dependencies
+You can choose to use any database that has ruby on rails bindings, but sqlite and mysql are used most commonly and are documented here. 
+ 
+* if you are using sqlite3:
+	sudo gem install sqlite3-ruby
+
+If you want to use sqlite, you will need to install sqlite3 and its ruby bindings
+
+On Red Hat Fedora the command is: 
+	sudo yum install sqlite sqlite-devel ruby-sqlite3
+
+On OSX macports the command is: 
+    sudo port install sqlite3 rb-sqlite3
+
+On FreeBSD the command is: 
+	cd /usr/ports/databases/rubygem-sqlite3 && make install clean
+
+
+* if you are using mysql, make sure mysql is installed, and run:
+	sudo gem install mysql	
+
+===Dependencies included with Blacklight
+
+* ActsAsTaggableOnSteroids plugin docs: http://agilewebdevelopment.com/plugins/acts_as_taggable_on_steroids
+
+* Resource Controller: http://github.com/giraffesoft/resource_controller/tree/master There is a very good 
+video tutorial on the resource_controller plugin: http://www.vimeo.com/637894
+
+These gems are vendorized with blacklight and will be built locally by the ''rake gems:build'' command
+	authlogic-2.0.13
+	curb-0.3.4
+	haml-2.0.9
+	marc-0.2.2
+	mislav-hanna-0.1.7
+	mislav-will_paginate-2.3.8
+	mwmitchell-material_girl-0.0.2
+	mwmitchell-rsolr-0.8.8
+	mwmitchell-rsolr-ext-0.7.35
+	nokogiri-1.3.2
+	rack-1.0.0
+	rdoc-2.3.0
+	rspec-1.2.7
+	rspec-rails-1.2.7.1
+	ruby-xslt-0.9.6
+	webrat-0.4.4
+
+

rails/vendor/plugins/blacklight/CHANGES CHANGES

@@ -0,0 +1,128 @@
+=Blacklight 
+
+Please see Project Info below for main information about this project and plugin.
+
+Please see Solr in Blacklight below for information about setting up and configuring Solr.
+
+Note: these instructions appy to releases 2.2.0 and above.
+
+Note: issue commands from your Rails application's root directory.
+
+==How to Install the Blacklight Plugin into Your Rails Project
+
+1. Create your rails app: http://guides.rubyonrails.org/getting_started.html#creating-a-new-rails-project
+2. Install Blacklight: 
+From a release:
+	script/plugin -v install http://blacklight.rubyforge.org/svn/releases/plugins/blacklight-plugin-2.2.0_RC2/
+Or from trunk:
+    script/plugin -v install http://blacklight.rubyforge.org/svn/trunk/rails/vendor/plugins/blacklight/
+
+Using <tt>script/plugin install</tt> calls the plugin's install.rb script, which does the following: 
+
+1. automatically installs the Engines plugin ( http://rails-engines.org )
+2. updates config/environment.rb with the necessary lines for Engines and Blacklight
+3. copies the vendorized Authlogic gem from vendor/plugins/blacklight/vendor/gems to vendor/gems
+4. adds default solr.yml to config dir
+5. copies the migration files from vendor/plugins/blacklight/db/migrate to db/migrate
+6. copies the default blacklight_config.rb file to config/initializers/blacklight_config.rb
+
+If you need to manually install Blacklight, see Installing Blacklight Manually below, then return to Post Installation.
+
+==Post Installation
+
+Remove public/index.html, app/controllers/application_controller.rb and app/helpers/application_helper.rb:
+  
+  rm public/index.html
+  rm app/controllers/application_controller.rb
+  rm app/helpers/application_helper.rb
+  
+Next, run the migrations. By default, Rails uses a SQLite3 database. Configure others in config/databases.yml:
+
+	rake db:migrate
+  
+You need a running instance of Solr. Just to get going you can use the test instance in the Blacklight plugin:
+
+	cd vendor/plugins/blacklight/jetty
+	java -jar start.jar
+  
+This starts an instance of jetty with Solr running on port 8983. If you want to start on another port, use Java's -D argument:
+
+	java -Djetty.port=8888 -jar start.jar
+  
+This Solr instance has data. Once you start it you can run the Rails app against this.
+
+	script/server
+ 
+Now navigate to http://localhost:3000 and you should see a running app with the test data set!
+
+
+==Installing Blacklight Manually
+
+This assumes that for some reason you can't install the plugin via <tt>script/plugin install</tt> or
+there was a problem and you need to finish manually. Otherwise, see the instructions above.
+
+1. Create your Rails app: http://guides.rubyonrails.org/getting_started.html#creating-a-new-rails-project
+2. Get the Blacklight plugin and put it in your plugins directory:
+  
+    Edge: svn export http://blacklight.rubyforge.org/svn/trunk/rails/vendor/plugins/blacklight vendor/plugins/blacklight
+    
+    Specific Release: 
+    
+      1. Find the release you want here: http://blacklight.rubyforge.org/svn/releases/plugins/
+      2. Then navigate to the plugin, for example: http://blacklight.rubyforge.org/svn/releases/plugins/blacklight-plugin-2.2.0
+      3. Use SVN to export it: svn export http://blacklight.rubyforge.org/svn/releases/plugins/blacklight-plugin-2.2.0
+      
+    Finally, you can also downlowd the archive and unpack it in vendor/plugins/blacklight:
+    
+      1. Find the release you want here: http://rubyforge.org/frs/?group_id=5235
+      2. Download it into vendor/plugins
+      3. Move to the directory: cd vendor/plugins
+      4. Unarchive: tar xvzf blacklight-plugin-2.2.0
+      5. Rename the directory: mv blacklight-plugin-2.2.0 blacklight
+    
+3. Install the Engines plugin:
+    
+    script/plugin install git://github.com/lazyatom/engines.git
+    
+  If you aren't using or can't use script/plugin, then install it manually:
+  
+    1. git clone git://github.com/lazyatom/engines.git vendor/plugins/engines
+    2. rm -rf vendor/plugins/engines/.git
+    
+4. Update _config/environment.rb_ with necessary lines:
+
+    1. Below require File.join(File.dirname(__FILE__), 'boot'):
+  
+      require File.join(File.dirname(__FILE__), '../vendor/plugins/engines/boot')
+    
+    2. Inside Rails::Initializer.run do |config| block:
+  
+      config.gem 'authlogic'
+      config.plugin_paths += ["#{RAILS_ROOT}/vendor/plugins/blacklight/vendor/plugins"]  
+      config.plugins = %W(engines blacklight acts_as_taggable_on_steroids resource_controller)
+      
+5. Install the Authlogic gem. You can install this as a system gem or copy it from the Blacklight plugin:
+
+    * As a system gem:
+
+      sudo gem install authlogic
+
+    * As a vendorized gem (this is what the Blacklight installer does--see above):
+
+      mkdir vendor/gems
+      cp -rp vendor/plugins/blacklight/vendor/gems/authlogic-<version> vendor/gems/authlogic-<version>
+
+6. Copy solr.yml to config dir:
+
+    cp vendor/plugins/blacklight/install/solr.yml config/
+    
+7. Copy the migration files to your app:
+
+    cp -pR vendor/plugins/blacklight/db/migrate db/migrate
+
+8. Copy the default blacklight_config.rb file to config/initializers:
+
+    cp vendor/plugins/blacklight/config/initializers/blacklight_config.rb config/initializers/
+    
+9. Go to "Post Installation", above.
+

rails/LICENSE LICENSE

@@ -0,0 +1,59 @@
+# require 'rake'
+# require 'rake/testtask'
+# require 'rake/rdoctask'
+
+require(File.join(File.dirname(__FILE__), 'config', 'boot'))
+
+require 'rake'
+#require 'rake/clean'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'tasks/rails'
+
+# the default rake task
+desc "run migrations and call solr:spec and solr:features"
+task :default => "test"
+
+# run migrations and call solr:spec and solr:features
+desc 'run migrations and call solr:spec and solr:features'
+  task "test" => ["db:migrate", "solr:spec", "solr:features"] do
+end
+
+# Set constants used for publishing releases and rdocs
+
+# The name of your project 
+PROJECT = "Blacklight" 
+# Short summary of your project, used in packaging. 
+PROJECT_SUMMARY = "Blacklight is open source discovery software. Libraries (or anyone else) may use blacklight to enable searching and browsing of their collections online. Blacklight uses Solr to index and search text and/or metadata, and it has a highly configurable Ruby on Rails front-end. Currently, Blacklight can index, search, and provide faceted browsing for MaRC records and several kinds of XML documents, including TEI, EAD, and GDMS. Blacklight was developed at the University of Virginia Library and is made public under an Apache 2.0 license." 
+# The project's package name (as opposed to its display name). Used for 
+# RubyForge connectivity and packaging. 
+UNIX_NAME = "blacklight" 
+# Your RubyForge user name. 
+RUBYFORGE_USER = ENV["RUBYFORGE_USER"] || "eos8d" 
+# Directory on RubyForge where your website's files should be uploaded. 
+RUBYFORGE_PATH = "/var/www/gforge-projects/blacklight/" 
+# Output directory for the rdoc html files. 
+# If you don't have a custom homepage, and want to use the RDoc 
+# index.html as homepage, just set it to WEBSITE_DIR. 
+RDOC_HTML_DIR = "html" 
+# Additional RDoc formatted files, besides the Ruby source files. 
+RDOC_FILES = FileList["README.rdoc", "Changes.rdoc"]
+CURRENT_SVN_BRANCH = "http://blacklight.rubyforge.org/svn/trunk/"
+
+
+desc 'Generate documentation for the blacklight plugin.'
+Rake::RDocTask.new('rdoc') do |t| 
+  t.rdoc_files.include('README.rdoc', 'lib/**/*.rb') 
+  t.main = 'README.rdoc' 
+  t.title = "Blacklight API documentation" 
+  t.options << '--line-numbers' << '--inline-source'
+end 
+
+desc "Upload website to RubyForge. scp will prompt for your RubyForge password." 
+task "publish-rdoc" => ["rdoc"] do 
+  rubyforge_path = "/var/www/gforge-projects/#{UNIX_NAME}/" 
+  sh "scp -r #{RDOC_HTML_DIR}/* " + 
+    "#{RUBYFORGE_USER}@rubyforge.org:#{RUBYFORGE_PATH}", 
+    :verbose => true 
+end
+

PRE-REQUISITES.rdoc

@@ -3,6 +3,7 @@
 # Likewise, all the methods added will be available for all controllers.
 #
 class ApplicationController < ActionController::Base
+  
   filter_parameter_logging :password, :password_confirmation  
   helper_method :current_user_session, :current_user