plutonium 0.5.0

data/lib/plutonium/helpers/content_helper.rb

@@ -0,0 +1,66 @@
+module Plutonium
+  module Helpers
+    module ContentHelper
+      def timeago(date, format: :long)
+        return if date.blank?
+
+        content = I18n.l(date, format:)
+        tag.time(
+          content,
+          title: content,
+          data: {
+            controller: "timeago",
+            timeago_refresh_interval_value: 1000,
+            timeago_include_seconds_value: true,
+            timeago_add_suffix_value: true,
+            timeago_datetime_value: date.iso8601
+          }
+        )
+      end
+
+      def read_more(content, clamp = 4)
+        return if content.blank?
+
+        # Stimulus Read More (https://www.stimulus-components.com/docs/stimulus-read-more/)
+        style = "overflow: hidden; display: -webkit-box; -webkit-box-orient: vertical; " \
+                "-webkit-line-clamp: var(--read-more-line-clamp, #{clamp});"
+
+        tag.div(
+          data: {
+            controller: "read-more",
+            read_more_more_text_value: "Read more",
+            read_more_less_text_value: "Read less"
+          }
+        ) do
+          concat tag.div(content,
+            style:,
+            data: {read_more_target: "content"})
+
+          next unless content.lines.size > clamp
+
+          concat tag.button("Read more",
+            class: "btn btn-sm btn-link text-decoration-none ps-0",
+            data: {action: "read-more#toggle"})
+        end
+      end
+
+      def quill(content)
+        return if content.blank?
+
+        tag.div(
+          content,
+          class: "ql-viewer",
+          data: {
+            controller: "quill-viewer"
+          }
+        )
+      end
+
+      def clamp_content(content)
+        return if content.blank?
+
+        tag.div content, class: "clamped-content"
+      end
+    end
+  end
+end

data/lib/plutonium/helpers/display_helper.rb

@@ -0,0 +1,83 @@
+module Plutonium
+  module Helpers
+    module DisplayHelper
+      def display_field(value:, helper: nil, **options)
+        return "-" unless value.present?
+
+        stack_multiple = options.key?(:stack_multiple) ? options.delete(:stack_multiple) : helper != :display_name_of
+
+        # clean options list
+        options.select! { |k, _v| !k.starts_with? "pu_" }
+
+        if value.respond_to?(:each) && stack_multiple
+          tag.ul class: "list-unstyled m-0" do
+            value.each do |val|
+              rendered = display_field_value(value: val, helper:, **options)
+              concat tag.li(rendered)
+            end
+          end
+        else
+          rendered = display_field_value(value:, helper:, **options)
+          tag.span rendered
+        end
+      end
+
+      def display_datetime_value(value)
+        timeago value
+      end
+
+      def display_field_value(value:, helper: nil, title: nil, **)
+        title = (title != false) ? title || value : nil
+        rendered = helper.present? ? send(helper, value, **) : value
+        tag.span rendered, title:
+      end
+
+      def display_association_value(association)
+        display_name = display_name_of(association)
+        link_to display_name, adapt_route_args(association, use_parent: false),
+          class: "text-decoration-none"
+      rescue NoMethodError
+        display_name
+      end
+
+      def display_numeric_value(value)
+        number_with_delimiter value
+      end
+
+      def display_boolean_value(value)
+        tag.input type: :checkbox, class: "form-check-input", checked: value, disabled: true
+      end
+
+      def display_url_value(value)
+        link_to nil, value, class: "text-decoration-none", target: :blank
+      end
+
+      def display_name_of(obj, separator: ", ")
+        return unless obj.present?
+
+        # If this is an array, display for each
+        return obj.map { |i| display_name_of i, separator: }.join(separator) if obj.is_a? Array
+
+        # Fallback to retrieving the value from a predefined list
+        %i[to_label name title].each do |method|
+          name = obj.send(method) if obj.respond_to?(method)
+          return name if name.present?
+        end
+
+        # Maybe this is a record?
+        return "#{resource_name(obj.class)} ##{obj.id}" if obj.respond_to?(:id)
+
+        # Oh well. Just convert it to a string.
+        obj.to_s
+      end
+
+      def display_clamped_quill(value)
+        clamp_content quill(value)
+      end
+
+      def display_attachment_value(value, **, &block)
+        attachment_preview(value, **, &block)
+      end
+    end
+  end
+end

