fragment_highlighter-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c6408468fafdf63427c816205dd38a1215f48f4e
+  data.tar.gz: b461fe69e5f315729de0fcedde65a5a36fd38eb3
+SHA512:
+  metadata.gz: b75f5574ec1c03e52cb652eee80b8d1e6d5274139d9f18d1dbb5d573945d421e6be293365729c71dcf1b4b19dfef92c12bfaea5a8fea7c861de231dca35ff9a1
+  data.tar.gz: 74e581c62c117065ad72acdfc4a4d7c34fd2119fa81d0a561b6ea53f202fefd07fb34d9ebd7377379364f8f910ca322b43e71c1f3ac63c7a8a47d247a49c74ca

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/tmp
+/log
+/tmp/
+
+# Ignore Byebug command history file.
+.byebug_history

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in fragment_highlighter-rails.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Flower Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# fragment_highlighter-rails
+JavaScript UI library for highlighting text fragments on page and saving ones into localStorage
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fragment_highlighter-rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fragment_highlighter-rails
+
+## Usage
+
+#application.css
+
+    @import "bootstrap-sprockets";
+    @import "bootstrap";
+    *= require 'fragment-highlighter'
+
+#application.js
+
+    //= require jquery
+    //= require bootstrap-sprockets
+    //= require fragment-highlighter/fragment-highlighter.js
+
+    $(function() {
+      let allowedPages = ['/articles/'];
+      new FragmentHighlighter(allowedPages);
+    });
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/fragment_highlighter-rails.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fragment_highlighter/rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fragment_highlighter-rails.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "fragment_highlighter/rails/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fragment_highlighter-rails"
+  spec.version       = FragmentHighlighter::Rails::VERSION
+  spec.authors       = ["PhlowerTeam"]
+  spec.email         = ["phlowerteam@gmail.com"]
+
+  spec.summary       = %q{JavaScript UI library for highlighting text fragments on the page and saving ones into localStorage}
+  spec.homepage      = "https://github.com/phlowerteam/fragment_highlighter-rails"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bootstrap-sass", "~> 3.3.5"
+  spec.add_development_dependency "jquery-rails"
+end

data/lib/fragment_highlighter/rails.rb

@@ -0,0 +1,8 @@
+require "fragment_highlighter/rails/version"
+
+module FragmentHighlighter
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/fragment_highlighter/rails/version.rb

@@ -0,0 +1,5 @@
+module FragmentHighlighter
+  module Rails
+    VERSION = "0.1.0"
+  end
+end

data/vendor/assets/javascripts/fragment-highlighter/fragment-highlighter.js

@@ -0,0 +1,35 @@
+//= require fragment-highlighter/libs/jquery.mark.es6.min.js
+//= require fragment-highlighter/libs/classes/HView.js
+//= require fragment-highlighter/libs/classes/HWindowCtrls.js
+//= require fragment-highlighter/libs/classes/LS.js
+//= require fragment-highlighter/libs/classes/Marker.js
+//= require fragment-highlighter/libs/classes/Tools.js
+//= require fragment-highlighter/libs/classes/UserSettings.js
+
+class FragmentHighlighter {
+
+  constructor(pages) {
+    FragmentHighlighter.init(pages);
+  }
+
+  static init(allowedPages) {
+    $(function(){
+      if (HView.isSupportedPage(allowedPages)) {
+        HView.renderModeButton();
+      }
+
+      HView.initHighlightWindow();
+      UserSettings.init();
+
+      if (HView.isHModeOn(allowedPages)) {
+        $(document.body).on('click', '.remove-text', function(e){
+          Marker.removeMarked(e.target);
+        });
+
+        $(document.body).bind('mouseup', function(e){
+          Marker.extractFragment();
+        });
+      }
+    });
+  }
+}

data/vendor/assets/javascripts/fragment-highlighter/libs/classes/HView.js

