editmode 1.1.9 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbdfaaca69c2832debd4fb728c6684b48abe8e9337cbaa8f4323a20cf175cf77
-  data.tar.gz: 51841cadd3a89aea58a0089b9e7c541a286f9da46fa2d7db0f32e9d7a07797ed
+  metadata.gz: bd467da504ef11a5ba029cc7dcf3b4957dbbc758fa37fe8cf38f2aed358fb17b
+  data.tar.gz: 577f1989ff49f7c624fd2d1864cc78c6bd0f3249e7c67951bf6b94e375794744
 SHA512:
-  metadata.gz: 9966ac6b514c9c237db8e2e1f77613431a365f2c4259565422892b9abdd749a2c294575bfd0e1242d9ac682a5340b940bacde295560fa1845e93ddd03ef500f1
-  data.tar.gz: fee7262f68522bb8e4f76d0de9f9da8c267c2a311105e89c72d7989408d46f124f6bbbf4170d712c0544aa4453b17f2837525c93f47da9afae2a729a0a2c47a5
+  metadata.gz: 5466ebc92b03dde2acc135dd0e90ff54c2b18242a0eb5011889ff429fd5c168f9ec09b7181be3df8d8a864f78911a49b620b0ed239a3aec9330e4d3fb9b3a3f7
+  data.tar.gz: bd302d21b044b4927e787f5aaacc530bae2a811f5e72138519b6b2b5cc594dc6322ec9fa026a1fa256d5d65a26ee79877d0256e547a11ad6589197482d0e5fb1

data/README.md

@@ -47,6 +47,7 @@ Editmode provides helper methods for use in your rails views and controllers.
 ```erb
 <%= E('cnk_x4ts............') %> # Using a chunk identifier
 <%= E('marketing_page_headline') %> # Using a content key
+<%= E('cnk_x4ts...', class: "a-css-class") %> # Render a chunk with inline css class 
 ```
 
 ### Content can also be accessed in Controllers
@@ -79,15 +80,13 @@ e("cnk_16e04a02d577afb610ce", "Email Content", variables: variable_values)
 
 ### Use collections for repeatable content
 ```erb
-<%= c('col_j8fbs...') do |chunk| %>
-  <div class="user-profile">
-    <h3 class="name">
-      <%= F("Name") %>
-    </h3>
-    <p class="description">
-      <%= f("Description") %>
-    </p>
-  </div>
+<%= c('col_j8fbs...', class: "profiles-container", item_class: "profile-item") do %>
+  <h3 class="name">
+    <%= F("Name", class: "profile-name") %>
+  </h3>
+  <p class="description">
+    <%= f("Description"), class: "profile-description" %>
+  </p>
 <% end %>
 ```
 

data/app/controllers/editmode_controller.rb

@@ -13,8 +13,7 @@ class EditmodeController < ApplicationController
       Rails.cache.delete("chunk_#{project_id}_variables")
       render status: 200, json: {:response => "success"}
     elsif params[:identifier]
-      Rails.cache.delete("chunk_#{params[:identifier]}")
-      Rails.cache.delete("chunk_#{params[:identifier]}_type")
+      Rails.cache.delete_matched("#{params[:identifier]}")
       render status: 200, json: {:response => "success"}
     else
       render status: 404, json: {:response => "no identifier specified"}

data/lib/editmode/action_view_extensions/editmode_helper.rb

@@ -80,9 +80,8 @@ module Editmode
       def chunk_field_value(parent_chunk_object, custom_field_identifier, options = {})
         begin 
           chunk_identifier = parent_chunk_object["identifier"]
-          custom_field_item = parent_chunk_object["content"].detect do |f|
-            f["custom_field_identifier"].try(:downcase) == custom_field_identifier.try(:downcase)  || f["custom_field_name"].try(:downcase)  == custom_field_identifier.try(:downcase)
-          end
+          chunk_value = Editmode::ChunkValue.new(parent_chunk_object["identifier"], options.merge({response: parent_chunk_object}))
+          custom_field_item = chunk_value.field_chunk(custom_field_identifier)
 
           options[:field] = custom_field_identifier
           
