richer_text 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e3e144daed92cf04465df7c11e55a30bec134bd6abd083b2ce76b078eb579323
+  data.tar.gz: 348c16817e8d8faad41627f985bb6d4dbf7392cd67d04b9faed369cd2ade73a5
+SHA512:
+  metadata.gz: 4e73645fe681761bc2941cc3814f4ecc2e84c6ad55060e4a62e84351393a6e6fe089a511c4e1a92072c52c6bc9a971d754706df22b57604789d3efc0dd44359e
+  data.tar.gz: 78bfe77159991d5449f5bfb57dd9727bc5aafa87d648f06913089e791ca69165eab938f8095c82f408a78727c1620f1011fff99803db8dcb7ff53ca22c97f8ee

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 Andrea Fomera
+
+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,28 @@
+# RicherText
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "richer_text"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install richer_text
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/richer_text_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/richer_text .css

data/app/assets/stylesheets/richer_text/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/richer_text/application_controller.rb

@@ -0,0 +1,4 @@
+module RicherText
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/richer_text/application_helper.rb

@@ -0,0 +1,4 @@
+module RicherText
+  module ApplicationHelper
+  end
+end

data/app/jobs/richer_text/application_job.rb

@@ -0,0 +1,4 @@
+module RicherText
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/richer_text/application_mailer.rb

@@ -0,0 +1,6 @@
+module RicherText
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/richer_text/application_record.rb

@@ -0,0 +1,5 @@
+module RicherText
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/richer_text/rich_text.rb

@@ -0,0 +1,23 @@
+module RicherText
+  class RichText < ApplicationRecord
+    belongs_to :record, polymorphic: true
+
+    serialize :body, RicherText::Content
+
+    delegate :to_s, :nil?, to: :body
+
+    has_many_attached :images
+
+    before_save :update_images
+
+    def to_html
+      body&.to_html
+    end
+
+    private
+
+    def update_images
+      self.images = body.image_blobs if body.present?
+    end
+  end
+end

data/app/views/layouts/richer_text/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Richer text</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "richer_text/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+RicherText::Engine.routes.draw do
+end

data/db/migrate/20230107020316_create_richer_text_rich_texts.rb

@@ -0,0 +1,13 @@
+class CreateRicherTextRichTexts < ActiveRecord::Migration[7.0]
+  def change
+    create_table :richer_text_rich_texts do |t|
+      t.string :name, null: false
+      t.text :body, size: :long
+      t.references :record, null: false, polymorphic: true
+
+      t.timestamps
+
+      t.index [:record_type, :record_id, :name], name: "index_richer_texts_rich_texts_uniqueness", unique: true
+    end
+  end
+end

data/lib/richer_text/attribute.rb

@@ -0,0 +1,37 @@
+module RicherText
+  module Attribute
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def has_richer_text(name)
+        class_eval <<-CODE, __FILE__, __LINE__ + 1
+          def #{name}
+            richer_text_#{name} || build_richer_text_#{name}
+          end
+
+          def #{name}?
+            richer_text_#{name}.present?
+          end
+
+          def #{name}=(body)
+            self.#{name}.body = body
+          end
+        CODE
+
+        has_one :"richer_text_#{name}", -> { where(name: name) },
+          class_name: "RicherText::RichText", as: :record, inverse_of: :record, autosave: true, dependent: :destroy
+
+        scope :"with_richer_text_#{name}", -> { includes("richer_text_#{name}") }
+      end
+
+      # Eager load all dependent RichText models in bulk.
+      def with_all_richer_text
+        eager_load(richer_text_association_names)
+      end
+
+      def richer_text_association_names
+        reflect_on_all_associations(:has_one).collect(&:name).select { |n| n.start_with?("richer_text_") }
+      end
+    end
+  end
+end

data/lib/richer_text/content.rb

