plutonium 0.12.9 → 0.12.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e23b355a86a4aa61a848f5a7778ce604a128f40b00283f50e12c8c39f5c4bc1e
-  data.tar.gz: 174b95054e17d4fd8d928f062380664ca2bf82ebe1d15685137a22e720f92281
+  metadata.gz: 443b2efe86f5242ef6355f8da9d8af08dbbf66ebeaf8feb3adebbe9c0858cf45
+  data.tar.gz: 532843ca3dd3a9456e135dfa371d5110f46c726f5d86fed70a1ebe02ed8cfde5
 SHA512:
-  metadata.gz: e525fac1c4621b3923ebccb40ea61ff9771d2dfd6bd541f505965f4728ad7befee7051d01f161b3099f2ac6b91ec23d7120324144f787849e9b876d1386d950f
-  data.tar.gz: d4eacfd569c110fb060f1efb2c8cfb60a1fb8e146fdb95be9e4508a5023424ea63330f831d02eb9b2dd36267c079738358cce9a963055b895705e5e2813aa712
+  metadata.gz: 0d19d82bd1f5ac2a2fd4d383fffbc78d0c773213ff1c6648e44723c113ae4e6a4c8065ec2318df7738012f676547c60231aa895542a139e5d55394179476c3bc
+  data.tar.gz: 22bbf75790b8bc214be9946f339e7d607a64e31e363bf6d76eead20713536168dbbd6838d6c4bb62f453ec168fa458c6126a48c0c083ec839c83675d71bcec91

data/# Plutonium: The pre-alpha demo.md

@@ -0,0 +1,218 @@
+# Plutonium: The pre-alpha demo
+
+- Introduce the project
+- Install Rails
+  ```bash
+  rails new demo -c tailwind -j esbuild
+  ```
+- Install Plutonium
+  ```bash
+  rails g pu:core:install
+  bundle add plutonium
+  ```
+- Install useful gems
+  ```bash
+  rails g pu:gem:annotate
+  ```
+- Install rodauth
+  ```bash
+  rails g pu:rodauth:install
+  ```
+- Create rodauth user account
+  ```bash
+  rails g pu:rodauth:account user
+  ```
+- Create blogging feature package
+  ```bash
+  rails g pu:pkg:feature blogging
+  ```
+- Create blog resource
+  ```bash
+  rails g pu:res:scaffold blog user:belongs_to slug:text title:string content:text state:string published_at:datetime
+  ```
+- Create dashboard app package
+  ```bash
+  rails g pu:pkg:app dashboard
+  ```
+- Connect the blog to the dashboard
+  ```bash
+  rails g pu:res:conn
+  ```
+- Scope dashboard to user
+
+  ```ruby
+  # packages/dashboard_app/lib/engine.rb
+
+  scope_to_entity User, strategy:  :current_user
+  # add directives above.
+  ```
+
+- Demonstrate queries
+
+  ```ruby
+  # packages/dashboard_app/lib/engine.rb
+
+  def define_filters
+    # define custom filters
+    define_search -> (scope, search:) { scope.where("title LIKE ?", "%#{search}%") }
+  end
+
+  def define_scopes
+    # define custom scopes
+    define_scope :published, -> (scope) { scope.where(state: :published) }
+    define_scope :drafts, -> (scope) { scope.where(state: :draft) }
+  end
+
+  def define_sorters
+    # define custom sorters
+    define_sorter :title
+    define_sorter :content
+  end
+  ```
+
+- Create a custom action
+
+  ```ruby
+  # packages/blogging/app/interactions/blogging/blog_interactions/publish.rb
+
+  module Blogging
+    module BlogInteractions
+      class Publish < ResourceInteraction
+        object :resource, class: Blog
+
+        def execute
+          errors.merge!(resource.errors) unless resource.update(state: "published", published_at: Time.current)
+          resource
+        end
+      end
+    end
+  end
+  ```
+
+  ```ruby
+  # packages/blogging/app/presenters/blogging/blog_presenter.rb
+
+    define_interactive_action :publish, label: 'Publish',
+                                        interaction: BlogInteractions::Publish,
+                                        icon: "outline/book",
+                                        color: :green
+  ```
+
+- Create blog_comment resource
+  ```bash
+  rails g pu:res:scaffold blog_comment blogging/blog:belongs_to user:belongs_to content:text
+  ```
+- Define associations
+
+  ```ruby
+  # packages/blogging/app/models/blogging/blog.rb
+
+  has_many :comments
+  ```
+
+  ```ruby
+  # packages/blogging/app/policies/blogging/blog_policy.rb
+
+   def permitted_attributes_for_show
+     super + [:comments]
+   end
+  ```
+
+- Connect comments to demonstrate auto linking
+  ```bash
+  rail g pu:res:conn
+  ```
+- Demonstrate plutonium association panels
+
+  ```ruby
+  # packages/blogging/app/policies/blogging/blog_policy.rb
+
+  def permitted_attributes_for_show
+      super
+  end
+
+  def permitted_associations
+  	%i[comments]
+  end
+  ```
+
+  19. Demonstrate nested_attributes
+
+  ```ruby
+  accepts_nested_attributes_for :comments, reject_if: :all_blank
+
+  define_nested_input  :comments, inputs:  %i[user content], limit:  1  do |input|
+  	input.define_field_input  :content, type:  :markdown
+  end
+  ```
+
+- Create a custom field renderer
+
+  ```bash
+  rails g pu:field:renderer markdown
+  bundle add redcarpet markdown
+  ```
+
+  ```ruby
+  Redcarpet::Markdown.new(Redcarpet::Render::HTML, autolink:  true).render "content"
+  ```
+
+- Create a custom field input
+
+  ```bash
+  rails g pu:field:input
+  ```
+
+  https://github.com/Ionaru/easy-markdown-editor
+
+  ```html
+  # app/views/layouts/resource.html.erb <% layout.with_assets do %>
+  <link
+    rel="stylesheet"
+    href="https://unpkg.com/easymde/dist/easymde.min.css"
+  />
+  <script src="https://unpkg.com/easymde/dist/easymde.min.js"></script>
+  <% end %>
+  ```
+
+  ```bash
+  rails g stimulus markdown_input
+  ```
+
+  ```js
+  // app/javascript/controllers/markdown_input_controller.js
+
+  connect() {
+  	console.log("markdown-input connected", this.element)
+
+      this.markdown = new EasyMDE({
+  		element: this.element,
+  	    toolbar: ["bold", "italic", "heading", "|", "quote"]
+  	})
+  }
+
+  disconnect() {
+    this.markdown.toTextArea()
+    this.markdown = null
+  }
+  ```
+
+  ```ruby
+  # app/plutonium/fields/inputs/markdown_input.rb
+
+    class MarkdownInput < Plutonium::Core::Fields::Inputs::Base
+      def render
+        form.input name, **options
+      end
+
+      private
+
+      def input_options
+        {input_html: {data: {controller: "markdown-input"}}}
+      end
+    end
+  ```
+
+  ```bash
+  rails g pu:core:assets
+  ```