@@ -0,0 +1,68 @@
+class HView {
+
+  static isHModeOn(allowedPages) {
+    return (UserSettings.isHMode() && HView.isSupportedPage(allowedPages));
+  }
+
+  static isSupportedPage(allowedPages) {
+    let matcher = new RegExp("(" + allowedPages.join('|') + ")", "g");
+    return matcher.test(window.location.href)
+  }
+
+  static renderModeButton() {
+    // https://www.w3schools.com/howto/howto_css_sidenav_buttons.asp
+    $('body').prepend(`
+      <div id='highlightSidenav' class='sidenav'>
+        <a href='#' id='h-mode' onclick='HWindowCtrls.showHighlightWindow()'>
+          <span class="glyphicon glyphicon-pencil" aria-hidden="true"></span>
+        </a>
+      </div>`);
+  }
+
+  static initHighlightWindow() {
+    $('body').prepend(`
+      <div class="modal fade" id="highlightModal" tabindex="-1" role="dialog" aria-labelledby="highlightModalLabel" aria-hidden="true">
+      <div class="modal-dialog">
+        <div class="modal-content">
+          <div class="modal-header">
+            <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
+            <h4 class="modal-title" id="myModalLabel">Highlighted Articles</h4>
+          </div>
+          <div class="modal-body" id="marked-items-list">
+            ...
+          </div>
+          <div class="modal-footer">
+            <row>
+              <div class="col-md-8">
+                <div class="checkbox">
+                  <label><input type="checkbox" id="hmode_checkbox" value="" onclick="HWindowCtrls.turnOnHMode()"> TURN ON Highlighting Mode</label>
+                </div>
+              </div>
+              <div class="col-md-4">
+                <button type="button" class="btn btn-primary" onclick='HWindowCtrls.exportJSON()'>Export Settings</button>
+              </div>
+            </row>
+            <br>
+            <br>
+            <row>
+              <div class="col-md-12">
+                <form id="jsonFile" name="jsonFile" enctype="multipart/form-data" method="post">
+                  <fieldset>
+                    <label class="custom-file">
+                      <input type="file" id="fileinput" class="custom-file-input" required>
+                      <span class="custom-file-control"></span>
+                    </label>
+                    <input type='button' class="btn btn-success" id='btnLoad' value='Import Settings' onclick='HWindowCtrls.importJSON();'>
+                  </fieldset>
+                </form>
+              </div>
+            </row>
+          </div>
+          <a id="downloadAnchorElem" style="display:none"></a>
+        </div>
+      </div>
+    </div>`);
+
+    $('#highlightModal').modal({ show: false });
+  }
+}

data/vendor/assets/javascripts/fragment-highlighter/libs/classes/HWindowCtrls.js

@@ -0,0 +1,64 @@
+class HWindowCtrls {
+
+  static showHighlightWindow(){
+    $('#marked-items-list').html('');
+    let userSettings = LS.uSettings();
+    for (let key in userSettings.articles_titles) {
+      $('#marked-items-list').append(`<span><a href='${key}' target='_blank'>${userSettings.articles_titles[key]}</a>&nbsp<a href="#" onclick="HWindowCtrls.deleteFragments('${key}')">[Delete]</a></span><br>`);
+    };
+    $('input#hmode_checkbox')[0].checked = userSettings.settings.hmode_is_on;
+    $('#highlightModal').modal();
+  }
+
+  static exportJSON(){
+    let userSettings = LS.uSettings();
+    let dataStr = "data:text/json;charset=utf-8," + encodeURIComponent(JSON.stringify(userSettings));
+    let dlAnchorElem = document.getElementById('downloadAnchorElem');
+    dlAnchorElem.setAttribute("href",     dataStr     );
+    dlAnchorElem.setAttribute("download", "scene.json");
+    dlAnchorElem.click();
+  }
+
+  static importJSON(){
+    let input, file, fr;
+
+    if (typeof window.FileReader !== 'function') {
+      alert("The file API isn't supported on this browser yet.");
+      return;
+    }
+
+    input = document.getElementById('fileinput');
+    if (!input) {
+      alert("Um, couldn't find the fileinput element.");
+    }
+    else if (!input.files) {
+      alert("This browser doesn't seem to support the `files` property of file inputs.");
+    }
+    else if (!input.files[0]) {
+      alert("Please select a file before clicking 'Load'");
+    }
+    else {
+      file = input.files[0];
+      fr = new FileReader();
+      fr.onload = receivedText;
+      fr.readAsText(file);
+    }
+
+    function receivedText(e) {
+      LS.saveUSettings(JSON.parse(e.target.result));
+      Tools.reloadPage();
+    }
+  }
+
+  static turnOnHMode(){
+    let userSettings = LS.uSettings();
+    userSettings.settings.hmode_is_on = $('input#hmode_checkbox')[0].checked;
+    LS.saveUSettings(userSettings);
+    Tools.reloadPage();
+  }
+
+  static deleteFragments(url) {
+    UserSettings.deleteFragments(url);
+    Tools.reloadPage();
+  }
+}

data/vendor/assets/javascripts/fragment-highlighter/libs/classes/LS.js

@@ -0,0 +1,10 @@
+class LS { // LocalStorage
+
+  static uSettings() {
+    return JSON.parse(localStorage.getItem('userSettings'));
+  }
+
+  static saveUSettings(userSettings) {
+    localStorage.setItem('userSettings', JSON.stringify(userSettings));
+  }
+}

data/vendor/assets/javascripts/fragment-highlighter/libs/classes/Marker.js

