editmode 1.3.5 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e15d8405884179d972f91d11fa4bb20097577371dc6daee29935c26530fed7a3
-  data.tar.gz: 7819de17f3f5a4da995adb11855c0aba118a3da2a89c3a74762e9e36aa687af1
+  metadata.gz: 500fe0cf37b2d0586d015874d1125ba7f03e71431db4e60d337f5a9dcc61f2b5
+  data.tar.gz: 99adf389c43e829add85c044ac4527bcf4db957f5e31d16cc74a2c3bc37dea33
 SHA512:
-  metadata.gz: fa7861dfa13bb0e4c680fbf943a30486be2d2519322afe0dfe898d91bae1e929cca214d2e36b693bd8e9016bb2ce4954c7889baede5605b4aa17ca31d837410e
-  data.tar.gz: 10291830bd61bd79720a77fbddf4b88e3dbd909eee66e1236915f757bb958f264b93ad20b2fbb232ab055e3e3ab025e01906e05b8e6e348b66f3709c5cf6c626
+  metadata.gz: ba38286569b3724873f8ce653057e170cc816800e31901aeb7838b2aedca51a73568f850c4d50f249b0e411b648f98cf72e81e4590e778cf7b996afff751583a
+  data.tar.gz: 882ff9cca0f75438c613bb22e07cc380f5727ebe4b8d435b88794696d90d82c0f51d34ad884fe1ad1a432a64a9e0bfe50ee95df5cc937d1d9d2f80823a074a76

data/README.md

@@ -119,7 +119,7 @@ Use `transformation` attribute to perform real-time image transformations to del
   = F('Avatar', transformation: "w-200 h-200")
 ```
 
-Please see complete list of [transformation parameters](https://editmode.com/docs#/imagekit_properties).
+Please see the complete list of [transformation parameters](https://editmode.com/docs#/imagekit_properties).
 
 ## Caching
 In order to keep your application speedy, Editmode minimizes the amount of network calls it makes by caching content where it can. 
@@ -139,6 +139,8 @@ The editmode gem exposes a cache expiration endpoint in your application at `/ed
 
 The cache expiration endpoint is currently **not** authenticated.
 
+?> We are using a method called `delete_matched` to purge your caches when a content gets updated, and this method isn't supported in `memcached`. We highly recommend using `redis_store` or `file_store`.
+
 ## Disabling editmode.js auto-include
 
 To disable automatic insertion for a particular controller or action you can:

data/lib/editmode.rb

@@ -8,11 +8,17 @@ require 'editmode/railtie' if defined? Rails
 require 'editmode/engine' if defined?(Rails)
 require 'editmode/monkey_patches'
 require 'editmode/logger'
+require 'editmode/chunk'
+
 module Editmode
   class << self
     include Editmode::ActionViewExtensions::EditmodeHelper
     include Editmode::Helper
 
+    def api_root_url
+      ENV["EDITMODE_OVERRIDE_API_URL"] || "https://api.editmode.com"
+    end
+
     def project_id=(id)
       config.project_id = id
     end
@@ -52,11 +58,30 @@ module Editmode
         puts er
       end
     end
+
+    def cache_all!(chunks)
+      chunks.each do |chunk|
+        project_id = chunk["project_id"]
+        identifier = chunk["identifier"]
+        content_key = chunk["content_key"]
+        json_data = chunk.to_json
+        Rails.cache.write("chunk_#{project_id}#{identifier}", json_data)
+        Rails.cache.write("chunk_#{project_id}#{content_key}", json_data) if content_key.present?
+      end
+    end
   end
 
   class Configuration
     attr_accessor :access_token, :variable
-    attr_reader :project_id, :log_level
+    attr_reader :project_id, :log_level, :preload
+
+    def preload=(bool)
+      @preload = bool
+      if bool
+        chunks = Editmode::Chunk.retrieve
+        Editmode.cache_all!(chunks)
+      end
+    end
 
     def logger
       @logger ||= Editmode::Logger.new
@@ -64,6 +89,10 @@ module Editmode
 
     def project_id=(id)
       @project_id = id
+      if preload
+        chunks = Editmode::Chunk.retrieve(id)
+        Editmode.cache_all!(chunks)
+      end
     end
 
     def log_level=(level)

data/lib/editmode/action_view_extensions/editmode_helper.rb

@@ -63,10 +63,10 @@ module Editmode
 
             if chunks.any?
               content_tag :div, class: "chunks-collection-wrapper #{parent_class}", data: {chunk_collection_identifier: collection_identifier} do
-                chunks.each do |chunk|
+                chunks.each_with_index do |chunk, index|
                   @custom_field_chunk = chunk
                   concat(content_tag(:div, class: "chunks-collection-item--wrapper #{item_class}") do
-                    yield(@custom_field_chunk)
+                    yield(@custom_field_chunk, index)
                   end)
                 end
 
@@ -163,7 +163,7 @@ module Editmode
         # prevent the page from loading.
         begin
           field = options[:field].presence || ""          
