wax_tasks 0.3.2 → 1.0.0.pre.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d88624cfe6327eb5449dda2246712718f4bdfb2fea155e12e1593b6a5e10af08
-  data.tar.gz: d6aa6846dedcbaa295d4ae3f909c1f22fa68c55db1524b7aea1e7a958ef241ad
+  metadata.gz: 6df6c21281405044f2958da14b8eda608a4a265337f684c1371612817468767a
+  data.tar.gz: f1a7248a2b83fa1cf34cfd15580baecdefdd91601c7328b987d9ac247316e154
 SHA512:
-  metadata.gz: b3c8dd46e8631bbff1bcdb2792255882ac37cb1afd4b8ed9e193e24e0625c934eeda807d56417832df1fbfbdc9dec435df02df5058c3907794761bf704734fcc
-  data.tar.gz: 954bbf0a5a9561ad4b74bf751de5e45e6cc5ec7de21a5fd82720789483470c29f1efc161fa62af1e69c2b4b8479956f82a4acd73277d3efd42bf36cfb0a2ef97
+  metadata.gz: 2a2c5464d13a57208f0c79bbf44a4355b6fad5efd3d2e511ad30ce7a0b4075321868a906a70b680b76ced742d5394fb758a746aff42f0601ea9137ad774dd448
+  data.tar.gz: 87e84935bcda6fcc92bab5a5fecc7b8fec29d19e3348b6b1f0404dd3b6e47595b778a1b7a25562e0ce7b5c187c700be7c9c20a728bc7adbf98284bba26e7b691

data/Gemfile

@@ -3,6 +3,6 @@ gemspec
 
 # dev/test utilities
 gem 'diane', require: false
-gem 'rubocop', require: false
+gem 'rubocop', '0.59.0', require: false
 gem 'simplecov', require: false
 gem 'yard', require: false

data/lib/tasks/derivatives_iiif.rake

@@ -0,0 +1,21 @@
+require 'wax_tasks'
+
+namespace :wax do
+  namespace :derivatives do
+    desc 'generate iiif derivatives from local image files'
+    task :iiif do
+      arguments = ARGV.drop(1).each { |a| task a.to_sym }
+      raise WaxTasks::Error::MissingArguments, "You must specify a collection after 'wax:derivatives:iiif'" if arguments.empty?
+      task_runner = WaxTasks::TaskRunner.new
+      task_runner.derivatives_iiif(arguments)
+    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

data/lib/tasks/derivatives_simple.rake

@@ -0,0 +1,13 @@
+require 'wax_tasks'
+
+namespace :wax do
+  namespace :derivatives do
+    desc 'generate iiif derivatives from local image files'
+    task :simple do
+      arguments = ARGV.drop(1).each { |a| task a.to_sym }
+      raise WaxTasks::Error::MissingArguments, "You must specify a collection after 'wax:derivatives:simple'" if arguments.empty?
+      task_runner = WaxTasks::TaskRunner.new
+      task_runner.derivatives_simple(arguments)
+    end
+  end
+end

data/lib/tasks/jspackage.rake

@@ -1,3 +1,4 @@
+require 'json'
 require 'wax_tasks'
 
 namespace :wax do
@@ -6,9 +7,11 @@ namespace :wax do
     task_runner = WaxTasks::TaskRunner.new
     package = task_runner.js_package
     unless package.empty?
-      path = WaxTasks::Utils.make_path(task_runner.site[:source_dir],
-                                       'package.json')
-      File.open(path, 'w') { |f| f.write(package.to_json) }
+      src_dir = task_runner.site[:source_dir]
+      path    = WaxTasks::Utils.root_path(src_dir, 'package.json')
+
+      puts "Writing javascript dependencies to #{path}".cyan
+      File.open(path, 'w') { |f| f.write(JSON.pretty_generate(package)) }
     end
   end
 end

data/lib/tasks/pagemaster.rake

@@ -3,9 +3,9 @@ require 'wax_tasks'
 namespace :wax do
   desc 'generate collection md pages from yaml or csv data source'
   task :pagemaster do
-    ARGS = ARGV.drop(1).each { |a| task a.to_sym }
-    raise 'You must specify a collection after wax:pagemaster' if ARGS.empty?
+    arguments = ARGV.drop(1).each { |a| task a.to_sym }
+    raise WaxTasks::Error::MissingArguments, 'You must specify a collection after wax:pagemaster' if arguments.empty?
     task_runner = WaxTasks::TaskRunner.new
-    task_runner.pagemaster(ARGS)
+    task_runner.pagemaster(arguments)
   end
 end

data/lib/tasks/push.rake

@@ -3,10 +3,10 @@ require 'wax_tasks'
 namespace :wax do
   desc 'push compiled Jekyll site to git branch BRANCH'
   task :push do
-    ARGS = ARGV.drop(1).each { |a| task a.to_sym }
-    raise 'You must specify a branch after \'wax:push:branch\'' if ARGS.empty?
+    arguments = ARGV.drop(1).each { |a| task a.to_sym }
+    raise WaxTasks::Error::MissingArguments, 'You must specify a branch after wax:push' if arguments.empty?
 
     task_runner = WaxTasks::TaskRunner.new
-    task_runner.push_branch(ARGS.first)
+    task_runner.push_branch(arguments.first)
   end
 end

data/lib/wax_tasks/branch.rb

@@ -24,9 +24,11 @@ module WaxTasks
 
     # @param site   [Hash]    the site config from (TaskRunner.site)
     # @param target [String]  the name of the Git branch to deploy to
+    # @param time   [String]  message with the time of deployment
     def initialize(site, target)
       @site   = site
       @target = target
+      @time   = Time.now.strftime('Updated at %H:%M on %Y-%m-%d')
     end
 
     # Rebuild the Jekyll site with branch @baseurl
@@ -54,6 +56,7 @@ module WaxTasks
         rebuild if @target == 'gh-pages'
         raise Error::MissingSite, "Cannot find #{WaxTasks::SITE_DIR}" unless Dir.exist? WaxTasks::SITE_DIR
         Dir.chdir(SITE_DIR)
