wax_tasks 1.0.0.pre.beta → 1.1.2

data/lib/wax_tasks/site.rb

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

data/lib/wax_tasks/utils.rb

@@ -1,17 +1,24 @@
+# frozen_string_literal: true
+
 module WaxTasks
   # Utility helper methods
   module Utils
-    # Contructs permalink extension from site `permalink` variable
     #
-    # @param site [Hash] the site config
-    # @return [String] the end of the permalink, either '/' or '.html'
-    def self.construct_permalink(site)
-      case site.fetch(:permalink, false)
-      when 'pretty' || '/'
-        '/'
-      else
-        '.html'
-      end
+    #
+    def self.ingest(source)
+      metadata =  case File.extname source
+                  when '.csv'
+                    WaxTasks::Utils.validate_csv source
+                  when '.json'
+                    WaxTasks::Utils.validate_json source
+                  when /\.ya?ml/
+                    WaxTasks::Utils.validate_yaml source
+                  else
+                    raise Error::InvalidSource, "Can't load #{File.extname source} files. Culprit: #{source}"
+                  end
+
+      WaxTasks::Utils.assert_pids metadata
+      WaxTasks::Utils.assert_unique metadata
     end
 
     # Checks and asserts presence of `pid` value for each item
@@ -20,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 #{@name} 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
 
@@ -33,6 +40,7 @@ module WaxTasks
       pids = data.map { |d| d['pid'] }
       not_unique = pids.select { |p| pids.count(p) > 1 }.uniq! || []
       raise Error::NonUniquePid, "#{@name} has the following nonunique pids:\n#{not_unique}" unless not_unique.empty?
+
       data
     end
 
@@ -53,8 +61,8 @@ module WaxTasks
     # @return [Array] validated JSON data as an Array of Hashes
     # @raise  WaxTasks::Error::InvalidJSON
     def self.validate_json(source)
-      file = File.read(source)
-      JSON.parse(file)
+      file = File.read source
+      JSON.parse file
     rescue StandardError => e
       raise Error::InvalidJSON, " #{e}"
     end
@@ -65,36 +73,24 @@ module WaxTasks
     # @return [Array] validated YAML data as an Array of Hashes
     # @raise  WaxTasks::Error::InvalidYAML
     def self.validate_yaml(source)
-      YAML.load_file(source)
+      SafeYAML.load_file source
     rescue StandardError => e
       raise WaxTasks::Error::InvalidYAML, " #{e}"
     end
 
-    # Creates a file path valid file path with empty strings and
-    # null values dropped
-    #
-    # @param  args [Array] items to concatenate in path
-    # @return [String] file path
-    def self.root_path(*args)
-      ['.'].concat(args).compact.reject(&:empty?).join('/').gsub(%r{/+}, '/')
-    end
-
     # Removes YAML front matter from a string
     # @return [String]
     def self.remove_yaml(str)
       str.to_s.gsub!(/\A---(.|\n)*?---/, '')
     end
 
-    def self.rm_liquid(str)
-      str.gsub(/{{.*}}/, '')
-    end
-
-    # Cleans YAML front matter + markdown pages for lunr indexing
+    # Scrubs yaml, liquid, html, and etc from content strings
     # @return [String]
-    def self.html_strip(str)
+    def self.content_clean(str)
       str.gsub!(/\A---(.|\n)*?---/, '') # remove yaml front matter
       str.gsub!(/{%(.*)%}/, '') # remove functional liquid
-      str.gsub!(%r{<\/?[^>]*>}, '') # remove html
+      str.gsub!(/{{.*}}/, '') # remove referential liquid
+      str.gsub!(%r{</?[^>]*>}, '') # remove html
       str.gsub!('\\n', '') # remove newlines
       str.gsub!(/\s+/, ' ') # remove extra space
       str.tr!('"', "'") # replace double quotes with single
@@ -106,95 +102,50 @@ module WaxTasks
     def self.remove_diacritics(str)
       to_replace  = 'ÀÁÂÃÄÅàáâãäåĀāĂ㥹ÇçĆćĈĉĊċČčÐðĎďĐđÈÉÊËèéêëĒēĔĕĖėĘęĚěĜĝĞğĠġĢģĤĥĦħÌÍÎÏìíîïĨĩĪīĬĭĮįİıĴĵĶķĸĹĺĻļĽľĿŀŁłÑñŃńŅņŇňʼnŊŋÒÓÔÕÖØòóôõöøŌōŎŏŐőŔŕŖŗŘřŚśŜŝŞşŠšſŢţŤťŦŧÙÚÛÜùúûüŨũŪūŬŭŮůŰűŲųŴŵÝýÿŶŷŸŹźŻżŽž'
       replaced_by = 'AAAAAAaaaaaaAaAaAaCcCcCcCcCcDdDdDdEEEEeeeeEeEeEeEeEeGgGgGgGgHhHhIIIIiiiiIiIiIiIiIiJjKkkLlLlLlLlLlNnNnNnNnnNnOOOOOOooooooOoOoOoRrRrRrSsSsSsSssTtTtTtUUUUuuuuUuUuUuUuUuUuWwYyyYyYZzZzZz'
