wax_tasks 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a05cb7d5dd4a2218f7c20546a7bb40762ff50c1382457ab5dc8573f5a8131eb9
-  data.tar.gz: d80600e1d481d7aa91c78fc38fb214aa234f86859ff1ae8660310f17586b5ed0
+  metadata.gz: 6a9f379405599184347f73da048e52435aacd769de71046e617bcd9b44b0f760
+  data.tar.gz: 3e9e07cda10a6063cb82a3b6af02ce2453ee561fa085baf9118f6c6ef4183a52
 SHA512:
-  metadata.gz: 36879c674be8917117b4219e485c987386370c8d8c89d6d8fdc8bc0149a6d05265ede31b4f4720a1aa48d9cca5db1d2e10a8511663f0aaab9ee34a48bbb96edd
-  data.tar.gz: 8b9ba90bd8a415fcacc969bd787862d8d37e1b7f222341bd23a9c9b08c33cd5eb9fd641f31d5a02b0df99707009ffb57969d945d462698df10c45bde58d0e758
+  metadata.gz: 939570ab776be0b04c78665439e36254f0c1a2a6fb071383f439844be039167a84986ac2fa430c6865cb61be3f35d8e1fa539a90d0054719f538a4d15d1c5dd5
+  data.tar.gz: b27e94c4c56e17b9298cfb5c612497c049890a3e91ec05ea8ba44d2401c9f7a5873e315fbb78d571bd0b708f0ade59db6b799b779d3b75ebc1923b5d37b23bdd

data/lib/tasks/push.rake

@@ -6,8 +6,7 @@ namespace :wax do
     ARGS = ARGV.drop(1).each { |a| task a.to_sym }
     raise 'You must specify a branch after \'wax:push:branch\'' if ARGS.empty?
 
-    target = WaxTasks::Utils.slug(ARGS.first)
     task_runner = WaxTasks::TaskRunner.new
-    task_runner.push_branch(target)
+    task_runner.push_branch(ARGS.first)
   end
 end

data/lib/wax_tasks/branch.rb

@@ -1,6 +1,5 @@
 require 'jekyll'
 require 'logger'
-require 'time'
 require 'tmpdir'
 
 module WaxTasks
@@ -37,10 +36,11 @@ module WaxTasks
         msg = 'Building the gh-pages _site without a baseurl is not recommended'
         Logger.new($stdout).warn(msg.orange)
       end
-      FileUtils.rm_r(SITE_DIR) if File.directory?(SITE_DIR)
+      FileUtils.rm_r(SITE_DIR) if File.directory?(WaxTasks::SITE_DIR)
       opts = {
-        source: '.',
-        destination: SITE_DIR,
+        source: @site[:source_dir] || '.',
+        destination: WaxTasks::SITE_DIR,
+        config: WaxTasks::DEFAULT_CONFIG,
         baseurl:  @baseurl,
         verbose: true
       }
@@ -52,7 +52,7 @@ module WaxTasks
     def push
       if @site[:env] == 'prod'
         rebuild if @target == 'gh-pages'
-        raise Error::MissingSite, "Cannot find #{SITE_DIR}" unless Dir.exist? SITE_DIR
+        raise Error::MissingSite, "Cannot find #{WaxTasks::SITE_DIR}" unless Dir.exist? WaxTasks::SITE_DIR
         Dir.chdir(SITE_DIR)
         system 'git init && git add .'
         system "git commit -m '#{@commit_msg}'"
@@ -64,47 +64,4 @@ module WaxTasks
       end
     end
   end
-
-  # Branch object for `$ wax:push` task when run on Travis-CI VM
-  # using encrypted Travis environment vars
-  #
-  # @attr repo_slug   [String] the 'user/repo_name'
-  # @attr user        [String] the GitHub user making the commit/push
-  # @attr token       [String] secret git access token
-  # @attr commit_msg  [String] the commit message to use on push
-  # @attr origin      [String] the current repository remote
-  # @attr baseurl     [String] the site baseurl to build with (if on gh-pages)
-  # @attr success_msg [String] informative message to be output to console
-  class TravisBranch < Branch
-    def initialize(site, target)
-      super(site, target)
-
-      @repo_slug    = ENV['TRAVIS_REPO_SLUG']
-      @user         = @repo_slug.split('/').first
-      @token        = ENV['ACCESS_TOKEN']
-
-      @commit_msg   = "Updated via #{ENV['TRAVIS_COMMIT']} @#{Time.now.utc}"
-      @origin       = "https://#{@user}:#{@token}@github.com/#{@repo_slug}.git"
-      @baseurl      = @repo_slug.split('/').last
-      @success_msg  = "Deploying to #{@target} branch from Travis as #{@user}."
-    end
-  end
-
-  # Branch object for `$ wax:push` task when run on local machine
-  # using local credentials
-  #
-  # @attr origin      [String] the current repository remote
-  # @attr commit_msg  [String] the commit message to use on push
-  # @attr baseurl     [String] the site baseurl to build with (if on gh-pages)
-  # @attr success_msg [String] informative message to be output to console
-  class LocalBranch < Branch
-    def initialize(site, target)
-      super(site, target)
-
-      @origin       = `git config --get remote.origin.url`.strip
-      @commit_msg   = "Updated via local task at #{Time.now.utc}"
-      @baseurl      = @origin.split('/').last.gsub('.git', '')
-      @success_msg  = "Deploying to #{@target} branch from local task."
-    end
-  end
 end

