inner_plan-trix 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2e402d6a4151154f84895ac83bacb670e6b8a6cf8a8a564ab08c51cf636948be
+  data.tar.gz: b5c8b56b57ab7d380202a67cf71df9e356379411b77870beb46e9ac962a40670
+SHA512:
+  metadata.gz: 931b0226aac16c06e4d5d8f65c682ef34b989510b751530dfc8e07e8335fcb0ebf6c0c5a54022743a265a5e13399d3cdde008a7acfb6bdc1b87c30463e1bf6e1
+  data.tar.gz: d9db0278d8586e5a8d055c0613ee7976674444a855976586583deefb884eea2fbb55f0606b795cac40584ebc218bd4bc299ae83af11da3cb4ccf1b1323a2bc88

data/README.md

@@ -0,0 +1,39 @@
+# InnerPlan::Trix
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "inner_plan-trix"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install inner_plan-trix
+```
+
+Rails 7.1 has a reduced amount of allowed tags and attributes therefore ActionText
+output is getting sanitized. In order to fix that, you might want to add something
+like that in your env file:
+
+```
+config.after_initialize do
+  ActionText::ContentHelper.sanitizer.class.allowed_tags += [ActionText::Attachment.tag_name, 'img', 'br'] + Rails::HTML5::Sanitizer.safe_list_sanitizer.allowed_tags
+  ActionText::ContentHelper.sanitizer.class.allowed_attributes += ['src', 'abbr', 'alt', 'cite', 'class', 'datetime', 'height', 'lang', 'name', 'title', 'width', 'xml:lang']
+end
+```
+
+## 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/inner_plan_trix_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../stylesheets/inner_plan/trix .css
+//= link inner_plan/trix/application.js

data/app/assets/stylesheets/inner_plan/trix/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/concepts/inner_plan/list/operation/index_patch.rb

@@ -0,0 +1,15 @@
+module InnerPlan::List::Operation
+  module IndexPatch
+    def self.prepended(base)
+      base.step :include_description, after: :find_models
+    end
+
+    private
+
+    def include_description(ctx, models:, **)
+      ctx[:models] = models.includes(tasks: :rich_text_description)
+    end
+  end
+end
+
+InnerPlan::List::Operation::Index.prepend(InnerPlan::List::Operation::IndexPatch) unless InnerPlan::List::Operation::Index.include?(InnerPlan::List::Operation::IndexPatch)

data/app/controllers/inner_plan/trix/application_controller.rb

@@ -0,0 +1,6 @@
+module InnerPlan
+  module Trix
+    class ApplicationController < ActionController::Base
+    end
+  end
+end

data/app/helpers/inner_plan/trix/application_helper.rb

@@ -0,0 +1,6 @@
+module InnerPlan
+  module Trix
+    module ApplicationHelper
+    end
+  end
+end

data/app/javascript/inner_plan/trix/application.js

@@ -0,0 +1,2 @@
+import 'trix'
+import '@rails/actiontext'

data/app/jobs/inner_plan/trix/application_job.rb

@@ -0,0 +1,6 @@
+module InnerPlan
+  module Trix
+    class ApplicationJob < ActiveJob::Base
+    end
+  end
+end

data/app/mailers/inner_plan/trix/application_mailer.rb

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

data/app/models/inner_plan/task_patch.rb

@@ -0,0 +1,9 @@
+module InnerPlan
+  module TaskPatch
+    def self.prepended(base)
+      base.has_rich_text :description
+    end
+  end
+end
+
+InnerPlan::Task.prepend(InnerPlan::TaskPatch)

data/app/models/inner_plan/trix/application_record.rb

@@ -0,0 +1,7 @@
+module InnerPlan
+  module Trix
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

data/app/services/inner_plan/tasks/description_renderer_patch.rb

@@ -0,0 +1,12 @@
+module InnerPlan
+  module Tasks
+    module DescriptionRendererPatch
+      def self.prepended(base)
+        base.step nil, delete: :apply_simple_format
+      end
+    end
+  end
+end
+
+# @todo why is that being called twice?
+InnerPlan::Tasks::DescriptionRenderer.prepend(InnerPlan::Tasks::DescriptionRendererPatch) unless InnerPlan::Tasks::DescriptionRenderer.include?(InnerPlan::Tasks::DescriptionRendererPatch)

data/app/views/active_storage/blobs/_blob.html.erb

@@ -0,0 +1,14 @@
+<figure class="attachment attachment--<%= blob.representable? ? "preview" : "file" %> attachment--<%= blob.filename.extension %>">
+  <% if blob.representable? %>
+    <%= image_tag main_app.url_for(blob.representation(resize_to_limit: local_assigns[:in_gallery] ? [ 800, 600 ] : [ 1024, 768 ])) %>
+  <% end %>
+
+  <figcaption class="attachment__caption">
+    <% if caption = blob.try(:caption) %>
+      <%= caption %>
+    <% else %>
+      <span class="attachment__name"><%= blob.filename %></span>
+      <span class="attachment__size"><%= number_to_human_size blob.byte_size %></span>
+    <% end %>
+  </figcaption>
+</figure>

data/app/views/layouts/action_text/contents/_content.html.erb

@@ -0,0 +1,3 @@
+<div class="trix-content">
+  <%= yield -%>
+</div>

data/app/views/layouts/inner_plan/trix/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Inner plan trix</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "inner_plan/trix/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

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

data/lib/inner_plan/trix/engine.rb

@@ -0,0 +1,44 @@
+module InnerPlan
+  module Trix
+    class Engine < ::Rails::Engine
+      isolate_namespace InnerPlan::Trix
+
+      config.to_prepare do
+        Dir.glob(File.join(File.dirname(__FILE__), '../../../app/**/*_patch*.rb')) do |c|
+          Rails.configuration.cache_classes ? require(c) : load(c)
+        end
+
+        InnerPlan.importmap.pin "trix"
+        InnerPlan.importmap.pin "@rails/actiontext", to: "actiontext.esm.js"
+        InnerPlan.importmap.pin "inner_plan/trix/application", to: "inner_plan/trix/application.js", preload: true
+
+        InnerPlan.configuration.additional_importmap_modules << 'inner_plan/trix/application'
+      end
+
+      initializer "inner_plan_trix.importmap", before: "importmap" do |app|
+        # https://github.com/rails/importmap-rails#sweeping-the-cache-in-development-and-test
+        app.config.importmap.cache_sweepers << root.join("app/javascript")
+      end
+
+      initializer "inner_plan_trix.assets" do |app|
+        # my_engine/app/javascript needs to be in the asset path
+        app.config.assets.paths << root.join("app/javascript")
+      end
+
+      config.after_initialize do
+        InnerPlan.configuration.task_edit_view_rows
+          .get(:secondary_row)
+          .content
+          .replace(:description, InnerPlan::SmartArray::Item.new(
+            :description,
+            { span: 12 },
+            proc { |context:, form:|
+              InnerPlan::Tasks::Form::ItemComponent.new(icon: Phlex::Icons::Tabler::FileText, title: 'Description') do
+                context.plain form.rich_text_area(:description, autofocus: (context.focus == :description))
+              end
+            })
+          )
+      end
+    end
+  end
+end

data/lib/inner_plan/trix/version.rb

@@ -0,0 +1,5 @@
+module InnerPlan
+  module Trix
+    VERSION = "0.1.0"
+  end
+end

data/lib/inner_plan/trix.rb

@@ -0,0 +1,8 @@
+require "inner_plan/trix/version"
+require "inner_plan/trix/engine"
+
+module InnerPlan
+  module Trix
+    # Your code goes here...
+  end
+end

data/lib/tasks/inner_plan/trix_tasks.rake

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

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: inner_plan-trix
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- mbajur
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.5
+- !ruby/object:Gem::Dependency
+  name: inner_plan
+  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: Trix and ActionText plugin for InnerPlan
+email:
+- mbajur@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/assets/config/inner_plan_trix_manifest.js
+- app/assets/stylesheets/inner_plan/trix/application.css
+- app/concepts/inner_plan/list/operation/index_patch.rb
+- app/controllers/inner_plan/trix/application_controller.rb
+- app/helpers/inner_plan/trix/application_helper.rb
+- app/javascript/inner_plan/trix/application.js
+- app/jobs/inner_plan/trix/application_job.rb
+- app/mailers/inner_plan/trix/application_mailer.rb
+- app/models/inner_plan/task_patch.rb
+- app/models/inner_plan/trix/application_record.rb
+- app/services/inner_plan/tasks/description_renderer_patch.rb
+- app/views/active_storage/blobs/_blob.html.erb
+- app/views/layouts/action_text/contents/_content.html.erb
+- app/views/layouts/inner_plan/trix/application.html.erb
+- config/routes.rb
+- lib/inner_plan/trix.rb
+- lib/inner_plan/trix/engine.rb
+- lib/inner_plan/trix/version.rb
+- lib/tasks/inner_plan/trix_tasks.rake
+homepage: https://github.com/mbajur/inner_plan-trix
+licenses: []
+metadata:
+  homepage_uri: https://github.com/mbajur/inner_plan-trix
+  source_code_uri: https://github.com/mbajur/inner_plan-trix
+  changelog_uri: https://github.com/mbajur/inner_plan-trix
+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.5.23
+signing_key:
+specification_version: 4
+summary: Trix and ActionText plugin for InnerPlan
+test_files: []