wax_tasks 0.2.0 → 0.3.0

data/lib/wax/collection.rb

@@ -1,49 +0,0 @@
-# document
-class Collection
-  def initialize(name, opts = {})
-    @name     = name
-    @s_conf   = opts.fetch(:site_config, WaxTasks.site_config)
-    @c_conf   = @s_conf.fetch(:collections).fetch(@name, nil)
-    @page_dir = "_#{@name}"
-    if @s_conf.fetch(:c_dir, false)
-      @page_dir = "#{@s_conf[:c_dir]}/#{@page_dir}"
-    end
-    assert_required(instance_variables)
-  end
-
-  def ingest(source)
-    Error.missing_key('source', @name) if source.nil?
-    src_path = "_data/#{source}"
-    data = hash_array(src_path)
-    Message.processing_source(source)
-    assert_pids(source, data)
-  rescue StandardError => e
-    Error.bad_source(source, @name) + "\n#{e}"
-  end
-
-  def hash_array(src)
-    opts = { headers: true, encoding: 'utf-8' }
-    ext  = File.extname(src)
-    case ext
-    when '.csv' then data = CSV.read(src, opts).map(&:to_hash)
-    when '.json' then data = JSON.parse(File.read(src))
-    when '.yml' then data = YAML.load_file(src)
-    else Error.invalid_type(ext, @name)
-    end
-    data
-  end
-
-  def assert_pids(source, data)
-    pids = data.map { |d| d.fetch('pid', nil) }
-    Error.missing_pids(source, pids) unless pids.all?
-    duplicates = pids.select { |p| pids.count(p) > 1 }.uniq! || []
-    Error.duplicate_pids(duplicates, @name) unless duplicates.empty?
-    data
-  end
-
-  def assert_required(vars)
-    vars.each do |v|
-      Error.invalid_collection(@name) if instance_variable_get(v).nil?
-    end
-  end
-end

data/lib/wax/iiif_collection.rb

@@ -1,63 +0,0 @@
-require 'wax_iiif'
-
-# document
-class IiifCollection < Collection
-  def initialize(name, opts = {})
-    super(name, opts)
-
-    @src_dir    = "_data/iiif/#{@name}"
-    @target_dir = "./iiif/#{@name}"
-    @src_data   = @c_conf.fetch('source', false)
-    @i_conf     = @c_conf.fetch('iiif', {})
-    @meta       = @i_conf.fetch('meta', false)
-    @variants   = validated_variants
-  end
-
-  def process
-    Error.missing_iiif_src(@src_dir) unless Dir.exist?(@src_dir)
-    FileUtils.mkdir_p("./iiif/#{@name}", verbose: false)
-
-    builder = iiif_builder
-    builder.load(iiif_records)
-    builder.process_data(true)
-  end
-
-  def iiif_builder
-    build_opts = {
-      base_url: "#{@s_conf[:baseurl]}/iiif/#{@name}",
-      output_dir: @target_dir,
-      verbose: true,
-      variants: @variants
-    }
-    IiifS3::Builder.new(build_opts)
-  end
-
-  def validated_variants
-    vars = @i_conf.fetch('variants', false)
-    if vars.is_a?(Array) && vars.all? { |v| v.is_a?(Integer) }
-      variants = {}
-      vars.each_with_index { |v, i| variants["custom_variant_#{i}".to_sym] = v }
-    else
-      variants = { med: 600, lg: 1140 }
-    end
-    variants
-  end
-
-  def iiif_records
-    records = []
-    source_images = Dir["#{@src_dir}/*"].sort!
-    metadata = ingest(@src_data) if @meta && @src_data
-    source_images.each { |src_img| records << iiif_record(src_img, metadata) }
-    records
-  end
-
-  def iiif_record(src_img, metadata)
-    basename = File.basename(src_img, '.*').to_s
-    record_opts = { id: basename, path: src_img, label: basename }
-    if metadata
-      src_item = metadata.find { |i| i['pid'].to_s == basename }
-      @meta.each { |k, v| record_opts[k.to_sym] = src_item.fetch(v, '') }
-    end
-    IiifS3::ImageRecord.new(record_opts)
-  end
-end