data/app/views/components/form/form_component.html.erb

@@ -8,20 +8,18 @@
       </svg>
       <div>
         <span class="font-medium"><%= f.error_notification %></span>
-        <!--
           <ul class="mt-1.5 list-disc list-inside">
             <% f.object.errors.full_messages.each do |message|  %>
               <li><%= f.error_notification message: message  %></li>
             <% end  %>
         </ul>
-        -->
       </div>
     </div>
   <% end %>
 
   <div>
   <% form.inputs.values.each do |input| %>
-    <%= input.render self, f, form.record %>
+    <%= render input.with(form: f, record: form.record) %>
   <% end %>
   </div>
 

data/app/views/components/interactive_action_form/interactive_action_form_component.html.erb

@@ -8,20 +8,18 @@
       </svg>
       <div>
         <span class="font-medium"><%= f.error_notification %></span>
-        <!--
-          <ul class="mt-1.5 list-disc list-inside">
-            <% f.object.errors.full_messages.each do |message|  %>
-              <li><%= f.error_notification message: message  %></li>
-            <% end  %>
+        <ul class="mt-1.5 list-disc list-inside">
+          <% f.object.errors.full_messages.each do |message|  %>
+            <li><%= f.error_notification message: message  %></li>
+          <% end  %>
         </ul>
-        -->
       </div>
     </div>
   <% end %>
 
   <div>
   <% interactive_action.inputs.values.each do |input| %>
-    <%= input.render self, f, interaction %>
+    <%= render input.with(form: f, record: interaction) %>
   <% end %>
   </div>
 

data/app/views/components/nested_resource_form_fields/nested_resource_form_fields_component.html.erb

