RubyGems - warclight - Versions diffs - 0.1.0 - Mend

warclight 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (88) hide show

checksums.yaml +7 -0
data/.eslintrc +12 -0
data/.gitignore +19 -0
data/.rspec +2 -0
data/.rubocop.yml +66 -0
data/.solr_wrapper +5 -0
data/.travis.yml +31 -0
data/CONTRIBUTING.md +53 -0
data/Gemfile +42 -0
data/LICENSE.txt +11 -0
data/README.md +79 -0
data/Rakefile +16 -0
data/app/assets/images/blacklight/compact.svg +25 -0
data/app/assets/images/blacklight/logo.png +0 -0
data/app/assets/javascripts/warclight/oembed_viewer.js +39 -0
data/app/assets/javascripts/warclight/warclight.js +4 -0
data/app/assets/stylesheets/warclight/application.scss +1 -0
data/app/assets/stylesheets/warclight/warclight.scss +1 -0
data/app/controllers/concerns/warclight/field_config_helpers.rb +11 -0
data/app/helpers/warclight/application_helper.rb +8 -0
data/app/jobs/warclight/application_job.rb +6 -0
data/app/models/concerns/warclight/catalog.rb +8 -0
data/app/models/concerns/warclight/search_behavior.rb +9 -0
data/app/models/concerns/warclight/solr_document.rb +9 -0
data/app/views/layouts/warclight/application.html.erb +14 -0
data/bin/rails +14 -0
data/config/routes.rb +4 -0
data/lib/generators/warclight/install_generator.rb +55 -0
data/lib/generators/warclight/templates/catalog_controller.rb +129 -0
data/lib/generators/warclight/templates/warclight.js +2 -0
data/lib/generators/warclight/templates/warclight.scss +3 -0
data/lib/generators/warclight/update_generator.rb +22 -0
data/lib/warclight.rb +7 -0
data/lib/warclight/engine.rb +105 -0
data/lib/warclight/version.rb +5 -0
data/package.json +24 -0
data/solr/conf/elevate.xml +42 -0
data/solr/conf/lang/contractions_ca.txt +8 -0
data/solr/conf/lang/contractions_fr.txt +15 -0
data/solr/conf/lang/contractions_ga.txt +5 -0
data/solr/conf/lang/contractions_it.txt +23 -0
data/solr/conf/lang/hyphenations_ga.txt +5 -0
data/solr/conf/lang/stemdict_nl.txt +6 -0
data/solr/conf/lang/stoptags_ja.txt +420 -0
data/solr/conf/lang/stopwords_ar.txt +125 -0
data/solr/conf/lang/stopwords_bg.txt +193 -0
data/solr/conf/lang/stopwords_ca.txt +220 -0
data/solr/conf/lang/stopwords_cz.txt +172 -0
data/solr/conf/lang/stopwords_da.txt +110 -0
data/solr/conf/lang/stopwords_de.txt +294 -0
data/solr/conf/lang/stopwords_el.txt +78 -0
data/solr/conf/lang/stopwords_en.txt +54 -0
data/solr/conf/lang/stopwords_es.txt +356 -0
data/solr/conf/lang/stopwords_eu.txt +99 -0
data/solr/conf/lang/stopwords_fa.txt +313 -0
data/solr/conf/lang/stopwords_fi.txt +97 -0
data/solr/conf/lang/stopwords_fr.txt +186 -0
data/solr/conf/lang/stopwords_ga.txt +110 -0
data/solr/conf/lang/stopwords_gl.txt +161 -0
data/solr/conf/lang/stopwords_hi.txt +235 -0
data/solr/conf/lang/stopwords_hu.txt +211 -0
data/solr/conf/lang/stopwords_hy.txt +46 -0
data/solr/conf/lang/stopwords_id.txt +359 -0
data/solr/conf/lang/stopwords_it.txt +303 -0
data/solr/conf/lang/stopwords_ja.txt +127 -0
data/solr/conf/lang/stopwords_lv.txt +172 -0
data/solr/conf/lang/stopwords_nl.txt +119 -0
data/solr/conf/lang/stopwords_no.txt +194 -0
data/solr/conf/lang/stopwords_pt.txt +253 -0
data/solr/conf/lang/stopwords_ro.txt +233 -0
data/solr/conf/lang/stopwords_ru.txt +243 -0
data/solr/conf/lang/stopwords_sv.txt +133 -0
data/solr/conf/lang/stopwords_th.txt +119 -0
data/solr/conf/lang/stopwords_tr.txt +212 -0
data/solr/conf/lang/userdict_ja.txt +29 -0
data/solr/conf/managed-schema +1045 -0
data/solr/conf/params.json +20 -0
data/solr/conf/protwords.txt +21 -0
data/solr/conf/schema.xml +350 -0
data/solr/conf/solrconfig.xml +1361 -0
data/solr/conf/stopwords.txt +14 -0
data/solr/conf/synonyms.txt +29 -0
data/tasks/warclight.rake +61 -0
data/template.rb +15 -0
data/vendor/assets/javascripts/responsiveTruncator.js +69 -0
data/vendor/assets/javascripts/stickyfill.js +480 -0
data/warclight.gemspec +38 -0
metadata +312 -0

