editmode 1.1.4 → 1.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d4e7090d2da1935453260320513e82439c6815295621646a1ebdc7378895abe
-  data.tar.gz: 8e96d36c0c479a4ebd89c4efb74896270c3cbae9ea75353adf491e00fdd51943
+  metadata.gz: fbdfaaca69c2832debd4fb728c6684b48abe8e9337cbaa8f4323a20cf175cf77
+  data.tar.gz: 51841cadd3a89aea58a0089b9e7c541a286f9da46fa2d7db0f32e9d7a07797ed
 SHA512:
-  metadata.gz: 28475295b70e1e65c3472f74d0b3ee4a5765bb52727843dc478c1239f9fd09fe399d43fd0db2c63814e14623f5f225344aea474421e3c73ff6feba3ec84123e6
-  data.tar.gz: d3d787c71c390a115b9470c06f2e48cdd5089fb7a788dc03e862d6090453b0a41a75a41812297b4a66dddae77b86a59e7415a8145245a0edebd72740c79ae1df
+  metadata.gz: 9966ac6b514c9c237db8e2e1f77613431a365f2c4259565422892b9abdd749a2c294575bfd0e1242d9ac682a5340b940bacde295560fa1845e93ddd03ef500f1
+  data.tar.gz: fee7262f68522bb8e4f76d0de9f9da8c267c2a311105e89c72d7989408d46f124f6bbbf4170d712c0544aa4453b17f2837525c93f47da9afae2a729a0a2c47a5

data/README.md

@@ -1,20 +1,127 @@
+<p align="center">
+  <img src="https://editmode.s3-eu-west-1.amazonaws.com/static/editmode-full-navy-bg-transparent.png" width="260" />
+</p>
+<br />
 
-# Editmode Rails Gem
+# EditMode for Rails
 
-To be completed
+Editmode is a smarter way to manage copy and other content in your rails app. It's syntax is similar to i18n, but it's built for copy updates, not internationalization (yet). It's built around the idea of moving your content out of your codebase.
 
 ## Installation
 
