editmode-rails 0.0.9.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 003ddbea8995e89ecad468f7ca40d1d795f456e37673dbcb1c91262c8a2f8864
+  data.tar.gz: fcf3aa1bca202716586bff3b279df8f3af40e63ebba481ee183731c7a665264e
+SHA512:
+  metadata.gz: abd85d25bc598544d1d78a4fda801ca69912c183c38e6762359198bb736975a0e2a2f4575b5df6d9eac06bf8d214ef2065103625e35cd0b349f8aebfdbe038ad
+  data.tar.gz: 33035b524294d03bd5befc0e0aaafb46d6486ecf062c2a12d75ec3cc018ab27ad00009583c15f4b670a77c740e299463f8160af169f48117ba0e102fff80803f

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in chunks.gemspec
+gemspec

data/README.md

@@ -0,0 +1,20 @@
+
+# Editmode Rails Gem
+
+To be completed
+
+## Installation
+
+## How It Works
+- Autoload editmode.js
+- Expose view helper
+
+## 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
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/app/controllers/editmode_controller.rb

@@ -0,0 +1,15 @@
+class EditModeController < ApplicationController
+
+  def clear_cache
+
+    Rails.cache.delete("bit_#{params[:identifier]}")
+    
+    if params[:identifier]
+      render status: 200, json: {:response => "success"}
+    else
+      render status: 404, json: {:response => "no identifier specified"}
+    end
+
+  end
+
+end

data/config/routes.rb

@@ -0,0 +1,4 @@
+Rails.application.routes.draw do
+  # Use a namespaced url because /:generic can easily be overwritten by app default routes
+  get "/editmode/clear_cache" => "editmode#clear_cache" , :as => :editmode_clear_cache
+end

data/lib/editmode-rails.rb

@@ -0,0 +1,14 @@
+require "active_support/dependencies"
+
+require "editmode-rails/version"
+
+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
+
+module EditModeRails
+  # Your code goes here...
+end
+
+require 'editmode-rails/engine' if defined?(Rails)

data/lib/editmode-rails/action_view_extensions/editmode_helper.rb

@@ -0,0 +1,75 @@
+module EditModeRails
+
+  module ActionViewExtensions
+    module EditModeHelper
+
+      require 'httparty'
+
+      def api_version
+        "v1"
+      end
+
+      def api_root_url
+        ENV["EDITMODE_OVERRIDE_API_URL"] || "https://www.editmode.app/api"
+      end
+
+      def versioned_api_url
+        "#{api_root_url}/#{api_version}"
+      end
+     
+      def chunk_display(label,identifier,options={})
+
+        chunk_content = Rails.cache.fetch("bit_#{identifier}") do  
+          url = "#{versioned_api_url}/bits/#{identifier}"
+          response = HTTParty.get(url)
+          chunk_content = response['content']
+        end
+
+        display_type = options[:display_type] || "span"
+        css_class = options[:css_class]
+        content_type = "plain"
+
+        # Simple check to see if returned chunk contains html. Regex will need to be improved
+        if /<[a-z][\s\S]*>/i.match(chunk_content)
+          content_type = "rich"
+          chunk_content = chunk_content.html_safe
+        elsif chunk_content.include? "\n"
+          content_type = "rich"
+          renderer = Redcarpet::Render::HTML.new(no_links: true, hard_wrap: true)
+          markdown = Redcarpet::Markdown.new(renderer, extensions = {})
+          chunk_content = markdown.render(chunk_content).html_safe
+        end
+
+        case display_type
+        when "span"
+          if content_type == "rich"
+            content_tag(:span, :class => css_class, :data => {:chunk => identifier, :chunk_editable => false }) do
+              chunk_content
+            end
+          else
+            content_tag(:span, :class => css_class, :data => {:chunk => identifier, :chunk_editable => true }) do
+              chunk_content
+            end
+          end
+        when "raw"
+          chunk_content
+        end
+
+      end
+
+      def bit(label,identifier,options={})
+        chunk_display(label,identifier)
+      end
+
+      def chunk(label,identifier,options={})
+        chunk_display(label,identifier)
+      end
+
+      def raw_chunk(label,identifier,options={})
+        chunk_display(label,identifier,options.merge(:display_type => "raw"))
+      end
+      
+    end
+  end
+
+end

