wax_tasks 0.0.46 → 0.0.47

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08373f20a96f8beb7d8da2f0080874f53434ca22946e978f1810341f8b0d0789'
-  data.tar.gz: d519743109cc40019c40b2ff0cb53165c9f35e7b8e37ba3bf849a64b240157bc
+  metadata.gz: 2eb86783ae6e09758e23af201aad5907f68d0f7ee0034d46bd168830264d9a74
+  data.tar.gz: a1261162881c112780ff5d342cc265389b2bffdc121952d123b1176f36dc31ac
 SHA512:
-  metadata.gz: 336d3b60f04a17515e95d55d2787ef8243b9bdbbc634ff52ede4e64745269e54149995e7df8bf586a035c074136c195c3d5484a0052028a20d1b0a19fb872150
-  data.tar.gz: 7576e0dd98d98ef35b3b89c1908969553e9edd0905d06f92610e16bd5ee886d569e6ede8e0e4f1eb92cd9c0cf69e59834d88123a6294ed6538d68a9a42b72127
+  metadata.gz: c6c7e4e7874f80c9073b51865ab46f1c39d01cc3993531df218d17f87badb2d242a36aa9346a7a7e237c664ccf9bfb6b95f180fd92f0ee230486eafc7e6058d4
+  data.tar.gz: ce6b90ea4d1cbf605e162a797c62d2aee01d15eeffdc980989661f9c68f746d1fe35064abd00c3fe70649520391630d41a8ae76a90899be66bdc0e1cd40ef375

data/lib/modules/iiif.rb

@@ -0,0 +1,49 @@
+require 'json'
+require 'wax_iiif'
+
+# module for generating IIIF derivatives + json from local images
+module Iiif
+  include FileUtils
+
+  def self.ingest_collections(args, site_config)
+    mkdir_p('./iiif', :verbose => false)
+    all_records = []
+    id_counter = 0
+    build_opts = Iiif.build_options(site_config)
+    args.each do |a|
+      id_counter += 1
+      inpath = './_data/iiif/' + a
+      abort "Source path '#{inpath}' does not exist. Exiting.".magenta unless Dir.exist?(inpath)
+      collection_records = make_records(a, inpath)
+      all_records.concat collection_records
+    end
+    builder = IiifS3::Builder.new(build_opts)
+    builder.load(all_records)
+    builder.process_data
+  end
+
+  def self.build_options(site_config)
+    {
+      :base_url => site_config['baseurl'] + '/iiif',
+      :output_dir => './iiif',
+      :verbose => true
+    }
+  end
+
+  def self.make_records(arg, inpath)
+    counter = 1
+    records = []
+    imagefiles = Dir[inpath + '/*'].sort!
+    imagefiles.each do |imagefile|
+      basename = File.basename(imagefile, '.*').to_s
+      record_opts = {
+        :id => arg + '-' + basename,
+        :path => imagefile,
+        :label => arg + ' - ' + basename
+      }
+      counter += 1
+      records << IiifS3::ImageRecord.new(record_opts)
+    end
+    records
+  end
+end

data/lib/modules/lunr.rb

