acts_as_content_highlightable 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 822a2e7c824acd2e7baa520d0e89177cd7a42acb
-  data.tar.gz: 813948922091b765ca6dc68256db220a2c9fb8a9
+  metadata.gz: e9b3aed4076a41c98413e268a0d75338d354688d
+  data.tar.gz: 8d2549d2c07a4debbf75340fbe230a8e557190fc
 SHA512:
-  metadata.gz: 163b81598185735a3a6e22cf96384d91d36c4f75e495745a06cc3bef96daac9353ea9d3d354496b4e9a09b4346e049ff7497127567231b8c021b33960b34cdc4
-  data.tar.gz: 91b2ff6bedfbaccce63386eab06e6239d189f0fabfab4450a13b3d8ea9c8762ddfbfa8cf4134e0a5b17a4bfc05cb0ca8b4ee788064d64fb8446d353b20269bd9
+  metadata.gz: a9ae7c75565bb626c59e835b8e1f35e696045f785c331ab98f8da28d666fdef2980adf5673ddb2e4b9de1750586ea26ad25e99f39b30623eef45ef73ddf65043
+  data.tar.gz: 2b7df5e8250b997c20bb3ac07d0e2b711bdf3185a818b1c0509ce1b9331c4ea1fa24be0aa396efd04bc88220a9c549815a56ff4f42c9adfdb97387f69492756d

data/.gitignore

@@ -1,3 +1,4 @@
+*.DS_Store
 /.bundle/
 /.yardoc
 /Gemfile.lock

data/README.md

@@ -46,13 +46,13 @@ bundle exec rake db:migrate
 ```
 
 #### 3. Set your model as content_highlightable
-Add `acts_as_content_highlightable_on` to the model and choose the column that has the HTML content that you want to highlight.
+Add `acts_as_content_highlightable_on` to the model and choose the column (or columns) that has the HTML content that you want to highlight.
 
 ```
 Class Post < ApplicationRecord
-  validates :summary, :presence => true
-  acts_as_content_highlightable_on :summary
-  # summary is a column on Post model that stores HTML text content
+  validates :summary, :content, :presence => true
+  acts_as_content_highlightable_on [:summary, :content]
+  # summary and content are columns on Post model that stores HTML text content
 end
 ```
 
@@ -67,10 +67,36 @@ and this to your application.css file
 ```
 
 #### 5. Retroactively tag text nodes
-This gem creates a `before_save` callback to tag every html node in the content (e.g. `:summary`) with a data attribute `data-chnode="daed4c12"`. This is essential to save, persist and display highlights. To retroactively tag the nodes, use some variant of the following code
+This gem creates a `before_save` callback to tag every html node in the content (e.g. `:summary`) with a data attribute `data-chnode="<unique_random_hex>"`. This is essential to save, persist and display highlights. To retroactively tag the nodes, use some variant of the following code
 ```
 Post.all.each{|post| post.prepare_for_content_highlights && post.save}
 ```
