editmode 1.1.0 → 1.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f95b98f49a419090f8745a3cf5cfb96d2cafb889c22268f759b07ca5fbb326d1
-  data.tar.gz: 61e6d4f6acf151d875d990e5b223009deefd1407c7fbad3799793ba703ffde17
+  metadata.gz: 834e252dd5d068562b8541a091e972404d759a2ae8cf9d80bedf33bdca22c167
+  data.tar.gz: bd7d10b6264e1ddca7e219587a7c08956b3a3ff8b1636ff18c6afc0aa70f8cfa
 SHA512:
-  metadata.gz: adcdff8c0127b8ca33ee6fc735d2aaa05b9c009570d0e62f726d1cb08ea42e78b53f89bd825deda483da66423b9870b5b278b79acf24df7f5af533cb0d0bda0f
-  data.tar.gz: 6c530fe95532b300ac069797078133a931f8c5fc6873e42fee1656bcee5bca6ab43f39424eac982ef9f7e0c05e470a95b7b1a070ba8807f153dc1df6b5078899
+  metadata.gz: d87b5770f58dbc06f88bece3d32f966c3ba211b537c4a3050fe72513875016cdd3898c0aeb213136595a29b5be0987d9d34bd6189d967403301c8ef7999fc2b1
+  data.tar.gz: 793c609415a18dc4ff89f08037754b470356fe0f6cb5edf5dc680cbb8e3f934f56bd9cbd1c540112e382f1a93e6e0f798c1e21a17658f386addc0e9fe06d3f24

data/README.md

@@ -1,20 +1,125 @@
+<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 |`optional` The number of collection items you want to display  |
+| tags | array |`optional` Filter collection items based on tags listed in this parameter  |
 
-## 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/app/controllers/editmode_controller.rb

@@ -4,6 +4,10 @@ class EditmodeController < ApplicationController
     if params[:full]
       Rails.cache.clear
       render status: 200, json: {:response => "success"}
+    elsif params[:collection]
+      cache_id = "collection_#{params[:identifier]}"
+      Rails.cache.delete_matched("#{cache_id}*")
+      render status: 200, json: {:response => "success"}
     elsif params[:variable_cache_project_id]
       project_id = params[:variable_cache_project_id]
       Rails.cache.delete("chunk_#{project_id}_variables")

data/lib/editmode.rb

@@ -10,6 +10,7 @@ require 'editmode/engine' if defined?(Rails)
 module Editmode
   class << self
     include Editmode::ActionViewExtensions::EditmodeHelper
+    include Editmode::Helper
 
     def project_id=(id)
       config.project_id = id

data/lib/editmode/action_view_extensions/editmode_helper.rb

@@ -1,8 +1,10 @@
+require 'editmode/helper'
+
 module Editmode
   module ActionViewExtensions
     module EditmodeHelper
-
       require 'httparty'
+      include Editmode::Helper
 
       def api_version
         # Todo Add Header Version
@@ -12,12 +14,12 @@ module Editmode
         ENV["EDITMODE_OVERRIDE_API_URL"] || "https://api.editmode.com"
       end
 
-      def chunk_collection(collection_identifier, **options)
+      def chunk_collection(collection_identifier, **options, &block)
         branch_params = params[:em_branch_id].present? ? "branch_id=#{params[:em_branch_id]}" : ""
         branch_id = params[:em_branch_id].presence
         tags = options[:tags].presence || []
         limit = options[:limit].presence
-
+        
         begin 
           url_params = { 
             :collection_identifier => collection_identifier,
@@ -30,24 +32,47 @@ module Editmode
           url.path = '/chunks'
           url.query = url_params
 
-          response = HTTParty.get(url)
+          cache_identifier = "collection_#{collection_identifier}#{branch_id}#{limit}#{tags.join}"
+          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"
+          else
 
-          raise "No response received" unless response.code == 200
-          chunks = response["chunks"]
+            chunks = Rails.cache.fetch(cache_identifier) do  
+              response['chunks']
+            end
 
-          return chunks
+            if chunks.any?
+              content_tag :div, class: "chunks-collection-wrapper", data: {chunk_collection_identifier: collection_identifier} do
+                chunks.each do |chunk|
+                  @custom_field_chunk = chunk
+                  yield
+                end
+              end
+            end
+          end
         rescue => error
           puts error 
           return []
         end
       end
+      alias_method :c, :chunk_collection
 
-      def chunk_field_value(parent_chunk_object, custom_field_identifier,options={})
-
+      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 }
-        
+          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 custom_field_item.present?
             render_chunk_content(
               custom_field_item["identifier"],
@@ -60,14 +85,14 @@ module Editmode
           puts errors
           content_tag(:span, "&nbsp".html_safe) 
         end
-      
       end
 
-      def render_chunk_content(chunk_identifier,chunk_content,chunk_type,options={})
+      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]
 
@@ -82,7 +107,8 @@ module Editmode
           if options[:parent_identifier].present?
             chunk_data.merge!({parent_identifier: options[:parent_identifier]})
           end