@@ -0,0 +1,107 @@
+include FileUtils
+require 'json'
+
+# module for generating elasticlunr index and default jquery ui
+module Lunr
+  def self.total_fields(collections)
+    total_fields = ['pid']
+    collections.each do |c|
+      total_fields = total_fields.concat(c[1]['lunr_index']['fields'])
+      total_fields << 'content' if c[1]['lunr_index']['content']
+    end
+    total_fields.uniq
+  end
+
+  def self.collections(site_config)
+    site_config['collections'].find_all { |c| c[1].key?('lunr_index') && c[1]['lunr_index'].key?('fields') }
+  end
+
+  def self.index(cdir, collections)
+    index = []
+    count = 0
+    abort 'There are no valid collections to index.'.magenta if collections.nil?
+
+    collections.each do |c|
+      dir = cdir + '_' + c[0]
+      fields = c[1]['lunr_index']['fields'].uniq
+      pages = Dir.glob(dir + '/*.md')
+      get_content = c[1]['lunr_index']['content']
+      # catch
+      abort "There are no markdown pages in directory '#{dir}'".magenta if pages.empty?
+      abort "There are no fields specified for #{c[0]}.".magenta if fields.empty?
+      puts "Loading #{pages.length} pages from #{dir}"
+      # index each page in collection
+      pages.each do |page|
+        index << page_hash(page, fields, get_content, count)
+        count += 1
+      end
+    end
+    JSON.pretty_generate(index)
+  end
+
+  def self.page_hash(page, fields, get_content, count)
+    yaml = YAML.load_file(page)
+    hash = {
+      'lunr_id' => count,
+      'link' => "{{'" + yaml.fetch('permalink') + "' | relative_url }}"
+    }
+    fields.each { |f| hash[f] = rm_diacritics(thing2string(yaml[f])) }
+    hash['content'] = rm_diacritics(clean(File.read(page))) if get_content
+    hash
+  end
+
+  def self.ui(total_fields)
+    # set up index
+    ui_string = "$.getJSON(\"{{ site.baseurl }}/js/lunr-index.json\", function(index_json) {\nwindow.index = new elasticlunr.Index;\nwindow.store = index_json;\nindex.saveDocument(false);\nindex.setRef('lunr_id');"
+    # add fields to index
+    total_fields.each { |field| ui_string += "\nindex.addField('#{field}');" }
+    # add docs
+    ui_string += "\n// add docs\nfor (i in store){index.addDoc(store[i]);}"
+    # gui
+    ui_string += "\n$('input#search').on('keyup', function() {\nvar results_div = $('#results');\nvar query = $(this).val();\nvar results = index.search(query, { boolean: 'AND', expand: true });\nresults_div.empty();\nif (results.length > 10) {\nresults_div.prepend(\"<p><small>Displaying 10 of \" + results.length + \" results.</small></p>\");\n}\nfor (var r in results.slice(0, 9)) {\nvar ref = results[r].ref;\nvar item = store[ref];"
+    # add fields as display vars
+    total_fields.each { |field| ui_string += "var #{field} = item.#{field};\n" }
+    ui_string += "var result = '<div class=\"result\"><b><a href=\"' + item.link + '\">' + title + '</a></b></p></div>';\nresults_div.append(result);\n}\n});\n});"
+    ui_string
+  end
+
+  def self.write_index(index)
+    mkdir_p('js')
+    index = "---\nlayout: none\n---\n" + index
+    path = 'js/lunr-index.json'
+    File.open(path, 'w') { |file| file.write(index) }
+    puts "Writing lunr index to #{path}".cyan
+  end
+
+  def self.write_ui(ui)
+    ui = "---\nlayout: none\n---\n" + ui
+    path = 'js/lunr-ui.js'
+    if File.exist?(path)
+      puts "Lunr UI already exists at #{path}. Skipping".cyan
+    else
+      File.open(path, 'w') { |file| file.write(ui) }
+      puts "Writing lunr ui to #{path}".cyan
+    end
+  end
+
+  def self.clean(str)
+    str.gsub!(/\A---(.|\n)*?---/, '') # remove yaml front matter
+    str.gsub!(/{%(.*)%}/, '') # remove functional liquid
+    str.gsub!(/<\/?[^>]*>/, '') # remove html
+    str.gsub!('\\n', '') # remove newlines
+    str.gsub!(/\s+/, ' ') # remove extra space
+    str.tr!('"', "'") # replace double quotes with single
+    str
+  end
+
+  def self.rm_diacritics(str)
+    to_replace  = 'ÀÁÂÃÄÅàáâãäåĀāĂ㥹ÇçĆćĈĉĊċČčÐðĎďĐđÈÉÊËèéêëĒēĔĕĖėĘęĚěĜĝĞğĠġĢģĤĥĦħÌÍÎÏìíîïĨĩĪīĬĭĮįİıĴĵĶķĸĹĺĻļĽľĿŀŁłÑñŃńŅņŇňʼnŊŋÒÓÔÕÖØòóôõöøŌōŎŏŐőŔŕŖŗŘřŚśŜŝŞşŠšſŢţŤťŦŧÙÚÛÜùúûüŨũŪūŬŭŮůŰűŲųŴŵÝýÿŶŷŸŹźŻżŽž'
+    replaced_by = 'AAAAAAaaaaaaAaAaAaCcCcCcCcCcDdDdDdEEEEeeeeEeEeEeEeEeGgGgGgGgHhHhIIIIiiiiIiIiIiIiIiJjKkkLlLlLlLlLlNnNnNnNnnNnOOOOOOooooooOoOoOoRrRrRrSsSsSsSssTtTtTtUUUUuuuuUuUuUuUuUuUuWwYyyYyYZzZzZz'
+    str.tr(to_replace, replaced_by)
+  end
+
+  def self.thing2string(thing)
+    thing = thing.join(' || ') if thing.is_a?(Array)
+    thing.to_s
+  end
+end

data/lib/modules/pagemaster.rb

