arclight 0.2.0 → 1.6.2

data/lib/arclight/traject/nokogiri_namespaceless_reader.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Arclight
+  module Traject
+    # Provides a Traject Reader for XML Documents which removes the namespaces
+    class NokogiriNamespacelessReader < ::Traject::NokogiriReader
+      # Overrides the #each method (which is used for iterating through each Document)
+      # @param args
+      # @see ::Traject::NokogiriReader#each
+      # @see Enumerable#each
+      def each(*args)
+        return to_enum(:each, *args) unless block_given?
+
+        super do |doc|
+          new_doc = doc.dup
+          new_doc.remove_namespaces!
+          yield new_doc
+        end
+      end
+    end
+  end
+end

data/lib/arclight/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Arclight
-  VERSION = '0.2.0'
+  VERSION = '1.6.2'
 end

data/lib/arclight/year_range.rb

@@ -18,19 +18,20 @@ module Arclight
     def initialize(dates = nil)
       @years = []
       self << parse_ranges(dates) if dates.present?
-      self
     end
 
     # @return [String] a concise, human-readable version of the year range, including gaps
     def to_s
       return if years.empty?
       return to_s_for_streak(years) unless gaps?
+
       to_s_with_gaps
     end
 
     # @param [Array<Integer>] `other` the set of years to add
     def <<(other)
       return self if other.blank?
+
       @years |= other # will remove duplicates
       @years.sort!
       self
@@ -40,10 +41,12 @@ module Arclight
     # @return [Array<Integer>] the set of years in the given range
     def parse_range(dates)
       return if dates.blank?
+
       start_year, end_year = dates.split('/').map { |date| to_year_from_iso8601(date) }
       return [start_year] if end_year.blank?
       raise ArgumentError, "Range is too large: #{dates}" if (end_year - start_year) > 1000
       raise ArgumentError, "Range is inverted: #{dates}" unless start_year <= end_year
+
       (start_year..end_year).to_a
     end
 
@@ -57,12 +60,14 @@ module Arclight
     #                        YYYY, YYYY-MM, YYYY-MM-DD, and YYYYMMDD
     def to_year_from_iso8601(date)
       return if date.blank?
+
       date.split('-').first[0..3].to_i # Time.parse doesn't work here
     end
 
     # @return [Boolean] are there gaps between the years, such as 1999, 2000, 2002?
     def gaps?
       return false if years.blank?
+
       (years.min..years.max).to_a != years
     end
 
@@ -71,12 +76,14 @@ module Arclight
     # Deals with making a human-readable range for years with 1 or more gaps.
     # It involves detection of streaks between the gaps.
     # @return [String] 1999-2000, 2002 for 1999, 2000, 2002
-    def to_s_with_gaps # rubocop: disable Metrics/AbcSize, Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def to_s_with_gaps
       raise ArgumentError if years.blank? || years.length < 2
+
       results = []
       streak = [years[0]]
       i = streak.first
-      years[1..-1].each do |j|
+      years[1..].each do |j|
         i += 1
         if i == j
           streak << j
@@ -93,10 +100,12 @@ module Arclight
       results << to_s_for_streak(streak)
       results.join(', ')
     end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
     def to_s_for_streak(streak)
       return streak.min.to_s if streak.min == streak.max
-      [streak.min, streak.max].map(&:to_s).join('-')
+
+      streak.minmax.map(&:to_s).join('-')
     end
   end
 end

data/lib/arclight.rb

@@ -5,6 +5,11 @@ require 'arclight/engine'
 require 'arclight/repository'
 require 'arclight/year_range'
 
+# :nodoc:
 module Arclight
-  # Your code goes here...
+  autoload :Routes, 'arclight/routes'
+
+  def self.deprecation
+    @deprecation ||= ActiveSupport::Deprecation.new('2.0', 'Arclight')
+  end
 end

data/lib/generators/arclight/install_generator.rb

@@ -5,8 +5,10 @@ require 'rails/generators'
 module Arclight
   ##
   # Arclight install generator
-  class Install < Rails::Generators::Base
-    source_root File.expand_path('../templates', __FILE__)
+  class Install < Rails::Generators::Base # rubocop:disable Metrics/ClassLength
+    source_root File.expand_path('templates', __dir__)
+
+    class_option :test, type: :boolean, default: false, aliases: '-t', desc: 'Indicates that app will be installed in a test environment'
 
     def create_blacklight_catalog
       remove_file 'app/controllers/catalog_controller.rb'
