fragment_highlighter-rails 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6408468fafdf63427c816205dd38a1215f48f4e
-  data.tar.gz: b461fe69e5f315729de0fcedde65a5a36fd38eb3
+  metadata.gz: 9d9a7be38d90a133feec79f9637fbd148af04fae
+  data.tar.gz: 0fe0f8c6c1230fb857263c777929c65284833b7c
 SHA512:
-  metadata.gz: b75f5574ec1c03e52cb652eee80b8d1e6d5274139d9f18d1dbb5d573945d421e6be293365729c71dcf1b4b19dfef92c12bfaea5a8fea7c861de231dca35ff9a1
-  data.tar.gz: 74e581c62c117065ad72acdfc4a4d7c34fd2119fa81d0a561b6ea53f202fefd07fb34d9ebd7377379364f8f910ca322b43e71c1f3ac63c7a8a47d247a49c74ca
+  metadata.gz: 05569411be52b5fdcd383d7e96410e77fa6fda458bbf61fff77c3c1a70bca23fadec1ca846b1a1f767ee30cb75839f84ae914e699c1581fb63198bf2d3cecf20
+  data.tar.gz: 6cf45a9727541c1178ad965749bdc27beab221e71bb639363f9f6e74858aa7916287bac5798f276cc27eb9475fda31ee555bf28a6fcbe817abdaa2a2244aeaff

data/README.md

@@ -32,10 +32,13 @@ Or install it yourself as:
     //= require fragment-highlighter/fragment-highlighter.js
 
     $(function() {
-      let allowedPages = ['/articles/'];
-      new FragmentHighlighter(allowedPages);
+      let options = { allowedPages: ['/articles/'], deniedPages: ['/admin/'] };
+      new FragmentHighlighter(options);
     });