@@ -0,0 +1,68 @@
+require 'json'
+require 'yaml'
+require 'csv'
+
+# module for generating markdown collection pages from csv/json/yaml records
+module Pagemaster
+  include FileUtils
+
+  def self.valid_config(name, site_config)
+    abort "Cannot find #{name} in _config.yml. Exiting.".magenta unless site_config['collections'].key?(name)
+    collection_config = site_config['collections'][name]
+    abort "Cannot find source for '#{name}'. Exiting.".magenta unless collection_config['source']
+    abort "Cannot find layout for '#{name}'. Exiting.".magenta unless collection_config['layout']
+    abort "Cannot find the file _data/#{collection_config['source']}.".magenta unless File.file?('_data/' + collection_config['source'])
+    collection_config
+  end
+
+  def self.ingest(src)
+    src = "_data/#{src}"
+    case File.extname(src)
+    when '.csv' then data = CSV.read(src, :headers => true, :encoding => 'utf-8').map(&:to_hash)
+    when '.json' then data = JSON.parse(File.read(src))
+    when '.yml' then data = YAML.load_file(src)
+    else abort "File type for #{src} must be .csv, .json, or .yml. Please fix and rerun."
+    end
+    puts "Processing #{src}...."
+    detect_duplicates(data)
+    data
+  rescue StandardError
+    puts "Cannot load #{src}. check for typos and rebuild.".magenta
+  end
+
+  def self.generate_pages(data, name, layout, cdir, order, perma)
+    dir = cdir + '_' + name
+    mkdir_p(dir)
+    completed = 0
+    skipped = 0
+    data.each_with_index do |item, index|
+      pagename = WaxTasks.slug(item.fetch('pid'))
+      pagepath = dir + '/' + pagename + '.md'
+      if File.exist?(pagepath)
+        puts "#{pagename}.md already exits. Skipping."
+        skipped += 1
+      else
+        item['permalink'] = '/' + name + '/' + pagename + perma
+        item['layout'] = layout
+        item['order'] = padded_int(index, data.length) if order
+        File.open(pagepath, 'w') { |f| f.write(item.to_yaml.to_s + '---') }
+        completed += 1
+      end
+    end
+    puts "\n#{completed} pages were generated to #{dir} directory.".cyan
+    puts "\n#{skipped} pre-existing items were skipped.".cyan
+  rescue StandardError
+    abort "#{completed} pages were generated before failure, most likely a record is missing a valid 'pid' value.".magenta
+  end
+
+  def self.detect_duplicates(data)
+    pids = []
+    data.each { |d| pids << d['pid'] }
+    duplicates = pids.detect { |p| pids.count(p) > 1 } || []
+    abort "\nYour collection has the following duplicate pids: \n#{duplicates}".magenta unless duplicates.empty?
+  end
+
+  def self.padded_int(index, max_idx)
+    index.to_s.rjust(Math.log10(max_idx).to_i + 1, '0')
+  end
+end

data/lib/tasks/iiif.rake

@@ -4,53 +4,9 @@ require 'wax_iiif'
 
 namespace :wax do
   task :iiif do
-    config = read_config
-    argv = read_argv
-
-    abort "You must specify a collections after 'bundle exec rake wax:iiif'.".magenta if argv.empty?
-
-    mkdir_p('./iiif')
-
-    all_records = []
-    id_counter = 0
-    build_opts = build_options(config)
-
-    argv.each do |a|
-      id_counter += 1
-      inpath = './_data/iiif/' + a
-      abort "Source path '#{inpath}' does not exist. Exiting.".magenta unless Dir.exist?(inpath)
-      paged = config['collections'][a]['iiif_paged'] == true
-      collection_records = make_records(a, inpath, paged, config)
-      all_records.concat collection_records
-    end
-    builder = IiifS3::Builder.new(build_opts)
-    builder.load(all_records)
-    builder.process_data
-  end
-end
-
-def build_options(config)
-  {
-    :base_url => config['baseurl'] + '/iiif',
-    :output_dir => './iiif',
-    :verbose => true
-  }
-end
-
-def make_records(collection_name, inpath, paged, config)
-  counter = 1
-  collection_records = []
-  imagefiles = Dir[inpath + '/*'].sort!
-  imagefiles.each do |imagefile|
-    basename = File.basename(imagefile, '.*').to_s
-    record_opts = {
-      :id => collection_name + '-' + basename,
-      :is_document => paged,
-      :path => imagefile,
-      :label => config['title'] + ' - ' + collection_name + ' - ' + basename
-    }
-    counter += 1
-    collection_records << IiifS3::ImageRecord.new(record_opts)
+    args = ARGV.drop(1).each { |a| task a.to_sym }
+    site_config = WaxTasks.config
+    abort "You must specify a collections after 'bundle exec rake wax:iiif'.".magenta if args.empty?
+    WaxTasks.iiif(args, site_config)
   end
