wax_tasks 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0f3ee5c37e9bdd609505415066d2e024f0ae2c98
+  data.tar.gz: c0f9c31e128a27ba5e474df8987c9105317a1a98
+SHA512:
+  metadata.gz: b57d647c1cbc1851d67bf5c1e5bd267a7feb3224d906dbfd8b59ac9e73f4a91645542051447d74e5e31157a0cdcf6d6e665ea1ab715b13ca6a9da993d5d09ecc
+  data.tar.gz: 65574cf6e3366c037df690884f06b8f2944d1241998c180c46f11964b58af8bd5417da3a0de5ee23b06c629f40539da128057062cb419dfcc34a556bf133cb28

data/README.md

@@ -0,0 +1,92 @@
+# wax_tasks [![Gem Version](https://badge.fury.io/rb/wax_tasks.svg)](https://badge.fury.io/rb/wax_tasks) [![Dependency Status](https://gemnasium.com/badges/github.com/mnyrop/wax_tasks.svg)](https://gemnasium.com/github.com/mnyrop/wax_tasks)
+
+## [minicomp](https://github.com/minicomp) rake tasks for jekyll [wax](https://minicomp.github.io/wax)
+
+### current tasks:
+
+`wax:pagemaster`: generates markdown pages for jekyll collections from csv or yaml files. (same as [`pagemaster`](https://github.com/mnyrop/pagemaster) gem).
+
+`wax:iiif`: generates iiif image tiles and associated json for jekyll collections from local jpgs. (uses [`iiif_s3`](https://github.com/cmoa/iiif_s3) gem).
+
+`wax:ghbranch`: builds your jekyll site and overwrites the `gh-pages` branch to publish your compiled `_site` directory with `gh-baseurl`.
+
+`wax:s3branch`: builds your jekyll site and overwrites the `s3` branch to publish your compiled `_site` directory with `baseurl`.
+
+`wax:lunr` builds a Lunrjs search index for your site.
+
+`wax:test` runs htmlproofer and, if there is an .rspec file, runs your rspec tests.
+
+
+### set-up:
+1. add the `wax_tasks` gem to your jekyll site's `Gemfile` and install with `bundle install`:
+```
+ gem 'wax_tasks'
+```
+2. Create a `Rakefile` in the root of your jekyll site and add the following to load the wax_tasks:
+```
+spec = Gem::Specification.find_by_name 'wax_tasks'
+Dir.glob("#{spec.gem_dir}/lib/tasks/*.rake").each {|r| load r}
+```
+3. Configure the collection information in your site's `_config.yaml`.
+```yaml
+# Collection params for wax:pagemaster
+collections:
+  paintings:
+    output: true
+    source: paintings-metadata.csv
+    directory: paintings
+    layout: painting-page
+  artists:
+    output: true
+    source: artist-data.yaml
+    directory: artists
+    layout: author-info-page
+```
+4. If generating a Lunrjs search index, add Lunr Params to `_config.yaml`.
+```bash
+# Lunr Search Params (for wax:lunr)
+lunr:
+  content: true
+  multi-language: true
+  meta:
+    - dir: "_projects"
+      permalink: "/projects"
+      fields:
+        - title
+        - era
+        - tags
+    - dir: "_posts"
+      permalink: "posts"
+      fields:
+        - title
+        - category
+        - tags
+```
+### to use:
+```bash
+$ bundle exec rake wax:<task_name> <option>
+```
+#### ex 1: generate md pages for `paintings` and `artists` from data files
+```bash
+$ bundle exec rake wax:pagemaster paintings artists
+```
+#### ex 2: generate iiif image tiles and associated json for `paintings` from local jpgs:
+```bash
+$ bundle exec rake wax:iiif paintings
+```
+#### ex 3: publish `_site` to `gh-pages` branch
+```bash
+$ bundle exec rake wax:ghbranch
+```
+#### ex 4: publish `_site` to `s3` branch
+```bash
+$ bundle exec rake wax:s3branch
+```
+#### ex 5: (re)generate lunrjs search index
+```bash
+$ bundle exec rake wax:lunr
+```
+#### ex 6: run CI test(s)
+```bash
+$ bundle exec rake wax:test
+```

data/lib/tasks/config.rake

@@ -0,0 +1,16 @@
+require 'yaml'
+require 'colorized_string'
+
+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 do ; end }
+    rescue
+      puts "Cannot load _config.yml".magenta
+      exit 1
+    end
+  end
+end

data/lib/tasks/ghbranch.rake

@@ -0,0 +1,34 @@
+require 'jekyll'
+require 'tmpdir'
+require 'fileutils'
+require 'colorized_string'
+
+namespace :wax do
+  desc 'build site with gh-baseurl and publish to gh-pages branch'
+  task :ghbranch => :config do
+    FileUtils.rm_rf('_site')
+
+    baseurl = $config['gh-baseurl']
+
+    Jekyll::Site.new(Jekyll.configuration({
+      "source"      => ".",
+      "destination" => "_site",
+      "config" => "_config.yml",
+      "baseurl" => baseurl,
+      "incremental" => true,
+      "verbose" => true
+    })).process
+
+    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}"
+      system "git push origin master:refs/heads/gh-pages --force"
+    end
+  end
+end

data/lib/tasks/iiif.rake

@@ -0,0 +1,52 @@
+require 'colorized_string'
+require 'iiif_s3'
+
+namespace :wax do
+  task :iiif => :config do
+
+    FileUtils::mkdir_p 'tiles'
+    imagedata = []
+    id_counter = 0
+
+    if $argv.empty?
+      puts "You must specify one or more collections after 'bundle exec rake wax:iiif' to generate.".magenta
+      exit 1
+    else
+      $argv.each do |a|
+        dirpath = './_iiif/' + a
+        unless Dir.exist?(dirpath)
+          puts ("Source path '" + dirpath + "' does not exist. Exiting.").magenta
+          exit 1
+        else
+          id_counter+=1
+          imagefiles = Dir[dirpath + "/*"].sort!
+          counter = 1
+          imagefiles.each do |imagefile|
+            begin
+              basename = File.basename(imagefile, ".*")
+              opts = {}
+              opts[:id] = basename
+              opts[:is_document] = false
+              opts[:path] = imagefile
+              opts[:label] = $config["title"] + " - " + a + " - " + basename
+              i = IiifS3::ImageRecord.new(opts)
+              counter = counter + 1
+              imagedata.push(i)
+            rescue
+              puts ("Failed to convert image " + imagefile + ".").magenta
+              exit 1
+            end
+          end
+        end
+      end
+      builder = IiifS3::Builder.new({
+        :base_url => $config["baseurl"] + "/tiles",
+        :output_dir => "./tiles",
+        :tile_scale_factors => [1,2],
+        :verbose => true
+      })
+      builder.load(imagedata)
+      builder.process_data()
+    end
+  end
+end

data/lib/tasks/lunr.rake

@@ -0,0 +1,79 @@
+require 'json'
+require 'yaml'
+require 'colorized_string'
+
+namespace :wax do
+  desc 'build lunr search index'
+  task :lunr => :config do
+
+    meta = $config['lunr']['meta']
+    name = $config['lunr']['name'].to_s
+    total_fields = []
+    count = 0
+
+    front_matter = "---\nlayout: null\n---"
+    store_string = "\nvar store = ["
+    index_string = "\nvar index = new elasticlunr.Index;\nindex.setRef('lunr_id');\nindex.saveDocument(false);"
+    if $config['lunr']['multi-language'].to_s == 'true'
+      index_string += "\nindex.pipeline.remove(elasticlunr.trimmer);" # remove elasticlunr.trimmer if multilanguage is true
+    end
+
+    if meta.to_s.empty?
+      puts "Lunr index parameters are not properly cofigured.".magenta
+      exit 1
+    else
+      meta.each { |group| total_fields += group['fields'] }
+      if total_fields.uniq.empty?
+        puts "Fields are not properly configured.".magenta
+        exit 1
+      else
+        total_fields.uniq.each do |f|
+          index_string += "\nindex.addField(" + "'" + f + "'" + "); "
+        end
+
+        meta.each do |collection|
+
+          dir = collection['dir']
+          perma = collection['permalink']
+          fields = collection['fields']
+
+          puts ("Loading pages from " + dir).cyan
+
+          Dir.glob(dir+"/*").each do |md|
+            begin
+              yaml = YAML.load_file(md)
+              hash = Hash.new
+              hash['lunr_id'] = count
+              hash['link'] = "{{ site.baseurl }}" + yaml['permalink']
+              fields.each { |f| hash[f] = clean(yaml[f].to_s) }
+              if $config['lunr']['content']
+                hash['content'] = clean(File.read(md))
+              end
+              index_string += "\nindex.addDoc(" + hash.to_json + "); "
+              store_string += "\n" + hash.to_json + ", "
+              count += 1
+            rescue
+              puts ("Cannot load data from markdown pages in " + dir + ".").magenta
+              exit 1
+            end
+          end
+        end
+
+        store_string = store_string.chomp(", ") + "];"
+
+        Dir.mkdir('js') unless File.exists?('js')
+        File.open("js/lunr-index.js", 'w') { |file| file.write( front_matter + index_string + store_string ) }
+        puts ("Writing lunr index to " + "js/lunr-index.js").green
+      end
+    end
+  end
+end
+
+def clean(str)
+  str = str.gsub(/\A---(.|\n)*?---/, "") # remove yaml front matter
+  str = str.gsub(/{%(.*)%}/, "") # remove functional liquid
+  str = str.gsub(/<\/?[^>]*>/, "") # remove html
+  str = str.gsub("\\n", "").gsub(/\s+/, ' ') # remove newlines and extra space
+  str = str.gsub('"',"'").to_s # replace double quotes with single
+  return str
+end

data/lib/tasks/pagemaster.rake

@@ -0,0 +1,81 @@
+require 'yaml'
+require 'csv'
+
+namespace :wax do
+  desc 'generate collection md pages from yaml or csv data source'
+  task :pagemaster => :config do
+
+    collections = $config['collections']
+    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 |a|
+        collection = collections[a]
+        if collection.nil?
+          puts ("The collection '" + a + "' does not exist. Check for typos in terminal and _config.yml.").magenta
+          exit 1
+        else
+
+          meta = Hash.new
+          meta['src']     = '_data/' + File.basename( collection['source'], ".*" ) + ".csv"
+          meta['layout']  = File.basename( collection['layout'], ".*" )
+          meta['dir']     = collection['directory']
+
+          $skipped, $completed = 0,0
+
+          unless [ meta['src'], meta['dir'], meta['layout'] ].all?
+            puts ("Your collection " + a +" is missing one or more of the required parameters (source, directory, layout) in config. please fix and rerun.").magenta
+            exit 1
+      		else
+      			FileUtils::mkdir_p meta['dir']
+      			data = ingest(meta['src'])
+            generate_pages(meta, data)
+      			puts ("\n" + $completed.to_s + " pages were generated to " + meta['dir'] + " directory.").green
+      			puts ($skipped.to_s + " pre-existing items were skipped.").green
+          end
+        end
+      end
+    end
+  end
+end
+
+def ingest(src)
+  begin
+    data = CSV.read(src, :headers => true, :encoding => 'utf-8')
+    duplicates = data['pid'].detect{ |i| data.count(i) > 1 }.to_s
+    unless duplicates.empty?
+      puts ("Your collection has the following duplicate ids. please fix and rerun.\n").magenta + duplicates +"\n"
+      exit 1
+    end
+    puts ("\nProcessing " + src + "....\n").cyan
+    return data.map(&:to_hash)
+  rescue
+    puts ("Cannot load " + src + ". check for typos and rebuild.").magenta
+    exit 1
+  end
+end
+
+def generate_pages(meta, data)
+  if $config['permalink'] == 'pretty'
+    perma_ext = "/"
+  else
+    perma_ext = ".html"
+  end
+  data.each do |item|
+    begin
+      pagename = item['pid']
+      pagepath = meta['dir'] + "/" + pagename + ".md"
+      if !File.exist?(pagepath)
+        File.open(pagepath, 'w') { |file| file.write( item.to_yaml.to_s + "permalink: /" + meta['dir'] + "/" + pagename + perma_ext + "\n" + "layout: " + meta['layout'] + "\n---" ) }
+        $completed+=1
+      else
+        puts pagename + ".md already exits. Skipping."
+        $skipped+=1
+      end
+    rescue
+      puts ($completed.to_s + " pages were generated before failure, most likely a record is missing a valid 'pid' value.").magenta
+      exit 1
+    end
+  end
+end

data/lib/tasks/s3branch.rake

@@ -0,0 +1,33 @@
+require 'jekyll'
+require 'tmpdir'
+require 'fileutils'
+require 'iiif_s3'
+
+namespace :wax do
+  desc 'build site with baseurl and publish to s3 branch'
+  task :s3branch => :config do
+    FileUtils.rm_rf('_site')
+    baseurl = $config['baseurl']
+
+    Jekyll::Site.new(Jekyll.configuration({
+      "source"      => ".",
+      "destination" => "_site",
+      "config" => "_config.yml",
+      "incremental" => true,
+      "verbose" => true,
+      "baseurl" => baseurl
+    })).process
+
+    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}"
+      system "git push origin master:refs/heads/s3 --force"
+    end
+  end
+end

data/lib/tasks/test.rake

@@ -0,0 +1,25 @@
+require 'html-proofer'
+require 'iiif_s3'
+
+namespace :wax do
+  desc 'run htmlproofer, rspec if exists'
+    task :test do
+      options = {
+      :check_external_hash => true,
+      :allow_hash_href => true,
+      :check_html => true,
+      :disable_external => true,
+      :empty_alt_ignore => true,
+      :only_4xx => true,
+      :verbose => true
+    }
+    begin
+      HTMLProofer.check_directory("./_site", options).run
+    rescue => msg
+      puts "#{msg}"
+    end
+    if File.exist?('.rspec')
+      sh 'bundle exec rspec'
+    end
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: wax_tasks
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Marii Nyröp
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+- !ruby/object:Gem::Dependency
+  name: html-proofer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: iiif_s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: 'Rake tasks for minimal exhibition sites with Jekyll. See: minicomp/wax.'
+email:
+- m.nyrop@columbia.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/tasks/config.rake
+- lib/tasks/ghbranch.rake
+- lib/tasks/iiif.rake
+- lib/tasks/lunr.rake
+- lib/tasks/pagemaster.rake
+- lib/tasks/s3branch.rake
+- lib/tasks/test.rake
+homepage: https://github.com/mnyrop/wax_tasks
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.9
+signing_key: 
+specification_version: 4
+summary: Rake tasks for minimal exhibitions.
+test_files: []