+## Video Presentation
+[![Watch the video](https://img.youtube.com/vi/sHj-CwYDRhU/0.jpg
+)](https://www.youtube.com/watch?v=sHj-CwYDRhU)
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/fragment_highlighter-rails.
+Bug reports and pull requests are welcome on GitHub at https://github.com/phlowerteam/fragment_highlighter-rails.

data/lib/fragment_highlighter/rails/version.rb

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

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

@@ -5,31 +5,38 @@
 //= require fragment-highlighter/libs/classes/Marker.js
 //= require fragment-highlighter/libs/classes/Tools.js
 //= require fragment-highlighter/libs/classes/UserSettings.js
+//= require fragment-highlighter/libs/classes/I18.js
 
 class FragmentHighlighter {
 
-  constructor(pages) {
-    FragmentHighlighter.init(pages);
+  constructor(options) {
+    FragmentHighlighter.init(options);
   }
 
-  static init(allowedPages) {
+  static init(options) {
     $(function(){
-      if (HView.isSupportedPage(allowedPages)) {
+      if (FragmentHighlighter.isEnabled(options)) {
         HView.renderModeButton();
-      }
 
-      HView.initHighlightWindow();
-      UserSettings.init();
+        HView.initHighlightWindow();
+        UserSettings.init();
 
-      if (HView.isHModeOn(allowedPages)) {
-        $(document.body).on('click', '.remove-text', function(e){
-          Marker.removeMarked(e.target);
-        });
+        if (UserSettings.isHMode()) {
+          $(document.body).on('click', '.remove-text', function(e){
+            Marker.removeMarked(e.target);
+          });
 
-        $(document.body).bind('mouseup', function(e){
-          Marker.extractFragment();
-        });
+          $(document.body).bind('mouseup', function(e){
+            Marker.extractFragment();
+          });
+        }
       }
     });
   }
+
+  static isEnabled(options) {
+    let allowedMatcher = new RegExp("(" + options.allowedPages.join('|') + ")", "g");
+    let deniedMatcher = new RegExp("(" + options.deniedPages.join('|') + ")", "g");
+    return (allowedMatcher.test(window.location.href) && !deniedMatcher.test(window.location.href));
+  }
 }

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

@@ -1,14 +1,5 @@
 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(`
@@ -26,7 +17,7 @@ class HView {
         <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>
+            <h4 class="modal-title" id="myModalLabel">${I18.tr(I18j.highlighted_fragments)}</h4>
           </div>
           <div class="modal-body" id="marked-items-list">
             ...
@@ -34,12 +25,18 @@ class HView {
           <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>
+                <label class="radio-inline">
+                  <input id="hmode_off_radio_btn" type="radio" name="optradio" onclick="HWindowCtrls.turnOffHMode()">${I18.tr(I18j.turn_off_hmode)}
+                </label>
+                <label class="radio-inline">
+                  <input id="hmode_on_radio_btn" type="radio" name="optradio" onclick="HWindowCtrls.turnOnHMode()">${I18.tr(I18j.turn_on_hmode)}
+                </label>
+                <label class="radio-inline">
+                  <input id="hmode_reading_radio_btn" type="radio" name="optradio"  onclick="HWindowCtrls.turnOnReadingHMode()">${I18.tr(I18j.turn_on_reading_hmode)}
+                </label>
               </div>
               <div class="col-md-4">
-                <button type="button" class="btn btn-primary" onclick='HWindowCtrls.exportJSON()'>Export Settings</button>
+                <button type="button" class="btn btn-primary" onclick='HWindowCtrls.exportJSON()'>${I18.tr(I18j.export_settings)}</button>
               </div>
             </row>
             <br>
@@ -52,7 +49,7 @@ class HView {
                       <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();'>
+                    <input type='button' class="btn btn-success" id='btnLoad' value='${I18.tr(I18j.import_settings)}' onclick='HWindowCtrls.importJSON();'>
                   </fieldset>
                 </form>
               </div>

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

@@ -4,9 +4,18 @@ class HWindowCtrls {
     $('#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>`);
+      $('#marked-items-list').append(`<span><a href='${key}' target='_blank'>${userSettings.articles_titles[key]}</a>&nbsp<a href="#" onclick="HWindowCtrls.deleteFragments('${key}')">[${I18.tr(I18j.remove)}]</a></span><br>`);
     };
-    $('input#hmode_checkbox')[0].checked = userSettings.settings.hmode_is_on;
+
+    if (userSettings.settings.hmode_is_on) {
+      $('input#hmode_on_radio_btn')[0].checked = true;
+    } else {
+      if (userSettings.settings.hmode_reading_is_on) {
+        $('input#hmode_reading_radio_btn')[0].checked = true;
+      } else {
+        $('input#hmode_off_radio_btn')[0].checked = true;
+      }
+    }
     $('#highlightModal').modal();
   }
 
@@ -15,7 +24,7 @@ class HWindowCtrls {
     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.setAttribute("download", "settings.json");
     dlAnchorElem.click();
   }
 
@@ -23,19 +32,19 @@ class HWindowCtrls {
     let input, file, fr;
 
     if (typeof window.FileReader !== 'function') {
-      alert("The file API isn't supported on this browser yet.");
+      alert(I18.tr(I18j.import.not_supported_api));
       return;
     }
 
     input = document.getElementById('fileinput');
     if (!input) {
-      alert("Um, couldn't find the fileinput element.");
+      alert(I18.tr(I18j.import.not_find));
     }
     else if (!input.files) {
-      alert("This browser doesn't seem to support the `files` property of file inputs.");
+      alert(I18.tr(I18j.import.not_supported_files));
     }
     else if (!input.files[0]) {
-      alert("Please select a file before clicking 'Load'");
+      alert(I18.tr(I18j.import.please_select));
     }
     else {
       file = input.files[0];
@@ -52,7 +61,24 @@ class HWindowCtrls {
 
   static turnOnHMode(){
     let userSettings = LS.uSettings();
-    userSettings.settings.hmode_is_on = $('input#hmode_checkbox')[0].checked;
+    userSettings.settings.hmode_is_on = true;
+    userSettings.settings.hmode_reading_is_on = false;
+    LS.saveUSettings(userSettings);
+    Tools.reloadPage();
+  }
+
+  static turnOffHMode(){
+    let userSettings = LS.uSettings();
+    userSettings.settings.hmode_is_on = false;
+    userSettings.settings.hmode_reading_is_on = false;
+    LS.saveUSettings(userSettings);
+    Tools.reloadPage();
+  }
+
+  static turnOnReadingHMode(){
+    let userSettings = LS.uSettings();
+    userSettings.settings.hmode_is_on = false;
+    userSettings.settings.hmode_reading_is_on = true;
     LS.saveUSettings(userSettings);
     Tools.reloadPage();
   }

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

@@ -0,0 +1,75 @@
+const I18j = {
+  highlighted_fragments: {
+    uk: 'Нотатки',
+    ru: 'Нотатки',
+    en: 'Notes'
+  },
+  remove: {
+    uk: 'Видалити',
+    ru: 'Удалить',
+    en: 'Remove'
+  },
+  turn_off_hmode: {
+    uk: 'Відключити',
+    ru: 'Отключить',
+    en: 'Turn off'
+  },
+  turn_on_hmode: {
+    uk: '"Нотатки"',
+    ru: '"Нотатки"',
+    en: '"Highlighting"'
+  },
+  turn_on_reading_hmode: {
+    uk: '"Читання"',
+    ru: '"Чтение"',
+    en: '"Reading" mode'
+  },
+  import_settings: {
+    uk: 'Імпортувати',
+    ru: 'Импортировать',
+    en: 'Import settings'
+  },
+  export_settings: {
+    uk: 'Експорт',
+    ru: 'Экспорт',
+    en: 'Export settings'
+  },
+  import: {
+    not_supported_api: {
+      uk: "Підтримка файлів поки що не підтримується в цьому браузері.",
+      ru: "Поддержка файлов пока что не поддерживается в этом браузере.",
+      en: "The file API isn't supported on this browser yet."
+    },
+    not_find: {
+      uk: "Нажаль не знайдено файлового елементу.",
+      ru: "К сожалению не найдено файлового элемента.",
+      en: "Um, couldn't find the fileinput element."
+    },
+    not_supported_files: {
+      uk: "Цей браузер здається не підтримує елементи.",
+      ru: "Этот браузер похоже не поддерживает элементы 'files'.",
+      en: "This browser doesn't seem to support the 'files' property of file inputs."
+    },
+    please_select: {
+      uk: "Будь-ласка оберіть файл перед завантаженням.",
+      ru: "Пожалуйста выберете файл перед загрузкой.",
+      en: "Please select a file before clicking 'Load'."
+    }
+  }
+}
+
+class I18 {
+
+  static tr(translation) {
+    return translation[I18.locale()];
+  }
+
+  static locale() {
+    let currentLocale = window.location.href.split('/')[3];
+    if (currentLocale == 'uk' || currentLocale == 'ru') {
+      return  currentLocale;
+    } else {
+      return 'en';
+    }
+  }
+}

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

@@ -17,13 +17,13 @@ class Marker {
       selection = document.selection.createRange();
     }
 
-    if (selection.toString() !== '') {
+    if (selection.toString().length > 2) {
       Marker.saveFragments(selection.toString());
     }
   }
 
   static saveFragments(text){
-    let fragments = text.trim().split("\n\n");
+    let fragments = text.trim().split("\n");
     fragments.forEach( fragment => {
       if (fragment.length > 0) {
         UserSettings.saveFragment(fragment);

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

@@ -25,24 +25,30 @@ class UserSettings {
         articles: {},
         articles_titles: {},
         settings:{
-          hmode_is_on: true
+          hmode_is_on: true,
+          hmode_reading_is_on: false
         }
       };
       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);
-        });
-      }
-    };
+    }
+
+    if(UserSettings.isHMode() || UserSettings.isHModeReading()){
+      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) {};
+    try { mode = (LS.uSettings().settings.hmode_is_on && !LS.uSettings().settings.hmode_reading_is_on) } catch(e) {};
+    return mode;
+  }
+
+  static isHModeReading() {
+    let mode;
+    try { mode = LS.uSettings().settings.hmode_reading_is_on } catch(e) {};
     return mode;
   }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fragment_highlighter-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - PhlowerTeam
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-09 00:00:00.000000000 Z
+date: 2017-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,6 +86,7 @@ files:
 - 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/I18.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
@@ -111,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: JavaScript UI library for highlighting text fragments on the page and saving