-  collection_records
 end

data/lib/tasks/jspackage.rake

@@ -4,15 +4,15 @@ require 'json'
 namespace :wax do
   desc 'write a simple package.json'
   task :jspackage do
-    config = read_config
+    site_config = WaxTasks.config
     package = {
-      'name'          => config['title'],
+      'name'          => site_config['title'],
       'version'       => '1.0.0',
-      'description'   => config['description'],
+      'description'   => site_config['description'],
       'dependencies'  => {}
     }
     names = []
-    config['js'].each do |dependency|
+    site_config['js'].each do |dependency|
       name = dependency[0]
       names << name
       version = dependency[1]['version']

data/lib/tasks/lunr.rake

@@ -1,28 +1,9 @@
 require 'wax_tasks'
-require 'json'
 
 namespace :wax do
   desc 'build lunr search index'
   task :lunr do
-    config = read_config
-    Dir.mkdir('js') unless File.exist?('js')
-    yaml = "---\nlayout: none\n---\n"
-    lunr = Lunr.new(config)
-
-    # write index to json file
-    idx = yaml + lunr.index
-    idx_path = 'js/lunr-index.json'
-    File.open(idx_path, 'w') { |file| file.write(idx) }
-    puts "Writing lunr index to #{idx_path}".cyan
-
-    # write index.ui to js file
-    ui = yaml + lunr.ui
-    ui_path = 'js/lunr-ui.js'
-    if File.exist?(ui_path)
-      puts "Lunr UI already exists at #{ui_path}. Skipping".cyan
-    else
-      File.open(ui_path, 'w') { |file| file.write(ui) }
-      puts "Writing lunr index to #{ui_path}".cyan
-    end
+    site_config = WaxTasks.config
+    WaxTasks.lunr(site_config)
   end
 end

data/lib/tasks/pagemaster.rake

@@ -3,16 +3,12 @@ require 'wax_tasks'
 namespace :wax do
   desc 'generate collection md pages from yaml or csv data source'
   task :pagemaster do
-    config = read_config
-    argv = read_argv
-    if argv.empty?
-      puts "You must specify one or more collections after 'bundle exec rake wax:pagemaster' to generate.".magenta
-      exit 1
+    args = ARGV.drop(1).each { |a| task a.to_sym }
+    site_config = WaxTasks.config
+    if args.empty?
+      abort "You must specify one or more collections after 'rake wax:pagemaster' to generate.".magenta
     else
-      argv.each do |name|
-        collection = Collection.new(config, name)
-        collection.pagemaster
-      end
+      args.each { |a| WaxTasks.pagemaster(a, site_config) }
     end
   end
 end

data/lib/tasks/push_gh.rake

@@ -8,7 +8,8 @@ namespace :wax do
     task :gh do
       if ENV['CI']
         REPO_SLUG = ENV['TRAVIS_REPO_SLUG']
-        USER = REPO_SLUG.split("/")[0]
+        USER = REPO_SLUG.split('/')[0]
+        REPO_NAME = '1' + REPO_SLUG.split('/')[1]
         TOKEN = ENV['ACCESS_TOKEN']
         COMMIT_MSG = "Site updated via #{ENV['TRAVIS_COMMIT']}".freeze
         ORIGIN = "https://#{USER}:#{TOKEN}@github.com/#{REPO_SLUG}.git".freeze
@@ -16,16 +17,18 @@ namespace :wax do
       else
         ORIGIN = `git config --get remote.origin.url`.freeze
         COMMIT_MSG = "Site updated at #{Time.now.utc}".freeze
-        puts "Deploying to gh-pages branch from local task"
+        puts 'Deploying to gh-pages branch from local task'
       end
       config = read_config
       rm_rf('_site')
 
+      baseurl = config['gh-baseurl'] || REPO_NAME.to_s
+
       opts = {
         'source' => '.',
         'destination' => '_site',
         'config' => '_config.yml',
-        'baseurl' => config['gh-baseurl']
+        'baseurl' => baseurl
       }
 
       Jekyll::Site.new(Jekyll.configuration(opts)).process
@@ -34,7 +37,7 @@ namespace :wax do
         Dir.chdir tmp
         system 'git init'
         system "git add . && git commit -m '#{COMMIT_MSG}'"
