wax_tasks 0.0.3 → 0.0.40

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ac9e0a96963154d6625c7f0c4fc71251c86c017
-  data.tar.gz: 4e87c17755a3da5eb541176aaec2812c305c736f
+  metadata.gz: 8e575498bcfd76bd5bd11705d9d6cac510a422eb
+  data.tar.gz: 725bae639d3bbb4ed57bdb0d79e9fb8147c85324
 SHA512:
-  metadata.gz: 3c885e92b4245d48e44e7af8b7206bee18461b2b4add0d50b23537e562e135755fa1d227d9febb5003cfc942303270867dd455f0ac8508af7619d2717b9dd3ca
-  data.tar.gz: bca597f6cd84e70ae59a2052c258f10781689753b98ffbad8aaf2828b8906e490f02d58bbc6707aa42390c43c734f9a1c2fc3dc2c2ad61589981ffff28e27a33
+  metadata.gz: 4c120c938aaf9778d1061749c2f9f38e0899ba4b56dd20ae97c08a34b3a15a77766f481b91efa43b6612295210368260613f9b79be2d863a7d90f35bc9accb16
+  data.tar.gz: 3f71b6b7e531c01f2d8d22aa2ef03d0c053f96a8e5dd9938e352226c0325e75a8c5e2b7fbf58cdf7d4ec3c76d588cd0ac5ad122d90de4e1d766f938d2adbcd35

data/lib/tasks/config.rake

@@ -1,5 +1,4 @@
-require 'yaml'
-require 'colorized_string'
+require 'wax_tasks'
 
 namespace :wax do
   desc 'get _config.yaml and parse cmd line args'

data/lib/tasks/ghbranch.rake

@@ -1,7 +1,4 @@
-require 'jekyll'
-require 'tmpdir'
-require 'fileutils'
-require 'time'
+require 'wax_tasks'
 
 namespace :wax do
   desc 'build site with gh-baseurl and publish to gh-pages branch'

data/lib/tasks/iiif.rake

@@ -1,24 +1,26 @@
-require 'colorized_string'
+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?
-    FileUtils.mkdir_p './_iiif/tiles'
+    outputdir = './iiif'
+    FileUtils.mkdir outputdir
     all_records = []
     id_counter = 0
     build_opts = {
-      :base_url => $config['baseurl'] + '/tiles',
-      :output_dir => './_iiif/tiles',
+      :base_url => $config['baseurl'] + '/iiif',
+      :output_dir => outputdir,
       :tile_scale_factors => [1, 2],
       :verbose => true
     }
     $argv.each do |a|
       id_counter += 1
-      dirpath = './_iiif/source_images/' + a
-      collection_records = make_records(a) if Dir.exist?(dirpath)
+      inpath = './_iiif_source/' + 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)
       all_records.concat collection_records
-      abort "Source path '#{dirpath}' does not exist. Exiting.".magenta unless Dir.exist?(dirpath)
     end
     builder = IiifS3::Builder.new(build_opts)
     builder.load(all_records)
@@ -26,15 +28,15 @@ namespace :wax do
   end
 end
 
-def make_records(collection_name)
+def make_records(collection_name, inpath, paged)
   counter = 1
   collection_records = []
-  imagefiles = Dir['./_iiif/source_images/' + collection_name + '/*'].sort!
+  imagefiles = Dir[inpath + '/*'].sort!
   imagefiles.each do |imagefile|
     basename = File.basename(imagefile, '.*').to_s
     record_opts = {
       :id => collection_name + '-' + basename,
-      :is_document => false,
+      :is_document => paged,
       :path => imagefile,
       :label => $config['title'] + ' - ' + collection_name + ' - ' + basename
     }

data/lib/tasks/lunr.rake

@@ -1,11 +1,11 @@
-require 'lunr_index'
+require 'wax_tasks'
 
 namespace :wax do
   desc 'build lunr search index'
   task :lunr => :config do
     collections = $config['collections']
     lunr_language = $config['lunr_language']
-    index = LunrIndex.new(collections, lunr_language)
+    index = Index.new(collections, lunr_language)
 
     Dir.mkdir('js') unless File.exist?('js')
     File.open('js/lunr-index.js', 'w') { |file| file.write(index.output) }

data/lib/tasks/pagemaster.rake

@@ -1,6 +1,4 @@
-require 'colorized_string'
-require 'wax_collection'
-require 'helpers'
+require 'wax_tasks'
 
 namespace :wax do
   desc 'generate collection md pages from yaml or csv data source'
@@ -11,8 +9,8 @@ namespace :wax do
     else
       $argv.each do |collection_name|
         collection_config = valid_pagemaster(collection_name)