@@ -0,0 +1,46 @@
+module RicherText
+  class Content
+    include Serialization
+
+    delegate :blank?, :empty?, :html_safe, :present?, to: :to_html
+
+    def initialize(body)
+      @body = body
+
+      @fragment = RicherText::Fragment.parse(body)
+    end
+
+    def inspect
+      "#<#{self.class.name} #{to_html.truncate(25).inspect}>"
+    end
+
+    def to_s
+      to_html
+    end
+
+    def to_html
+      body
+    end
+
+    def images
+      @images ||= fragment.find_all("img").map do |img|
+        img.attributes["src"].value
+      end.uniq
+    end
+
+    def image_blobs
+      image_blob_ids.map { |id| ActiveStorage::Blob.find_signed(id) }
+    end
+
+    def image_blob_ids
+      images.map do |image|
+        # Ensure old images from ActionText which used the proxy url are supported
+        image = image.gsub("/proxy/", "/redirect/")
+        # Fetch the signed_blob_id from the image src
+        image.split("/rails/active_storage/blobs/redirect/").last.split("/").first
+      end
+    end
+
+    attr_reader :body, :fragment
+  end
+end

data/lib/richer_text/engine.rb

@@ -0,0 +1,14 @@
+require "rails"
+require "nokogiri"
+
+module RicherText
+  class Engine < ::Rails::Engine
+    isolate_namespace RicherText
+
+    initializer "richer_text.attribute" do
+      ActiveSupport.on_load(:active_record) do
+        include RicherText::Attribute
+      end
+    end
+  end
+end

data/lib/richer_text/fragment.rb

@@ -0,0 +1,19 @@
+module RicherText
+  class Fragment
+    class << self
+      def parse(html)
+        new(Nokogiri::HTML.fragment(html))
+      end
+    end
+
+    attr_reader :source
+
+    def initialize(source)
+      @source = source
+    end
+
+    def find_all(selector)
+      source.css(selector)
+    end
+  end
+end

data/lib/richer_text/serialization.rb

@@ -0,0 +1,24 @@
+module RicherText
+  module Serialization
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def load(content)
+        new(content) if content
+      end
+
+      def dump(content)
+        case content
+        when nil
+          nil
+        when self
+          content.to_html
+        when RicherText::RichText
+          content.body.to_html
+        else
+          new(content).to_html
+        end
+      end
+    end
+  end
+end

data/lib/richer_text/version.rb

@@ -0,0 +1,3 @@
+module RicherText
+  VERSION = "0.0.1"
+end

data/lib/richer_text.rb

@@ -0,0 +1,14 @@
+require "active_support"
+require "active_support/rails"
+
+require "richer_text/version"
+require "richer_text/engine"
+
+module RicherText
+  extend ActiveSupport::Autoload
+
+  autoload :Attribute
+  autoload :Content
+  autoload :Fragment
+  autoload :Serialization
+end

data/lib/tasks/richer_text_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :richer_text do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: richer_text
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrea Fomera
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-07-28 00:00:00.000000000 Z
+dependencies:
+- !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:
+email:
+- afomera@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/richer_text_manifest.js
+- app/assets/stylesheets/richer_text/application.css
+- app/controllers/richer_text/application_controller.rb
+- app/helpers/richer_text/application_helper.rb
+- app/jobs/richer_text/application_job.rb
+- app/mailers/richer_text/application_mailer.rb
+- app/models/richer_text/application_record.rb
+- app/models/richer_text/rich_text.rb
+- app/views/layouts/richer_text/application.html.erb
+- config/routes.rb
+- db/migrate/20230107020316_create_richer_text_rich_texts.rb
+- lib/richer_text.rb
+- lib/richer_text/attribute.rb
+- lib/richer_text/content.rb
+- lib/richer_text/engine.rb
+- lib/richer_text/fragment.rb
+- lib/richer_text/serialization.rb
+- lib/richer_text/version.rb
+- lib/tasks/richer_text_tasks.rake
+homepage: https://github.com/afomera/richer_text
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/afomera/richer_text
+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.10
+signing_key:
+specification_version: 4
+summary: A richer text editor for Rails
+test_files: []