wax_tasks 1.0.2 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54e1d62bddb18ee554db5a1d517f65acc68998edce0a147d0f08d1c6807a3655
-  data.tar.gz: 52437257c9777aaaefd078c4e4be8ad76ccf82fd2e57d0d8ef022912a789cf4c
+  metadata.gz: 0e51a1e7e4f2b6e4f2a47ea31dafa67a25fa72b4792357fd7e3409f7f604ea40
+  data.tar.gz: 5f91332fb4f9ea78d922252d6d815d67a85738e37d055d8345935aadd0802f7b
 SHA512:
-  metadata.gz: b2479c1ed3f348c749f78f6a2988f5aa5f98041bb09821bf17c51cee5bd761f542c2560532516567595d956e220f94ffcef0aadf60c2cf0df9e6559eff82a682
-  data.tar.gz: cf0ba69cf4e2ab6b224bc55e9b532522ba766379f448330839d22a3e13fcbe0235df9f8a94fc9d3664350c56459de4b9491248fdaa97a8255010d63a08314f9a
+  metadata.gz: 2392b9846200a684cf022e48071988c41e824d074d848ba686b320f826bb499d50bf3d656d1de6a2789209ccd2ddad057d687013d9d4eff4ddf76a111bc7c593
+  data.tar.gz: dd37457cd55d005ac5ed02a9de0b040a2d34db96e7fb28f40a218808d27e04a5d7299a223407146ae3412fd421e4df2095e976655ff72a4e27c21fd5f9849ebc

data/Gemfile

@@ -4,6 +4,8 @@ source 'https://rubygems.org'
 gemspec
 
 # dev/test utilities
+gem 'bundle-audit', require: false
+gem 'diane', require: false
 gem 'rubocop', require: false
-gem 'simplecov', require: false
+gem 'simplecov', '0.17.1', require: false
 gem 'yard', require: false

data/lib/tasks/clobber.rake

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'wax_tasks'
+
+namespace :wax do
+  desc 'destroy wax-generated collection files, including pages, derivatives, and search index(es)'
+  task :clobber do
+    args = ARGV.drop(1).each { |a| task a.to_sym }
+    args.reject! { |a| a.start_with? '-' }
+
+    raise WaxTasks::Error::MissingArguments, Rainbow("You must specify a collection after 'wax:clobber'").magenta if args.empty?
+
+    site = WaxTasks::Site.new
+    args.each { |a| site.clobber a }
+  end
+end

data/lib/tasks/derivatives_iiif.rake

@@ -7,6 +7,8 @@ namespace :wax do
     desc 'generate iiif derivatives from local image files'
     task :iiif do
       args = ARGV.drop(1).each { |a| task a.to_sym }
+      args.reject! { |a| a.start_with? '-' }
+
       raise WaxTasks::Error::MissingArguments, Rainbow("You must specify a collection after 'wax:derivatives:iiif'").magenta if args.empty?
 
       site = WaxTasks::Site.new

data/lib/tasks/derivatives_simple.rake

@@ -7,6 +7,7 @@ namespace :wax do
     desc 'generate iiif derivatives from local image files'
     task :simple do
       args = ARGV.drop(1).each { |a| task a.to_sym }
+      args.reject! { |a| a.start_with? '-' }
       raise WaxTasks::Error::MissingArguments, Rainbow("You must specify a collection after 'wax:derivatives:simple'").magenta if args.empty?
 
       site = WaxTasks::Site.new

data/lib/tasks/pages.rake

@@ -6,6 +6,7 @@ namespace :wax do
   desc 'generate collection md pages from yaml or csv data source'
   task :pages do
     args = ARGV.drop(1).each { |a| task a.to_sym }
+    args.reject! { |a| a.start_with? '-' }
     raise WaxTasks::Error::MissingArguments, Rainbow('You must specify a collection after wax:pages').magenta if args.empty?
 
     site = WaxTasks::Site.new

data/lib/tasks/search.rake