data/lib/wax_tasks/collection.rb

@@ -47,12 +47,16 @@ module WaxTasks
     def ingest_file(source)
       raise Error::MissingSource, "Cannot find #{source}" unless File.exist? source
 
-      case File.extname(source)
-      when '.csv'     then data = WaxTasks::Utils.validate_csv(source)
-      when '.json'    then data = WaxTasks::Utils.validate_json(source)
-      when /\.ya?ml/  then data = WaxTasks::Utils.validate_yaml(source)
-      else raise Error::InvalidSource, "Cannot load #{File.extname(source)} files. Culprit: #{source}"
-      end
+      data = 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(data)
       WaxTasks::Utils.assert_unique(data)

data/lib/wax_tasks/local_branch.rb

@@ -0,0 +1,21 @@
+require 'time'
+
+module WaxTasks
+  # Branch object for `$ wax:push` task when run on local machine
+  # using local credentials
+  #
+  # @attr origin      [String] the current repository remote
+  # @attr commit_msg  [String] the commit message to use on push
+  # @attr baseurl     [String] the site baseurl to build with (if on gh-pages)
+  # @attr success_msg [String] informative message to be output to console
+  class LocalBranch < Branch
+    def initialize(site, target)
+      super(site, target)
+
+      @origin       = `git config --get remote.origin.url`.strip
+      @commit_msg   = "Updated via local task at #{Time.now.utc}"
+      @baseurl      = "/#{@origin.split('/').last.gsub('.git', '')}"
+      @success_msg  = "Deploying to #{@target} branch from local task."
+    end
+  end
+end

data/lib/wax_tasks/lunr_collection.rb

@@ -50,9 +50,12 @@ module WaxTasks
         'link' => "{{'#{yaml.fetch('permalink')}' | relative_url }}",
         'collection' => @name
       }
-      hash['content'] = File.read(page).html_strip.remove_diacritics if @content
+      if @content
+        content = WaxTasks::Utils.html_strip(File.read(page))
+        hash['content'] = WaxTasks::Utils.remove_diacritics(content)
+      end
       fields = @fields.push('pid').uniq
-      fields.each { |f| hash[f] = yaml[f].normalize }
+      fields.each { |f| hash[f] = yaml[f].lunr_normalize }
       hash
     end
   end

data/lib/wax_tasks/pagemaster_collection.rb

@@ -43,7 +43,7 @@ module WaxTasks
       FileUtils.mkdir_p(@page_dir)
       pages = []
       @data.each_with_index do |item, idx|
-        page_slug         = item.fetch('pid').to_s.slug
+        page_slug         = Utils.slug(item.fetch('pid'))
         path              = "#{@page_dir}/#{page_slug}.md"
         item['permalink'] = "/#{@name}/#{page_slug}#{@site[:permalink]}"
         item['layout']    = @layout

data/lib/wax_tasks/travis_branch.rb

@@ -0,0 +1,28 @@
+require 'time'
+
+module WaxTasks
+  # Branch object for `$ wax:push` task when run on Travis-CI VM
+  # using encrypted Travis environment vars
+  #
+  # @attr repo_slug   [String] the 'user/repo_name'
+  # @attr user        [String] the GitHub user making the commit/push
+  # @attr token       [String] secret git access token
+  # @attr commit_msg  [String] the commit message to use on push
+  # @attr origin      [String] the current repository remote
+  # @attr baseurl     [String] the site baseurl to build with (if on gh-pages)
+  # @attr success_msg [String] informative message to be output to console
+  class TravisBranch < Branch
+    def initialize(site, target)
+      super(site, target)
+
+      @repo_slug    = ENV['TRAVIS_REPO_SLUG']
+      @user         = @repo_slug.split('/').first
+      @token        = ENV['ACCESS_TOKEN']
+
+      @commit_msg   = "Updated via #{ENV['TRAVIS_COMMIT']} @#{Time.now.utc}"
+      @origin       = "https://#{@user}:#{@token}@github.com/#{@repo_slug}.git"
+      @baseurl      = "/#{@repo_slug.split('/').last}"
+      @success_msg  = "Deploying to #{@target} branch from Travis as #{@user}."
+    end
+  end
+end

