jekyll-waxify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 06235b80d0b3b3c71a6cd10496561a8823bad187f02465bf4d68f0b738d7c365
+  data.tar.gz: d4c1e2990721bdd4745ca6b9390174f00f6c388ab613c7258bd9642a8cafc2aa
+SHA512:
+  metadata.gz: e86964907ec3836709da76b96896cbea01bfa9c48e544ca006efd9bf7fbdbf213094463a41510f0a0aee46528e59253d407fd115ff22e6295263dab0ccf3e5a1
+  data.tar.gz: c7360294b078d908bba5d8e82b13f3385f07940d0d5f0bc4cc689923720103bce766c588aab0ac7c1763f7512f05049af2a499830d7fbec947a9f44d360b4cd3

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.DS_Store
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+- Add Wax search configuration to Jekyll config
+- Enable import of images when adding a new collection
+- Add Wax to a configured Jekyll site safely
+
+## [0.1.0] - 2021-04-18
+
+### Added
+
+- Add Wax infrastructure to Jekyll site
+- Add Wax IIIF collection to Jekyll config and _data

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at peter.binkley@ualberta.ca. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in jekyll-waxify.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.7"
+
+gem "simplecov", "0.17.1", require: false

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Peter Binkley
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Peter Binkley
+
+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,82 @@
+# Jekyll::Waxify
+A gem-packaged Jekyll plugin that installs basic minicomp/wax components 
+
+This gem installs the simplest possible framework for [Wax](https://minicomp.github.io/wax) IIIF support in a Jekyll site. It is intended to be used in teaching, as well as to flatten the learning curve for those who are new to Wax.
+
+This is a work in progress. If you try it on an existing Jekyll site, be sure you have a recent backup.
+
+TODOs:
+
+- [ ] deploy to RubyGems
+- [x] provide scaffolding for Wax iiif images
+- [ ] enable import of images on collection creation
+- [x] refactoring
+- [ ] provide scaffolding for Wax indexing
+- [ ] test with mature Jekyll sites
+- [x] add specs
+
+A minimal demo site can be seen at [https://pbinkley.github.io/jekyll-waxify](https://pbinkley.github.io/jekyll-waxify). 
+
+## Installation
+
+In order to make the site compatible with Github Pages, use the github pages gem to manage the Jekyll version. In your Jekyll site's Gemfile, comment out the Jekyll line:
+
+```ruby
+# gem "jekyll", "~> 4.2.0"
+```
+
+And add these lines to the ```jekyll_plugins``` group:
+
+```ruby
+gem 'github-pages', '~> 213'
+gem 'jekyll-waxify', '0.1.0'
+```
+
+And add this section:
+
+```ruby
+group :development do
+  gem 'wax_tasks', '~> 1.1'
+end
+```
+
+And then execute:
+
+    $ bundle update
+
+## Usage
+
+You can then waxify your Jekyll site and create a Wax image collection:
+
+    $ bundle exec jekyll waxify <collection name>
+
+This creates all the scaffolding for your collection. To populate it, copy images into ```_data/raw_images/<collection name>/```, and edit the csv file ```_data/<collection name>.csv```: for each image add a row containing the file name (without extension) and a label. E.g. for a map image ```1234.tif``` the row should contain ```1234,Map of Paris```. 
+
+Now you can generate the Wax artefacts for your collection:
+
+    $ bundle exec rake wax:pages <collection name>
+    $ bundle exec rake wax:derivatives:iiif <collection name>
+
+And view the site in the normal Jekyll way:
+
+    $ bundle exec jekyll serve
+    
+The "Collections" link in the tab bar will take you to your new collection.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pbinkley/jekyll-waxify. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/pbinkley/jekyll-waxify/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Jekyll::Waxify project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/pbinkley/jekyll-waxify/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "jekyll/waxify"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jekyll-waxify.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/jekyll/waxify/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-waxify"
+  spec.version       = Jekyll::Waxify::VERSION
+  spec.authors       = ["Peter Binkley"]
+  spec.email         = ["peter.binkley@ualberta.ca"]
+  spec.summary       = "A Jekyll plugin that installs basic minicomp/wax components"
+  spec.description   = "A Jekyll plugin that installs basic minicomp/wax components"
+  spec.homepage      = "https://github.com/pbinkley/jekyll-waxify"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/pbinkley/jekyll-waxify"
+  spec.metadata["changelog_uri"] = "https://github.com/pbinkley/jekyll-waxify"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "deep_merge", "~> 1.2"
+  spec.add_runtime_dependency "github-pages", "~> 213"
+  spec.add_runtime_dependency "progress_bar", "~> 1.3"
+  spec.add_runtime_dependency "rainbow", "~> 3.0"
+  spec.add_runtime_dependency "rake", "~> 13.0"
+  spec.add_runtime_dependency "safe_yaml", "~> 1.0"
+
+  spec.add_development_dependency "bump", "~> 0.8"
+  spec.add_development_dependency "byebug", "~> 11"
+  spec.add_development_dependency "rspec", "~> 3"
+end

data/lib/jekyll/commands/waxify.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Add wax components to a Jekyll site
+module Jekyll
+  # Commands
+  module Commands
+    # Waxify
+    class WaxifyCommand < Command
+      def self.init_with_program(prog)
+        prog.command(:waxify) do |c|
+          c.syntax "waxify [coll]"
+          c.description "Add Wax components"
+
+          c.action { |args, options| process(args, options) }
+        end
+      end
+
+      def self.process(args = [], _options = [])
+        coll = args[0]
+
+        jekyll_config = Waxify::JekyllConfig.new(Jekyll::Waxify::WAXIFY_FRAMEWORK, Jekyll::Waxify::JEKYLL_DIR)
+
+        return if jekyll_config.waxified
+
+        jekyll_config.add_cors
+        jekyll_config.add_collection(coll)
+        jekyll_config.merge
+        jekyll_config.save
+        jekyll_config.deploy_framework
+      end
+    end
+  end
+end

data/lib/jekyll/waxify.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "jekyll/waxify/version"
+require "jekyll/waxify/jekyll_config"
+
+module Jekyll
+  module Waxify
+      WAXIFY_FRAMEWORK = File.join(File.dirname(File.expand_path(__FILE__)),
+                                       "../../wax-framework/.")
+      JEKYLL_DIR = Dir.pwd
+  end
+end
+
+require "jekyll/commands/waxify.rb"

data/lib/jekyll/waxify/jekyll_config.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require "deep_merge"
+require "yaml"
+
+module Jekyll
+  module Waxify
+    # JekyllConfig: represents _config.yml in text and yaml
+    class JekyllConfig
+      attr_reader :yaml, :text, :new_config, :jekyll_dir
+
+      def initialize(framework_dir, jekyll_dir, new_config = {}, config_file = "_config.yml")
+        @framework_dir = framework_dir
+        @jekyll_dir = jekyll_dir
+        @config_file = config_file
+        @text = File.read("#{@jekyll_dir}/#{@config_file}")
+        @yaml = YAML.safe_load(@text)
+        @new_config = new_config
+      end
+
+      def waxified
+        @yaml["waxified"]
+      end
+
+      def deploy_framework
+        # copy framework documents to jekyll
+        FileUtils.cp_r @framework_dir, @jekyll_dir
+      end
+
+      def add(to_add)
+        @new_config.deep_merge! to_add
+      end
+
+      def add_cors
+        return if @yaml.dig("webrick", "header", "Access-Control-Allow-Origin")
+
+        # Add CORS stanza to _config.yml
+        add(
+          {
+            "webrick" => {
+              "header" => {
+                "Access-Control-Allow-Origin" => "*"
+              }
+            }
+          }
+        )
+      end
+
+      def add_collection(coll)
+        return unless coll
+
+        # Make coll images dir and metadata csv file
+        FileUtils.mkdir_p "#{@jekyll_dir}/_data/raw_images/#{coll}"
+        File.open("#{@jekyll_dir}/_data/#{coll}.csv", "w") { |file| file.write("pid,label\n") }
+
+        @yaml["collections"] ||= {}
+
+        return if @yaml.dig("collections", coll)
+
+        # Add coll to new config stanzas
+        add(
+          { "collections" => {
+            coll =>
+              {
+                "output" => true,
+                "layout" => "wax_item",
+                "metadata" => { "source" => "#{coll}.csv" },
+                "images" => { "source" => "raw_images/#{coll}" }
+              }
+          } }
+        )
+      end
+
+      def merge
+        @new_config["waxified"] = true
+
+        new_yaml = @new_config.to_yaml.sub("---\n", "")
+        
+        # collection block is terminated by EOF or a new key, i.e. a line 
+        # that begins a character other than whitespace or hash
+
+        groups = @text.match /(^collections:.*\n.+\n)(\Z|[^\s\#].*)/m
+
+        if groups.nil?
+          # there are no collections in initial yaml, so append new_yaml
+          @text += new_yaml
+        else
+          # merge collections from @new_config into collections
+          collections = YAML.safe_load(groups[1])
+          collections.deep_merge! @new_config
+
+          @text = groups.pre_match + collections.to_yaml.sub("---\n","") + groups[2]
+        end
+      end
+
+      def save
+        File.open(@config_file, "w") { |f| f.puts @text }
+      end
+    end
+  end
+end