wax_tasks 1.0.0.pre.beta → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6df6c21281405044f2958da14b8eda608a4a265337f684c1371612817468767a
-  data.tar.gz: f1a7248a2b83fa1cf34cfd15580baecdefdd91601c7328b987d9ac247316e154
+  metadata.gz: 0d6b199887d4f473d837b2115169191e7ba1761b6402715ef2ef5dc390f0a7e9
+  data.tar.gz: 3518140ad547ab96d258ce5de5ee9f8bac47dab868409318c7036a89bc85f3fa
 SHA512:
-  metadata.gz: 2a2c5464d13a57208f0c79bbf44a4355b6fad5efd3d2e511ad30ce7a0b4075321868a906a70b680b76ced742d5394fb758a746aff42f0601ea9137ad774dd448
-  data.tar.gz: 87e84935bcda6fcc92bab5a5fecc7b8fec29d19e3348b6b1f0404dd3b6e47595b778a1b7a25562e0ce7b5c187c700be7c9c20a728bc7adbf98284bba26e7b691
+  metadata.gz: ba2e755b8068a428edcb8b57ad727bef86108fa5ba6c651ff3191b521e3a71b4d5a2d9a55a8036efa3b27cbae97a03acdacff29fbfc459033af2b287fb018d52
+  data.tar.gz: 53fe1a0275839addf3b0d98b58ab02982c52885d3d2029a6c2424364b38f17e68ef426bd02449d9900d6dc30ce2f19b9cff577250470fa2ce3edfc9336cec15a

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/.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.4
+  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/.travis.yml

@@ -0,0 +1,27 @@
+# sudo: true
+language: ruby
+rvm:
+  - 2.4
+  - 2.5
+  - 2.6
+addons:
+  apt:
+    packages:
+      - ghostscript
+      - tree
+env:
+  global:
+    - CC_TEST_REPORTER_ID=9ef8644063d4113becf719844a0f9c0f8a452f87d69a8315c6fb090123e52cc8
+before_install:
+  - gem update --system
+  - gem install bundler
+  - sudo rm /etc/ImageMagick-6/policy.xml
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec bundle-audit
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CHANGELOG.md

@@ -0,0 +1,42 @@
+# Changelog
+
+Welcome to the Changelog! Below is the first attempt at a log for this project.  
+
+Please note that we define ___breaking changes___ as those changes which force users to change how they interact with __wax_tasks__
+via their site's `_config.yml` file or how they invoke the tasks on the command line.
+
+## v1.0.3
+#### Date: ???
+
+#### Non-breaking Changes:
+- :white_check_mark: Allows use of `wax_iiif < 0.3` (was `<0.2`)
+- :white_check_mark: Fix bug where command options (e.g., `--trace`) were being parsed as task ARGV args.
+
+## v1.0.2
+#### Date: 06/12/2019
+
+#### Non-breaking Changes:
+- :white_check_mark: Fixes [32](https://github.com/minicomp/wax_tasks/issues/32); accepts narrow images (< 1140px)
+- :white_check_mark: Fixes [33](https://github.com/minicomp/wax_tasks/issues/33); better image extension handling
+- :white_check_mark: Fixes [34](https://github.com/minicomp/wax_tasks/issues/34); ^
+- :white_check_mark: Fixes [36](https://github.com/minicomp/wax_tasks/issues/36); fixes bug if an image item doesn't have a record
+
+## v1.0.1
+#### Date: 06/05/2019
+
+#### Non-breaking Changes:
+- :white_check_mark: Uses `wax_iiif v0.1.2` with better progress bar handling on IIIF derivative generation
+- :white_check_mark: Has better progress bar handling on simple derivative generation
+
+## v1.0.0
+#### Date: 06/04/2019
+
+#### Breaking Changes:
+- :bangbang: __Search index generation__ is now handled under the variable `search` in `_config.yml` instead of `lunr_index` and accepts a hash instead of an array.
+- :bangbang: __Search index generation__ is now run with `bundle exec rake wax:search NAME` instead of `bundle exec rake wax:lunr`
+- :x: __Search UI__ is now handled dynamically by `wax_theme`; as such the `UI=true` option on the rake task has been depricated.
+- :x:: The __site testing__ task `bundle exec rake wax:test` was deprecated and moved to `wax_theme`, since it deals with site presentation and not the handling of collection data.
+- :x: The `wax:jspackage` task was depricated, since it was arbitrary and unused.
+
+#### Non-breaking Changes:
+- :white_check_mark: The __page generation__ task `bundle exec rake wax:pagemaster NAME` has become `bundle exec rake wax:pages NAME`. However, this is currently aliased for backwards compatibility.

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

@@ -1,8 +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', '0.59.0', require: false
-gem 'simplecov', require: false
+gem 'rubocop', require: false
+gem 'simplecov', '0.17.1', 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 🐝
+[![Build Status](https://travis-ci.com/minicomp/wax_tasks.svg?branch=main)](https://travis-ci.com/minicomp/wax_tasks) [![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://github.com/minicomp/wiki/blob/main/assets/wax_screen.gif?raw=true"/>
+
+
+# Getting Started
+
+## Prerequisites
+
+You'll need `Ruby >= 2.4` with `bundler` installed. Check your versions with:
+```bash
+$ ruby -v
+  ruby 2.4.2p198 (2017-09-14 revision 59899) [x86_64-darwin15]
+
+$ 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
+lunr_index:
+  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).