commonwealth-vlr-engine 0.0.1

data/lib/commonwealth-vlr-engine/notifier.rb

@@ -0,0 +1,33 @@
+module CommonwealthVlrEngine
+  module Notifier
+    extend ActiveSupport::Concern
+
+    def feedback(details)
+
+      @message = details[:message]
+      @topic = details[:topic]
+      @email = details[:email]
+      @name = details[:name]
+      @recipient = route_email(details[:topic])
+
+      mail(:to => @recipient,
+           :from => t('blacklight.email.record_mailer.name') + ' <' + t('blacklight.email.record_mailer.email') + '>',
+           :subject => t('blacklight.feedback.text.subject', identifier: Time.now.strftime('%s')))
+
+    end
+
+    private
+
+    def route_email(topic)
+      if topic == t('blacklight.feedback.form.topic.options.repro.option')
+        recipient_email = CONTACT_EMAILS['image_requests']
+      else
+        recipient_email = CONTACT_EMAILS['site_admin']
+      end
+      recipient_email
+    end
+
+
+
+  end
+end

data/lib/commonwealth-vlr-engine/pages.rb

@@ -0,0 +1,33 @@
+module CommonwealthVlrEngine
+  module Pages
+    extend ActiveSupport::Concern
+
+    def home
+      @carousel_slides = CarouselSlide.where(:context=>'root').order(:sequence)
+      section_active_count = 0
+      sections = ['maps', 'collections', 'institutions', 'formats']
+      sections.each do |section|
+        if t("blacklight.home.browse.#{section}.enabled")
+          section_active_count += 1
+        end
+      end
+
+      @middle_feature_columns = 12 / section_active_count
+
+      render 'pages/home'
+    end
+
+    def about
+      @nav_li_active = 'about'
+    end
+
+    def about_site
+      @nav_li_active = 'about'
+    end
+
+    def explore
+      @nav_li_active = 'explore'
+    end
+
+  end
+end

data/lib/commonwealth-vlr-engine/render_constraints_override.rb

@@ -0,0 +1,57 @@
+# Meant to be applied on top of Blacklight view helpers, to over-ride
+# certain methods from RenderConstraintsHelper,
+# to affect constraints rendering
+module CommonwealthVlrEngine
+  module RenderConstraintsOverride
+
+    # override so we can inspect for other params, like :mlt_id
+    def has_search_parameters?
+      has_mlt_parameters? || super
+      #!params[:q].blank? or !params[:f].blank? or !params[:search_field].blank? or params[:mlt_id] or !params[:coordinates].blank?
+    end
+
+    # return true if :mlt_id is present
+    def has_mlt_parameters?
+      !params[:mlt_id].blank?
+    end
+
+    # override to deal with A-Z link result display
+    def render_constraint_element(label, value, options = {})
+      if value.match(/ssort:[A-Z]+\*/)
+        label = t('blacklight.search.constraints.az_search')
+        value = value.match(/[A-Z]+/)[0]
+      end
+      super
+    end
+
+    # override to add method to show constraint for 'more like this' search
+    def render_constraints(localized_params = params)
+      render_mlt_query(localized_params) + super
+    end
+
+    # Render the 'more like this' query constraints
+    def render_mlt_query(localized_params = params)
+      # So simple don't need a view template, we can just do it here.
+      scope = localized_params.delete(:route_set) || self
+      return ''.html_safe if localized_params[:mlt_id].blank?
+
+      render_constraint_element(t('blacklight.more_like_this.constraint_label'),
+                                localized_params[:mlt_id],
+                                :classes => ['mlt'],
+                                :remove => scope.url_for(localized_params.merge(:mlt_id=>nil, :qt=>nil, :action=>'index')))
+    end
+
+    # include render_search_to_s_mlt() in rendered constraints
+    # Simpler textual version of constraints, used on Search History page.
+    def render_search_to_s(params)
+      render_search_to_s_mlt(params) + super
+    end
+
+    # render the MLT search query constraint, used on Search History page.
+    def render_search_to_s_mlt(params)
+      return "".html_safe if params[:mlt_id].blank?
+      render_search_to_s_element(t('blacklight.more_like_this.constraint_label'), render_filter_value(params[:mlt_id]) )
+    end
+
+  end
+end

data/lib/commonwealth-vlr-engine/route_sets.rb