data/lib/wax/index.rb

@@ -1,70 +0,0 @@
-# document
-class Index
-  attr_accessor :collections
-
-  def initialize(opts = {})
-    @s_conf       = opts.fetch(:site_config, WaxTasks.site_config)
-    @collections  = collections_to_index
-    @fields       = total_fields
-    @path         = opts.fetch(:path, 'js/lunr-index.json')
-    @ui           = opts.fetch(:ui, ui)
-  end
-
-  def collections_to_index
-    to_index = @s_conf[:collections].find_all { |c| c[1].key?('lunr_index') }
-    to_index.map! { |c| c[0] }
-    Error.no_collections_to_index if to_index.nil?
-    lunr_collections = []
-    to_index.each { |c| lunr_collections << LunrCollection.new(c) }
-    lunr_collections
-  end
-
-  def total_fields
-    total_fields = ['pid']
-    @collections.each { |c| total_fields.concat(c.fields) unless c.fields.nil? }
-    total_fields.uniq
-  end
-
-  def write
-    docs = []
-    @collections.each { |c| docs.concat(c.data) }
-    docs = add_lunr_ids(docs)
-    FileUtils.mkdir_p(File.dirname(@path))
-    index = "---\nlayout: none\n---\n#{JSON.pretty_generate(docs)}"
-    File.open(@path, 'w') { |f| f.write(index) }
-    Message.writing_index(@path)
-    write_ui if @ui
-  end
-
-  def ui
-    ui = "$.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');"
-    @fields.each { |f| ui += "\nindex.addField('#{f}');" }
-    ui += "\n// add docs\nfor (i in store){index.addDoc(store[i]);}"
-    ui += "\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];"
-    @fields.each { |f| ui += "var #{f} = item.#{f};\n" }
-    ui += "var result = '<div class=\"result\"><b><a href=\"' + item.link + '\">' + title + '</a></b></p></div>';\nresults_div.append(result);\n}\n});\n});"
-    ui
-  end
-
-  def write_ui
-    ui = "---\nlayout: none\n---\n#{@ui}"
-    path = 'js/lunr-ui.js'
-    if File.exist?(path)
-      Message.ui_exists(path)
-    else
-      File.open(path, 'w') { |file| file.write(ui) }
-      Message.writing_ui(path)
-    end
-  end
-
-  def add_lunr_ids(documents)
-    count = 0
-    docs_with_ids = []
-    documents.each do |d|
-      d['lunr_id'] = count
-      docs_with_ids << d
-      count += 1
-    end
-    docs_with_ids
-  end
-end

data/lib/wax/lunr_collection.rb

@@ -1,50 +0,0 @@
-# document
-class LunrCollection < Collection
-  attr_accessor :fields, :data
-
-  def initialize(name, opts = {})
-    super(name, opts)
-    @content  = @c_conf['lunr_index'].fetch('content', false)
-    @fields   = @c_conf['lunr_index'].fetch('fields', nil)
-    @data     = pages_to_hash_array
-  end
-
-  def pages_to_hash_array
-    page_hashes = []
-    pages = Dir.glob(@page_dir + '/*.md')
-    # catch
-    abort "There are no pages in '#{@page_dir}'".magenta if pages.empty?
-    abort "There are no fields for #{@name}.".magenta if @fields.empty?
-    puts "Loading #{pages.length} pages from #{@page_dir}"
-    # index each page in collection
-    pages.each { |page| page_hashes << page_hash(page) }
-    page_hashes
-  end
-
-  def page_hash(page)
-    yaml = YAML.load_file(page)
-    hash = {
-      'link' => "{{'" + yaml.fetch('permalink') + "' | relative_url }}",
-      'collection' => @name
-    }
-    hash['content'] = rm_diacritics(clean(File.read(page))) if @content
-    add_data_fields(hash, yaml)
-  end
-
-  def add_data_fields(hash, yaml)
-    @fields.each { |f| hash[f] = normalize(yaml[f]) }
-    hash
-  end
-
-  def normalize(value)
-    case value
-    when Array
-      if value.first.is_a? Hash then value
-      else rm_diacritics(value.join(', '))
-      end
-    when String then rm_diacritics(value)
-    when Hash then value
-    else value.to_s
-    end
-  end
-end

