wax_tasks 1.1.4 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8c25dc1366583fde027108991c23bb9ea21f20dd88d8341d1bcfeaafe3ec48c
-  data.tar.gz: 8f5e15e6278ca7879da49ba0c5d60dfbbc064fa572ce3593b92ffc5b706f0094
+  metadata.gz: 8fd8340a2ecff9fe1d3fa57fa2bbd0d70dfbf33584131d2056a8805ee36e1902
+  data.tar.gz: db4172c4bbd872c5f07e042149137eb321d0b3dd7862819a2cdb4e758c5ae87c
 SHA512:
-  metadata.gz: cdd850cd456911bc6f4630f8158866430fe930812b744a489ada634cb2fd0b8be317ccac862c574ea028026e4424043a05a0bdf8374d9dadab77f198ebfcad4c
-  data.tar.gz: 882d43181056533afe818d353915c0d4544908d747dc79b375ea9b068e70d05fea27648b89f3b22426b6bea868f9a7144e8709a346ab574fe2f0586766b81546
+  metadata.gz: 7f001ba8520a410f2601eb6386fd2fca430af7f8feea875497e589454472822a6ceecb8bf41711be8cdff89b45a63f82393da7354a98bd8e0a4392515de4ae65
+  data.tar.gz: abbec63cdc47318a45b9dc3eb74d9341f39f3aac2ba807879bb9008467f1f78c9b4033e2ec344367b54e88d1434717456a71f59fb181d16ac35a5e779f7a7b99

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,35 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: ci:test
+on:
+  pull_request:
+    paths-ignore:
+      - '**/README.md'
+  push:
+    paths-ignore:
+      - '**/README.md'
+
+jobs:
+   rspec:
+    runs-on: ubuntu-latest
+    steps:
+    - name: change imagemagick policy to allow pdf->png conversion.
+      run: |
+        sudo sed -i 's/^.*policy.*coder.*none.*PDF.*//' /etc/ImageMagick-6/policy.xml
+    - name: install ghostscript
+      run: sudo apt-get update && sudo apt-get install -y ghostscript
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 1
+    - uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+    - name: install
+      run: gem install bundler && bundle
+    - name: check for outdated gems
+      run: bundle outdated
+    - name: test
+      run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+Gemfile.lock
+coverage
+test_build
+doc
+.yardoc
+DIANE

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7
+  Exclude: ['spec/**/*', 'test_build/**/*']
+Layout/LineLength:
+  IgnoredPatterns: ['raise', 'puts', 'set', 'warn', 'ÈÉÊË', 'EEEE', 'safe_join', 'spec']
+Metrics/AbcSize:
+  Max: 28
+Metrics/MethodLength:
+  Max: 15
+Layout/EmptyComment:
+  Enabled: false
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+Style/SingleArgumentDig:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.7.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+gemspec
+
+# dev/test utilities
+gem 'bundle-audit', require: false
+gem 'diane', require: false
+gem 'rubocop', require: false
+gem 'simplecov', require: false
+gem 'yard', require: false

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 marii nyrop
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,171 @@
+# wax_tasks 🐝
+[![ci:test](https://github.com/minicomp/wax_tasks/actions/workflows/ci.yml/badge.svg)](https://github.com/minicomp/wax_tasks/actions/workflows/ci.yml) [![Depfu](https://badges.depfu.com/badges/6105c55b9634e74b1c27055b19bad8f0/overview.svg)](https://depfu.com/github/minicomp/wax_tasks?project_id=10548)
+[![Gem Version](https://badge.fury.io/rb/wax_tasks.svg)](https://badge.fury.io/rb/wax_tasks)
+[![Gem Downloads](https://img.shields.io/gem/dt/wax_tasks.svg?color=046d0b)](https://badge.fury.io/rb/wax_tasks)
+[![docs](http://img.shields.io/badge/docs-rdoc.info-blue.svg?style=flat)](https://www.rubydoc.info/github/minicomp/wax_tasks/)
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/14408e7e962b9b84ec65/maintainability)](https://codeclimate.com/github/minicomp/wax_tasks/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/14408e7e962b9b84ec65/test_coverage)](https://codeclimate.com/github/minicomp/wax_tasks/test_coverage)
+![License](https://img.shields.io/github/license/minicomp/wax_tasks.svg?color=c6a1e0)
+
+__wax_tasks__ is gem-packaged set of [Rake](https://ruby.github.io/rake/) tasks for creating minimal exhibition sites with [Wax](https://github.com/minicomp/wax/).
+
+It can be used to:
+- generate collection markdown pages from a metadata file ([wax:pages](#waxpages))
+- generate a client-side search index ([wax:search](#waxsearch))
+- generate either IIIF-compliant derivatives ([wax:derivatives:iiif](#waxderivativesiiif)) or simple image derivatives ([wax:derivatives:simple](#waxderivativessimple)) from local image and pdf files
+
+<br>
+<img src="https://raw.githubusercontent.com/minicomp/wiki/main/src/assets/wax_screen.gif?raw=true?raw=true"/>
+
+
+# Getting Started
+
+## Prerequisites
+
+You'll need `Ruby >= 2.4` with `bundler` installed. Check your versions with:
+```bash
+$ ruby -v
+  ruby 2.7.2p137 (2020-10-01 revision 5445e04352) [x86_64-darwin18]
+
+$ bundler -v
+  Bundler version 1.16.1
+```
+
+To use the image derivative tasks, you will also need to have ImageMagick and Ghostscript installed and functional. You can check to see if you have ImageMagick by running:
+```bash
+$ convert -version
+  Version: ImageMagick 6.9.9-20 Q16 x86_64 2017-10-15 http://www.imagemagick.org
+  Copyright: (c) 1999-2017 ImageMagick Studio LLC
+  License: http://www.imagemagick.org/script/license.php
+  Features: Cipher DPC Modules
+  Delegates (built-in): bzlib freetype jng jpeg ltdl lzma png tiff xml zlib
+```
+
+... and check Ghostscript with:
+```bash
+$ gs -version
+  GPL Ghostscript 9.21 (2017-03-16)
+  Copyright (C) 2017 Artifex Software, Inc.  All rights reserved.
+```
+
+Next, you'll need a Jekyll site. You can clone the [minicomp/wax demo site](https://github.com/minicomp/wax/) or start a site from scratch with:
+
+```sh
+$ gem install jekyll
+$ jekyll new wax && cd wax
+```
+
+## Installation
+
+Add `wax_tasks` to your Jekyll site's `Gemfile`:
+
+```ruby
+gem 'wax_tasks'
+```
+
+... and install with bundler:
+
+```bash
+$ bundle install
+```
+
+Create a `Rakefile` with the following:
+```ruby
+spec = Gem::Specification.find_by_name 'wax_tasks'
+Dir.glob("#{spec.gem_dir}/lib/tasks/*.rake").each { |r| load r }
+```
+
+# Usage
+
+After following the installation instructions above, you will have access to the Rake tasks in your shell by running `$ bundle exec rake wax:taskname` in the root directory of your Jekyll site.
+To see the available tasks, run
+
+```ruby
+$ bundle exec rake --tasks
+```
+
+## Sample site `_config.yml` file:
+
+```yaml
+# basic settings
+title: Wax.
+description: a jekyll theme for minimal exhibitions
+url: 'https://minicomp.github.io'
+baseurl: '/wax'
+
+# build settings
+permalink: pretty # optional, creates `/page/` link instead of `page.html` links
+
+# wax collection settings
+collections:
+  objects: # the collection name
+    layout: 'iiif-image-page'
+    output: true # this must be true for your .md pages to be built to html!
+    metadata:
+      source: 'objects.csv' # path to the metadata file, must be within '_data'
+    images:
+      source 'source_images/objects' # path to the directory of source images, must be within '_data'
+
+# wax search index settings
+search:
+  main:
+    index: 'js/lunr-index.json' # where the index will be generated
+    collections: # the collections to index
+      objects:
+        content: false # whether or not to index the markdown page content (below the YAML)
+        fields: # the metadata fields to index
+          - 'label'
+          - 'artist'
+          - 'location'
+          - 'object_type'
+```
+
+The above example includes a single collection `objects` that comprises:
+1. a CSV `metadata:source` file (`objects.csv`), and
+2. a `images:source` directory of image and pdf files.
+
+For more information on configuring Jekyll collections for __wax_tasks__, check out the [minicomp/wax wiki](https://minicomp.github.io/wiki/#/wax/) and <https://jekyllrb.com/docs/collections/>.
+
+## Running the tasks
+
+### wax:pages
+
+Takes a CSV, JSON, or YAML file of collection metadata and generates a [markdown](https://daringfireball.net/projects/markdown/syntax) page for each record to a directory using a specified layout. [Read More](#TODO).
+
+`$ bundle exec rake wax:pages collection-name`
+
+### wax:search
+
+Generates a client-side JSON search index of your site for use with [ElasticLunr.js](http://elasticlunr.com/). [Read More](#TODO).
+
+`$ bundle exec rake wax:search search-name`
+
+
+### wax:derivatives:simple
+
+Takes a local directory of images and pdf files and generates a few image derivatives (i.e., 'thumbnail' 250w and 'full' 1140w) for Jekyll layouts and includes to use. [Read More](#TODO).
+
+`$ bundle exec rake wax:derivatives:iiif collection-name`
+
+### wax:derivatives:iiif
+
+Takes a local directory of images and pdf files and generates tiles and data that work with a IIIF compliant image viewer like [OpenSeaDragon](https://openseadragon.github.io/), [Mirador](http://projectmirador.org/), or [Leaflet IIIF](https://github.com/mejackreed/Leaflet-IIIF). [Read More](#TODO).
+
+`$ bundle exec rake wax:derivatives:iiif collection-name`
+
+### wax:clobber
+
+Destroys (or "clobbers") wax-generated files, i.e., pages generated from `wax:pagemaster`, derivatives generated from `wax:derivatives`, and search indexes generated with `wax:search` so you can start from scratch.
+
+This task does *not* touch your source metadata or source image files! Instead, it simply clears a path for you to regenerate your collection materials in case you add/edit source materials.
+
+`$ bundle exec rake wax:clobber collection-name`
+
+# Contributing
+
+Fork/clone the repository. After making code changes, run the tests (`$ bundle exec rubocop` and `$ bundle exec rspec`) before submitting a pull request. You can enable verbose tests with `$ DEBUG=true bundle exec rspec`.
+
+# License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE).

data/lib/tasks/clobber.rake

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'wax_tasks'
+
+namespace :wax do
+  desc 'destroy wax-generated collection files, including pages, derivatives, and search index(es)'
+  task :clobber do
+    args = ARGV.drop(1).each { |a| task a.to_sym }
+    args.reject! { |a| a.start_with? '-' }
+
+    raise WaxTasks::Error::MissingArguments, Rainbow("You must specify a collection after 'wax:clobber'").magenta if args.empty?
+
+    site = WaxTasks::Site.new
+    args.each { |a| site.clobber a }
+  end
+end

data/lib/tasks/derivatives_iiif.rake

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'wax_tasks'
+
+namespace :wax do
+  namespace :derivatives do
+    desc 'generate iiif derivatives from local image files'
+    task :iiif do
+      args = ARGV.drop(1).each { |a| task a.to_sym }
+      args.reject! { |a| a.start_with? '-' }
+
+      raise WaxTasks::Error::MissingArguments, Rainbow("You must specify a collection after 'wax:derivatives:iiif'").magenta if args.empty?
+
+      site = WaxTasks::Site.new
+      args.each { |a| site.generate_derivatives(a, 'iiif') }
+    end
+  end
+
+  # alias wax:iiif to wax:derivatives:iiif for backwards compatibility
+  task :iiif do
+    t = Rake::Task['wax:derivatives:iiif']
+    desc t.full_comment if t.full_comment
+    arguments = ARGV.drop(1).each { |a| task a.to_sym }
+    t.invoke(*arguments)
+  end
+end