@@ -0,0 +1,49 @@
+# monkey-patching Blacklight::Routes::RouteSets
+# to use 'search' as path with Blacklight::CatalogController routes
+# stopgap solution until patch can be submitted
+# that will allow local app to provide :path option for resources passed as
+# args to blacklight/lib/blacklight/rails/routes.rb#blacklight_for
+module CommonwealthVlrEngine
+  module RouteSets
+
+    extend ActiveSupport::Concern
+    included do
+
+      def map_resource(key)
+        add_routes do |options|
+          get "search/facet/:id", :to => "#{key}#facet", :as => "#{key}_facet"
+          get "search", :to => "#{key}#index", :as => "#{key}_index"
+        end
+      end
+
+      def export(primary_resource)
+        add_routes do |options|
+          get "search/opensearch", :to => "#{primary_resource}#opensearch", :as => "opensearch_#{primary_resource}"
+          get "search/citation", :to => "#{primary_resource}#citation", :as => "citation_#{primary_resource}"
+          match 'search/email', :to => "#{primary_resource}#email", :as => "email_#{primary_resource}", :via => [:get, :post]
+        end
+      end
+
+      def solr_document(primary_resource)
+        add_routes do |options|
+
+          args = {only: [:show]}
+          args[:constraints] = options[:constraints] if options[:constraints]
+
+          resources :solr_document, args.merge(path: "search", controller: primary_resource) do
+            member do
+              post "track"
+            end
+          end
+
+          # :show and :update are for backwards-compatibility with catalog_url named routes
+          resources primary_resource, args
+        end
+      end
+
+    end
+
+  end
+
+end
+Blacklight::Routes::RouteSets.send(:include, CommonwealthVlrEngine::RouteSets)

data/lib/commonwealth-vlr-engine/routes.rb

@@ -0,0 +1,21 @@
+module CommonwealthVlrEngine
+  module Routes
+
+    extend ActiveSupport::Concern
+    included do |klass|
+      klass.default_route_sets.unshift(:bookmark_item_actions)
+    end
+
+    # route bookmark items actions (cite, email, delete) to folder_items_actions
+    # this needs to be before BL bookmarks stuff, so we add it at the beginning of
+    # the default_route_sets array
+    def bookmark_item_actions(_)
+      add_routes do |options|
+        put 'bookmarks/item_actions', :to => 'folder_items_actions#folder_item_actions', :as => 'selected_bookmarks_actions'
+      end
+    end
+
+  end
+
+end
+Blacklight::Routes.send(:include, CommonwealthVlrEngine::Routes)

data/lib/commonwealth-vlr-engine/version.rb

@@ -0,0 +1,3 @@
+module CommonwealthVlrEngine
+  VERSION = "0.0.1"
+end

data/lib/generators/commonwealth_vlr_engine/controller_generator.rb