-        system 'git remote add origin ' + ORIGIN
+        system "git remote add origin #{ORIGIN}"
         system 'git push origin master:refs/heads/gh-pages --force'
       end
     end

data/lib/tasks/push_s3.rake

@@ -7,7 +7,7 @@ namespace :wax do
     task :s3 do
       if ENV['CI']
         REPO_SLUG = ENV['TRAVIS_REPO_SLUG']
-        USER = REPO_SLUG.split("/")[0]
+        USER = REPO_SLUG.split('/')[0]
         TOKEN = ENV['ACCESS_TOKEN']
         COMMIT_MSG = "Site updated via #{ENV['TRAVIS_COMMIT']}".freeze
         ORIGIN = "https://#{USER}:#{TOKEN}@github.com/#{REPO_SLUG}.git".freeze
@@ -15,7 +15,7 @@ namespace :wax do
       else
         ORIGIN = `git config --get remote.origin.url`.freeze
         COMMIT_MSG = "Site updated at #{Time.now.utc}".freeze
-        puts "Deploying to s3 branch from local task"
+        puts 'Deploying to s3 branch from local task'
       end
 
       Dir.mktmpdir do |tmp|
@@ -23,7 +23,7 @@ namespace :wax do
         Dir.chdir tmp
         system 'git init'
         system "git add . && git commit -m '#{COMMIT_MSG}'"
-        system 'git remote add origin ' + ORIGIN
+        system "git remote add origin #{ORIGIN}"
         system 'git push origin master:refs/heads/s3 --force'
       end
     end

data/lib/wax_tasks.rb

@@ -1,3 +1,46 @@
-require 'wax_tasks/collection'
-require 'wax_tasks/helpers'
-require 'wax_tasks/lunr'
+require_relative 'modules/iiif'
+require_relative 'modules/lunr'
+require_relative 'modules/pagemaster'
+
+require 'yaml'
+require 'wax_iiif'
+
+# umbrella module for registering task modules
+module WaxTasks
+  def self.pagemaster(name, site_config)
+    collection_config = Pagemaster.valid_config(name, site_config)
+
+    src     = collection_config['source']
+    data    = Pagemaster.ingest(src)
+    layout  = collection_config.fetch('layout').to_s
+    perma   = config['permalink'] == 'pretty' ? '/' : '.html'
+    cdir    = site_config['collections_dir'].to_s
+    order   = collection_config.key?('keep_order') ? collection_config.fetch('keep_order') : false
+
+    Pagemaster.generate_pages(data, name, layout, cdir, order, perma)
+  end
+
+  def self.lunr(site_config)
+    cdir          = site_config['collections_dir'].to_s
+    collections   = Lunr.collections(site_config)
+    total_fields  = Lunr.total_fields(collections)
+
+    index         = Lunr.index(cdir, collections)
+    ui            = Lunr.ui(total_fields)
+
+    Lunr.write_index(index)
+    Lunr.write_ui(ui)
+  end
+
+  def self.iiif(args, site_config)
+    Iiif.ingest_collections(args, site_config)
+  end
+
+  def self.config
+    YAML.load_file('_config.yml')
+  end
+
+  def self.slug(str)
+    str.downcase.tr(' ', '_').gsub(/[^:\w-]/, '')
+  end
+end

data/spec/spec_helper.rb

@@ -1 +1,70 @@
-require 'test_tasks'
+require 'fileutils'
+
+require_relative 'fake/data'
+require_relative 'fake/site'
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+require 'wax_tasks'
+
+Fake.site
+Fake.data
+
+describe 'wax:pagemaster' do
+  config = WaxTasks.config
+  args = config['collections'].map { |c| c[0] }
+  system("bundle exec rake wax:pagemaster #{args.join(' ')} > /dev/null")
+  it 'generates directories' do
+    args.each { |a| expect(Dir.exist?('_' + a)) }
+  end
+  it 'generates pages' do
+    args.each { |a| expect(Dir.glob("_#{a}/*.md")) }
+  end
+end
+
+describe 'wax:lunr' do
+  system('bundle exec rake wax:lunr > /dev/null')
+  it 'generates a lunr index' do
+    index = File.open('js/lunr-index.json', 'r').read
+    expect(index.length > 1000)
+  end
+
+  it 'generates a lunr ui' do
+    ui = File.open('js/lunr-ui.js', 'r').read
+    expect(ui.length > 100)
+  end
+end
+
+describe 'wax:iiif' do
+  site_config = WaxTasks.config
+  args = site_config['collections'].map { |c| c[0] }
+
+  it 'generates iiif tiles and data' do
+    images = Dir.glob('./_data/iiif/*.jpg')
+    site_config['collections'].each do |c|
+      new_dir = './_data/iiif/' + c[0]
+      mkdir_p(new_dir)
+      images.each { |f| cp(File.expand_path(f), new_dir) }
+    end
+    rm_r(images)
+    system("bundle exec rake wax:iiif #{args.first} > /dev/null")
+    args.each { |a| expect(Dir.exist?('iiif/images' + a)) }
+  end
+end
+
+describe 'jekyll' do
+  it 'builds successfully' do
+    Bundler.with_clean_env { system('bundle exec jekyll build > /dev/null') }
+  end
+end
+
+describe 'wax:jspackage' do
+  system('bundle exec rake wax:jspackage > /dev/null')
+  it 'writes a package.json file' do
+    package = File.open('package.json', 'r').read
+    expect(package.length > 90)
+  end
+end
+
+describe 'wax:test' do
+  it 'passes html-proofer' do system('bundle exec rake wax:test > /dev/null') end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wax_tasks
 version: !ruby/object:Gem::Version
