editmode 0.0.9.75 → 0.0.10.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84d3a139a19d2ce3224a3dbde3caeeb86b855ee87af329adef40ec7ef73e6079
-  data.tar.gz: 6edf4098ee427cd1e0a535a25bca31685a63047e228cd36caea259822d133a1b
+  metadata.gz: e17da0620f2d013a83300d7984ace6b9badd0716bc3187b1125fe7497e8c99a0
+  data.tar.gz: 39e552edd8fc95c2ba238b0fe7575432603b4e6f7e7e46328c5ff5836987ce31
 SHA512:
-  metadata.gz: 50ea5beedeb776512cc1e39d26eb0a1bea80a1418fe71487350c6d226ed97e3d0fe709a5e045e63a599d0bf52202b2485b0467e117e5d9b9fed00d22e6938379
-  data.tar.gz: c788b16ab084ca7be4c0392efa1561eebe878d6d7ebce6c8f982e3422645355d912e79b7e6e0a2a41ac6d6a365424db401472c80ebcbec68a23b5ccf68eda705
+  metadata.gz: ff2bd59f92ff2389577e23888d092f1097daebc95e4f6e8cd56c3ce5df1e2dd6221705849301a0b6865a3fac8709530d6198d4a04137e9496720bac6b715f376
+  data.tar.gz: 69e56b6950e2e8c2f1907b7fd4a2c9626cf5b4777ddceadc720a002efbc15d1a6b3ae041117841e7b8c3351c3af825d12fcd558345ac5a8d49e53e727caf235d

data/app/controllers/editmode_controller.rb

@@ -1,8 +1,14 @@
 class EditmodeController < ApplicationController
 
   def clear_cache
-    
-    if params[:identifier]
+    if params[:full]
+      Rails.cache.clear
+      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")
+      render status: 200, json: {:response => "success"}
+    elsif params[:identifier]
       Rails.cache.delete("chunk_#{params[:identifier]}")
       Rails.cache.delete("chunk_#{params[:identifier]}_type")
       render status: 200, json: {:response => "success"}

data/lib/editmode.rb

@@ -1,14 +1,53 @@
 require "active_support/dependencies"
+require "editmode/version"
+require 'editmode/script_tag'
+require 'editmode/action_view_extensions/editmode_helper'
+require 'editmode/auto_include_filter'
+require 'editmode/chunk_value'
+require 'editmode/railtie' if defined? Rails
+require 'editmode/engine' if defined?(Rails)
+# Todo: Implement RSPEC
+module Editmode
+  class << self
+    include Editmode::ActionViewExtensions::EditmodeHelper
 
-require "editmode-rails/version"
+    def project_id=(id)
+      config.project_id = id
+    end
 
-require 'editmode-rails/script_tag'
-require 'editmode-rails/action_view_extensions/editmode_helper'
-require 'editmode-rails/auto_include_filter'
-require 'editmode-rails/railtie' if defined? Rails
+    def project_id
+      config.project_id
+    end
 
-module EditModeRails
-  # Your code goes here...
-end
+    def access_token
+      config.access_token
+    end
 
-require 'editmode-rails/engine' if defined?(Rails)
+    def config
+      @config ||= Configuration.new
+    end
+
+    def setup
+      yield config
+    end
+
+    def chunk_value(identifier, **options)
+      begin
+        options.merge!(project_id: project_id)
+        Editmode::ChunkValue.new(identifier, **options )
+      rescue => er
+        raise er
+      end
+    end
+  end
+
+  class Configuration
+    attr_accessor :access_token, :variable
+    attr_reader :project_id
+
+    def project_id=(id)
+      @project_id = id
+
+    end
+  end
+end

data/lib/{editmode-rails → editmode}/action_view_extensions/editmode_helper.rb

@@ -1,24 +1,21 @@
-module EditModeRails
+module Editmode
   module ActionViewExtensions
-    module EditModeHelper
+    module EditmodeHelper
 
       require 'httparty'
 
       def api_version
-        "v1"
+        # Todo Add Header Version
       end
 
       def api_root_url
-        ENV["EDITMODE_OVERRIDE_API_URL"] || "https://www.editmode.app/api"
+        ENV["EDITMODE_OVERRIDE_API_URL"] || "https://api.editmode.com"
       end
 
-      def versioned_api_url
-        "#{api_root_url}/#{api_version}"
-      end
-     
       def chunk_collection(collection_identifier,has_tags=[])
+        branch_params = params[:em_branch_id].present? ? "branch_id=#{params[:em_branch_id]}" : ""
         begin 
-          url = "#{versioned_api_url}/chunks?collection_identifier=#{collection_identifier}"
+          url = "#{api_root_url}/chunks?collection_identifier=#{collection_identifier}&#{branch_params}"
           response = HTTParty.get(url)
           raise "No response received" unless response.code == 200
           chunks = response["chunks"]
@@ -29,18 +26,18 @@ module EditModeRails
         end
       end
 