+        File.open('.info', 'w') { |f| f.write(@time) }
         system 'git init && git add .'
         system "git commit -m '#{@commit_msg}'"
         system "git remote add origin #{@origin}"

data/lib/wax_tasks/collection.rb

@@ -3,13 +3,8 @@ module WaxTasks
   # that cannot be created directly. Only child classes
   # (IiifCollection, LunrCollection, PagemasterCollection)
   # can be initialized.
-  #
-  # @attr config    [Hash]    the collection config within site config
-  # @attr name      [String]  the name of the collection in site:collections
-  # @attr page_dir  [String]  the directory path for generated collection pages
-  # @attr site      [Hash]    the site config
   class Collection
-    attr_reader :name, :page_dir
+    attr_accessor :name, :site
     private_class_method :new
 
     # This method ensures child classes can be instantiated though
@@ -18,28 +13,41 @@ module WaxTasks
       public_class_method :new
     end
 
-    # Creates a new collection with name @name given site config @site
+    # Creates a new collection with name @name given site configuration @site
     #
-    # @param name     [String]  the name of the collection in site:collections
-    # @param site     [Hash]    the site config
+    # @param  name      [String]  name of the collection in site:collections
+    # @param  site      [Hash]    site config
     def initialize(name, site)
       @name     = name
       @site     = site
-      @config   = collection_config
-      @page_dir = Utils.make_path(@site[:source_dir],
-                                  @site[:collections_dir],
-                                  "_#{@name}")
+      @config   = self.config
     end
 
     # Finds the collection config within the site config
     #
     # @return [Hash] the config for the collection
-    def collection_config
+    def config
       @site[:collections].fetch(@name)
     rescue StandardError => e
       raise Error::InvalidCollection, "Cannot load collection config for #{@name}.\n#{e}"
     end
 
+    # Returns the target directory for generated collection pages
+    #
+    # @return [String] path
+    def page_dir
+      WaxTasks::Utils.root_path(@site[:source_dir], @site[:collections_dir], "_#{@name}")
+    end
+
+    # Constructs the path to the data source file
+    #
+    # @return [String] the path to the data source file
+    def metadata_source_path
+      source = @config.dig('metadata', 'source')
+      raise WaxTasks::Error::MissingSource, "Missing collection source in _config.yml for #{@name}" if source.nil?
+      WaxTasks::Utils.root_path(@site[:source_dir], '_data', source)
+    end
+
     # Ingests the collection source data as an Array of Hashes
     #
     # @param source [String] the path to the CSV, JSON, or YAML source file
@@ -61,5 +69,24 @@ module WaxTasks
       WaxTasks::Utils.assert_pids(data)
       WaxTasks::Utils.assert_unique(data)
     end
+
+    # @return [Nil]
+    def overwrite_metadata
+      src = self.metadata_source_path
+      puts "Writing image derivative info #{src}.".cyan
+      case File.extname(src)
+      when '.csv'
+        keys = @metadata.map(&:keys).inject(&:|)
+        csv_string = keys.to_csv
+        @metadata.each { |h| csv_string += h.values_at(*keys).to_csv }
+        File.open(src, 'w') { |f| f.write(csv_string) }
+      when '.json'
+        File.open(src, 'w') { |f| f.write(JSON.pretty_generate(@metadata)) }
+      when /\.ya?ml/
+        File.open(src, 'w') { |f| f.write(@metadata.to_yaml) }
+      else
+        raise Error::InvalidSource
+      end
+    end
   end
 end

data/lib/wax_tasks/error.rb

@@ -8,6 +8,10 @@ module WaxTasks
       end
     end
 
+    # Custom Error:
+    # Rake task expects arguments, found none
+    class MissingArguments < WaxTasksError; end
+
     # Custom Error:
     # Site config cannot be found / parsed
     class InvalidSiteConfig < WaxTasksError; end
@@ -67,5 +71,9 @@ module WaxTasks
     # Custom Error:
     # Cannot find _site directory to push to GitHub
     class MissingSite < WaxTasksError; end
+
+    # Custom Error:
+    # Cannot find IIIF source image files
+    class MissingIiifSrc < WaxTasksError; end
   end
 end

data/lib/wax_tasks/iiif/derivatives.rb

@@ -0,0 +1,86 @@
+module WaxTasks
+  # Module of helper functions for WaxTasks::IiiifCollection class
+  module Iiif
+    # Helpers for creating Iiif derivatives for a Collection
+    # via `wax:derivatives:iiif` Rake task
+    module Derivatives
+      # @return [Hash] base WaxIiif::ImageRecord opts from item
+      def base_opts(item)
+        opts = { is_primary: false }
+        opts[:description] = item.dig(description).to_s unless description.nil?
+        opts[:attribution] = item.dig(attribution).to_s unless attribution.nil?
+        opts[:logo]        = "{{ '#{logo}' | absolute_url }}" unless logo.nil?
+        opts
+      end
+
+      # @return [Array] Set of WaxIiif::ImageRecords
+      def iiif_records(source_data)
+        records = []
+        source_data.each do |d|
+          item = @metadata.detect { |m| m['pid'] == d[:pid] } || {}
+          opts = base_opts(item)
+          if d[:images].length == 1
+            opts[:id]         = d[:pid]
+            opts[:path]       = d[:images].first
+            opts[:label]      = item.fetch(label.to_s, d[:pid])
+            opts[:is_primary] = true
+
+            records << WaxIiif::ImageRecord.new(opts)
+          else
+            item_records = []
+            d[:images].each do |i|
+              img_id = File.basename(i, '.*').to_s
+
+              opts[:id]             = "#{d[:pid]}_#{img_id}"
+              opts[:manifest_id]    = d[:pid]
+              opts[:path]           = i
+              opts[:label]          = item.fetch(label.to_s, d[:pid])
+              opts[:section_label]  = img_id
+
+              item_records << WaxIiif::ImageRecord.new(opts)
+            end
+            item_records.first.is_primary = true
+            records += item_records
+          end
+          records.flatten
+        end
+        records
+      end
+
+      # Opens IIIF JSON files and prepends yaml front matter
+      # So that liquid vars can be read by Jekyll
+      #
+      # @return [Nil]
+      def add_yaml_front_matter(dir)
+        Dir["#{dir}/**/*.json"].each do |file|
+          front_matter = "---\nlayout: none\n---\n"
+          filestring = File.read(file)
+          next if filestring.start_with?(front_matter)
+          begin
+            json = JSON.parse(filestring)
+            File.open(file, 'w') do |f|
+              f.puts(front_matter)
+              f.puts(JSON.pretty_generate(json))
+            end
+          rescue StandardError => e
+            raise Error::InvalidJSON, "IIIF JSON in #{file} is invalid.\n#{e}"
+          end
+        end
+      end
+
+      # @return [Nil]
+      def add_iiif_derivative_info_to_metadata(manifests)
+        manifests.map do |m|
+          json = JSON.parse(m.to_json)
+          pid = m.base_id
+          @metadata.find { |i| i['pid'] == pid }.tap do |hash|
+            hash['manifest']  = Utils.rm_liquid(json['@id'])
+            hash['thumbnail'] = Utils.rm_liquid(json['thumbnail'])
+            hash['full']      = hash['thumbnail'].sub('250,/0', '1140,/0')
+          end
+        end
+        overwrite_metadata
+      end
+    end
+  end
+end

