umlaut 3.3.1 → 4.0.0.beta1

data/db/orig_fixed_data/service_type_values.yml

@@ -1,25 +1,33 @@
+# display_name and display_name_plural are old deprecated; Rails i18n is now
+# used for display names. See service_type_values.rb.
+#
+# Which makes this file at present just a list of names and ids; if we had
+# to do it over, we'd do this differently. 
 fulltext:
   id: 1
-  display_name: Electronic Version
+  display_name: electronic_version
+  display_name_plural: electronic_versions
   
 holding:
   id: 2
   display_name: Copy in Library
-  display_name_plural: Copies in Library
+  display_name_plural: copies_in_library
   
 document_delivery:
   id: 3
   display_name: Request Service
+  display_name_plural: request_services
   
 help:
   id: 4
   display_name: Help Link
-  display_name_plural: Help Links
+  display_name_plural: help_links
 
 # Not currently used
 web_link:
   id: 5
   display_name: Web Result
+  display_name_plural: web_results
 
 # Not currently used. 
 relevant_link:
@@ -29,27 +37,29 @@ relevant_link:
 abstract:
   id: 11
   display_name: Abstract
-  display_name_plural: Abstracts
+  display_name_plural: abstracts
   
 table_of_contents:
   id: 12
   display_name: Table of Contents
-  display_name_plural: Tables of Contents
+  display_name_plural: tables_of_content
 
 cover_image:
   id: 13
   display_name: Cover Image
-  
+  display_name_plural: cover_images
+
 # "See also" links to known destinations, like Amazon or OCLC
 highlighted_link:
   id: 14
   display_name: See Also Link
+  display_name_plural: see_also_links
   
 # Link to search holdings, generally with a count given, ie "5 possible matches". 
 holding_search:
   id: 15
   display_name: Copy in Library
-  display_name_plural: Copies in Library
+  display_name_plural: copies_in_library
   
 # This is meant for 'fulltext' from such sources as the OPAC/ILS, where
 # it will always be a title-level link, and dates of coverage usually
@@ -111,6 +121,7 @@ similar_item:
 export_citation:
   id: 103
   display_name: Export tool
+  display_name_plural: export_tools
 
 primo_source:
   id: 104

data/lib/generators/templates/umlaut_services.yml

@@ -157,7 +157,7 @@ default:
         partner_id: YOUR_SCOPUS_PARTNER_ID
         link_salt_key: "YOUR_SCOPUS_LINK_SALT_KEY"
         
-      # Web of Knowledge API has no api key, but your
+      # Web of Science API has no api key, but your
       # IP needs to be registered with them. See source docs
       # for how. 
       IsiCitations:

data/lib/generators/umlaut/install_generator.rb

@@ -69,18 +69,6 @@ module Umlaut
 #  password:
 #  pool: 5
 #  encoding: utf8
-# 
-# UMLAUT: for Sfx4Solr functionality.  If you're not using SFX 4 indexed in 
-# Solr via Sunspot, feel free to ignore this.
-#sfx4_global:
-#  adapter: mysql2
-#  host: my_sfx_host.u.edu
-#  port: 3310 # 3310 is defualt SFX embedded mysql port
-#  database: sfxglb41 # or other sfx global db
-#  username:
-#  password:
-#  pool: 5
-#  encoding: utf8
 # 
           eos
         end

data/lib/generators/umlaut/remove_turbolinks_generator.rb

