plutonium 0.6.2 → 0.9.0

data/lib/generators/pu/lib/plutonium_generators/installer.rb

@@ -0,0 +1,205 @@
+# frozen_string_literal: true
+
+require "semantic_range"
+require "yaml"
+
+module PlutoniumGenerators
+  module Installer
+    def self.included(base)
+      base.send :source_root, File.expand_path("lib/generators/pu/setup/_templates", PlutoniumGenerators::ROOT_DIR)
+
+      base.send :class_option, :interactive, type: :boolean, desc: "Show prompts. Default: true"
+      base.send :class_option, :bundle, type: :boolean, desc: "Run bundle after setup. Default: true"
+      base.send :class_option, :lint, type: :boolean, desc: "Run linter after generation. Default: false"
+      base.send :class_option, :pug_id, type: :numeric, default: 0,
+        desc: "Used internally by plutonium generators. " \
+         "Do not set this value as it might lead to unspecified behaviour."
+      base.send :class_option, :force, type: :boolean, default: false,
+        desc: "Force installation even if it have been previously installed."
+    end
+
+    protected
+
+    def install!(feature)
+      set_ruby_version! if root_pug?
+
+      from_version = read_config(:installed, feature, default: "0.0.0")
+      versions = methods.map do |m|
+        m.to_s.match(/install_v([\d_]+)/)&.[](1)&.tr("_", ".")
+      end
+      versions = versions.select do |version|
+        force? || SemanticRange.satisfies?(version, ">#{from_version}")
+      end.compact.sort
+
+      if versions.any?
+        versions.each do |version|
+          log :install!, "#{feature} v#{version}"
+          send :"install_v#{version.tr(".", "_")}!"
+        end
+
+        installed_version = versions.last
+        write_config :installed, feature => installed_version
+
+        if root_pug?
+          if bundle?
+            bundle!
+            # run last minute bundle changes
+            bundle! false
+          end
+
+          begin
+            log :rubocop, "autocorrect"
+            run_eval "bundle exec standardrb --fix"
+          rescue
+            # Do nothing
+          end
+
+          success "Successfully installed #{feature} v#{installed_version}"
+        end
+      else
+        debug "Skipping installation of #{feature}. No new versions since v#{from_version}."
+      end
+    rescue => e
+      exception "#{self.class.desc} failed:", e
+    end
+
+    def add_gem(name, **)
+      log :add_gem, name
+      before_bundle(:gem, name, **)
+    end
+
+    def rubocop(library = nil)
+      log :rubocop, "install #{library}"
+
+      add_gem "rubocop", group: :development, require: false
+
+      in_root do
+        rubocop_file = ".rubocop.yml"
+        if File.exist?(rubocop_file)
+          rubocop_def = YAML.load_file(rubocop_file)
+          rubocop_def["require"] ||= []
+        else
+          rubocop_def = {
+            "require" => [],
+            "Style/FrozenStringLiteralComment" => {"SafeAutoCorrect" => true},
+            "Style/ClassAndModuleChildren" => {"SafeAutoCorrect" => true}
+          }
+        end
+
+        if library.present?
+          library = "rubocop-#{library}"
+          add_gem library, group: :development, require: false
+          rubocop_def["require"] << library
+        end
+
+        rubocop_def["require"].uniq!
+        create_file rubocop_file, YAML.dump(rubocop_def), force: true, verbose: false
+      end
+    end
+
+    def after_bundle(command, *args, **kwargs)
+      add_task_after(:bundle, [command, args, kwargs])
+    end
+
+    def before_bundle(command, *args, **kwargs)
+      add_task_before(:bundle, [command, args, kwargs])
+    end
+
+    def yes?(statement, color = nil)
+      !interactive? || super(statement, color)
+    end
+
+    def interactive?
+      options[:interactive] != false
+    end
+
+    def bundle?
+      options[:bundle] != false
+    end
+
+    def lint?
+      options[:lint] == true
+    end
+
+    def pug(command)
+      args = options.slice("lint", "interactive").map { |k, v| "--#{k} #{v}" }.join " "
+      generate "pu:#{command} --pug-id=#{depth + 1} --force=#{force?} #{args}"
+    end
+
+    private
+
+    def bundle!(run_tasks = true)
+      log :bundle, "install"
+
+      execute_tasks_before! :bundle if run_tasks
+      Bundler.with_unbundled_env do
+        run "bundle install", verbose: false
+      end
+      execute_tasks_after! :bundle if run_tasks
+    end
+
+    def add_task(event, action, task)
+      log :add_task, "#{event} #{action}: #{task}"
+
+      key = :"tasks_#{event}"
+      tasks = read_config(key, action, default: [])
+      tasks << task
+      write_config(key, action => tasks)
+    end
+
+    def execute_tasks!(event, action)
+      log :execute_tasks!, "#{event} #{action}"
+
+      key = :"tasks_#{event}"
+      tasks = read_config(key, action, default: [])
+      tasks.each do |a|
+        task = a[0]
+        args = a[1] || []
+        kwargs = a[2] || {}
+
+        log :execute_task, "#{event} #{action}: #{task}"
+        send task, *args, **kwargs
+      end
+
+      write_config(key, action => [])
+    end
+
+    def add_task_before(action, task)
+      add_task :before, action, task
+    end
+
+    def add_task_after(action, task)
+      add_task :after, action, task
+    end
+
+    def execute_tasks_before!(action)
+      execute_tasks! :before, action
+    end
+
+    def execute_tasks_after!(action)
+      execute_tasks! :after, action
+    end
+
+    def depth
+      options[:pug_id]
+    end
+
+    def force?
+      options[:force]
+    end
+
+    def root_pug?
+      depth == 0
+    end
+
+    # def process(cmd)
+    #   stdout, stderr, status = Open3.capture3(cmd + ";")
+    #   case status.exitstatus
+    #   when 0
+    #     stdout
+    #   else
+    #     raise stderr
+    #   end
+    # end
+  end
+end