+Please note that the data in your content column will be altered by this gem - it adds data attributes to text nodes of the html content. If your content is plain text, it will be converted into html text. See examples below
+```
+<!--Example 1 (plain text) -->
+Far far away, behind the word mountains, far from the countries Vokalia and Consonantia, there live the blind texts. Separated they live in Bookmarksgrove right at the coast of the Semantics, a large language ocean. A small river named Duden flows by their place and supplies it with the necessary regelialia. It is a paradisematic country, in which roasted parts of sentences fly into your mouth.
+
+<!--Example 2 (html text) -->
+<p>Far far away, behind the word mountains, far from the countries <em>Vokalia and Consonantia</em>, there live the blind texts. Separated they live in Bookmarksgrove right at the coast of the Semantics, a large language ocean.</p>
+<p>A small river named Duden flows by their place and supplies <b>it with the necessary <i>regelialia</i>. It is a paradisematic country, in which roasted parts of sentences fly into your mouth.</p>
+
+<!--Example 3 (already tagged html text) -->
+<p data-chnode="aba2519">Far far away, behind the word mountains, far from the countries <em data-chnode="c13d177">Vokalia and Consonantia</em>, there live the blind texts. Separated they live in Bookmarksgrove right at the coast of the Semantics, a large language ocean.</p>
+<p data-chnode="98dbae1">A small river named Duden flows by their place and supplies <b data-chnode="d1a2419">it with the necessary <i data-chnode="123ddb3">regelialia</i>. It is a paradisematic country, in which roasted parts of sentences fly into your mouth.</p>
+```
+becomes
+```
+<!--Example 1 (plain text - wrapped in <p> tag and added node identifier) -->
+<p data-chnode="d1a2419">Far far away, behind the word mountains, far from the countries Vokalia and Consonantia, there live the blind texts. Separated they live in Bookmarksgrove right at the coast of the Semantics, a large language ocean. A small river named Duden flows by their place and supplies it with the necessary regelialia. It is a paradisematic country, in which roasted parts of sentences fly into your mouth.</p>
+
+<!--Example 2 (html text - added node identifiers) -->
+<p data-chnode="aba2519">Far far away, behind the word mountains, far from the countries <em data-chnode="c13d177">Vokalia and Consonantia</em>, there live the blind texts. Separated they live in Bookmarksgrove right at the coast of the Semantics, a large language ocean.</p>
+<p data-chnode="98dbae1">A small river named Duden flows by their place and supplies <b data-chnode="d1a2419">it with the necessary <i data-chnode="123ddb3">regelialia</i>. It is a paradisematic country, in which roasted parts of sentences fly into your mouth.</p>
+
+<!--Example 3 (already tagged html text - node identifiers preserved)-->
+<p data-chnode="aba2519">Far far away, behind the word mountains, far from the countries <em data-chnode="c13d177">Vokalia and Consonantia</em>, there live the blind texts. Separated they live in Bookmarksgrove right at the coast of the Semantics, a large language ocean.</p>
+<p data-chnode="98dbae1">A small river named Duden flows by their place and supplies <b data-chnode="d1a2419">it with the necessary <i data-chnode="123ddb3">regelialia</i>. It is a paradisematic country, in which roasted parts of sentences fly into your mouth.</p>
+```
 
 #### 6. Invoke the Content Highlighter in your view
 Here is a sample posts/show view
@@ -85,6 +111,7 @@ Here is a sample posts/show view
       nodeIdentifierKey: "<%=ActsAsContentHighlightable.unique_html_node_identifier_key%>",
       highlightableType: "Post",
       highlightableId: "1",
+      highlightableColumn: "summary", // required if your model has more than 1 highlightable column
       readOnly: false
     });
     worker.init();
@@ -101,10 +128,16 @@ Use the `ContentHighlight#highlights_to_show` method to selectively show certain
 #### 2. Enrich Highlights
 `ContentHighlight#enrich_highlights` lets us modify the `description`, set permissions to remove `can_cancel`, and change css classes to distinguish the user's vs others' highlights `lifetime_class_ends`
 
-#### 3. Custom Styling
+#### 3. Set Add/remove permissions
+`ContentHighlight#can_add_highlights?(highlightable, user)` and `content_highlight#can_remove_highlight?(user)` lets us set permissions to add/remove highlights based on the user, highlightable etc.
+
+#### 4. Custom Node identifier Key
+`ActsAsContentHighlightable.unique_html_node_identifier_key = 'somekey'` shall be initialized in the rails app, preferably in the `config/initializers/acts_as_content_highlightable.rb`. This will let us use a node identifier key. The default is `chnode`, and nodes will be tagged `data-chnode`. Note that changing this will render your earlier node tags useless, and you might have to re tag all the text nodes with the new key.
+
+#### 5. Custom Styling
 Check out [content_highlight.css](./vendor/assets/stylesheets/content_highlight.css)
 
-#### 4. More Javascript options
+#### 6. More Javascript options
 `highlightableType` and `highlightableId` are required. Highlights can be set `readOnly` - no addition or removal. You may never need more but check out the [content_highlight.js](./vendor/assets/javascripts/content_highlight.js) file for more configuration options.
 
 ## Development

data/app/controller/acts_as_content_highlightable/content_highlights_controller.rb

@@ -2,12 +2,13 @@ module ActsAsContentHighlightable
   class ContentHighlightsController < ApplicationController
     before_action :set_highlighter_user
     before_action :get_highlightable