-      str.to_s.tr(to_replace, replaced_by)
+      str.to_s.tr to_replace, replaced_by
     end
 
     # Converts string to snake case and swaps out special chars
     # @return [String]
     def self.slug(str)
-      str.to_s.downcase.tr(' ', '_').gsub(/[^\w-]/, '')
+      Utils.remove_diacritics(str).to_s.downcase.tr(' ', '_').gsub(/[^\w-]/, '')
     end
-  end
-end
-
-# Monkey-patched String class
-class String
-  # Normalizes string without diacritics for lunr indexing
-  # @return [String]
-  def lunr_normalize
-    WaxTasks::Utils.remove_diacritics(self)
-  end
-
-  # Colorizes console output to magenta (errors)
-  # @return [String]
-  def magenta
-    "\e[35m#{self}\e[0m"
-  end
-
-  # Colorizes console output to cyan (messages)
-  # @return [String]
-  def cyan
-    "\e[36m#{self}\e[0m"
-  end
-
-  # Colorizes console output to orange (warnings)
-  # @return [String]
-  def orange
-    "\e[33m#{self}\e[0m"
-  end
-end
 
-# Monkey-patched Array class
-class Array
-  # Normalizes an array as a string or array of hashes
-  # without diacritics for lunr indexing
-  # @return [Hash || String] description
-  def lunr_normalize
-    if self.first.is_a? Hash
-      self
-    else
-      WaxTasks::Utils.remove_diacritics(self.join(', '))
+    #
+    #
+    def self.safe_join(*args)
+      File.join(args.compact).sub %r{^/}, ''
     end
-  end
 
-  def except(value)
-    self - value
-  end
-end
-
-# Monkey-patched Hash class
-class Hash
-  # Normalizes hash as itself for lunr indexing
-  # @return [Hash]
-  def lunr_normalize
-    self
-  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 self.padded_int(idx, max_idx)
+      idx.to_s.rjust(Math.log10(max_idx).to_i + 1, '0')
+    end
 
-  # Converts hash keys to symbols
-  # @return [Hash]
-  def symbolize_keys
-    hash = self
-    hash.clone.each_key do |key|
-      hash[key.to_sym || key] = hash.delete(key)
+    def self.lunr_normalize(val)
+      case val
+      when String || Integer
+        WaxTasks::Utils.remove_diacritics val.to_s
+      when Array
+        return val if val.first.is_a? Hash
+        WaxTasks::Utils.remove_diacritics val.join(', ')
+      else
+        val
+      end
     end
-    hash
-  end
-end
 
-# Monkey-patched Integer class
-class Integer
-  # Normalizes integer as a string for lunr indexing
-  # @return [String]
-  def lunr_normalize
-    self.to_s
-  end
-end
+    def self.add_yaml_front_matter_to_file(file)
+      front_matter = "---\nlayout: none\n---\n"
+      filestring = File.read file
+      return if filestring.start_with? front_matter
 
-# Monkey-patched Nil class
-class NilClass
-  # Normalizes integer as a string for lunr indexing
-  # @return [String]
-  def lunr_normalize
-    self.to_s
+      File.open(file, 'w') do |f|
+        f.puts front_matter
+        f.puts filestring
+      end
+    end
   end
 end

data/lib/wax_tasks/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module WaxTasks
+  VERSION = '1.1.2'
+end

data/spec/setup.rb

@@ -28,7 +28,7 @@ def quiet_stdout
   end
 end
 
-module WaxTasks::Test
+module Test
   def self.reset
     Dir.chdir(ROOT)
     FileUtils.rm_r(BUILD) if File.directory?(BUILD)

data/spec/spec_helper.rb

@@ -3,21 +3,26 @@
 QUIET = !ENV['DEBUG']
 
 # use codecov + add requirements
+require 'setup'
 require 'simplecov'
 SimpleCov.start do
   add_filter 'spec'
-  add_filter 'branch'
 end
-
-# load + setup
 require 'wax_tasks'
-require 'setup'
 
 # provide shared context for tests
 shared_context 'shared', :shared_context => :metadata do
