wax_tasks 0.0.41 → 0.0.42

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: afb4a9e989cd10f473e2fead7740ce6e8f450d4a
-  data.tar.gz: 13d1d213f15697986aefc80396cf82a29b1aedc9
+  metadata.gz: d92dedaceae47d24df69b152689a3380ab9eaf71
+  data.tar.gz: ffd41f9e22e2945a30c921637174f8750f4dc5ba
 SHA512:
-  metadata.gz: 2068c29aec041abea14be1384ae22104972da1d9f74d052e6ba2e206f86d786af2e4bcc2f03e2192f2cb170a9f4e6229d2fa7ee7f7f77920ba1c255c9120180b
-  data.tar.gz: 7a1245c635cb173acd1a69f1673bdf66af77ead311ca17a49922fa3870c79fce00f77c3335f7c222e201385dfaec8517d988c54787cf6750963547ef8340938a
+  metadata.gz: 5dd009a8aa640ac7afcfd64998cac60de07c74be01d127a68a709b6a7c64a225aed7a4aac48e2e58fa2d2b2e3af6df7f6d78871dbaa68fbb181a15c976e6d1cb
+  data.tar.gz: 61dfb031a8b480492e24302710b672028ad8220e82b83c33c3c4d7dbf5baa175791c3c21c0675341e9dd3d108ed7b055d966ea03251587d9f9ad1402148c8828

data/lib/tasks/ghbranch.rake

@@ -2,14 +2,15 @@ require 'wax_tasks'
 
 namespace :wax do
   desc 'build site with gh-baseurl and publish to gh-pages branch'
-  task :ghbranch => :config do
+  task :ghbranch do
+    config = read_config
     FileUtils.rm_rf('_site')
 
     opts = {
       'source' => '.',
       'destination' => '_site',
       'config' => '_config.yml',
-      'baseurl' => $config['gh-baseurl'],
+      'baseurl' => config['gh-baseurl'],
       'incremental' => true,
       'verbose' => true
     }

data/lib/tasks/iiif.rake

@@ -2,24 +2,29 @@ require 'wax_tasks'
 require 'iiif_s3'
 
 namespace :wax do
-  task :iiif => :config do
-    abort "You must specify a collections after 'bundle exec rake wax:iiif'.".magenta if $argv.empty?
-    outputdir = './iiif'
-    FileUtils.mkdir outputdir
+  task :iiif do
+    config = read_config
+    argv = read_argv
+
+    abort "You must specify a collections after 'bundle exec rake wax:iiif'.".magenta if argv.empty?
+
+    FileUtils.mkdir './iiif'
+
     all_records = []
     id_counter = 0
+
     build_opts = {
-      :base_url => $config['baseurl'] + '/iiif',
-      :output_dir => outputdir,
+      :base_url => config['baseurl'] + '/iiif',
+      :output_dir => './iiif',
       :tile_scale_factors => [1, 2],
       :verbose => true
     }
-    $argv.each do |a|
+    argv.each do |a|
       id_counter += 1
-      inpath = './_iiif_source/' + a
+      inpath = './_data/iiif/' + a
       abort "Source path '#{inpath}' does not exist. Exiting.".magenta unless Dir.exist?(inpath)
-      paged = $config['collections'][a]['iiif_paged'] == true
-      collection_records = make_records(a, inpath, paged)
+      paged = config['collections'][a]['iiif_paged'] == true
+      collection_records = make_records(a, inpath, paged, config)
       all_records.concat collection_records
     end
     builder = IiifS3::Builder.new(build_opts)
@@ -28,7 +33,7 @@ namespace :wax do
   end
 end
 
-def make_records(collection_name, inpath, paged)
+def make_records(collection_name, inpath, paged, config)
   counter = 1
   collection_records = []
   imagefiles = Dir[inpath + '/*'].sort!
@@ -38,7 +43,7 @@ def make_records(collection_name, inpath, paged)
       :id => collection_name + '-' + basename,
       :is_document => paged,
       :path => imagefile,
-      :label => $config['title'] + ' - ' + collection_name + ' - ' + basename
+      :label => config['title'] + ' - ' + collection_name + ' - ' + basename
     }
     counter += 1
     collection_records << IiifS3::ImageRecord.new(record_opts)

data/lib/tasks/jspackage.rake

@@ -3,15 +3,16 @@ require 'json'
 
 namespace :wax do
   desc 'write a simple package.json'
-  task :jspackage => :config do
+  task :jspackage do
+    config = read_config
     package = {
-      'name'          => $config['title'],
+      'name'          => config['title'],
       'version'       => '1.0.0',
-      'description'   => $config['description'],
+      'description'   => config['description'],
       'dependencies'  => {}
     }
     names = []
-    $config['js'].each do |dependency|
+    config['js'].each do |dependency|
       name = dependency[0]
       names << name
       version = dependency[1]['version']

data/lib/tasks/lunr.rake

@@ -1,11 +1,13 @@
 require 'wax_tasks'
+require 'json'
 
 namespace :wax do
   desc 'build lunr search index'
-  task :lunr => :config do
+  task :lunr do
+    config = read_config
     Dir.mkdir('js') unless File.exist?('js')
     yaml = "---\nlayout: none\n---\n"
-    lunr = Lunr.new($config)
+    lunr = Lunr.new(config)
 
     # write index to json file
     idx = yaml + lunr.index

data/lib/tasks/pagemaster.rake

@@ -2,15 +2,15 @@ require 'wax_tasks'
 
 namespace :wax do
   desc 'generate collection md pages from yaml or csv data source'
-  task :pagemaster => :config do
-    if $argv.empty?
+  task :pagemaster do
+    config = read_config
+    argv = read_argv
+    if argv.empty?
       puts "You must specify one or more collections after 'bundle exec rake wax:pagemaster' to generate.".magenta
       exit 1
     else
-      $argv.each do |collection_name|
-        collection_config = valid_pagemaster(collection_name)
-        collections_dir   = $config['collections_dir'].nil? ? '' : $config.fetch('collections_dir').to_s + '/'
-        collection = Collection.new(collection_name, collection_config, collections_dir)
+      argv.each do |name|
+        collection = Collection.new(config, name)
         collection.pagemaster
       end
     end

data/lib/wax_tasks/collection.rb

@@ -1,44 +1,48 @@
 include FileUtils
+require 'csv'
+require 'json'
 
 # initializes a wax collection for use with pagemaster,lunr,and iiif tasks
 class Collection
-  attr_reader :name, :config, :src, :layout, :dir, :data
-
-  def initialize(collection_name, collection_config, collections_dir)
+  def initialize(config, collection_name)
     @name   = collection_name
-    @config = collection_config
-    @cdir   = collections_dir
-    @src    = '_data/' + @config.fetch('source')
-    @layout = File.basename(@config.fetch('layout'), '.*')
-    @dir    = @cdir + '_' + @name
-    @data   = []
-    @lunr   = {}
+    @config = config
+
+    cdir = @config['collections_dir'].nil? ? '' : @config.fetch('collections_dir').to_s + '/'
+    collection = valid_collection_config
+
+    @src    = '_data/' + collection.fetch('source')
+    @layout = File.basename(collection.fetch('layout'), '.*')
+    @dir    = cdir + '_' + @name
   end
 
-  def pagemaster
-    mkdir_p(@dir)
-    ingest
-    detect_duplicates
-    generate_pages
+  def valid_collection_config
+    c = @config['collections'][@name]
+    abort "Cannot find the collection #{@name} in _config.yml. Exiting.".magenta if c.nil?
+    abort "Cannot find 'source' for the collection '#{@name}' in _config.yml. Exiting.".magenta if c['source'].nil?
+    abort "Cannot find 'layout' for the collection '#{@name}' in _config.yml. Exiting.".magenta if c['layout'].nil?
+    abort "Cannot find the file '#{'_data/' + c['source']}'. Exiting.".magenta unless File.file?('_data/' + c['source'])
+    c
   end
 
-  def ingest
-    if File.extname(@src) == '.csv'
-      @data = CSV.read(@src, :headers => true, :encoding => 'utf-8').map(&:to_hash)
-    elsif File.extname(@src) == '.json'
-      @data = JSON.parse(File.read(@src).encode("UTF-8"))
+  def ingest(src)
+    if File.extname(src) == '.csv'
+      data = CSV.read(src, :headers => true, :encoding => 'utf-8').map(&:to_hash)
+    elsif File.extname(src) == '.json'
+      data = JSON.parse(File.read(@src).encode("UTF-8"))
     else
       puts "File type for #{@src} must be .csv or .json. Please fix and rerun."
       exit 1
     end
