activeadmin_quill_editor 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf94d0ea455088b72ac7be86f3806c05b198382a4ea60dd764478802e8a96a71
-  data.tar.gz: 5b33ccb578cf5a7ea15a713faf72198cb0832fb6674aa2909a4af76520afb723
+  metadata.gz: 166486f6d1608e906d42b3b17c5123b6366c5de0b6bbdd8e1f3dc8a66acbf4a0
+  data.tar.gz: f2cdcf461d5a116496768d63e015ef0fdbe07dcafc5ee0ff8a5a740dfae3737d
 SHA512:
-  metadata.gz: 10c3d5a3d71cea53b2f3eb4eb57739aac06a6f3059e5813732bb1606765e76683809142bec4b5471f9a646f9de7214a20f3ffd6919295f76c361fd1d237e29bc
-  data.tar.gz: 64880dab1738516ac61fcf91b1251c1f0127eaeec1ded2ec011d113bccca8466a62eaae6756b6870808c1b891348b2d969cde469ee25476be20e21eada4fabb4
+  metadata.gz: ccb3e2bf4f7fd563d5dc78b6b1e05faaacd3791e67bccc14e3f8169375b2fae05824a8f45bf689178156fe9cd196a78922612ca02e73954c72ecdd6b6457fce4
+  data.tar.gz: 767180a9419b8883ecf931ac88f2fb1a2b8501dd280458204ec3ab65aeac1e2b122102c4624a058136b29d66843a4d0661d3071342228fe9bfa52f7ca72f1150

data/README.md

