avo-markdown_field 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f5a244196eeeb78ec3ea3da1416c4b97891cdeb0fecee52bc7393635f06d472c
+  data.tar.gz: 044db7995043bc04e43144f39511f7ba91282650ec217cd2fadf534cba7f38d7
+SHA512:
+  metadata.gz: 617d16105c3d95840f68775b4c31365727e9354a9bf6b9a0ba37f245ff85cd766e0b652e373f7befac2fd991d3f19a06e81444bea85d36a44a588bd53d70a224
+  data.tar.gz: '098f8b1ff436a625d2eb6e60b0c68274d2b4027519db8921827b7ec4e49cdc289345785c70a92e8238e5326ae7b0e0ccabd564bbe72a42d44b137aa375b76f12'

data/README.md

@@ -0,0 +1,11 @@
+# Avo Markdown Field
+
+A simple markdown field which is using the ['marksmith'](https://github.com/avo-hq/marksmith) editor for [avo-hq/avo](https://github.com/avo-hq/avo), a Rails Admin Panel and Internal Tool Builder.
+
+Docs available at [https://docs.avohq.io/3.0/fields/markdown.html](https://docs.avohq.io/3.0/fields/markdown.html)
+
+## Usage
+
+```ruby
+field :body, as: :markdown
+```

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/components/avo/fields/markdown_field/edit_component.html.erb

@@ -0,0 +1,8 @@
+<%= field_wrapper **field_wrapper_args, full_width: true do %>
+  <%= @form.marksmith @field.id,
+    extra_preview_params: {
+      resource_class: @resource.class.name,
+      field_id: field.id,
+    }
+  %>
+<% end %>

data/app/components/avo/fields/markdown_field/edit_component.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class Avo::Fields::MarkdownField::EditComponent < Avo::Fields::EditComponent
+end

data/app/components/avo/fields/markdown_field/show_component.html.erb

@@ -0,0 +1,3 @@
+<%= field_wrapper **field_wrapper_args, full_width: true do %>
+  <%= render partial: "marksmith/shared/rendered_body", locals: { body: Marksmith::Renderer.new.renderer.render(@field.value) } %>
+<% end %>

data/app/components/avo/fields/markdown_field/show_component.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class Avo::Fields::MarkdownField::ShowComponent < Avo::Fields::ShowComponent
+end

data/avo-markdown_field.gemspec

@@ -0,0 +1,21 @@
+$:.push File.expand_path("lib", __dir__)
+
+require "avo/markdown_field/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "avo-markdown_field"
+  spec.version = Avo::MarkdownField::VERSION
+  spec.summary = "Marksmith field for Avo."
+  spec.description = "Marksmith field for Avo."
+  spec.authors = ["Adrian Marin"]
+  spec.email = "adrian@adrianthedev.com"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    Dir["{app,lib}/**/*", "Rakefile", "README.md", "avo-markdown_field.gemspec"]
+  end
+  spec.files.reject! { |file_name| %w[app/javascript].any? { |rejected_file| file_name.include? rejected_file } }
+
+  spec.homepage = "https://avohq.io"
+
+  spec.add_dependency "marksmith"
+end

data/lib/avo/markdown_field/engine.rb

@@ -0,0 +1,23 @@
+require_relative "fields/markdown_field"
+
+module Avo
+  module MarkdownField
+    class Engine < Rails::Engine
+      isolate_namespace Avo::MarkdownField
+
+      initializer "avo-markdown_field.init" do |app|
+        app.routes.append do
+          mount Marksmith::Engine => "/marksmith"
+        end
+
+        ActiveSupport.on_load(:avo_boot) do
+          Avo.plugin_manager.register :markdown
+
+          Avo.plugin_manager.register_field :markdown, Avo::MarkdownField::Fields::MarkdownField
+
+          Avo.asset_manager.add_stylesheet "marksmith"
+        end
+      end
+    end
+  end
+end

data/lib/avo/markdown_field/fields/markdown_field.rb

@@ -0,0 +1,17 @@
+module Avo
+  module MarkdownField
+    module Fields
+      class MarkdownField < Avo::Fields::BaseField
+        def initialize(id, **args, &block)
+          super(id, **args, &block)
+
+          hide_on :index
+        end
+
+        def view_component_namespace
+          "Avo::Fields::MarkdownField"
+        end
+      end
+    end
+  end
+end

data/lib/avo/markdown_field/version.rb

@@ -0,0 +1,5 @@
+module Avo
+  module MarkdownField
+    VERSION = "0.0.5" unless const_defined?(:VERSION)
+  end
+end

data/lib/avo/markdown_field.rb

@@ -0,0 +1,14 @@
+require "zeitwerk"
+require "avo"
+require "avo/markdown_field/version"
+require "avo/markdown_field/engine"
+require "marksmith"
+
+loader = Zeitwerk::Loader.for_gem_extension(Avo)
+loader.setup
+
+module Avo
+  module MarkdownField
+    # Your code goes here...d
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: avo-markdown_field
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Adrian Marin
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: marksmith
+  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: Marksmith field for Avo.
+email: adrian@adrianthedev.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/components/avo/fields/markdown_field/edit_component.html.erb
+- app/components/avo/fields/markdown_field/edit_component.rb
+- app/components/avo/fields/markdown_field/show_component.html.erb
+- app/components/avo/fields/markdown_field/show_component.rb
+- avo-markdown_field.gemspec
+- lib/avo/markdown_field.rb
+- lib/avo/markdown_field/engine.rb
+- lib/avo/markdown_field/fields/markdown_field.rb
+- lib/avo/markdown_field/version.rb
+homepage: https://avohq.io
+licenses: []
+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.4.10
+signing_key:
+specification_version: 4
+summary: Marksmith field for Avo.
+test_files: []