rails_admin_tinymce 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cedeeebac43b6f1eda386c61daf29c77da7d33792d3adbed2e7c8faffbbd6722
+  data.tar.gz: 54c02a14c7b1470d5beaf41eec8d0eab756f502c821aeecce1356334ce2da02d
+SHA512:
+  metadata.gz: 5292d6114ba5cd034a5d5d210484eee4c718050ecc05a40915bdd181242a470d238cc062309eaa07720f98e9f137b88f696673c9c673ad4be4301348ce4c3d4c
+  data.tar.gz: a1e93c814d958cd97314fa4a752d43bc73ed305ef803975540031825aff8d5b9fb2a9e9ae173042aa007e6d276652e82257f562556c959146fd581182fe2d41d

data/README.md

@@ -0,0 +1,75 @@
+# TinyMCE plugin for `rails_admin`
+
+[![Gem Version](https://badge.fury.io/rb/rails_admin_tinymce.svg)](https://badge.fury.io/rb/rails_admin_tinymce)
+
+[RailsAdmin](https://github.com/sferik/rails_admin) extension for enabling the [TinyMCE](https://www.tiny.cloud/) editor.
+
+- Does not yet support ActiveStorage for image/files.
+- Tested with [tinymce-rails](https://github.com/spohlenz/tinymce-rails) 6.7.2.
+- Turbo Drive is supported (even though tinymce-rails doesn't support it yet).
+
+## Installation
+
+To enable **rails_admin_tinymce**, add the following to your `Gemfile`:
+
+```ruby
+gem 'rails_admin'
+gem 'rails_admin_tinymce'
+```
+
+Then create `config/tinymce.yml` according to step 2 of [tinymce-rails' instructions](https://github.com/spohlenz/tinymce-rails#instructions).
+
+Finally make sure the TinyMCE Javascript is loaded. That may differ depending on how you're using Javascript in Ruby on Rails.
+
+### Importmap
+
+Add to `importmap.rails_admin.rb`:
+
+```rb
+pin 'tinymce'
+pin 'tinymce.rails_admin'
+```
+
+Add to `rails_admin.js`:
+
+```javascript
+import 'tinymce';
+import 'tinymce.rails_admin';
+```
+
+### Bundler
+
+TODO
+
+## Configuration
+
+```ruby
+RailsAdmin.config do |config|
+  config.model Team do
+    edit do
+      field :description, :tinymce
+    end
+  end
+end
+```
+
+Or, you can provide more options to customize:
+
+```ruby
+RailsAdmin.config do |config|
+  config.model Team do
+    edit do
+      field :description, :tinymce do
+        # choose another configuration set from tinymce.yml
+        config 'alternate'
+        # or override specific options, see https://www.tiny.cloud/docs/tinymce/6/basic-setup/
+        options ({ plugins: [:image, :link] })
+      end
+    end
+  end
+end
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/app/assets/javascripts/tinymce.rails_admin.js.erb

@@ -0,0 +1,45 @@
+// assumes we are loaded after TinyMCERails
+<% TinyMCE::Rails.each_configuration do |name, config| %>
+TinyMCERails.configuration.<%= name %> = <%= config.to_javascript %>;
+<% end %>
+
+(function() {
+  function initTinyMCERails() {
+    // get config and options from data attributes
+    document.querySelectorAll('[data-tinymce-config]').forEach(function (el) {
+      var config = el.getAttribute('data-tinymce-config');
+      var options = JSON.parse(el.getAttribute('data-tinymce-options') || '{}');
+      // override selector, we already have the element
+      options.selector = null;
+      options.target = el;
+      TinyMCERails.initialize(config, options);
+    });
+  }
+
+  // Setup TinyMCE after first page load
+  document.addEventListener('DOMContentLoaded', function() {
+    initTinyMCERails();
+  });
+  // Make Turbo work
+  if (typeof Turbo != 'undefined' && Turbo.session.enabled) {
+    // Remove all TinyMCE instances before moving away
+    document.addEventListener('turbo:before-fetch-response', function() {
+      tinymce.remove();
+    });
+    // Reload TinyMCE after new content is loaded
+    document.addEventListener('turbo:load', function() {
+      initTinyMCERails();
+    });
+  }
+  // Make Turbolinks work
+  if (typeof Turbolinks != 'undefined' && Turbolinks.supported) {
+    // Remove all TinyMCE instances before initializing again
+    document.addEventListener('turbolinks:before-render', function() {
+      tinymce.remove();
+    });
+    // Reload TinyMCE after new content is loaded
+    document.addEventListener('turbolinks:load', function() {
+      initTinyMCERails();
+    });
+  }
+})();

data/app/views/rails_admin/main/_form_tinymce.html.erb

@@ -0,0 +1,8 @@
+<%
+  data_attrs = field.html_attributes.fetch('data', {})
+  html_attrs = field.html_attributes.reverse_merge(data: data_attrs.reverse_merge({
+    'tinymce-config' => field.config,
+    'tinymce-options' => field.options.to_json
+  }))
+%>
+<%= form.text_area field.method_name, html_attrs.reverse_merge({ value: field.form_value }) %>

data/lib/rails_admin_tinymce/engine.rb

@@ -0,0 +1,7 @@
+module RailsAdminTinymce
+  class Railtie < ::Rails::Engine
+    initializer "RailsAdminTinyMCE precompile hook", group: :all do |app|
+      app.config.assets.precompile += ['tinymce.rails_admin.js']
+    end
+  end
+end

data/lib/rails_admin_tinymce/version.rb

@@ -0,0 +1,3 @@
+module RailsAdminTinymce
+  VERSION = "0.1.0"
+end

data/lib/rails_admin_tinymce.rb

@@ -0,0 +1,47 @@
+require "rails_admin_tinymce/version"
+require "rails_admin_tinymce/engine"
+require "tinymce-rails"
+
+module RailsAdminTinymce
+  # Your code goes here...
+end
+
+require 'rails_admin/config/fields'
+require 'rails_admin/config/fields/base'
+
+module RailsAdmin
+  module Config
+    module Fields
+      module Types
+        class Tinymce < Text
+          # Register field type for the type loader
+          RailsAdmin::Config::Fields::Types.register(self)
+
+          register_instance_option :config do
+            :default
+          end
+
+          register_instance_option :options do
+            {}
+          end
+
+          register_instance_option :partial do
+            :form_tinymce
+          end
+        end
+      end
+    end
+  end
+end
+
+
+RailsAdmin::Config::Fields.register_factory do |parent, properties, fields|
+  if properties.name == :tinymce
+    fields << RailsAdmin::Config::Fields::Types::Tinymce.new(parent, properties.name, properties)
+    true
+  else
+    false
+  end
+end
+
+

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: rails_admin_tinymce
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- wvengen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: rails_admin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: tinymce-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- dev-rails@willem.engen.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/assets/javascripts/tinymce.rails_admin.js.erb
+- app/views/rails_admin/main/_form_tinymce.html.erb
+- lib/rails_admin_tinymce.rb
+- lib/rails_admin_tinymce/engine.rb
+- lib/rails_admin_tinymce/version.rb
+homepage: https://github.com/wvengen/rails_admin_tinymce
+licenses: []
+metadata:
+  homepage_uri: https://github.com/wvengen/rails_admin_tinymce
+  source_code_uri: https://github.com/wvengen/rails_admin_tinymce
+  changelog_uri: https://github.com/wvengen/rails_admin_tinymce/releases
+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.4.21
+signing_key: 
+specification_version: 4
+summary: TinyMCE editor for rails_admin
+test_files: []