-## How It Works
-- Autoload editmode.js
-- Expose view helper
+#### 1. Add the gem to your Gemfile:
+```ruby
+gem 'editmode'
+```
+And run `bundle install`.
+
+#### 2. Create an initializer with your project_id
+
+<small>Don't have a project id? Sign up for one [here](https://editmode.com/rails?s=ghreadme)</small>
+
+```sh
+  rails generate editmode:config YOUR-PROJECT-ID
+```
+This command produces an initializer file 
+```ruby
+# config/initializers/editmode.rb
+Editmode.setup do |config|
+  config.project_id={project_id}
+end
+```
+
+That's it, you're all set up. By default Editmode will now include editmode.js in every page of your rails application, unless you disable auto-include.
+<hr/>
+
+## Rendering Content
+
+Editmode provides helper methods for use in your rails views and controllers.
+
+### Render the content of a chunk
+```erb
+<%= e('cnk_x4ts............') %> # Using a chunk identifier
+<%= e('marketing_page_headline') %> # Using a content key 
+```
+
+### Render an *Editable* chunk. Wait, [what?](https://editmode.com/rails) 
+```erb
+<%= E('cnk_x4ts............') %> # Using a chunk identifier
+<%= E('marketing_page_headline') %> # Using a content key
+```
+
+### Content can also be accessed in Controllers
+```ruby
+@page_title = e("cnk_x4ts............")  # Using a chunk identifier
+@page_title = e("marketing_page_seo_title") # Using a content key
+```
+
+### Directly get the value of a custom field
+This works when a chunk is part of a collection.
+```ruby
+@email_subject = e("welcome_email","Subject")
+@email_content = e("welcome_email","Content")
+```
+
+### Working with variables
+```ruby
+variable_values = { first_name: "Dexter", last_name: "Morgan"}
+
+# Assume chunk content is "Hi {{first_name}} {{last_name}}"
+
+# Single Chunk with Variables
+e("cnk_d36415052285997e079b", variables: variable_values)
+
+# Collection Field with Variables
+e("cnk_16e04a02d577afb610ce", "Email Content", variables: variable_values)
+
+# Response: "Hi Dexter Morgan"
+```
+
+### 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>
+<% end %>
+```
+
+|Parameter|Type|Description|
+|---|---|---|
+| identifier | string | The first argument of `c` takes the id of the collection you want to loop through |
+| limit | int/string |`optional` The number of collection items you want to display  |
+| tags | array |`optional` Filter collection items based on tags listed in this parameter  |
+| class | string | `optional` Class name(s) that will be added along with "chunks-collection-wrapper" to the main collection `<div>` element |
+| item_class | string | `optional` Class name(s) that will be added along with "chunks-collection-item--wrapper" to all collection items |
 
-## Helper methods
-- chunk_display
-- raw_chunk
-- chunk_list (coming soon)
 
 ## Caching
-- All chunks cached by default using Rails.cache
-- GET /editmode/clear_cache?identifier={} to clear cache
+In order to keep your application speedy, Editmode minimizes the amount of network calls it makes by caching content where it can. 
+
+#### What's cached
+- Any embedded content returned by the `e`, `E`, `f`, or `F` view helpers.
+
+#### Expiring the cache
+
+The editmode gem exposes a cache expiration endpoint in your application at `/editmode/clear_cache`.
+
+1. GET `/editmode/clear_cache?identifier={chunk_id}` clears the cache for a specific chunk.
+2. GET `/editmode/clear_cache?full=1` clears the full Editmode cache.
+
+- Editmode.js will automatically hit this endpoint when you update a chunk through your frontend.
+- You can configure cache expiration webhooks in Editmode.com to ensure your application is notified when content changes happen on Editmode.com
+
+The cache expiration endpoint is currently **not** authenticated.
+
+## Disabling editmode.js auto-include
+
+To disable automatic insertion for a particular controller or action you can:
+```ruby
+ skip_after_action :editmode_auto_include
+```
 

data/lib/editmode.rb

@@ -36,7 +36,7 @@ module Editmode
       begin
         Editmode::ChunkValue.new(identifier, **options )
       rescue => er
-        raise er
+        puts er
       end
     end
   end

data/lib/editmode/action_view_extensions/editmode_helper.rb

@@ -19,6 +19,9 @@ module Editmode
         branch_id = params[:em_branch_id].presence
         tags = options[:tags].presence || []
         limit = options[:limit].presence
+
+        parent_class = options[:class] || ""
+        item_class = options[:item_class] || ""
         
         begin 
           url_params = { 
@@ -49,12 +52,22 @@ module Editmode
             end
 
             if chunks.any?
-              content_tag :div, class: "chunks-collection-wrapper", data: {chunk_collection_identifier: collection_identifier} do
+              content_tag :div, class: "chunks-collection-wrapper #{parent_class}", data: {chunk_collection_identifier: collection_identifier} do
                 chunks.each do |chunk|
                   @custom_field_chunk = chunk
-                  yield
+                  concat(content_tag(:div, class: "chunks-collection-item--wrapper #{item_class}") do
+                    yield
+                  end)
                 end
-              end
+
+                # Placeholder element for new collection item
+                @custom_field_chunk = chunks.first.merge!({placeholder: true})
+                concat(content_tag(:div, class: "chunks-hide chunks-col-placeholder-wrapper") do
+                  yield
+                end)
+              end 
+            else
+              content_tag(:span, "&nbsp".html_safe)
             end
           end
         rescue => error
@@ -67,14 +80,23 @@ 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 {|f| f["custom_field_identifier"] == custom_field_identifier || f["custom_field_name"] == custom_field_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
+
+          options[:field] = custom_field_identifier
           
+          if parent_chunk_object[:placeholder]
+            custom_field_item["identifier"] = ""
+            custom_field_item["content"] = ""
+          end
+
           if custom_field_item.present?
             render_chunk_content(
               custom_field_item["identifier"],
               custom_field_item["content"],
               custom_field_item["chunk_type"],
-              { parent_identifier: chunk_identifier }.merge(options)
+              { parent_identifier: chunk_identifier, custom_field_identifier:  custom_field_identifier}.merge(options)
             )
           end
         rescue => errors
@@ -88,6 +110,7 @@ module Editmode
         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]
 
@@ -99,9 +122,8 @@ module Editmode
 
           chunk_data = { :chunk => chunk_identifier, :chunk_editable => false, :chunk_type => chunk_type }
 
-          if options[:parent_identifier].present?
-            chunk_data.merge!({parent_identifier: options[:parent_identifier]})
-          end
+          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?
 
           case display_type
           when "span"
@@ -115,6 +137,7 @@ module Editmode
               end
             end
           when "image"
+            chunk_content = chunk_content.blank? || chunk_content == "/images/original/missing.png" ? 'https://www.editmode.com/upload.png' : chunk_content
             image_tag(chunk_content, :data => chunk_data, :class => css_class) 
           end
         rescue => errors
@@ -132,10 +155,11 @@ module Editmode
         # prevent the page from loading.
         begin
           branch_params = branch_id.present? ? "branch_id=#{branch_id}" : ""
-          cache_identifier = "chunk_#{identifier}#{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
@@ -144,15 +168,30 @@ module Editmode
           if !cached_content_present && !response_received
             raise "No response received"
           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  
-              response['content']
+              content.presence || response["content"]
             end
 
             chunk_type = Rails.cache.fetch("#{cache_identifier}_type") do  
-              response['chunk_type']
+              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)
 
           end
@@ -168,18 +207,23 @@ module Editmode
       alias_method :chunk, :chunk_display
 
 
-      def render_custom_field(label, options={})
-        chunk_field_value(@custom_field_chunk, label, options)
+      def render_custom_field(field_name, options={})
+        options[:variable_fallbacks] = @custom_field_chunk["variable_fallbacks"] || {}
+        options[:variable_values] = options[:variables] || {}
+        
+        chunk_field_value(@custom_field_chunk, field_name, options)
       end
       alias_method :F, :render_custom_field
 
-      def render_chunk(identifier, options = {}, &block)
+      def render_chunk(identifier, *args, &block)
+        field, options = parse_arguments(args)
+        options[:field] = field
         chunk_display('label', identifier, options, &block)
       end
       alias_method :E, :render_chunk
 
 
-      def variable_parse!(content, variables, values)
+      def variable_parse!(content, variables = {}, values = {})
         tokens = content.scan(/\{{(.*?)\}}/)
         if tokens.any?
           tokens.flatten! 

data/lib/editmode/chunk_value.rb

@@ -3,9 +3,9 @@ module Editmode
     include Editmode::ActionViewExtensions::EditmodeHelper
 
     attr_accessor :identifier, :variable_values, :branch_id, 
-                  :variable_fallbacks, :chunk_type, :project_id, 
+                  :variable_fallbacks, :chunk_type, :project_id,
                   :response
-
+                  
     attr_writer :content
 
     def initialize(identifier, **options)
@@ -31,18 +31,26 @@ module Editmode
           raise require_field_id
         end
       else
-        raise NoMethodError.new "undefined method 'field` for chunk_type: #{chunk_type} \n"
+        raise "undefined method 'field` for chunk_type: #{chunk_type} \n"
       end
       result || @content
     end
 
     def content