@@ -6,6 +6,7 @@ namespace :wax do
   desc 'build lunr search index (with default UI if UI=true)'
   task :search do
     args = ARGV.drop(1).each { |a| task a.to_sym }
+    args.reject! { |a| a.start_with? '-' }
     raise WaxTasks::Error::MissingArguments, Rainbow('You must specify a collection after wax:search').magenta if args.empty?
 
     site = WaxTasks::Site.new

data/lib/wax_tasks/asset.rb

@@ -3,10 +3,13 @@
 #
 module WaxTasks
   Derivative = Struct.new(:path, :label, :img)
-  attr_reader :id, :path
 
   #
   class Asset
+    attr_reader :id, :path
+
+
+
     def initialize(path, pid, variants)
       @path     = path
       @pid      = pid
@@ -17,7 +20,7 @@ module WaxTasks
     #
     #
     def asset_id
-      id = File.basename(@path, '.*')
+      id = File.basename @path, '.*'
       id.prepend "#{@pid}_" unless id == @pid
       id
     end
@@ -26,7 +29,7 @@ module WaxTasks
     #
     def simple_derivatives
       @variants.map do |label, width|
-        img = MiniMagick::Image.open(@path)
+        img = MiniMagick::Image.open @path
         if width > img.width
           warn Rainbow("Tried to create derivative #{width}px wide, but asset #{@id} for item #{@pid} only has a width of #{img.width}px.").yellow
         else
@@ -42,11 +45,13 @@ module WaxTasks
     #
     def to_iiif_image_record(is_only, index, base_opts)
       opts = base_opts.clone
+
       opts[:is_primary]    = index.zero?
       opts[:section_label] = "Page #{index + 1}" unless is_only
       opts[:path]          = @path
       opts[:manifest_id]   = @pid
       opts[:id]            = @id
+      opts[:variants]      = @variants
 
       WaxIiif::ImageRecord.new(opts)
     end

data/lib/wax_tasks/collection.rb

@@ -7,23 +7,55 @@ module WaxTasks
   #
   class Collection
     attr_reader :name, :config, :ext, :search_fields,
-                :page_source, :metadata_source, :imagedata_source
+                :page_source, :metadata_source, :imagedata_source,
+                :iiif_derivative_source, :simple_derivative_source
 
     include Collection::Metadata
     include Collection::Images
 
+    IMAGE_DERIVATIVE_DIRECTORY = 'img/derivatives'
+    DEFAULT_VARIANTS = { 'thumbnail' => 250, 'fullwidth' => 1140 }.freeze
+
     #
     #
     def initialize(name, config, source, collections_dir, ext)
-      @name             = name
-      @config           = config
-      @page_extension   = ext
-      @site_source      = source
-      @page_source      = Utils.safe_join source, collections_dir, "_#{name}"
-      @metadata_source  = Utils.safe_join source, '_data', config.dig('metadata', 'source')
-      @imagedata_source = Utils.safe_join source, '_data', config.dig('images', 'source')
-      @search_fields    = %w[pid label thumbnail permalink collection]
-      @image_variants   = image_variants
+      @name                     = name
+      @config                   = config
+      @page_extension           = ext
+      @site_source              = source
+      @page_source              = Utils.safe_join source, collections_dir, "_#{@name}"
+      @metadata_source          = Utils.safe_join source, '_data', config.dig('metadata', 'source')
+      @imagedata_source         = Utils.safe_join source, '_data', config.dig('images', 'source')
+      @iiif_derivative_source   = Utils.safe_join source, IMAGE_DERIVATIVE_DIRECTORY, 'iiif'
+      @simple_derivative_source = Utils.safe_join source, IMAGE_DERIVATIVE_DIRECTORY, 'simple'
+      @search_fields            = %w[pid label thumbnail permalink collection]
+      @image_variants           = image_variants
+    end
+
+    #
+    #
+    def image_variants
+      vars = @config.dig('images', 'variants') || {}
+      DEFAULT_VARIANTS.merge vars
+    end
+
+    #
+    #
+    def clobber_pages
+      return unless Dir.exist? @page_source
+      puts Rainbow("Removing pages from #{@page_source}").cyan
+      FileUtils.remove_dir @page_source, true
+    end
+
+    #
+    #
+    def clobber_derivatives
+      [@iiif_derivative_source, @simple_derivative_source].each do |dir|
+        if Dir.exist? dir
+          puts Rainbow("Removing derivatives from #{dir}").cyan
+          FileUtils.remove_dir dir, true
+        end
+      end
     end
   end
 end