-  let(:task_runner) { WaxTasks::TaskRunner.new }
-  let(:default_site) { task_runner.site }
-  let(:args) { default_site[:collections].map{ |c| c[0] } }
-  let(:index_path) { "#{BUILD}/js/lunr-index.json" }
-  let(:ui_path) { "#{BUILD }/js/lunr-ui.js" }
+   let(:config_from_file)         { WaxTasks.config_from_file }
+   let(:invalid_content_config)   { WaxTasks.config_from_file("#{BUILD}/_invalid_content_config.yml") }
+   let(:invalid_format_config)    { WaxTasks.config_from_file("#{BUILD}/_invalid_format_config.yml") }
+   let(:empty_config)             { Hash.new }
+
+   let(:site_from_config_file)    { WaxTasks::Site.new(config_from_file) }
+   let(:site_from_empty_config)   { WaxTasks::Site.new(empty_config) }
+   let(:site_from_invalid_config) { WaxTasks::Site.new(invalid_content_config) }
+
+   let(:args_from_file)           { %w[csv_collection json_collection yaml_collection] }
+   let(:csv)                      { args_from_file.first }
+   let(:json)                     { args_from_file[1] }
+   let(:yaml)                     { args_from_file[2] }
 end

data/wax_tasks.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'lib/wax_tasks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'wax_tasks'
+  spec.version       = WaxTasks::VERSION
+  spec.authors       = ['Marii Nyrop']
+  spec.email         = ['marii@nyu.edu']
+  spec.license       = 'MIT'
+  spec.homepage      = 'https://github.com/minicomp/wax_tasks'
+  spec.summary       = 'Rake tasks for minimal exhibition sites with Minicomp/Wax.'
+  spec.description   = 'Rake tasks for minimal exhibition sites with Minicomp/Wax.'
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.test_files             = Dir['spec/*']
+  spec.required_ruby_version  = '>= 2.4'
+  spec.metadata['yard.run']   = 'yri'
+
+  spec.requirements << 'imagemagick'
+  spec.requirements << 'ghostscript'
+
+  spec.add_runtime_dependency 'progress_bar', '~> 1.3'
+  spec.add_runtime_dependency 'rainbow', '~> 3.0'
+  spec.add_runtime_dependency 'rake', '~> 13.0'
+  spec.add_runtime_dependency 'safe_yaml', '~> 1.0'
+  spec.add_runtime_dependency 'wax_iiif', '~> 0.2'
+
+  spec.add_development_dependency 'rspec', '~> 3'
+end

metadata

@@ -1,85 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: wax_tasks
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.beta
+  version: 1.1.2
 platform: ruby
 authors:
 - Marii Nyrop
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-11-11 00:00:00.000000000 Z
+date: 2020-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: html-proofer
+  name: progress_bar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: jekyll
+  name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     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: wax_iiif
+  name: safe_yaml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: wax_iiif
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
-  type: :development
+        version: '0.2'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -94,42 +94,51 @@ 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:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Gemfile
+- LICENSE
+- README.md
+- lib/tasks/clobber.rake
 - lib/tasks/derivatives_iiif.rake
 - lib/tasks/derivatives_simple.rake
-- lib/tasks/jspackage.rake
-- lib/tasks/lunr.rake
-- lib/tasks/pagemaster.rake
-- lib/tasks/push.rake
-- lib/tasks/test.rake
+- lib/tasks/pages.rake
+- lib/tasks/search.rake
 - lib/wax_tasks.rb
-- lib/wax_tasks/branch.rb
+- lib/wax_tasks/asset.rb
 - lib/wax_tasks/collection.rb
+- lib/wax_tasks/collection/images.rb
+- lib/wax_tasks/collection/metadata.rb
+- lib/wax_tasks/config.rb
 - lib/wax_tasks/error.rb
-- lib/wax_tasks/iiif/derivatives.rb
-- lib/wax_tasks/iiif/manifest.rb
-- lib/wax_tasks/image_collection.rb
-- lib/wax_tasks/local_branch.rb
-- lib/wax_tasks/lunr/index.rb
-- lib/wax_tasks/lunr/page_set.rb
-- lib/wax_tasks/pagemaster_collection.rb
-- lib/wax_tasks/task_runner.rb
-- lib/wax_tasks/travis_branch.rb
+- lib/wax_tasks/index.rb
+- lib/wax_tasks/item.rb
+- lib/wax_tasks/record.rb
+- lib/wax_tasks/site.rb
 - lib/wax_tasks/utils.rb
+- lib/wax_tasks/version.rb
 - spec/setup.rb
 - spec/spec_helper.rb
+- wax_tasks.gemspec
 homepage: https://github.com/minicomp/wax_tasks
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  yard.run: yri
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -137,20 +146,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements:
 - imagemagick
 - ghostscript
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.4
+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