arclight 0.0.1 → 1.4.0

data/lib/arclight/year_range.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module Arclight
+  # A range of years that handles gaps, such as [1999, 2000, 2002].
+  # Primary usage is:
+  # ```
+  # range = YearRange.new('1999/2004')
+  # range.years => [1999, 2000, 2001, 2002, 2003, 2004]
+  # range.to_s => '1999-2004'
+  # range << range.parse_ranges(['2010/2010'])
+  # range.years => [1999, 2000, 2001, 2002, 2003, 2004, 2010]
+  # range.to_s => '1999-2004, 2010'
+  # ```
+  class YearRange
+    attr_accessor :years
+
+    # @param [Array<String>] `dates` in the form YYYY/YYYY
+    def initialize(dates = nil)
+      @years = []
+      self << parse_ranges(dates) if dates.present?
+    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
+    end
+
+    # @param [String] `dates` in the form YYYY/YYYY
+    # @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
+
+    # @param [Array<String>] `dates` in the form YYYY/YYYY
+    # @return [Array<Integer>] the set of years in the given range
+    def parse_ranges(dates)
+      dates.map { |date| parse_range(date) }.flatten.sort.uniq
+    end
+
+    # @param [String] `date` a date in one of these formats:
+    #                        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
+
+    private
+
+    # 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
+    # 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..].each do |j|
+        i += 1
+        if i == j
+          streak << j
+        else # we have a gap
+          results << if streak.length == 1
+                       streak.first.to_s
+                     else
+                       to_s_for_streak(streak)
+                     end
+          streak = [j]
+          i = j
+        end
+      end
+      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.minmax.map(&:to_s).join('-')
+    end
+  end
+end

data/lib/arclight.rb

@@ -1,5 +1,15 @@
+# frozen_string_literal: true
+
 require 'arclight/version'
+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

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module Arclight
+  ##
+  # Arclight install generator
+  class Install < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    def create_blacklight_catalog
+      remove_file 'app/controllers/catalog_controller.rb'
+      copy_file 'catalog_controller.rb', 'app/controllers/catalog_controller.rb'
+    end
+
+    def include_arclight_solrdocument
+      inject_into_file 'app/models/solr_document.rb', after: 'include Blacklight::Solr::Document' do
+        "\n include Arclight::SolrDocument"
+      end
+    end
+
+    def install_blacklight_locale_picker
+      gem 'blacklight-locale_picker'
+
+      Bundler.with_unbundled_env do
+        run 'bundle install'
+      end
+
+      generate 'blacklight:locale_picker:install'
+
+      inject_into_file 'app/helpers/application_helper.rb', after: 'include Blacklight::LocalePicker::LocaleHelper' do
+        "\n\n  def additional_locale_routing_scopes\n    [blacklight, arclight_engine]\n  end"
+      end
+    end
+
+    def add_custom_routes
+      inject_into_file 'config/routes.rb', after: "mount Blacklight::Engine => '/'" do
+        "\n  mount Arclight::Engine => '/'\n"
+      end
+
+      gsub_file 'config/routes.rb', 'root to: "catalog#index"', 'root to: "arclight/repositories#index"'
+    end
+
+    def copy_styles
+      copy_file 'arclight.scss', 'app/assets/stylesheets/arclight.scss'
+      remove_file 'app/assets/stylesheets/blacklight.scss' # Avoid two copies of bootstrap
+    end
+
+    def add_arclight_search_behavior
+      inject_into_file 'app/models/search_builder.rb', after: 'include Blacklight::Solr::SearchBuilderBehavior' do
+        "\n  include Arclight::SearchBehavior"
+      end
+    end
+
+    def solr_config
+      directory '../../../../solr', 'solr', force: true
+    end
+
+    def add_repository_config
+      copy_file 'config/repositories.yml' unless File.exist?('config/repositories.yml')
+    end
+
+    def add_download_config
+      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
+  end
+end

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

@@ -0,0 +1,5 @@
+$breadcrumb-divider: quote("»");
+$logo-image: image_url('arclight/logo.png') !default;
+@import 'bootstrap';
+@import 'blacklight/blacklight';
+@import 'arclight/application';