@@ -94,7 +93,7 @@ module Editmode
           if custom_field_item.present?
             render_chunk_content(
               custom_field_item["identifier"],
-              custom_field_item["content"],
+              chunk_value.field(custom_field_identifier),
               custom_field_item["chunk_type"],
               { parent_identifier: chunk_identifier, custom_field_identifier:  custom_field_identifier}.merge(options)
             )
@@ -106,13 +105,9 @@ module Editmode
       end
 
       def render_chunk_content(chunk_identifier, chunk_content, chunk_type,options = {})
-
         begin 
-          # Always sanitize the content!!
-          chunk_content = ActionController::Base.helpers.sanitize(chunk_content) unless chunk_type == 'rich_text'
-          chunk_content = variable_parse!(chunk_content, options[:variable_fallbacks], options[:variable_values])
-
           css_class = options[:class]
+          cache_id = options[:cache_identifier]
 
           if chunk_type == "image"
             display_type = "image"
@@ -124,6 +119,9 @@ module Editmode
 
           chunk_data.merge!({parent_identifier: options[:parent_identifier]}) if options[:parent_identifier].present?
           chunk_data.merge!({custom_field_identifier: options[:custom_field_identifier]}) if options[:custom_field_identifier].present?
+          chunk_data.merge!({chunk_cache_id: cache_id}) if cache_id.present?
+          chunk_data.merge!({chunk_collection_identifier: options[:collection_id]}) if options[:collection_id].present?
+          chunk_data.merge!({chunk_content_key: options[:content_key]}) if options[:content_key].present?
 
           case display_type
           when "span"
@@ -133,7 +131,7 @@ module Editmode
               end
             else
               content_tag("em-span", :class => css_class, :data => chunk_data.merge!({:chunk_editable => true}) ) do
-                chunk_content
+                chunk_content.html_safe
               end
             end
           when "image"
@@ -148,54 +146,31 @@ module Editmode
       end
 
       def chunk_display(label, identifier, options = {}, &block)
-        branch_id = params[:em_branch_id]
+        options[:branch_id] = params[:em_branch_id] if params[:em_branch_id].present?
         # This method should never show an error. 
         # If anything goes wrong fetching content
         # We should just show blank content, not
         # prevent the page from loading.
         begin
-          branch_params = branch_id.present? ? "branch_id=#{branch_id}" : ""
           field = options[:field].presence || ""          
-          cache_identifier = "chunk_#{identifier}#{branch_id}#{field}"
-          url = "#{api_root_url}/chunks/#{identifier}?project_id=#{Editmode.project_id}&#{branch_params}"
-          cached_content_present = Rails.cache.exist?(cache_identifier)
-          
-          if !cached_content_present
-            response = HTTParty.get(url)
-            response_received = true if response.code == 200
-          end
 
-          if !cached_content_present && !response_received
-            raise "No response received"
+          chunk_value = Editmode::ChunkValue.new(identifier, options)
+          
+          if field.present? && chunk_value.chunk_type == 'collection_item'
+            chunk_content = chunk_value.field(field)
+            identifier = chunk_value.field_chunk(field)["identifier"]
+            chunk_type = chunk_value.field_chunk(field)["chunk_type"]
+            options[:collection_id] = chunk_value.collection_id
           else
-            if field.present? && response.present?
-              field_content = response["content"].detect {|f| f["custom_field_identifier"].downcase == field.downcase || f["custom_field_name"].downcase == field.downcase }
-              if field_content
-                content = field_content["content"]
-                type = field_content["chunk_type"]
-                identifier = field_content["identifier"]
-              end
-            end
-
-            variable_fallbacks = Rails.cache.fetch("#{cache_identifier}_variables") do
-              response['variable_fallbacks'].presence || {}
-            end
-
-            chunk_content = Rails.cache.fetch(cache_identifier) do  
-              content.presence || response["content"]
-            end
-
-            chunk_type = Rails.cache.fetch("#{cache_identifier}_type") do  
-              type.presence || response['chunk_type']
-            end
-
-            options[:variable_fallbacks] = variable_fallbacks
-            options[:variable_values] = options[:variables].presence || {}
-            
-            render_chunk_content(identifier,chunk_content,chunk_type, options)
-
+            chunk_content = chunk_value.content
+            chunk_type = chunk_value.chunk_type
+            identifier = chunk_value.response["identifier"] unless identifier.include? "cnk_"
           end
 