data/lib/wax_tasks/iiif/manifest.rb

@@ -0,0 +1,26 @@
+module WaxTasks
+  module Iiif
+    # Module for handling metadata in IIIF manifests
+    module Manifest
+      # @return [String]
+      def label
+        @image_config.dig('iiif', 'label')
+      end
+
+      # @return [String]
+      def description
+        @image_config.dig('iiif', 'description')
+      end
+
+      # @return [String]
+      def attribution
+        @image_config.dig('iiif', 'attribution')
+      end
+
+      # @return [String]
+      def logo
+        @image_config.dig('iiif', 'logo')
+      end
+    end
+  end
+end

data/lib/wax_tasks/image_collection.rb

@@ -0,0 +1,137 @@
+require 'wax_iiif'
+require 'mini_magick'
+
+require_relative 'iiif/derivatives'
+require_relative 'iiif/manifest'
+
+module WaxTasks
+  # A Jekyll collection with image configuration + data
+  class ImageCollection < Collection
+    attr_reader :output_dir, :metadata, :data
+
+    include WaxTasks::Iiif::Derivatives
+    include WaxTasks::Iiif::Manifest
+
+    # Creates a new IiifCollection with name @name given site config @site
+    def initialize(name, site)
+      super(name, site)
+
+      @image_config = @config.dig('images')
+
+      raise Error::InvalidCollection, "No image configuration found for collection '#{@name}'" if @image_config.nil?
+
+      @data_source = self.image_source_directory
+      @output_dir  = Utils.root_path(@site[:source_dir], DEFAULT_DERIVATIVE_DIR)
+      @data        = self.image_data
+      @metadata    = ingest_file(self.metadata_source_path)
+      @variants    = WaxTasks::DEFAULT_IMAGE_VARIANTS
+    end
+
+    # Combines and described source image data including:
+    # single image items, items from subdirectories of images,
+    # and pdf documents.
+    #
+    # @return [Array] array of hashes relating item pids to image asset paths
+    def image_data
+      [single_image_items, multi_image_items, pdf_items].flatten.compact
+    end
+
+    # @return [String]
+    def image_source_directory
+      source = @image_config.dig('source')
+      raise WaxIiif::Error::InvalidImageData, 'No image source directory specified.' if source.nil?
+      path_to_image_source = Utils.root_path(@site[:source_dir], '_data/', source, '/')
+      raise Error::MissingIiifSrc, "Cannot find IIIF source directory #{path_to_image_source}" unless Dir.exist?(path_to_image_source)
+      raise Error::MissingIiifSrc, "No IIIF source data was found in #{path_to_image_source}" if Dir["#{path_to_image_source}/*"].empty?
+      path_to_image_source
+    end
+
+    # Gets the items with 1 image asset
+    #
+    # @return [Array] array of hashes relating pids to image paths
+    def single_image_items
+      Dir["#{@data_source}*.{jpg, jpeg, tiff, png}"].map do |d|
+        { pid: File.basename(d, '.*'), images: [d] }
+      end
+    end
+
+    # Gets the items with multiple image assets
+    #
+    # @return [Array] array of hashes relating pids to image paths
+    def multi_image_items
+      Dir["#{@data_source}*/"].map do |d|
+        images = Dir["#{d}*.{jpg, jpeg, tiff, png}"]
+        { pid: File.basename(d, '.*'), images: images.sort }
+      end
+    end
+
+    # Gets the items from pdf documents
+    #
+    # @return [Array] array of hashes relating pids to image paths
+    def pdf_items
+      Dir["#{@data_source}*.pdf"].map do |d|
+        pid = File.basename(d, '.pdf')
+        dir = "#{@data_source}/#{pid}"
+        next if Dir.exist?(dir)
+        { pid: pid, images: split_pdf(d) }
+      end
+    end
+
+    #
+    #
+    # @return [Array] array of image paths generated from pdf split
+    def split_pdf(pdf)
+      split_opts = { output_dir: @data_source, verbose: true }
+      WaxIiif::Utilities::PdfSplitter.split(pdf, split_opts).sort
+    end
+
+    def build_simple_derivatives
+      simple_output_dir = "#{@output_dir}/simple"
+      @data.each do |d|
+        d[:images].each_with_index do |img, index|
+          asset_id    = img.gsub(@data_source, '').gsub('.jpg', '').tr('/', '_')
+          asset_path  = "#{simple_output_dir}/#{asset_id}"
+          item_record = @metadata.find { |record| record['pid'] == d[:pid] }
+
+          FileUtils.mkdir_p(asset_path)
+
+          @variants.each do |label, width|
+            variant_path = "#{asset_path}/#{label}.jpg"
+            unless item_record.nil? || index.positive?
+              item_record[label.to_s] = variant_path.gsub(/^./, '')
+            end
+            next puts "skipping #{variant_path}" if File.exist?(variant_path)
+
+            image = MiniMagick::Image.open(img)
+            image.resize(width)
+            image.format('jpg')
+            image.write(variant_path)
+          end
+        end
+      end
+      self.overwrite_metadata
+    end
+
+    # Creates a WaxIiif::Builder object,
+    # builds the IIIF derivatives and json, and
+    # makes them usable for Jekyll/Wax
+    #
+    # @return [Nil]
+    def build_iiif_derivatives
+      iiif_output_dir = "#{@output_dir}/iiif"
+      jekyll_prefix = "{{ '' | absolute_url }}/#{DEFAULT_DERIVATIVE_DIR}/iiif"
+      build_opts = {
+        base_url: jekyll_prefix,
+        output_dir: iiif_output_dir,
+        variants: DEFAULT_IMAGE_VARIANTS,
+        verbose: true,
+        collection_label: @name
+      }
+      builder = WaxIiif::Builder.new(build_opts)
+      builder.load(iiif_records(@data))
+      builder.process_data
+      add_iiif_derivative_info_to_metadata(builder.manifests)
+      add_yaml_front_matter(iiif_output_dir)
+    end
+  end
+end

data/lib/wax_tasks/lunr/index.rb

@@ -0,0 +1,82 @@
+require_relative 'page_set'
+
+module WaxTasks
+  module Lunr
+    # A Lunr::Index document that combines data from all collections
+    # in site config that have `lunr_index` parameters.
+    #
+    # @attr collections [Array] a list of LunrCollection objects
+    # @attr fields [Array] shared list of fields to index among LunrCollections
+    class Index
+      attr_reader :collections, :index_path, :fields
+
+      # Creates a new LunrIndex object
+      def initialize(site, index_path, collections)
+        raise Error::NoLunrCollections, 'No collections were configured to index' if collections.nil?
+        raise Error::NoLunrCollections, 'No path was given for index file' if index_path.nil?
+
+        @collections = collections.keys.map! do |c|
+          Lunr::PageSet.new(c, collections[c], site)
+        end
+
+        @index_path = index_path
+        @fields     = self.total_fields
+      end
+
+      # @return [Array] shared list of fields to index among indexed collections
+      def total_fields
+        @collections.map { |c| c.data.map(&:keys) }.flatten.uniq
+      end
+
+      # @return [String] writes index as pretty JSON with YAML front-matter
+      def to_s
+        data = @collections.map(&:data).flatten
+        data.each_with_index.map { |m, id| m['lunr_index'] = id }
+        "---\nlayout: none\n---\n#{JSON.pretty_generate(data)}"
+      end
+
+      # Creates a default LunrUI / JS file for displaying the Index
+      #
+      # @return [String]
+      def default_ui
+        <<~HEREDOC
+          ---
+          layout: none
+          ---
+          $.getJSON("{{ '#{@index_path}' | absolute_url }}", function(index_json) {
+            window.index = new elasticlunr.Index;
+            window.store = index_json;
+            index.saveDocument(false);
+            index.setRef('lunr_index');
+            #{@fields.map { |f| "index.addField('#{f}');" }.join("\n\t")}
+            // add docs
+            for (i in store){
+              index.addDoc(store[i]);
+            }
+            $('input#search').on('keyup', function() {
+              var results_div = $('#results');
+              var query = $(this).val();
+              var results = index.search(query, { boolean: 'AND', expand: true });
+              results_div.empty();
+              for (var r in results) {
+                var ref = results[r].ref;
+                var item = store[ref];
+                var pid = item.pid;
+                var label = item.label;
+                var meta = `#{@fields.except(%w[pid label]).take(3).map { |f| "${item.#{f}}" }.join(' | ')}`;
+                if ('thumbnail' in item) {
+                  var thumb = `<img class='sq-thumb-sm' src='{{ "" | absolute_url }}${item.thumbnail}'/>&nbsp;&nbsp;&nbsp;`
+                }
+                else {
+                  var thumb = '';
+                }
+                var result = `<div class="result"><a href="${item.link}">${thumb}<p><span class="title">${item.label}</span><br>${meta}</p></a></p></div>`;
+                results_div.append(result);
+              }
+            });
+          });
+        HEREDOC
+      end
+    end
+  end
+end

data/lib/wax_tasks/lunr/page_set.rb

@@ -0,0 +1,57 @@
+module WaxTasks
+  module Lunr
+    # Class representing a directory of markdown pages
+    # to be indexed by a Lunr::Index
+    class PageSet
+      attr_reader :data
+
+      def initialize(name, config, site)
+        @name     = name
+        @fields   = config.dig('fields')
+
+        raise Error::MissingFields, "Cannot find fields to index collection #{@name}" if @fields.nil?
+
+        @content  = !!config.dig('content')
+        @page_dir = Utils.root_path(site[:source_dir], site[:collections_dir], "_#{@name}")
+        @data     = self.ingest_pages
+      end
+
+      # Finds the page_dir of markdown pages for the collection and ingests
+      # them as an array of hashes
+      #
+      # @return [Array] array of the loaded markdown pages loaded as hashes
+      def ingest_pages
+        data  = []
+        pages = Dir.glob("#{@page_dir}/*.md")
+        puts "There are no pages in #{@page_dir} to index.".orange if pages.empty?
+        pages.each do |p|
+          begin
+            data << load_page(p)
+          rescue StandardError => e
+            raise Error::LunrPageLoad, "Cannot load page #{p}\n#{e}"
+          end
+        end
+        data
+      end
+
+      # Reads in a markdown file and converts it to a hash
+      # with the values from @fields.
+      # Adds the content of the file (below the YAML) if @content == true
+      #
+      # @param page [String] the path to a markdown page to load
+      def load_page(page)
+        yaml = YAML.load_file(page)
+        hash = {
+          'link' => "{{'#{yaml.fetch('permalink')}' | absolute_url }}",
+          'collection' => @name
+        }
+        content         = WaxTasks::Utils.html_strip(File.read(page))
+        hash['content'] = WaxTasks::Utils.remove_diacritics(content) if @content
+        fields          = @fields.push('pid').push('label').uniq
+        fields.push('thumbnail') if yaml.key?('thumbnail')
+        fields.each { |f| hash[f] = yaml.dig(f).lunr_normalize }
+        hash
+      end
+    end
+  end
+end

data/lib/wax_tasks/pagemaster_collection.rb

@@ -2,29 +2,21 @@ module WaxTasks
   # A Jekyll collection with a data source file that
   # can generate markdown pages from that data.
   #
-  # @attr source  [String]  the path to the data source file
-  # @attr layout  [String]  the Jekyll layout to be used by the generated pages
-  # @attr data    [Array]   array of hashes representing the ingested data file
-  # @attr ordered [Boolean] whether/not the order of items should be preserved
+  # @attr config    [Hash]    the collection config
+  # @attr layout    [String]  Jekyll layout to be used by the generated pages
+  # @attr ordered   [Boolean] whether/not the order of items should be preserved
+  # @attr metadata  [Array]   array of hashes from ingested metadata file
   class PagemasterCollection < Collection
-    attr_reader :source, :layout, :data, :ordered
+    attr_reader :layout, :ordered, :metadata
 
     # Creates a new PagemasterCollection with name @name given site config @site
     def initialize(name, site)
       super(name, site)
 
-      @source   = source_path
+      @config   = self.config
       @layout   = assert_layout
-      @data     = ingest_file(@source)
       @ordered  = @config.fetch('keep_order', false)
-    end
-
-    # Constructs the path to the data source file
-    #
-    # @return [String] the path to the data source file
-    def source_path
-      raise WaxTasks::Error::MissingSource, "Missing collection source in _config.yml for #{@name}" unless @config.key? 'source'
-      WaxTasks::Utils.make_path(@site[:source_dir], '_data', @config['source'])
+      @metadata = ingest_file(self.metadata_source_path)
     end
 
     # Confirms + requires `layout` value in the collection @config
@@ -35,24 +27,25 @@ module WaxTasks
       @config['layout']
     end
 
-    # Writes markdown pages from the ingested data to @page_dir
+    # Writes markdown pages from the ingested data to page_dir
     # with layout, permalink, and order info added (if applicable)
     #
     # @return [Array] a copy of the pages as hashes, for testing
     def generate_pages
-      FileUtils.mkdir_p(@page_dir)
+      page_dir = self.page_dir
+      FileUtils.mkdir_p(page_dir)
       pages = []
-      @data.each_with_index do |item, idx|
+      @metadata.each_with_index do |item, idx|
         page_slug         = Utils.slug(item.fetch('pid'))
-        path              = "#{@page_dir}/#{page_slug}.md"
+        path              = "#{page_dir}/#{page_slug}.md"
         item['permalink'] = "/#{@name}/#{page_slug}#{@site[:permalink]}"
         item['layout']    = @layout
-        item['order']     = padded_int(idx, @data.length) if @ordered
+        item['order']     = padded_int(idx, @metadata.length) if @ordered
         pages << item
         next "#{page_slug}.md already exits. Skipping." if File.exist?(path)
         File.open(path, 'w') { |f| f.write("#{item.to_yaml}---") }
       end
-      puts "#{@data.length} pages were generated to #{@page_dir} directory.".cyan
+      puts "#{@metadata.length} pages were generated to #{page_dir} directory.".cyan
       pages
     end
 

data/lib/wax_tasks/task_runner.rb

@@ -21,18 +21,19 @@ module WaxTasks
     # @example use default config from file
     #   WaxTasks::TaskRunner.new
     def initialize(config = {}, env = 'prod')
-      config = YAML.load_file(DEFAULT_CONFIG).symbolize_keys if config.empty?
+      @config = YAML.load_file(DEFAULT_CONFIG).symbolize_keys if config.empty?
       @site = {
         env:              env,
-        title:            config.fetch(:title, ''),
-        url:              config.fetch(:url, ''),
-        baseurl:          config.fetch(:baseurl, ''),
-        repo_name:        config.fetch(:repo_name, ''),
-        source_dir:       config.fetch(:source, nil),
-        collections_dir:  config.fetch(:collections_dir, nil),
-        collections:      config.fetch(:collections, {}),
-        js:               config.fetch(:js, false),
-        permalink:        Utils.construct_permalink(config)
+        title:            @config.dig(:title),
+        url:              @config.dig(:url),
+        baseurl:          @config.dig(:baseurl),
+        repo_name:        @config.dig(:repo_name),
+        source_dir:       @config.dig(:source),
+        collections_dir:  @config.dig(:collections_dir),
+        collections:      @config.dig(:collections),
+        lunr_index:       @config.dig(:lunr_index),
+        js:               @config.dig(:js),
+        permalink:        Utils.construct_permalink(@config)
       }
     rescue StandardError => e
       raise Error::InvalidSiteConfig, "Could not load _config.yml. => #{e}"
@@ -69,18 +70,20 @@ module WaxTasks
     # @param generate_ui [Boolean] whether/not to generate a default lunr UI
     # @return [Nil]
     def lunr(generate_ui: false)
-      lunr_collections = Utils.get_lunr_collections(@site)
-      lunr_collections.map! { |name| LunrCollection.new(name, @site) }
+      @site[:lunr_index].each do |i|
+        file        = i.dig('file')
+        ui          = i.dig('ui')
+        collections = i.dig('collections')
+        index       = Lunr::Index.new(@site, file, collections)
 
-      index = LunrIndex.new(lunr_collections)
-      index_path = Utils.make_path(@site[:source_dir], LUNR_INDEX_PATH)
+        index_path = Utils.root_path(@site[:source_dir], file)
+        FileUtils.mkdir_p(File.dirname(index_path))
+        File.open(index_path, 'w') { |f| f.write(index.to_s) }
+        puts "Writing lunr search index to #{index_path}.".cyan
 