-      raise NoMethodError.new "undefined method 'content` for chunk_type: collection_item \nDid you mean? field" if chunk_type == 'collection_item'
+      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)
     end
 
     private
+
+    def json?(json)
+      JSON.parse(json)
+      return true
+    rescue JSON::ParserError => e
+      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}"
@@ -58,16 +66,16 @@ module Editmode
       if !cached_content_present && !response_received
         raise no_response_received(identifier)
       else
-        @response = Rails.cache.fetch(cache_identifier) do
-          http_response
+        cached_response = Rails.cache.fetch(cache_identifier) do
+          http_response.to_json
         end
 
+        @response = json?(cached_response) ? JSON.parse(cached_response) : cached_response
+
         @content = response['content']
         @chunk_type = response['chunk_type']
         @project_id = response['project_id']
-        @variable_fallbacks = Rails.cache.fetch("chunk_#{project_id}_variables") do
-          response['variable_fallbacks']
-        end
+        @variable_fallbacks = response['variable_fallbacks']
       end      
     end
 

data/lib/editmode/helper.rb

@@ -12,7 +12,7 @@ module Editmode
           chunk.content
         end 
       rescue => er
-        raise er
+        puts er
       end
     end
 

data/lib/editmode/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: editmode
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.9
 platform: ruby
 authors:
 - Tony Ennis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-04 00:00:00.000000000 Z
+date: 2020-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler