administrate-rich-text 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7920470be9deb106cd355f0f0e11cb920c222d291c963a8690e8f69c8676dc16
+  data.tar.gz: db5d55ddcc2adcf6bcdc136eeb75c55e0f355b122e1a307c8748a76caa00223b
+SHA512:
+  metadata.gz: d612426e25b87a9e5f9a51b456e91b2e1c1e8d763a499d5de94105a628c0f58ab2ae06baffa46c618c2a79fb5f45314dcd45d0409bdc80b54a6a76b86834b8d2
+  data.tar.gz: b7bacb5264be003ad0900ea6608a4ffe4fee8751f96dab1ec581ced7aedf35877bcb78220d50b703fb6d480a733cf074043a212e44808e26e79cde6eb01ca31f

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-11-02
+
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in administrate-rich-text.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Benjamin Randles-Dunkley
+
+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,38 @@
+# administrate-rich-text
+> A plugin for Rails 7+ to allow the use of `ActionText` `rich_text_area` fields in [Administrate](https://github.com/thoughtbot/administrate).
+
+`ActionTexct` is based on the [Trix](https://trix-editor.org) WYSIWYG editor.
+
+The Administrate field is compatible with Rails [Active Storage](https://guides.rubyonrails.org/active_storage_overview.html), so Rails will seamlessly handle attachment storage in your Wysiwyg field.
+
+## Install
+
+Add `administrate-rich-text`to your `Gemfile`:
+
+```ruby
+gem 'administrate-rich-text'
+```
+
+Install:
+
+```bash
+$ bundle install
+```
+
+Add javascript and CSS files to the asset pipeline and manifest:
+
+```bash
+$ rails g admin:actiontext_assets
+```
+
+## Usage
+
+Add an `ActionText` `rich_text_area` field to `app/dashboards/foo_dashboard.rb`:
+
+```ruby
+ATTRIBUTE_TYPES = {
+  bar: Field::RichTextArea
+}.freeze
+```
+
+

data/administrate-rich-text.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/administrate/rich/text/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "administrate-rich-text"
+  spec.version = Administrate::Rich::Text::VERSION
+  spec.authors = ["Benjamin Randles-Dunkley", "Oscar Randles-Dunkley"] # "Purr purr mew/,llllwqerp[ooooooooooooosdfa" - Oscar
+  spec.email = ["ben@chemica.co.uk"]
+
+  spec.summary = "Allow rich text editing in Administrate"
+  spec.description = "Incorporate ActionText into Administrate to allow rich text editing in the dashboard."
+  spec.homepage = "https://github.com/chemica/administrate-rich-text"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency 'administrate', '< 1.0.0'
+  spec.add_dependency 'rails', '>= 7.0.0'
+end

data/app/assets/javascripts/administrate-rich-text.js

@@ -0,0 +1,2 @@
+//= require trix
+//= require @rails/actiontext

data/app/assets/stylesheets/administrate-rich-text.scss

@@ -0,0 +1 @@
+@import 'actiontext.css';

data/app/views/fields/rich_text_area/_form.html.erb

@@ -0,0 +1,6 @@
+<div class="field-unit__label">
+  <%= f.label field.attribute %>
+</div>
+<div class="field-unit__field">
+  <%= f.rich_text_area field.attribute %>
+</div>

data/app/views/fields/rich_text_area/_index.html.erb

@@ -0,0 +1 @@
+<%= field.to_s %>

data/app/views/fields/rich_text_area/_show.html.erb

@@ -0,0 +1 @@
+<%= field.to_s %>

data/lib/administrate/field/rich_text_area.rb

@@ -0,0 +1,18 @@
+require 'rails'
+require 'administrate/field/base'
+require 'administrate/engine'
+
+module Administrate
+  module Field
+    class RichTextArea < Administrate::Field::Base
+      class Engine < ::Rails::Engine
+        Administrate::Engine.add_javascript 'administrate-rich-text'
+        Administrate::Engine.add_stylesheet 'administrate-rich-text'
+      end
+
+      def to_s
+        data
+      end
+    end
+  end
+end

data/lib/administrate/rich/text/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Administrate
+  module Rich
+    module Text
+      VERSION = "0.0.2"
+    end
+  end
+end

data/lib/administrate/rich/text.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+require "administrate/field/rich_text_area"
+require_relative "text/version"
+
+module Administrate
+  module Rich
+    module Text
+    end
+  end
+end

data/lib/generators/admin/actiontext_assets/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Add the admin JS file for rich text fields in Administrate
+
+Example:
+    bin/rails generate admin_js
+
+    This will create:
+        app/javascript/administrate-rich-text.js

data/lib/generators/admin/actiontext_assets/actiontext_assets_generator.rb

@@ -0,0 +1,18 @@
+module Admin
+  class ActiontextAssetsGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    def create_admin_js
+      template "administrate-rich-text.js.erb", "app/javascript/administrate-rich-text.js"
+
+      manifest_file = "app/assets/config/manifest.js"
+
+
+      if File.exist?(manifest_file)
+        append_to_file manifest_file do
+          "\n//= link administrate-rich-text.css\n//= link administrate-rich-text.js"
+        end
+      end
+    end
+  end
+end

data/lib/generators/admin/actiontext_assets/templates/administrate-rich-text.js.erb

@@ -0,0 +1,2 @@
+import "trix";
+import "@rails/actiontext";

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: administrate-rich-text
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Benjamin Randles-Dunkley
+- Oscar Randles-Dunkley
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: administrate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+description: Incorporate ActionText into Administrate to allow rich text editing in
+  the dashboard.
+email:
+- ben@chemica.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- administrate-rich-text.gemspec
+- app/assets/javascripts/administrate-rich-text.js
+- app/assets/stylesheets/administrate-rich-text.scss
+- app/views/fields/rich_text_area/_form.html.erb
+- app/views/fields/rich_text_area/_index.html.erb
+- app/views/fields/rich_text_area/_show.html.erb
+- lib/administrate/field/rich_text_area.rb
+- lib/administrate/rich/text.rb
+- lib/administrate/rich/text/version.rb
+- lib/generators/admin/actiontext_assets/USAGE
+- lib/generators/admin/actiontext_assets/actiontext_assets_generator.rb
+- lib/generators/admin/actiontext_assets/templates/administrate-rich-text.js.erb
+homepage: https://github.com/chemica/administrate-rich-text
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/chemica/administrate-rich-text
+  source_code_uri: https://github.com/chemica/administrate-rich-text
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Allow rich text editing in Administrate
+test_files: []