wax_tasks 0.0.40 → 0.0.41

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e575498bcfd76bd5bd11705d9d6cac510a422eb
-  data.tar.gz: 725bae639d3bbb4ed57bdb0d79e9fb8147c85324
+  metadata.gz: afb4a9e989cd10f473e2fead7740ce6e8f450d4a
+  data.tar.gz: 13d1d213f15697986aefc80396cf82a29b1aedc9
 SHA512:
-  metadata.gz: 4c120c938aaf9778d1061749c2f9f38e0899ba4b56dd20ae97c08a34b3a15a77766f481b91efa43b6612295210368260613f9b79be2d863a7d90f35bc9accb16
-  data.tar.gz: 3f71b6b7e531c01f2d8d22aa2ef03d0c053f96a8e5dd9938e352226c0325e75a8c5e2b7fbf58cdf7d4ec3c76d588cd0ac5ad122d90de4e1d766f938d2adbcd35
+  metadata.gz: 2068c29aec041abea14be1384ae22104972da1d9f74d052e6ba2e206f86d786af2e4bcc2f03e2192f2cb170a9f4e6229d2fa7ee7f7f77920ba1c255c9120180b
+  data.tar.gz: 7a1245c635cb173acd1a69f1673bdf66af77ead311ca17a49922fa3870c79fce00f77c3335f7c222e201385dfaec8517d988c54787cf6750963547ef8340938a

data/lib/tasks/jspackage.rake

@@ -0,0 +1,23 @@
+require 'wax_tasks'
+require 'json'
+
+namespace :wax do
+  desc 'write a simple package.json'
+  task :jspackage => :config do
+    package = {
+      'name'          => $config['title'],
+      'version'       => '1.0.0',
+      'description'   => $config['description'],
+      'dependencies'  => {}
+    }
+    names = []
+    $config['js'].each do |dependency|
+      name = dependency[0]
+      names << name
+      version = dependency[1]['version']
+      package['dependencies'][name] = '^' + version
+    end
+    File.open('package.json', 'w') { |file| file.write(package.to_json) }
+    puts "Writing #{names} to simple package.json.".cyan
+  end
+end

data/lib/tasks/lunr.rake

@@ -3,12 +3,24 @@ require 'wax_tasks'
 namespace :wax do
   desc 'build lunr search index'
   task :lunr => :config do
-    collections = $config['collections']
-    lunr_language = $config['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) }
-    puts "Writing lunr index to js/lunr-index.js".cyan
+    yaml = "---\nlayout: none\n---\n"
+    lunr = Lunr.new($config)
+
+    # write index to json file
+    idx = yaml + lunr.index
+    idx_path = 'js/lunr-index.json'
+    File.open(idx_path, 'w') { |file| file.write(idx) }
+    puts "Writing lunr index to #{idx_path}".cyan
+
+    # write index.ui to js file
+    ui = yaml + lunr.ui
+    ui_path = 'js/lunr-ui.js'
+    if File.exist?(ui_path)
+      puts "Lunr UI already exists at #{ui_path}. Skipping".cyan
+    else
+      File.open(ui_path, 'w') { |file| file.write(ui) }
+      puts "Writing lunr index to #{ui_path}".cyan
+    end
   end
 end

data/lib/wax_tasks/helpers.rb

@@ -23,5 +23,10 @@ def rm_diacritics(str)
 end
 
 def slug(str)
-  str.downcase.tr(' ', '_').gsub(/[^\w-]/, '')
+  str.downcase.tr(' ', '_').gsub(/[^:\w-]/, '')
+end
+
+def thing2string(thing)
+  thing = thing.join(" ") if thing.is_a?(Array)
+  thing.to_s
 end

data/lib/wax_tasks/lunr.rb

@@ -0,0 +1,69 @@
+include FileUtils
+
+# for generating Lunr Index and Lunr UI files
+class Lunr
+  def initialize(config)
+    @lunr_collections = collections_to_index(config['collections'])
+    @total_fields     = total_fields(@lunr_collections)
+    @lunr_language    = config['lunr_language']
+    @collections_dir  = config['collections_dir'].nil? ? '' : config.fetch('collections_dir') + '/'
+  end
+
+  def collections_to_index(collections)
+    collections.find_all { |c| c[1].key?('lunr_index') && c[1]['lunr_index'].key?('fields') }
+  end
+
+  def total_fields(collections)
+    total_fields = ['pid']
+    collections.each do |c|
+      total_fields = total_fields.concat(c[1]['lunr_index']['fields'])
+      total_fields << 'content' if c[1]['lunr_index']['content']
+    end
+    total_fields.uniq
+  end
+
+  def index
+    full_index = []
+    count = 0
+    # catch
+    abort("There are no valid collections to index.".magenta) if @lunr_collections.nil?
+    # index each lunr_collection
+    @lunr_collections.each do |c|
+      c_dir = @collections_dir + '_' + c[0]
+      c_fields = c[1]['lunr_index']['fields'].uniq
+      c_pages = Dir.glob(c_dir + '/*.md')
+      # catch
+      abort "There are no markdown pages in directory '#{c_dir}'".magenta if c_pages.empty?
+      abort "There are no fields specified for #{c[0]}.".magenta if c_fields.empty?
+      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']
+        count += 1
+        full_index << hash
+      end
+    end
+    JSON.pretty_generate(full_index)
+  end
+
+  def ui
+    # set up index
+    ui_string = "$.getJSON(\"{{ site.baseurl }}/js/lunr-index.json\", function(index_json) {\nwindow.index = new elasticlunr.Index;\nwindow.store = index_json;\nindex.saveDocument(false);\nindex.setRef('lunr_id');"
+    # add fields to index
+    @total_fields.each { |field| ui_string += "\nindex.addField('#{field}');" }
+    # add docs
+    ui_string += "\n// add docs\nfor (i in store){index.addDoc(store[i]);}"
+    # gui
+    ui_string += "\n$('input#search').on('keyup', function() {\nvar results_div = $('#results');\nvar query = $(this).val();\nvar results = index.search(query, { boolean: 'AND', expand: true });\nresults_div.empty();\nif (results.length > 10) {\nresults_div.prepend(\"<p><small>Displaying 10 of \" + results.length + \" results.</small></p>\");\n}\nfor (var r in results.slice(0, 9)) {\nvar ref = results[r].ref;\nvar item = store[ref];"
+    # add fields as display vars
+    @total_fields.each { |field| ui_string += "var #{field} = item.#{field};\n" }
+    ui_string += "var result = '<div class=\"result\"><b><a href=\"' + item.link + '\">' + title + '</a></b></p></div>';\nresults_div.append(result);\n}\n});\n});"
+    ui_string
+  end
+end

data/lib/wax_tasks.rb

@@ -4,4 +4,4 @@ Bundler.require(:default)
 
 require 'wax_tasks/helpers'
 require 'wax_tasks/collection'
-require 'wax_tasks/index'
+require 'wax_tasks/lunr'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wax_tasks
 version: !ruby/object:Gem::Version
-  version: 0.0.40
+  version: 0.0.41
 platform: ruby
 authors:
 - Marii Nyrop
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-09 00:00:00.000000000 Z
+date: 2018-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -147,6 +147,7 @@ files:
 - lib/tasks/config.rake
 - lib/tasks/ghbranch.rake
 - lib/tasks/iiif.rake
+- lib/tasks/jspackage.rake
 - lib/tasks/lunr.rake
 - lib/tasks/pagemaster.rake
 - lib/tasks/s3branch.rake
@@ -154,7 +155,7 @@ files:
 - lib/wax_tasks.rb
 - lib/wax_tasks/collection.rb
 - lib/wax_tasks/helpers.rb
-- lib/wax_tasks/index.rb
+- lib/wax_tasks/lunr.rb
 - spec/spec_helper.rb
 homepage: https://github.com/mnyrop/wax_tasks
 licenses:
@@ -176,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.9
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Rake tasks for minimal exhibitions.

data/lib/wax_tasks/index.rb

@@ -1,67 +0,0 @@
-include FileUtils
-
-# 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.fetch('collections_dir') + '/'
-    @lunr_collections = []
-    @total_fields     = []
-    @output           = ''
-
-    pre_process
-    add_docs
-  end
-
-  def pre_process
-    @output += "---\nlayout: none\n---\nvar index = new elasticlunr.Index;\nindex.setRef('lunr_id');\nindex.saveDocument(false);"
-    @output += "\nindex.pipeline.remove(elasticlunr.trimmer);" if @lunr_language
-    @collections.each do |c|
-      if c[1].key?('lunr_index') && c[1]['lunr_index'].key?('fields')
-        @total_fields.concat c[1]['lunr_index']['fields']
-        @total_fields << 'content' if c[1]['lunr_index']['content']
-        @lunr_collections << c
-      end
-    end
-    @total_fields.uniq!
-    abort("Fields are not properly configured.".magenta) if @total_fields.empty?
-    @total_fields.each { |f| @output += "\nindex.addField(" + "'" + f + "'" + "); " }
-  end
-
-  def add_docs
-    count = 0
-    store_string = "\nvar store = ["
-
-    abort("There are no valid collections to index.".magenta) if @collections.nil?
-    @lunr_collections.each do |c|
-      dir = @cdir + '_' + c[0]
-      fields = c[1]['lunr_index']['fields'].uniq
-      pages = Dir.glob(dir + '/*.md')
-
-      abort "There are no markdown pages in directory '#{dir}'".magenta if pages.empty?
-      abort "There are no fields specified for #{c[0]}.".magenta if fields.empty?
-
-      puts "Loading #{pages.length} pages from #{dir}"
-      pages.each do |page|
-        begin
-          yaml = YAML.load_file(page)
-          hash = {
-            'lunr_id' => count,
-            'link' => "{{'" + yaml.fetch('permalink') + "' | relative_url }}"
-          }
-          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 + ", "
-          count += 1
-        rescue StandardError
-          abort "Cannot load data from markdown pages in #{dir}.".magenta
-        end
-      end
-    end
-    @output += store_string.chomp(', ') + '];'
-  end
-end