umlaut 4.0.0.beta3 → 4.0.0.beta4

data/test/README.md

@@ -1,75 +0,0 @@
-#Testing Umlaut
-
-Testing coverage in Umlaut is not yet comprehensive, but is continually improving.  
-There is more about this topic on the [Umlaut Wiki](https://github.com/team-umlaut/umlaut/wiki/Developing)
-
-##Testing Principles
-
-When writing tests for Umlaut, there are a few things you should keep in mind.
-
-### Dummy app
-
-We used rails 3.1 `rails plugin new` generator to create a gem plugin skeleton for Umlaut. 
-One thing this did was create a `./test/dummy` dummy app in umlaut source. 
-This is meant for running tests against. Tests you write in `/test/*` will run against the dummy app. 
-The dummy app can have configuration customized (with those changes committed) if needed to exercise certain features 
-(although changing config 'live' and temporarily in a test itself would be preferable where feasible). 
-The dummy app doesn't have a `database.yml`, you'll need to add one pointing at a local mysql 
-(not sqlite3, umlaut won't work against sqlite3). 
-
-### Test::Unit/Minitest please
-
-Please use straight Test::Unit and/or Minitest.  Please do not use rspec, cucumber, etc. Put tests in `./test`.  There's already a `rake test` to run all tests.
-
-### Tests should pass locally for everyone
-
-Tests should pass for everyone with a straight umlaut checkout without modifying any files but adding a database.yml. 
-
-Please don't add tests that raise or fail without a private API key or access to a private server. 
-We've started to use the [VCR](https://github.com/myronmarston/vcr) gem to record HTTP responses to provide deterministic testing results.
-VCR "cassettes" are committed to the repo in `./test/vcr_cassettes/<module>`.
-To run VCR tests, you can leverage the `TestWithCassette` support module following the example below.
-
-    class GoogleBookSearchTest < ActiveSupport::TestCase  
-      extend TestWithCassette
-
-      # Use VCR to provide a deterministic GBS search. 
-      test_with_cassette("frankenstein by OCLC number", :google_book_search) do
-        hashified_response = @gbs_default.do_query('OCLC2364071', requests(:frankenstein))
-        assert_not_nil hashified_response
-        assert_not_nil hashified_response["totalItems"]
-        assert_operator hashified_response["totalItems"], :>, 0 
-      end
-    end
-    
-We still want to figure out a way for someone with access to the necessary third party platforms to 
-choose to run against 'live' too (for only specified services?) 
-(and then commit the new versions of the responses back to repo if they want). 
-There's some stuff to figure out, yeah.
-
-If you really must write tests that require private api keys or access to private servers to pass, 
-then I guess that's better than no tests at all, but figure out a way to:
-
-* Clearly document where the developer should put those private api keys or local server URLs to get tests to pass. 
-* Keep from interfering with running the rest of the test suite for a developer who does not have that private information filled out. 
-  Ideally tests that require it would output a clear 'skipped' or 'pending' message 
-  (explaining what needs to be configured to run them_ rather than failing.)
-  **In no cases should they raise exceptions in such a way that prevents the rest of the test suite from continuing.**
-
-### Test should pass on Travis, too
-
-[Travis](http://travis-ci.org) is a continuous integration service for the open source community that Umlaut leverages to run tests.
-One reason to use Test::Unit/Minitest is that [Travis](https://travis-ci.org/#!/team-umlaut/umlaut) will automatically run your tests.
-
-Travis creates the necessary MySQL databases and runs tests against the dummy app based on the database configuration in
-`./test/dummy/config/travis_database.yml`.
-
-One specific test Travis runs is for SFX search functionality.  
-Travis uses the configuration in `./test/dummy/config/travis_database.yml` to create a mock instance of an 
-SFX global and local database, migrates the SFX database schema and the test populates the database with 
-deterministic SFX Object and AZ Title fixtures.  
-It tests basic search functionality and serves as a sanity check to make sure SFX searching is working as expected.
-This test make @jrochkind very nervous, and **you probably shouldn't ever run this test locally**.  The migrations and test code
-only run in the case that the SFX database configuration is specified as a 'mock instance' in order to prevent overwriting
-a real SFX database. (Yet another reason the Umlaut user that queries SFX should only have read permissions.)
-

data/test/dummy/Rakefile

@@ -1,7 +0,0 @@
-#!/usr/bin/env rake
-# Add your own tasks in files placed in lib/tasks ending in .rake,
-# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
-
-require File.expand_path('../config/application', __FILE__)
-
-Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -1,13 +0,0 @@
-
- // Umlaut javascript required for proper functionality. The 'umlaut' file
- // also forces require of jquery and jquery-ui, dependencies. 
- //= require 'umlaut'          
-// This is a manifest file that'll be compiled into including all the files listed below.
-// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
-// be included in the compiled file accessible from http://example.com/assets/application.js
-// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-// the compiled file.
-//
-//= require jquery
-//= require jquery_ujs
-//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -1,15 +0,0 @@
-/* 
- * The base Umlaut styles:
- *= require 'umlaut'         
-          
- * This is a manifest file that'll automatically include all the stylesheets available in this directory
- * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
- * the top of the compiled file, but it's generally better to create a new file per style scope.
- *= require_self
- *= require_tree . 
-*/
-          
-  /* Umlaut needs a jquery-ui theme CSS. Here's an easy way to get one,
-     you can replace with another theme. */
-  @import url(http://ajax.googleapis.com/ajax/libs/jqueryui/1.8.16/themes/ui-lightness/jquery-ui.css);
-          

data/test/dummy/app/controllers/application_controller.rb

@@ -1,3 +0,0 @@
-class ApplicationController < ActionController::Base
-  protect_from_forgery
-end

data/test/dummy/app/controllers/umlaut_controller.rb

@@ -1,114 +0,0 @@
-require 'umlaut'
-require 'umlaut_configurable'
-
-# Superclass for all Umlaut controllers, to hold default behavior,
-# also hold global configuration. It's a superclass rather than a module,
-# so we can use Rails 3 hieararchical superclass view lookup too if we want,
-# for general umlaut views. And also so local app can over-ride
-# methods here once, and have it apply to all Umlaut controllers.
-# But there's not much magic in here or anything, the
-# common behavior is ordinary methods available to be called, mostly. 
-#
-# This class is copied into the local app -- the default implementation
-# does nothing but 'include Umlaut::ControllerBehavior'
-#
-# You will ordinarily set config here, and can also over-ride
-# methods from Umlaut::ControllerBehavior if desired. Or add
-# additional helpers to over-ride Umlaut helpers if needed. 
-class UmlautController < ApplicationController
-    include Umlaut::ControllerBehavior    
-    # Some suggested configuration. More config keys
-    # are available, see UmlautConfigurable.set_default_configuration!
-    # implementation for list. Configuration actually uses
-    # a Confstruct object. 
-    
-    umlaut_config.configure do 
-      # app_name 'Find It'
-      
-      # URL to image to use for link resolver in some self-links, 
-      # OR name of image asset in local app. 
-      #link_img_url "http//something"
-      
-      # Sometimes Umlaut sends out email, what email addr should it be from?
-      # from_email_addr 'no_reply@umlaut.example.com'
-      
-      # Local layout for UmlautController's, instead of
-      # built in 'umlaut' layout?
-      # layout "application"
-      
-      # A help url used on error page and a few other places.
-      # help_url  "http://www.library.jhu.edu/services/askalib/index.html"
-
-      # If OpenURL came from manual entry of title/ISSN, and no match is found in
-      # link resolver knowledge base, display a warning to the user of potential
-      # typo?
-      # entry_not_in_kb_warning true
-      
-      # rfr_ids used for umlaut generated pages.
-      # rfr_ids do
-      #   opensearch  "info:sid/umlaut.code4lib.org:opensearch"
-      #  citation    "info:sid/umlaut.code4lib.org:citation"
-      #   azlist      'info:sid/umlaut.code4lib.org:azlist'
-      # end
-      
-      # Referent filters. Sort of like SFX source parsers.
-      # hash, key is regexp to match a sid, value is filter object
-      # (see lib/referent_filters )        
-      # add_referent_filters!( :match => /.*/, :filter => DissertationCatch.new ) 
-    
-      # How many seconds between updates of the background updater for background
-      # services?
-      # poll_wait_seconds 4
-
-      # uncomment this line to show localisation selector
-      show_localization_selector true
-      
-      # Configuration for the 'search' functions -- A-Z lookup
-      # and citation entry. 
-      search do
-        # Is your SFX database connection, defined in database.yml under
-        # sfx_db and used for A-Z searches, Sfx4 or do you want to use Sfx4Solr?  
-        # Other SearchMethods in addition to SFX direct db may be provided later. 
-        #az_search_method  SearchMethods::Sfx4
-        #az_search_method  SearchMethods::Sfx4Solr::Local
-        
-        # When talking directly to the SFX A-Z list database, you may
-        # need to set this, if you have multiple A-Z profiles configured
-        # and don't want to use the 'default.
-        # sfx_az_profile "default"    
-                
-        # can set to "_blank" etc. 
-        # result_link_target nil        
-      end
-      
-      # config only relevant to SFX use  
-      sfx do      
-        # base sfx url to use for search actions, error condition backup,
-        # and some other purposes. For search actions (A-Z), direct database
-        # connection to your SFX db also needs to be defined in database.yml
-        # sfx_base_url  'http://sfx.library.jhu.edu:8000/jhu_sfx?'
-        # 
-  
-        
-        
-        # Umlaut tries to figure out from the SFX knowledge base
-        # which hosts are "SFX controlled", to avoid duplicating SFX
-        # urls with urls from catalog. But sometimes it misses some, or
-        # alternate hostnames for some. Regexps matching against
-        # urls can be included here. Eg,
-        # AppConfig::Base.additional_sfx_controlled_urls = [
-        #    %r{^http://([^\.]\.)*pubmedcentral\.com}
-        #  ]    
-        # additional_sfx_controlled_urls = []
-        
-        
-      end
-      
-      # Advanced topic, you can declaratively configure
-      # what sections of the resolve page are output where
-      # and how using resolve_sections and add_resolve_sections!            
-      
-    end
-    
-    
-end

data/test/dummy/app/helpers/application_helper.rb

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

data/test/dummy/app/views/layouts/application.html.erb

@@ -1,14 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>Dummy</title>
-  <%= stylesheet_link_tag    "application" %>
-  <%= javascript_include_tag "application" %>
-  <%= csrf_meta_tags %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
-</html>

data/test/dummy/config.ru

@@ -1,4 +0,0 @@
-# This file is used by Rack-based servers to start the application.
-
-require ::File.expand_path('../config/environment',  __FILE__)
-run Dummy::Application

data/test/dummy/config/application.rb

@@ -1,49 +0,0 @@
-require File.expand_path('../boot', __FILE__)
-
-require 'rails/all'
-
-Bundler.require
-require "umlaut"
-
-require 'jquery-rails' # Oddly neccesary in our dummy app see http://www.ruby-forum.com/topic/2484569#1021529
-
-module Dummy
-  class Application < Rails::Application
-    # Settings in config/environments/* take precedence over those specified here.
-    # Application configuration should go into files in config/initializers
-    # -- all .rb files in that directory are automatically loaded.
-
-    # Custom directories with classes and modules you want to be autoloadable.
-    # config.autoload_paths += %W(#{config.root}/extras)
-
-    # Only load the plugins named here, in the order given (default is alphabetical).
-    # :all can be used as a placeholder for all plugins not explicitly named.
-    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
-
-    # Activate observers that should always be running.
-    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
-
-    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
-    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
-    # config.time_zone = 'Central Time (US & Canada)'
-
-    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
-    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
-    # config.i18n.default_locale = :de
-
-    # Configure the default encoding used in templates for Ruby 1.9.
-    config.encoding = "utf-8"
-
-    # Configure sensitive parameters which will be filtered from the log file.
-    config.filter_parameters += [:password]
-
-    # Enable the asset pipeline
-    config.assets.enabled = true
-
-    # Version of your assets, change this if you want to expire all your assets
-    config.assets.version = '1.0'
-
-    config.secret_key_base = "adfadf"
-  end
-end
-

data/test/dummy/config/boot.rb

@@ -1,10 +0,0 @@
-require 'rubygems'
-gemfile = File.expand_path('../../../../Gemfile', __FILE__)
-
-if File.exist?(gemfile)
-  ENV['BUNDLE_GEMFILE'] = gemfile
-  require 'bundler'
-  Bundler.setup
-end
-
-$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/environment.rb

@@ -1,5 +0,0 @@
-# Load the rails application
-require File.expand_path('../application', __FILE__)
-
-# Initialize the rails application
-Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -1,41 +0,0 @@
-Dummy::Application.configure do
-  # Settings specified here will take precedence over those in config/application.rb
-
-  # In the development environment your application's code is reloaded on
-  # every request.  This slows down response time but is perfect for development
-  # since you don't have to restart the web server when you make code changes.
-  #
-  # UMLAUT: Umlaut's use of threading is not compatible with class
-  # reloading, even in development. Umlaut requires true here.
-  # Rails 3.2 _might_ let you get away with false when it comes out.
-  config.cache_classes = true
-
-  # Log error messages when you accidentally call methods on nil.
-  config.whiny_nils = true
-
-  # Show full error reports and disable caching
-  config.consider_all_requests_local       = true
-  config.action_controller.perform_caching = false
-
-  # Don't care if the mailer can't send
-  config.action_mailer.raise_delivery_errors = false
-
-  # Print deprecation notices to the Rails logger
-  config.active_support.deprecation = :log
-
-  # Only use best-standards-support built into browsers
-  config.action_dispatch.best_standards_support = :builtin
-
-  # Do not compress assets
-  config.assets.compress = false
-
-  # Expands the lines which load the assets
-  config.assets.debug = true
-  
-  
-  # Log the query plan for queries taking more than this (works
-  # with SQLite, MySQL, and PostgreSQL)
-  # This seems to not work right in multi-threaded AR use as we're doing,
-  # leave off, at least for now. 
-  #config.active_record.auto_explain_threshold_in_seconds = 0.5
-end

data/test/dummy/config/environments/production.rb

@@ -1,60 +0,0 @@
-Dummy::Application.configure do
-  # Settings specified here will take precedence over those in config/application.rb
-
-  # Code is not reloaded between requests
-  config.cache_classes = true
-
-  # Full error reports are disabled and caching is turned on
-  config.consider_all_requests_local       = false
-  config.action_controller.perform_caching = true
-
-  # Disable Rails's static asset server (Apache or nginx will already do this)
-  config.serve_static_assets = false
-
-  # Compress JavaScripts and CSS
-  config.assets.compress = true
-
-  # Don't fallback to assets pipeline if a precompiled asset is missed
-  config.assets.compile = false
-
-  # Generate digests for assets URLs
-  config.assets.digest = true
-
-  # Defaults to Rails.root.join("public/assets")
-  # config.assets.manifest = YOUR_PATH
-
-  # Specifies the header that your server uses for sending files
-  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
-  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
-
-  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
-  # config.force_ssl = true
-
-  # See everything in the log (default is :info)
-  # config.log_level = :debug
-
-  # Use a different logger for distributed setups
-  # config.logger = SyslogLogger.new
-
-  # Use a different cache store in production
-  # config.cache_store = :mem_cache_store
-
-  # Enable serving of images, stylesheets, and JavaScripts from an asset server
-  # config.action_controller.asset_host = "http://assets.example.com"
-
-  # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)
-  # config.assets.precompile += %w( search.js )
-
-  # Disable delivery errors, bad email addresses will be ignored
-  # config.action_mailer.raise_delivery_errors = false
-
-  # Enable threaded mode
-  # config.threadsafe!
-
-  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
-  # the I18n.default_locale when a translation can not be found)
-  config.i18n.fallbacks = true
-
-  # Send deprecation notices to registered listeners
-  config.active_support.deprecation = :notify
-end

data/test/dummy/config/environments/test.rb

@@ -1,42 +0,0 @@
-Dummy::Application.configure do
-  # Settings specified here will take precedence over those in config/application.rb
-
-  # The test environment is used exclusively to run your application's
-  # test suite.  You never need to work with it otherwise.  Remember that
-  # your test database is "scratch space" for the test suite and is wiped
-  # and recreated between test runs.  Don't rely on the data there!
-  config.cache_classes = true
-  config.eager_load = false
-
-  # Configure static asset server for tests with Cache-Control for performance
-  config.serve_static_assets = true
-  config.static_cache_control = "public, max-age=3600"
-
-  # Log error messages when you accidentally call methods on nil
-  config.whiny_nils = true
-
-  # Show full error reports and disable caching
-  config.consider_all_requests_local       = true
-  config.action_controller.perform_caching = false
-
-  # Raise exceptions instead of rendering exception templates
-  config.action_dispatch.show_exceptions = false
-
-  # Disable request forgery protection in test environment
-  config.action_controller.allow_forgery_protection    = false
-
-  # Tell Action Mailer not to deliver emails to the real world.
-  # The :test delivery method accumulates sent emails in the
-  # ActionMailer::Base.deliveries array.
-  config.action_mailer.delivery_method = :test
-
-  # Use SQL instead of Active Record's schema dumper when creating the test database.
-  # This is necessary if your schema can't be completely dumped by the schema dumper,
-  # like if you have constraints or database-specific column types
-  # config.active_record.schema_format = :sql
-
-  # Print deprecation notices to the stderr
-  config.active_support.deprecation = :stderr
-  
-  
-end