action_markdown 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 293af657a085cc950228d941a8d449c8c335a83043843bd4733a3b69cd6422c8
+  data.tar.gz: 5e6e747ee48734dac51e1a06f61078d84ea4da676dae6df53182d783c32a4920
+SHA512:
+  metadata.gz: 9ba60286b520a138d923f3a7634ef70fececd6d67d543f8ee4d818879a0cd99b4dc12ed0b7969b2989a74c639770a3774074377f69ae913cf8e25dc490c0a01e
+  data.tar.gz: 77406fd0f6231c75475dafbe9978980144ea7c7fab76d09b37ef491dfe1a51e73dc0d54cfc387af4a12b9de27b58ea056d30f7ce5c5cf9f3395af482581deefc

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Alexandre Ruban
+
+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,68 @@
+# Welcome to ActionMarkdown
+
+Do you like GitHub issues Markdown editor? I love it too! ActionMarkdown aims to provide the same feature out of the box for Rails applications. With ActionMarkdown, it is easy to write some Markdown text in a form field and convert it to HTML seamlessly in the view.
+
+## Installation
+
+Let's add this line to our application's `Gemfile`:
+
+```ruby
+gem "action_markdown"
+```
+
+We can then run the installation script to copy the migration file:
+
+```bash
+bin/rails action_markdown:install
+```
+
+Last but not least, we need to run the migration:
+
+```bash
+bin/rails db:migrate
+```
+
+ActionMarkdown is now installed, we are good to go!
+
+## Usage
+
+Let's imagine we want to write articles in the Markdown format. In our Rails application, we will have an `Article`. To add Markdown content, we need to use the `has_markdown` macro like this:
+
+```rb
+class Article < ApplicationRecord
+  has_markdown :content
+
+  validates :content, presence: true
+end
+```
+
+Without adding any new migration, we can now create a new article with Markdown text:
+
+```rb
+markdown = <<~MARKDOWN
+# Title
+
+This is a paragraph.
+MARKDOWN
+
+article = Article.create! content: markdown
+```
+
+In the view, the Markdown content will be converted to HTML. For example, in the `ArticlesController#show` view, we can render the content converted to HTML like this:
+
+```erb
+<%# articles/show.html.erb %>
+
+<%= @article.content %>
+```
+
+In the view above, the Markdown content will automatically be converted to the following HTML:
+
+```html
+<h1>Title</h1>
+<p>This is a paragraph.</p>
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/models/action_markdown/application_record.rb

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

data/app/models/action_markdown/markdown_text.rb

@@ -0,0 +1,11 @@
+module ActionMarkdown
+  class MarkdownText < ApplicationRecord
+    self.table_name = "action_markdown_markdown_texts"
+
+    serialize :body, ActionMarkdown::Content
+
+    belongs_to :record, polymorphic: true, touch: true
+
+    delegate :to_s, :to_html, to: :body
+  end
+end

data/app/views/action_markdown/contents/_content.html.erb

@@ -0,0 +1 @@
+<%= sanitize content.to_html %>

data/db/migrate/20221110163240_create_action_markdown_tables.rb

@@ -0,0 +1,26 @@
+class CreateActionMarkdownTables < ActiveRecord::Migration[7.0]
+  def change
+    # Use Active Record's configured type for primary and foreign keys
+    primary_key_type, foreign_key_type = primary_and_foreign_key_types
+
+    create_table :action_markdown_markdown_texts, id: primary_key_type do |t|
+      t.string     :name, null: false
+      t.text       :body, size: :long
+      t.references :record, null: false, polymorphic: true, index: false, type: foreign_key_type
+
+      t.timestamps
+
+      t.index %i[record_type record_id name], name: "index_action_markdown_markdown_texts_uniqueness", unique: true
+    end
+  end
+
+  private
+
+  def primary_and_foreign_key_types
+    config = Rails.configuration.generators
+    setting = config.options[config.orm][:primary_key_type]
+    primary_key_type = setting || :primary_key
+    foreign_key_type = setting || :bigint
+    [primary_key_type, foreign_key_type]
+  end
+end

data/lib/action_markdown/attribute.rb

@@ -0,0 +1,20 @@
+module ActionMarkdown
+  module Attribute
+    def has_markdown(name)
+      class_eval <<-CODE, __FILE__, __LINE__ + 1
+        def #{name}
+          markdown_#{name} || build_markdown_#{name}
+        end
+
+        def #{name}=(body)
+          self.#{name}.body = body
+        end
+      CODE
+
+      has_one :"markdown_#{name}", -> { where(name: name) }, class_name: "ActionMarkdown::MarkdownText",
+        as: :record, inverse_of: :record, autosave: true, dependent: :destroy
+
+      scope :"with_markdown_#{name}", -> { includes("markdown_#{name}") }
+    end
+  end
+end

data/lib/action_markdown/content.rb

@@ -0,0 +1,33 @@
+module ActionMarkdown
+  class Content
+    include ActiveModel::Conversion, Rendering, Serialization
+
+    def initialize(body)
+      @body = body
+    end
+
+    def to_html
+      markdown_renderer.render(body)
+    end
+
+    def to_s
+      render partial: to_partial_path, layout: false, locals: { content: self }
+    end
+
+    private
+
+    attr_accessor :body
+
+    def markdown_renderer
+      @markdown_renderer ||= Redcarpet::Markdown.new(
+        Renderer,
+        no_intra_emphasis: true,
+        fenced_code_blocks: true,
+        autolink: true,
+        strikethrough: true,
+        superscript: true,
+        tables: true
+      )
+    end
+  end
+end

data/lib/action_markdown/engine.rb

@@ -0,0 +1,11 @@
+module ActionMarkdown
+  class Engine < ::Rails::Engine
+    isolate_namespace ActionMarkdown
+
+    initializer "action_markdown.attribute" do
+      ActiveSupport.on_load(:active_record) do
+        extend ActionMarkdown::Attribute
+      end
+    end
+  end
+end

data/lib/action_markdown/renderer.rb

@@ -0,0 +1,7 @@
+require "rouge/plugins/redcarpet"
+
+module ActionMarkdown
+  class Renderer < Redcarpet::Render::HTML
+    include Rouge::Plugins::Redcarpet
+  end
+end

data/lib/action_markdown/rendering.rb

@@ -0,0 +1,13 @@
+module ActionMarkdown
+  module Rendering
+    private
+
+    def render(*args, &block)
+      action_controller_renderer.render(*args, &block)
+    end
+
+    def action_controller_renderer
+      ActionController::Base.renderer
+    end
+  end
+end

data/lib/action_markdown/serialization.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ActionMarkdown
+  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 ActionMarkdown::MarkdownText
+          content.body.to_html
+        else
+          new(content).to_html
+        end
+      end
+    end
+  end
+end

data/lib/action_markdown/version.rb

@@ -0,0 +1,3 @@
+module ActionMarkdown
+  VERSION = "0.1.0"
+end

data/lib/action_markdown.rb

@@ -0,0 +1,14 @@
+require "action_markdown/version"
+require "action_markdown/engine"
+
+require "redcarpet"
+
+module ActionMarkdown
+  extend ActiveSupport::Autoload
+
+  autoload :Attribute
+  autoload :Content
+  autoload :Renderer
+  autoload :Rendering
+  autoload :Serialization
+end

data/lib/generators/action_markdown/install/install_generator.rb

@@ -0,0 +1,9 @@
+module ActionMarkdown
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      def create_migrations
+        rails_command "railties:install:migrations FROM=action_markdown", inline: true
+      end
+    end
+  end
+end

data/lib/tasks/action_markdown_tasks.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+desc "Copy over the migration"
+task "action_markdown:install" do
+  Rails::Command.invoke :generate, ["action_markdown:install"]
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: action_markdown
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexandre Ruban
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-11-27 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
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- alexandre@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- app/models/action_markdown/application_record.rb
+- app/models/action_markdown/markdown_text.rb
+- app/views/action_markdown/contents/_content.html.erb
+- db/migrate/20221110163240_create_action_markdown_tables.rb
+- lib/action_markdown.rb
+- lib/action_markdown/attribute.rb
+- lib/action_markdown/content.rb
+- lib/action_markdown/engine.rb
+- lib/action_markdown/renderer.rb
+- lib/action_markdown/rendering.rb
+- lib/action_markdown/serialization.rb
+- lib/action_markdown/version.rb
+- lib/generators/action_markdown/install/install_generator.rb
+- lib/tasks/action_markdown_tasks.rake
+homepage: https://github.com/alexandreruban/action-markdown
+licenses:
+- MIT
+metadata: {}
+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.3.7
+signing_key:
+specification_version: 4
+summary: Add rich text to your Ruby on Rails application thanks to Markdown.
+test_files: []