-        collections_dir   = $config['collections_dir'].nil? ? '' : $config['collections_dir'].to_s + '/'
-        collection = WaxCollection.new(collection_name, collection_config, collections_dir)
+        collections_dir   = $config['collections_dir'].nil? ? '' : $config.fetch('collections_dir').to_s + '/'
+        collection = Collection.new(collection_name, collection_config, collections_dir)
         collection.pagemaster
       end
     end

data/lib/tasks/s3branch.rake

@@ -1,30 +1,12 @@
-require 'jekyll'
-require 'tmpdir'
-require 'fileutils'
-require 'time'
+require 'wax_tasks'
 
 namespace :wax do
   desc 'build site with baseurl and publish to s3 branch'
-  task :s3branch => :config do
-    FileUtils.rm_rf('_site')
-
-    opts = {
-      'source'      => '.',
-      'destination' => '_site',
-      'config' => '_config.yml',
-      'incremental' => true,
-      'verbose' => true,
-      'baseurl' => $config['baseurl']
-    }
-
-    Jekyll::Site.new(Jekyll.configuration(opts)).process
-
+  task :s3branch do
     origin = `git config --get remote.origin.url`
-
     Dir.mktmpdir do |tmp|
       cp_r '_site/.', tmp
       Dir.chdir tmp
-
       system 'git init' # Init the repo.
       system "git add . && git commit -m 'Site updated at #{Time.now.utc}'"
       system 'git remote add origin ' + origin

data/lib/tasks/test.rake

@@ -1,5 +1,5 @@
+require 'wax_tasks'
 require 'html-proofer'
-require 'colorized_string'
 
 namespace :wax do
   desc 'run htmlproofer, rspec if exists'

data/lib/{wax_collection.rb → wax_tasks/collection.rb}

@@ -1,22 +1,15 @@
-require 'yaml'
-require 'csv'
-require 'json'
-require 'fileutils'
-require 'colorized_string'
-require 'helpers'
-
 include FileUtils
 
-# WaxCollection class
-class WaxCollection
+# 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)
     @name   = collection_name
     @config = collection_config
     @cdir   = collections_dir
-    @src    = '_data/' + @config['source']
-    @layout = File.basename(@config['layout'], '.*')
+    @src    = '_data/' + @config.fetch('source')
+    @layout = File.basename(@config.fetch('layout'), '.*')
     @dir    = @cdir + '_' + @name
     @data   = []
     @lunr   = {}
@@ -49,7 +42,7 @@ class WaxCollection
     completed = 0
     skipped = 0
     data.each do |item|
-      pagename = slug(item['pid'])
+      pagename = slug(item.fetch('pid'))
       pagepath = @dir + '/' + pagename + '.md'
       permalink = '/' + @name + '/' + pagename + perma_ext
       if File.exist?(pagepath)

data/lib/{helpers.rb → wax_tasks/helpers.rb}

@@ -1,5 +1,3 @@
-require 'colorized_string'
-
 def clean(str)
   str.gsub!(/\A---(.|\n)*?---/, '') # remove yaml front matter
   str.gsub!(/{%(.*)%}/, '') # remove functional liquid
@@ -11,11 +9,10 @@ def clean(str)
 end
 
 def valid_pagemaster(collection_name)
-  c = $config['collections'][collection_name]
-  abort "Cannot find the collection '#{collection_name}' in _config.yml. Exiting.".magenta if c.nil?
-  abort "Cannot find 'source' for the collection '#{collection_name}' in _config.yml. Exiting.".magenta if c['source'].nil?
-  abort "Cannot find 'layout' for the collection '#{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 = $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
 

data/lib/{lunr_index.rb → wax_tasks/index.rb}

@@ -1,15 +1,13 @@
-require 'yaml'
-require 'colorized_string'
-require 'helpers'
+include FileUtils
 
-# LunrIndex class
-class LunrIndex
+# initializes a lunr index to be output to js/lunr-index.js
+class Index
   attr_reader :output
 
   def initialize(collections, lunr_language)
     @collections      = collections
     @lunr_language    = lunr_language
-    @cdir             = $config['collections_dir'].nil? ? '' : $config['collections_dir'] + '/'
+    @cdir             = $config['collections_dir'].nil? ? '' : $config.fetch('collections_dir') + '/'
     @lunr_collections = []
     @total_fields     = []
     @output           = ''
@@ -52,9 +50,9 @@ class LunrIndex
           yaml = YAML.load_file(page)
           hash = {
             'lunr_id' => count,
-            'link' => "{{'" + yaml['permalink'] + "' | relative_url }}"
+            'link' => "{{'" + yaml.fetch('permalink') + "' | relative_url }}"
           }