data/lib/generators/pu/lib/plutonium_generators/model_generator.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/active_record/model/model_generator"
+
+module PlutoniumGenerators
+  class ModelGenerator < ActiveRecord::Generators::ModelGenerator
+    include PlutoniumGenerators::Generator
+
+    # remove_hook_for :test_framework
+    remove_task :create_migration_file
+    remove_task :create_model_file
+    remove_task :create_module_file
+    # remove_task :check_class_collision
+
+    class_option :dest, type: :string
+
+    # def check_class_collision # :doc:
+    #   class_collisions "#{options[:prefix]}#{name}#{options[:suffix]}"
+    # end
+
+    private
+
+    def parse_attributes!
+      @original_attributes = attributes
+      self.attributes = parse_attributes_internal!(attributes)
+    end
+
+    def parse_attributes_internal!(attributes)
+      (attributes || []).map do |attr|
+        GeneratedAttribute.parse(name, attr)
+      end
+    end
+
+    # def class_collisions(*class_names)
+    #   super
+    # rescue Rails::Generators::Error
+    #   raise
+    # end
+
+    def name
+      @pu_name ||= begin
+        @original_name = @name
+        @selected_feature = select_feature selected_feature
+        @name = [main_app? ? nil : selected_feature.underscore, super.singularize.underscore].compact.join "/"
+        set_destination_root!
+        @name
+      end
+    end
+
+    def feature_package_name
+      main_app? ? nil : selected_feature.camelize
+    end
+
+    def main_app?
+      selected_feature == "main_app"
+    end
+
+    def selected_feature
+      @selected_feature || options[:dest]
+    end
+
+    def set_destination_root!
+      @destination_stack = [File.join(Rails.root, main_app? ? "" : "packages/#{selected_feature.underscore}")]
+    end
+
+    # https://github.com/rails/rails/blob/main/railties/lib/rails/generators/generated_attribute.rb#L7
+    class GeneratedAttribute < Rails::Generators::GeneratedAttribute
+      class << self
+        def parse(model_name, column_definition)
+          name, type, index_type = column_definition.split(":")
+
+          # if user provided "name:index" instead of "name:string:index"
+          # type should be set blank so GeneratedAttribute's constructor
+          # could set it to :string
+          index_type, type = type, nil if valid_index_type?(type)
+
+          type, attr_options = *parse_type_and_options(type)
+          type = type.to_sym if type
+
+          if dangerous_name?(name)
+            raise Error, "Could not generate field '#{name}', as it is already defined by Active Record."
+          end
+
+          if type && !valid_type?(type)
+            raise Error, "Could not generate field '#{name}' with unknown type '#{type}'."
+          end
+
+          if index_type && !valid_index_type?(index_type)
+            raise Error, "Could not generate field '#{name}' with unknown index '#{index_type}'."
+          end
+
+          if type && reference?(type)
+            if Rails::Generators::GeneratedAttribute::UNIQ_INDEX_OPTIONS.include?(index_type)
+              attr_options[:index] = {unique: true}
+            end
+
+            if name.include? "/"
+              attr_options[:to_table] = name.tr("/", "_").pluralize.to_sym
+              attr_options[:class_name] = name.classify
+              if (shared_namespace = find_shared_namespace(model_name, name, separator: "/"))
+                name = name.sub "#{shared_namespace}/", ""
+              end
+
+              name = name.tr "/", "_"
+            end
+          end
+
+          new(name, type, index_type, attr_options)
+        end
+
+        private
+
+        def find_shared_namespace(model1, model2, separator: "::")
+          # Split the model names by separator to get the namespaces and class names as arrays
+          parts1 = model1.split(separator)
+          parts2 = model2.split(separator)
+
+          # Initialize an array to hold the shared namespace parts
+          shared_namespace = []
+
+          # Iterate over the shorter of the two arrays
+          [parts1.length, parts2.length].min.times do |i|
+            if parts1[i] == parts2[i]
+              shared_namespace << parts1[i]
+            else
+              break
+            end
+          end
+
+          # Return the shared namespace, joined by '::' or nil if there's no shared namespace
+          shared_namespace.empty? ? nil : shared_namespace.join(separator)
+        end
+      end
+
+      def required?
+        # TODO: make it such that we can override fields as nullable
+        super || true
+      end
+
+      def options_for_migration
+        super.tap do |options|
+          if options[:to_table]
+            options[:foreign_key] = {to_table: options.delete(:to_table)}
+          end
+          options.delete(:class_name)
+        end
+      end
+    end
+  end
+end

