administration-zero 0.0.1

data/lib/generators/admin/install/templates/test_unit/system/admin/users_test.rb

@@ -0,0 +1,43 @@
+require "application_system_test_case"
+
+class Admin::UsersTest < ApplicationSystemTestCase
+  setup do
+    @admin_user = admin_sign_in_as(admin_users(:lazaro_nixon))
+  end
+
+  test "visiting the index" do
+    visit admin_users_url
+    assert_selector "h2", text: "Admin users"
+  end
+
+  test "should create user" do
+    visit admin_users_url
+    click_on "New admin user"
+
+    fill_in "Email", with: "lazaronixon@hey.com"
+    fill_in "Password", with: "Secret1*3*5*"
+    fill_in "Password confirmation", with: "Secret1*3*5*"
+    click_on "Create Admin user"
+
+    assert_text "User was successfully created"
+  end
+
+  test "should update User" do
+    visit admin_user_url(@admin_user)
+    click_on "Edit admin user"
+
+    fill_in "Email", with: @admin_user.email
+    fill_in "Password", with: "NewSecret1*3*5*"
+    fill_in "Password confirmation", with: "NewSecret1*3*5*"
+    click_on "Update Admin user"
+
+    assert_text "User was successfully updated"
+  end
+
+  test "should destroy User" do
+    visit admin_user_url(@admin_user)
+    page.accept_confirm { click_on "Delete admin user" }
+
+    assert_text "User was successfully destroyed"
+  end
+end

data/lib/generators/admin/install/templates/test_unit/test_helper.rb

@@ -0,0 +1,16 @@
+ENV["RAILS_ENV"] ||= "test"
+require_relative "../config/environment"
+require "rails/test_help"
+
+class ActiveSupport::TestCase
+  # Run tests in parallel with specified workers
+  parallelize(workers: :number_of_processors)
+
+  # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order.
+  fixtures :all
+
+  # Add more helper methods to be used by all tests here...
+  def admin_sign_in_as(user)
+    post(admin_sign_in_url, params: { email: user.email, password: "Secret1*3*5*" }); user
+  end
+end

data/lib/generators/admin/scaffold/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Explain the generator
+
+Example:
+    bin/rails generate admin:scaffold model field:type field:type

data/lib/generators/admin/scaffold/scaffold_generator.rb

@@ -0,0 +1,87 @@
+require "rails/generators/resource_helpers"
+
+module Admin
+  module Generators
+    class ScaffoldGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::ResourceHelpers
+
+      class_option :orm, banner: "NAME", type: :string, required: true, desc: "ORM to generate the controller for"
+
+      argument :attributes, type: :array, default: [], banner: "field:type field:type"
+
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_files
+        directory "erb", "app/views/admin/#{file_name.pluralize}"
+
+        template "controller.rb", "app/controllers/admin/#{controller_file_name}_controller.rb"
+
+        template "functional_test.rb", "test/controllers/admin/#{controller_file_name}_controller_test.rb"
+        template "system_test.rb",     "test/system/admin/#{file_name.pluralize}_test.rb"
+      end
+
+      def create_routes
+        route "resources :#{file_name.pluralize}", namespace: :admin
+      end
+
+      private
+        def controller_class_path
+          [ "admin" ]
+        end
+
+        def singular_route_name
+          "#{controller_class_path.join('_')}_#{singular_table_name}"
+        end
+
+        def plural_route_name
+          "#{controller_class_path.join('_')}_#{plural_table_name}"
+        end
+
+        def model_resource_name(base_name = singular_table_name, prefix: "")
+          "[#{controller_class_path.map { |name| ":" + name }.join(", ")}, #{prefix}#{base_name}]"
+        end
+
+        def permitted_params
+          attachments, others = attributes_names.partition { |name| attachments?(name) }
+          params = others.map { |name| ":#{name}" }
+          params += attachments.map { |name| "#{name}: []" }
+          params.join(", ")
+        end
+
+        def attachments?(name)
+          attribute = attributes.find { |attr| attr.name == name }
+          attribute&.attachments?
+        end
+
+        def fixture_name
+          table_name
+        end
+
+        def attributes_string
+          attributes_hash.map { |k, v| "#{k}: #{v}" }.join(", ")
+        end
+
+        def attributes_hash
+          return {} if attributes_names.empty?
+
+          attributes_names.filter_map do |name|
+            if %w(password password_confirmation).include?(name) && attributes.any?(&:password_digest?)
+              ["#{name}", '"secret"']
+            elsif !virtual?(name)
+              ["#{name}", "@#{singular_table_name}.#{name}"]
+            end
+          end.sort.to_h
+        end
+
+        def boolean?(name)
+          attribute = attributes.find { |attr| attr.name == name }
+          attribute&.type == :boolean
+        end
+
+        def virtual?(name)
+          attribute = attributes.find { |attr| attr.name == name }
+          attribute&.virtual?
+        end
+    end
+  end
+end

