wax_tasks 1.0.0.pre.beta → 1.0.0

data/lib/wax_tasks/lunr/page_set.rb

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

@@ -1,60 +0,0 @@
-module WaxTasks
-  # A Jekyll collection with a data source file that
-  # can generate markdown pages from that data.
-  #
-  # @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 :layout, :ordered, :metadata
-
-    # Creates a new PagemasterCollection with name @name given site config @site
-    def initialize(name, site)
-      super(name, site)
-
-      @config   = self.config
-      @layout   = assert_layout
-      @ordered  = @config.fetch('keep_order', false)
-      @metadata = ingest_file(self.metadata_source_path)
-    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
-      page_dir = self.page_dir
-      FileUtils.mkdir_p(page_dir)
-      pages = []
-      @metadata.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, @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 "#{@metadata.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

data/lib/wax_tasks/task_runner.rb

@@ -1,148 +0,0 @@
-module WaxTasks
-  # Class for running the Rake tasks in ./tasks
-  # TaskRunner is responsible for loading and parsing the site config
-  # from `_config.yml`, which can be overridden with .override(opts)
-  #
-  # @attr site [Hash] main variables from site config normalized + symbolized
-  class TaskRunner
-    attr_reader :site
-
-    # Creates a new TaskRunner with a config hash or default config file
-    #
-    # @param env    [String]  test/prod. only affects Branch module
-    # @param config [Hash]    optional hash, should mirror a parsed _config.yml
-    # @example give a custom config
-    #   config = {
-    #     title:        'custom title',
-    #     url:          'custom.url',
-    #     collections:  {...}
-    #   }
-    #   WaxTasks::TaskRunner.new(config)
-    # @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?
-      @site = {
-        env:              env,
-        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}"
-    end
-
-    # Overrides a specific part of @site
-    #
-    # @param opts [Hash] part of the site config to be overwritten
-    # @example override title + url
-    #   runner = WaxTasks::TaskRunner.new
-    #   runner.override({ title: 'my new title', url: 'my-new.url' })
-    def override(opts)
-      opts.each { |k, v| @site[k] = v }
-      @site[:permalink] = Utils.construct_permalink(opts)
-      self
-    end
-
-    # Given an array of command line arguments `args`,
-    # creates a PagemasterCollection for each and generates markdown
-    # pages from its specified data `source` file
-    #
-    # @param args [Array] the arguments/collection names from wax:pagemaster
-    # @return [Nil]
-    def pagemaster(args)
-      args.each do |name|
-        PagemasterCollection.new(name, @site).generate_pages
-      end
-    end
-
-    # Creates a LunrCollection for each collection
-    # that has lunr_index parameters in the site config
-    # and generates a lunr-index.json file from the collection data
-    #
-    # @param generate_ui [Boolean] whether/not to generate a default lunr UI
-    # @return [Nil]
-    def lunr(generate_ui: false)
-      @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_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
-
-        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
-    end
-
-    # Given an array of command line arguments `args`,
-    # creates a IiifCollection for each and generates iiif
-    # derivative images, manifests, etc. from source image files
-    #
-    # @param args [Array] the arguments/collection names from wax:pagemaster
-    # @return [Nil]
-    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|
-        image_collection = ImageCollection.new(name, @site)
-        image_collection.build_simple_derivatives
-      end
-    end
-
-    # Finds the JS dependencies listed in site config and
-    # writes them to a package.json file
-    # in orderto easily track / monitor / update them
-    #
-    # @return [Nil]
-    def js_package
-      names = []
-      package = {
-        'name'          => site[:title],
-        'version'       => @config.fetch(:version, ''),
-        'dependencies'  => {}
-      }
-      site[:js].each do |dependency|
-        name = dependency[0]
-        names << name
-        version = dependency[1]['version']
-        package['dependencies'][name] = '^' + version
-      end
-      package
-    end
-
-    # Constructs a TravisBranch or LocalBranch object
-    # with appropriate Git credentials and pushes
-    # the compiled Jekyll site to the target GitHub branch
-    #
-    # @param target [String] the name of the Git branch to deploy to
-    # @return [Nil]
-    def push_branch(target)
-      if ENV.fetch('CI', false)
-        TravisBranch.new(self.site, target).push
-      else
-        LocalBranch.new(self.site, target).push
-      end
-    end
-  end
-end

data/lib/wax_tasks/travis_branch.rb

@@ -1,28 +0,0 @@
-require 'time'
-
-module WaxTasks
-  # Branch object for `$ wax:push` task when run on Travis-CI VM
-  # using encrypted Travis environment vars
-  #
-  # @attr repo_slug   [String] the 'user/repo_name'
-  # @attr user        [String] the GitHub user making the commit/push
-  # @attr token       [String] secret git access token
-  # @attr commit_msg  [String] the commit message to use on push
-  # @attr origin      [String] the current repository remote
-  # @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 TravisBranch < Branch
-    def initialize(site, target)
-      super(site, target)
-
-      @repo_slug    = ENV['TRAVIS_REPO_SLUG']
-      @user         = @repo_slug.split('/').first
-      @token        = ENV['ACCESS_TOKEN']
-
-      @commit_msg   = "Updated via #{ENV['TRAVIS_COMMIT']} @#{Time.now.utc}"
-      @origin       = "https://#{@user}:#{@token}@github.com/#{@repo_slug}.git"
-      @baseurl      = "/#{@repo_slug.split('/').last}"
-      @success_msg  = "Deploying to #{@target} branch from Travis as #{@user}."
-    end
-  end
-end