data/lib/wax_tasks/utils.rb

@@ -89,47 +89,47 @@ module WaxTasks
       raise Error::NoLunrCollections, 'There are no lunr collections to index.' if to_index.nil?
       to_index.map { |c| c[0] }
     end
-  end
-end
 
-# Monkey-patched String class
-class String
-  # Removes YAML front matter from a string
-  # @return [String]
-  def remove_yaml
-    self.gsub!(/\A---(.|\n)*?---/, '')
-  end
+    # Removes YAML front matter from a string
+    # @return [String]
+    def self.remove_yaml(str)
+      str.to_s.gsub!(/\A---(.|\n)*?---/, '')
+    end
 
-  # Cleans YAML front matter + markdown pages for lunr indexing
-  # @return [String]
-  def html_strip
-    self.gsub!(/\A---(.|\n)*?---/, '') # remove yaml front matter
-    self.gsub!(/{%(.*)%}/, '') # remove functional liquid
-    self.gsub!(%r{<\/?[^>]*>}, '') # remove html
-    self.gsub!('\\n', '') # remove newlines
-    self.gsub!(/\s+/, ' ') # remove extra space
-    self.tr!('"', "'") # replace double quotes with single
-    self
-  end
+    # Cleans YAML front matter + markdown pages for lunr indexing
+    # @return [String]
+    def self.html_strip(str)
+      str.gsub!(/\A---(.|\n)*?---/, '') # remove yaml front matter
+      str.gsub!(/{%(.*)%}/, '') # remove functional liquid
+      str.gsub!(%r{<\/?[^>]*>}, '') # remove html
+      str.gsub!('\\n', '') # remove newlines
+      str.gsub!(/\s+/, ' ') # remove extra space
+      str.tr!('"', "'") # replace double quotes with single
+      str
+    end
 
-  # Normalizes accent marks/diacritics for Lunr indexing
-  # @return [String]
-  def remove_diacritics
-    to_replace  = 'ÀÁÂÃÄÅàáâãäåĀāĂ㥹ÇçĆćĈĉĊċČčÐðĎďĐđÈÉÊËèéêëĒēĔĕĖėĘęĚěĜĝĞğĠġĢģĤĥĦħÌÍÎÏìíîïĨĩĪīĬĭĮįİıĴĵĶķĸĹĺĻļĽľĿŀŁłÑñŃńŅņŇňʼnŊŋÒÓÔÕÖØòóôõöøŌōŎŏŐőŔŕŖŗŘřŚśŜŝŞşŠšſŢţŤťŦŧÙÚÛÜùúûüŨũŪūŬŭŮůŰűŲųŴŵÝýÿŶŷŸŹźŻżŽž'
-    replaced_by = 'AAAAAAaaaaaaAaAaAaCcCcCcCcCcDdDdDdEEEEeeeeEeEeEeEeEeGgGgGgGgHhHhIIIIiiiiIiIiIiIiIiJjKkkLlLlLlLlLlNnNnNnNnnNnOOOOOOooooooOoOoOoRrRrRrSsSsSsSssTtTtTtUUUUuuuuUuUuUuUuUuUuWwYyyYyYZzZzZz'
-    self.tr(to_replace, replaced_by)
-  end
+    # Normalizes accent marks/diacritics for Lunr indexing
+    # @return [String]
+    def self.remove_diacritics(str)
+      to_replace  = 'ÀÁÂÃÄÅàáâãäåĀāĂ㥹ÇçĆćĈĉĊċČčÐðĎďĐđÈÉÊËèéêëĒēĔĕĖėĘęĚěĜĝĞğĠġĢģĤĥĦħÌÍÎÏìíîïĨĩĪīĬĭĮįİıĴĵĶķĸĹĺĻļĽľĿŀŁłÑñŃńŅņŇňʼnŊŋÒÓÔÕÖØòóôõöøŌōŎŏŐőŔŕŖŗŘřŚśŜŝŞşŠšſŢţŤťŦŧÙÚÛÜùúûüŨũŪūŬŭŮůŰűŲųŴŵÝýÿŶŷŸŹźŻżŽž'
+      replaced_by = 'AAAAAAaaaaaaAaAaAaCcCcCcCcCcDdDdDdEEEEeeeeEeEeEeEeEeGgGgGgGgHhHhIIIIiiiiIiIiIiIiIiJjKkkLlLlLlLlLlNnNnNnNnnNnOOOOOOooooooOoOoOoRrRrRrSsSsSsSssTtTtTtUUUUuuuuUuUuUuUuUuUuWwYyyYyYZzZzZz'
+      str.to_s.tr(to_replace, replaced_by)
+    end
 
