hydra-head 4.1.3 → 5.0.0.pre1

data/hydra-head.gemspec

@@ -1,41 +0,0 @@
-# -*- 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.2.3' 
-  s.add_dependency "blacklight", '~>3.4'  
-  s.add_dependency "devise"
-  s.add_dependency "active-fedora", '~>4.1'
-  s.add_dependency 'RedCloth', '=4.2.9'
-  s.add_dependency 'block_helpers'
-  s.add_dependency 'sanitize'
-  s.add_dependency 'hydra-mods', ">= 0.0.5"
-  s.add_dependency 'deprecation', ">= 0.0.5"
-  s.add_dependency 'jquery-rails'
-  s.add_dependency 'hydra-access-controls', ">= 0.0.5"
-  
-  s.add_development_dependency 'sqlite3'
-  s.add_development_dependency 'yard'
-  s.add_development_dependency 'jettywrapper', ">=1.3.0"
-  s.add_development_dependency 'rspec-rails'
-  s.add_development_dependency 'mocha'
-  s.add_development_dependency 'cucumber-rails', '>=1.2.0'
-  s.add_development_dependency 'factory_girl', "~> 2.6.0"
-  s.add_development_dependency 'solrizer-fedora', '>=2.1.0'
-
-
-  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/init.rb

@@ -1,4 +0,0 @@
-# Include hook code here
-require "hydra"
-require "hydra-head"
-Hydra.extend Blacklight::Configurable  # not sure why this isn't being executed in lib/hydra.rb

data/install.rb

@@ -1 +0,0 @@
-# Install hook code here

data/lib/application_helper.rb

@@ -1,3 +0,0 @@
-# Needed for testing
-module ApplicationHelper
-end

data/lib/generators/hydra/assets_generator.rb

@@ -1,50 +0,0 @@
-# -*- encoding : utf-8 -*-
-# Copy Blacklight assets to public folder in current app. 
-# If you want to do this on application startup, you can
-# add this next line to your one of your environment files --
-# generally you'd only want to do this in 'development', and can
-# add it to environments/development.rb:
-#       require File.join(Hydra.root, "lib", "generators", "hydra", "assets_generator.rb")
-#       Hydra::Assets.start(["--force", "--quiet"])
-
-
-# Need the requires here so we can call the generator from environment.rb
-# as suggested above. 
-require 'rails/generators'
-require 'rails/generators/base'
-module Hydra
-  class AssetsGenerator < Rails::Generators::Base
-    source_root File.expand_path('../templates', __FILE__)
-  
-    def assets
-      if use_asset_pipeline?
-        insert_into_file "app/assets/stylesheets/application.css", :after => " *= require_self" do
-%q{
- *
- * Required by Hydra
- *= require 'hydra/styles'         
-}
-        end
-
-        insert_into_file "app/assets/javascripts/application.js", :after => "//= require jquery_ujs" do
-%q{
-// Required by Hydra
-//= require 'jquery.ui.datepicker.js'      
-}          
-        end
-        directory("../../../../app/assets/images/blacklight", "public/images/blacklight")
-      else
-        # directories are relative to the source_root 
-        directory("../../../../assets/images", "public/images")
-        directory("../../../../assets/stylesheets", "public/stylesheets") 
-        directory("../../../../assets/javascripts", "public/javascripts") 
-      end
-    end
-
-    private
-    def use_asset_pipeline?
-      (Rails::VERSION::MAJOR >= 3 and Rails::VERSION::MINOR >= 1) and Rails.application.config.assets.enabled
-    end
-    
-  end
-end

data/lib/generators/hydra/cucumber_support_generator.rb

@@ -1,29 +0,0 @@
-# -*- encoding : utf-8 -*-
-require 'rails/generators'
-require 'rails/generators/migration'     
-
-module Hydra
-class CucumberSupportGenerator < Rails::Generators::Base
-  
-  source_root File.expand_path('../../../../test_support/features', __FILE__)
-  
-  argument :features_dir, :type => :string , :default => "features"
-        
-  desc """
-  This Generator copies Hydra's cucumber step definitions and paths into your application's features directory.
-  We have plans to provide the step definitions directly through the hydra-head gem without requiring this step of copying the files.
-  In the meantime, you need to copy the files in order to use them. 
-  
-  Defaults to assuming that your cucumber features live in a directory called \"features\".  To pass in an alternative path to your features directory,
-  
-  rails generate hydra:cucumber_support test_support/features
-  
-  """
-  
-  def copy_cucumber_support
-    directory("step_definitions", "#{features_dir}/step_definitions")
-    copy_file("support/paths.rb", "#{features_dir}/support/paths.rb")
-  end
-  
-end
-end