data/lib/generators/pu/lib/plutonium_generators.rb

@@ -0,0 +1,15 @@
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem # (warn_on_extra_files: false)
+loader.inflector.inflect(
+  "cli" => "CLI"
+)
+loader.setup
+
+module PlutoniumGenerators
+  class << self
+    def cli?
+      ENV["PU_CLI"] == "1"
+    end
+  end
+end

data/lib/generators/pu/pkg/app/app_generator.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "plutonium_generators"
+require_relative "../../lib/plutonium_generators"
 
 module Pu
   module Pkg
@@ -28,7 +28,17 @@ module Pu
         template "lib/engine.rb", "packages/#{package_namespace}/lib/engine.rb"
         template "config/routes.rb", "packages/#{package_namespace}/config/routes.rb"
 
-        %w[controllers interactions policies presenters].each do |dir|
+        template "app/controllers/package_controller.rb",
+          "packages/#{package_namespace}/app/controllers/#{package_namespace}/#{package_namespace}_controller.rb"
+        template "app/controllers/app_controller.rb",
+          "packages/#{package_namespace}/app/controllers/#{package_namespace}/app_controller.rb"
+
+        template "app/controllers/dashboard_controller.rb",
+          "packages/#{package_namespace}/app/controllers/#{package_namespace}/dashboard_controller.rb"
+        copy_file "app/views/package/dashboard/index.html.erb",
+          "packages/#{package_namespace}/app/views/#{package_namespace}/dashboard/index.html.erb"
+
+        %w[policies presenters query_objects].each do |dir|
           directory "app/#{dir}", "packages/#{package_namespace}/app/#{dir}/#{package_namespace}"
         end
         create_file "packages/#{package_namespace}/app/views/#{package_namespace}/.keep"
@@ -41,7 +51,7 @@ module Pu
       attr_reader :rodauth_account
 
       def package_name
-        name.classify + "App"
+        name.camelize + "App"
       end
 
       def package_namespace
@@ -49,7 +59,7 @@ module Pu
       end
 
       def package_type
-        "Packaging::App"
+        "Pkg::App"
       end
 
       def public_access? = @public_access

data/lib/generators/pu/pkg/app/templates/app/controllers/app_controller.rb.tt

@@ -0,0 +1,5 @@
+module <%= package_name %>
+  class AppController < ::ApplicationController
+    include <%= package_name %>Controller
+  end
+end

data/lib/generators/pu/pkg/app/templates/app/controllers/dashboard_controller.rb.tt

@@ -0,0 +1,6 @@
+module <%= package_name %>
+  class DashboardController < AppController
+    def index
+    end
+  end
+end

data/lib/generators/pu/pkg/app/templates/app/controllers/{resource_controller.rb.tt → package_controller.rb.tt}

@@ -1,11 +1,11 @@
 module <%= package_name %>
-  module ResourceController
+  module <%= package_name %>Controller
     extend ActiveSupport::Concern
-    include Plutonium::Core::AppController
+    include Plutonium::Application::Controller
     <%- if rodauth_account.present? -%>
     include Plutonium::Auth.rodauth(:<%= rodauth_account %>)
     <%- elsif public_access? -%>