-
+          
+          
           case display_type
           when "span"
             if chunk_type == "rich_text"
@@ -104,7 +130,7 @@ module Editmode
 
       end
 
-      def chunk_display(label,identifier,options={},&block)
+      def chunk_display(label, identifier, options = {}, &block)
         branch_id = params[:em_branch_id]
         # This method should never show an error. 
         # If anything goes wrong fetching content
@@ -112,10 +138,11 @@ module Editmode
         # prevent the page from loading.
         begin
           branch_params = branch_id.present? ? "branch_id=#{branch_id}" : ""
-          cache_identifier = "chunk_#{identifier}#{branch_id}"
-          url = "#{api_root_url}/chunks/#{identifier}?#{branch_params}"
+          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
@@ -124,15 +151,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]
+            
             render_chunk_content(identifier,chunk_content,chunk_type, options)
 
           end
@@ -144,12 +186,27 @@ module Editmode
           # maintain layout
           content_tag("em-span", "&nbsp".html_safe) 
         end
+      end
+      alias_method :chunk, :chunk_display
+
 
+      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, *args, &block)
+        field, options = parse_arguments(args)
+        options[:field] = field
+        chunk_display('label', identifier, options, &block)
+      end
+      alias_method :E, :render_chunk
 
-      alias_method :chunk, :chunk_display
 
-      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,15 +3,15 @@ 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)
       @identifier = identifier
       @branch_id = options[:branch_id].presence
-      @variable_values = options[:values].presence || {}
+      @variable_values = options[:variables].presence || {}
       get_content
     end
 
@@ -20,7 +20,7 @@ module Editmode
       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 }
+          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)
@@ -33,7 +33,7 @@ module Editmode
       else
         raise NoMethodError.new "undefined method 'field` for chunk_type: #{chunk_type} \n"
       end
-      result ||= content
+      result || @content
     end
 
     def content
@@ -43,9 +43,17 @@ module Editmode
     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}?#{branch_params}"
+      url = "#{api_root_url}/chunks/#{identifier}?project_id=#{Editmode.project_id}&#{branch_params}"
 
       cache_identifier = "chunk_value_#{identifier}#{branch_id}"
       cached_content_present = Rails.cache.exist?(cache_identifier)
@@ -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/engine.rb

@@ -1,8 +1,10 @@
-module Editmode
+require 'editmode/chunk_value'
+require 'editmode/helper'
 
+module Editmode
   class Engine < Rails::Engine
-
-  
+    ActionController::Base.class_eval do
+      include Editmode::Helper
+    end
   end
-
 end

data/lib/editmode/helper.rb

@@ -0,0 +1,36 @@
+module Editmode
+  module Helper
+    # Render non-editable content
+    def e(identifier, *args)
+      field, options = parse_arguments(args)
+      begin
+        chunk = Editmode::ChunkValue.new(identifier, options)
+        
+        if chunk.chunk_type == 'collection_item'
+          chunk.field(field)
+        else
+          chunk.content
+        end 
+      rescue => er
+        raise er
+      end
+    end
+
+    def render_custom_field_raw(label, options={})
+      e(@custom_field_chunk["identifier"], label, options)
+    end
+    alias_method :f, :render_custom_field_raw
+
+    def parse_arguments(args)
+      field = nil
+      options = {}
+      if args[0].class.name == 'String'
+        field = args[0]
+        options =  args[1] || {}
+      elsif args[0].class.name == 'Hash'
+        options =  args[0] || {}
+      end
+      return field, options
+    end
+  end
+end

data/lib/editmode/script_tag.rb

@@ -18,6 +18,7 @@ module Editmode
       
       str = <<-EDITMODE_SCRIPT
   <script>window.chunksProjectIdentifier = '#{Editmode.project_id}'</script>
+  <script>window.editmodeENV = '#{ENV["EDITMODE_ENV"] || 'production'}'</script>
   <script src="#{script_url}" async ></script>
       EDITMODE_SCRIPT
 
@@ -26,7 +27,7 @@ module Editmode
     end
 
     def script_url 
-      ENV["EDITMODE_OVERRIDE_SCRIPT_URL"] || "https://static.editmode.com/editmode@^1.0.0/dist/editmode.js"
+      ENV["EDITMODE_OVERRIDE_SCRIPT_URL"] || "https://static.editmode.com/editmode@2.0.0/dist/editmode.js"
     end
 
   end

data/lib/editmode/version.rb

@@ -1,3 +1,3 @@
 module Editmode
-  VERSION = "1.1.0"
+  VERSION = "1.1.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: editmode
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.6
 platform: ruby
 authors:
 - Tony Ennis
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-15 00:00:00.000000000 Z
+date: 2020-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,6 +84,7 @@ files:
 - lib/editmode/auto_include_filter.rb
 - lib/editmode/chunk_value.rb
 - lib/editmode/engine.rb
+- lib/editmode/helper.rb
 - lib/editmode/railtie.rb
 - lib/editmode/script_tag.rb
 - lib/editmode/version.rb
@@ -93,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,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.8
-signing_key: 
+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