data/lib/generators/hydra/head_generator.rb

@@ -1,165 +0,0 @@
-# -*- encoding : utf-8 -*-
-require 'rails/generators'
-require 'rails/generators/migration'     
-
-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 a database migration for superusers 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/fedora.yml and config/solr.yml which you may need to modify to tell the hydra head where to find fedora & solr
-    5. 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
-    #CatalogController
-    copy_file "catalog_controller.rb", "app/controllers/catalog_controller.rb"
-
-    # Initializers
-    copy_file "config/initializers/hydra_config.rb", "config/initializers/hydra_config.rb"
-    copy_file "config/initializers/action_dispatch_http_upload_monkey_patch.rb", "config/initializers/action_dispatch_http_upload_monkey_patch.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"
-  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
-  
-  #
-  # Static Assets
-  #
-  # Call external generator in AssetsGenerator, which copies static assets like stylesheets, javascript and images 
-  # into the app's public directory
-  def copy_public_assets 
-    generate "hydra:assets"
-  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 @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
-
-  # 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 #{file_path}, which does not exist.  If you used a different name, please re-run the generator 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::Controller::CatalogControllerBehavior\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" +  
-        "\n  # This filters out objects that you want to exclude from search results, like FileAssets" +  
-        "\n  CatalogController.solr_search_params_logic << :exclude_unwanted_models" 
-
-      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::ControllerBehavior module in the Controller class definition.  See the Hydra::Controller::ControllerBehavior 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_hydra_controller_behavior    
-    puts "Adding Hydra behaviors to ApplicationController"
-    controller_name = "ApplicationController"
-    file_path = "app/controllers/#{controller_name.underscore}.rb"
-    if File.exists?(file_path) 
-      insert_into_file file_path, :after => 'include Blacklight::Controller' do 
-        "  \n# Adds Hydra behaviors into the application controller \n" +        
-        "  include Hydra::Controller::ControllerBehavior\n" +
-        "  def layout_name\n" +
-        "   'hydra-head'\n" +
-        "  end\n"     
-      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::ControllerBehavior module in the Controller class definition.  See the Hydra::Controller::ControllerBehavior section in the Hydra API Docs for more info." 
-    end
-  end
-  
-  def create_migration_file
-    migration_template 'migrations/create_superusers.rb', 'db/migrate/create_superusers.rb'    
-  end
-         
-
-  
-
-  
-end # HeadGenerator
-end # Hydra

data/lib/generators/hydra/hyhead_fixtures_generator.rb

@@ -1,27 +0,0 @@
-# -*- encoding : utf-8 -*-
-require 'rails/generators'
-require 'rails/generators/migration'
-
-module Hydra
-class HyheadFixturesGenerator < Rails::Generators::Base
-
-  source_root File.expand_path('../../../../', __FILE__)
-
-  desc """
-  This Generator copies the hydra-head sample/test objects into your application's test_support/fixtures directory
-  These objects are useful for getting a sense of how hydra works, but you will want to delete them and create your own
-  fixtures to run your application's tests against.
-
-  After running this generator, you can import your fixtures into fedora & solr by running
-
-  rake hydra:fixtures:refresh
-  rake hydra:fixtures:refresh RAILS_ENV=test
-
-  """
-
-  def copy_hyhead_fixtures
-    directory("test_support/fixtures", "spec/fixtures")
-  end
-
-end
-end

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

@@ -1,162 +0,0 @@
-# -*- encoding : utf-8 -*-
-require 'blacklight/catalog'
-
-class CatalogController < ApplicationController  
-
-  include Blacklight::Catalog
-
-  configure_blacklight do |config|
-    config.default_solr_params = { 
-      :qt => 'search',
-      :rows => 10 
-    }
-
-    # solr field configuration for search results/index views
-    config.index.show_link = 'title_t'
-    config.index.record_display_type = 'has_model_s'
-
-    # solr field configuration for document/show views
-    config.show.html_title = 'title_t'
-    config.show.heading = 'title_t'
-    config.show.display_type = 'has_model_s'
-
-    # 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 'object_type_facet', :label => 'Format' 
-    config.add_facet_field 'pub_date', :label => 'Publication Year' 
-    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'  
-
-    # 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[:'facet.field'] = config.facet_fields.keys
-    #use this instead if you don't want to query facets marked :show=>false
-    #config.default_solr_params[:'facet.field'] = config.facet_fields.select{ |k, v| v[:show] != false}.keys
-
-
-    # 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