kubes 0.7.4 → 0.7.5

data/docs/search/search.js

@@ -0,0 +1,247 @@
+/**
+ * A simple JSON search
+ * Requires jQuery (v 1.7+)
+ *
+ * @author   Mat Hayward - Erskine Design
+ * @author   Rishikesh Darandale <Rishikesh.Darandale@gmail.com>
+ * @version  1.1
+ */
+
+var q, jsonFeedUrl = "/search/data.json",
+  $searchForm = $("[data-search-form]"),
+  $searchInput = $("[data-search-input]"),
+  $resultTemplate = $("#search-result"),
+  $resultsPlaceholder = $("[data-search-results]"),
+  $foundContainer = $("[data-search-found]"),
+  $foundTerm = $("[data-search-found-term]"),
+  $foundCount = $("[data-search-found-count]"),
+  $foundWord = $("[data-search-found-word]"),
+  allowEmpty = true,
+  showLoader = true,
+  loadingClass = "is--loading",
+  indexVar;
+
+
+$(document).ready( function() {
+  // hide items found string
+  $foundContainer.hide();
+  // initiate search functionality
+  initSearch();
+});
+
+function initSearch() {
+  if(!sessionStorage.getItem("lunrIndex")) {
+    // get the data
+    getData();
+  } else {
+    // Get search results if q parameter is set in querystring
+    if (getParameterByName('q')) {
+      q = decodeURIComponent(getParameterByName('q'));
+      $searchInput.val(q);
+      execSearch(q);
+    }
+  }
+
+  // Get search results on submission of form
+  $(document).on("submit", $searchForm, function(e) {
+    console.log("form submitted");
+    e.preventDefault();
+    q = $searchInput.val();
+    execSearch(q);
+  });
+}
+
+/**
+ * Get the JSON data
+ * Get the generated feeds/feed.json file so lunr.js can search it locally.
+ * Store the index in sessionStorage
+ */
+function getData(indexVar) {
+  jqxhr = $.getJSON(jsonFeedUrl)
+    .done(function(loaded_data){
+      // save the actual data as well
+      sessionStorage.setItem("actualData", JSON.stringify(loaded_data));
+      // set the index fields
+      indexVar = lunr(function () {
+        this.field('id');
+        this.field('title', { boost: 10 });
+        this.field('search_title', { boost: 10 });
+        this.field('content', { boost: 10 });
+        this.field('author');
+        loaded_data.forEach(function (doc, index) {
+          if ( doc.search_omit != "true" ) {
+            console.log("adding to index: " + doc.title);
+            this.add($.extend({ "id": index }, doc));
+          }
+        }, this)
+      });
+      // store the index in sessionStorage
+      sessionStorage.setItem("lunrIndex", JSON.stringify(indexVar));
+      // Get search results if q parameter is set in querystring
+      if (getParameterByName('q')) {
+        q = decodeURIComponent(getParameterByName('q'));
+        $searchInput.val(q);
+        execSearch(q);
+      }
+    })
+    .fail( function() {
+      console.log("get json failed...");
+    })
+    .always( function() {
+      console.log("finally...");
+    });
+}
+
+/**
+ * Get the search result from lunr
+ * @param {String} q
+ * @returns search results
+ */
+function getResults(q) {
+  var savedIndexData = JSON.parse(sessionStorage.getItem("lunrIndex"));
+  console.log("Indexed var from sessionStorage: " + savedIndexData);
+  return lunr.Index.load(savedIndexData).search(q);
+}
+
+/**
+ * Executes search
+ * @param {String} q
+ * @return null
+ */
+function execSearch(q) {
+  if (q != '' || allowEmpty) {
+    if (showLoader) {
+      toggleLoadingClass();
+    }
+    processResultData(getResults(q));
+    changeUrl("Search", "/search/?q=" + encodeURIComponent(q));
+  }
+}
+
+/**
+ * Toggles loading class on results and found string
+ * @return null
+ */
+function toggleLoadingClass() {
+  $resultsPlaceholder.toggleClass(loadingClass);
+  $foundContainer.toggleClass(loadingClass);
+}
+
+/**
+ * Process search result data
+ * @return null
+ */
+function processResultData(searchResults) {
+  $results = [];
+
+  console.log("Search Results: " + searchResults);
+  var resultsCount = 0,
+      results = "";
+
+  // Iterate over the results
+  searchResults.forEach(function(result) {
+    var loaded_data = JSON.parse(sessionStorage.getItem("actualData"));
+    var item = loaded_data[result.ref];
+    var result = populateResultContent($resultTemplate.html(), item);
+        resultsCount++;
+        results += result;
+  });
+
+
+  if (showLoader) {
+    toggleLoadingClass();
+  }
+
+  populateResultsString(resultsCount);
+  showSearchResults(results);
+}
+
+/**
+ * Add search results to placeholder
+ * @param {String} results
+ * @return null
+ */
+function showSearchResults(results) {
+  // Add results HTML to placeholder
+  $resultsPlaceholder.html(results);
+}
+
+/**
+ * Add results content to item template
+ * @param {String} html
+ * @param {object} item
+ * @return {String} Populated HTML
+ */
+function populateResultContent(html, item) {
+  var title = item.search_title || item.title
+  html = injectContent(html, title, '##Title##');
+  html = injectContent(html, item.link, '##Url##');
+  var content = text_truncate(item.content);
+  html = injectContent(html, content, '##Content##');
+  return html;
+}
+
+function text_truncate(str, length, ending) {
+  if (length == null) {
+    length = 255;
+  }
+  if (ending == null) {
+    ending = '...';
+  }
+  if (str.length > length) {
+    return str.substring(0, length - ending.length) + ending;
+  } else {
+    return str;
+  }
+};
+
+/**
+ * Populates results string
+ * @param {String} count
+ * @return null
+ */
+function populateResultsString(count) {
+  $foundTerm.text(q);
+  $foundCount.text(count);
+  if (count == 1)
+    $foundWord.text("result")
+  else
+    $foundWord.text("results")
+  $foundContainer.show();
+}
+
+ /* ==========================================================================
+    Helper functions
+    ========================================================================== */
+
+
+/**
+ * Gets query string parameter - taken from http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript
+ * @param {String} name
+ * @return {String} parameter value
+ */
+function getParameterByName(name) {
+  var match = RegExp('[?&]' + name + '=([^&]*)').exec(window.location.search);
+  return match && decodeURIComponent(match[1].replace(/\+/g, ' '));
+}
+
+/**
+ * Injects content into template using placeholder
+ * @param {String} originalContent
+ * @param {String} injection
+ * @param {String} placeholder
+ * @return {String} injected content
+ */
+function injectContent(originalContent, injection, placeholder) {
+  var regex = new RegExp(placeholder, 'g');
+  return originalContent.replace(regex, injection);
+}
+
+function changeUrl(page, url) {
+  if (typeof(window.history.pushState) != "undefined") {
+    var obj = { Page: page, Url: url };
+    window.history.pushState(obj, obj.Page, obj.Url);
+  } else {
+    console.log("Browser does not support HTML5.");
+  }
+}

