avo-record_link_field 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f6fbdb1c3f2e5fbc2279dfff61b81a493bd1098e9eb5399cd8585098835529c8
+  data.tar.gz: 39c30aa5ca96c059699c67ac5fc843a5b4ac4243ac0d2cc66beebf3e622e038e
+SHA512:
+  metadata.gz: 7fa148ad3a375f94a72b666cdc87e026e42ac6c329080017819ed8ae58025bd6339257729163b338d72eccd779c8d19fa8e024093db0a2708f3b9dc20fae3df3
+  data.tar.gz: 88d1abadf49606b6dc22bb449e2848fd148140de787ddaf2b6e83beaaf4d5f6e5d097de23142aaf83a18a884c2151412bb4f6374e5eca48c6ac5037c194ca3c2

data/README.md

@@ -0,0 +1,12 @@
+# Avo `record_link` Field
+
+A simple record link field 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/record_link.html](https://docs.avohq.io/3.0/fields/record_link.html)
+
+## Usage
+
+```ruby
+field :post, as: :record_link
+```
+

data/avo-record_link_field.gemspec

@@ -0,0 +1,17 @@
+$:.push File.expand_path("lib", __dir__)
+
+require "avo/record_link_field/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "avo-record_link_field"
+  spec.version = Avo::RecordLinkField::VERSION
+  spec.summary = "Record link field for Avo."
+  spec.description = "Record link field for Avo."
+  spec.authors = ["Adrian Marin"]
+  spec.email = "adrian@adrianthedev.com"
+
+  spec.files = Dir["{lib}/**/*", "MIT-LICENSE", "Rakefile", "README.md", "avo-record_link_field.gemspec", "Gemfile", "Gemfile.lock"]
+
+  spec.homepage = "https://avohq.io"
+  spec.license = "MIT"
+end

data/lib/avo/record_link_field/fields/record_link_field/common_record_link_component.html.erb

@@ -0,0 +1 @@
+<%= link_to label, resource_view_path, target: @target %>

data/lib/avo/record_link_field/fields/record_link_field/common_record_link_component.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+# frozen_string_literal: true
+
+class Avo::RecordLinkField::Fields::RecordLinkField::CommonRecordLinkComponent < ViewComponent::Base
+  def initialize(record:, add_via_params:, use_resource:)
+    @record = record
+    @use_resource = use_resource
+    @add_via_params = add_via_params
+  end
+
+  def resource_class
+    if @use_resource.present?
+      Avo.resource_manager.get_resource @use_resource
+    else
+      Avo.resource_manager.get_resource_by_model_class @record.class
+    end
+  end
+
+  def resource
+    @resource ||= resource_class.new(record: @record)
+  end
+
+  def label
+    @label ||= resource_class.new(record: @record)&.record_title
+  end
+
+  def resource_view_path
+    args = {
+      record: @record,
+      resource: resource,
+    }
+
+    if @add_via_params
+      args[:via_resource_class] = resource.class.to_s
+      args[:via_record_id] = @record.to_param
+    end
+
+    helpers.resource_view_path(**args)
+  end
+end

data/lib/avo/record_link_field/fields/record_link_field/index_component.html.erb

@@ -0,0 +1,3 @@
+<%= index_field_wrapper **field_wrapper_args do %>
+  <%= render Avo::RecordLinkField::Fields::RecordLinkField::CommonRecordLinkComponent.new record: @field.value, use_resource: @field.use_resource, add_via_params: @field.add_via_params %>
+<% end %>

data/lib/avo/record_link_field/fields/record_link_field/index_component.rb

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

data/lib/avo/record_link_field/fields/record_link_field/show_component.html.erb

@@ -0,0 +1,3 @@
+<%= field_wrapper **field_wrapper_args do %>
+  <%= render Avo::RecordLinkField::Fields::RecordLinkField::CommonRecordLinkComponent.new record: @field.value, use_resource: @field.use_resource, add_via_params: @field.add_via_params %>
+<% end %>

data/lib/avo/record_link_field/fields/record_link_field/show_component.rb

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

data/lib/avo/record_link_field/fields/record_link_field.rb

@@ -0,0 +1,21 @@
+module Avo
+  module RecordLinkField
+    module Fields
+      class RecordLinkField < Avo::Fields::BaseField
+        attr_reader :target
+        attr_reader :use_resource
+        attr_reader :add_via_params
+
+        def initialize(id, **args, &block)
+          super(id, **args, &block)
+
+          hide_on [:edit, :new]
+
+          add_string_prop args, :target
+          add_string_prop args, :use_resource
+          add_boolean_prop args, :add_via_params, true
+        end
+      end
+    end
+  end
+end

data/lib/avo/record_link_field/plugin.rb

@@ -0,0 +1,16 @@
+require_relative "fields/record_link_field"
+
+module Avo
+  module RecordLinkField
+    class Plugin < Avo::Plugin
+      class << self
+        def boot
+          Avo.plugin_manager.register_field :record_link, Avo::RecordLinkField::Fields::RecordLinkField
+        end
+
+        def init
+        end
+      end
+    end
+  end
+end

data/lib/avo/record_link_field/railtie.rb

@@ -0,0 +1,9 @@
+module Avo
+  module RecordLinkField
+    class Railtie < Rails::Railtie
+      initializer "avo-record_link_field.init" do
+        Avo.plugin_manager.register Avo::RecordLinkField::Plugin
+      end
+    end
+  end
+end

data/lib/avo/record_link_field/version.rb

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

data/lib/avo/record_link_field.rb

@@ -0,0 +1,15 @@
+require "zeitwerk"
+require "avo"
+require "avo/record_link_field/version"
+require "avo/record_link_field/railtie"
+
+loader = Zeitwerk::Loader.for_gem_extension(Avo)
+loader.setup
+
+module Avo
+  module RecordLinkField
+    # Your code goes here...
+  end
+end
+
+# loader.eager_load

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: avo-record_link_field
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adrian Marin
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-04-12 00:00:00.000000000 Z
+dependencies: []
+description: Record link field for Avo.
+email: adrian@adrianthedev.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- avo-record_link_field.gemspec
+- lib/avo/record_link_field.rb
+- lib/avo/record_link_field/fields/record_link_field.rb
+- lib/avo/record_link_field/fields/record_link_field/common_record_link_component.html.erb
+- lib/avo/record_link_field/fields/record_link_field/common_record_link_component.rb
+- lib/avo/record_link_field/fields/record_link_field/index_component.html.erb
+- lib/avo/record_link_field/fields/record_link_field/index_component.rb
+- lib/avo/record_link_field/fields/record_link_field/show_component.html.erb
+- lib/avo/record_link_field/fields/record_link_field/show_component.rb
+- lib/avo/record_link_field/plugin.rb
+- lib/avo/record_link_field/railtie.rb
+- lib/avo/record_link_field/version.rb
+homepage: https://avohq.io
+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.4.10
+signing_key:
+specification_version: 4
+summary: Record link field for Avo.
+test_files: []