hydra-head 3.0.0pre1

data/hydra-head.gemspec

@@ -0,0 +1,70 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "hydra-head/version"
+
+Gem::Specification.new do |s|
+  s.name        = "hydra-head"
+  s.version     = HydraHead::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Matt Zumwalt, Bess Sadler, Julie Meloni, Naomi Dushay, Jessie Keck, John Scofield, Justin Coyne & many more.  See https://github.com/projecthydra/hydra-head/contributors"]
+  s.email       = ["hydra-tech@googlegroups.com"]
+  s.homepage    = "http://projecthydra.org"
+  s.summary     = %q{Hydra-Head Rails Engine (requires Rails3) }
+  s.description = %q{Hydra-Head is a Rails Engine containing the core code for a Hydra application. The full hydra stack includes: Blacklight, Fedora, Solr, active-fedora, solrizer, and om}
+
+  s.add_dependency "rails", '>= 3.0'
+  s.add_dependency "blacklight", '3.0.0'  
+  s.add_dependency "active-fedora", '>= 2.3.3'
+  s.add_dependency 'builder'
+  s.add_dependency 'columnize'
+  s.add_dependency 'crack'
+  s.add_dependency 'curb'
+  s.add_dependency 'database_cleaner'
+  s.add_dependency 'diff-lcs'
+  s.add_dependency 'facets', '2.8.4'
+  s.add_dependency 'haml'
+  s.add_dependency 'httparty'
+  s.add_dependency 'json_pure', '>1.4.3'
+  s.add_dependency 'launchy'
+  s.add_dependency 'linecache'
+  s.add_dependency 'mime-types'
+  s.add_dependency 'multipart-post'
+  s.add_dependency 'nokogiri' # Default to using the version required by Blacklight
+  s.add_dependency 'om', '>=1.2.3'
+  s.add_dependency 'rack'
+  s.add_dependency 'rack-test'
+  s.add_dependency 'rake'
+  s.add_dependency 'rcov'
+  s.add_dependency 'RedCloth', '=4.2.3'
+  s.add_dependency 'solr-ruby' 
+  s.add_dependency 'solrizer', '>=1.1.0'
+  s.add_dependency 'solrizer-fedora', '>=1.1.0'
+  s.add_dependency 'sqlite3-ruby', '1.2.5'
+  s.add_dependency 'term-ansicolor'
+  s.add_dependency 'trollop'
+  s.add_dependency 'will_paginate'
+  s.add_dependency 'xml-simple'
+  s.add_dependency 'yard'
+  s.add_dependency 'block_helpers'
+  s.add_dependency 'sanitize'
+  
+  s.add_development_dependency 'jettywrapper', "~> 0.0.10"
+  s.add_development_dependency 'ruby-debug'
+  s.add_development_dependency 'ruby-debug-base'
+  s.add_development_dependency 'rspec', '>= 2.0.0'  
+  s.add_development_dependency 'rspec-rails', '>= 2.0.0' # rspec-rails 2.0.0 requires Rails 3.
+  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'cucumber', '>=0.8.5'
+  s.add_development_dependency 'cucumber-rails', '>=1.0.0'
+#  s.add_development_dependency 'capybara'
+  s.add_development_dependency 'gherkin'
+  s.add_development_dependency 'factory_girl'
+#s.add_development_dependency 'markup_validity'
+  s.add_development_dependency "rake"
+
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/application_controller.rb

@@ -0,0 +1,25 @@
+module HydraHead
+  ## Define ControllerMethods
+  module Controller
+  	## this one manages the usual self.included, klass_eval stuff
+    extend ActiveSupport::Concern
+
+    included do
+      before_filter :method_for_before_filtering
+    end
+
+    module InstanceMethods
+      def method_for_before_filtering
+        #puts "Filtering before" 
+      end
+
+      def method_not_a_filter
+        puts "not used as a filter"
+      end
+    end
+  end
+end
+
+::ActionController::Base.send :include, HydraHead::Controller
+
+

data/lib/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/lib/engine.rb

@@ -0,0 +1,30 @@
+require 'hydra-head'
+require 'rails'
+require 'action_controller'
+require 'application_helper'
+
+module HydraHead
+  class Engine < Rails::Engine
+
+    # Config defaults
+    config.mount_at = '/'
+    
+    # Load rake tasks
+    rake_tasks do
+      Dir.glob(File.join(File.expand_path(File.dirname(__FILE__)),'railties', '*.rake')).each do |railtie|
+        load railtie
+      end
+    end
+    
+    # Check the gem config
+    initializer "check config" do |app|
+      # make sure mount_at ends with trailing slash
+      config.mount_at += '/'  unless config.mount_at.last == '/'
+    end
+    
+    initializer "static assets" do |app|
+      app.middleware.use ::ActionDispatch::Static, "#{root}/public"
+    end
+    
+  end
+end

