diff --git a/.circleci/config.yml b/.circleci/config.yml deleted file mode 100644 index d766f6a..0000000 --- a/.circleci/config.yml +++ /dev/null @@ -1,33 +0,0 @@ -version: 2.1 -orbs: - ruby: circleci/ruby@0.1.2 - -jobs: - build: - docker: - - image: circleci/ruby:2.6.6-stretch-node-browsers - executor: ruby/default - steps: - - checkout - - restore_cache: - key: gem-cache-{{ checksum "activeadmin_quill_editor.gemspec" }} - - run: - name: Setup Bundler - command: gem install bundler - - run: - name: Bundle Install - command: bundle install --path vendor/bundle - - save_cache: - key: gem-cache-{{ checksum "activeadmin_quill_editor.gemspec" }} - paths: vendor/bundle - - run: - name: Run Specs - command: | - bin/rspec \ - --profile 10 \ - --format RspecJunitFormatter \ - --out test_results/rspec.xml \ - --format progress \ - $(circleci tests glob "spec/**/*_spec.rb") - - store_test_results: - path: test_results diff --git a/.github/workflows/brakeman-analysis.yml b/.github/workflows/brakeman-analysis.yml deleted file mode 100644 index 4b8f33e..0000000 --- a/.github/workflows/brakeman-analysis.yml +++ /dev/null @@ -1,44 +0,0 @@ -# This workflow integrates Brakeman with GitHub's Code Scanning feature -# Brakeman is a static analysis security vulnerability scanner for Ruby on Rails applications - -name: Brakeman Scan - -# This section configures the trigger for the workflow. Feel free to customize depending on your convention -on: - push: - branches: [ "master", "main" ] - pull_request: - branches: [ "master", "main" ] - -jobs: - brakeman-scan: - name: Brakeman Scan - runs-on: ubuntu-latest - steps: - # Checkout the repository to the GitHub Actions runner - - name: Checkout - uses: actions/checkout@v2 - - # Customize the ruby version depending on your needs - - name: Setup Ruby - uses: actions/setup-ruby@v1 - with: - ruby-version: '2.7' - - - name: Setup Brakeman - env: - BRAKEMAN_VERSION: '4.10' # SARIF support is provided in Brakeman version 4.10+ - run: | - gem install brakeman --version $BRAKEMAN_VERSION - - # Execute Brakeman CLI and generate a SARIF output with the security issues identified during the analysis - - name: Scan - continue-on-error: true - run: | - brakeman -f sarif -o output.sarif.json . - - # Upload the SARIF file generated in the previous step - - name: Upload SARIF - uses: github/codeql-action/upload-sarif@v1 - with: - sarif_file: output.sarif.json diff --git a/.github/workflows/specs.yml b/.github/workflows/specs.yml new file mode 100644 index 0000000..2eab4dc --- /dev/null +++ b/.github/workflows/specs.yml @@ -0,0 +1,26 @@ +name: Specs + +on: + push: + branches: [master] + pull_request: + branches: [master] + +jobs: + specs: + runs-on: ubuntu-latest + + strategy: + matrix: + ruby: ['2.5', '2.6', '2.7'] + + steps: + - name: Checkout + uses: actions/checkout@v2 + - name: Set up Ruby + uses: ruby/setup-ruby@v1 + with: + ruby-version: ${{ matrix.ruby }} + bundler-cache: true # runs 'bundle install' and caches installed gems automatically + - name: Run tests + run: bundle exec rake diff --git a/README.md b/README.md index 19d1ac3..f26af6e 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@ -# ActiveAdmin Quill Editor [![Gem Version](https://badge.fury.io/rb/activeadmin_quill_editor.svg)](https://badge.fury.io/rb/activeadmin_quill_editor) [![CircleCI](https://circleci.com/gh/blocknotes/activeadmin_quill_editor.svg?style=svg)](https://circleci.com/gh/blocknotes/activeadmin_quill_editor) +# ActiveAdmin Quill Editor [![Gem Version](https://badge.fury.io/rb/activeadmin_quill_editor.svg)](https://badge.fury.io/rb/activeadmin_quill_editor) [![Specs](https://github.com/blocknotes/activeadmin_quill_editor/actions/workflows/specs.yml/badge.svg)](https://github.com/blocknotes/activeadmin_quill_editor/actions/workflows/specs.yml) An Active Admin plugin to use [Quill Rich Text Editor](https://github.com/quilljs/quill) in form fields. ![screenshot](screenshot.png) ## Install + After installing Active Admin, add to your Gemfile: `gem 'activeadmin_quill_editor'` (and execute *bundle*) If you installed Active Admin without Webpacker support (default for now): @@ -34,6 +35,7 @@ require('activeadmin_quill_editor') ``` ## Usage + In your Active Admin models, form configuration, set the text inputs with `as: :quill_editor` where needed. **data-options**: permits to set *quill editor* options directly - see [options list](https://quilljs.com/docs/configuration/) @@ -61,6 +63,7 @@ f.input :description, as: :quill_editor, input_html: { data: { options: { module ``` ### ImageUploader plugin + This plugin allows to upload images to the server (instead of storing them in *base64* by default), reference [here](https://github.com/NoelOConnell/quill-image-uploader). ```ruby @@ -87,13 +90,16 @@ the *upload_admin_post_path*) and it doesn't provide a way to remove images (jus the editor will not destroy them, you'll need to implement a purge logic for that). ## Do you like it? Star it! + If you use this component just star it. A developer is more motivated to improve a project when there is some interest. My other [Active Admin components](https://github.com/blocknotes?utf8=✓&tab=repositories&q=activeadmin&type=source). 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).