@@ -0,0 +1,92 @@
+require 'rails/generators'
+
+module CommonwealthVlrEngine
+  class ControllerGenerator < Rails::Generators::Base
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    argument     :controller_name  , type: :string , default: "catalog"
+
+    desc """
+  This generator makes the following changes to your application:
+   1. Injects behavior into your user application_controller.rb
+   2. Configures your catalog_controller.rb and removes many values.
+  Thank you for Installing Commonwealth VLR.
+         """
+
+    # Add Commonwealth to the application controller
+    def inject_application_controller_behavior
+      unless IO.read("app/controllers/application_controller.rb").include?('CommonwealthVlrEngine::Controller')
+        marker = 'include Blacklight::Controller'
+        insert_into_file "app/controllers/application_controller.rb", :after => marker do
+          %q{
+
+  # adds some site-wide behavior into the application controller
+  include CommonwealthVlrEngine::Controller
+  layout 'commonwealth-vlr-engine'
+}
+        end
+        remove_marker = "layout 'blacklight'"
+        gsub_file("app/controllers/application_controller.rb", remove_marker, "")
+
+      end
+    end
+
+    # Update the blacklight catalog controller
+    def inject_catalog_controller_behavior
+      unless IO.read("app/controllers/#{controller_name}_controller.rb").include?('CommonwealthVlrEngine')
+        marker = 'include Blacklight::Catalog'
+        insert_into_file "app/controllers/#{controller_name}_controller.rb", :after => marker do
+          %q{
+  # CatalogController-scope behavior and configuration for CommonwealthVlrEngine
+  include CommonwealthVlrEngine::ControllerOverride
+  CatalogController.search_params_logic += [:institution_limit]
+}
+        end
+
+        marker = 'configure_blacklight do |config|'
+        insert_into_file "app/controllers/#{controller_name}_controller.rb", :after => marker do
+          %q{
+    # SearchBuilder contains logic for adding search params to Solr
+    config.search_builder_class = SearchBuilder
+
+    # limit Advanced Search facets to this institution
+    # can't call SearchBuilder.institution_limit because it's an instance method, not a class method
+    config.advanced_search[:form_solr_parameters]['fq'] = '+institution_pid_ssi:"' + CommonwealthVlrEngine.config[:institution][:pid] + '"'
+}
+        end
+
+        #For config.default_solr_params
+        gsub_file("app/controllers/#{controller_name}_controller.rb", /config\.default_solr_params[\s\S]+?}/, "")
+
+        #For multi line fields
+        fields_to_remove = [/ +config.add_facet_field 'example_query_facet_field'[\s\S]+?}\n[ ]+}/,
+                                 / +config.add_search_field\([\s\S]+?end/
+        ]
+
+        fields_to_remove.each do |remove_marker|
+          #gsub_file("app/controllers/#{controller_name}_controller.rb", /#{comment_marker}/, "\##{comment_marker}")
+          gsub_file("app/controllers/#{controller_name}_controller.rb", /#{remove_marker}/, "")
+        end
+
+        #For single line fields
+        fields_to_remove = [/ +config.index.title_field +=.+?$\n*/,
+                                 / +config.index.display_type_field +=.+?$\n*/,
+                                 / +config.add_facet_field +'.+?$\n*/,
+                                 / +config.add_index_field +'.+?$\n*/,
+                                 / +config.add_show_field +'.+?$\n*/,
+                                 / +config.add_search_field +'.+?$\n*/,
+                                 / +config.add_sort_field +'.+?$\n*/
+        ]
+
+        fields_to_remove.each do |remove_marker|
+          #gsub_file("app/controllers/#{controller_name}_controller.rb", /#{comment_marker}/, "\##{comment_marker}")
+          gsub_file("app/controllers/#{controller_name}_controller.rb", /#{remove_marker}/, "")
+        end
+
+      end
+
+    end
+
+  end
+end

data/lib/generators/commonwealth_vlr_engine/environment_generator.rb

@@ -0,0 +1,49 @@
+require 'rails/generators'
+
+module CommonwealthVlrEngine
+  class EnvironmentGenerator < Rails::Generators::Base
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    desc """
+  This generator makes the following changes to your application:
+   1. Adds some settings for asset precompilation to config/initializers/assets.rb
+   2. Adds some settings for security and mailers to config/application.rb
+  Thank you for installing Commonwealth VLR.
+         """
+
+    # add settings to application.rb
+    def inject_application_settings
+      unless IO.read('config/application.rb').include?('config.action_mailer.delivery_method')
+        marker = 'class Application < Rails::Application'
+        insert_into_file 'config/application.rb', :after => marker do
+          %q{
+
+    # don't log passwords
+    config.filter_parameters += [:password]
+    # mailer settings
+    config.action_mailer.delivery_method = :sendmail
+    config.action_mailer.default_url_options = { :host => 'awesomelibrary.org' }
+}
+
+        end
+
+      end
+    end
+
+    # add settings to assets.rb
+    def inject_asset_settings
+      unless IO.read('config/initializers/assets.rb').match(/^[^#]*config.assets.precompile/)
+        marker = '# Precompile additional assets.'
+        insert_into_file 'config/initializers/assets.rb', :after => marker do
+          %q{
+Rails.application.config.assets.precompile += %w(wdl-viewer/fd-slider.min.css ie_fixes.css *.js)
+}
+
+        end
+
+      end
+    end
+
+  end
+end

data/lib/generators/commonwealth_vlr_engine/install_generator.rb

@@ -0,0 +1,57 @@
+require 'rails/generators'
+
+module CommonwealthVlrEngine
+  class InstallGenerator < Rails::Generators::Base
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    argument :search_builder_name, type: :string , default: "search_builder"
+    argument :document_name, type: :string , default: "solr_document"
+    argument :controller_name, type: :string , default: "catalog"
+
+    desc "InstallGenerator Commonwealth VLR Engine"
+
+    def verify_blacklight_installed
+      if !IO.read('app/controllers/application_controller.rb').include?('include Blacklight::Controller')
+         raise "It doesn't look like you have Blacklight installed..."
+      end
+    end
+
+    def insert_to_assets
+      generate 'commonwealth_vlr_engine:localassets'
+    end
+
+    def copy_yml_files
+      generate 'commonwealth_vlr_engine:yml'
+    end
+
+    def insert_to_controllers
+      generate 'commonwealth_vlr_engine:controller', controller_name
+    end
+
+    def insert_to_models
+      generate 'commonwealth_vlr_engine:model', search_builder_name, document_name
+    end
+
+    def add_vlr_initializers
+      template 'config/initializers/a_load_commonwealth_vlr_configs.rb'
+      template 'config/initializers/devise.rb'
+      template 'config/initializers/secret_token.rb'
+    end
+
+    def insert_to_routes
+      generate 'commonwealth_vlr_engine:routes'
+    end
+
+    def insert_to_environments
+      generate 'commonwealth_vlr_engine:environment'
+    end
+
+    def bundle_install
+      Bundler.with_clean_env do
+        run 'bundle install'
+      end
+    end
+
+  end
+end

data/lib/generators/commonwealth_vlr_engine/localassets_generator.rb

@@ -0,0 +1,29 @@
+require 'rails/generators'
+
+module CommonwealthVlrEngine
+  class LocalassetsGenerator < Rails::Generators::Base
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    desc "AssetsGenerator Commonwealth VLR Engine"
+
+    def assets
+      unless IO.read("app/assets/javascripts/application.js").include?('commonwealth-vlr-engine')
+        marker = '//= require_tree .'
+        insert_into_file "app/assets/javascripts/application.js", :before => marker do
+          %q{
+//
+// Required by Commonwealth-VLR-Engine
+//= require bootstrap/carousel
+//= require commonwealth-vlr-engine
+
+}
+        end
+      end
+
+      copy_file "commonwealth_vlr_engine.css.scss", "app/assets/stylesheets/commonwealth_vlr_engine.css.scss"
+
+    end
+
+  end
+end

data/lib/generators/commonwealth_vlr_engine/model_generator.rb

@@ -0,0 +1,65 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module CommonwealthVlrEngine
+  class ModelGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    argument     :search_builder_model, :type => :string , :default => "search_builder"
+    argument     :document_model_name, :type => :string , :default => "solr_document"
+
+    desc """
+  This generator makes the following changes to your application:
+   1. Injects the institution limiter into search_builder.rb
+   2. Adds OpenSeadragon suppoer to solr_document.rb
+  Thank you for Installing Commonwealth VLR.
+         """
+
+    # Limit the institutions
+    def inject_search_builder_behavior
+      unless IO.read("app/models/#{search_builder_model}.rb").include?('def institutions_filter')
+        marker = 'Blacklight::Solr::SearchBuilderBehavior'
+        insert_into_file "app/models/#{search_builder_model}.rb", :after => marker do
+          %q{
+
+  # limit to a specific institution
+  def institution_limit(solr_parameters = {})
+    solr_parameters[:fq] ||= []
+    solr_parameters[:fq] << '+institution_pid_ssi:"' + CommonwealthVlrEngine.config[:institution][:pid] + '"'
+  end
+}
+        end
+      end
+    end
+
+    # OpenSeadragon support?
+    def inject_solr_document_behavior
+      unless IO.read("app/models/#{document_model_name}.rb").include?('Blacklight::Gallery::OpenseadragonSolrDocument')
+        marker = 'include Blacklight::Solr::Document'
+        insert_into_file "app/models/#{document_model_name}.rb", :after => marker do
+          %q{
+
+  include Blacklight::Gallery::OpenseadragonSolrDocument
+}
+        end
+      end
+    end
+
+    # get the database migrations from the submodule
+    # https://github.com/boston-library/commonwealth-db-migrations.git
+    def get_migrations_submodule
+      Dir.chdir(File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..'))) do
+        `git submodule init`
+        `git submodule update`
+      end
+    end
+
+    # Setup the database migrations
+    def copy_migrations
+      rake 'railties:install:migrations'
+    end
+
+  end
+end