hydra-head 3.0.0pre1

data/lib/hydra/user.rb

@@ -0,0 +1,22 @@
+# Injects behaviors into User model so that it will work with Hydra Access Controls
+# By default, this module assumes you are using the User model created by Blacklight, which uses Devise.
+# To integrate your own User implementation into Hydra, override this Module or define your own User model in app/models/user.rb within your Hydra head.
+module Hydra::User
+  
+  def self.included(klass)
+    # Other modules to auto-include
+    klass.send(:include, Hydra::SuperuserAttributes)
+  end
+
+  # This method should display the unique identifier for this user
+  # the unique identifier is what access controls will be enforced against. 
+  def unique_id
+    return to_s
+  end
+
+  # For backwards compatibility with the Rails2 User models in Hydra/Blacklight
+  def login
+    return unique_id
+  end
+  
+end

data/lib/mediashelf/active_fedora_helper.rb

@@ -0,0 +1,72 @@
+# Stanford SolrHelper is a controller layer mixin. It is in the controller scope: request params, session etc.
+# 
+# NOTE: Be careful when creating variables here as they may be overriding something that already exists.
+# The ActionController docs: http://api.rubyonrails.org/classes/ActionController/Base.html
+#
+# Override these methods in your own controller for customizations:
+# 
+# class HomeController < ActionController::Base
+#   
+#   include Stanford::SolrHelper
+#   
+#   def solr_search_params
+#     super.merge :per_page=>10
+#   end
+#   
+# end
+#
+module MediaShelf
+  module ActiveFedoraHelper
+
+    def retrieve_af_model(class_name, opts={})
+      if !class_name.nil?
+        klass = Module.const_get(class_name.camelcase)
+      else
+        klass = nil
+      end
+      #klass.included_modules.include?(ActiveFedora::Model)  
+      if klass.is_a?(Class) && klass.superclass == ActiveFedora::Base
+        return klass
+      else
+        return opts.fetch(:default, false)
+      end
+      rescue NameError
+        return false
+    end
+
+    def load_af_instance_from_solr(doc)
+      pid = doc[:id] ? doc[:id] : doc[:id.to_s]
+      pid ? ActiveFedora::Base.load_instance_from_solr(pid,doc) : nil
+    end
+
+    private
+  
+    def require_fedora
+      Fedora::Repository.register(ActiveFedora.fedora_config[:url],  session[:user])
+      return true
+    end
+  
+    def require_solr
+      ActiveFedora::SolrService.register(ActiveFedora.solr_config[:url])
+    end
+    
+    #underscores are escaped w/ + signs, which are unescaped by rails to spaces
+    def unescape_keys(attrs)
+      h=Hash.new
+      attrs.each do |k,v|
+        h[k.gsub(/ /, '_')]=v
+
+      end
+      h
+    end
+    def escape_keys(attrs)
+      h=Hash.new
+      attrs.each do |k,v|
+        h[k.gsub(/_/, '+')]=v
+
+      end
+      h
+    end
+    
+  end
+end

data/lib/railties/all_tests.rake

@@ -0,0 +1,23 @@
+namespace :hyhead do
+  begin
+    require 'cucumber/rake/task'
+    require 'rspec/core'
+    require 'rspec/core/rake_task'
+
+    desc "Run HydraHead cucumber and rspec, with test solr"
+    task :all_tests => ['hyhead:spec:with_solr', 'hyhead:cucumber:with_solr']
+    
+    namespace :all_tests do
+      desc "Run HydraHead rspec and cucumber tests with rcov"
+      rm "hyhead-coverage.data" if File.exist?("hyhead-coverage.data")
+      task :rcov => ['hyhead:spec:rcov', 'hyhead:cucumber:rcov']
+    end
+    
+  rescue LoadError
+    desc "Not available! (cucumber and rspec not avail)"
+    task :all_tests do
+      abort 'Not available. Both cucumber and rspec need to be installed to run hyhead:all_tests'
+    end
+  end
+end
+

data/lib/railties/hydra-fixtures.rake

