plutonium 0.5.0

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

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+require "plutonium_generators"
+
+require "rails/generators"
+require "rails/generators/active_record/model/model_generator"
+
+module Pu
+  module Resource
+    class ModelGenerator < ActiveRecord::Generators::ModelGenerator
+      include PlutoniumGenerators::Generator
+
+      source_root File.expand_path("templates", __dir__)
+
+      remove_hook_for :test_framework
+      remove_task :create_migration_file
+      remove_task :create_model_file
+      remove_task :create_module_file
+
+      class_option :package, type: :string
+
+      def run_create_module
+        create_module_file
+      end
+
+      def run_create_model
+        create_model_file
+      end
+
+      def run_create_migration
+        create_migration_file
+      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
+
+      # https://github.com/rails/rails/blob/main/railties/lib/rails/generators/generated_attribute.rb#L7
+
+      private
+
+      def parse_attributes!
+        self.attributes = (attributes || []).map do |attr|
+          GeneratedAttribute.parse(name, attr)
+        end
+      end
+
+      def name
+        @pu_name ||= begin
+          @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.classify
+      end
+
+      def main_app?
+        selected_feature == "main_app"
+      end
+
+      def selected_feature
+        @selected_feature || options[:feature]
+      end
+
+      def set_destination_root!
+        @destination_stack = [File.join(Rails.root, main_app? ? "" : "packages/#{selected_feature.underscore}")]
+      end
+
+      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
+                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
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/pu/resource/model/templates/controller.rb.tt

@@ -0,0 +1,5 @@
+<% module_namespacing do -%>
+class <%= class_name.pluralize %>Controller < <%= [feature_package_name, "ResourceController"].join "::" %>
+  controller_for ::<%= class_name %>
+end
+<% end -%>

data/lib/generators/pu/resource/model/templates/create_table_migration.rb.tt

@@ -0,0 +1,26 @@
+class <%= migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    create_table :<%= table_name %><%= primary_key_type %> do |t|
+<% attributes.each do |attribute| -%>
+<% if attribute.password_digest? -%>
+      t.string :password_digest<%= attribute.inject_options %>
+<% elsif attribute.token? -%>
+      t.string :<%= attribute.name %><%= attribute.inject_options %>
+<% elsif attribute.reference? -%>
+      t.<%= attribute.type %> :<%= attribute.name %><%= attribute.inject_options %><%= foreign_key_type %>
+<% elsif !attribute.virtual? -%>
+      t.<%= attribute.type %> :<%= attribute.name %><%= attribute.inject_options %>
+<% end -%>
+<% end -%>
+<% if options[:timestamps] %>
+      t.timestamps
+<% end -%>
+    end
+<% attributes.select(&:token?).each do |attribute| -%>
+    add_index :<%= table_name %>, :<%= attribute.index_name %><%= attribute.inject_index_options %>, unique: true
+<% end -%>
+<% attributes_with_index.each do |attribute| -%>
+    add_index :<%= table_name %>, :<%= attribute.index_name %><%= attribute.inject_index_options %>
+<% end -%>
+  end
+end

data/lib/generators/pu/resource/model/templates/model.rb.tt

@@ -0,0 +1,53 @@
+<% if class_path.last.present? -%>
+require_relative "../<%= class_path.last.underscore %>"
+
+<% end -%>
+<% module_namespacing do -%>
+class <%= class_name %> < <%= [feature_package_name, "ResourceRecord"].join "::" %>
+  # add concerns above.
+
+  # add model configurations above.
+
+<% attributes.select(&:reference?).each do |attribute| -%>
+  belongs_to :<%= attribute.name %><%= ", polymorphic: true" if attribute.polymorphic? %>
+<% end -%>
+  # add belongs_to associations above.
+
+  # add has_one associations above.
+
+  # add has_many associations above.
+
+<% attributes.select(&:attachment?).each do |attribute| -%>
+  has_one_attached :<%= attribute.name %>
+<% end -%>
+<% attributes.select(&:attachments?).each do |attribute| -%>
+  has_many_attached :<%= attribute.name %>
+<% end -%>
+  # add attachments above.
+
+<% attributes.select(&:rich_text?).each do |attribute| -%>
+  has_rich_text :<%= attribute.name %>
+<% end -%>
+<% attributes.select(&:token?).each do |attribute| -%>
+  has_secure_token<% if attribute.name != "token" %> :<%= attribute.name %><% end %>
+<% end -%>
+<% if attributes.any?(&:password_digest?) -%>
+  has_secure_password
+<% end -%>
+  # add misc attribute macros above.
+
+  # add scopes above.
+
+<% attributes.select(&:required?).each do |attribute| -%>
+  <%- next if attribute.reference? || attribute.rich_text? || attribute.token? || attribute.password_digest? -%>
+  validates :<%= attribute.name %>, presence: true
+<% end -%>
+  # add validations above.
+
+  # add callbacks above.
+
+  # add delegations above.
+
+  # add methods above.
+end
+<% end -%>