data/app/controllers/concerns/warclight/field_config_helpers.rb ADDED Viewed

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+module Warclight
+  ##
+  # A module to add configuration helpers for certain fields used by Warclight
+  module FieldConfigHelpers
+    extend ActiveSupport::Concern
+    include ActionView::Helpers::OutputSafetyHelper
+    include ActionView::Helpers::TagHelper
+  end
+end

data/app/helpers/warclight/application_helper.rb ADDED Viewed

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+module Warclight
+  ##
+  # Helper for Warclight. This might disappear.
+  module ApplicationHelper
+  end
+end

data/app/jobs/warclight/application_job.rb ADDED Viewed

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module Warclight
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/models/concerns/warclight/catalog.rb ADDED Viewed

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+module Warclight
+  ##
+  # Warclight specific methods for the Catalog
+  module Catalog
+  end
+end

data/app/models/concerns/warclight/search_behavior.rb ADDED Viewed

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+module Warclight
+  ##
+  # Customized Search Behavior for Warclight
+  module SearchBehavior
+    extend ActiveSupport::Concern
+  end
+end

data/app/models/concerns/warclight/solr_document.rb ADDED Viewed

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+module Warclight
+  ##
+  # Extends Blacklight::Solr::Document to provide Warclight specific behavior
+  module SolrDocument
+    extend Blacklight::Solr::Document
+  end
+end

data/app/views/layouts/warclight/application.html.erb ADDED Viewed

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

data/bin/rails ADDED Viewed

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/warclight/engine', __FILE__)
+APP_PATH = File.expand_path('../../test/dummy/config/application', __FILE__)
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+require 'rails/all'
+require 'rails/engine/commands'

data/config/routes.rb ADDED Viewed

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+Warclight::Engine.routes.draw do
+end

data/lib/generators/warclight/install_generator.rb ADDED Viewed

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+require 'rails/generators'
+module Warclight
+  ##
+  # Warclight install generator
+  class Install < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+    def create_blacklight_catalog
+      remove_file 'app/controllers/catalog_controller.rb'
+      copy_file 'catalog_controller.rb', 'app/controllers/catalog_controller.rb'
+    end
+    def include_warclight_solrdocument
+      inject_into_file 'app/models/solr_document.rb', after: 'include Blacklight::Solr::Document' do
+        "\n include Warclight::SolrDocument"
+      end
+    end
+    def install_blacklight_range_limit
+      generate 'blacklight_range_limit:install'
+    end
+    def add_custom_routes
+      inject_into_file 'config/routes.rb', after: "mount Blacklight::Engine => '/'" do
+        "\n    mount Warclight::Engine => '/'\n"
+      end
+    end
+    def assets
+      copy_file 'warclight.scss', 'app/assets/stylesheets/warclight.scss'
+      copy_file 'warclight.js', 'app/assets/javascripts/warclight.js'
+      inject_into_file 'app/assets/javascripts/application.js', after: '//= require blacklight/blacklight' do
+        "\n//= require bootstrap/scrollspy\n" \
+        "\n//= require bootstrap/tab\n"
+      end
+    end
+    def add_warclight_search_behavior
+      inject_into_file 'app/models/search_builder.rb', after: 'include Blacklight::Solr::SearchBuilderBehavior' do
+        "\n  include Warclight::SearchBehavior"
+      end
+    end
+    def solr_config
+      directory '../../../../solr', 'solr', force: true
+    end
+    def modify_blacklight_yml
+      gsub_file 'config/locales/blacklight.en.yml', "application_name: 'Blacklight'", "application_name: 'Warclight'"
+    end
+  end
+end