data/lib/wax/pagemaster_collection.rb

@@ -1,40 +0,0 @@
-# document
-class PagemasterCollection < Collection
-  attr_accessor :page_dir
-
-  def initialize(name, opts = {})
-    super(name, opts)
-    @data     = ingest(@c_conf.fetch('source', nil))
-    @layout   = @c_conf.fetch('layout', nil)
-    @ordered  = @c_conf.fetch('keep_order', false)
-  end
-
-  def generate_pages
-    FileUtils.mkdir_p(@page_dir)
-    completed = 0
-    @data.each_with_index do |item, i|
-      page_slug = slug(item.fetch('pid').to_s)
-      path      = "#{@page_dir}/#{page_slug}.md"
-      if File.exist?(path)
-        puts "#{page_slug}.md already exits. Skipping."
-      else
-        File.open(path, 'w') { |f| f.write("#{page(item, page_slug, i).to_yaml}---") }
-        completed += 1
-      end
-    end
-    puts Message.pagemaster_results(completed, @page_dir)
-  rescue StandardError => e
-    Error.page_generation_failure(completed) + "\n#{e}"
-  end
-
-  def page(item, page_slug, index)
-    item['permalink'] = "/#{@name}/#{page_slug}#{@s_conf[:permalink]}"
-    item['layout']    = @layout
-    item['order']     = padded_int(index, @data.length) if @ordered
-    item
-  end
-
-  def padded_int(index, max_idx)
-    index.to_s.rjust(Math.log10(max_idx).to_i + 1, '0')
-  end
-end

data/lib/wax/tasks/jspackage.rake

@@ -1,26 +0,0 @@
-require 'wax_tasks'
-
-namespace :wax do
-  desc 'write a simple package.json'
-  task :jspackage do
-    s_conf = WaxTasks.site_config
-    if s_conf[:js]
-      names = []
-      package = {
-        'name'          => s_conf['title'],
-        'version'       => '1.0.0',
-        'dependencies'  => {}
-      }
-      s_conf[:js].each do |dependency|
-        name = dependency[0]
-        names << name
-        version = dependency[1]['version']
-        package['dependencies'][name] = '^' + version
-      end
-      File.open('package.json', 'w') { |file| file.write(package.to_json) }
-      Message.writing_package_json(names)
-    else
-      Message.skipping_package_json
-    end
-  end
-end

data/lib/wax/tasks/lunr.rake

@@ -1,9 +0,0 @@
-require 'wax_tasks'
-
-namespace :wax do
-  desc 'build lunr search index'
-  task :lunr do
-    index = Index.new
-    index.write
-  end
-end

data/lib/wax/tasks/push.rake

@@ -1,18 +0,0 @@
-require 'wax_tasks'
-
-namespace :wax do
-  desc 'push compiled site to git branch BRANCH'
-  task :push do
-    ARGS    = ARGV.drop(1).each { |a| task a.to_sym }
-    TARGET  = slug(ARGS.first)
-    TRAVIS  = ENV.fetch('CI', false)
-    CONFIG  = YAML.load_file('./_config.yml')
-    GH      = TARGET == 'gh-pages'
-
-    abort "You must specify a branch after 'wax:push:branch'" if ARGS.empty?
-
-    branch = TRAVIS ? TravisBranch.new : LocalBranch.new
-    branch.build_gh_site if GH
-    branch.push
-  end
-end

data/lib/wax/utilities.rb