data/lib/generators/hydra/head_generator.rb

@@ -0,0 +1,152 @@
+# -*- encoding : utf-8 -*-
+require 'rails/generators'
+require 'rails/generators/migration'     
+
+# require "generators/blacklight/blacklight_generator"
+
+module Hydra
+class HeadGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  
+  source_root File.expand_path('../templates', __FILE__)
+  
+  argument     :model_name, :type => :string , :default => "user"
+  
+    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/hydra_config.rb 
+    4. Creates config/initializers/fedora_config.rb 
+    5. Creates config/fedora.yml and config/solr.yml which you may need to modify to tell the hydra head where to find fedora & solr
+    6. Creates a number of role_map config files that are used in the placeholder user roles implementation 
+  Enjoy building your Hydra Head!
+         """
+  
+  #
+  # Config Files & Initializers
+  #
+         
+  # Copy all files in templates/config directory to host config
+  def create_configuration_files
+    # Initializers
+   copy_file "config/initializers/fedora_config.rb", "config/initializers/fedora_config.rb"
+   copy_file "config/initializers/hydra_config.rb", "config/initializers/hydra_config.rb"
+   copy_file "config/initializers/blacklight_config.rb", "config/initializers/blacklight_config.rb"
+
+   # Role Mappings
+   copy_file "config/role_map_cucumber.yml", "config/role_map_cucumber.yml"
+   copy_file "config/role_map_development.yml", "config/role_map_development.yml"
+   copy_file "config/role_map_production.yml", "config/role_map_production.yml"
+   copy_file "config/role_map_test.yml", "config/role_map_test.yml"
+   
+   # Solr Mappings
+   copy_file "config/solr_mappings.yml", "config/solr_mappings.yml"
+
+   # Fedora & Solr YAML files
+   copy_file "config/fedora.yml", "config/fedora.yml"
+   copy_file "config/solr.yml", "config/solr.yml"
+   
+   # Fedora & Solr Config files
+   directory "fedora_conf"
+   directory "solr_conf"
+   # directory "../../../../fedora_conf", "fedora_conf"
+   # directory "../../../../solr_conf", "solr_conf"
+  end
+  
+  # Register mimetypes required by hydra-head
+  def add_mime_types
+    puts "Updating Mime Types"
+    insert_into_file "config/initializers/mime_types.rb", :before => 'Mime::Type.register_alias "text/plain", :refworks_marc_txt' do <<EOF
+# Mime Types Added By Hydra Head:
+
+# Mime::Type.register "text/html", :html
+# Mime::Type.register "application/pdf", :pdf
+# Mime::Type.register "image/jpeg2000", :jp2
+Mime::Type.register_alias "text/html", :textile
+Mime::Type.register_alias "text/html", :inline
+
+EOF
+    end
+  end
+  
+  #
+  # Migrations
+  #
+  
+  # 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(dirname)
+    unless @previous_migration_nr
+      if ActiveRecord::Base.timestamped_migrations
+        @previous_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+      else
+        @previous_migration_nr = "%.3d" % (current_migration_number(dirname) + 1).to_i
+      end
+    else
+      @previous_migration_nr +=1 
+    end
+    @previous_migration_nr.to_s
+  end
+
+  # Add Hydra behaviors to the user model
+  def inject_hydra_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 Hydra behaviors. " +
+        "\n include Hydra::User\n"        
+      end
+    else
+      puts "     \e[31mFailure\e[0m  Hydra requires a user object in order to apply access controls. 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 hydra:head client" 
+    end    
+  end
+  
+  # Add Hydra behaviors and Filters to CatalogController
+  def inject_hydra_catalog_behavior
+    puts "Adding Hydra behaviors to CatalogController"
+    controller_name = "catalog_controller"
+    file_path = "app/controllers/#{controller_name.underscore}.rb"
+    if File.exists?(file_path) 
+      insert_into_file file_path, :after => 'include Blacklight::Catalog' do      
+        "\n  # Extend Blacklight::Catalog with Hydra behaviors (primarily editing)." +
+        "\n  include Hydra::Catalog\n"  +
+        "\n  # These before_filters apply the hydra access controls" +
+        "\n  before_filter :enforce_access_controls" +
+        "\n  before_filter :enforce_viewing_context_for_show_requests, :only=>:show" +
+        "\n  # This applies appropriate access controls to all solr queries" +  
+        "\n  CatalogController.solr_search_params_logic << :add_access_controls_to_solr_params"         
+      end
+    else
+      puts "     \e[31mFailure\e[0m  Could not find #{model_name.underscore}.rb.  To add Hydra behaviors to your Blacklight::Catalog Controllers, you must include the Hydra::Controller module in the Controller class definition.  See the Hydra::Controller section in the Hydra API Docs for more info." 
+    end    
+  end
+  
+  # Inject call to HydraHead.add_routes in config/routes.rb
+  def inject_hydra_routes
+    insert_into_file "config/routes.rb", :after => 'Blacklight.add_routes(self)' do
+      "\n  # Add Hydra routes.  For options, see API docs for HydraHead.routes"
+      "\n  HydraHead.add_routes(self)"
+    end
+  end
+  
+  # Add Hydra to the application controller
+  def inject_blacklight_controller_behavior    
+    inject_into_class "app/controllers/application_controller.rb", "ApplicationController" do
+      "  # Adds Hydra behaviors into the application controller \n " +        
+        "  include Hydra::Controller\n"
+    end
+  end
+  
+  def create_migration_file
+    migration_template 'migrations/add_user_attributes_table.rb', 'db/migrate/add_user_attributes_table.rb'
+    sleep 1 # ensure scripts have different time stamps
+    migration_template 'migrations/create_superusers.rb', 'db/migrate/create_superusers.rb'    
+  end
+         
+
+  
+
+  
+end # HeadGenerator
+end # Hydra

data/lib/generators/hydra/templates/config/fedora.yml

@@ -0,0 +1,17 @@
+development:
+  fedora:
+    url: http://fedoraAdmin:fedoraAdmin@127.0.0.1:8983/fedora
+  solr:
+    url: http://localhost:8983/solr/development
+test: &TEST  
+  fedora:
+    url: http://fedoraAdmin:fedoraAdmin@127.0.0.1:8983/fedora
+  solr:
+    url: http://localhost:8983/solr/test
+production:
+  fedora:
+    url: http://fedoraAdmin:fedoraAdmin@your.production.server:8080/fedora
+  solr:
+    url: http://your.production.server:8080/solr 
+cucumber:
+  <<: *TEST

data/lib/generators/hydra/templates/config/initializers/blacklight_config.rb

@@ -0,0 +1,246 @@
+# -*- encoding : utf-8 -*-
+# You can configure Blacklight from here. 
+#   
+#   Blacklight.configure(:environment) do |config| end
+#   
+# :shared (or leave it blank) is used by all environments. 
+# You can override a shared key by using that key in a particular
+# environment's configuration.
+# 
+# If you have no configuration beyond :shared for an environment, you
+# do not need to call configure() for that envirnoment.
+# 
+# For specific environments:
+# 
+#   Blacklight.configure(:test) {}
+#   Blacklight.configure(:development) {}
+#   Blacklight.configure(:production) {}
+# 
+
+Blacklight.configure(:shared) do |config|
+
+  config[:default_solr_params] = {
+    :qt => "search",
+    :per_page => 10 
+  }
+ 
+  # solr field values given special treatment in the show (single result) view
+  config[:show] = {
+    :html_title => "title_t",
+    :heading => "title_t",
+    :display_type => "has_model_s"
+  }
+
+  # solr fld values given special treatment in the index (search results) view
+  config[:index] = {
+    :show_link => "title_t",
+    :record_display_type => "id"
+  }
+
+  # solr fields that will be treated as facets by the blacklight application
+  #   The ordering of the field names is the order of the display
+  # TODO: Reorganize facet data structures supplied in config to make simpler
+  # for human reading/writing, kind of like search_fields. Eg,
+  # config[:facet] << {:field_name => "format", :label => "Format", :limit => 10}
+  config[:facet] = {
+    :field_names => (facet_fields = [
+      "format",
+      "pub_date",
+      "subject_topic_facet",
+      "language_facet",
+      "lc_1letter_facet",
+      "subject_geo_facet",
+      "subject_era_facet"
+    ]),
+    :labels => {
+      "format"              => "Format",
+      "pub_date"            => "Publication Year",
+      "subject_topic_facet" => "Topic",
+      "language_facet"      => "Language",
+      "lc_1letter_facet"    => "Call Number",
+      "subject_era_facet"   => "Era",
+      "subject_geo_facet"   => "Region"
+    },
+    # 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.     
+    :limits => {
+      "subject_topic_facet" => 20,
+      "language_facet" => true
+    }
+  }
+
+  # 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[:default_solr_params] ||= {}
+  config[:default_solr_params][:"facet.field"] = facet_fields
+
+  # solr fields to be displayed in the index (search results) view
+  #   The ordering of the field names is the order of the display 
+  config[:index_fields] = {
+    :field_names => [
+      "title_display",
+      "title_vern_display",
+      "author_display",
+      "author_vern_display",
+      "format",
+      "language_facet",
+      "published_display",
+      "published_vern_display",
+      "lc_callnum_display"
+    ],
+    :labels => {
+      "title_display"           => "Title:",
+      "title_vern_display"      => "Title:",
+      "author_display"          => "Author:",
+      "author_vern_display"     => "Author:",
+      "format"                  => "Format:",
+      "language_facet"          => "Language:",
+      "published_display"       => "Published:",
+      "published_vern_display"  => "Published:",
+      "lc_callnum_display"      => "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[:show_fields] = {
+    :field_names => [
+      "title_display",
+      "title_vern_display",
+      "subtitle_display",
+      "subtitle_vern_display",
+      "author_display",
+      "author_vern_display",
+      "format",
+      "url_fulltext_display",
+      "url_suppl_display",
+      "material_type_display",
+      "language_facet",
+      "published_display",
+      "published_vern_display",
+      "lc_callnum_display",
+      "isbn_t"
+    ],
+    :labels => {
+      "title_display"           => "Title:",
+      "title_vern_display"      => "Title:",
+      "subtitle_display"        => "Subtitle:",
+      "subtitle_vern_display"   => "Subtitle:",
+      "author_display"          => "Author:",
+      "author_vern_display"     => "Author:",
+      "format"                  => "Format:",
+      "url_fulltext_display"    => "URL:",
+      "url_suppl_display"       => "More Information:",
+      "material_type_display"   => "Physical description:",
+      "language_facet"          => "Language:",
+      "published_display"       => "Published:",
+      "published_vern_display"  => "Published:",
+      "lc_callnum_display"      => "Call number:",
+      "isbn_t"                  => "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. 
+  config[:search_fields] ||= []
+
+  # 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[:search_fields] << {
+    :key => "all_fields",  
+    :display_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[:search_fields] << {
+    :key => 'title',     
+    # solr_parameters hash are sent to Solr as ordinary url query params. 
+    :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
+    :solr_local_parameters => {
+      :qf => "$title_qf",
+      :pf => "$title_pf"
+    }
+  }
+  config[:search_fields] << {
+    :key =>'author',     
+    :solr_parameters => {
+      :"spellcheck.dictionary" => "author" 
+    },
+    :solr_local_parameters => {
+      :qf => "$author_qf",
+      :pf => "$author_pf"
+    }
+  }
+
+  # 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[:search_fields] << {
+    :key => 'subject', 
+    :qt=> 'search',
+    :solr_parameters => {
+      :"spellcheck.dictionary" => "subject"
+    },
+    :solr_local_parameters => {
+      :qf => "$subject_qf",
+      :pf => "$subject_pf"
+    }
+  }
+  
+  # "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).
+  # label is key, solr field is value
+  config[:sort_fields] ||= []
+  config[:sort_fields] << ['relevance', 'score desc, pub_date_sort desc, title_sort asc']
+  config[:sort_fields] << ['year', 'pub_date_sort desc, title_sort asc']
+  config[:sort_fields] << ['author', 'author_sort asc, title_sort asc']
+  config[:sort_fields] << ['title', 'title_sort asc, pub_date_sort desc']
+  
+  # If there are more than this many search results, no spelling ("did you 
+  # mean") suggestion is offered.
+  config[:spell_max] = 5
+
+  # Add documents to the list of object formats that are supported for all objects.
+  # This parameter is a hash, identical to the Blacklight::Solr::Document#export_formats 
+  # output; keys are format short-names that can be exported. Hash includes:
+  #    :content-type => mime-content-type
+  config[:unapi] = {
+    'oai_dc_xml' => { :content_type => 'text/xml' } 
+  }
+end
+