data/lib/generators/pu/resource/model/templates/module.rb.tt

@@ -0,0 +1,7 @@
+<% module_namespacing do -%>
+module <%= class_path.map(&:camelize).join("::") %>
+  def self.table_name_prefix
+    "<%= namespaced? ? namespaced_class_path.join("_") : class_path.join("_") %>_"
+  end
+end
+<% end -%>

data/lib/generators/pu/resource/model/templates/policy.rb.tt

@@ -0,0 +1,4 @@
+<% module_namespacing do -%>
+class <%= class_name %>Policy < <%= [feature_package_name, "ResourcePolicy"].join "::" %>
+end
+<% end -%>

data/lib/generators/pu/resource/model/templates/presenter.rb.tt

@@ -0,0 +1,4 @@
+<% module_namespacing do -%>
+class <%= class_name %>Presenter < <%= [feature_package_name, "ResourcePresenter"].join "::" %>
+end
+<% end -%>

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

@@ -0,0 +1,219 @@
+# frozen_string_literal: true
+
+require "plutonium_generators"
+
+module Pu
+  module Resource
+    class ScaffoldGenerator < Rails::Generators::Base
+      include PlutoniumGenerators::Generator
+
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Scaffold a resource"
+
+      argument :name
+      class_option :env, type: :string, default: "all"
+
+      def start
+        setup_models
+        scaffold_route
+        scaffold_controllers
+        scaffold_views
+        scaffold_policies
+        scaffold_presenters
+      rescue => e
+        exception "Resource scaffold failed:", e
+      end
+
+      protected
+
+      def setup_models
+        return if resource_class < Pu::ResourceModel
+
+        insert_into_file "app/models/#{resource_path}.rb",
+          indent("include ResourceModel\n", 2),
+          before: /.*# pu:add concerns.*\n/
+      end
+
+      def scaffold_route
+        route_exists = File.read("config/routes.rb").match?(/concern :#{resource_name_underscored}_routes do/)
+        return if route_exists && skip_existing?
+
+        if resource_module_underscored.present?
+          indentation = "  resources :#{resource_name_plural_underscored}, ".size
+          module_config = [
+            "module: '#{resource_module_underscored}'",
+            "controller: '#{resource_attribute_plural}'",
+            "path: '#{resources_path}'"
+          ].map { |c| indent c, indentation }.join(",\n")
+          module_config = ",\n#{module_config}"
+        end
+        route = <<~TILDE
+          concern :#{resource_name_underscored}_routes do
+            #{resource_name_underscored}_concerns = %i[]
+            #{resource_name_underscored}_concerns += shared_resource_concerns
+            resources :#{resource_name_plural_underscored}, concerns: #{resource_name_underscored}_concerns#{module_config} do
+              # pu:routes:#{resource_name_plural_underscored}
+            end
+          end
+          entity_resource_routes << :#{resource_name_underscored}_routes
+          admin_resource_routes << :#{resource_name_underscored}_routes
+        TILDE
+
+        route.gsub!(/entity_resource_routes << :#{resource_name_underscored}_routes\n/, "") if admin_only?
+        route = indent route, 2
+
+        if route_exists
+          gsub_file "config/routes.rb",
+            /.*concern :#{resource_name_underscored}_routes do(.|\n)*<< :#{resource_name_underscored}_routes\n/,
+            route
+        else
+          insert_into_file "config/routes.rb",
+            "#{route}\n",
+            before: /.*# pu:add #{entity? ? "entity" : "resource"} routes above.*/
+        end
+      end
+
+      def scaffold_controllers
+        template "app/controllers/admin_resources/resource_controller.rb",
+          "app/controllers/admin_resources/#{resources_path}_controller.rb", skip: skip_existing?
+
+        return if admin_only?
+
+        template "app/controllers/entity_resources/resource_controller.rb",
+          "app/controllers/entity_resources/#{resources_path}_controller.rb", skip: skip_existing?
+      end
+
+      def scaffold_views
+        %w[entity_resources admin_resources].each do |subdir|
+          next if subdir != "admin_resources" && admin_only?
+
+          create_file "app/views/#{subdir}/#{resources_path}/.keep", ""
+
+          #   template 'app/views/resources/resource/_resource.html.erb',
+          #            "app/views/#{subdir}/#{resources_path}/_#{resource_attribute}.html.erb", skip: skip_existing?
+          #   copy_file 'app/views/resources/resource/_resource.rabl',
+          #             "app/views/#{subdir}/#{resources_path}/_#{resource_attribute}.rabl", skip: skip_existing?
+        end
+      end
+
+      def scaffold_policies
+        template "app/policies/resources/resource_policy.rb",
+          "app/policies/resources/#{resource_path}_policy.rb", skip: skip_existing?
+
+        template "app/policies/resources/admin/resource_policy.rb",
+          "app/policies/resources/admin/#{resource_path}_policy.rb", skip: skip_existing?
+
+        return if admin_only?
+
+        template "app/policies/resources/entity/resource_policy.rb",
+          "app/policies/resources/entity/#{resource_path}_policy.rb", skip: skip_existing?
+      end
+
+      def scaffold_presenters
+        template "app/resources/resource/presenter.rb",
+          "app/resources/#{resources_path}/presenter.rb", skip: skip_existing?
+        template "app/resources/resource/admin_presenter.rb",
+          "app/resources/#{resources_path}/admin_presenter.rb", skip: skip_existing?
+
+        return if admin_only?
+
+        template "app/resources/resource/entity_presenter.rb",
+          "app/resources/#{resources_path}/entity_presenter.rb", skip: skip_existing?
+      end
+
+      def create_fields
+        @create_fields ||= (resource_class.attribute_names - %w[id slug created_at updated_at]).map(&:to_sym)
+      end
+
+      def read_fields
+        @read_fields ||= begin
+          attribute_names = resource_class.attribute_names.reject { |attr| associations[attr] }
+          attribute_names = attribute_names.map(&:to_sym)
+          attribute_names.insert(1, entity_assoc.name) if entity_assoc
+          attribute_names - %i[]
+        end
+      end
+
+      def associations
+        @associations ||= resource_class.reflect_on_all_associations.map do |assoc|
+          [assoc.foreign_key, assoc]
+        end.compact.to_h.with_indifferent_access
+      end
+
+      def entity_assoc(source_class = nil)
+        @entity_assoc ||= {}
+
+        source_class ||= resource_class
+        @entity_assoc[source_class] ||= begin
+          matcher = lambda do |assoc|
+            assoc_class = assoc.class_name.constantize
+            assoc_class == Entity || assoc_class < Entity
+          rescue
+            false
+          end
+
+          assoc = source_class.reflect_on_all_associations(:belongs_to).find(&matcher)
+          assoc ||= source_class.reflect_on_all_associations(:has_one).find(&matcher)
+          assoc
+        end
+      end
+
+      def assoc?(attr)
+        resource_class.reflect_on_association(attr)
+      end
+
+      def admin_only?
+        entity? || entity_assoc.nil?
+      end
+
+      def entity?
+        resource_class == Entity || resource_class < Entity
+      end
+
+      def resource_name
+        @resource_name ||= name.classify
+      end
+
+      def resource_name_plural
+        @resource_name_plural ||= resource_name.pluralize
+      end
+
+      def resource_class
+        @resource_class ||= resource_name.constantize
+      end
+
+      def resource_name_underscored
+        @resource_name_underscored ||= resource_name.underscore.tr("/", "_")
+      end
+
+      def resource_name_plural_underscored
+        @resource_name_plural_underscored ||= resource_name_plural.underscore.tr("/", "_")
+      end
+
+      def resource_path
+        @resource_path ||= resource_name.underscore
+      end
+
+      def resources_path
+        @resources_path ||= resource_name_plural.underscore
+      end
+
+      def resource_attribute
+        @resource_attribute ||= resource_name.demodulize.underscore
+      end
+
+      def resource_attribute_plural
+        @resource_attribute_plural ||= resource_name_plural.demodulize.underscore
+      end
+
+      def resource_module_underscored
+        @resource_module_underscored ||= resource_name.deconstantize.underscore
+      end
+
+      def skip_existing?
+        !options[:force]
+      end
+    end
+  end
+end

data/lib/generators/pu/resource/scaffold/templates/app/controllers/admin_resources/resource_controller.rb.tt

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module AdminResources
+  class <%= resource_name_plural %>Controller < ResourceController
+    controller_for ::<%= resource_name %>
+  end
+end

data/lib/generators/pu/resource/scaffold/templates/app/controllers/entity_resources/resource_controller.rb.tt

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module EntityResources
+  class <%= resource_name_plural %>Controller < ResourceController
+    controller_for ::<%= resource_name %>
+  end
+end

data/lib/generators/pu/resource/scaffold/templates/app/policies/resources/admin/resource_policy.rb.tt

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Resources
+  module Admin
+    class <%= resource_name %>Policy < Resources::Admin::ResourcePolicy
+      include Resources::<%= resource_name %>Policy
+
+      class Scope
+        include Pu::Policy::Initializer
+
+        def resolve
+          scope = ::<%= resource_name %>.all
+          scope = @context.parent.<%= resource_name_plural_underscored %> if @context.parent.present?
+          scope
+          <%- if entity_assoc -%>
+            .includes(:<%= entity_assoc.name %>)
+          <%- end -%>
+        end
+      end
+    end
+  end
+end

data/lib/generators/pu/resource/scaffold/templates/app/policies/resources/entity/resource_policy.rb.tt

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Resources
+  module Entity
+    class <%= resource_name %>Policy < Resources::Entity::ResourcePolicy
+      include Resources::<%= resource_name %>Policy
+
+      class Scope
+        include Pu::Policy::Initializer
+
+        def resolve
+          @context
+            .parent
+            .<%= resource_name_plural_underscored %>
+            <%- if entity_assoc -%>
+            .includes(:<%= entity_assoc.name %>)
+            <%- end -%>
+        end
+      end
+    end
+  end
+end

data/lib/generators/pu/resource/scaffold/templates/app/policies/resources/resource_policy.rb.tt

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Resources
+  module <%= resource_name %>Policy
+    def permitted_attributes_for_read
+      <%= read_fields.inspect %>
+    end
+
+    def permitted_attributes_for_create
+      <%= create_fields.inspect %>
+    end
+  end
+end

data/lib/generators/pu/resource/scaffold/templates/app/resources/resource/admin_presenter.rb.tt

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module <%= resource_name_plural %>
+  class AdminPresenter < Presenter
+    include AdminResourcePresenter
+  end
+end

data/lib/generators/pu/resource/scaffold/templates/app/resources/resource/entity_presenter.rb.tt

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module <%= resource_name_plural %>
+  class EntityPresenter < Presenter
+    include EntityResourcePresenter
+  end
+end

data/lib/generators/pu/resource/scaffold/templates/app/resources/resource/presenter.rb.tt

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module <%= resource_name_plural %>
+  class Presenter < ResourcePresenter
+    private
+
+    def collection_fields
+      <%= (read_fields - %i[id]).inspect %>
+    end
+
+    def detail_fields
+      <%= (read_fields - %i[id]).inspect %>
+    end
+
+    def form_inputs
+      <%= create_fields.inspect %>
+    end
+
+    def associations_list
+      []
+    end
+  end
+end

data/lib/generators/pu/resource/scaffold/templates/app/views/resources/resource/_resource.html.erb.tt

@@ -0,0 +1,3 @@
+<%% raise NotImplementedError, "Only Builders::Details is supported" unless <%= resource_name_underscored %>.is_a? ::Pu::UI::Builder::Detail %>
+
+<%%= render 'details', details: <%= resource_name_underscored %> %>

data/lib/generators/pu/resource/scaffold/templates/app/views/resources/resource/_resource.rabl

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+attributes :id
+attributes(*permitted_attributes)
+attributes :created_at, :updated_at
+
+node(:url) { |resource| url_for(adapt_route_args(resource)) }