data/lib/generators/warclight/templates/catalog_controller.rb ADDED Viewed

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+class CatalogController < ApplicationController
+  include Blacklight::Catalog
+  include Warclight::Catalog
+  configure_blacklight do |config|
+    ## Class for sending and receiving requests from a search index
+    # config.repository_class = Blacklight::Solr::Repository
+    #
+    ## Class for converting Blacklight's url parameters to into request parameters for the search index
+    # config.search_builder_class = ::SearchBuilder
+    #
+    ## Model that maps search index responses to the blacklight response model
+    # config.response_model = Blacklight::Solr::Response
+    ## Default parameters to send to solr for all search-like requests. See also SearchBuilder#processed_parameters
+    config.default_solr_params = {
+      rows: 10
+    }
+    # solr field configuration for search results/index views
+    config.index.title_field = 'title'
+    # solr fields that will be treated as facets by the blacklight application
+    # The ordering of the field names is the order of the display
+    #
+    # Setting a limit will trigger Blacklight's 'more' facet values link.
+    # * If left unset, then all facet values returned by solr will be displayed.
+    # * If set to an integer, then "f.somefield.facet.limit" will be added to
+    # solr request, with actual solr request being +1 your configured limit --
+    # you configure the number of items you actually want _displayed_ in a page.
+    # * If set to 'true', then no additional parameters will be sent to solr,
+    # but any 'sniffed' request limit parameters will be used for paging, with
+    # paging at requested limit -1. Can sniff from facet.limit or
+    # f.specific_field.facet.limit solr request params. This 'true' config
+    # can be used if you set limits in :default_solr_params, or as defaults
+    # on the solr side in the request handler itself. Request handler defaults
+    # sniffing requires solr requests to be made with "echoParams=all", for
+    # app code to actually have it echo'd back to see it.
+    #
+    # :show may be set to false if you don't want the facet to be drawn in the
+    # facet bar
+    #
+    # set :index_range to true if you want the facet pagination view to have
+    # facet prefix-based navigation (useful when user clicks "more" on a large
+    # facet and wants to navigate alphabetically across a large set of results)
+    # :index_range can be an array or range of prefixes that will be used to
+    # create the navigation (note: It is case sensitive when searching values)
+    config.add_facet_field 'content_type_norm', label: 'General Content Type', collapse: false
+    config.add_facet_field 'crawl_year', label: 'Crawl Year', collapse: false
+    config.add_facet_field 'public_suffix', label: 'Public Suffix', collapse: false
+    config.add_facet_field 'domain', label: 'Domain'
+    config.add_facet_field 'links_domains', label: 'Links Domains'
+    config.add_facet_field 'institution', label: 'Institution'
+    config.add_facet_field 'collection_name', label: 'Collection Name'
+    config.add_facet_field 'collection_number', label: 'Collection Number'
+    # Have BL send all facet field names to Solr, which has been the default
+    # previously. Simply remove these lines if you'd rather use Solr request
+    # handler defaults, or have no facets.
+    config.add_facet_fields_to_solr_request!
+    # solr fields to be displayed in the index (search results) view
+    #   The ordering of the field names is the order of the display
+    config.add_index_field 'title', label: 'Title'
+    config.add_index_field 'host', label: 'Host'
+    config.add_index_field 'crawl_date', label: 'Crawl Date'
+    config.add_index_field 'content_type', label: 'Content Type'
+    config.add_index_field 'domain', label: 'Domain'
+    config.add_index_field 'links_domains', label: 'This page links to'
+    config.add_index_field 'institution', label: 'Institution'
+    config.add_index_field 'collection_name', label: 'Collection Name'
+    config.add_index_field 'collection_number', label: 'Collection Number'
+    # solr fields to be displayed in the show (single result) view
+    #   The ordering of the field names is the order of the display
+    config.add_show_field 'title', label: 'Title'
+    config.add_show_field 'url', label: 'URL'
+    config.add_show_field 'host', label: 'Host'
+    config.add_show_field 'crawl_date', label: 'Crawl Date'
+    config.add_show_field 'source_file', label: 'Source File'
+    config.add_show_field 'content_type', label: 'Content Type'
+    config.add_show_field 'server', label: 'Server'
+    config.add_show_field 'content_type_served', label: 'Content Type Served'
+    config.add_show_field 'content_length', label: 'Length'
+    config.add_show_field 'links_hosts', label: 'Link Hosts'
+    config.add_show_field 'content', label: 'Content'
+    # "fielded" search configuration. Used by pulldown among other places.
+    # For supported keys in hash, see rdoc for Blacklight::SearchFields
+    #
+    # Search fields will inherit the :qt solr request handler from
+    # config[:default_solr_parameters], OR can specify a different one
+    # with a :qt key/value. Below examples inherit, except for subject
+    # that specifies the same :qt as default for our own internal
+    # testing purposes.
+    #
+    # The :key is what will be used to identify this BL search field internally,
+    # as well as in URLs -- so changing it after deployment may break bookmarked
+    # urls.  A display label will be automatically calculated from the :key,
+    # or can be specified manually to be different.
+    # This one uses all the defaults set by the solr request handler. Which
+    # solr request handler? The one set in config[:default_solr_parameters][:qt],
+    # since we aren't specifying it otherwise.
+    config.add_search_field 'all_fields', label: 'All Fields' do |field|
+      field.include_in_simple_select = true
+    end
+    # Field-based searches. We have registered handlers in the Solr configuration
+    # so we have Blacklight use the `qt` parameter to invoke them
+    # "sort results by" select (pulldown)
+    # label in pulldown is followed by the name of the SOLR field to sort by and
+    # whether the sort is ascending or descending (it must be asc or desc
+    # except in the relevancy case).
+    config.add_sort_field 'score desc', label: 'relevance'
+    # If there are more than this many search results, no spelling ("did you
+    # mean") suggestion is offered.
+    config.spell_max = 5
+    # Configuration for autocomplete suggestor
+    config.autocomplete_enabled = true
+    config.autocomplete_path = 'suggest'
+  end
+end