data/lib/generators/admin/scaffold/templates/controller.rb.tt

@@ -0,0 +1,58 @@
+class <%= controller_class_name %>Controller < Admin::ApplicationController
+  before_action :set_<%= singular_table_name %>, only: %i[ show edit update destroy ]
+
+  def index
+    @search = <%= orm_class.all(class_name) %>.ransack(params[:q])
+
+    respond_to do |format|
+      format.html { @pagy, @<%= plural_table_name %> = pagy(@search.result) }
+      format.csv  { render csv: @search.result }
+    end
+  end
+
+  def show
+  end
+
+  def new
+    @<%= singular_table_name %> = <%= orm_class.build(class_name) %>
+  end
+
+  def edit
+  end
+
+  def create
+    @<%= singular_table_name %> = <%= orm_class.build(class_name, "#{singular_table_name}_params") %>
+
+    if @<%= orm_instance.save %>
+      redirect_to <%= redirect_resource_name %>, notice: <%= %("#{human_name} was successfully created.") %>
+    else
+      render :new, status: :unprocessable_entity
+    end
+  end
+
+  def update
+    if @<%= orm_instance.update("#{singular_table_name}_params") %>
+      redirect_to <%= redirect_resource_name %>, notice: <%= %("#{human_name} was successfully updated.") %>
+    else
+      render :edit, status: :unprocessable_entity
+    end
+  end
+
+  def destroy
+    @<%= orm_instance.destroy %>
+    redirect_to <%= index_helper %>_url, notice: <%= %("#{human_name} was successfully destroyed.") %>
+  end
+
+  private
+    def set_<%= singular_table_name %>
+      @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
+    end
+
+    def <%= "#{singular_table_name}_params" %>
+      <%- if attributes_names.empty? -%>
+      params.fetch(:<%= singular_table_name %>, {})
+      <%- else -%>
+      params.require(:<%= singular_table_name %>).permit(<%= permitted_params %>)
+      <%- end -%>
+    end
+end

data/lib/generators/admin/scaffold/templates/erb/_form.html.erb.tt

@@ -0,0 +1,41 @@
+<%%= form_with(model: <%= model_resource_name %>) do |form| %>
+<% attributes.each do |attribute| -%>
+  <div class="form-group row mb-2">
+<% if attribute.password_digest? -%>
+    <%%= form.label :password, class: "form-label col-md-3 col-form-label" %>
+    <div class="col-md px-0">
+      <%%= form.password_field :password, required: true, autocomplete: "new-password", class: "form-control" %>
+      <%%= tag.div <%= singular_name %>.errors[:password].first, class: "invalid-feedback" %>
+    </div>
+  </div>
+
+  <div class="col-md px-0">
+    <%%= form.password_field :password_confirmation, required: true, autocomplete: "new-password", class: "form-control" %>
+    <%%= tag.div <%= singular_name %>.errors[:password_confirmation].first, class: "invalid-feedback" %>
+<% elsif attribute.attachments? -%>
+    <%%= form.label :<%= attribute.column_name %>, class: "form-label col-md-3 col-form-label" %>
+    <div class="col-md px-0">
+      <%%= form.<%= attribute.field_type %> :<%= attribute.column_name %>, multiple: true, class: "form-control" %>
+      <%%= tag.div <%= singular_name %>.errors[:<%= attribute.column_name %>].first, class: "invalid-feedback" %>
+    </div>
+<% elsif attribute.field_type == :check_box -%>
+    <%%= form.label :<%= attribute.column_name %>, class: "form-check-label col-md-3 col-form-label" %>
+    <div class="col-md px-0">
+      <%%= form.<%= attribute.field_type %> :<%= attribute.column_name %>, class: "form-check-input" %>
+      <%%= tag.div <%= singular_name %>.errors[:<%= attribute.column_name %>].first, class: "invalid-feedback" %>
+    </div>
+<% else -%>
+    <%%= form.label :<%= attribute.column_name %>, class: "form-label col-md-3 col-form-label" %>
+    <div class="col-md px-0">
+      <%%= form.<%= attribute.field_type %> :<%= attribute.column_name %>, class: "form-control" %>
+      <%%= tag.div <%= singular_name %>.errors[:<%= attribute.column_name %>].first, class: "invalid-feedback" %>
+    </div>
+<% end -%>
+  </div>
+
+<% end -%>
+  <div class="form-footer">
+    <%%= form.submit class: "btn btn-primary" %>
+    <%%= link_to "Cancel", <%= index_helper(type: :path) %>, class: "btn btn-light" %>
+  </div>
+<%% end %>

data/lib/generators/admin/scaffold/templates/erb/edit.html.erb.tt

@@ -0,0 +1,17 @@
+<%%= render "page_header" do %>
+  <%%= render "page_header_breadcrumb", title: "Editing <%= human_name.downcase %>" do %>
+  <li class="breadcrumb-item"><%%= link_to "Admin", admin_path %></li>
+  <li class="breadcrumb-item"><%%= link_to "<%= human_name.pluralize %>", <%= index_helper(type: :path) %> %></li>
+  <li class="breadcrumb-item"><%%= link_to "Show this <%= human_name.downcase %>", <%= model_resource_name(prefix: "@") %> %></li>
+  <%% end %>
+<%% end %>
+
+<div class="page-body">
+  <div class="container-fluid">
+    <div class="card">
+      <div class="card-body">
+        <%%= render "form", <%= singular_table_name %>: @<%= singular_table_name %> %>
+      </div>
+    </div>
+  </div>
+</div>

data/lib/generators/admin/scaffold/templates/erb/index.html.erb.tt

@@ -0,0 +1,77 @@
+<%%= render "page_header" do %>
+  <%%= render "page_header_breadcrumb", title: "<%= human_name.pluralize %>" do %>
+    <li class="breadcrumb-item"><%%= link_to "Admin", admin_path %></li>
+  <%% end %>
+
+  <%%= render "page_header_actions" do %>
+    <%%= link_to "New <%= human_name.downcase %>", <%= new_helper(type: :path) %>, class: "btn btn-primary" %>
+  <%% end %>
+<%% end %>
+
+<div class="page-body">
+  <div class="container-fluid">
+    <div class="row gy-3">
+      <div class="col-md-4 col-lg-3">
+        <div class="card">
+          <div class="card-header">
+            <h3 class="card-title">Filters</h3>
+          </div>
+          <%%= search_form_for [:admin, @search], class: "card-body" do |f| %>
+            <%%# f.label :name_cont, class: "form-label" %>
+            <%%# f.text_field :name_cont, class: "form-control mb-3" %>
+
+            <%%= f.submit "Filter", class: "btn btn-primary" %>
+            <%%= link_to "Clear Filter", <%= index_helper(type: :path) %>, class: "btn btn-light" %>
+          <%% end %>
+        </div>
+      </div>
+      <div class="col-md-8 col-lg-9 order-md-first">
+        <div class="card">
+          <div class="table-responsive">
+            <table class="table table-vcenter card-table table-striped">
+              <thead>
+                <tr>
+<% attributes.each do |attribute| -%>
+                  <th><%= attribute.human_name %></th>
+<% end -%>
+                  <th></th>
+                </tr>
+              </thead>
+              <tbody>
+                <%% @<%= plural_table_name %>.each do |<%= singular_table_name %>| %>
+                  <tr>
+<% attributes.reject(&:password_digest?).each do |attribute| -%>
+<% if attribute.attachment? -%>
+                    <td><%%= link_to <%= singular_name %>.<%= attribute.column_name %>.filename, <%= singular_name %>.<%= attribute.column_name %> if <%= singular_name %>.<%= attribute.column_name %>.attached? %></td>
+<% elsif attribute.attachments? -%>
+                  <%% <%= singular_name %>.<%= attribute.column_name %>.each do |<%= attribute.singular_name %>| %>
+                    <td><%%= link_to <%= attribute.singular_name %>.filename, <%= attribute.singular_name %> %></td>
+                  <%% end %>
+<% else -%>
+                    <td><%%= <%= singular_name %>.<%= attribute.column_name %> %></td>
+<% end -%>
+<% end -%>
+                    <td>
+                      <%%= link_to "View", <%= model_resource_name %>, class: "btn btn-light btn-sm" %>
+                      <%%= link_to "Edit", <%= edit_helper(singular_table_name, type: :path) %>, class: "btn btn-light btn-sm" %>
+                      <%%= button_to "Delete", <%= model_resource_name %>, method: :delete, form_class: "d-inline", class: "btn btn-light btn-sm", data: { confirm: "Are you sure ?" } %>
+                    </td>
+                  </tr>
+                <%% end %>
+              </tbody>
+            </table>
+          </div>
+          <div class="card-footer d-flex align-items-center fs-5">
+            <div>
+              Download: <%%= link_to "CSV", <%= index_helper(type: :path) %>(format: :csv, q: request.params[:q]) %>
+            </div>
+            <div class="ms-auto d-flex align-items-center gap-2">
+              <%%== pagy_info @pagy %>
+              <%%= render "pagination", pagy: @pagy %>
+            </div>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>

data/lib/generators/admin/scaffold/templates/erb/new.html.erb.tt

@@ -0,0 +1,16 @@
+<%%= render "page_header" do %>
+  <%%= render "page_header_breadcrumb", title: "New <%= human_name.downcase %>" do %>
+    <li class="breadcrumb-item"><%%= link_to "Admin", admin_path %></li>
+    <li class="breadcrumb-item"><%%= link_to "<%= human_name.pluralize %>", <%= index_helper(type: :path) %> %></li>
+  <%% end %>
+<%% end %>
+
+<div class="page-body">
+  <div class="container-fluid">
+    <div class="card">
+      <div class="card-body">
+        <%%= render "form", <%= singular_table_name %>: @<%= singular_table_name %> %>
+      </div>
+    </div>
+  </div>
+</div>

data/lib/generators/admin/scaffold/templates/erb/show.html.erb.tt

@@ -0,0 +1,37 @@
+<%%= render "page_header" do %>
+  <%%= render "page_header_breadcrumb", title: "Showing <%= human_name.downcase %>" do %>
+    <li class="breadcrumb-item"><%%= link_to "Admin", admin_path %></li>
+    <li class="breadcrumb-item"><%%= link_to "<%= human_name.pluralize %>", <%= index_helper(type: :path) %> %></li>
+  <%% end %>
+
+  <%%= render "page_header_actions" do %>
+    <%%= link_to "Edit <%= human_name.downcase %>", <%= edit_helper(type: :path) %>, class: "btn btn-primary" %>
+    <%%= button_to "Delete <%= human_name.downcase %>", <%= model_resource_name(prefix: "@") %>, method: :delete, form_class: "d-inline", class: "btn btn-light", data: { confirm: "Are you sure ?" } %>
+  <%% end %>
+<%% end %>
+
+<div class="page-body">
+  <div class="container-fluid">
+    <div class="card">
+      <div class="card-header">
+        <h3 class="card-title"><%= human_name %> details</h3>
+      </div>
+      <div class="card-body">
+        <dl class="row">
+<% attributes.reject(&:password_digest?).each do |attribute| -%>
+          <dt class="col-md-3"><%= attribute.human_name %></dt>
+<% if attribute.attachment? -%>
+          <dd class="col-md-9"><%%= link_to <%= singular_name %>.<%= attribute.column_name %>.filename, <%= singular_name %>.<%= attribute.column_name %> if <%= singular_name %>.<%= attribute.column_name %>.attached? %></dd>
+<% elsif attribute.attachments? -%>
+    <%% <%= singular_name %>.<%= attribute.column_name %>.each do |<%= attribute.singular_name %>| %>
+          <dd class="col-md-9"><%%= link_to <%= attribute.singular_name %>.filename, <%= attribute.singular_name %> %></dd>
+    <%% end %>
+<% else -%>
+          <dd class="col-md-9"><%%= @<%= singular_name %>.<%= attribute.column_name %> %></dd>
+<% end -%>
+<% end -%>
+        </dl>
+      </div>
+    </div>
+  </div>
+</div>