+          options[:cache_identifier] = chunk_value.identifier
+          options[:content_key] = chunk_value.response.try(:[], "content_key")
+          render_chunk_content(identifier, chunk_content, chunk_type, options)
+
         rescue => error
           # Show fallback content by default
           return content_tag("em-span", &block) if block_given?
@@ -222,22 +197,6 @@ module Editmode
       end
       alias_method :E, :render_chunk
 
-
-      def variable_parse!(content, variables = {}, values = {})
-        tokens = content.scan(/\{{(.*?)\}}/)
-        if tokens.any?
-          tokens.flatten! 
-          tokens.each do |token|
-            token_value = values[token.to_sym] || variables[token] || ""
-            sanitized_value = ActionController::Base.helpers.sanitize(token_value)
-
-            content.gsub!("{{#{token}}}", sanitized_value)
-          end
-        end
-
-        content
-      end
-
       def no_response_received(id = "")
         "Sorry, we can't find a chunk using this identifier: \"#{id}\". This can happen if you've deleted a chunk on editmode.com or if your local cache is out of date. If it persists, try running Rails.cache clear."
       end

data/lib/editmode/chunk_value.rb

@@ -1,29 +1,42 @@
 module Editmode
   class ChunkValue
-    include Editmode::ActionViewExtensions::EditmodeHelper
+    include ActionView::Helpers::TagHelper
+    include ActionView::Context
+
+    attr_accessor :identifier, :variable_values, :branch_id,
+      :variable_fallbacks, :chunk_type, :project_id,
+      :url, :collection_id, :cache_identifier,
+      :response
 
-    attr_accessor :identifier, :variable_values, :branch_id, 
-                  :variable_fallbacks, :chunk_type, :project_id,
-                  :response
-                  
     attr_writer :content
 
     def initialize(identifier, **options)
       @identifier = identifier
       @branch_id = options[:branch_id].presence
+      @project_id = Editmode.project_id
       @variable_values = options[:variables].presence || {}
-      get_content
+      @raw = options[:raw].present?
+      @skip_sanitize = options[:dangerously_skip_sanitization]
+
+      @url = "#{api_root_url}/chunks/#{identifier}"
+      @cache_identifier = set_cache_identifier(identifier)
+
+      if options[:response].present?
+        @response = options[:response]
+        set_response_attributes!
+      else
+        get_content
+      end
     end
 
     def field(field = nil)
       # Field ID can be a slug or field_name
       if chunk_type == 'collection_item'
         if field.present?
-          field.downcase!
-          field_content = @content.detect {|f| f["custom_field_identifier"].downcase == field || f["custom_field_name"].downcase == field }
-          if field_content.present?
-            result = field_content['content']
-            result = variable_parse!(result, variable_fallbacks, variable_values)
+          field_chunk = field_chunk(field)
+          if field_chunk.present?
+            result = field_chunk['content']
+            result = variable_parse!(result, variable_fallbacks, variable_values, @raw, @skip_sanitize)
           else
             raise no_response_received(field)
           end
@@ -33,17 +46,33 @@ module Editmode
       else
         raise "undefined method 'field` for chunk_type: #{chunk_type} \n"
       end
-      result || @content
+      result ||= @content
+      result.try(:html_safe)
+    end
+
+    def field_chunk(field)
+      field.downcase!
+      @content.detect {|f| f["custom_field_identifier"].downcase == field || f["custom_field_name"].downcase == field }
     end
 
     def content
-      raise "undefined method 'content` for chunk_type: collection_item \nDid you mean? field" if chunk_type == 'collection_item'
-      
-      variable_parse!(@content, variable_fallbacks, variable_values)
+      raise "undefined method 'content' for chunk_type: collection_item \nDid you mean? field" if chunk_type == 'collection_item'
+
+      result = variable_parse!(@content, variable_fallbacks, variable_values, @raw, @skip_sanitize)
+      result.try(:html_safe)
     end
 
     private
 
