plutonium 0.12.10 → 0.12.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 053e7c4ed94242099eed9ecf819521ccb175ab5e8649a6b771ffe86b743cff64
-  data.tar.gz: 83a54d5ded5d6ed7fcf68179cc0ecd99d92975f1965edefb029731b749c1963c
+  metadata.gz: 443b2efe86f5242ef6355f8da9d8af08dbbf66ebeaf8feb3adebbe9c0858cf45
+  data.tar.gz: 532843ca3dd3a9456e135dfa371d5110f46c726f5d86fed70a1ebe02ed8cfde5
 SHA512:
-  metadata.gz: bdeb350835e78ff12d69789507bb3be8ac9b36dfb174e56d0e85ec85b97a47a41d32080ba626fb19cfaa46b3bc31913f209c58a3a4484dc40c8588398c83ada9
-  data.tar.gz: cd0601de7a8d83add613e97695abad65639bdf988c609c3e587ca41d152aa21dfdb7384e602110dc87ac75d6007d583c52879c8311d4ae83f83022275a202a99
+  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/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/version.rb

@@ -1,3 +1,3 @@
 module Plutonium
-  VERSION = "0.12.10"
+  VERSION = "0.12.11"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plutonium
 version: !ruby/object:Gem::Version
-  version: 0.12.10
+  version: 0.12.11
 platform: ruby
 authors:
 - Stefan Froelich
@@ -208,6 +208,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- "# Plutonium: The pre-alpha demo.md"
 - ".node-version"
 - ".rspec"
 - ".ruby-version"
@@ -883,6 +884,9 @@ files:
 - lib/generators/pu/field/renderer/renderer_generator.rb
 - lib/generators/pu/field/renderer/templates/.keep
 - lib/generators/pu/field/renderer/templates/renderer.rb.tt
+- lib/generators/pu/gem/annotate/annotate_generator.rb
+- lib/generators/pu/gem/annotate/templates/.keep
+- lib/generators/pu/gem/annotate/templates/lib/tasks/auto_annotate_models.rake
 - lib/generators/pu/gem/dotenv/dotenv_generator.rb
 - lib/generators/pu/gem/dotenv/templates/.env
 - lib/generators/pu/gem/dotenv/templates/.env.local