data/lib/wax_tasks/collection/images.rb

@@ -10,14 +10,6 @@ module WaxTasks
   class Collection
     #
     module Images
-      #
-      #
-      def image_variants
-        default_variants = { 'thumbnail' => 250, 'full' => 1140 }
-        custom_variants  = @config.dig('images', 'variants') || {}
-        default_variants.merge custom_variants
-      end
-
       #
       #
       def items_from_imagedata
@@ -46,6 +38,7 @@ module WaxTasks
           next unless Dir.glob("#{target_dir}/*").empty?
 
           puts Rainbow("\nPreprocessing #{path} into image files. This may take a minute.\n").cyan
+
           opts = { output_dir: File.dirname(target_dir) }
           WaxIiif::Utilities::PdfSplitter.split(path, opts)
         end
@@ -53,13 +46,14 @@ module WaxTasks
 
       #
       #
-      def write_simple_derivatives(dir)
+      def write_simple_derivatives
         puts Rainbow("Generating simple image derivatives for collection '#{@name}'\nThis might take awhile.").cyan
 
         bar = ProgressBar.new(items_from_imagedata.length)
+        bar.write
         items_from_imagedata.map do |item|
           item.simple_derivatives.each do |d|
-            path = "#{dir}/#{d.path}"
+            path = "#{@simple_derivative_source}/#{d.path}"
             FileUtils.mkdir_p File.dirname(path)
             next if File.exist? path
 
@@ -78,9 +72,10 @@ module WaxTasks
         build_opts = {
           base_url: "{{ '/' | absolute_url }}#{dir}",
           output_dir: dir,
-          collection_label: @name
+          collection_label: @name,
+          variants: @image_variants.dup.tap { |h| h.delete 'full' }
         }
-        WaxIiif::Builder.new(build_opts)
+        WaxIiif::Builder.new build_opts
       end
 
       #
@@ -113,10 +108,10 @@ module WaxTasks
 
       #
       #
-      def write_iiif_derivatives(dir)
+      def write_iiif_derivatives
         items     = items_from_imagedata
         iiif_data = items.map(&:iiif_image_records).flatten
-        builder   = iiif_builder(dir)
+        builder   = iiif_builder @iiif_derivative_source
 
         builder.load iiif_data
 
@@ -124,7 +119,7 @@ module WaxTasks
         builder.process_data
         records = items.map(&:record).compact
 
-        add_font_matter_to_json_files dir
+        add_font_matter_to_json_files @iiif_derivative_source
         add_iiif_results_to_records records, builder.manifests
       end
     end

data/lib/wax_tasks/collection/metadata.rb

@@ -68,7 +68,7 @@ module WaxTasks
         lost_record_pids.each do |pid|
           new << original.find { |r| r.pid == pid }
         end
-        new.sort_by(&:order)
+        new
       end
 
       #

data/lib/wax_tasks/config.rb

@@ -6,8 +6,12 @@ module WaxTasks
     attr_reader :collections
 
     def initialize(config)
-      @config           = config
-      @collections      = process_collections
+      @config         = config
+      @collections    = process_collections
+    end
+
+    def self
+      @config
     end
 
     #

data/lib/wax_tasks/index.rb

@@ -34,7 +34,7 @@ module WaxTasks
     #
     #
     def write_to(dir)
