hugerte-rails 1.0.9.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 853e36941b21ff9601cc7512e7999c768158cd5a90dceed0c7bbf48d63ce2d79
+  data.tar.gz: dd99c1395cb74de4f4d8356a93403e0ec39734a2a67face77e7d37230a40101e
+SHA512:
+  metadata.gz: b0475932b6df567a6c100674df2bbdab0f4ffd98223daa8050976dcff16c9064fe47dd75885e9de9c15217038ea35d001276141a754a5a5849f12433d68cb7e7
+  data.tar.gz: dec527aba2279bc3e7b70233028a919fdf8ceeb93b0209527483b8f378bad49b47783ba631591c702b3565a4aed0d3677854ab149955084402a8b5d504d37992

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (C) 2011-25 by Liberaldev, Sam Pohlenz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,171 @@
+Rails Integration for TinyMCE
+=============================
+
+The `hugerte-rails` gem integrates the [HugeRTE](https://hugerte.org/) editor with the Rails asset pipeline.
+
+This gem is compatible with Rails 6.0 and higher.
+
+[![Build Status](https://img.shields.io/github/actions/workflow/status/liberaldev/hugerte-rails/rspec.yml)](https://github.com/liberaldev/hugerte-rails/actions)
+
+
+Instructions
+------------
+
+**1. Add `hugerte-rails` to your Gemfile**
+
+```ruby
+gem 'hugerte-rails'
+```
+
+Be sure to add to the global group, not the `assets` group. Then run `bundle install`.
+
+
+**2. Create a `config/hugerte.yml` file with your global configuration options:**
+
+```yml
+toolbar:
+  - styleselect | bold italic | undo redo
+  - image | link
+plugins:
+  - image
+  - link
+```
+
+The Rails server no longer needs to be restarted when this file is updated in development mode.
+
+To define multiple configuration sets, follow this syntax (a default configuration must be specified):
+
+```yml
+default: &default
+  plugins:
+    - image
+    - link
+
+alternate:
+  <<: *default
+  toolbar: styleselect | bold italic | undo redo | table
+  plugins:
+    - table
+```
+
+See the [TinyMCE 6 Documentation](https://www.tiny.cloud/docs/tinymce/6/) for a full list of configuration options.
+
+**3. Include the TinyMCE assets**
+
+Use *one* of the following options to include TinyMCE assets.
+
+(1) Add to your application.js (Sprockets only):
+
+```js
+//= require hugerte
+```
+
+or (2) add the script tag to your layout using the `hugerte_assets` helper:
+
+```erb
+<%= hugerte_assets data: { turbo_track: "reload" } %>
+#=> <script type="text/javascript" src="/assets/hugerte.js" data-turbo-track="reload">
+```
+
+When using Propshaft, the `hugerte_assets` helper adds multiple script tags including the pre-init code (available via the `hugerte_preinit` helper), as well as `hugerte/hugerte.js` and `hugerte/rails.js`. You may prefer to selectively include these manually depending on your requirements.
+
+For Sprockets, these are bundled together into one script tag.
+
+
+**4. Initialize TinyMCE**
+
+For each textarea that you want to use with TinyMCE, add the "hugerte" class and ensure it has a unique ID:
+
+```erb
+<%= text_area_tag :content, "", class: "hugerte", rows: 40, cols: 120 %>
+```
+
+or if you are using Rails' form builders:
+
+```erb
+<%= f.text_area :content, class: "hugerte", rows: 40, cols: 120 %>
+```
+
+Then invoke the `hugerte` helper to initialize TinyMCE:
+
+```erb
+<%= hugerte %>
+```
+
+Custom options can be passed to `hugerte` to override the global options specified in `config/hugerte.yml`:
+
+```erb
+<%= hugerte theme: "simple", language: "de", plugins: ["wordcount", "paste"] %>
+```
+
+Alternate configurations defined in 'config/hugerte.yml' can be used with:
+
+```erb
+<%= hugerte :alternate %>
+```
+
+
+Language Packs
+--------------
+
+See the [liberaldev-rails-langs](https://github.com/liberaldev/hugerte-rails-langs) gem for additional language packs for HugeRTE.
+
+
+Manual Initialization
+---------------------
+
+Using the `hugerte` helper and global configuration file is entirely optional. The `hugerte.init` JS function can be invoked manually if desired.
+
+```erb
+<%= text_area_tag :editor, "", rows: 40, cols: 120 %>
+
+<script type="text/javascript">
+  hugerte.init({
+    selector: 'textarea.editor'
+  });
+</script>
+```
+
+
+Asset Compilation
+-----------------
+
+Since TinyMCE loads most of its files dynamically, some workarounds are required to ensure that the TinyMCE asset files are accessible using non-digested filenames.
+
+As of hugerte-rails 3.5.11, 4.1.10 and 4.2.1, two alternative asset installation methods are available, which can be changed by setting `config.hugerte.install` within your `config/application.rb` file. These methods are called when you run `rake asset:precompile` (via `Rake::Task#enhance`) after the regular application assets are compiled.
+
+The default method (as of 4.5.2), `compile`, adds the TinyMCE paths to the Sprockets precompilation paths and then creates symlinks from the non-digested filenames to their digested versions.
+
+```ruby
+config.hugerte.install = :compile
+```
+
+If you experience issues with the `compile` method, you may wish to use the `copy` method instead, which copies the TinyMCE assets directly into `public/assets` and appends the file information into the asset manifest. The `copy_no_preserve` method is also available of you do not wish to or cannot preserve file modes on your filesystem.
+
+```ruby
+config.hugerte.install = :copy
+```
+
+If you are including TinyMCE via `application.js` or using the `hugerte_assets` helper, you do not need to manually add the scripts to the Sprockets precompile paths.
+
+
+Custom Plugins & Skins
+----------------------
+
+To use custom plugins or skins, simply add the files to your asset load path so that they are locatable at a path beneath `hugerte/plugins/` or `hugerte/skins/`.
+
+For example, a plugin called `mycustomplugin` could have its main JS file at `app/assets/javascripts/hugerte/plugins/mycustomplugin/plugin.js`.
+
+You should also ensure that your custom paths are added to the asset precompile paths.
+
+
+Using hugerte-rails as an Engine Dependency
+-------------------------------------------
+
+Ensure that you explicitly require `hugerte-rails` within your engine file. Including hugerte-rails as a dependency in your gemspec is not enough.
+
+
+Updating
+--------
+
+When new versions of TinyMCE are released, simply update the `hugerte-rails` gem to the latest version. There is no need to run any extra rake tasks (apart from `rake assets:precompile`).

data/Rakefile

@@ -0,0 +1,64 @@
+require File.expand_path('../lib/hugerte/rails/version', __FILE__)
+
+def step(name)
+  print "#{name} ..."
+  yield
+  puts " DONE"
+end
+
+def download(url, filename)
+  puts "Downloading #{url} ..."
+  `mkdir -p tmp`
+  `curl -L -# #{url} -o tmp/#{filename}`
+end
+
+desc "Update HugeRTE to version #{HugeRTE::Rails::HUGERTE_VERSION}"
+task :update => [ :fetch, :extract, :rename ]
+
+task :fetch do
+  download("https://github.com/hugerte/hugerte-dist/archive/refs/tags/v#{HugeRTE::Rails::HUGERTE_VERSION}.zip", "hugerte.zip")
+end
+
+task :extract do
+  step "Extracting core files" do
+    `rm -rf tmp/hugerte-dist-*`
+    `unzip -u tmp/hugerte.zip -d tmp`
+    `rm -rf vendor/assets/javascripts/hugerte`
+    `mkdir -p vendor/assets/javascripts/hugerte`
+    `cp -r tmp/hugerte-dist-#{HugeRTE::Rails::HUGERTE_VERSION}/* vendor/assets/javascripts/hugerte/`
+  end
+
+  step "Extracting unminified source" do
+   `mkdir -p app/assets/source/hugerte`
+   `mv tmp/hugerte-dist-#{HugeRTE::Rails::HUGERTE_VERSION}/hugerte.js app/assets/source/hugerte/hugerte.js`
+   `rm -rf tmp/hugerte-dist-#{HugeRTE::Rails::HUGERTE_VERSION}`
+  end
+end
+
+task :rename do
+  step "Renaming files" do
+    Dir["vendor/assets/javascripts/hugerte/**/*.min.js"].each do |min_file|
+      js_file = min_file.sub(/\.min\.js$/, '.js')
+      if File.exist?(js_file)
+        FileUtils.rm(js_file)
+        FileUtils.mv(min_file, js_file)
+        puts "Replaced #{js_file} with #{min_file}"
+      end
+    end
+
+    Dir["vendor/assets/javascripts/hugerte/**/*.min.css"].each do |min_file|
+      css_file = min_file.sub(/\.min\.css$/, '.css')
+      if File.exist?(css_file)
+        FileUtils.rm(css_file)
+        FileUtils.cp(min_file, css_file)
+        puts "Replaced #{css_file} with #{min_file}"
+      end
+    end
+  end
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+require "bundler/gem_tasks"

data/app/assets/javascripts/hugerte/rails.js

@@ -0,0 +1,51 @@
+window.HugeRTERails = {
+  configuration: {
+    default: {}
+  },
+
+  initialize: function(config, options) {
+    if (typeof hugeRTE != 'undefined') {
+      // Merge the custom options with the given configuration
+      var configuration = HugeRTERails.configuration[config || 'default'];
+      configuration = HugeRTERails._merge(configuration, options);
+
+      hugeRTE.init(configuration);
+    } else {
+      // Wait until HugeRTE is loaded
+      setTimeout(function() {
+        HugeRTERails.initialize(config, options);
+      }, 50);
+    }
+  },
+
+  setupTurbolinks: function() {
+    // Remove all HugeRTE instances before rendering
+    document.addEventListener('turbolinks:before-render', function() {
+      hugeRTE.remove();
+    });
+  },
+
+  _merge: function() {
+    var result = {};
+
+    for (var i = 0; i < arguments.length; ++i) {
+      var source = arguments[i];
+
+      for (var key in source) {
+        if (Object.prototype.hasOwnProperty.call(source, key)) {
+          if (Object.prototype.toString.call(source[key]) === '[object Object]') {
+            result[key] = HugeRTERails._merge(result[key], source[key]);
+          } else {
+            result[key] = source[key];
+          }
+        }
+      }
+    }
+
+    return result;
+  }
+};
+
+if (typeof Turbolinks != 'undefined' && Turbolinks.supported) {
+  HugeRTERails.setupTurbolinks();
+}