-    include Plutonium::Auth::PublicAccess
+    include Plutonium::Auth::Public
     <%- end -%>
     # add concerns above.
 

data/lib/generators/pu/pkg/app/templates/app/{interactions/resource_interaction.rb.tt → query_objects/resource_query_object.rb.tt}

@@ -1,4 +1,4 @@
 module <%= package_name %>
-  module ResourceInteraction
+  module ResourceQueryObject
   end
 end

data/lib/generators/pu/pkg/app/templates/app/views/package/dashboard/index.html.erb

@@ -0,0 +1,23 @@
+<div class="w-full max-w-md p-4 bg-white border border-gray-200 rounded-lg shadow sm:p-8 dark:bg-gray-800 dark:border-gray-700">
+  <div class="flex items-center justify-between mb-4">
+    <h5 class="text-xl font-bold leading-none text-gray-900 dark:text-white">Resources</h5>
+  </div>
+  <div class="flow-root">
+    <ul role="list" class="divide-y divide-gray-200 dark:divide-gray-700">
+      <% registered_resources.each do |resource| %>
+        <li class="py-3 sm:py-4">
+          <div class="flex items-center">
+            <div class="flex-1 min-w-0 ms-4">
+              <a href="<%= resource_url_for(resource, parent: nil) %>" class="text-md font-medium text-gray-900 truncate dark:text-white">
+                <%= resource.model_name.human.pluralize %>
+              </a>
+            </div>
+            <div class="inline-flex items-center text-base font-semibold text-gray-900 dark:text-white">
+              <%= resource.count %>
+            </div>
+          </div>
+        </li>
+      <% end %>
+    </ul>
+  </div>
+</div>

data/lib/generators/pu/pkg/app/templates/config/routes.rb.tt

@@ -1,6 +1,8 @@
-# <%= package_name %>::Engine.routes.draw do
-#   # add custom app routes here
-# end
+<%= package_name %>::Engine.routes.draw do
+  root to: "dashboard#index"
+
+  # add custom app routes here
+end
 
 # draw routes for registered resources
 <%= package_name %>::Engine.draw_resource_routes

data/lib/generators/pu/pkg/feature/feature_generator.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "plutonium_generators"
+require_relative "../../lib/plutonium_generators"
 
 module Pu
   module Pkg
@@ -18,7 +18,7 @@ module Pu
 
         template "lib/engine.rb", "packages/#{package_namespace}/lib/engine.rb"
 
-        %w[controllers interactions models policies presenters].each do |dir|
+        %w[controllers interactions models policies presenters query_objects].each do |dir|
           directory "app/#{dir}", "packages/#{package_namespace}/app/#{dir}/#{package_namespace}"
         end
         create_file "packages/#{package_namespace}/app/views/#{package_namespace}/.keep"
@@ -29,7 +29,7 @@ module Pu
       private
 
       def package_name
-        name.classify
+        name.camelize
       end
 
       def package_namespace
@@ -37,7 +37,7 @@ module Pu
       end
 
       def package_type
-        "Packaging::Feature"
+        "Pkg::Feature"
       end
     end
   end

data/lib/generators/pu/pkg/feature/templates/app/query_objects/resource_query_object.rb.tt

@@ -0,0 +1,4 @@
+module <%= package_name %>
+  class ResourceQueryObject < ::ResourceQueryObject
+  end
+end

data/lib/generators/pu/{resource → res}/conn/conn_generator.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require "plutonium_generators"
+require_relative "../../lib/plutonium_generators"
 
 module Pu
-  module Resource
+  module Res
     class ConnGenerator < Rails::Generators::Base
       include PlutoniumGenerators::Generator
 
@@ -29,6 +29,7 @@ module Pu
           template "app/controllers/resource_controller.rb", "packages/#{package_namespace}/app/controllers/#{package_namespace}/#{resource.pluralize.underscore}_controller.rb"
           template "app/policies/resource_policy.rb", "packages/#{package_namespace}/app/policies/#{package_namespace}/#{resource.underscore}_policy.rb"
           template "app/presenters/resource_presenter.rb", "packages/#{package_namespace}/app/presenters/#{package_namespace}/#{resource.underscore}_presenter.rb"
+          template "app/query_objects/resource_query_object.rb", "packages/#{package_namespace}/app/query_objects/#{package_namespace}/#{resource.underscore}_query_object.rb"
 
           insert_into_file "packages/#{package_namespace}/lib/engine.rb",
             indent("register_resource ::#{resource}\n", 6),