-          fields.each { |f| hash[f] = rm_diacritics(yaml[f]) }
+          fields.each { |f| hash[f] = rm_diacritics(yaml[f].to_s) }
           hash['content'] = rm_diacritics(clean(File.read(page))) if c[1]['lunr_index']['content']
           @output += "\nindex.addDoc(" + hash.to_json + "); "
           store_string += "\n" + hash.to_json + ", "

data/lib/wax_tasks.rb

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

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
-require 'fake_helpers'
-require 'fake_site'
-require 'fake_data'
-require 'test_config'
-require 'test_pagemaster'
-require 'test_lunr'
-require 'test_iiif'
+require 'fake/helpers'
+require 'fake/site'
+require 'fake/data'
+require 'test/config'
+require 'test/pagemaster'
+require 'test/lunr'
+require 'test/iiif'

metadata

@@ -1,141 +1,141 @@
 --- !ruby/object:Gem::Specification
 name: wax_tasks
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.40
 platform: ruby
 authors:
 - Marii Nyrop
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-04 00:00:00.000000000 Z
+date: 2018-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
+        version: '0.8'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: faker
+  name: html-proofer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :development
+        version: '3.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: iiif_s3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
-  type: :development
+        version: '0.1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.52'
-  type: :development
+        version: '3.7'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '12.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: html-proofer
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
+        version: '1.16'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
-  name: iiif_s3
+  name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :runtime
+        version: '1.8'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
-  name: jekyll
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
-  type: :runtime
+        version: '3.5'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
-  type: :runtime
+        version: '0.52'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '0.52'
 description: Rake tasks for minimal iiif exhibition sites with Jekyll.
 email:
 - m.nyrop@columbia.edu
@@ -144,8 +144,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
-- lib/helpers.rb
-- lib/lunr_index.rb
 - lib/tasks/config.rake
 - lib/tasks/ghbranch.rake
 - lib/tasks/iiif.rake
@@ -153,15 +151,11 @@ files:
 - lib/tasks/pagemaster.rake
 - lib/tasks/s3branch.rake
 - lib/tasks/test.rake
-- lib/wax_collection.rb
-- spec/fake_data.rb
-- spec/fake_helpers.rb
-- spec/fake_site.rb
+- lib/wax_tasks.rb
+- lib/wax_tasks/collection.rb
+- lib/wax_tasks/helpers.rb
+- lib/wax_tasks/index.rb
 - spec/spec_helper.rb
-- spec/test_config.rb
-- spec/test_iiif.rb
-- spec/test_lunr.rb
-- spec/test_pagemaster.rb
 homepage: https://github.com/mnyrop/wax_tasks
 licenses:
 - MIT
@@ -188,10 +182,3 @@ specification_version: 4
 summary: Rake tasks for minimal exhibitions.
 test_files:
 - spec/spec_helper.rb
-- spec/test_iiif.rb
-- spec/test_config.rb
-- spec/test_lunr.rb
-- spec/fake_helpers.rb
-- spec/fake_data.rb
-- spec/fake_site.rb
-- spec/test_pagemaster.rb

data/spec/fake_data.rb

@@ -1,43 +0,0 @@
-require 'csv'
-require 'faker'
-require 'json'
-require 'rake'
-
-# make csvs
-I18n.enforce_available_locales = false
-Faker::Config.locale = 'zh-CN'
-Dir.mkdir('_data') unless File.exist?('_data')
-
-def fake_data(name, type)
-  data = []
-  keys = ['pid']
-  5.times { keys << slug(Faker::Lovecraft.unique.word) } # keys = pid + 5
-  5.times do # with 5 records
-    record = {
-      keys[0] => slug(Faker::Dune.unique.character),
-      keys[1] => Faker::Lorem.sentence,
-      keys[2] => Faker::TwinPeaks.quote,
-      keys[3] => Faker::Name.name,
-      keys[4] => Faker::Space.star,
-      keys[5] => Faker::Lovecraft.sentence
-    }
-    data << record
-    $collection_data[name] = { 'keys' => keys, 'type' => type }
-  end
-  data
-end
-
-5.times do |i|
-  name = slug(Faker::RuPaul.unique.queen)
-  if i.even?
-    data = fake_data(name, '.csv')
-    path = '_data/' + name + '.csv'
-    write_csv(path, data)
-  else
-    data = fake_data(name, '.json')
-    path = '_data/' + name + '.json'
-    File.open(path, 'w') { |f| f.write(data.to_json) }
-  end
-  Faker::Dune.unique.clear
-  Faker::Lovecraft.unique.clear
-end