-  # Converts string to snake case and swaps out special chars
-  # @return [String]
-  def slug
-    self.downcase.tr(' ', '_').gsub(/[^\w-]/, '')
+    # Converts string to snake case and swaps out special chars
+    # @return [String]
+    def self.slug(str)
+      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 normalize
-    self.remove_diacritics
+  def lunr_normalize
+    WaxTasks::Utils.remove_diacritics(self)
   end
 
   # Colorizes console output to magenta (errors)
@@ -156,11 +156,11 @@ class Array
   # Normalizes an array as a string or array of hashes
   # without diacritics for lunr indexing
   # @return [Hash || String] description
-  def normalize
+  def lunr_normalize
     if self.first.is_a? Hash
       self
     else
-      self.join(', ').remove_diacritics
+      WaxTasks::Utils.remove_diacritics(self.join(', '))
     end
   end
 end
@@ -169,7 +169,7 @@ end
 class Hash
   # Normalizes hash as itself for lunr indexing
   # @return [Hash]
-  def normalize
+  def lunr_normalize
     self
   end
 
@@ -188,7 +188,16 @@ end
 class Integer
   # Normalizes integer as a string for lunr indexing
   # @return [String]
-  def normalize
+  def lunr_normalize
+    self.to_s
+  end
+end
+
+# Monkey-patched Nil class
+class NilClass
+  # Normalizes integer as a string for lunr indexing
+  # @return [String]
+  def lunr_normalize
     self.to_s
   end
 end

data/lib/wax_tasks.rb

@@ -2,10 +2,12 @@ require_relative 'wax_tasks/branch'
 require_relative 'wax_tasks/collection'
 require_relative 'wax_tasks/error'
 require_relative 'wax_tasks/iiif_collection'
+require_relative 'wax_tasks/local_branch'
 require_relative 'wax_tasks/lunr_collection'
 require_relative 'wax_tasks/lunr_index'
 require_relative 'wax_tasks/pagemaster_collection'
 require_relative 'wax_tasks/task_runner'
+require_relative 'wax_tasks/travis_branch'
 require_relative 'wax_tasks/utils'
 
 # The WaxTasks module powers the Rake tasks in `./tasks`, including:

data/spec/spec_helper.rb

@@ -1,11 +1,6 @@
-# toggle stdout/stderr verbosity
-#
 # run $ DEBUG=true bundle exec rspec for verbose output
 # run $ bundle exec rspec for sparse output
-case ENV['DEBUG']
-when 'true' then QUIET = false
-else QUIET = true
-end
+QUIET = !ENV['DEBUG']
 
 # use codecov + add requirements
 require 'simplecov'
@@ -26,12 +21,3 @@ shared_context 'shared', :shared_context => :metadata do
   let(:index_path) { 'js/lunr_index.json' }
   let(:ui_path) { 'js/lunr_ui.js'}
 end
-
-# run tests in a more intuitive order
-require 'tests/tasks_spec'
-require 'tests/task_runner_spec'
-require 'tests/utils_spec'
-require 'tests/pagemaster_collection_spec'
-require 'tests/lunr_collection_spec'
-require 'tests/iiif_collection_spec'
-require 'tests/branch_spec'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wax_tasks
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Marii Nyrop
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-26 00:00:00.000000000 Z
+date: 2018-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: html-proofer
@@ -113,10 +113,12 @@ files:
 - lib/wax_tasks/collection.rb
 - lib/wax_tasks/error.rb
 - lib/wax_tasks/iiif_collection.rb
+- lib/wax_tasks/local_branch.rb
 - lib/wax_tasks/lunr_collection.rb
 - lib/wax_tasks/lunr_index.rb
 - lib/wax_tasks/pagemaster_collection.rb
 - lib/wax_tasks/task_runner.rb
+- lib/wax_tasks/travis_branch.rb
 - lib/wax_tasks/utils.rb
 - spec/setup.rb
 - spec/spec_helper.rb
@@ -146,5 +148,5 @@ signing_key:
 specification_version: 4
 summary: Rake tasks for minimal exhibition sites with Jekyll Wax.
 test_files:
-- spec/setup.rb
 - spec/spec_helper.rb
+- spec/setup.rb