data/lib/generators/admin/scaffold/templates/functional_test.rb.tt

@@ -0,0 +1,53 @@
+require "test_helper"
+
+class <%= controller_class_name %>ControllerTest < ActionDispatch::IntegrationTest
+  <%- if mountable_engine? -%>
+  include Engine.routes.url_helpers
+
+  <%- end -%>
+  setup do
+    @admin_user = admin_sign_in_as admin_users(:lazaro_nixon)
+    @<%= singular_table_name %> = <%= fixture_name %>(:one)
+  end
+
+  test "should get index" do
+    get <%= index_helper(type: :url) %>
+    assert_response :success
+  end
+
+  test "should get new" do
+    get <%= new_helper %>
+    assert_response :success
+  end
+
+  test "should create <%= singular_table_name %>" do
+    assert_difference("<%= class_name %>.count") do
+      post <%= index_helper(type: :url) %>, params: { <%= "#{singular_table_name}: { #{attributes_string} }" %> }
+    end
+
+    assert_redirected_to <%= show_helper("#{class_name}.last") %>
+  end
+
+  test "should show <%= singular_table_name %>" do
+    get <%= show_helper %>
+    assert_response :success
+  end
+
+  test "should get edit" do
+    get <%= edit_helper %>
+    assert_response :success
+  end
+
+  test "should update <%= singular_table_name %>" do
+    patch <%= show_helper %>, params: { <%= "#{singular_table_name}: { #{attributes_string} }" %> }
+    assert_redirected_to <%= show_helper %>
+  end
+
+  test "should destroy <%= singular_table_name %>" do
+    assert_difference("<%= class_name %>.count", -1) do
+      delete <%= show_helper %>
+    end
+
+    assert_redirected_to <%= index_helper(type: :url) %>
+  end
+end

data/lib/generators/admin/scaffold/templates/system_test.rb.tt

@@ -0,0 +1,52 @@
+require "application_system_test_case"
+
+class <%= class_name.pluralize %>Test < ApplicationSystemTestCase
+  setup do
+    @admin_user = admin_sign_in_as(admin_users(:lazaro_nixon))
+    @<%= singular_table_name %> = <%= fixture_name %>(:one)
+  end
+
+  test "visiting the index" do
+    visit <%= index_helper(type: :url) %>
+    assert_selector "h2", text: "<%= human_name.pluralize %>"
+  end
+
+  test "should create <%= human_name.downcase %>" do
+    visit <%= index_helper(type: :url) %>
+    click_on "New <%= human_name.downcase %>"
+
+    <%- attributes_hash.each do |attr, value| -%>
+    <%- if boolean?(attr) -%>
+    check "<%= attr.humanize %>" if <%= value %>
+    <%- else -%>
+    fill_in "<%= attr.humanize %>", with: <%= value %>
+    <%- end -%>
+    <%- end -%>
+    click_on "Create <%= human_name %>"
+
+    assert_text "<%= human_name %> was successfully created"
+  end
+
+  test "should update <%= human_name %>" do
+    visit <%= show_helper(type: :url) %>
+    click_on "Edit <%= human_name.downcase %>", match: :first
+
+    <%- attributes_hash.each do |attr, value| -%>
+    <%- if boolean?(attr) -%>
+    check "<%= attr.humanize %>" if <%= value %>
+    <%- else -%>
+    fill_in "<%= attr.humanize %>", with: <%= value %>
+    <%- end -%>
+    <%- end -%>
+    click_on "Update <%= human_name %>"
+
+    assert_text "<%= human_name %> was successfully updated"
+  end
+
+  test "should destroy <%= human_name %>" do
+    visit <%= show_helper(type: :url) %>
+    page.accept_confirm { click_on "Delete <%= human_name.downcase %>" }
+
+    assert_text "<%= human_name %> was successfully destroyed"
+  end
+end