data/spec/fake_helpers.rb

@@ -1,22 +0,0 @@
-require 'csv'
-require 'colorized_string'
-
-# global
-$collection_data = {}
-
-# helper methods
-def slug(str)
-  str.downcase.tr(' ', '_').gsub(/[^\w-]/, '')
-end
-
-def write_csv(path, hashes)
-  CSV.open(path, 'wb:UTF-8') do |csv|
-    csv << hashes.first.keys
-    hashes.each do |hash|
-      csv << hash.values
-    end
-  end
-  puts "Writing csv data to #{path}."
-rescue StandardError
-  abort "Cannot write csv data to #{path} for some reason.".magenta
-end

data/spec/fake_site.rb

@@ -1,27 +0,0 @@
-require 'fileutils'
-require 'jekyll'
-require 'yaml'
-
-include FileUtils
-
-site_dir = 'faker_site'
-mkdir_p(site_dir)
-image_dir = Dir.glob('spec/data/_iiif')
-cp_r(image_dir, site_dir)
-cd(site_dir)
-
-config_file = {
-  'title'       => 'faker',
-  'url'         => '',
-  'baseurl'     => '',
-  'exclude'     => ['Rakefile']
-}
-config_opts = {
-  'source'      => '.',
-  'destination' => '_site',
-  'config'      => '_config.yml'
-}
-
-File.open('_config.yml', 'w') { |f| f.puts(config_file.to_yaml) }
-File.open('Rakefile', 'w') { |f| f.puts('Dir.glob("../lib/tasks/*.rake").each { |r| load r }') }
-Jekyll::Site.new(Jekyll.configuration(config_opts)).process

data/spec/test_config.rb

@@ -1,28 +0,0 @@
-require 'rake'
-require 'yaml'
-
-# run + test wax:config
-describe 'wax:config' do
-  it 'accesses _config.yml and argvs' do
-    load File.expand_path("../../lib/tasks/config.rake", __FILE__)
-    Rake::Task['wax:config'].invoke
-
-    $collection_data.each { |col| $argv << col[0] }
-    expect($config.length)
-    expect($argv.length)
-
-    # add collection data to config file
-    collection_hash = {}
-    $argv.each do |coll_name|
-      ext = $collection_data[coll_name]['type']
-      collection_hash[coll_name] = {
-        'source' => coll_name + ext,
-        'layout' => 'default'
-      }
-    end
-
-    $config['collections'] = collection_hash
-    output = YAML.dump $config
-    File.write('_config.yml', output)
-  end
-end

data/spec/test_iiif.rb

@@ -1,20 +0,0 @@
-require 'csv'
-require 'fileutils'
-require 'rake'
-
-include FileUtils
-
-describe 'wax:iiif' do
-  it 'generates iiif tiles and data' do
-    images = Dir.glob('./_iiif/source_images/*.jpg')
-    $collection_data.each do |coll|
-      new_dir = './_iiif/source_images/' + coll[0]
-      mkdir_p(new_dir)
-      images.each { |f| cp(File.expand_path(f), new_dir) }
-    end
-    rm_r(images)
-    $argv = [$argv.first] # make tests faster by only running on 1/3 collections
-    load File.expand_path("../../lib/tasks/iiif.rake", __FILE__)
-    Rake::Task['wax:iiif'].invoke
-  end
-end

data/spec/test_lunr.rb

@@ -1,24 +0,0 @@
-require 'rake'
-
-describe 'wax:lunr' do
-  it 'generates a lunr index' do
-    $config['collections'].each do |collection|
-      name = collection[0]
-      # get info on what to index
-      lunr_hash = {
-        'content' => false,
-        'fields' => $collection_data[name]['keys']
-      }
-      # add it to config
-      $config['collections'][name]['lunr_index'] = lunr_hash
-      output = YAML.dump $config
-      File.write('_config.yml', output)
-    end
-    # invoke lunr task
-    load File.expand_path("../../lib/tasks/lunr.rake", __FILE__)
-    Rake::Task['wax:lunr'].invoke
-    # expect a populated index
-    index = File.open('js/lunr-index.js', 'r').read
-    expect(index.length > 1000)
-  end
-end

data/spec/test_pagemaster.rb

@@ -1,9 +0,0 @@
-require 'rake'
-require 'yaml'
-
-describe 'wax:pagemaster' do
-  it 'generates pages' do
-    load File.expand_path("../../lib/tasks/pagemaster.rake", __FILE__)
-    Rake::Task['wax:pagemaster'].invoke
-  end
-end