@@ -0,0 +1,56 @@
+class Marker {
+
+  static removeMarked(element){
+    let textElement = $(element).prev();
+    UserSettings.removeFragment($(textElement).text());
+    $(textElement).removeClass('highlight-marked');
+    $(textElement).unmark();
+    $(element).remove();
+  }
+
+  static extractFragment(element){
+    let selection;
+
+    if (window.getSelection) {
+      selection = window.getSelection();
+    } else if (document.selection) {
+      selection = document.selection.createRange();
+    }
+
+    if (selection.toString() !== '') {
+      Marker.saveFragments(selection.toString());
+    }
+  }
+
+  static saveFragments(text){
+    let fragments = text.trim().split("\n\n");
+    fragments.forEach( fragment => {
+      if (fragment.length > 0) {
+        UserSettings.saveFragment(fragment);
+        Marker.highlight(fragment.trim());
+      }
+    });
+  }
+
+  static highlight(text){
+    $("body").mark(text, {
+      "className": "highlight-marked",
+      "caseSensitive": true,
+      "separateWordSearch": false,
+      "diacritics": false
+    });
+
+    let highlights = $(".highlight-marked");
+    if (highlights){
+      highlights.each((i, hl) => {
+        let next = $(hl).next();
+        if(next && $(next).attr('class') == 'remove-text'){
+        } else {
+          $('<span class="remove-text">[X]</span>').insertAfter(hl);
+        }
+      })
+    }
+    $(".highlight-marked").css('background-color', 'yellow');
+    $(".remove-text").css('background-color', 'gold');
+  }
+}

data/vendor/assets/javascripts/fragment-highlighter/libs/classes/Tools.js

@@ -0,0 +1,9 @@
+class Tools {
+  static href() {
+    return window.location.href.split('#')[0];
+  }
+
+  static reloadPage() {
+    location.reload();
+  }
+}

data/vendor/assets/javascripts/fragment-highlighter/libs/classes/UserSettings.js

@@ -0,0 +1,86 @@
+// userSettings format:
+// {
+//   articles: {
+//     'url': [
+//       {
+//         text: 'fragment'
+//       }
+//     ]
+//   },
+//   articles_titles: {
+//     'url': 'title'
+//   },
+//   settings: {
+//     hmode_is_on: true
+//   }
+// }
+
+class UserSettings {
+
+  static init() {
+    let userSettings = LS.uSettings();
+    if (!userSettings){
+    // if (true){ //for debug
+      let userSettings = {
+        articles: {},
+        articles_titles: {},
+        settings:{
+          hmode_is_on: true
+        }
+      };
+      LS.saveUSettings(userSettings);
+    } else {
+      let hModeOn = LS.uSettings().settings.hmode_is_on;
+      if(hModeOn){
+        let articleFragments = userSettings.articles[Tools.href()] || [];
+        articleFragments.forEach(fragment => {
+          Marker.highlight(fragment.text);
+        });
+      }
+    };
+  }
+
+  static isHMode() {
+    let mode;
+    try { mode = LS.uSettings().settings.hmode_is_on } catch(e) {};
+    return mode;
+  }
+
+  static isNotPresent(text){
+    let article = LS.uSettings().articles[Tools.href()];
+    return (article && article.findIndex(i => i.text.trim() === text.trim()) < 0);
+  }
+
+  static removeFragment(text){
+    let userSettings = LS.uSettings();
+    let articleFragments = userSettings.articles[Tools.href()] || [];
+    userSettings.articles[Tools.href()].forEach(((fragment, i) => {
+      if (fragment.text.trim() == text.trim()){
+        userSettings.articles[Tools.href()].splice(i, 1);
+        LS.saveUSettings(userSettings);
+        return;
+      }
+    }));
+  }
+
+  static saveFragment(text){
+    let userSettings = LS.uSettings();
+    userSettings.articles[Tools.href()] = userSettings.articles[Tools.href()] || [];
+    userSettings.articles_titles = userSettings.articles_titles || {};
+
+    if (UserSettings.isNotPresent(text)) {
+      userSettings.articles[Tools.href()].push({
+        text: text.trim()
+      });
+    }
+    userSettings.articles_titles[Tools.href()] = $('h1').text();
+    LS.saveUSettings(userSettings);
+  }
+
+  static deleteFragments(url) {
+    let userSettings = LS.uSettings();
+    delete userSettings.articles[url];
+    delete userSettings.articles_titles[url];
+    LS.saveUSettings(userSettings);
+  }
+}

data/vendor/assets/javascripts/fragment-highlighter/libs/jquery.mark.es6.min.js