data/lib/editmode-rails/auto_include_filter.rb

@@ -0,0 +1,65 @@
+module EditModeRails
+
+  module AutoInclude
+
+    module Method
+      def editmode_auto_include
+        EditModeRails::AutoInclude::Filter.filter(self)
+      end
+    end
+
+    class Filter
+
+      CLOSING_BODY_TAG = %r{</body>}
+      def self.filter(controller)
+        auto_include_filter = new(controller)
+        return unless auto_include_filter.include_javascript?
+
+        auto_include_filter.include_javascript!
+      end
+
+      attr_reader :controller
+
+      def initialize(kontroller)
+        @controller = kontroller
+      end
+
+      def include_javascript!
+        response.body = response.body.gsub(CLOSING_BODY_TAG, editmode_script_tag.output + '\\0')
+      end
+
+      def include_javascript?
+        enabled_for_environment? &&
+        html_content_type? &&
+        response_has_closing_body_tag? &&
+        editmode_script_tag.valid?
+      end
+
+      private
+      def response
+        controller.response
+      end
+
+      def html_content_type?
+        response.content_type == 'text/html'
+      end
+
+      def response_has_closing_body_tag?
+        !!(response.body[CLOSING_BODY_TAG])
+      end
+
+      def editmode_script_tag
+        @script_tag ||= EditModeRails::ScriptTag.new()
+      end
+
+      def enabled_for_environment?
+        enabled_environments = ["production","development","staging"]
+        return true if enabled_environments.nil?
+        enabled_environments.map(&:to_s).include?(Rails.env)
+      end
+
+    end
+
+  end
+
+end

data/lib/editmode-rails/engine.rb

@@ -0,0 +1,8 @@
+module EditMode
+
+  class Engine < Rails::Engine
+
+  
+  end
+
+end

data/lib/editmode-rails/railtie.rb

@@ -0,0 +1,19 @@
+module EditModeRails
+  class Railtie < Rails::Railtie
+    initializer "editmode-rails" do |app|
+
+      ActiveSupport.on_load :action_view do
+        include EditModeRails::ActionViewExtensions::EditModeHelper
+      end
+      ActiveSupport.on_load :action_controller do
+        include AutoInclude::Method
+
+        if respond_to? :after_action
+          after_action :editmode_auto_include
+        else
+          after_filter :editmode_auto_include
+        end
+      end
+    end
+  end
+end

data/lib/editmode-rails/script_tag.rb

@@ -0,0 +1,33 @@
+module EditModeRails
+
+  class ScriptTag
+
+    def self.generate(*args)
+      new(*args).output
+    end
+
+    def initialize(options = {})
+      
+    end
+
+    def valid?
+      true
+    end
+
+    def output
+      
+      str = <<-EDITMODE_SCRIPT
+  <script src="#{script_url}" async ></script>
+      EDITMODE_SCRIPT
+
+      str.respond_to?(:html_safe) ? str.html_safe : str
+
+    end
+
+    def script_url 
+      ENV["EDITMODE_OVERRIDE_SCRIPT_URL"] || "https://www.editmode.app/assets/chunks.js"
+    end
+
+  end
+
+end

data/lib/editmode-rails/version.rb

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

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: editmode-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.9.8
+platform: ruby
+authors:
+- Tony Ennis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.5
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.2
+description: The Editmode gem allows you to include chunks from the Editmode platform
+  in your rails views
+email:
+- ennis.tony@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- app/controllers/editmode_controller.rb
+- config/routes.rb
+- lib/editmode-rails.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
+homepage: https://github.com/tonyennis145/editmode-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+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
+test_files: []