+    before_action :set_highlightable_column, :only => [:add]
 
     def add
-      if @highlightable.present?
+      if @highlightable.present? and (ContentHighlight.respond_to?(:can_add_highlights?) ? ContentHighlight.can_add_highlights?(@highlightable, @highlighter_user) : true)
         content_highlight = @highlightable.content_highlights.new({
           :user => @highlighter_user,
-          :highlightable_column => @highlightable.highlightable_column,
+          :highlightable_column => @highlightable_column,
           :content => params[:content],
           :container_node_identifier_key => params[:common_ancestor_identifier_key],
           :container_node_identifier => params[:common_ancestor_identifier],
@@ -26,7 +27,7 @@ module ActsAsContentHighlightable
 
     def remove
       content_highlight = @highlightable.content_highlights.where(:id => params[:content_highlight_id]).first
-      if content_highlight.present? and (content_highlight.user == @highlighter_user)
+      if content_highlight.present? and (content_highlight.respond_to?(:can_remove_highlight?) ? content_highlight.can_remove_highlight?(@highlighter_user) : (content_highlight.user == @highlighter_user))
         remove_highlights = @highlightable.content_highlights.where(:id => content_highlight.id).enrich_highlights(@highlighter_user).as_json
         content_highlight.destroy
       else
@@ -36,10 +37,27 @@ module ActsAsContentHighlightable
     end
 
     private
+
+    def set_highlightable_column
+      if params[:highlightable_column].blank? and @highlightable.highlightable_columns.size > 1
+        raise ArgumentError.new("More than one highlightable column found. Please provide highlightable_column in your parameters")
+      elsif params[:highlightable_column].blank?
+        @highlightable_column = @highlightable.highlightable_columns.first.to_s
+      else
+        @highlightable_column = params[:highlightable_column].to_s
+      end
+      if not @highlightable.respond_to?(:highlightable_columns)
+        raise ArgumentError.new("Highlightable column not found. Please check the parameter: highlightable_column")
+      end
+      if not @highlightable.highlightable_columns.include? @highlightable_column
+        raise ArgumentError.new("Invalid Highlightable column")
+      end
+    end
+
     def get_highlightable
       highlightable_model = params[:highlightable_type].to_s.constantize
       @highlightable = highlightable_model.respond_to?(:find_by_id) && highlightable_model.find_by_id(params[:highlightable_id])
-      @highlightable = nil unless @highlightable.respond_to?(:highlightable_column)
+      @highlightable = nil unless @highlightable.respond_to?(:highlightable_columns)
     end
 
     def set_highlighter_user

data/changelog.md

@@ -0,0 +1,11 @@
+# v 0.2.0
+(July, 10, 2017)
+
+* Supports multiple content_highlightable columns per model
+  ```
+  acts_as_content_highlightable_on [:summary, :content]
+  ```
+* Added ActsAsContentHighlightabl.extract_text_from_html(text) method
+  - can be used to extract text from HTML content.
+* Extract `can_remove_highlight?(user)` method from controller to ContentHighlight model
+  - Can customize removal permissions - better than just checking (highlight.user == current_user)

data/lib/acts_as_content_highlightable.rb

@@ -13,6 +13,11 @@ module ActsAsContentHighlightable
   mattr_accessor :mount
   self.mount = true
 
+  def self.extract_text_from_html(text)
+    return nil unless text.is_a? String
+    return ActsAsContentHighlightable::HtmlNodeParser.new(text).body_text
+  end
+
   ActiveSupport.on_load(:active_record) do
     extend ActsAsContentHighlightable::Model
   end

data/lib/acts_as_content_highlightable/html_node_parser.rb

@@ -17,6 +17,10 @@ class ActsAsContentHighlightable::HtmlNodeParser
     return @parsed.css('body').inner_html
   end
 
+  def body_text
+    return @parsed.text
+  end
+
   private
 
   def apply_unique_identifiers_to_children(node, attribute_name)

data/lib/acts_as_content_highlightable/model.rb

@@ -1,21 +1,24 @@
 module ActsAsContentHighlightable
   module Model
-    def acts_as_content_highlightable_on(column_name)
-      if not self.column_names.include? column_name.to_s
-        raise ArgumentError, "acts_as_content_highlightable_on: Invalid attribute #{column_name}"
+    def acts_as_content_highlightable_on(column_names)
+      column_names = [column_names].flatten
+      if not column_names.all? {|column_name| self.column_names.include? column_name.to_s}
+        raise ArgumentError, "acts_as_content_highlightable_on: One or more invalid attribute #{column_names}"
       end
 
       class_eval do
         has_many :content_highlights, :as => :highlightable
+        before_save :prepare_for_content_highlights, :if => column_names.map{|column_name| "#{column_name}_changed?"}
       end
 
       class_eval %{
-        before_save :prepare_for_content_highlights, :if => :#{column_name.to_s}_changed?
-        def highlightable_column
-          return "#{column_name.to_s}"
+        def highlightable_columns
+          return #{column_names.map(&:to_s)}
         end
         def prepare_for_content_highlights
-          self.#{column_name.to_s} = ActsAsContentHighlightable::HtmlNodeParser.new(self.#{column_name.to_s}).assign_unique_node_identifiers("data-" + ActsAsContentHighlightable.unique_html_node_identifier_key).body_content
+          #{column_names}.each do |column_name|
+            self[column_name.to_sym] = ActsAsContentHighlightable::HtmlNodeParser.new(self[column_name.to_sym]).assign_unique_node_identifiers("data-" + ActsAsContentHighlightable.unique_html_node_identifier_key).body_content
+          end
         end
       }
     end

data/lib/acts_as_content_highlightable/version.rb

@@ -1,3 +1,3 @@
 module ActsAsContentHighlightable
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/generators/acts_as_content_highlightable/templates/active_record_content_highlight_model.rb

@@ -14,6 +14,17 @@ class ContentHighlight < ActiveRecord::Base
     highlightable.content_highlights
   end
 
+  # Set Add Permissions here
+  def self.can_add_highlights?(highlightable, user)
+    return true # e.g. highlightable.can_highlight?(user)
+  end
+
+  # Set remove permissions here
+  def can_remove_highlight?(user)
+    return (self.user == user)
+  end
+
+
   # This method is used to show details on the poptips with permissions to remove highlights
   def self.enrich_highlights(user)
     ContentHighlight.joins(:user)

data/vendor/assets/javascripts/content_highlight.js

@@ -40,6 +40,7 @@ var contentHighlightWorker = function(element, options){
   this.settings = {
     highlightableType: options.highlightableType || "",
     highlightableId: options.highlightableId || "",
+    highlightableColumn: options.highlightableColumn || "",
     readOnly: options.readOnly || false,
     nodeIdentifierKey: options.nodeIdentifierKey || "chnode",
     highlightClass: options.highlightClass || "content-highlight",
@@ -52,7 +53,7 @@ var contentHighlightWorker = function(element, options){
     removeFromServerPath: options.removeFromServerPath || element.dataset.removehighlightspath || "/content_highlights/remove?",
   }
 
-  this.sendToServerParams = "highlightable_type=" + this.settings.highlightableType + "&highlightable_id=" + this.settings.highlightableId;
+  this.sendToServerParams = "highlightable_type=" + this.settings.highlightableType + "&highlightable_id=" + this.settings.highlightableId + "&highlightable_column=" + this.settings.highlightableColumn;
 
   if(!rangy || !rangy.getSelection){
     return;

data/vendor/assets/stylesheets/content_highlight.css

@@ -25,7 +25,7 @@
 }
 .content-highlight-poptip .description{
   font-size: 100%;
-  line-height: 100%;
+  line-height: 140%;
   display: block;
   white-space: nowrap;
   overflow: hidden;

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_content_highlightable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Karthik Ravichandran
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-05 00:00:00.000000000 Z
+date: 2017-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -100,6 +100,7 @@ files:
 - app/controller/acts_as_content_highlightable/content_highlights_controller.rb
 - bin/console
 - bin/setup
+- changelog.md
 - config/routes.rb
 - lib/acts_as_content_highlightable.rb
 - lib/acts_as_content_highlightable/engine.rb