@@ -0,0 +1,7 @@
+/*!***************************************************
+ * mark.js v8.11.0
+ * https://github.com/julmot/mark.js
+ * Copyright (c) 2014–2017, Julian Motz
+ * Released under the MIT license https://git.io/vwTVl
+ *****************************************************/
+"use strict";((factory,window,document)=>{if(typeof define==="function"&&define.amd){define(["jquery"],jQuery=>{return factory(window,document,jQuery);});}else if(typeof module==="object"&&module.exports){module.exports=factory(window,document,require("jquery"));}else{factory(window,document,jQuery);}})((window,document,$)=>{class Mark{constructor(ctx){this.ctx=ctx;this.ie=false;const ua=window.navigator.userAgent;if(ua.indexOf("MSIE")>-1||ua.indexOf("Trident")>-1){this.ie=true;}}set opt(val){this._opt=Object.assign({},{"element":"","className":"","exclude":[],"iframes":false,"iframesTimeout":5000,"separateWordSearch":true,"diacritics":true,"synonyms":{},"accuracy":"partially","acrossElements":false,"caseSensitive":false,"ignoreJoiners":false,"ignoreGroups":0,"ignorePunctuation":[],"wildcards":"disabled","each":()=>{},"noMatch":()=>{},"filter":()=>true,"done":()=>{},"debug":false,"log":window.console},val);}get opt(){return this._opt;}get iterator(){return new DOMIterator(this.ctx,this.opt.iframes,this.opt.exclude,this.opt.iframesTimeout);}log(msg,level="debug"){const log=this.opt.log;if(!this.opt.debug){return;}if(typeof log==="object"&&typeof log[level]==="function"){log[level](`mark.js: ${msg}`);}}escapeStr(str){return str.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g,"\\$&");}createRegExp(str){if(this.opt.wildcards!=="disabled"){str=this.setupWildcardsRegExp(str);}str=this.escapeStr(str);if(Object.keys(this.opt.synonyms).length){str=this.createSynonymsRegExp(str);}if(this.opt.ignoreJoiners||this.opt.ignorePunctuation.length){str=this.setupIgnoreJoinersRegExp(str);}if(this.opt.diacritics){str=this.createDiacriticsRegExp(str);}str=this.createMergedBlanksRegExp(str);if(this.opt.ignoreJoiners||this.opt.ignorePunctuation.length){str=this.createJoinersRegExp(str);}if(this.opt.wildcards!=="disabled"){str=this.createWildcardsRegExp(str);}str=this.createAccuracyRegExp(str);return str;}createSynonymsRegExp(str){const syn=this.opt.synonyms,sens=this.opt.caseSensitive?"":"i",joinerPlaceholder=this.opt.ignoreJoiners||this.opt.ignorePunctuation.length?"\u0000":"";for(let index in syn){if(syn.hasOwnProperty(index)){const value=syn[index],k1=this.opt.wildcards!=="disabled"?this.setupWildcardsRegExp(index):this.escapeStr(index),k2=this.opt.wildcards!=="disabled"?this.setupWildcardsRegExp(value):this.escapeStr(value);if(k1!==""&&k2!==""){str=str.replace(new RegExp(`(${k1}|${k2})`,`gm${sens}`),joinerPlaceholder+`(${this.processSynomyms(k1)}|`+`${this.processSynomyms(k2)})`+joinerPlaceholder);}}}return str;}processSynomyms(str){if(this.opt.ignoreJoiners||this.opt.ignorePunctuation.length){str=this.setupIgnoreJoinersRegExp(str);}return str;}setupWildcardsRegExp(str){str=str.replace(/(?:\\)*\?/g,val=>{return val.charAt(0)==="\\"?"?":"\u0001";});return str.replace(/(?:\\)*\*/g,val=>{return val.charAt(0)==="\\"?"*":"\u0002";});}createWildcardsRegExp(str){let spaces=this.opt.wildcards==="withSpaces";return str.replace(/\u0001/g,spaces?"[\\S\\s]?":"\\S?").replace(/\u0002/g,spaces?"[\\S\\s]*?":"\\S*");}setupIgnoreJoinersRegExp(str){return str.replace(/[^(|)\\]/g,(val,indx,original)=>{let nextChar=original.charAt(indx+1);if(/[(|)\\]/.test(nextChar)||nextChar===""){return val;}else{return val+"\u0000";}});}createJoinersRegExp(str){let joiner=[];const ignorePunctuation=this.opt.ignorePunctuation;if(Array.isArray(ignorePunctuation)&&ignorePunctuation.length){joiner.push(this.escapeStr(ignorePunctuation.join("")));}if(this.opt.ignoreJoiners){joiner.push("\\u00ad\\u200b\\u200c\\u200d");}return joiner.length?str.split(/\u0000+/).join(`[${joiner.join("")}]*`):str;}createDiacriticsRegExp(str){const sens=this.opt.caseSensitive?"":"i",dct=this.opt.caseSensitive?["aàáâãäåāąă","AÀÁÂÃÄÅĀĄĂ","cçćč","CÇĆČ","dđď","DĐĎ","eèéêëěēę","EÈÉÊËĚĒĘ","iìíîïī","IÌÍÎÏĪ","lł","LŁ","nñňń","NÑŇŃ","oòóôõöøō","OÒÓÔÕÖØŌ","rř","RŘ","sšśșş","SŠŚȘŞ","tťțţ","TŤȚŢ","uùúûüůū","UÙÚÛÜŮŪ","yÿý","YŸÝ","zžżź","ZŽŻŹ"]:["aàáâãäåāąăAÀÁÂÃÄÅĀĄĂ","cçćčCÇĆČ","dđďDĐĎ","eèéêëěēęEÈÉÊËĚĒĘ","iìíîïīIÌÍÎÏĪ","lłLŁ","nñňńNÑŇŃ","oòóôõöøōOÒÓÔÕÖØŌ","rřRŘ","sšśșşSŠŚȘŞ","tťțţTŤȚŢ","uùúûüůūUÙÚÛÜŮŪ","yÿýYŸÝ","zžżźZŽŻŹ"];let handled=[];str.split("").forEach(ch=>{dct.every(dct=>{if(dct.indexOf(ch)!==-1){if(handled.indexOf(dct)>-1){return false;}str=str.replace(new RegExp(`[${dct}]`,`gm${sens}`),`[${dct}]`);handled.push(dct);}return true;});});return str;}createMergedBlanksRegExp(str){return str.replace(/[\s]+/gmi,"[\\s]+");}createAccuracyRegExp(str){const chars=`!"#$%&'()*+,-./:;<=>?@[\\]^_\`{|}~¡¿`;let acc=this.opt.accuracy,val=typeof acc==="string"?acc:acc.value,ls=typeof acc==="string"?[]:acc.limiters,lsJoin="";ls.forEach(limiter=>{lsJoin+=`|${this.escapeStr(limiter)}`;});switch(val){case"partially":default:return`()(${str})`;case"complementary":lsJoin="\\s"+(lsJoin?lsJoin:this.escapeStr(chars));return`()([^${lsJoin}]*${str}[^${lsJoin}]*)`;case"exactly":return`(^|\\s${lsJoin})(${str})(?=$|\\s${lsJoin})`;}}getSeparatedKeywords(sv){let stack=[];sv.forEach(kw=>{if(!this.opt.separateWordSearch){if(kw.trim()&&stack.indexOf(kw)===-1){stack.push(kw);}}else{kw.split(" ").forEach(kwSplitted=>{if(kwSplitted.trim()&&stack.indexOf(kwSplitted)===-1){stack.push(kwSplitted);}});}});return{"keywords":stack.sort((a,b)=>{return b.length-a.length;}),"length":stack.length};}isNumeric(value){return Number(parseFloat(value))==value;}checkRanges(array){if(!Array.isArray(array)||Object.prototype.toString.call(array[0])!=="[object Object]"){this.log("markRanges() will only accept an array of objects");this.opt.noMatch(array);return[];}const stack=[];let last=0;array.sort((a,b)=>{return a.start-b.start;}).forEach(item=>{let{start,end,valid}=this.callNoMatchOnInvalidRanges(item,last);if(valid){item.start=start;item.length=end-start;stack.push(item);last=end;}});return stack;}callNoMatchOnInvalidRanges(range,last){let start,end,valid=false;if(range&&typeof range.start!=="undefined"){start=parseInt(range.start,10);end=start+parseInt(range.length,10);if(this.isNumeric(range.start)&&this.isNumeric(range.length)&&end-last>0&&end-start>0){valid=true;}else{this.log(`Ignoring invalid or overlapping range: `+`${JSON.stringify(range)}`);this.opt.noMatch(range);}}else{this.log(`Ignoring invalid range: ${JSON.stringify(range)}`);this.opt.noMatch(range);}return{start:start,end:end,valid:valid};}checkWhitespaceRanges(range,originalLength,string){let end,valid=true,max=string.length,offset=originalLength-max,start=parseInt(range.start,10)-offset;start=start>max?max:start;end=start+parseInt(range.length,10);if(end>max){end=max;this.log(`End range automatically set to the max value of ${max}`);}if(start<0||end-start<0||start>max||end>max){valid=false;this.log(`Invalid range: ${JSON.stringify(range)}`);this.opt.noMatch(range);}else if(string.substring(start,end).replace(/\s+/g,"")===""){valid=false;this.log("Skipping whitespace only range: "+JSON.stringify(range));this.opt.noMatch(range);}return{start:start,end:end,valid:valid};}getTextNodes(cb){let val="",nodes=[];this.iterator.forEachNode(NodeFilter.SHOW_TEXT,node=>{nodes.push({start:val.length,end:(val+=node.textContent).length,node});},node=>{if(this.matchesExclude(node.parentNode)){return NodeFilter.FILTER_REJECT;}else{return NodeFilter.FILTER_ACCEPT;}},()=>{cb({value:val,nodes:nodes});});}matchesExclude(el){return DOMIterator.matches(el,this.opt.exclude.concat(["script","style","title","head","html"]));}wrapRangeInTextNode(node,start,end){const hEl=!this.opt.element?"mark":this.opt.element,startNode=node.splitText(start),ret=startNode.splitText(end-start);let repl=document.createElement(hEl);repl.setAttribute("data-markjs","true");if(this.opt.className){repl.setAttribute("class",this.opt.className);}repl.textContent=startNode.textContent;startNode.parentNode.replaceChild(repl,startNode);return ret;}wrapRangeInMappedTextNode(dict,start,end,filterCb,eachCb){dict.nodes.every((n,i)=>{const sibl=dict.nodes[i+1];if(typeof sibl==="undefined"||sibl.start>start){if(!filterCb(n.node)){return false;}const s=start-n.start,e=(end>n.end?n.end:end)-n.start,startStr=dict.value.substr(0,n.start),endStr=dict.value.substr(e+n.start);n.node=this.wrapRangeInTextNode(n.node,s,e);dict.value=startStr+endStr;dict.nodes.forEach((k,j)=>{if(j>=i){if(dict.nodes[j].start>0&&j!==i){dict.nodes[j].start-=e;}dict.nodes[j].end-=e;}});end-=e;eachCb(n.node.previousSibling,n.start);if(end>n.end){start=n.end;}else{return false;}}return true;});}wrapMatches(regex,ignoreGroups,filterCb,eachCb,endCb){const matchIdx=ignoreGroups===0?0:ignoreGroups+1;this.getTextNodes(dict=>{dict.nodes.forEach(node=>{node=node.node;let match;while((match=regex.exec(node.textContent))!==null&&match[matchIdx]!==""){if(!filterCb(match[matchIdx],node)){continue;}let pos=match.index;if(matchIdx!==0){for(let i=1;i<matchIdx;i++){pos+=match[i].length;}}node=this.wrapRangeInTextNode(node,pos,pos+match[matchIdx].length);eachCb(node.previousSibling);regex.lastIndex=0;}});endCb();});}wrapMatchesAcrossElements(regex,ignoreGroups,filterCb,eachCb,endCb){const matchIdx=ignoreGroups===0?0:ignoreGroups+1;this.getTextNodes(dict=>{let match;while((match=regex.exec(dict.value))!==null&&match[matchIdx]!==""){let start=match.index;if(matchIdx!==0){for(let i=1;i<matchIdx;i++){start+=match[i].length;}}const end=start+match[matchIdx].length;this.wrapRangeInMappedTextNode(dict,start,end,node=>{return filterCb(match[matchIdx],node);},(node,lastIndex)=>{regex.lastIndex=lastIndex;eachCb(node);});}endCb();});}wrapRangeFromIndex(ranges,filterCb,eachCb,endCb){this.getTextNodes(dict=>{const originalLength=dict.value.length;ranges.forEach((range,counter)=>{let{start,end,valid}=this.checkWhitespaceRanges(range,originalLength,dict.value);if(valid){this.wrapRangeInMappedTextNode(dict,start,end,node=>{return filterCb(node,range,dict.value.substring(start,end),counter);},node=>{eachCb(node,range);});}});endCb();});}unwrapMatches(node){const parent=node.parentNode;let docFrag=document.createDocumentFragment();while(node.firstChild){docFrag.appendChild(node.removeChild(node.firstChild));}parent.replaceChild(docFrag,node);if(!this.ie){parent.normalize();}else{this.normalizeTextNode(parent);}}normalizeTextNode(node){if(!node){return;}if(node.nodeType===3){while(node.nextSibling&&node.nextSibling.nodeType===3){node.nodeValue+=node.nextSibling.nodeValue;node.parentNode.removeChild(node.nextSibling);}}else{this.normalizeTextNode(node.firstChild);}this.normalizeTextNode(node.nextSibling);}markRegExp(regexp,opt){this.opt=opt;this.log(`Searching with expression "${regexp}"`);let totalMatches=0,fn="wrapMatches";const eachCb=element=>{totalMatches++;this.opt.each(element);};if(this.opt.acrossElements){fn="wrapMatchesAcrossElements";}this[fn](regexp,this.opt.ignoreGroups,(match,node)=>{return this.opt.filter(node,match,totalMatches);},eachCb,()=>{if(totalMatches===0){this.opt.noMatch(regexp);}this.opt.done(totalMatches);});}mark(sv,opt){this.opt=opt;let totalMatches=0,fn="wrapMatches";const{keywords:kwArr,length:kwArrLen}=this.getSeparatedKeywords(typeof sv==="string"?[sv]:sv),sens=this.opt.caseSensitive?"":"i",handler=kw=>{let regex=new RegExp(this.createRegExp(kw),`gm${sens}`),matches=0;this.log(`Searching with expression "${regex}"`);this[fn](regex,1,(term,node)=>{return this.opt.filter(node,kw,totalMatches,matches);},element=>{matches++;totalMatches++;this.opt.each(element);},()=>{if(matches===0){this.opt.noMatch(kw);}if(kwArr[kwArrLen-1]===kw){this.opt.done(totalMatches);}else{handler(kwArr[kwArr.indexOf(kw)+1]);}});};if(this.opt.acrossElements){fn="wrapMatchesAcrossElements";}if(kwArrLen===0){this.opt.done(totalMatches);}else{handler(kwArr[0]);}}markRanges(rawRanges,opt){this.opt=opt;let totalMatches=0,ranges=this.checkRanges(rawRanges);if(ranges&&ranges.length){this.log("Starting to mark with the following ranges: "+JSON.stringify(ranges));this.wrapRangeFromIndex(ranges,(node,range,match,counter)=>{return this.opt.filter(node,range,match,counter);},(element,range)=>{totalMatches++;this.opt.each(element,range);},()=>{this.opt.done(totalMatches);});}else{this.opt.done(totalMatches);}}unmark(opt){this.opt=opt;let sel=this.opt.element?this.opt.element:"*";sel+="[data-markjs]";if(this.opt.className){sel+=`.${this.opt.className}`;}this.log(`Removal selector "${sel}"`);this.iterator.forEachNode(NodeFilter.SHOW_ELEMENT,node=>{this.unwrapMatches(node);},node=>{const matchesSel=DOMIterator.matches(node,sel),matchesExclude=this.matchesExclude(node);if(!matchesSel||matchesExclude){return NodeFilter.FILTER_REJECT;}else{return NodeFilter.FILTER_ACCEPT;}},this.opt.done);}}class DOMIterator{constructor(ctx,iframes=true,exclude=[],iframesTimeout=5000){this.ctx=ctx;this.iframes=iframes;this.exclude=exclude;this.iframesTimeout=iframesTimeout;}static matches(element,selector){const selectors=typeof selector==="string"?[selector]:selector,fn=element.matches||element.matchesSelector||element.msMatchesSelector||element.mozMatchesSelector||element.oMatchesSelector||element.webkitMatchesSelector;if(fn){let match=false;selectors.every(sel=>{if(fn.call(element,sel)){match=true;return false;}return true;});return match;}else{return false;}}getContexts(){let ctx,filteredCtx=[];if(typeof this.ctx==="undefined"||!this.ctx){ctx=[];}else if(NodeList.prototype.isPrototypeOf(this.ctx)){ctx=Array.prototype.slice.call(this.ctx);}else if(Array.isArray(this.ctx)){ctx=this.ctx;}else if(typeof this.ctx==="string"){ctx=Array.prototype.slice.call(document.querySelectorAll(this.ctx));}else{ctx=[this.ctx];}ctx.forEach(ctx=>{const isDescendant=filteredCtx.filter(contexts=>{return contexts.contains(ctx);}).length>0;if(filteredCtx.indexOf(ctx)===-1&&!isDescendant){filteredCtx.push(ctx);}});return filteredCtx;}getIframeContents(ifr,successFn,errorFn=()=>{}){let doc;try{const ifrWin=ifr.contentWindow;doc=ifrWin.document;if(!ifrWin||!doc){throw new Error("iframe inaccessible");}}catch(e){errorFn();}if(doc){successFn(doc);}}isIframeBlank(ifr){const bl="about:blank",src=ifr.getAttribute("src").trim(),href=ifr.contentWindow.location.href;return href===bl&&src!==bl&&src;}observeIframeLoad(ifr,successFn,errorFn){let called=false,tout=null;const listener=()=>{if(called){return;}called=true;clearTimeout(tout);try{if(!this.isIframeBlank(ifr)){ifr.removeEventListener("load",listener);this.getIframeContents(ifr,successFn,errorFn);}}catch(e){errorFn();}};ifr.addEventListener("load",listener);tout=setTimeout(listener,this.iframesTimeout);}onIframeReady(ifr,successFn,errorFn){try{if(ifr.contentWindow.document.readyState==="complete"){if(this.isIframeBlank(ifr)){this.observeIframeLoad(ifr,successFn,errorFn);}else{this.getIframeContents(ifr,successFn,errorFn);}}else{this.observeIframeLoad(ifr,successFn,errorFn);}}catch(e){errorFn();}}waitForIframes(ctx,done){let eachCalled=0;this.forEachIframe(ctx,()=>true,ifr=>{eachCalled++;this.waitForIframes(ifr.querySelector("html"),()=>{if(! --eachCalled){done();}});},handled=>{if(!handled){done();}});}forEachIframe(ctx,filter,each,end=()=>{}){let ifr=ctx.querySelectorAll("iframe"),open=ifr.length,handled=0;ifr=Array.prototype.slice.call(ifr);const checkEnd=()=>{if(--open<=0){end(handled);}};if(!open){checkEnd();}ifr.forEach(ifr=>{if(DOMIterator.matches(ifr,this.exclude)){checkEnd();}else{this.onIframeReady(ifr,con=>{if(filter(ifr)){handled++;each(con);}checkEnd();},checkEnd);}});}createIterator(ctx,whatToShow,filter){return document.createNodeIterator(ctx,whatToShow,filter,false);}createInstanceOnIframe(contents){return new DOMIterator(contents.querySelector("html"),this.iframes);}compareNodeIframe(node,prevNode,ifr){const compCurr=node.compareDocumentPosition(ifr),prev=Node.DOCUMENT_POSITION_PRECEDING;if(compCurr&prev){if(prevNode!==null){const compPrev=prevNode.compareDocumentPosition(ifr),after=Node.DOCUMENT_POSITION_FOLLOWING;if(compPrev&after){return true;}}else{return true;}}return false;}getIteratorNode(itr){const prevNode=itr.previousNode();let node;if(prevNode===null){node=itr.nextNode();}else{node=itr.nextNode()&&itr.nextNode();}return{prevNode,node};}checkIframeFilter(node,prevNode,currIfr,ifr){let key=false,handled=false;ifr.forEach((ifrDict,i)=>{if(ifrDict.val===currIfr){key=i;handled=ifrDict.handled;}});if(this.compareNodeIframe(node,prevNode,currIfr)){if(key===false&&!handled){ifr.push({val:currIfr,handled:true});}else if(key!==false&&!handled){ifr[key].handled=true;}return true;}if(key===false){ifr.push({val:currIfr,handled:false});}return false;}handleOpenIframes(ifr,whatToShow,eCb,fCb){ifr.forEach(ifrDict=>{if(!ifrDict.handled){this.getIframeContents(ifrDict.val,con=>{this.createInstanceOnIframe(con).forEachNode(whatToShow,eCb,fCb);});}});}iterateThroughNodes(whatToShow,ctx,eachCb,filterCb,doneCb){const itr=this.createIterator(ctx,whatToShow,filterCb);let ifr=[],elements=[],node,prevNode,retrieveNodes=()=>{({prevNode,node}=this.getIteratorNode(itr));return node;};while(retrieveNodes()){if(this.iframes){this.forEachIframe(ctx,currIfr=>{return this.checkIframeFilter(node,prevNode,currIfr,ifr);},con=>{this.createInstanceOnIframe(con).forEachNode(whatToShow,ifrNode=>elements.push(ifrNode),filterCb);});}elements.push(node);}elements.forEach(node=>{eachCb(node);});if(this.iframes){this.handleOpenIframes(ifr,whatToShow,eachCb,filterCb);}doneCb();}forEachNode(whatToShow,each,filter,done=()=>{}){const contexts=this.getContexts();let open=contexts.length;if(!open){done();}contexts.forEach(ctx=>{const ready=()=>{this.iterateThroughNodes(whatToShow,ctx,each,filter,()=>{if(--open<=0){done();}});};if(this.iframes){this.waitForIframes(ctx,ready);}else{ready();}});}}$.fn.mark=function(sv,opt){new Mark(this.get()).mark(sv,opt);return this;};$.fn.markRegExp=function(regexp,opt){new Mark(this.get()).markRegExp(regexp,opt);return this;};$.fn.markRanges=function(ranges,opt){new Mark(this.get()).markRanges(ranges,opt);return this;};$.fn.unmark=function(opt){new Mark(this.get()).unmark(opt);return this;};return $;},window,document);