@@ -0,0 +1,184 @@
+# require File.expand_path(File.dirname(__FILE__) + '/hydra_jetty.rb')
+require "active-fedora"
+require "solrizer-fedora"
+require "active_support" # This is just to load ActiveSupport::CoreExtensions::String::Inflections
+require "hydra/fixtures"
+namespace :hydra do
+  
+  
+  desc "Delete and re-import the fixture identified by pid" 
+  task :refresh_fixture => :init do
+    # If a destination url has been provided, attampt to export from the fedora repository there.
+    if ENV["destination"]
+      Fedora::Repository.register(ENV["destination"])
+    end
+    if ENV["pid"].nil? 
+      raise "You must specify a valid pid.  Example: rake hydra:refresh_fixture pid=demo:12"
+    end
+    begin
+      Hydra::Fixtures.reload(ENV["pid"])
+    rescue Errno::ECONNREFUSED => e
+      puts "Can't connect to Fedora! Are you sure jetty is running?"
+    rescue Fedora::ServerError => e
+        logger.error("Received a Fedora error while deleting #{pid}")
+    end
+  end
+  
+  desc "Delete the object identified by pid. Example: rake hydra:delete pid=demo:12"
+  task :delete => :init do
+    # If a destination url has been provided, attampt to export from the fedora repository there.
+    if ENV["destination"]
+      Fedora::Repository.register(ENV["destination"])
+    end
+    
+    if ENV["pid"].nil? 
+      raise "You must specify a valid pid.  Example: rake hydra:delete pid=demo:12"
+    else
+      pid = ENV["pid"]
+      puts "Deleting '#{pid}' from #{Fedora::Repository.instance.fedora_url}"
+      begin
+        Hydra::Fixtures.delete(pid)
+      rescue Errno::ECONNREFUSED => e
+        puts "Can't connect to Fedora! Are you sure jetty is running?"
+      rescue Fedora::ServerError => e
+          logger.error("Received a Fedora error while deleting #{pid}")
+      end
+      logger.info "Deleted '#{pid}' from #{Fedora::Repository.instance.fedora_url}"
+    end
+  end
+  
+  desc "Delete a range of objects in a given namespace.  ie 'rake hydra:purge_range[demo, 22, 50]' will delete demo:22 through demo:50"
+  task :purge_range => :init do |t, args|
+    # If Fedora Repository connection is not already initialized, initialize it using ActiveFedora defaults
+    # ActiveFedora.init unless Thread.current[:repo]
+    
+    namespace = ENV["namespace"]
+    start_point = ENV["start"].to_i
+    stop_point = ENV["stop"].to_i
+    unless start_point < stop_point 
+      raise StandardError "start point must be less that end point."
+    end
+    puts "Deleting #{stop_point - start_point} objects from #{namespace}:#{start_point.to_s} to #{namespace}:#{stop_point.to_s}"
+    i = start_point
+    while i <= stop_point do
+      pid = namespace + ":" + i.to_s
+      begin
+        ActiveFedora::Base.load_instance(pid).delete
+      rescue ActiveFedora::ObjectNotFoundError
+        # The object has already been deleted (or was never created).  Do nothing.
+      end
+      puts "Deleted '#{pid}' from #{Fedora::Repository.instance.fedora_url}"
+      i += 1
+    end
+  end
+
+  namespace :fixtures do
+    desc "Refresh the fixtures applicable to this hydra head"
+    task :refresh => ["hydra:default_fixtures:refresh"] do
+    end
+  end
+  
+  desc "Export the object identified by pid into test_support/fixtures. Example:rake hydra:harvest_fixture pid=druid:sb733gr4073 source=http://fedoraAdmin:fedoraAdmin@127.0.0.1:8080/fedora"
+  task :harvest_fixture => :init do
+        
+    # If a source url has been provided, attampt to export from the fedora repository there.
+    if ENV["source"]
+      Fedora::Repository.register(ENV["source"])
+    end
+    
+    if ENV["pid"].nil? 
+      puts "You must specify a valid pid.  Example: rake hydra:harvest_fixture pid=demo:12"
+    else
+      pid = ENV["pid"]
+      puts "Exporting '#{pid}' from #{Fedora::Repository.instance.fedora_url}"
+      foxml = Fedora::Repository.instance.export(pid)
+      filename = File.join("test_support","fixtures","#{pid.gsub(":","_")}.foxml.xml")
+      file = File.new(filename,"w")
+      file.syswrite(foxml)
+      puts "The object has been saved as #{filename}"
+    end
+  end
+  
+  desc "Import the fixture located at the provided path. Example: rake hydra:import_fixture fixture=test_support/fixtures/demo_12.foxml.xml"
+  task :import_fixture => [:init, :environment] do
+    
+    # If a destination url has been provided, attampt to export from the fedora repository there.
+    if ENV["destination"]
+      Fedora::Repository.register(ENV["destination"])
+    end
+    if !ENV["fixture"].nil? 
+      body = Hydra::Fixtures.import_to_fedora(ENV["fixture"])
+    elsif !ENV["pid"].nil?
+      body = Hydra::Fixtures.import_and_index(ENV["pid"])
+    else
+      raise "You must specify a path to the fixture or provide its pid.  Example: rake hydra:import_fixture fixture=test_support/fixtures/demo_12.foxml.xml"
+    end
+    puts "The fixture has been ingested as #{body}"
+    
+  end
+  
+  desc "Init Hydra configuration" 
+  task :init do
+    if !ENV["environment"].nil? 
+      Rails.env = ENV["environment"]
+    end
+    # If Fedora Repository connection is not already initialized, initialize it using ActiveFedora defaults
+    ActiveFedora.init unless Thread.current[:repo]  
+  end
+
+  desc "Load hydra-head models"
+  task :load_models do
+    require "hydra"
+    Dir.glob(File.join(File.expand_path(File.dirname(__FILE__)), "..",'app','models', '*.rb')).each do |model|
+      load model
+    end
+  end
+
+  namespace :default_fixtures do
+
+    FIXTURES = [
+        "hydrangea:fixture_mods_article1",
+        "hydrangea:fixture_mods_article3",
+        "hydrangea:fixture_file_asset1",
+        "hydrangea:fixture_mods_article2",
+        "hydrangea:fixture_uploaded_svg1",
+        "hydrangea:fixture_archivist_only_mods_article",
+        "hydrangea:fixture_mods_dataset1",
+        "libra-oa:1", "libra-oa:2"
+    ]
+
+    desc "Load default Hydra fixtures"
+    task :load do
+      FIXTURES.each do |fixture|
+        ENV["fixture"] = nil
+        ENV["pid"] = fixture
+        Rake::Task["hydra:import_fixture"].reenable
+        Rake::Task["hydra:import_fixture"].invoke
+      end
+    end
+
+    desc "Remove default Hydra fixtures"
+    task :delete do
+      FIXTURES.each do |fixture|
+        ENV["fixture"] = nil
+        ENV["pid"] = fixture
+        Rake::Task["hydra:delete"].reenable
+        Rake::Task["hydra:delete"].invoke
+      end
+    end
+
+    desc "Refresh default Hydra fixtures"
+    task :refresh do
+      FIXTURES.each do |fixture|
+        logger.debug("Refreshing #{fixture}")
+        ENV["fixture"] = nil
+        ENV["pid"] = fixture        
+        Rake::Task["hydra:delete"].reenable
+        Rake::Task["hydra:delete"].invoke
+        Rake::Task["hydra:import_fixture"].reenable
+        Rake::Task["hydra:import_fixture"].invoke
+      end
+    end
+  end
+
+end