data/lib/generators/warclight/templates/warclight.js ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ //= require warclight/warclight
2	+ //= require stickyfill

data/lib/generators/warclight/templates/warclight.scss ADDED Viewed

@@ -0,0 +1,3 @@
+/*
+*= require warclight/application
+*/

data/lib/generators/warclight/update_generator.rb ADDED Viewed

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require 'generators/warclight/install_generator'
+module Warclight
+  ##
+  # Warclight Update generator. This subclasses the Install generator, so this is
+  # intended to override behavior in the install generator that can allow the
+  # downstream application to choose if they want to take our changes or not and
+  # can choose to see a diff of our changes to help them decide.
+  class Update < Warclight::Install
+    source_root File.expand_path('../templates', __FILE__)
+    def create_blacklight_catalog
+      copy_file 'catalog_controller.rb', 'app/controllers/catalog_controller.rb'
+    end
+    def solr_config
+      directory '../../../../solr', 'solr'
+    end
+  end
+end

data/lib/warclight.rb ADDED Viewed

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require 'warclight/engine'
+module Warclight
+  # Your code goes here...
+end

data/lib/warclight/engine.rb ADDED Viewed

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+require 'blacklight'
+module Warclight
+  ##
+  # This is the defining class for the Warclight Rails Engine
+  class Engine < ::Rails::Engine
+    Warclight::Engine.config.catalog_controller_field_accessors = %i[
+      access_terms
+      author
+      category
+      collection
+      collection_name
+      collection_number
+      collections
+      comments
+      content
+      content_encoding
+      content_ffb
+      content_first_bytes
+      content_language
+      content_length
+      content_metadata
+      content_metadata_ss
+      content_text_length
+      content_type
+      content_type_droid
+      content_type_ext
+      content_type_full
+      content_type_norm
+      content_type_served
+      content_type_tika
+      content_type_version
+      crawl_date
+      crawl_dates
+      crawl_year
+      crawl_year_month
+      crawl_year_month_day
+      crawl_years
+      description
+      domain
+      elements_used
+      generator
+      hash
+      hashes
+      host
+      host_surt
+      id_long
+      image_colours
+      image_dominant_colour
+      image_faces
+      image_faces_count
+      image_height
+      image_size
+      image_width
+      institution
+      keywords
+      last_modified
+      last_modified_year
+      license_url
+      links
+      links_domains
+      links_hosts
+      links_hosts_surts
+      links_norm
+      links_public_suffixes
+      locations
+      parse_error
+      pdf_pdfa_errors
+      pdf_pdfa_is_valid
+      postcode
+      postcode_district
+      public_suffix
+      publication_date
+      publication_year
+      record_type
+      referrer_url
+      resourcename
+      sentiment
+      sentiment_score
+      server
+      source_file
+      source_file_offset
+      status_code
+      subject
+      text
+      title
+      type
+      url
+      url_norm
+      url_path
+      url_type
+      wayback_date
+      wct_agency
+      wct_collections
+      wct_description
+      wct_instance_id
+      wct_subjects
+      wct_target_id
+      wct_title
+      xml_root_ns
+    ]
+  end
+end

data/lib/warclight/version.rb ADDED Viewed

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+module Warclight
+  VERSION = '0.1.0'
+end

data/package.json ADDED Viewed

@@ -0,0 +1,24 @@
+{
+  "name": "warclight",
+  "description": "",
+  "main": "index.js",
+  "dependencies": {},
+  "devDependencies": {
+    "eslint": "^3.19.0",
+    "eslint-config-airbnb-base": "^11.1.3",
+    "eslint-plugin-import": "^2.2.0"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/archivesunleashed/warclight.git"
+  },
+  "author": "",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/archivesunleashed/warclight/issues"
+  },
+  "homepage": "https://github.com/archivesunleashed/warclight#readme"
+}