data/lib/plutonium/helpers/form_helper.rb

@@ -0,0 +1,24 @@
+module Plutonium
+  module Helpers
+    module FormHelper
+      include ActionView::Helpers::FormHelper
+
+      #
+      # Override the original form_for helper to disable turbo forms by default if not
+      # explicitly opted into
+      #
+      def resource_form_for(record, options = {}, &block)
+        turbo_frame = options.key?(:turbo_frame) ? options[:turbo_frame] : "_top"
+        options = {
+          html: {
+            data: {
+              turbo_frame:
+            }
+          }
+        }.deep_merge! options
+
+        simple_form_for(record, options, &block)
+      end
+    end
+  end
+end

data/lib/plutonium/helpers/menu_helper.rb

@@ -0,0 +1,69 @@
+module Plutonium
+  module Helpers
+    module MenuHelper
+      # <ul class="list-unstyled ps-0">
+      #   <li class="mb-1">
+      #     <button class="btn btn-toggle d-inline-flex align-items-center rounded border-0 collapsed" data-bs-toggle="collapse" data-bs-target="#resources-collapse" aria-expanded="true">Resources</button>
+      #     <div class="collapse show" id="resources-collapse">
+      #         <ul class="btn-toggle-nav list-unstyled fw-normal pb-1 small">
+      #           <li class="mb-1">
+      #             <a class="link-body-emphasis d-inline-flex text-decoration-none rounded" data-turbo-frame="content" href="http://127.0.0.1:3000/admin/organisations">Organisations</a>
+      #           </li>
+      #           <li class="mb-1" style="margin-left: 1.25em">
+      #             <button class="btn btn-toggle d-inline-flex align-items-center rounded border-0 collapsed" data-bs-toggle="collapse" data-bs-target="#nested-collapse" aria-expanded="true">Nested</button>
+      #             <div class="collapse show" id="nested-collapse">
+      #               <ul class="btn-toggle-nav list-unstyled fw-normal pb-1 small">
+      #                   <li class="mb-1">
+      #                     <a class="link-body-emphasis d-inline-flex text-decoration-none rounded" data-turbo-frame="content" href="http://127.0.0.1:3000/admin/organisations">Nested Organisations</a>
+      #                   </li>
+      #               </ul>
+      #             </div>
+      #           </li>
+      #         </ul>
+      #     </div>
+      #   </li>
+      # </ul>
+
+      def build_sidebar_menu(menu, turbo_frame: "content")
+        tag.ul class: "list-unstyled ps-0" do
+          menu.each do |name, definition|
+            concat build_sidebar_menu_item(name, definition, 0)
+          end
+        end
+      end
+
+      private
+
+      def build_sidebar_menu_item(name, definition, depth)
+        if definition.is_a? String
+          tag.li class: "mb-1" do
+            tag.a name,
+              class: "link-body-emphasis d-inline-flex text-decoration-none rounded ps-0",
+              data: {turbo_frame: "content"},
+              href: definition
+          end
+        else
+          style = "margin-left: #{depth * 1.25}em"
+          tag.li(class: "mb-1", style:) do
+            concat tag.button(
+              name,
+              class: "btn btn-toggle d-inline-flex align-items-center rounded border-0 collapsed ps-0",
+              data: {bs_toggle: "collapse", bs_target: "##{name.parameterize}-collapse"},
+              aria: {expanded: "false"}
+            )
+
+            concat begin
+              tag.div(class: "collapse", id: "#{name.parameterize}-collapse") do
+                tag.ul(class: "btn-toggle-nav list-unstyled fw-normal pb-1 small") do
+                  definition.each do |name, sub_definition|
+                    concat build_sidebar_menu_item(name, sub_definition, depth + 1)
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/plutonium/helpers/pagination_helper.rb

@@ -0,0 +1,9 @@
+require "pagy"
+
+module Plutonium
+  module Helpers
+    module PaginationHelper
+      include Pagy::Frontend
+    end
+  end
+end

data/lib/plutonium/helpers/turbo_helper.rb

@@ -0,0 +1,13 @@
+module Plutonium
+  module Helpers
+    module TurboHelper
+      def current_turbo_frame
+        request.headers["Turbo-Frame"]
+      end
+
+      def modal_frame_tag(&block)
+        turbo_frame_tag "modal", &block
+      end
+    end
+  end
+end

data/lib/plutonium/helpers/turbo_stream_actions_helper.rb