data/vendor/assets/stylesheets/fragment-highlighter.css

@@ -0,0 +1,26 @@
+/* Style the links inside the sidenav */
+#highlightSidenav a {
+  position: fixed; /* Position them relative to the browser window */
+  left: -15px; /* Position them outside of the screen */
+  transition: 0.3s; /* Add transition on hover */
+  padding: 15px; /* 15px padding */
+  width: 50px; /* Set a specific width */
+  text-decoration: none; /* Remove underline */
+  font-size: 20px; /* Increase font size */
+  color: white; /* White text color */
+  border-radius: 0 5px 5px 0; /* Rounded corners on the top right and bottom right side */
+}
+
+#highlightSidenav a:hover {
+  left: 0; /* On mouse-over, make the elements appear as they should */
+}
+
+#highlightSidenav a, a:visited {
+  color: #D3D3D3 !important;
+}
+
+/* The about link: 20px from the top with a green background */
+#h-mode {
+  top: 50%;
+  background-color: #4CAF50;
+}

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: fragment_highlighter-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- PhlowerTeam
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: bootstrap-sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.5
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- phlowerteam@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fragment_highlighter-rails.gemspec
+- lib/fragment_highlighter/rails.rb
+- lib/fragment_highlighter/rails/version.rb
+- vendor/assets/javascripts/fragment-highlighter/fragment-highlighter.js
+- vendor/assets/javascripts/fragment-highlighter/libs/classes/HView.js
+- vendor/assets/javascripts/fragment-highlighter/libs/classes/HWindowCtrls.js
+- vendor/assets/javascripts/fragment-highlighter/libs/classes/LS.js
+- vendor/assets/javascripts/fragment-highlighter/libs/classes/Marker.js
+- vendor/assets/javascripts/fragment-highlighter/libs/classes/Tools.js
+- vendor/assets/javascripts/fragment-highlighter/libs/classes/UserSettings.js
+- vendor/assets/javascripts/fragment-highlighter/libs/jquery.mark.es6.min.js
+- vendor/assets/stylesheets/fragment-highlighter.css
+homepage: https://github.com/phlowerteam/fragment_highlighter-rails
+licenses: []
+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.13
+signing_key: 
+specification_version: 4
+summary: JavaScript UI library for highlighting text fragments on the page and saving
+  ones into localStorage
+test_files: []