-          options[:referrer] = request.url
+          options[:referrer] = request.present? && request.url || ""
           chunk_value = Editmode::ChunkValue.new(identifier, options)
           
           if field.present? && chunk_value.chunk_type == 'collection_item'
@@ -182,11 +182,12 @@ module Editmode
           render_chunk_content(identifier, chunk_content, chunk_type, options)
 
         rescue => error
+          puts error
           # Show fallback content by default
           return content_tag("em-span", &block) if block_given?
           # Otherwise show a span with no content to 
           # maintain layout
-          content_tag("em-span", "&nbsp".html_safe) 
+          content_tag("em-span", "&nbsp".html_safe)
         end
       end
       alias_method :chunk, :chunk_display

data/lib/editmode/chunk.rb

@@ -0,0 +1,26 @@
+class Editmode::Chunk
+  def initialize
+  end
+
+  class << self
+    def retrieve(project_id = Editmode.project_id, options = {})
+      begin
+        root_url = Editmode.api_root_url
+        chunk_id = options[:identifier] || options[:content_key]
+
+        url = "#{root_url}/chunks/#{chunk_id}?project_id=#{project_id}"
+        response = HTTParty.get(url)
+
+        if chunk_id.present?
+          return response
+        else
+          chunks = response.try(:[], "chunks")
+          chunks ||= []
+        end
+      rescue => er
+        Rails.logger.info er
+        []
+      end
+    end
+  end
+end

data/lib/editmode/chunk_value.rb

@@ -133,33 +133,36 @@ module Editmode
     def query_params
       the_params = { 'project_id' => project_id }
       the_params['branch_id'] = branch_id if branch_id.present?
-      the_params['transformation'] = @transformation if @transformation.present?
 
       the_params
     end
 
     def get_content
       if !cached?
-        http_response = HTTParty.get(url, query: query_params, headers: {referrer: @referrer})
-        response_received = true if http_response.code == 200
+        @response = HTTParty.get(url, query: query_params, headers: {referrer: @referrer})
+        response_received = true if @response.code == 200
       end
 
       if !cached? && !response_received
-        message = http_response.try(:[], 'message') || no_response_received(identifier)
+        message = @response.try(:[], 'message') || no_response_received(identifier)
 
         raise message
       else
-        Rails.cache.write(cache_identifier, http_response.to_json) if http_response.present?
+        Rails.cache.write(cache_identifier, @response.to_json) if @response.present?
         cached_response = Rails.cache.fetch(cache_identifier)
 
-        @response = json?(cached_response) ? JSON.parse(cached_response) : cached_response
+        if cached_response.present?
+          @response = json?(cached_response) ? JSON.parse(cached_response) : cached_response
+        end
+
         set_response_attributes!
       end
     end
 
     def set_response_attributes!
-      @content = response['content']
       @chunk_type = response['chunk_type']
+      
+      @content = @chunk_type == 'image' ? set_transformation_properties!(response['content']) : response['content'] 
       @variable_fallbacks = response['variable_fallbacks'].presence || {}
       @collection_id = response["collection"]["identifier"] if chunk_type == 'collection_item'
       @branch_id = response['branch_id']

data/lib/editmode/helper.rb

@@ -5,7 +5,7 @@ module Editmode
       field, options = parse_arguments(args)
       begin
         chunk = Editmode::ChunkValue.new(identifier, options.merge({raw: true}))
-
+        
         if chunk.chunk_type == 'collection_item'
           chunk.field(field)
         else
@@ -13,6 +13,7 @@ module Editmode
         end 
       rescue => er
         Rails.logger.info "#{er}: We can't render content for #{identifier}"
+        return ""
       end
     end
 

data/lib/editmode/version.rb

@@ -1,3 +1,3 @@
 module Editmode
-  VERSION = "1.3.5"
+  VERSION = "1.5.0"
 end

data/lib/generators/editmode/templates/editmode.rb.erb

@@ -1,5 +1,11 @@
 Editmode.setup do |config|
-  # Replace TodoProjectId with your Editmode Project ID, 
-  # visit https://editmode.com/projects
   config.project_id = "<%= @project_id %>"
+
+  # Enables logging on every API request
+  # config.log_level = :silence
+
+  # Preload contents - this will take all the contents
+  # from the project specified in config.project_id
+  # and store it to your Application cache.
+  # config.preload = true
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: editmode
 version: !ruby/object:Gem::Version
-  version: 1.3.5
+  version: 1.5.0
 platform: ruby
 authors:
 - Tony Ennis
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-12 00:00:00.000000000 Z
+date: 2021-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -82,6 +82,7 @@ files:
 - lib/editmode.rb
 - lib/editmode/action_view_extensions/editmode_helper.rb
 - lib/editmode/auto_include_filter.rb
+- lib/editmode/chunk.rb
 - lib/editmode/chunk_value.rb
 - lib/editmode/engine.rb
 - lib/editmode/helper.rb
@@ -96,7 +97,7 @@ homepage: https://github.com/tonyennis145/editmode-rails
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -111,8 +112,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.4
-signing_key:
+rubygems_version: 3.0.3.1
+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