@@ -0,0 +1,9 @@
+module Plutonium
+  module Helpers
+    module TurboStreamActionsHelper
+      def redirect(url)
+        turbo_stream_action_tag :redirect, url:
+      end
+    end
+  end
+end

data/lib/plutonium/helpers.rb

@@ -0,0 +1,31 @@
+module Plutonium
+  module Helpers
+    extend ActiveSupport::Autoload
+
+    def self.included(base)
+      base.class_eval do
+        include Plutonium::Helpers::ApplicationHelper
+        include Plutonium::Helpers::ActionButtonsHelper
+        include Plutonium::Helpers::ContentHelper
+        include Plutonium::Helpers::FormHelper
+        include Plutonium::Helpers::MenuHelper
+        include Plutonium::Helpers::PaginationHelper
+        include Plutonium::Helpers::DisplayHelper
+        include Plutonium::Helpers::TurboHelper
+        include Plutonium::Helpers::AttachmentHelper
+      end
+    end
+
+    eager_autoload do
+      autoload :ApplicationHelper
+      autoload :ActionButtonsHelper
+      autoload :ContentHelper
+      autoload :FormHelper
+      autoload :MenuHelper
+      autoload :PaginationHelper
+      autoload :DisplayHelper
+      autoload :TurboHelper
+      autoload :AttachmentHelper
+    end
+  end
+end

data/lib/plutonium/initializers/TODO

@@ -0,0 +1,2 @@
+figure out how to clean up this issue with initializers
+figure out how to deal with rabl

data/lib/plutonium/initializers/pagy.rb

@@ -0,0 +1,5 @@
+require "pagy"
+require "pagy/extras/bootstrap"
+require "pagy/extras/overflow"
+require "pagy/extras/trim"
+require "pagy/extras/headers"

data/lib/plutonium/initializers/patches.rb

@@ -0,0 +1,2 @@
+# this is required to circumvent an issue with turbo loading action cable even if it is not included in rails
+Rails.autoloaders.once.do_not_eager_load("#{Turbo::Engine.root}/app/channels")

data/lib/plutonium/initializers/rabl.rb

@@ -0,0 +1,60 @@
+require "rabl"
+
+# https://github.com/nesquena/rabl#configuration
+
+Rabl.configure do |config|
+  config.cache_sources = !Rails.env.development? # Defaults to false
+  config.raise_on_missing_attribute = !Rails.env.production? # Defaults to false
+
+  # config.cache_all_output = false
+  # config.cache_engine = Rabl::CacheEngine.new # Defaults to Rails cache
+  # config.perform_caching = false
+  # config.escape_all_output = false
+  # config.json_engine = nil # Class with #dump class method (defaults JSON)
+  # config.msgpack_engine = nil # Defaults to ::MessagePack
+  # config.bson_engine = nil # Defaults to ::BSON
+  # config.plist_engine = nil # Defaults to ::Plist::Emit
+  # config.include_json_root = true
+  # config.include_msgpack_root = true
+  # config.include_bson_root = true
+  # config.include_plist_root = true
+  # config.include_xml_root  = false
+  # config.include_child_root = true
+  # config.enable_json_callbacks = false
+  # config.xml_options = { :dasherize  => true, :skip_types => false }
+  # config.view_paths = []
+  # config.replace_nil_values_with_empty_strings = true # Defaults to false
+  # config.replace_empty_string_values_with_nil_values = true # Defaults to false
+  # config.exclude_nil_values = true # Defaults to false
+  # config.exclude_empty_values_in_collections = true # Defaults to false
+  # config.camelize_keys = :upper # Defaults to false
+end
+
+# Monkey Patch Rabl source lookup to make it compatible with Rails view lookup
+module Rabl
+  module Sources
+    private
+
+    # Returns the rabl template path for Rails
+    def fetch_rails_source(file, _options = {})
+      # use Rails template resolution mechanism if possible (find_template)
+      source_format = request_format if defined?(request_format)
+
+      lookup_proc = lambda do |partial|
+        context_scope.lookup_context.find(file, context_scope.lookup_context.prefixes, partial, [],
+          {formats: [source_format]})
+      end
+      template = begin
+        lookup_proc.call(false)
+      rescue
+        nil
+      end
+      template ||= begin
+        lookup_proc.call(true)
+      rescue
+        nil
+      end
+      template&.identifier
+    end
+  end
+end