-      FileUtils.mkdir_p(File.dirname(index_path))
-      File.open(index_path, 'w') { |f| f.write(index) }
-      puts "Writing lunr search index to #{index_path}.".cyan
-
-      if generate_ui
-        ui_path = Utils.make_path(@site[:source_dir], LUNR_UI_PATH)
+        next unless generate_ui
+        raise Error::WaxTasksError, 'Cannot generate default UI because no path was given' if ui.nil?
+        ui_path = Utils.root_path(@site[:source_dir], ui)
         puts "Writing default lunr UI to #{ui_path}.".cyan
         File.open(ui_path, 'w') { |f| f.write(index.default_ui) }
       end
@@ -92,9 +95,18 @@ module WaxTasks
     #
     # @param args [Array] the arguments/collection names from wax:pagemaster
     # @return [Nil]
-    def iiif(args)
+    def derivatives_iiif(args)
+      args.each do |name|
+        iiif_collection = ImageCollection.new(name, @site)
+        iiif_collection.build_iiif_derivatives
+      end
+    end
+
+    # @return [Nil]
+    def derivatives_simple(args)
       args.each do |name|
-        IiifCollection.new(name, @site).process
+        image_collection = ImageCollection.new(name, @site)
+        image_collection.build_simple_derivatives
       end
     end
 
@@ -107,7 +119,7 @@ module WaxTasks
       names = []
       package = {
         'name'          => site[:title],
-        'version'       => '1.0.0',
+        'version'       => @config.fetch(:version, ''),
         'dependencies'  => {}
       }
       site[:js].each do |dependency|

data/lib/wax_tasks/utils.rb

@@ -75,19 +75,8 @@ module WaxTasks
     #
     # @param  args [Array] items to concatenate in path
     # @return [String] file path
-    def self.make_path(*args)
-      args.compact.reject(&:empty?).join('/')
-    end
-
-    # Finds collections in site config where `lunr_index` is enabled
-    #
-    # @param  site [Hash] the site config
-    # @return [Array] a list of collection names
-    # @raise WaxTasks::Error::NoLunrCollections
-    def self.get_lunr_collections(site)
-      to_index = site[:collections].find_all { |c| c[1].key?('lunr_index') }
-      raise Error::NoLunrCollections, 'There are no lunr collections to index.' if to_index.nil?
-      to_index.map { |c| c[0] }
+    def self.root_path(*args)
+      ['.'].concat(args).compact.reject(&:empty?).join('/').gsub(%r{/+}, '/')
     end
 
     # Removes YAML front matter from a string
@@ -96,6 +85,10 @@ module WaxTasks
       str.to_s.gsub!(/\A---(.|\n)*?---/, '')
     end
 
+    def self.rm_liquid(str)
+      str.gsub(/{{.*}}/, '')
+    end
+
     # Cleans YAML front matter + markdown pages for lunr indexing
     # @return [String]
     def self.html_strip(str)
@@ -163,6 +156,10 @@ class Array
       WaxTasks::Utils.remove_diacritics(self.join(', '))
     end
   end
+
+  def except(value)
+    self - value
+  end
 end
 
 # Monkey-patched Hash class

data/lib/wax_tasks.rb

@@ -1,10 +1,9 @@
 require_relative 'wax_tasks/branch'
 require_relative 'wax_tasks/collection'
 require_relative 'wax_tasks/error'
-require_relative 'wax_tasks/iiif_collection'
+require_relative 'wax_tasks/image_collection'
 require_relative 'wax_tasks/local_branch'
-require_relative 'wax_tasks/lunr_collection'
-require_relative 'wax_tasks/lunr_index'
+require_relative 'wax_tasks/lunr/index'
 require_relative 'wax_tasks/pagemaster_collection'
 require_relative 'wax_tasks/task_runner'
 require_relative 'wax_tasks/travis_branch'
@@ -12,12 +11,13 @@ require_relative 'wax_tasks/utils'
 
 # The WaxTasks module powers the Rake tasks in `./tasks`, including:
 #
-# wax:pagemaster  :: generate collection md pages from csv, json, or yaml file
-# wax:lunr        :: build lunr search index (with default UI if UI=true)
-# wax:iiif        :: generate iiif derivatives from local image files
-# wax:jspackage   :: write a simple package.json for monitoring js dependencies
-# wax:push        :: push compiled Jekyll site to git branch
-# wax:test        :: run htmlproofer, rspec if .rspec file exists
+# wax:pagemaster          :: generate collection md pages from csv, json, or yaml file
+# wax:lunr                :: build lunr search index (with default UI if UI=true)
+# wax:derivatives:simple  :: generate simple image derivatives from local image files
+# wax:derivatves:iiif     :: generate iiif derivatives from local image files
+# wax:jspackage           :: write a simple package.json for monitoring js dependencies
+# wax:push                :: push compiled Jekyll site to git branch
+# wax:test                :: run htmlproofer, rspec if .rspec file exists
 #
 # Tasks are run by a WaxTasks::TaskRunner object which is resposible
 # for reading in site config from `_config.yml`
@@ -27,11 +27,17 @@ module WaxTasks
   # ----------
 
   # @return [String] The path to load Jekyll site config
-  DEFAULT_CONFIG  = '_config.yml'.freeze
-  # @return [String] The path to write WaxTasks::LunrIndex
-  LUNR_INDEX_PATH = 'js/lunr-index.json'.freeze
+  DEFAULT_CONFIG          = '_config.yml'.freeze
+
   # @return [String] The path to write default LunrUI
-  LUNR_UI_PATH    = 'js/lunr-ui.js'.freeze
+  LUNR_UI_PATH            = 'js/lunr-ui.js'.freeze
+
   # @return [String] The path to the compiled Jekyll site
