wax_tasks 0.3.2 → 1.1.0

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/tasks/jspackage.rake

@@ -1,14 +0,0 @@
-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?
-      path = WaxTasks::Utils.make_path(task_runner.site[:source_dir],
-                                       'package.json')
-      File.open(path, 'w') { |f| f.write(package.to_json) }
-    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
-    ARGS = ARGV.drop(1).each { |a| task a.to_sym }
-    raise 'You must specify a collection after wax:pagemaster' if ARGS.empty?
-    task_runner = WaxTasks::TaskRunner.new
-    task_runner.pagemaster(ARGS)
-  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
-    ARGS = ARGV.drop(1).each { |a| task a.to_sym }
-    raise 'You must specify a branch after \'wax:push:branch\'' if ARGS.empty?
-
-    task_runner = WaxTasks::TaskRunner.new
-    task_runner.push_branch(ARGS.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,67 +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
-    def initialize(site, target)
-      @site   = site
-      @target = target
-    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)
-        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_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/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_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

data/lib/wax_tasks/pagemaster_collection.rb

@@ -1,67 +0,0 @@
-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
-  class PagemasterCollection < Collection
-    attr_reader :source, :layout, :data, :ordered
-
-    # Creates a new PagemasterCollection with name @name given site config @site
-    def initialize(name, site)
-      super(name, site)
-
-      @source   = source_path
-      @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'])
-    end
-
-    # Confirms + requires `layout` value in the collection @config
-    #
-    # @return [String] the Jekyll layout to be used by the generated pages
-    def assert_layout
-      raise WaxTasks::Error::MissingLayout, "Missing collection layout in _config.yml for #{@name}" unless @config.key? 'layout'
-      @config['layout']
-    end
-
-    # 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)
-      pages = []
-      @data.each_with_index do |item, idx|
-        page_slug         = Utils.slug(item.fetch('pid'))
-        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
-        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
-      pages
-    end
-
-    # Constructs the order variable for each page (if the collection
-    # needs to preserve the order of items from the file)
-    #
-    # @return [Integer] the order if the item padded with '0's for sorting
-    def padded_int(idx, max_idx)
-      idx.to_s.rjust(Math.log10(max_idx).to_i + 1, '0')
-    end
-  end
-end