@@ -0,0 +1,14 @@
+require 'rails/generators'
+
+module Umlaut
+  class RemoveTurbolinks < Rails::Generators::Base
+
+    def remove_turbolinks_js_reference
+      gsub_file "app/assets/javascripts/application.js", /\/\/\= require ['"]?turbolinks['"]?\n?/, ''
+    end
+
+    def remove_turbolinks_gem
+      gsub_file "Gemfile", /( *\# Turbolinks.*\n)? *gem ['"]turbolinks['"].*\n/, '', :verbose => true
+    end
+  end
+end

data/lib/generators/umlaut_app_template.rb

@@ -0,0 +1,37 @@
+# An app template to set up a Rails app with umlaut, with required
+# configuration and generated content. 
+
+# ENV['UMLAUT_GEM_PATH'] can be used to add the line to Gemfile
+# with a path to local checkout of Umlaut. NOTE WELL the path
+# passed in ENV must be absolute path OR relative to the generated
+# app's gemfile (which is confusing). (We've already lost the actual
+# CWD by the the time the generator runs, so we can't correct to relative
+# to original command CWD)
+# 
+
+# Add the lib path from the copy of Umlaut we're in to the load path. 
+# Since we're an app template, our gem isn't loaded yet. 
+umlaut_lib = File.expand_path(File.dirname(__FILE__) + '/../')
+$LOAD_PATH.unshift(umlaut_lib) if File.directory?(umlaut_lib) && !$LOAD_PATH.include?(umlaut_lib)
+
+require 'umlaut/version'
+
+umlaut_version = Umlaut::VERSION.split(".")
+
+gem_spec_str = 
+  "\ngem 'umlaut', '>= #{Umlaut::VERSION}', '< #{umlaut_version.first.to_i + 1}'"
+if ENV["UMLAUT_GEM_PATH"]
+  path = File.expand_path( ENV["UMLAUT_GEM_PATH"] )
+  gem_spec_str += ", :path => '#{path}'"
+end
+
+
+append_file "Gemfile", gem_spec_str
+
+generate "umlaut:remove_turbolinks"
+
+generate "umlaut:install"
+  
+# future rails will offer an after_bundle hook we could use for
+# a post-install message. Instead, the post-install message for now
+# is in the `umlaut` command wrapper. 

data/lib/umlaut.rb

@@ -19,6 +19,35 @@ module Umlaut
       app.config.assets.precompile << 'umlaut/update_html.js'
       app.config.assets.precompile << "umlaut_ui.js"
     end
+
+    initializer "#{engine_name}.backtrace_cleaner" do |app|
+
+      engine_root_regex = Regexp.escape (self.root.to_s + File::SEPARATOR)
+
+      # Clean those ERB lines, we don't need the internal autogenerated
+      # ERB method, what we do need (line number in ERB file) is already there
+      Rails.backtrace_cleaner.add_filter do |line|
+        line.sub /(\.erb:\d+)\:in.*$/, "\\1"
+      end
+
+      # Remove our own engine's path prefix, even if it's 
+      # being used from a local path rather than the gem directory. 
+      Rails.backtrace_cleaner.add_filter do |line|
+        line.sub(/^#{engine_root_regex}/, "#{engine_name} ")
+      end
+
+      # Keep Umlaut's own stacktrace in the backtrace -- we have to remove Rails
+      # silencers and re-add them how we want. 
+      Rails.backtrace_cleaner.remove_silencers!
+
+      # Silence what Rails silenced, UNLESS it looks like
+      # it's from Umlaut engine
+      Rails.backtrace_cleaner.add_silencer do |line|
+        (line !~ Rails::BacktraceCleaner::APP_DIRS_PATTERN) &&
+        (line !~ /^#{engine_root_regex}/  ) &&
+        (line !~ /^#{engine_name} /)
+      end
+    end
     
     # Patch with fixed 'fair' version of ConnectionPool, see 
     # active_record_patch/connection_pool.rb

data/lib/umlaut/routes.rb

@@ -44,7 +44,7 @@ module Umlaut
       
       def permalinks
         add_routes do |options|
-          match 'go/:id' => 'store#index'
+          get 'go/:id' => 'store#index'
         end
       end
   
@@ -53,17 +53,17 @@ module Umlaut
       def a_z
         add_routes do |options|
           # Special one for alpha list
-          match 'journal_list(/:id(/:page))' => 'search#journal_list', :defaults => { :page => '1', :id => 'A' }
+          get 'journal_list(/:id(/:page))' => 'search#journal_list', :defaults => { :page => '1', :id => 'A' }
           
           
           # Catch redirected from SFX A-Z and citation linker urls
           # v2 A-Z links redirected to umlaut, point to journal_list
           # code in journal_list filter picks out SFX URL vars for
           # letter. 
-          match '/resolve/azlist/default' => 'search#journal_list', :page => 1, :id => 'A'
+          get '/resolve/azlist/default' => 'search#journal_list', :page => '1', :id => 'A'
           
           # SFX v3 A-Z list url format
-          match 'resolve/az' => 'search#journal_list', :page => 1, :id => 'A'          
+          get 'resolve/az' => 'search#journal_list', :page => '1', :id => 'A'
         end
       end
       
@@ -73,63 +73,59 @@ module Umlaut
         
       def resolve
         add_routes do |options|
+          # Prevent resolve/index/:id, should always be resolve/index?id=foo, 
+          # to keep OpenURLs good, and avoid errors with DOI's with slashes in em etc. 
+          get 'resolve(.:format)' => "resolve#index"
+
           # ResolveController still uses rails 2.0 style 'wildcard' routes, 
           # TODO tighten this up to only match what oughta be matched.           
-          # Note: This route will make all actions in this controller accessible via GET requests.
-          # We do make sure to prevent resolve/index/:id, should always be resolve/index?id=foo, 
-          # to keep OpenURLs good, and avoid errors with DOI's with slashes in em etc. 
-          match 'resolve(.:format)' => "resolve#index"
-          match 'resolve(/:action(/:id(.:format)))' => "resolve"
+          # Note: This route will make all actions in this controller accessible via GET requests.          
+          get 'resolve(/:action(/:id(.:format)))' => "resolve"
+
+          get 'resolve/get_permalink'
+          match 'resolve/display_coins', :via => [:get, :post]
+          get 'resolve/background_status'
+          get 'resolve/partial_html_sections'
+          get 'resolve/api'
         end
       end
       
       def open_search
         add_routes do |options|
-          # OpenSearchController still uses rails 2.0 style 'wildcard' routes, 
-          # TODO tighten this up to only match what oughta be matched.           
-          # Note: This route will make all actions in this controller accessible via GET requests.
-          
-          match 'open_search(/:action(/:id(.:format)))' => "open_search"
+          get 'open_search(/index)' => "open_search#index"
         end
       end
       
       def link_router
         add_routes do |options|
-          # LinkRouterController still uses rails 2.0 style 'wildcard' routes, 
-          # TODO tighten this up to only match what oughta be matched.           
-          # Note: This route will make all actions in this controller accessible via GET requests.
-          
-          match 'link_router(/:action(/:id(.:format)))' => "link_router"
+          get 'link_router(/index)' => "link_router#index"
         end
       end
       
       def export_email
         add_routes do |options|
-          # ExportEmailController still uses rails 2.0 style 'wildcard' routes, 
-          # TODO tighten this up to only match what oughta be matched.           
-          # Note: This route will make all actions in this controller accessible via GET requests.
-          
-          match 'export_email(/:action(/:id(.:format)))' => "export_email"
+          get  'export_email/email'      => "export_email#email"
+          post 'export_email/send_email' => "export_email#send_email"
+
+          get  'export_email/txt'      => "export_email#txt"
+          post 'export_email/send_txt'   => "export_email#send_txt"
         end
       end
       
       def resources
         add_routes do |options|
-          # ResourceController still uses rails 2.0 style 'wildcard' routes, 
-          # TODO tighten this up to only match what oughta be matched.           
-          # Note: This route will make all actions in this controller accessible via GET requests.
-          
-          match 'resource(/:action(/:id(.:format)))' => "resource"
+          get 'resource/proxy'
         end
       end
       
       def search
         add_routes do |options|
-          # SearchController still uses rails 2.0 style 'wildcard' routes, 
-          # TODO tighten this up to only match what oughta be matched.           
-          # Note: This route will make all actions in this controller accessible via GET requests.
-          
-          match 'search(/:action(/:id(.:format)))' => "search"
+          get 'search(/index)' => "search#index"
+          get 'search/journals'
+          get 'search/books'
+          get 'search/journal_search'
+          get 'search/journal_list', :to => redirect("/journal_list")
+          get 'search/auto_complete_for_journal_title'
         end
       end
       
@@ -140,15 +136,15 @@ module Umlaut
           # Intentionally non-fingerprinted, most efficient thing
           # we can do in this case is let the web server take care
           # of Last-modified-by etc headers. 
-          match 'javascripts/jquery/umlaut/update_html.js' => redirect("/assets/umlaut/update_html.js", :status => 301)
+          get 'javascripts/jquery/umlaut/update_html.js' => redirect("/assets/umlaut/update_html.js", :status => 301)
           
           # The loader doens't work _exactly_ like the new umlaut-ui.js, but
           # it's close enough that it'll work better redirecting than just
           # 404'ing. 
-          match 'js_helper/loader' => redirect("/assets/umlaut_ui.js")
+          get 'js_helper/loader' => redirect("/assets/umlaut_ui.js")
           
           
-          match 'images/spinner.gif' => redirect("/assets/spinner.gif")
+          get 'images/spinner.gif' => redirect("/assets/spinner.gif")
         end
       end
 
@@ -162,7 +158,7 @@ module Umlaut
       def admin
         add_routes do |options|
           namespace "admin" do
-            match 'service_errors(/:service_id)' => "service_errors#index"
+            get 'service_errors(/:service_id)' => "service_errors#index"
           end
         end
       end

data/lib/umlaut/version.rb

@@ -1,3 +1,8 @@
 module Umlaut
-  VERSION = "3.3.1"
+  VERSION = "4.0.0.beta1"
+
+  # This is used in Umlaut's .gemspec for generating the gem,
+  # and is also used in the umlaut app generator to make sure
+  # we're generating with a compatible Rails version. 
+  RAILS_COMPAT_SPEC = [">= 3.2.12", "< 4.2.0.beta1"]
 end

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

@@ -2,7 +2,7 @@
  // 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.
+// 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

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

@@ -16,8 +16,7 @@ require 'umlaut_configurable'
 # methods from Umlaut::ControllerBehavior if desired. Or add
 # additional helpers to over-ride Umlaut helpers if needed. 
 class UmlautController < ApplicationController
-    include Umlaut::ControllerBehavior
-        
+    include Umlaut::ControllerBehavior    
     # Some suggested configuration. More config keys
     # are available, see UmlautConfigurable.set_default_configuration!
     # implementation for list. Configuration actually uses
@@ -60,6 +59,9 @@ class UmlautController < ApplicationController
       # 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. 

data/test/dummy/config/application.rb

@@ -4,7 +4,6 @@ require 'rails/all'
 
 Bundler.require
 require "umlaut"
-require "sunspot_rails"
 
 require 'jquery-rails' # Oddly neccesary in our dummy app see http://www.ruby-forum.com/topic/2484569#1021529
 
@@ -43,6 +42,8 @@ module Dummy
 
     # 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/environments/development.rb

@@ -32,9 +32,7 @@ Dummy::Application.configure do
   # Expands the lines which load the assets
   config.assets.debug = true
   
-  # Raise exception on mass assignment protection for Active Record models
-  config.active_record.mass_assignment_sanitizer = :strict
- 
+  
   # 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,

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

@@ -6,6 +6,7 @@ Dummy::Application.configure do
   # 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
@@ -37,6 +38,5 @@ Dummy::Application.configure do
   # Print deprecation notices to the stderr
   config.active_support.deprecation = :stderr
   
-  # Raise exception on mass assignment protection for Active Record models
-  config.active_record.mass_assignment_sanitizer = :strict  
+  
 end

data/test/dummy/config/travis_database.yml

@@ -80,17 +80,3 @@ sfx_db:
   # If in doubt set :mock_instance => false
   mock_instance: true
 
-# This is used for SFX search testing.
-# DO NOT SET THIS FOR ANYTHING LIKE A REAL SFX DATABASE.
-sfx4_global:
-  adapter: <%= defined?(JRUBY_VERSION) ? "mysql" : "mysql2" %>
-  database: sfxglb41_test
-  username: root
-  password: 
-  pool: 5
-  encoding: utf8
-  # :mock_instance is used for SFX search testing.
-  # DO NOT SET :mock_instance TO TRUE FOR ANYTHING LIKE A REAL SFX DATABASE.
-  # If in doubt set :mock_instance => false
-  mock_instance: true
-