-  version: 0.0.46
+  version: 0.0.47
 platform: ruby
 authors:
 - Marii Nyrop
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-21 00:00:00.000000000 Z
+date: 2018-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -30,112 +30,112 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '12'
 - !ruby/object:Gem::Dependency
   name: wax_iiif
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.53'
+        version: '0.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.53'
+        version: '0.5'
 description: Rake tasks for minimal iiif exhibition sites with Jekyll.
 email:
 - m.nyrop@columbia.edu
@@ -144,6 +144,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
+- lib/modules/iiif.rb
+- lib/modules/lunr.rb
+- lib/modules/pagemaster.rb
 - lib/tasks/iiif.rake
 - lib/tasks/jspackage.rake
 - lib/tasks/lunr.rake
@@ -152,11 +155,7 @@ files:
 - lib/tasks/push_s3.rake
 - lib/tasks/test.rake
 - lib/wax_tasks.rb
-- lib/wax_tasks/collection.rb
-- lib/wax_tasks/helpers.rb
-- lib/wax_tasks/lunr.rb
 - spec/spec_helper.rb
-- spec/test_tasks.rb
 homepage: https://github.com/mnyrop/wax_tasks
 licenses:
 - MIT
@@ -183,4 +182,3 @@ specification_version: 4
 summary: Rake tasks for minimal exhibitions.
 test_files:
 - spec/spec_helper.rb
-- spec/test_tasks.rb

data/lib/wax_tasks/collection.rb

@@ -1,81 +0,0 @@
-include FileUtils
-require 'csv'
-require 'json'
-
-# initializes a wax collection for use with pagemaster,lunr,and iiif tasks
-class Collection
-  def initialize(config, collection_name)
-    @name   = collection_name
-    @config = config
-
-    cdir = @config['collections_dir'].nil? ? '' : @config.fetch('collections_dir').to_s + '/'
-    collection = valid_collection_config
-
-    @src    = '_data/' + collection.fetch('source')
-    @layout = File.basename(collection.fetch('layout'), '.*')
-    @dir    = cdir + '_' + @name
-    @order  = collection.key?('keep_order') ? collection.fetch('keep_order') : false
-  end
-
-  def valid_collection_config
-    c = @config['collections'][@name]
-    abort "Cannot find the collection #{@name} in _config.yml. Exiting.".magenta if c.nil?
-    abort "Cannot find 'source' for the collection '#{@name}' in _config.yml. Exiting.".magenta if c['source'].nil?
-    abort "Cannot find 'layout' for the collection '#{@name}' in _config.yml. Exiting.".magenta if c['layout'].nil?
-    abort "Cannot find the file '#{'_data/' + c['source']}'. Exiting.".magenta unless File.file?('_data/' + c['source'])
-    c
-  end
-
-  def ingest(src)
-    if File.extname(src) == '.csv'
-      data = CSV.read(src, :headers => true, :encoding => 'utf-8').map(&:to_hash)
-    elsif File.extname(src) == '.json'
-      data = JSON.parse(File.read(@src).encode("UTF-8"))
-    else
-      puts "File type for #{@src} must be .csv or .json. Please fix and rerun."
-      exit 1
-    end
-    detect_duplicates(data)
-    puts "Processing #{src}...."
-    data
-  rescue StandardError
-    puts "Cannot load #{src}. check for typos and rebuild.".magenta
-  end
-
-  def generate_pages(data)
-    perma_ext = @config['permalink'] == 'pretty' ? '/' : '.html'
-    completed = 0
-    skipped = 0
-    data.each_with_index do |item, index|
-      pagename = slug(item.fetch('pid'))
-      pagepath = @dir + '/' + pagename + '.md'
-      item['permalink'] = '/' + @name + '/' + pagename + perma_ext
-      item['layout'] = @layout
-      item['order'] = padded_int(index, data.length) if @order
-      if File.exist?(pagepath)
-        puts "#{pagename}.md already exits. Skipping."
-        skipped += 1
-      else
-        File.open(pagepath, 'w') { |file| file.write(item.to_yaml.to_s + '---') }
-        completed += 1
-      end
-    end
-    puts "\n#{completed} pages were generated to #{@dir} directory.".cyan
-    puts "\n#{skipped} pre-existing items were skipped.".cyan
-  rescue StandardError
-    abort "#{completed} pages were generated before failure, most likely a record is missing a valid 'pid' value.".magenta
-  end
-
-  def detect_duplicates(data)
-    pids = []
-    data.each { |d| pids << d['pid'] }
-    duplicates = pids.detect { |p| pids.count(p) > 1 } || []
-    raise "\nYour collection has the following duplicate ids. please fix and rerun.\n#{duplicates}".magenta unless duplicates.empty?
-  end
-
-  def pagemaster
-    mkdir_p(@dir)
-    data = ingest(@src)
-    generate_pages(data)
-  end
-end

