wax_tasks 1.0.0.pre.beta → 1.1.2

data/lib/wax_tasks/collection/metadata.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+#
+module WaxTasks
+  #
+  class Collection
+    #
+    module Metadata
+      #
+      #
+      def search_fields=(fields)
+        @search_fields.concat(fields).flatten.compact.uniq
+      end
+
+      #
+      #
+      def records_from_pages
+        paths = Dir.glob("#{@page_source}/*.{md, markdown}")
+        warn Rainbow("There are no pages in #{@page_source} to index.").orange if paths.empty?
+
+        paths.map do |path|
+          begin
+            content = WaxTasks::Utils.content_clean File.read(path)
+            Record.new(SafeYAML.load_file(path)).tap do |r|
+              r.set 'content', content
+              r.set 'permalink', "/#{@name}/#{r.pid}#{@ext}" unless r.permalink?
+            end
+          rescue StandardError => e
+            raise Error::PageLoad, "Cannot load page #{path}\n#{e}"
+          end
+        end
+      end
+
+      #
+      #
+      def records_from_metadata
+        raise Error::MissingSource, "Cannot find metadata source '#{@metadata_source}'" unless File.exist? @metadata_source
+
+        metadata = Utils.ingest @metadata_source
+        metadata.each_with_index.map do |meta, i|
+          Record.new(meta).tap do |r|
+            r.set 'order', Utils.padded_int(i, metadata.length) unless r.order?
+            r.set 'layout', @config['layout'] if @config.key? 'layout'
+            r.set 'collection', @name
+          end
+        end
+      end
+
+      #
+      #
+      def update_metadata(update)
+        records = consolidate_records records_from_metadata, update
+        reformatted = case File.extname @metadata_source
+                      when '.csv'
+                        csv_string records
+                      when '.json'
+                        json_string records
+                      when /\.ya?ml/
+                        yaml_string records
+                      end
+        File.open(@metadata_source, 'w') { |f| f.puts reformatted }
+      end
+
+      #
+      #
+      def consolidate_records(original, new)
+        lost_record_pids = original.map(&:pid) - new.map(&:pid)
+        lost_record_pids.each do |pid|
+          new << original.find { |r| r.pid == pid }
+        end
+        new.sort_by(&:order)
+      end
+
+      #
+      #
+      def csv_string(records)
+        keys = records.flat_map(&:keys).uniq
+        CSV.generate do |csv|
+          csv << keys
+          records.each do |r|
+            csv << keys.map { |k| r.hash.fetch(k, '') }
+          end
+        end
+      end
+
+      #
+      #
+      def json_string(records)
+        hashes = records.map(&:hash)
+        JSON.pretty_generate hashes
+      end
+
+      #
+      #
+      def yaml_string(records)
+        hashes = records.map(&:hash)
+        hashes.to_yaml
+      end
+    end
+  end
+end

data/lib/wax_tasks/config.rb

@@ -0,0 +1,79 @@
+# 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,10 +1,12 @@
+# 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(msg.magenta)
+        super(Rainbow(msg).magenta)
       end
     end
 
@@ -13,8 +15,8 @@ module WaxTasks
     class MissingArguments < WaxTasksError; end
 
     # Custom Error:
-    # Site config cannot be found / parsed
-    class InvalidSiteConfig < WaxTasksError; end
+    # 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
@@ -22,58 +24,42 @@ module WaxTasks
 
     # Custom Error:
     # Collection data source type is not allowed or is an invalid file
-    class InvalidSource     < WaxTasksError; end
+    class InvalidSource < WaxTasksError; end
 
     # Custom Error:
     # Data source file could not be found
-    class MissingSource     < WaxTasksError; end
-
-    # Custom Error:
-    # While loading markdown pages to index, one could not be read
-    class LunrPageLoad      < WaxTasksError; end
-
-    # Custom Error:
-    # Lunr collection does not have fields specified to index
-    class MissingFields     < WaxTasksError; end
+    class MissingSource < WaxTasksError; end
 
     # Custom Error:
-    # Page layout was not specified for a pagemaster collection
-    class MissingLayout     < WaxTasksError; end
+    # 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
+    class MissingPid < WaxTasksError; end
 
     # Custom Error:
     # Collection item has a non-unique pud value
-    class NonUniquePid      < WaxTasksError; end
+    class NonUniquePid < WaxTasksError; end
 
     # Custom Error:
     # Collection page item could not be generated
-    class PageFailure       < WaxTasksError; end
+    class PageFailure < WaxTasksError; end
 
     # Custom Error:
     # CSV file failed to lint + could not be loaded
-    class InvalidCSV        < WaxTasksError; end
+    class InvalidCSV < WaxTasksError; end
 
     # Custom Error:
     # JSON file failed to lint + could not be loaded
-    class InvalidJSON       < WaxTasksError; end
+    class InvalidJSON < WaxTasksError; end
 
     # Custom Error:
     # YAML file failed to lint + could not be loaded
-    class InvalidYAML       < WaxTasksError; end
-
-    # Custom Error:
-    # No collections in site config have lunr_index parameters
-    class NoLunrCollections < WaxTasksError; end
-
-    # Custom Error:
-    # Cannot find _site directory to push to GitHub
-    class MissingSite < WaxTasksError; end
+    class InvalidYAML < WaxTasksError; end
 
     # Custom Error:
-    # Cannot find IIIF source image files
-    class MissingIiifSrc < WaxTasksError; end
+    # Search index in site config has no valid collections to index
+    class NoSearchCollections < WaxTasksError; end
   end
 end

data/lib/wax_tasks/index.rb

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

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

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