data/lib/railties/hydra_jetty.rake

@@ -0,0 +1,79 @@
+require "hydra/testing_server"
+
+# if you would like to see solr startup messages on STDERR
+# when starting solr test server during functional tests use:
+# 
+#    rake SOLR_CONSOLE=true
+JETTY_PARAMS = {
+  :quiet => ENV['HYDRA_CONSOLE'] ? false : true,
+  :jetty_home => ENV['HYDRA_JETTY_HOME'],
+  :jetty_port => 8983,
+  :solr_home => ENV['HYDRA_SOLR_HOME'],
+  :fedora_home => ENV['HYDRA_SOLR_HOME']
+}
+
+#:jetty_port => ENV['HYDRA_JETTY_PORT'],
+namespace :hydra do
+  namespace :jetty do
+    desc "Starts the bundled Hydra Testing Server"
+    task :start do
+      Hydra::TestingServer.configure(JETTY_PARAMS)
+      Hydra::TestingServer.instance.start
+    end
+    
+    desc "Stops the bundled Hydra Testing Server"
+    task :stop do
+      Hydra::TestingServer.instance.stop
+    end
+    
+    desc "Restarts the bundled Hydra Testing Server"
+    task :restart do
+      Hydra::TestingServer.instance.stop
+      Hydra::TestingServer.configure(JETTY_PARAMS)
+      Hydra::TestingServer.instance.start
+    end
+
+    desc "Copies the default Solr & Fedora configs into the bundled Hydra Testing Server"
+    task :config do
+      Rake::Task["hydra:jetty:config_fedora"].invoke
+      Rake::Task["hydra:jetty:config_solr"].invoke
+    end
+    
+    desc "Copies the default SOLR config for the bundled Hydra Testing Server"
+    task :config_solr do
+      FileList['solr_conf/conf/*'].each do |f|  
+        cp("#{f}", 'jetty/solr/development-core/conf/', :verbose => true)
+        cp("#{f}", 'jetty/solr/test-core/conf/', :verbose => true)
+    end
+
+    end
+
+    desc "Copies a custom fedora config for the bundled Hydra Testing Server"
+    task :config_fedora do
+      # load a custom fedora.fcfg - 
+      if defined?(Rails.root)
+        app_root = Rails.root
+      else
+        app_root = File.join(File.dirname(__FILE__),"..")
+      end
+       
+      fcfg = File.join(app_root,"fedora_conf","conf","fedora.fcfg")
+      puts "PWD:: #{FileUtils.pwd}"
+      if File.exists?(fcfg)
+        puts "copying over fedora.fcfg"
+        cp("#{fcfg}", 'jetty/fedora/default/server/config/', :verbose => true)
+      else
+        puts "#{fcfg} file not found -- skipping fedora config"
+      end
+    end
+
+    desc "Copies the default SOLR config files and starts up the fedora instance."
+    task :load => [:config, :start]
+
+    desc "Returns the status of the Hydra::TestingServer."
+    task :status do
+      status = Hydra::TestingServer.instance.pid ? "Running: #{Hydra::TestingServer.instance.pid}" : "Not running"
+      puts status
+    end
+  end
+end