-      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].present? }
+          custom_field_item = parent_chunk_object["content"].detect {|f| f["custom_field_identifier"] == custom_field_identifier }
         
           if custom_field_item.present?
-            properties = custom_field_item[custom_field_identifier]
             render_chunk_content(
-              properties["identifier"],
-              properties["content"],
-              properties["chunk_type"]
+              custom_field_item["identifier"],
+              custom_field_item["content"],
+              custom_field_item["chunk_type"],
+              { parent_identifier: chunk_identifier }.merge(options)
             )
           end
         rescue => errors
@@ -64,39 +61,43 @@ module EditModeRails
             display_type = options[:display_type] || "span"
           end
 
+          chunk_data = { :chunk => chunk_identifier, :chunk_editable => false }
+
+          if options[:parent_identifier].present?
+            chunk_data.merge!({parent_identifier: options[:parent_identifier]})
+          end
+
           case display_type
           when "span"
             if chunk_type == "rich_text"
-              content_tag(:span, :class => css_class, :data => {:chunk => chunk_identifier, :chunk_editable => false} ) do
+              content_tag("em-span", :class => css_class, :data => chunk_data ) do
                 chunk_content.html_safe
               end
             else
-              content_tag(:span, :class => css_class, :data => {:chunk => chunk_identifier, :chunk_editable => true} ) do
+              content_tag("em-span", :class => css_class, :data => chunk_data.merge!({:chunk_editable => true}) ) do
                 chunk_content
               end
             end
           when "image"
-            content_tag(:span, :data => {:chunk => chunk_identifier, :chunk_editable => false} ) do 
-              image_tag(chunk_content, :class => css_class) 
-            end
+            image_tag(chunk_content, :data => chunk_data, :class => css_class) 
           end
         rescue => errors
           puts errors
-          content_tag(:span, "&nbsp".html_safe) 
+          content_tag("em-span", "&nbsp".html_safe) 
         end
 
       end
 
       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
         # We should just show blank content, not
         # prevent the page from loading.
-        begin 
-
-          cache_identifier = "chunk_#{identifier}"
-          url = "#{versioned_api_url}/chunks/#{identifier}"
+        begin
+          branch_params = branch_id.present? ? "branch_id=#{branch_id}" : ""
+          cache_identifier = "chunk_#{identifier}#{branch_id}"
+          url = "#{api_root_url}/chunks/#{identifier}?#{branch_params}"
           cached_content_present = Rails.cache.exist?(cache_identifier)
 
           if !cached_content_present
@@ -116,22 +117,44 @@ module EditModeRails
               response['chunk_type']
             end
 
-            render_chunk_content(identifier,chunk_content,chunk_type)
+            render_chunk_content(identifier,chunk_content,chunk_type, options)
 
           end
 
         rescue => error
           # Show fallback content by default
-          return content_tag(:span, &block) if block_given?
+          return content_tag("em-span", &block) if block_given?
           # Otherwise show a span with no content to 
           # maintain layout
-          content_tag(:span, "&nbsp".html_safe) 
+          content_tag("em-span", "&nbsp".html_safe) 
         end
 
       end
 
       alias_method :chunk, :chunk_display
 
+      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 content using this identifier: \"#{id}\""
+      end
+      
+      def require_field_id
+        "Field ID or Field Name is required to retrieve a collection item"
+      end
     end
   end
 end

data/lib/{editmode-rails → editmode}/auto_include_filter.rb

@@ -1,10 +1,10 @@
-module EditModeRails
+module Editmode
 
   module AutoInclude
 
     module Method
       def editmode_auto_include
-        EditModeRails::AutoInclude::Filter.filter(self)
+        Editmode::AutoInclude::Filter.filter(self)
       end
     end
 
@@ -49,7 +49,7 @@ module EditModeRails
       end
 
       def editmode_script_tag
-        @script_tag ||= EditModeRails::ScriptTag.new()
+        @script_tag ||= Editmode::ScriptTag.new()
       end
 
       def enabled_for_environment?

data/lib/editmode/chunk_value.rb

@@ -0,0 +1,71 @@
+module Editmode
+  class ChunkValue
+    include Editmode::ActionViewExtensions::EditmodeHelper
+
+    attr_accessor :identifier, :variable_values, :branch_id, 
+                  :variable_fallbacks, :chunk_type, :project_id, 
+                  :content
+
+    def initialize(identifier, **options)
+      @identifier = identifier
+      @branch_id = options[:branch_id].presence
+      @project_id = options[:project_id].presence
+      @variable_values = options[:values].presence || {}
+      get_content
+    end
+
+    def field(field = nil)
+      # Field ID can be a slug or field_name
+      if chunk_type == 'collection_item'
+        if field.present?
+          field_content = content.detect {|f| f["custom_field_identifier"] == field || f["custom_field_name"] == field }
+          if field_content.present?
+            result = field_content['content']
+            result = variable_parse!(result, variable_fallbacks, variable_values)
+          else
+            raise no_response_received(field)
+          end
+        else
+          raise require_field_id
+        end
+      else
+        raise "undefined method field for chunk_type: #{chunk_type}"
+      end
+      result ||= content
+    end
+
+    private
+    def get_content
+      branch_params = branch_id.present? ? "branch_id=#{branch_id}" : ""
+      url = "#{api_root_url}/chunks/#{identifier}?#{branch_params}"
+
+      cache_identifier = "chunk_#{identifier}#{branch_id}"
+      cached_content_present = Rails.cache.exist?(cache_identifier)
+      cached_content_present = Rails.cache.exist?("chunk_#{project_id}_variables") if cached_content_present
+
+      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(identifier)
+      else
+        @content = Rails.cache.fetch(cache_identifier) do
+          response['content']
+        end
+
+        @chunk_type = Rails.cache.fetch("#{cache_identifier}_type") do
+          response['chunk_type']
+        end
+
+        # Since variables are defined in the project level,
+        # We use project_id as cache identifier
+        @variable_fallbacks = Rails.cache.fetch("chunk_#{project_id}_variables") do
+          response['variable_fallbacks']
+        end
+      end      
+    end
+
+  end
+end

data/lib/{editmode-rails → editmode}/engine.rb

@@ -1,4 +1,4 @@
-module EditMode
+module Editmode
 
   class Engine < Rails::Engine
 

data/lib/{editmode-rails → editmode}/railtie.rb

@@ -1,9 +1,9 @@
-module EditModeRails
+module Editmode
   class Railtie < Rails::Railtie
-    initializer "editmode-rails" do |app|
+    initializer "editmode" do |app|
 
       ActiveSupport.on_load :action_view do
-        include EditModeRails::ActionViewExtensions::EditModeHelper
+        include Editmode::ActionViewExtensions::EditmodeHelper
       end
       ActiveSupport.on_load :action_controller do
         include AutoInclude::Method

data/lib/{editmode-rails → editmode}/script_tag.rb

@@ -1,4 +1,4 @@
-module EditModeRails
+module Editmode
 
   class ScriptTag
 
@@ -17,6 +17,7 @@ module EditModeRails
     def output
       
       str = <<-EDITMODE_SCRIPT
+  <script>window.chunksProjectIdentifier = '#{Editmode.project_id}'</script>
   <script src="#{script_url}" async ></script>
       EDITMODE_SCRIPT
 
@@ -25,7 +26,7 @@ module EditModeRails
     end
 
     def script_url 
-      ENV["EDITMODE_OVERRIDE_SCRIPT_URL"] || "https://www.editmode.app/assets/chunks.js"
+      ENV["EDITMODE_OVERRIDE_SCRIPT_URL"] || "https://static.editmode.com/editmode@1.0.0/dist/editmode.js"
     end
 
   end

data/lib/editmode/version.rb

@@ -0,0 +1,3 @@
+module Editmode
+  VERSION = "0.0.10.12"
+end

data/lib/generators/editmode/config_generator.rb

@@ -0,0 +1,26 @@
+
+require 'rails/generators/base'
+
+module Editmode
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      argument :project_id, :desc => "Your Editmode project_id, which can be found here: https://www.editmode.com/projects"
+
+      def create_config_file
+        @project_id = project_id
+        
+        introduction = <<-intro
+Editmode will automatically insert its javascript before the closing '</body>'
+tag on every page.
+
+        intro
+
+        print "#{introduction} "
+
+        template "editmode.rb.erb", "config/initializers/editmode.rb"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+Editmode.setup do |config|
+  # Replace TodoProjectId with your Editmode Project ID, 
+  # visit https://editmode.com/projects
+  config.project_id = "<%= @project_id %>"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: editmode
 version: !ruby/object:Gem::Version
-  version: 0.0.9.75
+  version: 0.0.10.12
 platform: ruby
 authors:
 - Tony Ennis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-15 00:00:00.000000000 Z
+date: 2020-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -79,13 +79,16 @@ files:
 - Rakefile
 - app/controllers/editmode_controller.rb
 - config/routes.rb
-- lib/editmode-rails/action_view_extensions/editmode_helper.rb
-- lib/editmode-rails/auto_include_filter.rb
-- lib/editmode-rails/engine.rb
-- lib/editmode-rails/railtie.rb
-- lib/editmode-rails/script_tag.rb
-- lib/editmode-rails/version.rb
 - lib/editmode.rb
+- lib/editmode/action_view_extensions/editmode_helper.rb
+- lib/editmode/auto_include_filter.rb
+- lib/editmode/chunk_value.rb
+- lib/editmode/engine.rb
+- lib/editmode/railtie.rb
+- lib/editmode/script_tag.rb
+- lib/editmode/version.rb
+- lib/generators/editmode/config_generator.rb
+- lib/generators/editmode/templates/editmode.rb.erb
 homepage: https://github.com/tonyennis145/editmode-rails
 licenses:
 - MIT
@@ -105,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Editmode allows you to turn plain text in your rails app into easily inline-editable

data/lib/editmode-rails/version.rb

@@ -1,3 +0,0 @@
-module EditModeRails
-  VERSION = "0.0.9.75"
-end