wax_tasks 1.1.2 → 1.1.3

data/lib/wax_tasks/config.rb

@@ -1,79 +0,0 @@
-# frozen_string_literal: true
-
-module WaxTasks
-  #
-  class Config
-    attr_reader :collections
-
-    def initialize(config)
-      @config         = config
-      @collections    = process_collections
-    end
-
-    def self
-      @config
-    end
-
-    #
-    #
-    def source
-      @config.dig 'source'
-    end
-
-    #
-    #
-    def collections_dir
-      @config.dig 'collections_dir'
-    end
-
-    #
-    # Contructs permalink extension from site `permalink` variable
-    #
-    # @return [String] the end of the permalink, either '/' or '.html'
-    def ext
-      case @config.dig 'permalink'
-      when 'pretty' || '/'
-        '/'
-      else
-        '.html'
-      end
-    end
-
-    #
-    #
-    def process_collections
-      if @config.key? 'collections'
-        @config['collections'].map do |k, v|
-          WaxTasks::Collection.new(k, v, source, collections_dir, ext)
-        end
-      else
-        []
-      end
-    end
-
-    #
-    #
-    def search(name)
-      search_config = @config.dig 'search', name
-      raise WaxTasks::Error::InvalidConfig if search_config.nil?
-      raise WaxTasks::Error::InvalidConfig unless search_config.dig('collections').is_a? Hash
-
-      search_config['collections'] = search_config['collections'].map do |k, v|
-        fields = v.fetch('fields', [])
-        fields << 'content' if v.fetch('content', false)
-        find_collection(k).tap { |c| c.search_fields = fields }
-      end
-
-      search_config
-    end
-
-    #
-    #
-    def find_collection(name)
-      collection = @collections.find { |c| c.name == name }
-      raise WaxTasks::Error::InvalidCollection, "Cannot find requested collection '#{name}'" if collection.nil?
-
-      collection
-    end
-  end
-end

data/lib/wax_tasks/error.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-module WaxTasks
-  # Custom WaxTasks Errors module
-  module Error
-    # Custom WaxTasks Error class with magenta console output
-    class WaxTasksError < StandardError
-      def initialize(msg = '')
-        super(Rainbow(msg).magenta)
-      end
-    end
-
-    # Custom Error:
-    # Rake task expects arguments, found none
-    class MissingArguments < WaxTasksError; end
-
-    # Custom Error:
-    # Site config cannot be found / parsed for the task at hand
-    class InvalidConfig < WaxTasksError; end
-
-    # Custom Error:
-    # Collection specified cannot be found / parsed in site config
-    class InvalidCollection < WaxTasksError; end
-
-    # Custom Error:
-    # Collection data source type is not allowed or is an invalid file
-    class InvalidSource < WaxTasksError; end
-
-    # Custom Error:
-    # Data source file could not be found
-    class MissingSource < WaxTasksError; end
-
-    # Custom Error:
-    # Could not load collection page(s)
-    class PageLoad < WaxTasksError; end
-
-    # Custom Error:
-    # Collection item does not have a required pid value
-    class MissingPid < WaxTasksError; end
-
-    # Custom Error:
-    # Collection item has a non-unique pud value
-    class NonUniquePid < WaxTasksError; end
-
-    # Custom Error:
-    # Collection page item could not be generated
-    class PageFailure < WaxTasksError; end
-
-    # Custom Error:
-    # CSV file failed to lint + could not be loaded
-    class InvalidCSV < WaxTasksError; end
-
-    # Custom Error:
-    # JSON file failed to lint + could not be loaded
-    class InvalidJSON < WaxTasksError; end
-
-    # Custom Error:
-    # YAML file failed to lint + could not be loaded
-    class InvalidYAML < WaxTasksError; end
-
-    # Custom Error:
-    # Search index in site config has no valid collections to index
-    class NoSearchCollections < WaxTasksError; end
-  end
-end

