umlaut_journal_tocs 0.0.1

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

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

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

@@ -0,0 +1,136 @@
+require 'umlaut'
+
+# 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"
+
+      # string used in standard layout footer to identify your app.
+      # mark it html_safe if it includes html
+      # footer_credit "Find It service provided by <a href='http://www.university.edu/'>My University</a>".html_safe
+
+
+      # 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
+
+      # uncomment this line to show localization (language) selector
+      # in default umlaut layout header. 
+      # show_localization_selector 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 )
+
+      # Turn off permalink-generation? If you don't want it at all, or
+      # don't want it temporarily because you are pointing at a database
+      # that won't last.
+      # create_permalinks false
+
+      # How many seconds between updates of the background updater for background
+      # services?
+      # poll_wait_seconds 4
+
+      # 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
+
+        # On 0 hits from search screen, ordinarily we redirect to resolve
+        # screen becuase Resolve might be able to provide other useful
+        # services such as ILL or backed by other KB's. But to instead
+        # display a "no results" page, set:
+        # display_zero_hit_results true
+      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,
+        # additional_sfx_controlled_urls  [
+        #    %r{^http://([^\.]\.)*pubmedcentral\.com}
+        #  ]
+        # additional_sfx_controlled_urls []
+
+
+      end
+
+      # You can use Umlaut's built-in feedback form if you want
+      # See https://github.com/team-umlaut/umlaut/wiki/Umlaut's-Feedback-Form
+      # feedback do
+      #    main_library {:email_address => "dummy@example.org", :label => "Main Library"}
+      # 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!
+
+      resolve_sections.insert_section UmlautJournalTocs.resolve_section_definition
+
+    end
+end

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

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

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

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/test/dummy/config.ru

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

data/test/dummy/config/application.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "umlaut_journal_tocs"
+
+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.
+
+    # 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
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,60 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+#
+# UMLAUT: mysql db with mysql2 adapter strongly recommended for Umlaut, in both 
+# production and development. sqlite3 has unclear semantics under threaded 
+# concurrency which umlaut uses, and in many cases simply does not work. 
+#
+# A higher pool size than ordinary is recommended because of umlaut's
+# use of concurrency. Perhaps as large as the number of services
+# you have configured to run in the same wave, plus another few. 
+#
+# development:
+#   adapter: mysql2
+#   host: 
+#   username:
+#   password:
+#   database:
+#   pool: 15 
+
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3
+          
+#
+# UMLAUT: for the 'search' functions (A-Z title lookup) to work, you need
+# a direct database connection to the SFX database, under 'sfx_db' key. 
+# You should manually set up a new read-only MySQL account in the SFX db
+# for this purpose, rather than use one of the full-access existing SFX
+# mysql accounts. 
+#
+#sfx_db:
+#  adapter: mysql2
+#  host: my_sfx_host.u.edu
+#  port: 3310 # 3310 is defualt SFX embedded mysql port
+#  database: sfxlcl41 # or other sfx instance db
+#  username:
+#  password:
+#  pool: 5
+#  encoding: utf8
+# 

data/test/dummy/config/environment.rb

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

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

@@ -0,0 +1,45 @@
+Rails.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.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  #
+  # UMLAUT: Umlaut's use of threading makes Rails dev-mode class reloading tricky
+  # It seems to be be mostly okay with cache_classes=false AND eager_load=true
+  # but beware of editing files while background requests are running. 
+  config.eager_load = 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
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end

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

@@ -0,0 +1,83 @@
+Rails.application.configure do
+  # Umlaut generated this, because Umlaut does some colorized
+  # logging, and Rails really ought to default to false in production.
+  config.colorize_logging = false
+
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both threaded web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like
+  # NGINX, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable serving static files from the `/public` folder by default since
+  # Apache or NGINX already handles this.
+  config.serve_static_files = ENV['RAILS_SERVE_STATIC_FILES'].present?
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+
+  # `config.assets.precompile` and `config.assets.version` have moved to config/initializers/assets.rb
+
+  # 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
+
+  # Use the lowest log level to ensure availability of diagnostic information
+  # when problems arise.
+  config.log_level = :debug
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(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'
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation cannot be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+
+  # Do not dump schema after migrations.
+  config.active_record.dump_schema_after_migration = false
+end