-  SITE_DIR        = './_site'.freeze
+  SITE_DIR                = '_site'.freeze
+
+  # @return [String] Default image variant/derivative widths to generate
+  DEFAULT_IMAGE_VARIANTS  = { thumbnail: 250, full: 1140 }.freeze
+
+  # @return [String] The path where image derivatives should be generated
+  DEFAULT_DERIVATIVE_DIR  = 'img/derivatives'.freeze
 end

data/spec/setup.rb

@@ -3,7 +3,7 @@ require 'fileutils'
 #constants
 ROOT    = `pwd`.strip.freeze
 SAMPLE  = "#{ROOT}/spec/sample_site".freeze
-BUILD   = "#{ROOT}/build".freeze
+BUILD   = "#{ROOT}/test_build".freeze
 
 # helper methods
 def quiet_stdout
@@ -32,7 +32,7 @@ module WaxTasks::Test
   def self.reset
     Dir.chdir(ROOT)
     FileUtils.rm_r(BUILD) if File.directory?(BUILD)
-    FileUtils.copy_entry SAMPLE, BUILD
+    FileUtils.copy_entry(SAMPLE, BUILD)
     Dir.chdir(BUILD)
   end
 end

data/spec/spec_helper.rb

@@ -18,6 +18,6 @@ shared_context 'shared', :shared_context => :metadata do
   let(:task_runner) { WaxTasks::TaskRunner.new }
   let(:default_site) { task_runner.site }
   let(:args) { default_site[:collections].map{ |c| c[0] } }
-  let(:index_path) { WaxTasks::LUNR_INDEX_PATH }
-  let(:ui_path) { WaxTasks::LUNR_UI_PATH }
+  let(:index_path) { "#{BUILD}/js/lunr-index.json" }
+  let(:ui_path) { "#{BUILD }/js/lunr-ui.js" }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wax_tasks
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 1.0.0.pre.beta
 platform: ruby
 authors:
 - Marii Nyrop
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-21 00:00:00.000000000 Z
+date: 2018-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: html-proofer
@@ -16,56 +16,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '3.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '3.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '12.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: wax_iiif
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -102,7 +102,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
-- lib/tasks/iiif.rake
+- lib/tasks/derivatives_iiif.rake
+- lib/tasks/derivatives_simple.rake
 - lib/tasks/jspackage.rake
 - lib/tasks/lunr.rake
 - lib/tasks/pagemaster.rake
@@ -112,10 +113,12 @@ files:
 - lib/wax_tasks/branch.rb
 - lib/wax_tasks/collection.rb
 - lib/wax_tasks/error.rb
-- lib/wax_tasks/iiif_collection.rb
+- lib/wax_tasks/iiif/derivatives.rb
+- lib/wax_tasks/iiif/manifest.rb
+- lib/wax_tasks/image_collection.rb
 - lib/wax_tasks/local_branch.rb
-- lib/wax_tasks/lunr_collection.rb
-- lib/wax_tasks/lunr_index.rb
+- lib/wax_tasks/lunr/index.rb
+- lib/wax_tasks/lunr/page_set.rb
 - lib/wax_tasks/pagemaster_collection.rb
 - lib/wax_tasks/task_runner.rb
 - lib/wax_tasks/travis_branch.rb
@@ -137,11 +140,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements:
 - imagemagick
+- ghostscript
 rubyforge_project: 
 rubygems_version: 2.7.6
 signing_key: 

data/lib/tasks/iiif.rake

@@ -1,11 +0,0 @@
-require 'wax_tasks'
-
-namespace :wax do
-  desc 'generate iiif derivatives from local image files'
-  task :iiif do
-    ARGS = ARGV.drop(1).each { |a| task a.to_sym }
-    abort "You must specify a collection after 'wax:iiif'" if ARGS.empty?
-    task_runner = WaxTasks::TaskRunner.new
-    task_runner.iiif(ARGS)
-  end
-end

data/lib/wax_tasks/iiif_collection.rb

@@ -1,105 +0,0 @@
-require 'wax_iiif'
-
-module WaxTasks
-  # A Jekyll collection with IIIF configuration + data
-  #
-  # @attr src_data    [String]  the path to the data source file
-  # @attr iiif_config [Hash]    the iiif configuration for the collection
-  # @attr meta        [Array]   metadata k,v rules
-  # @attr variants    [Hash]    image variants to generate e.g. { med: 650 }
-  # @attr src_dir     [String]  path to existing iiif source images
-  # @attr target_dir  [String]  target path for iiif derivatives
-  class IiifCollection < Collection
-    attr_reader :variants, :meta, :target_dir
-
-    # Creates a new IiifCollection with name @name given site config @site
-    def initialize(name, site)
-      super(name, site)
-
-      @src_data     = @config.fetch('source', nil)
-      @iiif_config  = @config.fetch('iiif', {})
-      @meta         = @iiif_config.fetch('meta', nil)
-      @variants     = validated_variants
-      @src_dir      = Utils.make_path(@site[:source_dir],
-                                      '_data/iiif',
-                                      @name)
-      @target_dir   = Utils.make_path(@site[:source_dir],
-                                      'iiif',
-                                      @name)
-    end
-
-    # Main method for generating iiif derivatives and json
-    # @return [Nil]
-    def process
-      raise Error::MissingIiifSrc, "Cannot find IIIF source directory #{@src_dir}" unless Dir.exist?(@src_dir)
-      FileUtils.mkdir_p(@target_dir, verbose: false)
-      builder = iiif_builder
-      builder.load(iiif_records)
-      builder.process_data(true)
-    end
-
-    # Creates a IiifS3::Builder object from collection config
-    # @return [Object]
-    def iiif_builder
-      build_opts = {
-        base_url: "#{@site[:baseurl]}/iiif/#{@name}",
-        output_dir: @target_dir,
-        verbose: true,
-        variants: @variants
-      }
-      IiifS3::Builder.new(build_opts)
-    end
-
-    # Gets custom image variants from collection config if available
-    # Else returns default variants { med: 600, lg: 1140 } to Builder
-    #
-    # @return [Hash]
-    def validated_variants
-      vars = @iiif_config.fetch('variants', false)
-      if vars.is_a?(Array) && vars.all? { |v| v.is_a?(Integer) }
-        variants = {}
-        vars.each_with_index do |v, i|
-          variants["custom_variant_#{i}".to_sym] = v
-        end
-      else
-        variants = { med: 600, lg: 1140 }
-      end
-      variants
-    end
-
-    # Creates an array of IIIfS3 ImageRecords from the collection config
-    # for the IiifS3 Builder to process
-    #
-    # @return [Array]
-    def iiif_records
-      records = []
-      source_images = Dir["#{@src_dir}/*"].sort!
-      if @meta && @src_data
-        src_path = Utils.make_path(@site[:source_dir], '_data', @src_data)
-        metadata = ingest_file(src_path)
-      else
-        metadata = false
-      end
-      source_images.each { |src_img| records << iiif_record(src_img, metadata) }
-      records
-    end
-
-    # Creates an individual IiifS3 ImageRecord
-    # with metadata from source data file if available
-    #
-    # @param  src_img  [String]  path to the original source image
-    # @param  metadata [Hash]    metadata to add to the item if available
-    # @return [Object]
-    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 do |i|
-          record_opts[i.first[0].to_sym] = src_item.fetch(i.first[1], '')
-        end
-      end
-      IiifS3::ImageRecord.new(record_opts)
-    end
-  end
-end