@@ -2,8 +2,12 @@
 [![gem version](https://badge.fury.io/rb/activeadmin_quill_editor.svg)](https://badge.fury.io/rb/activeadmin_quill_editor)
 [![gem downloads](https://badgen.net/rubygems/dt/activeadmin_quill_editor)](https://rubygems.org/gems/activeadmin_quill_editor)
 [![linters](https://github.com/blocknotes/activeadmin_quill_editor/actions/workflows/linters.yml/badge.svg)](https://github.com/blocknotes/activeadmin_quill_editor/actions/workflows/linters.yml)
+
 [![specs Rails 6.1](https://github.com/blocknotes/activeadmin_quill_editor/actions/workflows/specs_rails61.yml/badge.svg)](https://github.com/blocknotes/activeadmin_quill_editor/actions/workflows/specs_rails61.yml)
 [![specs Rails 7.0](https://github.com/blocknotes/activeadmin_quill_editor/actions/workflows/specs_rails70.yml/badge.svg)](https://github.com/blocknotes/activeadmin_quill_editor/actions/workflows/specs_rails70.yml)
+[![Specs Rails 7.1](https://github.com/blocknotes/activeadmin_quill_editor/actions/workflows/specs_rails71.yml/badge.svg)](https://github.com/blocknotes/activeadmin_quill_editor/actions/workflows/specs_rails71.yml)
+[![Specs Rails 7.2](https://github.com/blocknotes/activeadmin_quill_editor/actions/workflows/specs_rails72.yml/badge.svg)](https://github.com/blocknotes/activeadmin_quill_editor/actions/workflows/specs_rails72.yml)
+[![Specs Rails 8.0](https://github.com/blocknotes/activeadmin_quill_editor/actions/workflows/specs_rails80.yml/badge.svg)](https://github.com/blocknotes/activeadmin_quill_editor/actions/workflows/specs_rails80.yml)
 
 An Active Admin plugin to use [Quill Rich Text Editor](https://github.com/quilljs/quill) in form fields.
 
@@ -101,9 +105,62 @@ Consider that this is just a basic example: images are uploaded as soon as they
 the *upload_admin_post_path*) and it doesn't provide a way to remove images (just deleting them from
 the editor will not destroy them, you'll need to implement a purge logic for that).
 
-## Changelog
+## Javascript API
+
+Some methods are provided for advanced use cases:
+
+- `window.getQuillEditors()`: returns all the available Quill editors instances;
+- `window.getQuillEditorByIndex(n)`: returns the N-th Quill editor instance;
+- `window.getQuillEditorByElementId(id)`: returns the Quill editor instance related to the specified element id (e.g. _article_description_).
+
+## Development
+
+Project created by [Mattia Roccoberton](http://blocknot.es), thanks also to the good guys that opened issues and pull requests from time to time.
+
+There 3 ways to interact with this project:
+
+1) Using Docker:
+
+```sh
+# Run rails server on the dummy app (=> http://localhost:3000 to access to ActiveAdmin):
+make up
+# Enter in a Rails console (with the dummy app started):
+make console
+# Enter in a shell (with the dummy app started):
+make shell
+# Run the linter on the project (with the dummy app started):
+make lint
+# Run the test suite (with the dummy app started):
+make specs
+# Remove container and image:
+make cleanup
+# To try different versions of Ruby/Rails/ActiveAdmin edit docker-compose.yml
+# For more commands please check the Makefile
+```
 
-The changelog is available [here](CHANGELOG.md).
+2) Using Appraisal:
+
+```sh
+export RAILS_ENV=development
+# Install dependencies
+bin/appraisal
+# Run server (or any command)
+bin/appraisal rails s
+# Or with specific versions
+bin/appraisal rails71-activeadmin rails s
+```
+
+3) With a local setup:
+
+```sh
+# Dev setup (set the required envs)
+source extra/dev_setup.sh
+# Install dependencies
+bundle
+# Run server (or any command)
+bin/rails s
+# To try different versions of Rails/ActiveAdmin edit extra/dev_setup.sh
+```
 
 ## Do you like it? Star it!
 
@@ -111,11 +168,6 @@ If you use this component just star it. A developer is more motivated to improve
 
 Or consider offering me a coffee, it's a small thing but it is greatly appreciated: [about me](https://www.blocknot.es/about-me).
 
-## Contributors
-
-- [Mattia Roccoberton](http://blocknot.es): author
-- The good guys that opened issues and pull requests from time to time
-
 ## License
 
 The gem is available as open-source under the terms of the [MIT](LICENSE.txt).

data/app/assets/javascripts/activeadmin/quill_editor_input.js

@@ -1,3 +1,4 @@
+/* eslint-disable no-undef */
 (function () {
   'use strict'
 
@@ -73,6 +74,9 @@
             method: 'POST'
           }).then(response => response.json())
             .then(result => {
+              if (!result.url) {
+                reject('Upload failed')
+              }
               resolve(result.url);
             })
             .catch(error => {
@@ -84,6 +88,27 @@
     }
   }
 
+  // --- public functions --------------------------------------------------------
+  window.getQuillEditors = function() {
+    const editors = document.querySelectorAll('[data-aa-quill-editor]')
+    let list = []
+
+    editors.forEach(function(editor) { list.push(editor['_quill-editor']) })
+    return list
+  }
+
+  window.getQuillEditorByIndex = function(index) {
+    const editors = document.querySelectorAll('[data-aa-quill-editor]')
+
+    return (index >= 0 && index < editors.length) ? editors[index]['_quill-editor'] : null
+  }
+
+  window.getQuillEditorByElementId = function(id) {
+    const editor = document.querySelector(`[data-aa-quill-editor]#${id}`)
+
+    return editor ? editor['_quill-editor'] : null
+  }
+
   // --- events ------------------------------------------------------------------
   $(document).ready(initQuillEditors)
   $(document).on('has_many_add:after', '.has_many_container', initQuillEditors)

data/lib/activeadmin/quill_editor/version.rb

@@ -2,7 +2,7 @@
 
 module ActiveAdmin
   module QuillEditor
-    VERSION = '1.2.0'
+    VERSION = '1.3.0'
     QUILL_VERSION = '1.3.7'
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: activeadmin_quill_editor
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Mattia Roccoberton
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-29 00:00:00.000000000 Z
+date: 2025-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeadmin
@@ -76,7 +75,6 @@ metadata:
   changelog_uri: https://github.com/blocknotes/activeadmin_quill_editor/blob/main/CHANGELOG.md
   source_code_uri: https://github.com/blocknotes/activeadmin_quill_editor
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -91,8 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Quill Editor for ActiveAdmin
 test_files: []