@@ -22,7 +24,7 @@ module Arclight
     def install_blacklight_locale_picker
       gem 'blacklight-locale_picker'
 
-      Bundler.with_clean_env do
+      Bundler.with_unbundled_env do
         run 'bundle install'
       end
 
@@ -33,19 +35,39 @@ module Arclight
       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 Arclight::Engine => '/'\n"
+        "\n  mount Arclight::Engine => '/'\n"
       end
+
+      gsub_file 'config/routes.rb', 'root to: "catalog#index"', 'root to: "arclight/repositories#index"'
     end
 
-    def assets
+    def add_frontend
+      if ENV['CI']
+        run "yarn add file:#{Arclight::Engine.root}"
+      elsif options[:test]
+        run 'yarn link arclight'
+
+      # If a branch was specified (e.g. you are running a template.rb build
+      # against a test branch), use the latest version available on npm
+      elsif ENV['BRANCH']
+        run 'yarn add arclight@latest'
+
+      # Otherwise, pick the version from npm that matches the Arclight
+      # gem version
+      else
+        run "yarn add arclight@#{arclight_yarn_version}"
+      end
+    end
+
+    def add_stylesheets
       copy_file 'arclight.scss', 'app/assets/stylesheets/arclight.scss'
-      copy_file 'arclight.js', 'app/assets/javascripts/arclight.js'
+      append_to_file 'app/assets/stylesheets/application.bootstrap.scss' do
+        <<~CONTENT
+          @import "arclight";
+        CONTENT
+      end
     end
 
     def add_arclight_search_behavior
@@ -66,8 +88,76 @@ module Arclight
       copy_file 'config/downloads.yml' unless File.exist?('config/downloads.yml')
     end
 
+    def add_i18n_config
+      copy_file 'config/locales/arclight.en.yml'
+    end
+
     def modify_blacklight_yml
       gsub_file 'config/locales/blacklight.en.yml', "application_name: 'Blacklight'", "application_name: 'Arclight'"
     end
+
+    def assets
+      if using_importmap?
+        pin_javascript_dependencies
+        import_arclight_javascript
+      else
+        install_javascript_dependencies
+      end
+    end
+
+    def inject_arclight_routes
+      inject_into_file 'config/routes.rb',
+                       "  concern :hierarchy, Arclight::Routes::Hierarchy.new\n",
+                       after: /concern :exportable.*\n/
+      inject_into_file 'config/routes.rb',
+                       "  concerns :hierarchy\n",
+                       after: /resources :solr_documents.*\n/
+    end
+
+    private
+
+    def root
+      @root ||= Pathname(destination_root)
+    end
+
+    def using_importmap?
+      @using_importmap ||= root.join('config/importmap.rb').exist?
+    end
+
+    # This is the last step because any failure here wouldn't prevent the other steps from running
+    def install_javascript_dependencies
+      inject_into_file 'app/assets/javascripts/application.js', after: '//= require blacklight/blacklight' do
+        "\n// Required by Arclight" \
+          "\n//= require arclight/arclight"
+      end
+    end
+
+    def pin_javascript_dependencies
+      say 'Arclight Importmap asset generation'
+
+      append_to_file 'config/importmap.rb', <<~RUBY
+        pin "arclight", to: "arclight/arclight.js"
+        # TODO: We may be able to move these to a single importmap for arclight.
+        pin "arclight/oembed_controller", to: "arclight/oembed_controller.js"
+        pin "arclight/truncate_controller", to: "arclight/truncate_controller.js"
+      RUBY
+    end
+
+    def import_arclight_javascript
+      append_to_file 'app/javascript/application.js', "\nimport \"arclight\""
+    end
+
+    def package_yarn_version(package_name, requested_version)
+      versions = JSON.parse(`yarn info #{package_name} versions --json`)['data']
+      exact_match = versions.find { |v| v == requested_version }
+      return exact_match if exact_match
+
+      major_version = Gem::Version.new(requested_version).segments.first
+      "^#{major_version}"
+    end
+
+    def arclight_yarn_version
+      package_yarn_version('arclight', Arclight::VERSION)
+    end
   end
 end

data/lib/generators/arclight/templates/arclight.scss

@@ -1,3 +1,6 @@
-/*
-*= require arclight/application
-*/
+:root {
+  --bs-breadcrumb-divider: "»";
+}
+
+// Arclight, imported from arclight frontend package
+@import 'arclight/app/assets/stylesheets/arclight/application';