@@ -1,99 +0,0 @@
-require 'colorize'
-
-def rm_diacritics(str)
-  to_replace  = 'ÀÁÂÃÄÅàáâãäåĀāĂ㥹ÇçĆćĈĉĊċČčÐðĎďĐđÈÉÊËèéêëĒēĔĕĖėĘęĚěĜĝĞğĠġĢģĤĥĦħÌÍÎÏìíîïĨĩĪīĬĭĮįİıĴĵĶķĸĹĺĻļĽľĿŀŁłÑñŃńŅņŇňʼnŊŋÒÓÔÕÖØòóôõöøŌōŎŏŐőŔŕŖŗŘřŚśŜŝŞşŠšſŢţŤťŦŧÙÚÛÜùúûüŨũŪūŬŭŮůŰűŲųŴŵÝýÿŶŷŸŹźŻżŽž'
-  replaced_by = 'AAAAAAaaaaaaAaAaAaCcCcCcCcCcDdDdDdEEEEeeeeEeEeEeEeEeGgGgGgGgHhHhIIIIiiiiIiIiIiIiIiJjKkkLlLlLlLlLlNnNnNnNnnNnOOOOOOooooooOoOoOoRrRrRrSsSsSsSssTtTtTtUUUUuuuuUuUuUuUuUuUuWwYyyYyYZzZzZz'
-  str.tr(to_replace, replaced_by)
-end
-
-def clean(str)
-  str.gsub!(/\A---(.|\n)*?---/, '') # remove yaml front matter
-  str.gsub!(/{%(.*)%}/, '') # remove functional liquid
-  str.gsub!(%r{<\/?[^>]*>}, '') # remove html
-  str.gsub!('\\n', '') # remove newlines
-  str.gsub!(/\s+/, ' ') # remove extra space
-  str.tr!('"', "'") # replace double quotes with single
-  str
-end
-
-def slug(str)
-  str.downcase.tr(' ', '_').gsub(/[^:\w-]/, '')
-end
-
-# document
-module Error
-  def self.complain(error)
-    abort error.magenta
-  end
-
-  def self.missing_key(key, name)
-    complain("Key '#{key}' not found for '#{name}'. Check config and rerun.")
-  end
-
-  def self.invalid_type(ext, name)
-    complain("Source file for #{name} must be .csv .json  or .yml. Found #{ext}.")
-  end
-
-  def self.duplicate_pids(duplicates, name)
-    complain("Fix the following duplicate pids for collection '#{name}': #{duplicates}")
-  end
-
-  def self.bad_source(source, name)
-    complain("Cannot load source '#{source}' for collection '#{name}'. Check for typos and rebuild.")
-  end
-
-  def self.missing_pids(source, pids)
-    complain("Source '#{source}' is missing #{pids.count(nil)} `pid` values.")
-  end
-
-  def self.invalid_collection(name)
-    complain("Configuration for the collection '#{name}' is invalid.")
-  end
-
-  def self.page_generation_failure(completed)
-    complain("Failure after #{completed} pages, likely from missing pid.")
-  end
-
-  def self.no_collections_to_index
-    complain('There are no valid collections to index.')
-  end
-
-  def self.missing_iiif_src(dir)
-    complain("Source path '#{dir}' does not exist. Exiting.")
-  end
-end
-
-# document
-class Message
-  def self.share(msg)
-    puts msg.cyan
-  end
-
-  def self.processing_source(source)
-    share("\nProcessing #{source}...")
-  end
-
-  def self.pagemaster_results(completed, dir)
-    share("\n#{completed} pages were generated to #{dir} directory.")
-  end
-
-  def self.writing_index(path)
-    share("Writing lunr index to #{path}")
-  end
-
-  def self.ui_exists(path)
-    share("Lunr UI already exists at #{path}. Skipping.")
-  end
-
-  def self.writing_ui(path)
-    share("Writing lunr ui to #{path}")
-  end
-
-  def self.writing_package_json(names)
-    share("Writing #{names} to simple package.json.")
-  end
-
-  def self.skipping_package_json
-    share('Cannot find js dependencies in config. Skipping package.json.')
-  end
-end

data/spec/iiif.rb

