wax_tasks 1.0.0.pre.beta → 1.0.0

data/lib/tasks/jspackage.rake

@@ -1,17 +0,0 @@
-require 'json'
-require 'wax_tasks'
-
-namespace :wax do
-  desc 'write a simple package.json for monitoring js dependencies'
-  task :jspackage do
-    task_runner = WaxTasks::TaskRunner.new
-    package = task_runner.js_package
-    unless package.empty?
-      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/lunr.rake

@@ -1,9 +0,0 @@
-require 'wax_tasks'
-
-namespace :wax do
-  desc 'build lunr search index (with default UI if UI=true)'
-  task :lunr do
-    task_runner = WaxTasks::TaskRunner.new
-    task_runner.lunr(generate_ui: !!ENV['UI'])
-  end
-end

data/lib/tasks/pagemaster.rake

@@ -1,11 +0,0 @@
-require 'wax_tasks'
-
-namespace :wax do
-  desc 'generate collection md pages from yaml or csv data source'
-  task :pagemaster do
-    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(arguments)
-  end
-end

data/lib/tasks/push.rake

@@ -1,12 +0,0 @@
-require 'wax_tasks'
-
-namespace :wax do
-  desc 'push compiled Jekyll site to git branch BRANCH'
-  task :push do
-    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(arguments.first)
-  end
-end

data/lib/tasks/test.rake

@@ -1,18 +0,0 @@
-require 'html-proofer'
-
-namespace :wax do
-  desc 'run htmlproofer, rspec if .rspec file exists'
-  task :test do
-    opts = {
-      check_external_hash: true,
-      allow_hash_href: true,
-      check_html: true,
-      disable_external: true,
-      empty_alt_ignore: true,
-      only_4xx: true,
-      verbose: true
-    }
-    HTMLProofer.check_directory('./_site', opts).run
-    system('bundle exec rspec') if File.exist?('.rspec')
-  end
-end

data/lib/wax_tasks/branch.rb

@@ -1,70 +0,0 @@
-require 'jekyll'
-require 'logger'
-require 'tmpdir'
-
-module WaxTasks
-  # Parent class representing a Git Branch
-  # that cannot be created directly. Only child classes
-  # (LocalBranch, TravisBranch) can be initialized.
-  #
-  # @attr target      [String] the name of the Git branch to deploy to
-  # @attr origin      [String] the current repository remote
-  # @attr commit_msg  [String] the commit message to use on push
-  # @attr baseurl     [String] the site baseurl to build with (if on gh-pages)
-  # @attr success_msg [String] informative message to be output to console
-  class Branch
-    attr_reader :target, :origin, :commit_msg, :baseurl, :success
-    private_class_method :new
-
-    # This method ensures child classes can be instantiated eventhough
-    # Branch.new cannot be.
-    def self.inherited(*)
-      public_class_method :new
-    end
-
-    # @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
-    # @return [Nil]
-    def rebuild
-      if @baseurl.empty?
-        msg = 'Building the gh-pages _site without a baseurl is not recommended'
-        Logger.new($stdout).warn(msg.orange)
-      end
-      FileUtils.rm_r(SITE_DIR) if File.directory?(WaxTasks::SITE_DIR)
-      opts = {
-        source: @site[:source_dir] || '.',
-        destination: WaxTasks::SITE_DIR,
-        config: WaxTasks::DEFAULT_CONFIG,
-        baseurl:  @baseurl,
-        verbose: true
-      }
-      Jekyll::Site.new(Jekyll.configuration(opts)).process
-    end
-
-    # Add, commmit, and push compiled Jekyll site to @target branch
-    # @return [Nil]
-    def push
-      if @site[:env] == 'prod'
-        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}"
-        puts @success_msg.cyan
-        system "git push origin master:refs/heads/#{@target} --force"
-      else
-        puts "Skipping build for branch '#{@target}' on env='test'".orange
-      end
-    end
-  end
-end

data/lib/wax_tasks/iiif/derivatives.rb

@@ -1,86 +0,0 @@
-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

@@ -1,26 +0,0 @@
-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

@@ -1,137 +0,0 @@
-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/local_branch.rb

@@ -1,21 +0,0 @@
-require 'time'
-
-module WaxTasks
-  # Branch object for `$ wax:push` task when run on local machine
-  # using local credentials
-  #
-  # @attr origin      [String] the current repository remote
-  # @attr commit_msg  [String] the commit message to use on push
-  # @attr baseurl     [String] the site baseurl to build with (if on gh-pages)
-  # @attr success_msg [String] informative message to be output to console
-  class LocalBranch < Branch
-    def initialize(site, target)
-      super(site, target)
-
-      @origin       = `git config --get remote.origin.url`.strip
-      @commit_msg   = "Updated via local task at #{Time.now.utc}"
-      @baseurl      = "/#{@origin.split('/').last.gsub('.git', '')}"
-      @success_msg  = "Deploying to #{@target} branch from local task."
-    end
-  end
-end

data/lib/wax_tasks/lunr/index.rb

@@ -1,82 +0,0 @@
-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