@@ -11,7 +11,7 @@
     <%= form.simple_fields_for name, new_record, child_index: 'NEW_RECORD' do |nested| %>
       <fieldset class="border-t mt-4 pt-4 first:border-t-0 first:pt-0 nested-resource-form-fields" data-new-record="<%= nested.object.new_record? %>">
         <% inputs.values.each do |input| %>
-          <%= input.render self, nested, new_record %>
+          <%= render input.with(form: nested, record: new_record) %>
         <% end %>
 
         <div class="text-right">
@@ -34,7 +34,7 @@
     <%= form.simple_fields_for name do |nested| %>
       <fieldset class="border-t mt-4 pt-4 first:border-t-0 first:pt-0 nested-resource-form-fields" data-new-record="<%= nested.object.new_record? %>">
         <% inputs.values.each do |input| %>
-          <%= input.render self, nested, new_record %>
+          <%= render input.with(form: nested, record: new_record) %>
         <% end %>
 
         <div>

data/app/views/components/table_search_input/table_search_input_component.html.erb

@@ -7,7 +7,11 @@
                 <path fill-rule="evenodd" d="M8 4a4 4 0 100 8 4 4 0 000-8zM2 8a6 6 0 1110.89 3.476l4.817 4.817a1 1 0 01-1.414 1.414l-4.816-4.816A6 6 0 012 8z" clip-rule="evenodd" />
             </svg>
         </div>
-        <%= search_object.search_filter.input_definitions[:search].render self, f, nil,
+
+        <%=
+          render search_object.search_filter.input_definitions[:search].with(
+            form: f,
+            record:nil,
             wrapper: false, label: false,
             as: :string, # force string for search
             placeholder: "search...",
@@ -21,7 +25,9 @@
                 # form_target: "focus",
                 turbo_permanent: true
               }
-        } %>
+            }
+          )
+        %>
     </div>
 
 

data/app/views/resource/_interactive_resource_action_form.html.erb

@@ -25,7 +25,7 @@
               </div>
               <div class="form-inputs">
                 <% interactive_action.inputs.values.each do |input| %>
-                  <%= input.render self, f, @interaction %>
+                  <%= render input.with(form: f, record: @interaction) %>
                 <% end %>
               </div>
             </div>

data/app/views/resource/_resource_details.html.erb

@@ -9,12 +9,19 @@
   <div class="p-4">
     <dl class="divide-y divide-gray-100">
       <% details.fields.each do |name, renderer| %>
+        <%#
+          TODO:
+          For now, we are hacking around the need to call #with before #label
+          This proves there's an issue with the rendering api.
+          While I think of an elegant solution, this works for now.
+        %>
+        <% renderer.with(record: details.record) %>
         <div class="py-6 sm:grid sm:grid-cols-3 sm:gap-4 sm:px-0">
           <dt class="text-sm font-medium leading-6 text-gray-900 dark:text-gray-300">
             <%= renderer.label %>
           </dt>
           <dd class="mt-1 text-sm leading-6 text-gray-700 dark:text-gray-200 sm:col-span-2 sm:mt-0">
-            <%= renderer.render self, details.record %>
+            <%= render renderer %>
           </dd>
         </div>
       <% end %>
@@ -24,6 +31,6 @@
 
 <% if present_associations? %>
   <% details.associations.each do |name, renderer| %>
-    <%= renderer.render self, details.record %>
+    <%= render renderer.with(record: details.record) %>
   <% end %>
 <% end %>

data/app/views/resource/_resource_table.html.erb

@@ -71,8 +71,16 @@
       <% end %>
 
       <% fields.each do |name, field| %>
+        <%#
+          TODO:
+          For now, we are hacking around the need to call #with before #label
+          This proves there's an issue with the rendering api.
+          While I think of an elegant solution, this works for now.
+        %>
+        <% field.with(record: resources[0]) %>
         <% table.column(name:, label: field.label, search_object: search_object) do |resource| %>
-          <%= field.render self, resource %>
+          <% field.with(record: resource) %>
+          <%= render field %>
         <% end %>
       <% end %>
     <% end %>

data/lib/generators/pu/core/assets/templates/tailwind.config.js

@@ -13,6 +13,8 @@ module.exports = {
     `${__dirname}/app/helpers/**/*.rb`,
     `${__dirname}/app/assets/stylesheets/**/*.css`,
     `${__dirname}/app/javascript/**/*.js`,
+    `${__dirname}/app/plutonium/**/*.rb`,
+    `${__dirname}/packages/**/app/plutonium/**/*.rb`,
     `${__dirname}/packages/**/app/views/**/*.html.erb`,
   ].concat(plutoniumTailwindConfig.content),
 }