+    detect_duplicates(data)
     puts "Processing #{src}...."
+    data
   rescue StandardError
     puts "Cannot load #{src}. check for typos and rebuild.".magenta
-    exit 1
   end
 
-  def generate_pages
-    perma_ext = $config['permalink'] == 'pretty' ? '/' : '.html'
+  def generate_pages(data)
+    perma_ext = @config['permalink'] == 'pretty' ? '/' : '.html'
     completed = 0
     skipped = 0
     data.each do |item|
@@ -59,10 +63,16 @@ class Collection
     abort "#{completed} pages were generated before failure, most likely a record is missing a valid 'pid' value.".magenta
   end
 
-  def detect_duplicates
+  def detect_duplicates(data)
     pids = []
-    @data.each { |d| pids << d['pid'] }
+    data.each { |d| pids << d['pid'] }
     duplicates = pids.detect { |p| pids.count(p) > 1 } || []
     raise "\nYour collection has the following duplicate ids. please fix and rerun.\n#{duplicates}".magenta unless duplicates.empty?
   end
+
+  def pagemaster
+    mkdir_p(@dir)
+    data = ingest(@src)
+    generate_pages(data)
+  end
 end

data/lib/wax_tasks/helpers.rb

@@ -8,14 +8,6 @@ def clean(str)
   str
 end
 
-def valid_pagemaster(collection_name)
-  c = $config.fetch('collections').fetch(collection_name)
-  abort "Cannot find 'source' for the collection '#{collection_name}' in _config.yml. Exiting.".magenta if c.fetch('source').nil?
-  abort "Cannot find 'layout' for the collection '#{collection_name}' in _config.yml. Exiting.".magenta if c.fetch('layout').nil?
-  abort "Cannot find the file '#{'_data/' + c['source']}'. Exiting.".magenta unless File.file?('_data/' + c.fetch('source'))
-  c
-end
-
 def rm_diacritics(str)
   to_replace  = "ÀÁÂÃÄÅàáâãäåĀāĂ㥹ÇçĆćĈĉĊċČčÐðĎďĐđÈÉÊËèéêëĒēĔĕĖėĘęĚěĜĝĞğĠġĢģĤĥĦħÌÍÎÏìíîïĨĩĪīĬĭĮįİıĴĵĶķĸĹĺĻļĽľĿŀŁłÑñŃńŅņŇňʼnŊŋÒÓÔÕÖØòóôõöøŌōŎŏŐőŔŕŖŗŘřŚśŜŝŞşŠšſŢţŤťŦŧÙÚÛÜùúûüŨũŪūŬŭŮůŰűŲųŴŵÝýÿŶŷŸŹźŻżŽž"
   replaced_by = "AAAAAAaaaaaaAaAaAaCcCcCcCcCcDdDdDdEEEEeeeeEeEeEeEeEeGgGgGgGgHhHhIIIIiiiiIiIiIiIiIiJjKkkLlLlLlLlLlNnNnNnNnnNnOOOOOOooooooOoOoOoRrRrRrSsSsSsSssTtTtTtUUUUuuuuUuUuUuUuUuUuWwYyyYyYZzZzZz"
@@ -27,6 +19,16 @@ def slug(str)
 end
 
 def thing2string(thing)
-  thing = thing.join(" ") if thing.is_a?(Array)
+  thing = thing.join(" || ") if thing.is_a?(Array)
   thing.to_s
 end
+
+def read_config
+  YAML.load_file('_config.yml')
+end
+
+def read_argv
+  argv = ARGV.drop(1)
+  argv.each { |a| task a.to_sym }
+  argv
+end

data/lib/wax_tasks/lunr.rb

@@ -1,4 +1,5 @@
 include FileUtils
+require 'json'
 
 # for generating Lunr Index and Lunr UI files
 class Lunr
@@ -22,6 +23,17 @@ class Lunr
     total_fields.uniq
   end
 
+  def page_hash(page, c_fields, c, count)
+    yaml = YAML.load_file(page)
+    hash = {
+      'lunr_id' => count,
+      'link' => "{{'" + yaml.fetch('permalink') + "' | relative_url }}"
+    }
+    c_fields.each { |f| hash[f] = rm_diacritics(thing2string(yaml[f])) }
+    hash['content'] = rm_diacritics(clean(File.read(page))) if c[1]['lunr_index']['content']
+    hash
+  end
+
   def index
     full_index = []
     count = 0