data/docs/search/tips.md

@@ -0,0 +1,48 @@
+---
+title: Search Tips
+---
+
+Here are some useful search tips that can help to make searching more effective.
+
+## OR Searches
+
+By default, searches for multiple terms are combined with OR. If a document matches at least one of the search terms, it will show in the results. So:
+
+    install aws
+
+Will always result in more results just `install` by itself.
+
+
+## AND Searches
+
+To do an AND search of "install AND aws" mark both terms as required, you use a `+` sign in front of each term. Example:
+
+    +install +aws
+
+This results in pages only with both exactly install and aws.
+
+## Filter Terms
+
+To filter "keywords", you use a `-` sign in front of each term. Example:
+
+    +install -aws
+
+This results in pages only with install but filter or reject any pages with aws.
+
+## Wildcard
+
+You can use wildcards:
+
+    install*
+
+## Fields
+
+You can target specific fields:
+
+    title:install
+
+For fields see: [search data.json]({% link search/data.json %})
+
+## More Tips
+
+More search tips can be found at: [lunrjs searching](https://lunrjs.com/guides/searching.html)

data/lib/kubes/compiler/dsl/core/fields.rb

@@ -64,7 +64,7 @@ module Kubes::Compiler::Dsl::Core
         result = instance_variable_get(ivar)
         result = {} if mode == "reset" # allow user to override with mode: reset option
         result ||= {} # maintain value for layering
-        result.deeper_merge!(value)
+        Kubes.deep_merge!(result, value)
         instance_variable_set(ivar, result)
       end
     end

data/lib/kubes/compiler/dsl/syntax/resource.rb

@@ -18,7 +18,7 @@ module Kubes::Compiler::Dsl::Syntax
     # top-level of resource is quite common
     def default_result
       data = top.merge(default_top)
-      data.deeper_merge!(default_result_append)
+      Kubes.deep_merge!(data, default_result_append)
       data.deep_stringify_keys!
       HashSqueezer.squeeze(data)
     end
@@ -63,7 +63,7 @@ module Kubes::Compiler::Dsl::Syntax
 
     # For generic kind
     def field(name, data)
-      top.deeper_merge!(name => data)
+      Kubes.deep_merge!(top, {name => data})
     end
   end
 end

data/lib/kubes/compiler/strategy/dispatcher.rb

@@ -4,8 +4,8 @@ class Kubes::Compiler::Strategy
       result = render(@path) # main
       results = [result].flatten # ensure array
       data = results.map! do |main|
-        hash = pre_layer.deeper_merge!(main) # need the ! or deep_merge returns original hash
-        hash.deeper_merge!(post_layer)
+        hash = Kubes.deep_merge!(pre_layer, main)
+        Kubes.deep_merge!(hash, post_layer)
       end
       Result.new(@save_file, data)
     end

data/lib/kubes/core.rb

@@ -34,5 +34,11 @@ module Kubes
       logger.error "ERROR: It doesnt look like this is a kubes project. Are you sure you are in a kubes project?".color(:red)
       ENV['TS_TEST'] ? raise : exit(1)
     end
+
+    # wrapper to ensure we use the same deeper_merge options everywhere
+    def deep_merge!(a, b)
+      a.deeper_merge!(b, overwrite_arrays: true)
+      a
+    end
   end
 end

data/lib/kubes/version.rb

@@ -1,3 +1,3 @@
 module Kubes
-  VERSION = "0.7.4"
+  VERSION = "0.7.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubes
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.7.5
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-02 00:00:00.000000000 Z
+date: 2021-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -472,6 +472,11 @@ files:
 - docs/opal/sidebar.rb
 - docs/opal/sidebar/expander.rb
 - docs/reference.md
+- docs/search/data.json
+- docs/search/index.html
+- docs/search/lunr.js
+- docs/search/search.js
+- docs/search/tips.md
 - docs/support.md
 - docs/vendor/bootstrap/css/bootstrap-grid.css
 - docs/vendor/bootstrap/css/bootstrap-grid.css.map