data/lib/generators/pu/core/install/install_generator.rb

@@ -29,7 +29,7 @@ module Pu
       end
 
       def setup_app
-        # directory "config"
+        directory "config"
         directory "app"
 
         environment "# config.plutonium.assets.favicon = \"favicon.ico\""

data/lib/generators/pu/core/install/templates/config/initializers/plutonium.rb

@@ -1 +1,5 @@
 # Configure plutonium
+
+Rails.application.config.to_prepare do
+  # Register components here
+end

data/lib/generators/pu/eject/layout/layout_generator.rb

@@ -15,11 +15,11 @@ module Pu
       class_option :rodauth, type: :boolean
 
       def start
-        destination_dir = (destination_app == "main_app") ? "app/views/" : "packages/#{destination_app}/app/views/#{destination_app}"
+        destination_dir = (destination_app == "main_app") ? "app/views/" : "packages/#{destination_app}/app/views/"
         [
           "layouts/resource.html.erb"
         ].each do |file|
-          copy_file Plutonium.root.join("app", "views", file), Rails.root.join(destination_dir)
+          copy_file Plutonium.root.join("app", "views", file), Rails.root.join(destination_dir, file)
         end
       rescue => e
         exception "#{self.class} failed:", e
@@ -33,6 +33,7 @@ module Pu
 
       def copy_file(source_path, destination_path)
         if File.exist?(source_path)
+          FileUtils.mkdir_p(File.dirname(destination_path))
           FileUtils.cp(source_path, destination_path)
           say_status("info", "Copied #{source_path} to #{destination_path}", :green)
         else

data/lib/generators/pu/eject/shell/shell_generator.rb

@@ -14,12 +14,12 @@ module Pu
       class_option :dest, type: :string
 
       def start
-        destination_dir = (destination_app == "main_app") ? "app/views/" : "packages/#{destination_app}/app/views/#{destination_app}"
+        destination_dir = (destination_app == "main_app") ? "app/views/" : "packages/#{destination_app}/app/views"
         [
           "application/_resource_header.html.erb",
           "application/_resource_sidebar.html.erb"
         ].each do |file|
-          copy_file Plutonium.root.join("app", "views", file), Rails.root.join(destination_dir)
+          copy_file Plutonium.root.join("app", "views", file), Rails.root.join(destination_dir, file)
         end
       rescue => e
         exception "#{self.class} failed:", e
@@ -33,6 +33,7 @@ module Pu
 
       def copy_file(source_path, destination_path)
         if File.exist?(source_path)
+          FileUtils.mkdir_p(File.dirname(destination_path))
           FileUtils.cp(source_path, destination_path)
           say_status("info", "Copied #{source_path} to #{destination_path}", :green)
         else

data/lib/generators/pu/field/input/input_generator.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "../../lib/plutonium_generators"
+
+module Pu
+  module Field
+    class InputGenerator < Rails::Generators::Base
+      include PlutoniumGenerators::Generator
+
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Generates a field input"
+
+      argument :name
+
+      def start
+        in_root do
+          template "input.rb", "app/plutonium/fields/inputs/#{name.underscore}_input.rb"
+          insert_into_file "config/initializers/plutonium.rb", registration_statement, after: /.*# Register components here.*\n/
+        end
+      rescue => e
+        exception "#{self.class} failed:", e
+      end
+
+      private
+
+      def registration_statement
+        indent "Plutonium::Core::Fields::Inputs::Factory.map_type :#{name.underscore}, to: Fields::Inputs::#{name.camelize}Input\n", 2
+      end
+    end
+  end
+end

data/lib/generators/pu/field/input/templates/input.rb.tt

@@ -0,0 +1,15 @@
+module Fields
+  module Inputs
+    class <%= name.camelize %>Input < Plutonium::Core::Fields::Inputs::Base
+      def render
+        form.input name, **options
+      end
+
+      private
+
+      def input_options
+        {}
+      end
+    end
+  end
+end