-      file_path = WaxTasks::Utils.safe_join Dir.pwd, dir, path
+      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"

data/lib/wax_tasks/item.rb

@@ -47,7 +47,7 @@ module WaxTasks
       if accepted_image_formats.include? @type
         [Asset.new(@path, @pid, @variants)]
       elsif @type == 'dir'
-        paths = Dir.glob("#{@path}/*{#{accepted_image_formats.join(',')}}")
+        paths = Dir.glob("#{@path}/*{#{accepted_image_formats.join(',')}}").sort
         paths.map { |p| Asset.new(p, @pid, @variants) }
       else
         []

data/lib/wax_tasks/record.rb

@@ -23,9 +23,13 @@ module WaxTasks
       @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
 

data/lib/wax_tasks/site.rb

@@ -5,7 +5,6 @@ module WaxTasks
   #
   class Site
     attr_reader :config
-    IMAGE_DERIVATIVE_DIRECTORY = 'img/derivatives'
 
     #
     #
@@ -19,6 +18,26 @@ module WaxTasks
       @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)
@@ -53,12 +72,11 @@ module WaxTasks
       raise WaxTasks::Error::InvalidCollection if collection.nil?
       raise WaxTasks::Error::InvalidConfig unless %w[iiif simple].include? type
 
-      output_dir = Utils.safe_join @config.source, IMAGE_DERIVATIVE_DIRECTORY, type
       records = case type
                 when 'iiif'
-                  collection.write_iiif_derivatives output_dir
+                  collection.write_iiif_derivatives
                 when 'simple'
-                  collection.write_simple_derivatives output_dir
+                  collection.write_simple_derivatives
                 end
 
       collection.update_metadata records

data/lib/wax_tasks/utils.rb

@@ -27,7 +27,7 @@ module WaxTasks
     # @return [Array] same data unless a an item is missing the key `pid`
     # @raise WaxTasks::Error::MissingPid
     def self.assert_pids(data)
-      data.each_with_index { |d, i| raise Error::MissingPid, "Collection is missing pid for item #{i}." unless d.key? 'pid' }
+      data.each_with_index { |d, i| raise Error::MissingPid, "Collection is missing pid for item #{i}.\nHint: review common .csv formatting issues (such as hidden characters) in the documentation: https://minicomp.github.io/wiki/wax/preparing-your-collection-data/metadata/" unless d.key? 'pid' }
       data
     end
 
@@ -114,7 +114,7 @@ module WaxTasks
     #
     #
     def self.safe_join(*args)
-      File.join(args.compact)
+      File.join(args.compact).sub %r{^\/}, ''
     end
 
     # Constructs the order variable for each page (if the collection

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wax_tasks
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.1
 platform: ruby
 authors:
 - Marii Nyrop
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-06-13 00:00:00.000000000 Z
+date: 2020-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: progress_bar
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: safe_yaml
   requirement: !ruby/object:Gem::Requirement
@@ -70,20 +70,14 @@ dependencies:
   name: wax_iiif
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.2
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.2
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
 - !ruby/object:Gem::Dependency
@@ -100,14 +94,15 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
-description: Rake tasks for minimal exhibition sites with Jekyll Wax.
+description: Rake tasks for minimal exhibition sites with Minicomp/Wax.
 email:
-- m.nyrop@columbia.edu
+- marii@nyu.edu
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
+- lib/tasks/clobber.rake
 - lib/tasks/derivatives_iiif.rake
 - lib/tasks/derivatives_simple.rake
 - lib/tasks/pages.rake
@@ -131,7 +126,7 @@ licenses:
 - MIT
 metadata:
   yard.run: yri
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -148,11 +143,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - imagemagick
 - ghostscript
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6.2
+signing_key:
 specification_version: 4
-summary: Rake tasks for minimal exhibition sites with Jekyll Wax.
+summary: Rake tasks for minimal exhibition sites with Minicomp/Wax.
 test_files:
 - spec/spec_helper.rb
 - spec/setup.rb