data/lib/wax_tasks/lunr_collection.rb

@@ -1,62 +0,0 @@
-module WaxTasks
-  # A Jekyll collection to be Indexed in a Lunr Index / JSON file
-  # for client-side search.
-  #
-  # @attr index_config  [Hash]    the collection's lunr_index config
-  # @attr content       [Boolean] whether/not page content should be indexed
-  # @attr fields        [Array]   the fields (i.e., keys) that should be indexed
-  # @attr data          [Array]   hash array of data from the ingested pages
-  class LunrCollection < Collection
-    attr_accessor :fields, :data
-
-    # Creates a new LunrCollection with name @name given site config @site
-    def initialize(name, site)
-      super(name, site)
-
-      @index_config = @config['lunr_index']
-      @content      = @index_config.fetch('content', false)
-      @fields       = @index_config.fetch('fields', [])
-      @data         = ingest_pages
-
-      raise Error::MissingFields, "There are no fields for #{@name}.".magenta if @fields.empty?
-    end
-
-    # Finds the @page_dir of markdown pages for the collection and ingests
-    # them as an array of hashes
-    #
-    # @return [Array] array of the loaded markdown pages loaded as hashes
-    def ingest_pages
-      data  = []
-      pages = Dir.glob("#{@page_dir}/*.md")
-      puts "There are no pages in #{@page_dir} to index.".cyan if pages.empty?
-      pages.each do |p|
-        begin
-          data << load_page(p)
-        rescue StandardError => e
-          raise Error::LunrPageLoad, "Cannot load page #{p}\n#{e}"
-        end
-      end
-      data
-    end
-
-    # Reads in a markdown file and converts it to a hash
-    # with the values from @fields.
-    # Adds the content of the file (below the YAML) if @content == true
-    #
-    # @param page [String] the path to a markdown page to load
-    def load_page(page)
-      yaml = YAML.load_file(page)
-      hash = {
-        'link' => "{{'#{yaml.fetch('permalink')}' | relative_url }}",
-        'collection' => @name
-      }
-      if @content
-        content = WaxTasks::Utils.html_strip(File.read(page))
-        hash['content'] = WaxTasks::Utils.remove_diacritics(content)
-      end
-      fields = @fields.push('pid').uniq
-      fields.each { |f| hash[f] = yaml[f].lunr_normalize }
-      hash
-    end
-  end
-end

data/lib/wax_tasks/lunr_index.rb

@@ -1,67 +0,0 @@
-module WaxTasks
-  # A LunrIndex document that combines data from all collections
-  # in site config that have `lunr_index` parameters.
-  #
-  # @attr collections [Array] a list of LunrCollection objects
-  # @attr fields [Array] shared list of fields to index among LunrCollections
-  class LunrIndex
-    attr_accessor :collections, :fields
-
-    # Creates a new LunrIndex object
-    def initialize(collections)
-      @collections  = collections
-      @fields       = total_fields
-    end
-
-    # @return [Array] shared list of fields to index among LunrCollections
-    def total_fields
-      total_fields = @collections.map(&:fields).reduce([], :concat)
-      total_fields.uniq
-    end
-
-    # @return [String] writes index data as pretty JSON with YAML front-matter
-    def to_s
-      data = @collections.map(&:data).flatten
-      data.each_with_index.map { |d, id| d['lunr_index'] = id }
-      "---\nlayout: none\n---\n#{JSON.pretty_generate(data)}"
-    end
-
-    # Creates a default LunrUI / JS file for displaying the Index
-    #
-    # @return [String]
-    def default_ui
-      <<~HEREDOC
-        ---
-        layout: none
-        ---
-        $.getJSON({{ site.baseurl }}/js/lunr-index.json, function(index_json) {
-          window.index = new elasticlunr.Index;
-          window.store = index_json;
-          index.saveDocument(false);
-          index.setRef('lunr_id');
-          #{@fields.map { |f| "index.addField('#{f}');" }.join("\n")}
-          // add docs
-          for (i in store){
-            index.addDoc(store[i]);
-          }
-          $('input#search').on('keyup', function() {
-            var results_div = $('#results');
-            var query = $(this).val();
-            var results = index.search(query, { boolean: 'AND', expand: true });
-            results_div.empty();
-            if (results.length > 10) {
-              results_div.prepend("<p><small>Displaying 10 of " + results.length + " results.</small></p>");
-            }
-            for (var r in results.slice(0, 9)) {
-              var ref = results[r].ref;
-              var item = store[ref];
-              #{@fields.map { |f| "var #{f} = item.#{f};" }.join("\n")}
-              var result = '<div class="result"><b><a href="' + item.link + '">' + title + '</a></b></p></div>';
-              results_div.append(result);
-            }
-          });
-        });
-      HEREDOC
-    end
-  end
-end