arclight 0.2.0 → 1.6.2
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.
- checksums.yaml +4 -4
- data/.all-contributorsrc +450 -0
- data/.codeclimate.yml +5 -0
- data/.eslintrc +14 -4
- data/.github/workflows/ruby.yml +51 -0
- data/.gitignore +1 -0
- data/.rspec +0 -1
- data/.rubocop.yml +504 -8
- data/.rubocop_todo.yml +62 -199
- data/.solr_wrapper +2 -1
- data/CONTRIBUTING.md +5 -5
- data/CONTRIBUTORS.md +79 -0
- data/Gemfile +15 -10
- data/README.md +36 -34
- data/Rakefile +0 -1
- data/app/assets/images/blacklight/bookmark.svg +1 -0
- data/app/assets/images/blacklight/collection.svg +5 -0
- data/app/assets/images/blacklight/compact.svg +1 -25
- data/app/assets/images/blacklight/container.svg +5 -0
- data/app/assets/images/blacklight/ead.svg +1 -0
- data/app/assets/images/blacklight/file.svg +5 -0
- data/app/assets/images/blacklight/folder.svg +1 -0
- data/app/assets/images/blacklight/list.svg +1 -0
- data/app/assets/images/blacklight/minus.svg +1 -0
- data/app/assets/images/blacklight/online.svg +5 -0
- data/app/assets/images/blacklight/pdf.svg +1 -0
- data/app/assets/images/blacklight/plus.svg +1 -0
- data/app/assets/images/blacklight/repository.svg +1 -0
- data/app/assets/javascripts/arclight/arclight.js +4 -10
- data/app/assets/javascripts/arclight/oembed_controller.js +58 -0
- data/app/assets/javascripts/arclight/truncate_controller.js +27 -0
- data/app/assets/stylesheets/arclight/application.scss +4 -4
- data/app/assets/stylesheets/arclight/build.scss +4 -0
- data/app/assets/stylesheets/arclight/modules/hierarchy_and_online_contents.scss +117 -146
- data/app/assets/stylesheets/arclight/modules/highlights.scss +2 -1
- data/app/assets/stylesheets/arclight/modules/icons.scss +20 -0
- data/app/assets/stylesheets/arclight/modules/layout.scss +183 -40
- data/app/assets/stylesheets/arclight/modules/mastheads.scss +24 -75
- data/app/assets/stylesheets/arclight/modules/repositories.scss +3 -7
- data/app/assets/stylesheets/arclight/modules/repository_card.scss +5 -50
- data/app/assets/stylesheets/arclight/modules/search_form.scss +9 -0
- data/app/assets/stylesheets/arclight/modules/search_results.scss +197 -26
- data/app/assets/stylesheets/arclight/modules/show_collection.scss +21 -69
- data/app/assets/stylesheets/arclight/modules/truncator.scss +58 -0
- data/app/assets/stylesheets/arclight/responsive.scss +13 -0
- data/app/assets/stylesheets/arclight/variables.scss +25 -2
- data/app/components/arclight/access_component.html.erb +14 -0
- data/app/components/arclight/access_component.rb +25 -0
- data/app/components/arclight/bookmark_component.html.erb +25 -0
- data/app/components/arclight/bookmark_component.rb +9 -0
- data/app/components/arclight/breadcrumb_component.rb +50 -0
- data/app/components/arclight/breadcrumbs_hierarchy_component.html.erb +34 -0
- data/app/components/arclight/breadcrumbs_hierarchy_component.rb +25 -0
- data/app/components/arclight/collection_context_component.html.erb +12 -0
- data/app/components/arclight/collection_context_component.rb +27 -0
- data/app/components/arclight/collection_info_component.html.erb +28 -0
- data/app/components/arclight/collection_info_component.rb +26 -0
- data/app/components/arclight/collection_sidebar_component.html.erb +15 -0
- data/app/components/arclight/collection_sidebar_component.rb +39 -0
- data/app/{views/catalog/_search_results_repository.html.erb → components/arclight/constraints_component.html.erb} +2 -1
- data/app/components/arclight/constraints_component.rb +17 -0
- data/app/components/arclight/document_collection_context_component.html.erb +29 -0
- data/app/components/arclight/document_collection_context_component.rb +28 -0
- data/app/components/arclight/document_collection_hierarchy_component.html.erb +50 -0
- data/app/components/arclight/document_collection_hierarchy_component.rb +62 -0
- data/app/components/arclight/document_component.html.erb +39 -0
- data/app/components/arclight/document_component.rb +49 -0
- data/app/components/arclight/document_components_hierarchy_component.html.erb +20 -0
- data/app/components/arclight/document_components_hierarchy_component.rb +34 -0
- data/app/components/arclight/document_download_component.html.erb +24 -0
- data/app/components/arclight/document_download_component.rb +71 -0
- data/app/components/arclight/embed_component.html.erb +10 -0
- data/app/components/arclight/embed_component.rb +43 -0
- data/app/components/arclight/expand_hierarchy_button_component.html.erb +5 -0
- data/app/components/arclight/expand_hierarchy_button_component.rb +16 -0
- data/app/components/arclight/group_component.html.erb +34 -0
- data/app/components/arclight/group_component.rb +23 -0
- data/app/components/arclight/header_component.html.erb +5 -0
- data/app/components/arclight/header_component.rb +10 -0
- data/app/components/arclight/index_metadata_field_component.html.erb +16 -0
- data/app/components/arclight/index_metadata_field_component.rb +20 -0
- data/app/components/arclight/masthead_component.html.erb +17 -0
- data/app/components/arclight/masthead_component.rb +10 -0
- data/app/components/arclight/metadata_section_component.html.erb +13 -0
- data/app/components/arclight/metadata_section_component.rb +22 -0
- data/app/components/arclight/oembed_viewer_component.html.erb +5 -0
- data/app/components/arclight/oembed_viewer_component.rb +16 -0
- data/app/components/arclight/online_content_filter_component.html.erb +15 -0
- data/app/components/arclight/online_content_filter_component.rb +17 -0
- data/app/components/arclight/online_status_indicator_component.rb +19 -0
- data/app/components/arclight/repository_breadcrumb_component.html.erb +10 -0
- data/app/components/arclight/repository_breadcrumb_component.rb +17 -0
- data/app/components/arclight/repository_location_component.html.erb +20 -0
- data/app/components/arclight/repository_location_component.rb +10 -0
- data/app/components/arclight/search_bar_component.html.erb +27 -0
- data/app/components/arclight/search_bar_component.rb +32 -0
- data/app/components/arclight/search_result_breadcrumbs_component.html.erb +6 -0
- data/app/components/arclight/search_result_breadcrumbs_component.rb +37 -0
- data/app/components/arclight/search_result_component.html.erb +20 -0
- data/app/components/arclight/search_result_component.rb +18 -0
- data/app/components/arclight/search_result_title_component.html.erb +15 -0
- data/app/components/arclight/search_result_title_component.rb +15 -0
- data/app/components/arclight/sidebar_component.html.erb +9 -0
- data/app/components/arclight/sidebar_component.rb +19 -0
- data/app/components/arclight/upper_metadata_layout_component.rb +10 -0
- data/app/components/blacklight/icons/bookmark_component.rb +12 -0
- data/app/components/blacklight/icons/collection_component.rb +14 -0
- data/app/components/blacklight/icons/compact_component.rb +12 -0
- data/app/components/blacklight/icons/container_component.rb +14 -0
- data/app/components/blacklight/icons/ead_component.rb +12 -0
- data/app/components/blacklight/icons/file_component.rb +14 -0
- data/app/components/blacklight/icons/folder_component.rb +12 -0
- data/app/components/blacklight/icons/online_component.rb +15 -0
- data/app/components/blacklight/icons/pdf_component.rb +12 -0
- data/app/components/blacklight/icons/repository_component.rb +12 -0
- data/app/controllers/arclight/repositories_controller.rb +4 -4
- data/app/helpers/arclight/ead_format_helpers.rb +309 -0
- data/app/helpers/arclight/field_config_helpers.rb +26 -0
- data/app/helpers/arclight_helper.rb +55 -120
- data/app/models/arclight/document_downloads.rb +122 -0
- data/app/models/arclight/parent.rb +9 -9
- data/app/models/arclight/parents.rb +9 -4
- data/app/models/arclight/requests/aeon_external_request.rb +42 -0
- data/app/models/arclight/requests/aeon_web_ead.rb +52 -0
- data/app/models/arclight/requests/google_form.rb +8 -3
- data/app/models/concerns/arclight/catalog.rb +33 -11
- data/app/models/concerns/arclight/search_behavior.rb +22 -21
- data/app/models/concerns/arclight/solr_document.rb +88 -59
- data/app/presenters/arclight/show_presenter.rb +34 -7
- data/app/views/arclight/_requests.html.erb +7 -0
- data/app/views/arclight/repositories/_repository.html.erb +22 -41
- data/app/views/arclight/repositories/index.html.erb +5 -0
- data/app/views/arclight/repositories/show.html.erb +7 -8
- data/app/views/arclight/requests/_aeon_external_request_endpoint.html.erb +8 -0
- data/app/views/arclight/requests/_aeon_web_ead.html.erb +6 -0
- data/app/views/arclight/requests/_google_form.html.erb +4 -5
- data/app/views/catalog/_document_list.html.erb +8 -0
- data/app/views/catalog/_group.html.erb +4 -0
- data/app/views/catalog/_group_toggle.html.erb +10 -0
- data/app/views/catalog/_search_results_header.html.erb +3 -0
- data/app/views/catalog/hierarchy.html.erb +19 -0
- data/app/views/catalog/index.html.erb +16 -7
- data/app/views/shared/_breadcrumbs.html.erb +3 -15
- data/app/views/shared/_main_menu_links.html.erb +1 -1
- data/arclight.gemspec +18 -17
- data/config/breadcrumbs.rb +24 -0
- data/config/i18n-tasks.yml +11 -9
- data/config/importmap.rb +3 -0
- data/config/locales/arclight.en.yml +68 -34
- data/config/routes.rb +1 -1
- data/docker-compose.yml +16 -0
- data/lib/arclight/digital_object.rb +2 -1
- data/lib/arclight/engine.rb +22 -31
- data/lib/arclight/exceptions.rb +1 -0
- data/lib/arclight/hash_absolute_xpath.rb +13 -8
- data/lib/arclight/level_label.rb +46 -0
- data/lib/arclight/normalized_date.rb +5 -10
- data/lib/arclight/normalized_id.rb +7 -2
- data/lib/arclight/normalized_title.rb +3 -0
- data/lib/arclight/repository.rb +70 -28
- data/lib/arclight/routes/hierarchy.rb +19 -0
- data/lib/arclight/routes.rb +8 -0
- data/lib/arclight/traject/ead2_component_config.rb +335 -0
- data/lib/arclight/traject/ead2_config.rb +172 -331
- data/lib/arclight/traject/nokogiri_namespaceless_reader.rb +22 -0
- data/lib/arclight/version.rb +1 -1
- data/lib/arclight/year_range.rb +13 -4
- data/lib/arclight.rb +6 -1
- data/lib/generators/arclight/install_generator.rb +100 -10
- data/lib/generators/arclight/templates/arclight.scss +6 -3
- data/lib/generators/arclight/templates/catalog_controller.rb +237 -179
- data/lib/generators/arclight/templates/config/downloads.yml +12 -0
- data/lib/generators/arclight/templates/config/locales/arclight.en.yml +61 -0
- data/lib/generators/arclight/templates/config/repositories.yml +42 -31
- data/lib/generators/arclight/update_generator.rb +1 -1
- data/lib/tasks/index.rake +25 -30
- data/package.json +15 -9
- data/solr/conf/schema.xml +97 -328
- data/solr/conf/solrconfig.xml +99 -164
- data/tasks/arclight.rake +18 -9
- data/template.rb +6 -7
- metadata +188 -129
- data/.travis.yml +0 -28
- data/app/assets/javascripts/arclight/collection_context.js +0 -18
- data/app/assets/javascripts/arclight/collection_navigation.js +0 -117
- data/app/assets/javascripts/arclight/collection_scrollspy.js +0 -6
- data/app/assets/javascripts/arclight/component_ancestors.js +0 -56
- data/app/assets/javascripts/arclight/oembed_viewer.js +0 -46
- data/app/assets/javascripts/arclight/search_results.js +0 -15
- data/app/assets/javascripts/arclight/truncator.js.erb +0 -23
- data/app/assets/stylesheets/arclight/bootstrap_overrides.scss +0 -3
- data/app/assets/stylesheets/arclight/modules/sidebar.scss +0 -21
- data/app/controllers/concerns/arclight/field_config_helpers.rb +0 -86
- data/app/factories/blacklight_field_configuration_factory.rb +0 -29
- data/app/views/arclight/repositories/_in_person_repository.html.erb +0 -19
- data/app/views/arclight/viewers/_oembed.html.erb +0 -7
- data/app/views/catalog/_arclight_document_index_header.html.erb +0 -13
- data/app/views/catalog/_arclight_document_index_header_online_contents_default.html.erb +0 -0
- data/app/views/catalog/_arclight_index_compact_default.html.erb +0 -15
- data/app/views/catalog/_arclight_online_content_indicator.html.erb +0 -5
- data/app/views/catalog/_arclight_rangelimit.html.erb +0 -24
- data/app/views/catalog/_arclight_viewer_default.html.erb +0 -1
- data/app/views/catalog/_collection_contents.html.erb +0 -12
- data/app/views/catalog/_collection_count.html.erb +0 -7
- data/app/views/catalog/_collection_downloads.html.erb +0 -15
- data/app/views/catalog/_collection_online_contents.html.erb +0 -17
- data/app/views/catalog/_collection_overview.html.erb +0 -7
- data/app/views/catalog/_component_contents.html.erb +0 -16
- data/app/views/catalog/_component_overview.html.erb +0 -40
- data/app/views/catalog/_context_card.html.erb +0 -27
- data/app/views/catalog/_context_sidebar.html.erb +0 -8
- data/app/views/catalog/_custom_metadata.html.erb +0 -16
- data/app/views/catalog/_home.html.erb +0 -1
- data/app/views/catalog/_index_breadcrumb_default.html.erb +0 -3
- data/app/views/catalog/_index_default.html.erb +0 -17
- data/app/views/catalog/_index_header.html.erb +0 -7
- data/app/views/catalog/_index_header_hierarchy_default.html.erb +0 -42
- data/app/views/catalog/_index_header_online_contents_default.html.erb +0 -1
- data/app/views/catalog/_index_hierarchy_default.html.erb +0 -28
- data/app/views/catalog/_index_online_contents_default.html.erb +0 -6
- data/app/views/catalog/_results_histogram.html.erb +0 -15
- data/app/views/catalog/_search_results.html.erb +0 -31
- data/app/views/catalog/_show_breadcrumbs_default.html.erb +0 -21
- data/app/views/catalog/_show_collection.html.erb +0 -48
- data/app/views/catalog/_show_component_sidebar.html.erb +0 -12
- data/app/views/catalog/_show_default.html.erb +0 -42
- data/app/views/catalog/_show_sidebar.html.erb +0 -22
- data/app/views/catalog/_show_upper_metadata_collection.html.erb +0 -1
- data/app/views/catalog/_show_upper_metadata_default.html.erb +0 -14
- data/app/views/layouts/catalog_result.html.erb +0 -7
- data/app/views/shared/_context_sidebar.html.erb +0 -8
- data/app/views/shared/_header_navbar.html.erb +0 -65
- data/lib/arclight/custom_component.rb +0 -99
- data/lib/arclight/custom_document.rb +0 -93
- data/lib/arclight/indexer.rb +0 -9
- data/lib/arclight/shared_indexing_behavior.rb +0 -97
- data/lib/arclight/shared_terminology_behavior.rb +0 -65
- data/lib/arclight/solr_ead_indexer_ext.rb +0 -155
- data/lib/arclight/viewer.rb +0 -45
- data/lib/arclight/viewers/oembed.rb +0 -56
- data/lib/generators/arclight/templates/arclight.js +0 -2
- data/solr/conf/scripts.conf +0 -24
- data/vendor/assets/javascripts/responsiveTruncator.js +0 -69
- data/vendor/assets/javascripts/stickyfill.js +0 -480
- /data/app/assets/images/{blacklight → arclight}/logo.png +0 -0
- /data/{app/views/catalog/_arclight_document_index_header_hierarchy_default.html.erb → config/repositories.yml} +0 -0
data/README.md
CHANGED
|
@@ -1,20 +1,23 @@
|
|
|
1
|
-
[](https://badge.fury.io/rb/arclight)
|
|
2
|
+
[](https://badge.fury.io/js/arclight)
|
|
3
|
+

|
|
4
|
+
[](CONTRIBUTORS.md)
|
|
5
|
+
[](https://codeclimate.com/github/projectblacklight/arclight/coverage)
|
|
3
6
|
|
|
4
7
|
# ArcLight
|
|
5
8
|
|
|
6
|
-
A Rails engine supporting discovery of archival materials.
|
|
9
|
+
A Rails engine supporting discovery of archival materials, based on [Blacklight](https://projectblacklight.org/)
|
|
7
10
|
|
|
8
|
-
During April - June 2017, ArcLight underwent its initial development as a Minimally Viable Product (MVP). The MVP is targeted for content that is described in the [Encoded Archival Description](http://eadiva.com/2/) (EAD) format. Future development is in the planning phase with no definitive timeline as yet.
|
|
9
11
|
|
|
10
12
|
## Requirements
|
|
11
13
|
|
|
12
|
-
* [Ruby](https://www.ruby-lang.org/en/)
|
|
13
|
-
* [Rails](http://rubyonrails.org)
|
|
14
|
+
* [Ruby](https://www.ruby-lang.org/en/) 3.0.3 or later
|
|
15
|
+
* [Rails](http://rubyonrails.org) 7.1 or later
|
|
16
|
+
* Solr 8.1 or later
|
|
14
17
|
|
|
15
18
|
## Installation
|
|
16
19
|
|
|
17
|
-
[Installing ArcLight](https://github.com/
|
|
20
|
+
[Installing ArcLight](https://github.com/projectblacklight/arclight/wiki/Creating,-installing,-and-running-your-ArcLight-application) is straightforward in a Rails environment.
|
|
18
21
|
|
|
19
22
|
Basically, add this line to your application's `Gemfile`:
|
|
20
23
|
|
|
@@ -34,7 +37,7 @@ Or install it yourself as:
|
|
|
34
37
|
$ gem install arclight
|
|
35
38
|
```
|
|
36
39
|
|
|
37
|
-
For further details, see our [Installing ArcLight](https://github.com/
|
|
40
|
+
For further details, see our [Installing ArcLight](https://github.com/projectblacklight/arclight/wiki/Creating,-installing,-and-running-your-ArcLight-application) documentation.
|
|
38
41
|
|
|
39
42
|
## Usage
|
|
40
43
|
|
|
@@ -46,50 +49,40 @@ Browsing allows you to view the Overview or Contents (when it exists) of a colle
|
|
|
46
49
|
|
|
47
50
|
Some pages include an inline view tab to the right of an item which will expand the Contents further.
|
|
48
51
|
|
|
49
|
-
See the [ArcLight demo](https://arclight-demo.projectblacklight.org/) and [ArcLight MVP Wiki](https://github.com/
|
|
52
|
+
See the [ArcLight demo](https://arclight-demo.projectblacklight.org/) and [ArcLight MVP Wiki](https://github.com/projectblacklight/arclight/wiki) for usage.
|
|
50
53
|
|
|
51
|
-
See [Arclight Major Features](https://github.com/
|
|
54
|
+
See [Arclight Major Features](https://github.com/projectblacklight/arclight/wiki/Arclight-Major-Features) for a list of features.
|
|
52
55
|
|
|
53
56
|
### Traject indexing of EAD content
|
|
54
|
-
[Traject](https://github.com/traject/traject) is a
|
|
57
|
+
[Traject](https://github.com/traject/traject) is a high performance way of transforming documents for indexing into Solr and how ArcLight does indexing. An EAD2 can be indexed by doing the following:
|
|
55
58
|
|
|
56
59
|
```sh
|
|
57
60
|
bundle exec traject -u http://127.0.0.1:8983/solr/blacklight-core -i xml -c lib/arclight/traject/ead2_config.rb spec/fixtures/ead/sample/large-components-list.xml
|
|
58
61
|
```
|
|
59
62
|
|
|
60
|
-
Or
|
|
63
|
+
Or
|
|
61
64
|
|
|
62
65
|
```sh
|
|
63
|
-
|
|
64
|
-
|
|
66
|
+
bundle exec rake arclight:seed
|
|
67
|
+
```
|
|
65
68
|
|
|
66
69
|
## Resources
|
|
67
70
|
|
|
68
71
|
* General
|
|
69
|
-
* [ArcLight team wiki](https://wiki.duraspace.org/display/hydra/ArcLight): includes design process documentation
|
|
70
|
-
* Use the [ArcLight Google Group](http://groups.google.com/d/forum/arclight-community) to contact us with questions
|
|
71
|
-
* MVP Implementation:
|
|
72
72
|
* [ArcLight demo site](https://arclight-demo.projectblacklight.org/)
|
|
73
|
-
* [
|
|
74
|
-
* [ArcLight MVP Wiki](https://github.com/sul-dlss/arclight/wiki)
|
|
73
|
+
* [ArcLight Github wiki](https://github.com/projectblacklight/arclight/wiki): developer/implementor documentation
|
|
75
74
|
* [Blacklight wiki](https://github.com/projectblacklight/blacklight/wiki)
|
|
75
|
+
* Use the [ArcLight Google Group](http://groups.google.com/d/forum/arclight-community) to contact us with questions
|
|
76
|
+
* ArcLight MVP:
|
|
77
|
+
* [MVP sprint demo videos](https://www.youtube.com/playlist?list=PLMdUaIJ0G8QgbuDCUVvFhTSTO96N37lRA)
|
|
76
78
|
|
|
77
|
-
##
|
|
79
|
+
## Contributors
|
|
78
80
|
|
|
79
|
-
|
|
80
|
-
* [Camille Villa](https://github.com/camillevilla)
|
|
81
|
-
* [Darren Hardy](https://github.com/drh-stanford)
|
|
82
|
-
* [Gary Geisler](https://github.com/ggeisler)
|
|
83
|
-
* [Jack Reed](https://github.com/mejackreed)
|
|
84
|
-
* [Jennifer Vine](https://github.com/jvine)
|
|
85
|
-
* [Jessie Keck](https://github.com/jkeck)
|
|
86
|
-
* [Mark Matienzo](https://github.com/anarchivist)
|
|
87
|
-
* University of Michigan
|
|
88
|
-
* [Gordon Leacock](https://github.com/gordonleacock)
|
|
81
|
+
See the [CONTRIBUTORS](CONTRIBUTORS.md) file.
|
|
89
82
|
|
|
90
83
|
## Development
|
|
91
84
|
|
|
92
|
-
ArcLight development
|
|
85
|
+
ArcLight requires Solr to be running. For development you can start this using `solr_wrapper` or you may choose to use Docker. Start Solr using Docker by doing `docker compose up`.
|
|
93
86
|
|
|
94
87
|
### Run the test suite
|
|
95
88
|
|
|
@@ -112,16 +105,25 @@ Then visit http://localhost:3000. It will also start a Solr instance on port 898
|
|
|
112
105
|
|
|
113
106
|
You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
|
114
107
|
|
|
115
|
-
###
|
|
108
|
+
### Releasing
|
|
116
109
|
|
|
117
|
-
To release a new
|
|
110
|
+
#### To release a new gem:
|
|
118
111
|
|
|
119
112
|
1. Update the version number in `lib/arclight/version.rb`
|
|
120
113
|
2. Run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, build the gem file (e.g., `gem build arclight.gemspec`) and push the `.gem` file to [rubygems.org](https://rubygems.org) (e.g., `gem push arclight-x.y.z.gem`).
|
|
121
114
|
|
|
115
|
+
#### To release the frontend sources:
|
|
116
|
+
|
|
117
|
+
When any of the javascript components or SASS sources in the gem are changed, this package should be published to NPM with the following steps:
|
|
118
|
+
1. [Install npm](https://www.npmjs.com/get-npm)
|
|
119
|
+
2. Bump the version number in `package.json`
|
|
120
|
+
3. run `npm run build && npm publish` to push the javascript package to https://npmjs.org/package/arclight
|
|
121
|
+
|
|
122
122
|
## Contributing
|
|
123
123
|
|
|
124
|
-
[Bug reports](https://github.com/
|
|
124
|
+
[Bug reports](https://github.com/projectblacklight/arclight/issues) and [pull requests](https://github.com/projectblacklight/arclight/pulls) are welcome on ArcLight -- see [CONTRIBUTING.md](https://github.com/projectblacklight/arclight/blob/main/CONTRIBUTING.md) for details.
|
|
125
125
|
## License
|
|
126
126
|
|
|
127
127
|
The gem is available as open source under the terms of the [Apache 2 License](https://opensource.org/licenses/Apache-2.0).
|
|
128
|
+
|
|
129
|
+
ArcLight also uses embedded SVG icons from the [FontAwesome](https://fontawesome.com) project. These icons are unmodified and licensed [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/). All of these icons have the license and attribution embedded in them.
|
data/Rakefile
CHANGED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 384 512"><path d="M0 512V48C0 21.49 21.49 0 48 0h288c26.51 0 48 21.49 48 48v464L192 400 0 512z"/></svg>
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
<!--
|
|
2
|
+
Used unmodified from https://fontawesome.com
|
|
3
|
+
CC BY 4.0 https://creativecommons.org/licenses/by/4.0/
|
|
4
|
+
-->
|
|
5
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 512 512"><path d="M32 448c0 17.7 14.3 32 32 32h384c17.7 0 32-14.3 32-32V160H32v288zm160-212c0-6.6 5.4-12 12-12h104c6.6 0 12 5.4 12 12v8c0 6.6-5.4 12-12 12H204c-6.6 0-12-5.4-12-12v-8zM480 32H32C14.3 32 0 46.3 0 64v48c0 8.8 7.2 16 16 16h480c8.8 0 16-7.2 16-16V64c0-17.7-14.3-32-32-32z"/></svg>
|
|
@@ -1,25 +1 @@
|
|
|
1
|
-
|
|
2
|
-
<svg width="16px" height="16px" viewBox="0 0 16 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
3
|
-
<!-- Generator: Sketch 44.1 (41455) - http://www.bohemiancoding.com/sketch -->
|
|
4
|
-
<title>Compact</title>
|
|
5
|
-
<desc>Created with Sketch.</desc>
|
|
6
|
-
<defs></defs>
|
|
7
|
-
<g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd" stroke-linecap="square">
|
|
8
|
-
<g id="Compact" stroke="#000000">
|
|
9
|
-
<path d="M1.43885093,2.44444444 L6.83349609,2.44444444"></path>
|
|
10
|
-
<path d="M1.43885093,4.44444444 L6.83349609,4.44444444"></path>
|
|
11
|
-
<path d="M1.43885093,6.44444444 L6.83349609,6.44444444"></path>
|
|
12
|
-
<path d="M1.43885093,8.44444444 L6.83349609,8.44444444"></path>
|
|
13
|
-
<path d="M1.43885093,10.4444444 L6.83349609,10.4444444"></path>
|
|
14
|
-
<path d="M1.43885093,12.4444444 L6.83349609,12.4444444"></path>
|
|
15
|
-
<path d="M1.43885093,14.4444444 L6.83349609,14.4444444"></path>
|
|
16
|
-
<path d="M9.43885093,2.44444444 L14.8334961,2.44444444"></path>
|
|
17
|
-
<path d="M9.43885093,4.44444444 L14.8334961,4.44444444"></path>
|
|
18
|
-
<path d="M9.43885093,6.44444444 L14.8334961,6.44444444"></path>
|
|
19
|
-
<path d="M9.43885093,8.44444444 L14.8334961,8.44444444"></path>
|
|
20
|
-
<path d="M9.43885093,10.4444444 L14.8334961,10.4444444"></path>
|
|
21
|
-
<path d="M9.43885093,12.4444444 L14.8334961,12.4444444"></path>
|
|
22
|
-
<path d="M9.43885093,14.4444444 L14.8334961,14.4444444"></path>
|
|
23
|
-
</g>
|
|
24
|
-
</g>
|
|
25
|
-
</svg>
|
|
1
|
+
<svg xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 0 24 24"><path d="M3,15H21V13H3Zm0,4H21V17H3Zm0-8H21V9H3ZM3,5V7H21V5Z"/></svg>
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
<!--
|
|
2
|
+
Used unmodified from https://fontawesome.com
|
|
3
|
+
CC BY 4.0 https://creativecommons.org/licenses/by/4.0/
|
|
4
|
+
-->
|
|
5
|
+
<svg xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 0 512 512"><path d="M464 128H272l-64-64H48C21.49 64 0 85.49 0 112v288c0 26.51 21.49 48 48 48h416c26.51 0 48-21.49 48-48V176c0-26.51-21.49-48-48-48z"/></svg>
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
<svg xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 0 384 512"><path d="M149.9 349.1l-.2-.2-32.8-28.9 32.8-28.9c3.6-3.2 4-8.8.8-12.4l-.2-.2-17.4-18.6c-3.4-3.6-9-3.7-12.4-.4l-57.7 54.1c-3.7 3.5-3.7 9.4 0 12.8l57.7 54.1c1.6 1.5 3.8 2.4 6 2.4 2.4 0 4.8-1 6.4-2.8l17.4-18.6c3.3-3.5 3.1-9.1-.4-12.4zm220-251.2L286 14C277 5 264.8-.1 252.1-.1H48C21.5 0 0 21.5 0 48v416c0 26.5 21.5 48 48 48h288c26.5 0 48-21.5 48-48V131.9c0-12.7-5.1-25-14.1-34zM256 51.9l76.1 76.1H256zM336 464H48V48h160v104c0 13.3 10.7 24 24 24h104zM209.6 214c-4.7-1.4-9.5 1.3-10.9 6L144 408.1c-1.4 4.7 1.3 9.6 6 10.9l24.4 7.1c4.7 1.4 9.6-1.4 10.9-6L240 231.9c1.4-4.7-1.3-9.6-6-10.9zm24.5 76.9l.2.2 32.8 28.9-32.8 28.9c-3.6 3.2-4 8.8-.8 12.4l.2.2 17.4 18.6c3.3 3.5 8.9 3.7 12.4.4l57.7-54.1c3.7-3.5 3.7-9.4 0-12.8l-57.7-54.1c-3.5-3.3-9.1-3.2-12.4.4l-17.4 18.6c-3.3 3.5-3.1 9.1.4 12.4z"/></svg>
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
<!--
|
|
2
|
+
Used unmodified from https://fontawesome.com
|
|
3
|
+
CC BY 4.0 https://creativecommons.org/licenses/by/4.0/
|
|
4
|
+
-->
|
|
5
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 384 512"><path d="M224 136V0H24C10.7 0 0 10.7 0 24v464c0 13.3 10.7 24 24 24h336c13.3 0 24-10.7 24-24V160H248c-13.2 0-24-10.8-24-24zm160-14.1v6.1H256V0h6.1c6.4 0 12.5 2.5 17 7l97.9 98c4.5 4.5 7 10.6 7 16.9z"/></svg>
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
<svg xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 0 512 512"><path d="M464 128H272l-64-64H48C21.49 64 0 85.49 0 112v288c0 26.51 21.49 48 48 48h416c26.51 0 48-21.49 48-48V176c0-26.51-21.49-48-48-48z"/></svg>
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
<svg height="24" width="24" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><title>file</title><path d="M0,0H24V24H0Z" fill="none"/><path d="M3,19H21V13.45H3ZM3,5v5.61H21V5Z"/></svg>
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M19 13H5v-2h14v2z"/><path d="M0 0h24v24H0z" fill="none"/></svg>
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
<!--
|
|
2
|
+
Used unmodified from https://fontawesome.com
|
|
3
|
+
CC BY 4.0 https://creativecommons.org/licenses/by/4.0/
|
|
4
|
+
-->
|
|
5
|
+
<svg xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 0 640 512"><path d="M608 0H160a32 32 0 0 0-32 32v96h160V64h192v320h128a32 32 0 0 0 32-32V32a32 32 0 0 0-32-32zM232 103a9 9 0 0 1-9 9h-30a9 9 0 0 1-9-9V73a9 9 0 0 1 9-9h30a9 9 0 0 1 9 9zm352 208a9 9 0 0 1-9 9h-30a9 9 0 0 1-9-9v-30a9 9 0 0 1 9-9h30a9 9 0 0 1 9 9zm0-104a9 9 0 0 1-9 9h-30a9 9 0 0 1-9-9v-30a9 9 0 0 1 9-9h30a9 9 0 0 1 9 9zm0-104a9 9 0 0 1-9 9h-30a9 9 0 0 1-9-9V73a9 9 0 0 1 9-9h30a9 9 0 0 1 9 9zm-168 57H32a32 32 0 0 0-32 32v288a32 32 0 0 0 32 32h384a32 32 0 0 0 32-32V192a32 32 0 0 0-32-32zM96 224a32 32 0 1 1-32 32 32 32 0 0 1 32-32zm288 224H64v-32l64-64 32 32 128-128 96 96z"/></svg>
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
<svg xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 0 384 512"><path d="M369.9 97.9L286 14C277 5 264.8-.1 252.1-.1H48C21.5 0 0 21.5 0 48v416c0 26.5 21.5 48 48 48h288c26.5 0 48-21.5 48-48V131.9c0-12.7-5.1-25-14.1-34zM332.1 128H256V51.9l76.1 76.1zM48 464V48h160v104c0 13.3 10.7 24 24 24h104v288H48zm250.2-143.7c-12.2-12-47-8.7-64.4-6.5-17.2-10.5-28.7-25-36.8-46.3 3.9-16.1 10.1-40.6 5.4-56-4.2-26.2-37.8-23.6-42.6-5.9-4.4 16.1-.4 38.5 7 67.1-10 23.9-24.9 56-35.4 74.4-20 10.3-47 26.2-51 46.2-3.3 15.8 26 55.2 76.1-31.2 22.4-7.4 46.8-16.5 68.4-20.1 18.9 10.2 41 17 55.8 17 25.5 0 28-28.2 17.5-38.7zm-198.1 77.8c5.1-13.7 24.5-29.5 30.4-35-19 30.3-30.4 35.7-30.4 35zm81.6-190.6c7.4 0 6.7 32.1 1.8 40.8-4.4-13.9-4.3-40.8-1.8-40.8zm-24.4 136.6c9.7-16.9 18-37 24.7-54.7 8.3 15.1 18.9 27.2 30.1 35.5-20.8 4.3-38.9 13.1-54.8 19.2zm131.6-5s-5 6-37.3-7.8c35.1-2.6 40.9 5.4 37.3 7.8z"/></svg>
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M19 13h-6v6h-2v-6H5v-2h6V5h2v6h6v2z"/><path d="M0 0h24v24H0z" fill="none"/></svg>
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
<svg xmlns="http://www.w3.org/2000/svg" height="24" width="24" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0V0z"/><path d="M4 10v7h3v-7H4zm6 0v7h3v-7h-3zM2 22h19v-3H2v3zm14-12v7h3v-7h-3zm-4.5-9L2 6v2h19V6l-9.5-5z"/></svg>
|
|
@@ -1,10 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
//= require arclight/oembed_viewer
|
|
6
|
-
//= require arclight/search_results
|
|
7
|
-
//= require arclight/truncator
|
|
8
|
-
|
|
9
|
-
// Vendor Scripts
|
|
10
|
-
//= require responsiveTruncator
|
|
1
|
+
import Truncate from 'arclight/truncate_controller'
|
|
2
|
+
Stimulus.register('arclight-truncate', Truncate)
|
|
3
|
+
import Oembed from 'arclight/oembed_controller'
|
|
4
|
+
Stimulus.register('arclight-oembed', Oembed)
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
import { Controller } from '@hotwired/stimulus'
|
|
2
|
+
|
|
3
|
+
export default class OembedController extends Controller {
|
|
4
|
+
static values = {
|
|
5
|
+
url: String
|
|
6
|
+
}
|
|
7
|
+
|
|
8
|
+
connect() {
|
|
9
|
+
const loadedAttr = this.element.getAttribute('loaded')
|
|
10
|
+
|
|
11
|
+
if (loadedAttr && loadedAttr === 'loaded') {
|
|
12
|
+
return
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
fetch(this.urlValue)
|
|
16
|
+
.then((response) => {
|
|
17
|
+
if (response.ok) return response.text()
|
|
18
|
+
throw new Error(`HTTP error, status = ${response.status}`)
|
|
19
|
+
})
|
|
20
|
+
.then((body) => {
|
|
21
|
+
const oEmbedEndPoint = this.findOEmbedEndPoint(body)
|
|
22
|
+
if (!oEmbedEndPoint || oEmbedEndPoint.length === 0) {
|
|
23
|
+
console.warn(`No oEmbed endpoint found in <head> at ${this.urlValue}`)
|
|
24
|
+
return
|
|
25
|
+
}
|
|
26
|
+
this.loadEndPoint(oEmbedEndPoint)
|
|
27
|
+
}).catch(error => {
|
|
28
|
+
console.error(error)
|
|
29
|
+
})
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
// We are choosing not to make this class static so that downstream classes
|
|
33
|
+
// can override it and access values to populate extraParams.
|
|
34
|
+
// E.g. https://github.com/sul-dlss/vt-arclight/blob/main/app/javascript/controllers/sul_embed_controller.js
|
|
35
|
+
findOEmbedEndPoint(body, extraParams = {}) { // eslint-disable-line class-methods-use-this
|
|
36
|
+
// Parse out link elements so image assets are not loaded
|
|
37
|
+
const template = document.createElement('template')
|
|
38
|
+
template.innerHTML = body.match(/<link .*>/g).join('')
|
|
39
|
+
|
|
40
|
+
// Look for a link element containing the oEmbed endpoint; bail out if none
|
|
41
|
+
const endpoint = template.content.querySelector('link[rel="alternate"][type="application/json+oembed"]')
|
|
42
|
+
?.getAttribute('href')
|
|
43
|
+
if (!endpoint) return ''
|
|
44
|
+
|
|
45
|
+
// Serialize any extra params and append them to the endpoint
|
|
46
|
+
const qs = new URLSearchParams(extraParams).toString()
|
|
47
|
+
return `${endpoint}&${qs}`
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
loadEndPoint(oEmbedEndPoint) {
|
|
51
|
+
fetch(oEmbedEndPoint)
|
|
52
|
+
.then((response) => response.json())
|
|
53
|
+
.then((json) => {
|
|
54
|
+
this.element.innerHTML = json.html
|
|
55
|
+
this.element.setAttribute('loaded', 'loaded')
|
|
56
|
+
})
|
|
57
|
+
}
|
|
58
|
+
}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { Controller } from '@hotwired/stimulus'
|
|
2
|
+
|
|
3
|
+
export default class extends Controller {
|
|
4
|
+
static targets = ['content']
|
|
5
|
+
|
|
6
|
+
connect() {
|
|
7
|
+
// target elements
|
|
8
|
+
const contentInner = Array.from(this.contentTarget.children)
|
|
9
|
+
|
|
10
|
+
// calculate total scrollable inner height vs. observed outer height
|
|
11
|
+
const outerHeight = this.contentTarget.clientHeight
|
|
12
|
+
const innerHeight = contentInner.map(e => e.scrollHeight).reduce((a, b) => a + b, 0)
|
|
13
|
+
|
|
14
|
+
// truncation occurred if total inner height exceeds outer (observed) height.
|
|
15
|
+
// if no longer truncated, reset the expanded state (e.g. on window resize).
|
|
16
|
+
if (innerHeight > outerHeight) {
|
|
17
|
+
this.element.classList.add('truncated')
|
|
18
|
+
} else {
|
|
19
|
+
this.element.classList.remove('truncated')
|
|
20
|
+
this.contentTarget.classList.remove('expanded')
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
trigger() {
|
|
25
|
+
this.element.classList.toggle('expanded')
|
|
26
|
+
}
|
|
27
|
+
}
|
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
@import 'bootstrap/functions';
|
|
2
|
-
@import 'bootstrap/variables';
|
|
3
|
-
@import 'bootstrap_overrides';
|
|
4
1
|
@import 'variables';
|
|
2
|
+
@import 'responsive';
|
|
5
3
|
@import 'modules/collection_search';
|
|
6
4
|
@import 'modules/highlights';
|
|
7
5
|
@import 'modules/hierarchy_and_online_contents';
|
|
6
|
+
@import 'modules/icons';
|
|
8
7
|
@import 'modules/layout';
|
|
9
8
|
@import 'modules/mastheads';
|
|
10
9
|
@import 'modules/repositories.scss';
|
|
11
10
|
@import 'modules/repository_card.scss';
|
|
12
11
|
@import 'modules/search_results';
|
|
13
12
|
@import 'modules/show_collection';
|
|
14
|
-
@import 'modules/
|
|
13
|
+
@import 'modules/truncator';
|
|
14
|
+
@import 'modules/search_form';
|