data/lib/railties/hyhead_cucumber.rake

@@ -0,0 +1,127 @@
+# IMPORTANT: This file is generated by cucumber-rails - edit at your own peril.
+# It is recommended to regenerate this file in the future when you upgrade to a 
+# newer version of cucumber-rails. Consider adding your own code to a new file 
+# instead of editing this one. Cucumber will automatically load all features/**/*.rb
+# files.
+
+# Blacklight customization, trick Cucumber into looking in our current
+# location for Rails.root, even though we're going to give it features
+# from elsewhere. 
+ENV['RAILS_ROOT'] = Rails.root.to_s
+
+# hyhead_features, where to find features inside hyhead source?
+hyhead_features = File.expand_path("./test_support/features",HydraHead.root)
+
+unless ARGV.any? {|a| a =~ /^gems/} # Don't load anything when running the gems:* tasks
+
+vendored_cucumber_bin = Dir["#{Rails.root}/vendor/{gems,plugins}/cucumber*/bin/cucumber"].first
+$LOAD_PATH.unshift(File.dirname(vendored_cucumber_bin) + '/../lib') unless vendored_cucumber_bin.nil?
+
+begin
+  require 'cucumber/rake/task'
+
+  namespace :hyhead do
+    desc 'Alias for hyhead:cucumber:ok'
+    task :cucumber => 'hyhead:cucumber:ok'
+    namespace :cucumber do
+      Cucumber::Rake::Task.new({:ok => 'db:test:prepare'}, 'Run features that should pass') do |t|
+        # Blacklight customization, call features from external location, pass
+        # in feature location wtih cucumber_opts, yeah it's weird but that's how.
+        t.cucumber_opts = hyhead_features
+        
+        t.binary = vendored_cucumber_bin # If nil, the gem's binary is used.
+        t.fork = true # You may get faster startup if you set this to false
+        t.profile = 'default'
+      end
+
+      Cucumber::Rake::Task.new({:wip => 'db:test:prepare'}, 'Run features that are being worked on') do |t|
+        # Blacklight customization, call features from external location, pass
+        # in feature location wtih cucumber_opts, yeah it's weird but that's how.
+        t.cucumber_opts = hyhead_features
+        
+        
+        t.binary = vendored_cucumber_bin
+        t.fork = true # You may get faster startup if you set this to false
+        t.profile = 'wip'
+      end
+  
+      Cucumber::Rake::Task.new({:rerun => 'db:test:prepare'}, 'Record failing features and run only them if any exist') do |t|
+        # Blacklight customization, call features from external location, pass
+        # in feature location wtih cucumber_opts, yeah it's weird but that's how.
+        t.cucumber_opts = hyhead_features
+        
+        t.binary = vendored_cucumber_bin
+        t.fork = true # You may get faster startup if you set this to false
+        t.profile = 'rerun'
+      end
+
+      if (RUBY_VERSION.to_f < 1.9)  then      
+      Cucumber::Rake::Task.new({:rcov => 'db:test:prepare'}, 'Run features with rcov') do |t|
+        # Blacklight customization, call features from external location, pass
+        # in feature location wtih cucumber_opts, yeah it's weird but that's how.
+        t.cucumber_opts = hyhead_features
+      
+        
+        t.binary = vendored_cucumber_bin # If nil, the gem's binary is used.
+        t.fork = true # You may get faster startup if you set this to false
+        t.profile = 'default'
+        t.rcov = true
+        t.rcov_opts = %w{--rails --exclude osx\/objc,gems\/,spec\/,features\/ --aggregate hyhead-coverage.data}
+        t.rcov_opts << %[-o "#{HydraHead.root}/coverage"]
+      end
+      end	
+  
+      desc 'Run all features'
+      task :all => [:ok, :wip]
+      
+      
+      # Solr wrapper. for now just for hyhead:cucumber, plan to
+      # provide it for all variants eventually.
+      # if you would like to see solr startup messages on STDERR
+      # when starting solr test server during functional tests use:
+      # 
+      #    rake SOLR_CONSOLE=true
+      require File.expand_path('../jetty_solr_server.rb', __FILE__)
+      desc "hyhead:cucumber with jetty/solr launch"
+      task :with_solr do      
+        # wrap tests with a test-specific Solr server
+        # Need to look  up where the test jetty is located
+        # from solr.yml, we don't hardcode it anymore. 
+
+        solr_yml_path = locate_path("config", "solr.yml")
+        jetty_path = if ( File.exists?( solr_yml_path ))
+            solr_config = YAML::load(File.open(solr_yml_path))
+            solr_config["test"]["jetty_path"] if solr_config["test"]
+        end   
+        raise Exception.new("Can't find jetty path to start test jetty. Expect a jetty_path key in config/solr.yml for test environment.") unless jetty_path 
+        
+        JettySolrServer.new(
+          :jetty_home => File.expand_path(jetty_path, Rails.root), 
+          :sleep_after_start => 2).wrap do 
+            Rake::Task["hyhead:cucumber"].invoke 
+        end     
+      end      
+      
+    end
+    
+        
+  end
+
+
+  
+
+  task :features => :cucumber do
+    STDERR.puts "*** The 'features' task is deprecated. See rake -T cucumber ***"
+  end
+
+  # In case we don't have ActiveRecord, append a no-op task that we can depend upon.
+  task 'db:test:prepare' do
+  end
+rescue LoadError
+  desc 'cucumber rake task not available (cucumber not installed)'
+  task :cucumber do
+    abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
+  end
+end
+
+end