data/lib/wax_tasks/helpers.rb

@@ -1,38 +0,0 @@
-def clean(str)
-  str.gsub!(/\A---(.|\n)*?---/, '') # remove yaml front matter
-  str.gsub!(/{%(.*)%}/, '') # remove functional liquid
-  str.gsub!(/<\/?[^>]*>/, '') # remove html
-  str.gsub!('\\n', '') # remove newlines
-  str.gsub!(/\s+/, ' ') # remove extra space
-  str.tr!('"', "'") # replace double quotes with single
-  str
-end
-
-def rm_diacritics(str)
-  to_replace  = "ÀÁÂÃÄÅàáâãäåĀāĂ㥹ÇçĆćĈĉĊċČčÐðĎďĐđÈÉÊËèéêëĒēĔĕĖėĘęĚěĜĝĞğĠġĢģĤĥĦħÌÍÎÏìíîïĨĩĪīĬĭĮįİıĴĵĶķĸĹĺĻļĽľĿŀŁłÑñŃńŅņŇňʼnŊŋÒÓÔÕÖØòóôõöøŌōŎŏŐőŔŕŖŗŘřŚśŜŝŞşŠšſŢţŤťŦŧÙÚÛÜùúûüŨũŪūŬŭŮůŰűŲųŴŵÝýÿŶŷŸŹźŻżŽž"
-  replaced_by = "AAAAAAaaaaaaAaAaAaCcCcCcCcCcDdDdDdEEEEeeeeEeEeEeEeEeGgGgGgGgHhHhIIIIiiiiIiIiIiIiIiJjKkkLlLlLlLlLlNnNnNnNnnNnOOOOOOooooooOoOoOoRrRrRrSsSsSsSssTtTtTtUUUUuuuuUuUuUuUuUuUuWwYyyYyYZzZzZz"
-  str.tr(to_replace, replaced_by)
-end
-
-def slug(str)
-  str.downcase.tr(' ', '_').gsub(/[^:\w-]/, '')
-end
-
-def thing2string(thing)
-  thing = thing.join(" || ") if thing.is_a?(Array)
-  thing.to_s
-end
-
-def read_config
-  YAML.load_file('_config.yml')
-end
-
-def read_argv
-  argv = ARGV.drop(1)
-  argv.each { |a| task a.to_sym }
-  argv
-end
-
-def padded_int(index, max_idx)
-  index.to_s.rjust(Math.log10(max_idx).to_i + 1, "0")
-end

data/lib/wax_tasks/lunr.rb