data/lib/generators/pu/field/renderer/renderer_generator.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "../../lib/plutonium_generators"
+
+module Pu
+  module Field
+    class RendererGenerator < Rails::Generators::Base
+      include PlutoniumGenerators::Generator
+
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Generates a field renderer"
+
+      argument :name
+
+      def start
+        in_root do
+          template "renderer.rb", "app/plutonium/fields/renderers/#{name.underscore}_renderer.rb"
+          insert_into_file "config/initializers/plutonium.rb", registration_statement, after: /.*# Register components here.*\n/
+        end
+      rescue => e
+        exception "#{self.class} failed:", e
+      end
+
+      private
+
+      def registration_statement
+        indent "Plutonium::Core::Fields::Renderers::Factory.map_type :#{name.underscore}, to: Fields::Renderers::#{name.camelize}Renderer\n", 2
+      end
+    end
+  end
+end

data/lib/generators/pu/field/renderer/templates/renderer.rb.tt

@@ -0,0 +1,9 @@
+module Fields
+  module Renderers
+    class <%= name.camelize %>Renderer < Plutonium::Core::Fields::Renderers::Base
+      def render
+        tag.span value
+      end
+    end
+  end
+end

data/lib/generators/pu/gem/annotate/annotate_generator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "../../lib/plutonium_generators"
+
+module Pu
+  module Gem
+    class AnnotateGenerator < Rails::Generators::Base
+      include PlutoniumGenerators::Generator
+
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Install the annnotate gem"
+
+      def start
+        bundle "annotate", group: :development
+        copy_file "lib/tasks/auto_annotate_models.rake"
+      rescue => e
+        exception "#{self.class} failed:", e
+      end
+    end
+  end
+end

data/lib/generators/pu/gem/annotate/templates/lib/tasks/auto_annotate_models.rake

@@ -0,0 +1,59 @@
+# NOTE: only doing this in development as some production environments (Heroku)
+# NOTE: are sensitive to local FS writes, and besides -- it's just not proper
+# NOTE: to have a dev-mode tool do its thing in production.
+return unless Rails.env.development?
+
+require "annotate"
+task :set_annotation_options do
+  # You can override any of these by setting an environment variable of the
+  # same name.
+  Annotate.set_defaults(
+    "active_admin" => "false",
+    "additional_file_patterns" => [],
+    "routes" => "false",
+    "models" => "true",
+    "position_in_routes" => "before",
+    "position_in_class" => "before",
+    "position_in_test" => "before",
+    "position_in_fixture" => "before",
+    "position_in_factory" => "before",
+    "position_in_serializer" => "before",
+    "show_foreign_keys" => "true",
+    "show_complete_foreign_keys" => "false",
+    "show_indexes" => "true",
+    "simple_indexes" => "false",
+    "model_dir" => ([Rails.application.root.join("app/models")] + Dir[Rails.application.root.join("packages/*/app/models")]).join(","),
+    "root_dir" => "",
+    "include_version" => "false",
+    "require" => "",
+    "exclude_tests" => "true",
+    "exclude_fixtures" => "true",
+    "exclude_factories" => "true",
+    "exclude_serializers" => "true",
+    "exclude_scaffolds" => "true",
+    "exclude_controllers" => "true",
+    "exclude_helpers" => "true",
+    "exclude_sti_subclasses" => "false",
+    "ignore_model_sub_dir" => "false",
+    "ignore_columns" => nil,
+    "ignore_routes" => nil,
+    "ignore_unknown_models" => "false",
+    "hide_limit_column_types" => "integer,bigint,boolean",
+    "hide_default_column_types" => "json,jsonb,hstore",
+    "skip_on_db_migrate" => "false",
+    "format_bare" => "true",
+    "format_rdoc" => "false",
+    "format_yard" => "false",
+    "format_markdown" => "false",
+    "sort" => "false",
+    "force" => "false",
+    "frozen" => "false",
+    "classified_sort" => "true",
+    "trace" => "false",
+    "wrapper_open" => nil,
+    "wrapper_close" => nil,
+    "with_comment" => "true"
+  )
+end
+
+Annotate.load_tasks

data/lib/plutonium/core/actions/interactive_action.rb

@@ -2,7 +2,7 @@ module Plutonium
   module Core
     module Actions
       class InteractiveAction < Plutonium::Core::Action
-        include Plutonium::Core::Definers::InputDefiner
+        include Plutonium::Core::Definers::FieldInputDefiner
 
         Context = Data.define :resource_class
 
@@ -37,7 +37,7 @@ module Plutonium
 
         def set_interaction(interaction)
           @interaction = interaction
-          @inputs = defined_inputs_for(*(interaction.filters.keys - [:resource, :resources]))
+          @inputs = defined_field_inputs_for(*(interaction.filters.keys - [:resource, :resources]))
           @inline = @inputs.blank? unless inline == false
         end