data/lib/generators/pu/{resource → res}/conn/templates/app/controllers/resource_controller.rb.tt

@@ -1,3 +1,3 @@
 class <%= app_namespace %>::<%= resource_class.pluralize %>Controller < ::<%= resource_class.pluralize %>Controller
-  include <%= app_namespace %>::ResourceController
+  include <%= app_namespace %>::<%= app_namespace %>Controller
 end

data/lib/generators/pu/res/conn/templates/app/query_objects/resource_query_object.rb.tt

@@ -0,0 +1,3 @@
+class <%= app_namespace %>::<%= resource_class %>QueryObject < ::<%= resource_class %>QueryObject
+  include <%= app_namespace %>::ResourceQueryObject
+end

data/lib/generators/pu/res/model/model_generator.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "../../lib/plutonium_generators"
+
+module Pu
+  module Res
+    class ModelGenerator < PlutoniumGenerators::ModelGenerator
+      source_root File.expand_path("templates", __dir__)
+
+      def run_create_module
+        create_module_file if create_files?
+      end
+
+      def run_create_model
+        model_class = class_name.safe_constantize
+        if model_class.present? && !model_class.include?(Plutonium::Resource::Record)
+          insert_into_file File.join("app/models", class_path, "#{file_name}.rb"),
+            indent("include Plutonium::Resource::Record\n", 2),
+            after: /.*class .*\n/
+        end
+
+        create_model_file if create_files?
+      end
+
+      def run_create_migration
+        create_migration_file if create_files?
+      end
+
+      private
+
+      def create_files?
+        attributes.present?
+      end
+    end
+  end
+end

data/lib/generators/pu/{resource → res}/model/templates/model.rb.tt

@@ -9,7 +9,7 @@ class <%= class_name %> < <%= [feature_package_name, "ResourceRecord"].join "::"
   # add model configurations above.
 
 <% attributes.select(&:reference?).each do |attribute| -%>
-  belongs_to :<%= attribute.name %><%= ", polymorphic: true" if attribute.polymorphic? %>
+  belongs_to :<%= attribute.name %><%= ", polymorphic: true" if attribute.polymorphic? %><%= ", class_name: \"#{attribute.attr_options[:class_name]}\"" if attribute.attr_options[:class_name] %>
 <% end -%>
   # add belongs_to associations above.
 

data/lib/generators/pu/res/scaffold/scaffold_generator.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "../../lib/plutonium_generators"
+
+module Pu
+  module Res
+    class ScaffoldGenerator < PlutoniumGenerators::ModelGenerator
+      include PlutoniumGenerators::Generator
+
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Scaffold a resource"
+
+      def setup
+        model_class = class_name.safe_constantize
+        if model_class.present? && attributes.empty? && prompt.yes?("Existing model class found. Do you want to import its attributes?")
+          attributes_str = model_class.content_columns.map { |col| "#{col.name}:#{col.type}" }
+          self.attributes = parse_attributes_internal!(attributes_str)
+        end
+      end
+
+      def create_model
+        invoke "pu:res:model", [@original_name, *@original_attributes], dest: selected_feature, **options
+      end
+
+      def create_controller
+        template "controller.rb", File.join("app/controllers", class_path, "#{file_name.pluralize}_controller.rb")
+      end
+
+      def create_policy
+        template "policy.rb", File.join("app/policies", class_path, "#{file_name}_policy.rb")
+      end
+
+      def create_presenter
+        template "presenter.rb", File.join("app/presenters", class_path, "#{file_name}_presenter.rb")
+      end
+
+      def create_query_object
+        template "query_object.rb", File.join("app/query_objects", class_path, "#{file_name}_query_object.rb")
+      end
+    end
+  end
+end

data/lib/generators/pu/{resource/model → res/scaffold}/templates/policy.rb.tt

@@ -13,11 +13,11 @@ class <%= class_name %>Policy < <%= [feature_package_name, "ResourcePolicy"].joi
   # Core attributes
 
   def permitted_attributes_for_create
-    <%= (class_name.constantize.resource_field_names - [:created_at, :updated_at]).inspect %>
+    <%= attributes.select{ |a| !a.rich_text? && !a.password_digest? && !a.token? }.map(&:name).map(&:to_sym).inspect %>
   end
 
   def permitted_attributes_for_read
-    <%= class_name.constantize.resource_field_names.inspect %>
+    <%= attributes.select{ |a| !a.rich_text? && !a.password_digest? && !a.token? }.map(&:name).map(&:to_sym).inspect %>
   end
 end
 <% end -%>