@@ -1,74 +0,0 @@
-include FileUtils
-require 'json'
-
-# for generating Lunr Index and Lunr UI files
-class Lunr
-  def initialize(config)
-    @lunr_collections = collections_to_index(config['collections'])
-    @total_fields     = total_fields(@lunr_collections)
-    @lunr_language    = config['lunr_language']
-    @collections_dir  = config['collections_dir'].nil? ? '' : config.fetch('collections_dir') + '/'
-  end
-
-  def collections_to_index(collections)
-    collections.find_all { |c| c[1].key?('lunr_index') && c[1]['lunr_index'].key?('fields') }
-  end
-
-  def total_fields(collections)
-    total_fields = ['pid']
-    collections.each do |c|
-      total_fields = total_fields.concat(c[1]['lunr_index']['fields'])
-      total_fields << 'content' if c[1]['lunr_index']['content']
-    end
-    total_fields.uniq
-  end
-
-  def page_hash(page, c_fields, collection, count)
-    yaml = YAML.load_file(page)
-    hash = {
-      'lunr_id' => count,
-      'link' => "{{'" + yaml.fetch('permalink') + "' | relative_url }}"
-    }
-    c_fields.each { |f| hash[f] = rm_diacritics(thing2string(yaml[f])) }
-    hash['content'] = rm_diacritics(clean(File.read(page))) if collection[1]['lunr_index']['content']
-    hash
-  end
-
-  def index
-    full_index = []
-    count = 0
-    # catch
-    abort("There are no valid collections to index.".magenta) if @lunr_collections.nil?
-    # index each lunr_collection
-    @lunr_collections.each do |c|
-      c_dir = @collections_dir + '_' + c[0]
-      c_fields = c[1]['lunr_index']['fields'].uniq
-      c_pages = Dir.glob(c_dir + '/*.md')
-      # catch
-      abort "There are no markdown pages in directory '#{c_dir}'".magenta if c_pages.empty?
-      abort "There are no fields specified for #{c[0]}.".magenta if c_fields.empty?
-      puts "Loading #{c_pages.length} pages from #{c_dir}"
-      # index each page in collection
-      c_pages.each do |page|
-        full_index << page_hash(page, c_fields, c, count)
-        count += 1
-      end
-    end
-    JSON.pretty_generate(full_index)
-  end
-
-  def ui
-    # set up index
-    ui_string = "$.getJSON(\"{{ site.baseurl }}/js/lunr-index.json\", function(index_json) {\nwindow.index = new elasticlunr.Index;\nwindow.store = index_json;\nindex.saveDocument(false);\nindex.setRef('lunr_id');"
-    # add fields to index
-    @total_fields.each { |field| ui_string += "\nindex.addField('#{field}');" }
-    # add docs
-    ui_string += "\n// add docs\nfor (i in store){index.addDoc(store[i]);}"
-    # gui
-    ui_string += "\n$('input#search').on('keyup', function() {\nvar results_div = $('#results');\nvar query = $(this).val();\nvar results = index.search(query, { boolean: 'AND', expand: true });\nresults_div.empty();\nif (results.length > 10) {\nresults_div.prepend(\"<p><small>Displaying 10 of \" + results.length + \" results.</small></p>\");\n}\nfor (var r in results.slice(0, 9)) {\nvar ref = results[r].ref;\nvar item = store[ref];"
-    # add fields as display vars
-    @total_fields.each { |field| ui_string += "var #{field} = item.#{field};\n" }
-    ui_string += "var result = '<div class=\"result\"><b><a href=\"' + item.link + '\">' + title + '</a></b></p></div>';\nresults_div.append(result);\n}\n});\n});"
-    ui_string
-  end
-end

data/spec/test_tasks.rb

@@ -1,44 +0,0 @@
-require 'yaml'
-require 'fileutils'
-require 'fake/helpers'
-require 'fake/site'
-require 'fake/data'
-
-# run + test wax:config
-describe 'wax_tasks' do
-  Fake.site
-  collection_data = Fake.data
-  config = YAML.load_file('_config.yml')
-  argv = collection_data.map { |col| col[0] }
-  add_collections_to_config(argv, collection_data, config)
-  add_lunr_data(config, collection_data)
-
-  it 'accesses _config.yml and argv' do
-    expect(config.length)
-    expect(argv.length)
-  end
-
-  it 'generates pages' do
-    system("bundle exec rake wax:pagemaster #{argv.join(' ')}")
-    argv.each { |a| expect(Dir.exist?('_' + a)) }
-  end
-
-  it 'generates a lunr index' do
-    system("bundle exec rake wax:lunr")
-    index = File.open('js/lunr-index.json', 'r').read
-    ui = File.open('js/lunr-ui.js', 'r').read
-    expect(index.length > 1000)
-    expect(ui.length > 100)
-  end
-
-  it 'generates iiif tiles and data' do
-    images = Dir.glob('./_data/iiif/*.jpg')
-    collection_data.each do |coll|
-      new_dir = './_data/iiif/' + coll[0]
-      mkdir_p(new_dir)
-      images.each { |f| cp(File.expand_path(f), new_dir) }
-    end
-    rm_r(images)
-    system("bundle exec rake wax:iiif #{argv.first}")
-  end
-end