@@ -38,15 +50,8 @@ class Lunr
       puts "Loading #{c_pages.length} pages from #{c_dir}"
       # index each page in collection
       c_pages.each do |page|
-        yaml = YAML.load_file(page)
-        hash = {
-          'lunr_id' => count,
-          'link' => "{{'" + yaml.fetch('permalink') + "' | relative_url }}"
-        }
-        c_fields.each { |f| hash[f] = rm_diacritics(thing2string(yaml[f])) }
-        hash['content'] = rm_diacritics(clean(File.read(page))) if c[1]['lunr_index']['content']
+        full_index << page_hash(page, c_fields, c, count)
         count += 1
-        full_index << hash
       end
     end
     JSON.pretty_generate(full_index)

data/lib/wax_tasks.rb

@@ -1,7 +1,5 @@
-require 'rubygems'
-require 'bundler'
-Bundler.require(:default)
+require 'colorize'
 
-require 'wax_tasks/helpers'
 require 'wax_tasks/collection'
+require 'wax_tasks/helpers'
 require 'wax_tasks/lunr'

data/spec/spec_helper.rb

@@ -1,7 +1 @@
-require 'fake/helpers'
-require 'fake/site'
-require 'fake/data'
-require 'test/config'
-require 'test/pagemaster'
-require 'test/lunr'
-require 'test/iiif'
+require 'test_tasks'

data/spec/test_tasks.rb

@@ -0,0 +1,44 @@
+require 'yaml'
+require 'fileutils'
+require 'fake/helpers'
+require 'fake/site'
+require 'fake/data'
+
+# run + test wax:config
+describe 'wax_tasks' do
+  Fake.site
+  collection_data = Fake.data
+  config = YAML.load_file('_config.yml')
+  argv = collection_data.map { |col| col[0] }
+  add_collections_to_config(argv, collection_data, config)
+  add_lunr_data(config, collection_data)
+
+  it 'accesses _config.yml and argv' do
+    expect(config.length)
+    expect(argv.length)
+  end
+
+  it 'generates pages' do
+    system("bundle exec rake wax:pagemaster #{argv.join(' ')}")
+    argv.each { |a| expect(Dir.exist?('_' + a)) }
+  end
+
+  it 'generates a lunr index' do
+    system("bundle exec rake wax:lunr")
+    index = File.open('js/lunr-index.json', 'r').read
+    ui = File.open('js/lunr-ui.js', 'r').read
+    expect(index.length > 1000)
+    expect(ui.length > 100)
+  end
+
+  it 'generates iiif tiles and data' do
+    images = Dir.glob('./_data/iiif/*.jpg')
+    collection_data.each do |coll|
+      new_dir = './_data/iiif/' + coll[0]
+      mkdir_p(new_dir)
+      images.each { |f| cp(File.expand_path(f), new_dir) }
+    end
+    rm_r(images)
+    system("bundle exec rake wax:iiif #{argv.first}")
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wax_tasks
 version: !ruby/object:Gem::Version
-  version: 0.0.41
+  version: 0.0.42
 platform: ruby
 authors:
 - Marii Nyrop
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-23 00:00:00.000000000 Z
+date: 2018-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -144,7 +144,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
-- lib/tasks/config.rake
 - lib/tasks/ghbranch.rake
 - lib/tasks/iiif.rake
 - lib/tasks/jspackage.rake
@@ -157,6 +156,7 @@ files:
 - lib/wax_tasks/helpers.rb
 - lib/wax_tasks/lunr.rb
 - spec/spec_helper.rb
+- spec/test_tasks.rb
 homepage: https://github.com/mnyrop/wax_tasks
 licenses:
 - MIT
@@ -177,9 +177,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Rake tasks for minimal exhibitions.
 test_files:
 - spec/spec_helper.rb
+- spec/test_tasks.rb

data/lib/tasks/config.rake

@@ -1,14 +0,0 @@
-require 'wax_tasks'
-
-namespace :wax do
-  desc 'get _config.yaml and parse cmd line args'
-  task :config do
-    begin
-      $config = YAML.load_file('_config.yml')
-      $argv = ARGV.drop(1)
-      $argv.each { |a| task a.to_sym }
-    rescue StandardError
-      abort 'Cannot load _config.yml'.magenta
-    end
-  end
-end