dynamic_text 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 045ab717af477c29c99326ae5c31683e319cd42c968fbd8787f8257926f2681b
-  data.tar.gz: e8cef2d57e7dfc7d68a40845985da49dc2ad46abf97b89499143b6c46c0e3c73
+  metadata.gz: dc355787a78ea70e6728fb425360773d10a6a964478a551213a525a029153fa5
+  data.tar.gz: 400c9191e052f31835e86a1d3575cf82ff1c78bfd5240c7a3d46cf76502143e8
 SHA512:
-  metadata.gz: 04bb86f100420e54a44b1ae85be5ed567b1a2aaf79e0329ea2206724f54eeaa7f55787d36edd652d3c1d9eafe891fa01d5ddaac7442619f0c769da75aa7a58ee
-  data.tar.gz: 214149fd278354e6bedbe52e1fe4972212c256cd1c2b67fb804b1c9a0d4b169cfd7b775e5fc8c8122fb3a0f308d201c5ead72c10cdc695bb166583fa8cb888a2
+  metadata.gz: 578a1f7541b9d99e46753eb26ee1e0a9f053629931ab30421a1d93ef9640058a963c56809f47ee4e0589c9f2d1f1a50f9355a948b6b5c2906f102e90e1562dfc
+  data.tar.gz: a38e4ea970e6808367e52c552b8b8b7a00014db566e2874cb156df239cfece7897808d4978d4b2563c0aa17c7fca8fe678c01c0d06bcc329e0565cbb8a4f099c

data/Rakefile

@@ -14,19 +14,17 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
 load 'rails/tasks/engine.rake'
 
 load 'rails/tasks/statistics.rake'
 
 require 'bundler/gem_tasks'
 
-require 'rake/testtask'
+require 'rspec/core'
+require 'rspec/core/rake_task'
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
+# desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec)
 
-task default: :test
+task default: :spec

data/app/assets/javascripts/dynamic_text/dynamic_text.js

@@ -54,13 +54,13 @@ const DynamicText = {
     this.ajaxResponses['default'] = func;
   },
 
-  // Set response for specific ajax key
-  handleAjaxResponseFor(ajaxKey, func) {
-    this.ajaxResponses[ajaxKey] = func;
+  // Set response for specific js key
+  handleAjaxResponseFor(jsKey, func) {
+    this.ajaxResponses[jsKey] = func;
   },
 
   // Build ajax request for patch resource function.
-  sendPatchRequest(url, resourceType, attribute, updatedValue, ajaxKey) {
+  sendPatchRequest(url, resourceType, attribute, updatedValue, jsKey) {
     const CSRF_TOKEN =
       document.querySelector('meta[name="csrf-token"]')
               .getAttribute('content');
@@ -78,7 +78,7 @@ const DynamicText = {
     xhr.onload = () => {
       if (xhr.status === 200) {
         successCallback =
-          this.ajaxResponses[ajaxKey] || this.ajaxResponses['default']
+          this.ajaxResponses[jsKey] || this.ajaxResponses['default']
         successCallback(JSON.parse(xhr.responseText), resourceType)
       }
     };
@@ -98,78 +98,9 @@ const DynamicText = {
     const url = action.getAttribute('url');
     const resourceType = action.getAttribute('resource-type');
     const attribute = action.getAttribute('attribute');
-    const ajaxKey = action.getAttribute('ajax-key');
+    const jsKey = action.getAttribute('js-key');
     const updatedValue = editableText.innerText;
 
-    this.sendPatchRequest(url, resourceType, attribute, updatedValue, ajaxKey)
+    this.sendPatchRequest(url, resourceType, attribute, updatedValue, jsKey)
   }
 }
-
-const prepareDynamicText = () => {
-  document.querySelectorAll('.editable-text').forEach((editableText) => {
-    // Exit editable text editor mode (focus) on enter instead of adding a new line.
-    editableText.addEventListener('keydown', (e) => {
-      if (e.keyCode === 13) {
-        e.preventDefault();
-        e.currentTarget.blur();
-      }
-    });
-
-    // Properly paste text into editable text
-    editableText.addEventListener('paste', (e) => {
-      e.preventDefault();
-      DynamicText.handleContentEditablePaste(e)
-    });
-
-    // Disable dragging and dropping text/images into editable text.
-    ["dragover", "drop"].forEach((evt) => {
-      editableText.addEventListener(evt, (e) => {
-        e.preventDefault();
-        return false;
-      });
-    });
-
-    // Store original value when focusing in on specific editable text (used to determine if text was changed and patch request should be sent on focusout.)
-    editableText.addEventListener('focus', (e) => {
-      const target = e.currentTarget;
-      target.setAttribute('data-original-value', target.innerText);
-    });
-
-    // Send patch request for resource if content was changed.
-    editableText.addEventListener('focusout', (e) => {
-      const target = e.currentTarget
-
-      // Empty all content of text if editable text is empty (otherwise certain browsers fill in a default <br> or <p> value.)
-      if (!target.innerText.trim().length) {
-        target.innerText = null;
-      }
-
-      // Send patch request if text was changed.
-      if (target.getAttribute('data-original-value') != target.innerText) {
-        DynamicText.patchResource(e);
-      }
-
-      target.removeAttribute('data-original-value')
-    });
-
-    // Update all other divs tagged with the same dynamic-tag as the current text being edited. (So if you have two elements on one page that display the same title property of a resource, both will be updated in real time when you edit the text of one.)
-    editableText.addEventListener('input', (e) => {
-      const target = e.currentTarget;
-      const newValue = target.innerText;
-      const dynamicTag = target.getAttribute('data-dynamic-tag');
-
-      document.querySelectorAll(`[data-dynamic-tag='${dynamicTag}']`)
-        .forEach((dynamicTextElement) => {
-          if(dynamicTextElement !== target) {
-            dynamicTextElement.innerText = newValue;
-          }
-        });
-    });
-  })
-}
-
-const events = ["turbolinks:load", "page:change"];
-
-events.forEach((evt) => {
-  document.addEventListener(evt, prepareDynamicText)
-});

data/app/assets/javascripts/dynamic_text/dynamic_text_preparer.js

@@ -0,0 +1,62 @@
+const prepareDynamicText = () => {
+  document.querySelectorAll('.editable-text').forEach((editableText) => {
+    // Exit editable text editor mode (focus) on enter instead of adding a new line.
+    editableText.addEventListener('keydown', (e) => {
+      if (e.keyCode === 13) {
+        e.preventDefault();
+        e.currentTarget.blur();
+      }
+    });
+
+    // Properly paste text into editable text
+    editableText.addEventListener('paste', (e) => {
+      e.preventDefault();
+      DynamicText.handleContentEditablePaste(e)
+    });
+
+    // Disable dragging and dropping text/images into editable text.
+    ["dragover", "drop"].forEach((evt) => {
+      editableText.addEventListener(evt, (e) => {
+        e.preventDefault();
+        return false;
+      });
+    });
+
+    // Store original value when focusing in on specific editable text (used to determine if text was changed and patch request should be sent on focusout.)
+    editableText.addEventListener('focus', (e) => {
+      const target = e.currentTarget;
+      target.setAttribute('data-original-value', target.innerText);
+    });
+
+    // Send patch request for resource if content was changed.
+    editableText.addEventListener('focusout', (e) => {
+      const target = e.currentTarget
+
+      // Empty all content of text if editable text is empty (otherwise certain browsers fill in a default <br> or <p> value.)
+      if (!target.innerText.trim().length) {
+        target.innerText = null;
+      }
+
+      // Send patch request if text was changed.
+      if (target.getAttribute('data-original-value') != target.innerText) {
+        DynamicText.patchResource(e);
+      }
+
+      target.removeAttribute('data-original-value')
+    });
+
+    // Update all other divs tagged with the same dynamic-tag as the current text being edited. (So if you have two elements on one page that display the same property of a resource, both will be updated in real time when you edit the text of one.)
+    editableText.addEventListener('input', (e) => {
+      const target = e.currentTarget;
+      const newValue = target.innerText;
+      const dynamicTag = target.getAttribute('data-dynamic-tag');
+
+      document.querySelectorAll(`[data-dynamic-tag='${dynamicTag}']`)
+        .forEach((dynamicTextElement) => {
+          if(dynamicTextElement !== target) {
+            dynamicTextElement.innerText = newValue;
+          }
+        });
+    });
+  })
+}

data/app/assets/javascripts/dynamic_text/js.js

@@ -13,3 +13,9 @@
 //= require rails-ujs
 //= require activestorage
 //= require_tree .
+
+const events = ["turbolinks:load", "page:change"];
+
+events.forEach((evt) => {
+  document.addEventListener(evt, prepareDynamicText)
+});

data/app/helpers/dynamic_text/view_helper.rb

@@ -1,99 +1,13 @@
 module DynamicText
   module ViewHelper
-    def dynamic_text(text="", tag: "default", filler: "N/A")
-      text = filler if !text || text.empty?
-      content_tag(:span, text, class: "dynamic-text", data: {"dynamic-tag": tag})
+    def dynamic_text_for(resource, attribute, opts={})
+      DynamicText::ViewRenderer.new(self)
+        .render_dynamic_text_for(resource, attribute, opts)
     end
 
-    def editable_text(text="", tag: "default", placeholder: "Enter text...")
-      content_tag(:span, class: "editable-text-container") do
-        content_tag(:span, text, class: "editable-text", contenteditable: true, placeholder: placeholder, data: {"dynamic-tag": tag})
-      end
-    end
-
-    def dynamic_text_for(resource, attribute, options={})
-      options = dynamic_attributes(resource, attribute, options)
-      dynamic_text_tag(options)
-    end
-
-    def editable_text_for(resource, attribute, options = {})
-      options = editable_attributes(resource, attribute, options)
-
-      content_tag(:span, class: "editable-text-container") do
-        editable_text_tag(options) +
-        patch_request_tag(options)
-      end
-    end
-
-    private
-
-    def dynamic_attributes(resource, attribute, options={})
-      Hash.new.tap do |hash|
-        hash[:resource] = resource
-        hash[:attribute] = attribute
-        hash[:value] = resource.send(attribute)
-        hash[:placeholder] = options[:placeholder] || "Enter #{attribute}..."
-        hash[:resource_type] = expected_resource_type(resource)
-        hash[:dynamic_tag] =
-          default_dynamic_tag(hash[:resource_type], resource.id, attribute)
-      end
-    end
-
-    def editable_attributes(resource, attribute, options={})
-      dynamic_attributes(resource, attribute, options={}).tap do |hash|
-        hash[:url] =
-          options[:url] || send("#{DynamicText.configuration.path_prefix}#{hash[:resource_type]}_path", resource)
-        hash[:ajax_key] =
-          options[:ajax_key] || default_ajax_key(hash[:resource_type], attribute)
-      end
-    end
-
-    def dynamic_text_tag(attributes)
-      text = attributes[:value] || attributes[:placeholder]
-      dynamic_text_attributes = {
-        class: "dynamic-text",
-        data: {"dynamic-tag": attributes[:dynamic_tag]}
-      }
-
-      content_tag(:span, text, dynamic_text_attributes)
-    end
-
-    def editable_text_tag(attributes)
-      editable_text_attributes = {
-        class: "editable-text",
-        contenteditable: true,
-        placeholder: attributes[:placeholder],
-        data: {"dynamic-tag": attributes[:dynamic_tag]}
-      }
-
-      content_tag(:span, attributes[:value], editable_text_attributes)
-    end
-
-    def patch_request_tag(attributes)
-      patch_request_attributes = {
-        'url' => attributes[:url],
-        'attribute' => attributes[:attribute],
-        'resource-type' => attributes[:resource_type],
-        'ajax-key' => attributes[:ajax_key]
-      }
-
-      hidden_field_tag("_action", "patch", patch_request_attributes)
-    end
-
-    def expected_resource_type(resource)
-      resource.class.name.downcase
-    end
-
-    def expected_path(resource, resource_type=expected_type_for(resource))
-      send("#{resource_type}_path", resource)
-    end
-
-    def default_dynamic_tag(resource_type, resource_id, attribute)
-      "#{resource_type}:#{resource_id}:#{attribute}"
-    end
-
-    def default_ajax_key(resource_type, attribute)
-      "#{resource_type}:#{attribute}"
+    def editable_text_for(resource, attribute, opts={})
+      DynamicText::ViewRenderer.new(self)
+        .render_editable_text_for(resource, attribute, opts)
     end
   end
 end

data/app/views/dynamic_text/_dynamic_text.html.erb

@@ -0,0 +1,4 @@
+<span class='dynamic-text'
+      data-dynamic-tag='<%= dynamic_tag %>'>
+  <%= value -%>
+</span>

data/app/views/dynamic_text/_editable_text.html.erb

@@ -0,0 +1,20 @@
+<span class='editable-text-container'>
+  <%= content_tag(:span,
+        class: 'editable-text',
+        contenteditable: true,
+        placeholder: placeholder,
+        data: { 'dynamic-tag': dynamic_tag }
+      ) do -%>
+    <%= value -%>
+  <% end %>
+
+  <input id='_action'
+         type='hidden'
+         name='_action'
+         value='patch'
+         url='<%= url %>'
+         attribute='<%= attribute %>'
+         resource-type='<%= resource_type %>'
+         js-key='<%= js_key %>'
+  >
+</span>

data/lib/dynamic_text/configuration.rb

@@ -1,11 +1,11 @@
 class DynamicText::Configuration
-  attr_reader :path_prefix
+  attr_reader :resource_scope
 
   def initialize
-    @path_prefix = nil
+    @resource_scope = nil
   end
 
-  def path_prefix=(prefix)
-    @path_prefix = "#{prefix}_"
+  def resource_scope=(resource_scope)
+    @resource_scope = "/#{resource_scope}"
   end
 end

data/lib/dynamic_text/locals_setter.rb

@@ -0,0 +1,70 @@
+class DynamicText::LocalsSetter
+  def get_dynamic_locals(resource, attribute, opts={})
+    locals.merge!(opts).tap do |locals|
+      locals[:resource] = resource
+      locals[:attribute] = attribute
+      locals[:resource_id] = resource.id
+      locals[:value] = resource.send(attribute)
+      locals[:resource_scope] ||= default_resource_scope
+      locals[:placeholder] ||= default_placeholder
+      locals[:resource_type] ||= default_resource_type
+      locals[:resource_route] ||= default_resource_route
+      locals[:dynamic_tag] ||= default_dynamic_tag
+    end
+  end #PT
+
+  def get_editable_locals(resource, attribute, opts={})
+    get_dynamic_locals(resource, attribute, opts).tap do |locals|
+      locals[:url] ||= default_url
+      locals[:js_key] ||= default_js_key
+    end
+  end #PT
+
+  private
+
+  # Defaults
+
+  def default_resource_scope
+    DynamicText.configuration.resource_scope
+  end
+
+  def default_placeholder
+    "Enter #{get_local(:attribute)}..."
+  end
+
+  def default_resource_type
+    get_local(:resource).class.name.downcase
+  end
+
+  def default_resource_route
+    get_local(:resource_type).pluralize
+  end
+
+  def default_dynamic_tag
+    get_locals(:resource_type, :resource_id, :attribute).join(":")
+  end
+
+  def default_url
+    get_locals(:resource_scope, :resource_route, :resource_id).join("/")
+  end
+
+  def default_js_key
+    get_locals(:resource_type, :attribute).join(":")
+  end
+
+  # Helpers
+
+  def locals
+    @locals ||= {}
+  end
+
+  def get_local(local_name)
+    locals[local_name]
+  end
+
+  def get_locals(*local_names)
+    local_names.collect do |local_name|
+      get_local(local_name)
+    end
+  end
+end

data/lib/dynamic_text/version.rb

@@ -1,3 +1,3 @@
 module DynamicText
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/lib/dynamic_text/view_renderer.rb

@@ -0,0 +1,39 @@
+class DynamicText::ViewRenderer < AbstractController::Base
+  def initialize(controller)
+    @controller = controller
+  end
+
+  def render_dynamic_text_for(resource, attribute, opts={})
+    render_dynamic_text dynamic_locals(resource, attribute, opts)
+  end
+
+  def render_editable_text_for(resource, attribute, opts={})
+    render_editable_text editable_locals(resource, attribute, opts)
+  end
+
+  private
+
+  def dynamic_locals(resource, attribute, opts={})
+    locals_setter.get_dynamic_locals(resource, attribute, opts)
+  end
+
+  def editable_locals(resource, attribute, opts={})
+    locals_setter.get_editable_locals(resource, attribute, opts)
+  end
+
+  def locals_setter
+    DynamicText::LocalsSetter.new
+  end
+
+  def render_editable_text(locals)
+    render_partial(:editable_text, **locals)
+  end
+
+  def render_dynamic_text(locals)
+    render_partial(:dynamic_text, **locals)
+  end
+
+  def render_partial(partial, **locals)
+    @controller.render partial: "dynamic_text/#{partial}", locals: locals
+  end
+end

data/lib/dynamic_text.rb

@@ -1,4 +1,6 @@
 require 'dynamic_text/engine'
+require 'dynamic_text/view_renderer'
+require 'dynamic_text/locals_setter'
 require 'configuron'
 
 module DynamicText

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,4 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css
+//= link editable_text_manifest.js

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require activestorage
+//= require_tree .

data/spec/dummy/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the `rails generate channel` command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/spec/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/spec/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= stylesheet_link_tag    'application', media: 'all' %>
+    <%= javascript_include_tag 'application' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run