data/lib/wax_tasks/index.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-module WaxTasks
-  #
-  class Index
-    attr_reader :path, :collections
-
-    def initialize(config)
-      @config      = config
-      @collections = config.dig 'collections'
-      @path        = config.dig 'index'
-
-      raise WaxTasks::Error::NoSearchCollections if @collections.nil?
-      raise WaxTasks::Error::InvalidConfig if @path.nil?
-
-      @records = records
-    end
-
-    #
-    #
-    def records
-      lunr_id = 0
-      @collections.flat_map do |collection|
-        collection.records_from_pages.each.flat_map do |r|
-          r.keep_only collection.search_fields
-          r.set 'lunr_id', lunr_id
-          r.lunr_normalize_values
-          lunr_id += 1
-          r
-        end
-      end
-    end
-
-    #
-    #
-    def write_to(dir)
-      file_path = WaxTasks::Utils.safe_join dir, @path
-      FileUtils.mkdir_p File.dirname(file_path)
-      File.open(file_path, 'w') do |f|
-        f.puts "---\nlayout: none\n---\n"
-        f.puts JSON.pretty_generate(@records.map(&:hash))
-      end
-    end
-  end
-end

data/lib/wax_tasks/item.rb

@@ -1,116 +0,0 @@
-# frozen_string_literal: true
-
-module WaxTasks
-  #
-  class Item
-    attr_accessor :record, :iiif_config
-    attr_reader :pid
-
-    #
-    #
-    #
-    def initialize(path, variants)
-      @path            = path
-      @variants        = variants
-      @type            = type
-      @pid             = File.basename @path, '.*'
-      @assets          = assets
-    end
-
-    #
-    #
-    def accepted_image_formats
-      %w[.png .jpg .jpeg .tiff .tif]
-    end
-
-    #
-    #
-    def type
-      Dir.exist?(@path) ? 'dir' : File.extname(@path).downcase
-    end
-
-    #
-    #
-    def valid?
-      accepted_image_formats.include? @type or @type == 'dir'
-    end
-
-    #
-    #
-    def record?
-      @record.is_a? Record
-    end
-
-    #
-    #
-    def assets
-      if accepted_image_formats.include? @type
-        [Asset.new(@path, @pid, @variants)]
-      elsif @type == 'dir'
-        paths = Dir.glob("#{@path}/*{#{accepted_image_formats.join(',')}}").sort
-        paths.map { |p| Asset.new(p, @pid, @variants) }
-      else
-        []
-      end
-    end
-
-    #
-    #
-    def simple_derivatives
-      @assets.map(&:simple_derivatives).flatten
-    end
-
-    #
-    #
-    def logo
-      logo_uri = @iiif_config&.dig 'logo'
-      "{{ '#{logo_uri}' | absolute_url }}" if logo_uri
-    end
-
-    def label
-      label_key = @iiif_config&.dig 'label'
-      if @record && label_key
-        @record.hash.dig label_key
-      else
-        @pid
-      end
-    end
-
-    #
-    #
-    def description
-      description_key = @iiif_config&.dig 'description'
-      @record.hash.dig description_key if description_key && @record
-    end
-
-    #
-    #
-    def attribution
-      attribution_key = @iiif_config.dig 'attribution'
-      @record.hash.dig attribution_key if attribution_key && @record
-    end
-
-    #
-    #
-    def iiif_image_records
-      opts = base_opts.clone
-      is_only = @assets.length == 1
-
-      @assets.map.with_index do |asset, i|
-        asset.to_iiif_image_record(is_only, i, opts)
-      end
-    end
-
-    #
-    #
-    def base_opts
-      opts = { label: label }
-      return opts unless @iiif_config
-
-      opts[:logo]        = logo if logo
-      opts[:description] = description.to_s if description
-      opts[:attribution] = attribution.to_s if attribution
-      opts
-    end
-  end
-end