+    # Todo: Transfer to helper utils
+    def api_root_url
+      ENV["EDITMODE_OVERRIDE_API_URL"] || "https://api.editmode.com"
+    end
+
+    def set_cache_identifier(id)
+      "chunk_#{project_id}#{branch_id}#{id}"
+    end
+
     def json?(json)
       JSON.parse(json)
       return true
@@ -51,19 +80,46 @@ module Editmode
       return false
     end
 
-    def get_content
-      branch_params = branch_id.present? ? "branch_id=#{branch_id}" : ""
-      url = "#{api_root_url}/chunks/#{identifier}?project_id=#{Editmode.project_id}&#{branch_params}"
+    def variable_parse!(content, variables = {}, values = {}, raw = true, skip_sanitize=false)
+      content = ActionController::Base.helpers.sanitize(content) unless skip_sanitize
+      tokens = content.scan(/\{{(.*?)\}}/)
+      if tokens.any?
+        tokens.flatten!
+        tokens.each do |token|
+          token_value = values[token.to_sym] || variables[token] || ""
+          sanitized_value = ActionController::Base.helpers.sanitize(token_value)
 
-      cache_identifier = "chunk_value_#{identifier}#{branch_id}"
-      cached_content_present = Rails.cache.exist?(cache_identifier)
+          unless raw
+            sanitized_value = content_tag("em-var", :data => {chunk_variable: token, chunk_variable_value: sanitized_value}) do
+              sanitized_value
+            end
+          end
 
-      if !cached_content_present
-        http_response = HTTParty.get(url)
+          content.gsub!("{{#{token}}}", sanitized_value)
+        end
+      end
+
+      content
+    end
+
+    def cached?
+      Rails.cache.exist?(cache_identifier)
+    end
+
+    def query_params
+      the_params = { 'project_id' => project_id }
+      the_params['branch_id'] = branch_id if branch_id.present?
+
+      the_params
+    end
+
+    def get_content
+      if !cached?
+        http_response = HTTParty.get(url, query: query_params)
         response_received = true if http_response.code == 200
       end
 
-      if !cached_content_present && !response_received
+      if !cached? && !response_received
         raise no_response_received(identifier)
       else
         cached_response = Rails.cache.fetch(cache_identifier) do
@@ -71,13 +127,17 @@ module Editmode
         end
 
         @response = json?(cached_response) ? JSON.parse(cached_response) : cached_response
+        set_response_attributes!
+      end
+    end
 
-        @content = response['content']
-        @chunk_type = response['chunk_type']
-        @project_id = response['project_id']
-        @variable_fallbacks = response['variable_fallbacks']
-      end      
+    def set_response_attributes!
+      @content = response['content']
+      @chunk_type = response['chunk_type']
+      @variable_fallbacks = response['variable_fallbacks'].presence || {}
+      @collection_id = response["collection"]["identifier"] if chunk_type == 'collection_item'
+      @branch_id = response['branch_id']
     end
 
   end
-end
+end

data/lib/editmode/helper.rb

@@ -4,8 +4,8 @@ module Editmode
     def e(identifier, *args)
       field, options = parse_arguments(args)
       begin
-        chunk = Editmode::ChunkValue.new(identifier, options)
-        
+        chunk = Editmode::ChunkValue.new(identifier, options.merge({raw: true}))
+
         if chunk.chunk_type == 'collection_item'
           chunk.field(field)
         else
@@ -17,7 +17,7 @@ module Editmode
     end
 
     def render_custom_field_raw(label, options={})
-      e(@custom_field_chunk["identifier"], label, options)
+      e(@custom_field_chunk["identifier"], label, options.merge({response: @custom_field_chunk}))
     end
     alias_method :f, :render_custom_field_raw
 

data/lib/editmode/version.rb

@@ -1,3 +1,3 @@
 module Editmode
-  VERSION = "1.1.9"
+  VERSION = "1.2.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: editmode
 version: !ruby/object:Gem::Version
-  version: 1.1.9
+  version: 1.2.4
 platform: ruby
 authors:
 - Tony Ennis
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-07 00:00:00.000000000 Z
+date: 2020-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,7 +94,7 @@ homepage: https://github.com/tonyennis145/editmode-rails
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -109,8 +109,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: Editmode allows you to turn plain text in your rails app into easily inline-editable
   bits of content that can be managed by anyone with no technical knowledge