@@ -1,42 +0,0 @@
-describe 'wax:iiif' do
-  it 'constructs iiif collections' do
-    expect { quiet_stdout { IIIF_COLLECTIONS.all? } }
-  end
-  context 'when invoked as a task' do
-    it 'passes' do
-      passes = quiet_stdout { system("bundle exec rake wax:iiif #{ARGS.first}") }
-      expect(passes).to eq(true)
-    end
-    it 'generates collection json' do
-      expect(File.exist?("./iiif/#{ARGS.first}/collection/top.json")).to be true
-    end
-    it 'generates manifest json' do
-      expect(File.exist?("./iiif/#{ARGS.first}/0/manifest.json")).to be true
-    end
-    it 'adds manifest metadata fields from config + source' do
-      manifest = JSON.parse(File.read("./iiif/#{ARGS.first}/0/manifest.json"))
-      %w[label description].each do |k|
-        expect(manifest).to have_key(k)
-        expect(manifest[k]).not_to be_empty
-      end
-    end
-    it 'generates derivatives' do
-      expect(Dir.exist?("./iiif/#{ARGS.first}/images")).to be true
-    end
-    it 'generates custom image variants' do
-      [100, 900].each do |size|
-        expect(File.exist?("./iiif/#{ARGS.first}/images/1-1/full/#{size},/0/default.jpg")).to be true
-      end
-    end
-  end
-  context 'when processed directly' do
-    it 'still passes' do
-      expect { quiet_stdout { IIIF_COLLECTIONS.last.process } }.not_to raise_error
-    end
-  end
-  context 'when looking for a missing dir' do
-    it 'throws a configuration error' do
-      expect { quiet_stdout { IiifCollection.new('not_a_collection') } }.to raise_error(SystemExit)
-    end
-  end
-end

data/spec/lunr.rb

@@ -1,24 +0,0 @@
-# lunr task specs
-describe 'wax:lunr' do
-  it 'constructs an index object' do
-    idx = quiet_stdout { Index.new }
-    expect { idx.collections.all? }
-  end
-  it 'passes when invoked' do
-    passes = quiet_stdout { system('bundle exec rake wax:lunr') }
-    expect(passes).to eq(true)
-  end
-  it 'writes a lunr index' do
-    index = File.open('./js/lunr-index.json', 'r').read
-    expect(index.length).to be > 1000
-  end
-  it 'generates a lunr ui' do
-    ui = File.open('./js/lunr-ui.js', 'r').read
-    expect(ui.length).to be > 100
-  end
-  context 'when a ui already exists' do
-    it 'skips over it' do
-      expect { Index.new.write }.to output(/.*Skipping.*/).to_stdout
-    end
-  end
-end

data/spec/pagemaster.rb

@@ -1,41 +0,0 @@
-# pagemaster task specs
-describe 'wax:pagemaster' do
-  it 'constructs pagemaster collections' do
-    expect { PM_COLLECTIONS.all? }
-  end
-  context 'when invoked as a task' do
-    it 'passes' do
-      passes = quiet_stdout { system("bundle exec rake wax:pagemaster #{ARGS.join ' '}") }
-      expect(passes).to eq(true)
-    end
-    it 'generates pages to the correct directories' do
-      PM_COLLECTIONS.each do |c|
-        pages = Dir.glob("#{c.page_dir}/*.md")
-        expect(pages.length).to be > 0
-        Fake.content(pages) # add content to pages to test lunr indexing
-      end
-    end
-  end
-  context 'when processed directly' do
-    it 'still passes' do
-      FileUtils.rm_r "./collections/_#{ARGS.first}"
-      expect { quiet_stdout { PM_COLLECTIONS.first.generate_pages } }.not_to raise_error
-    end
-  end
-  context 'when given a collection arg not in config' do
-    it 'throws a configuration error' do
-      expect { quiet_stdout { PagemasterCollection.new('not_a_collection') } }.to raise_error(SystemExit)
-    end
-  end
-  context 'when trying to genrate pages that already exist' do
-    it 'skips them' do
-      expect { PM_COLLECTIONS.first.generate_pages }.to output(/.*Skipping.*/).to_stdout
-    end
-  end
-  context 'when given a bad config' do
-    it 'throws a key error' do
-      opts = { site_config: {} }
-      expect { PagemasterCollection.new(ARGS.first, opts) }.to raise_error(KeyError)
-    end
-  end
-end