data/lib/wax_tasks/record.rb

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-module WaxTasks
-  #
-  class Record
-    attr_reader :pid, :hash, :order
-
-    def initialize(hash)
-      @hash  = hash
-      @pid   = @hash.dig 'pid'
-      @order = @hash.dig 'order'
-    end
-
-    #
-    #
-    def lunr_normalize_values
-      @hash.transform_values { |v| Utils.lunr_normalize v }
-    end
-
-    #
-    #
-    def keys
-      @hash.keys
-    end
-
-    # PATCH :: rename 'fullwidth' to 'full' to
-    # (1) avoid breaking wax_iiif with special 'full' variant label
-    # (2) avoid breaking wax_theme which still expects 'full' to provide an image path
-    # this can be deprecated when a new version of wax_theme looks for another fullsize key
-    #
-    def set(key, value)
-      key = 'full' if key == 'fullwidth'
-      @hash[key] = value
-    end
-
-    #
-    #
-    def permalink?
-      @hash.key? 'permalink'
-    end
-
-    #
-    #
-    def order?
-      @order.is_a? String
-    end
-
-    #
-    #
-    def keep_only(fields)
-      @hash.select! { |k, _v| fields.include? k }
-    end
-
-    #
-    #
-    def write_to_page(dir)
-      raise Error::MissingPid if @pid.nil?
-
-      path = "#{dir}/#{Utils.slug(@pid)}.md"
-      if File.exist? path
-        0
-      else
-        FileUtils.mkdir_p File.dirname(path)
-        File.open(path, 'w') { |f| f.puts "#{@hash.to_yaml}---" }
-        1
-      end
-    end
-  end
-end

data/lib/wax_tasks/site.rb

@@ -1,86 +0,0 @@
-# frozen_string_literal: true
-
-#
-module WaxTasks
-  #
-  class Site
-    attr_reader :config
-
-    #
-    #
-    def initialize(config = nil)
-      @config = WaxTasks::Config.new(config || WaxTasks.config_from_file)
-    end
-
-    #
-    #
-    def collections
-      @config.collections
-    end
-
-    #
-    #
-    def clobber(name)
-      collection = @config.find_collection name
-      raise WaxTasks::Error::InvalidCollection if collection.nil?
-
-      collection.clobber_pages
-      collection.clobber_derivatives
-
-      @config.self.fetch('search', {}).each do |_name, search|
-        next unless search.key? 'index'
-        index = Utils.safe_join @config.source, search['index']
-        next unless File.exist? index
-        puts Rainbow("Removing search index #{index}").cyan
-        FileUtils.rm index
-      end
-
-      puts Rainbow("\nDone ✔").green
-    end
-
-    #
-    #
-    def generate_pages(name)
-      result     = 0
-      collection = @config.find_collection name
-      raise WaxTasks::Error::InvalidCollection if collection.nil?
-
-      collection.records_from_metadata.each do |record|
-        result += record.write_to_page(collection.page_source)
-      end
-
-      puts Rainbow("#{result} pages were generated to #{collection.page_source}.").cyan
-      puts Rainbow("\nDone ✔").green
-    end
-
-    #
-    #
-    def generate_static_search(name)
-      search_config = @config.search name
-      index = WaxTasks::Index.new(search_config)
-
-      puts Rainbow("Generating #{name} search index to #{index.path}").cyan
-      index.write_to @config.source
-
-      puts Rainbow("\nDone ✔").green
-    end
-
-    #
-    #
-    def generate_derivatives(name, type)
-      collection = @config.find_collection name
-      raise WaxTasks::Error::InvalidCollection if collection.nil?
-      raise WaxTasks::Error::InvalidConfig unless %w[iiif simple].include? type
-
-      records = case type
-                when 'iiif'
-                  collection.write_iiif_derivatives
-                when 'simple'
-                  collection.write_simple_derivatives
-                end
-
-      collection.update_metadata records
-      puts Rainbow("\nDone ✔").green
-    end
-  end
-end