administration-one 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1a5a5aaf21f14faf81ce38558d16c86a7f4950c7cfa2edd1f0ac16f157776a70
+  data.tar.gz: ede5fb32819425bab63db3fbb764fb2c147009e9e8261e67d9b6c49256318865
+SHA512:
+  metadata.gz: c8811f2e428b657bad4155cfda93bb66d2c73e7e4abff09754d4876ef241b188022cbe086e8e5eda76d8bd884114f3d376b7cadd70d4b0b08138ead730529aee
+  data.tar.gz: 9d57bc0b477cc328ee682424be509ac2b8eaea70095fb46e2aa2163e803d2ebd57d96de7d5f7a1ef3929a5e3749dcbaabbbab3af7ce85c6be4f104e9a3ce498a

data/.dockerignore

@@ -0,0 +1,51 @@
+# See https://docs.docker.com/engine/reference/builder/#dockerignore-file for more about ignoring files.
+
+# Ignore git directory.
+/.git/
+/.gitignore
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all environment files.
+/.env*
+
+# Ignore all default key files.
+/config/master.key
+/config/credentials/*.key
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore pidfiles, but keep the directory.
+/tmp/pids/*
+!/tmp/pids/.keep
+
+# Ignore storage (uploaded files in development and any SQLite databases).
+/storage/*
+!/storage/.keep
+/tmp/storage/*
+!/tmp/storage/.keep
+
+# Ignore assets.
+/node_modules/
+/app/assets/builds/*
+!/app/assets/builds/.keep
+/public/assets
+
+# Ignore CI service files.
+/.github
+
+# Ignore Kamal files.
+/config/deploy*.yml
+/.kamal
+
+# Ignore development files
+/.devcontainer
+
+# Ignore Docker-related files
+/.dockerignore
+/Dockerfile*

data/.gitattributes

@@ -0,0 +1,9 @@
+# See https://git-scm.com/docs/gitattributes for more about git attribute files.
+
+# Mark the database schema as having been generated.
+db/schema.rb linguist-generated
+
+# Mark any vendored files as having been vendored.
+vendor/* linguist-vendored
+config/credentials/*.yml.enc diff=rails_credentials
+config/credentials.yml.enc diff=rails_credentials

data/.gitignore

@@ -0,0 +1,37 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# Temporary files generated by your text editor or operating system
+# belong in git's global ignore instead:
+# `$XDG_CONFIG_HOME/git/ignore` or `~/.config/git/ignore`
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all environment files.
+/.env*
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore pidfiles, but keep the directory.
+/tmp/pids/*
+!/tmp/pids/
+!/tmp/pids/.keep
+
+# Ignore storage (uploaded files in development and any SQLite databases).
+/storage/*
+!/storage/.keep
+/tmp/storage/*
+!/tmp/storage/
+!/tmp/storage/.keep
+
+/public/assets
+
+# Ignore master key for decrypting credentials and more.
+/config/master.key
+
+#Built gem files
+*.gem

data/.rubocop.yml

@@ -0,0 +1,8 @@
+# Omakase Ruby styling for Rails
+inherit_gem: { rubocop-rails-omakase: rubocop.yml }
+
+# Overwrite or add rules to create your own house style
+#
+# # Use `[a, [b, c]]` not `[ a, [ b, c ] ]`
+# Layout/SpaceInsideArrayLiteralBrackets:
+#   Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.4.1

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## [1.0.0] - 2025-05-16
+- Initial release

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in administration_one.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    administration-one (1.0.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (13.0.6)
+
+PLATFORMS
+  x86_64-darwin-21
+  x86_64-darwin-22
+  x86_64-darwin-23
+
+DEPENDENCIES
+  administration-one!
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.3.7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Alexey Beregovoy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# Administration One
+
+Administration One is a fork of [Administration Zero by Lázaro Nixon](https://github.com/lazaronixon/administration-zero), which can be considered as its charged and production-ready version. Like the original gem, it is designed for generating an administrative interface for Ruby on Rails applications. Administration-One includes all the original gem’s features but also comes with the following:
+
+* User management is built with the standard Rails authorization generator introduced in version 8+. Administrators are users with the `is_admin` field set to `true`.
+* EditorJS as the WYSIWYG editor.
+* Basic user profile management.
+* A functional light/dark theme switcher and other minor improvements.
+
+<img src=".documentation/screenshot.png" alt="screenshot" style="max-width: 100%;">
+
+## Installation
+
+```ruby
+bundle add administration-one
+```
+
+Then: 
+
+```
+rails generate admin:install
+```
+
+Then run `bundle install`
+
+Then run `rails db:migrate db:seed`
+
+You can access the admin panel in `/admin`, using `email: "admin@example.com", password: "Password1234"`
+
+## Scaffolding
+
+You'll need to create a model to be administrated, if you don't have one. for this example let's use the following:
+
+```
+rails generate model Post title:string content:text published:boolean
+```
+
+Now you are free to generate your admin scaffolds.
+
+```
+rails generate admin:scaffold posts title:string content:text published:boolean
+```
+
+Since this model has an attribute `content:text`, the generator will ask whether to use EditorJS. This question will be asked for any model that has an attribute named «content». 
+
+## A few words about EditorJS
+
+Since uploading images via EditorJS typically requires storage (which can be implemented in many different ways depending on the project) Administration One uses an universal solution: encoding all images to Base64. However, this approach may be not database-friendly. The author strongly recommends implementing file-based image uploads tailored to your project’s specific.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/administration_one.gemspec

@@ -0,0 +1,22 @@
+require_relative 'lib/administration_one/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "administration-one"
+  spec.version       = AdministrationOne::VERSION
+  spec.authors       = ["Alexey Beregovoy"]
+  spec.email         = ["thismailis4spam@icloud.com"]
+
+  spec.summary       = "An administration system generator for Rails applications"
+  spec.homepage      = "https://github.com/LawfulEvilRaccoon/administration-one"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/LawfulEvilRaccoon/administration-one"
+  spec.metadata["changelog_uri"] = "https://github.com/LawfulEvilRaccoon/administration-one/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+end

data/lib/administration-one.rb

@@ -0,0 +1 @@
+require "administration_one"

data/lib/administration_one/version.rb

@@ -0,0 +1,3 @@
+module AdministrationOne
+  VERSION = "1.0.0"
+end

data/lib/administration_one.rb

@@ -0,0 +1,4 @@
+require_relative "administration_one/version"
+
+module AdministrationOne
+end

data/lib/generators/admin/install/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Explain the generator
+
+Example:
+    bin/rails generate admin:install

data/lib/generators/admin/install/install_generator.rb

@@ -0,0 +1,142 @@
+require "rails/generators/active_record"
+
+module Admin
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+
+      source_root File.expand_path("templates", __dir__)
+
+      def add_field_error_proc
+        field_error_proc_code = <<~RUBY
+          # Provides an HTML generator for displaying errors that come from Active Model
+          config.action_view.field_error_proc = Proc.new do |html_tag, instance|
+            raw Nokogiri::HTML.fragment(html_tag).child.add_class("is-invalid")
+          end
+        RUBY
+
+        environment field_error_proc_code
+      end
+
+      def generate_authentication
+        system "bin/rails generate authentication"
+
+        # Rails auth generator makes route that generates routes for index & show actions. This is a quick fix for that.
+        gsub_file "config/routes.rb", "resources :passwords, param: :token",
+                  "resources :passwords, except: %i[ index show ], param: :token"
+      end
+
+      def install_active_storage
+        system "bin/rails active_storage:install"
+      end
+
+      def remove_default_users_migration
+        users_migration_filename = Dir.children('./db/migrate').find { |c| c.include?('users') }
+        File.delete("db/migrate/#{users_migration_filename}")
+      end
+
+      def add_gems
+        uncomment_lines "Gemfile", /"bcrypt"/
+        gem "pagy", comment: "Use Pagy to add paginated results [https://github.com/ddnexus/pagy]"
+        gem "ransack", comment: "Use Ransack to enable the creation of search forms for your application [https://github.com/activerecord-hackery/ransack]"
+        gem "spreadsheet_architect", comment: "Spreadsheet Architect is a library that allows you to create XLSX, ODS, or CSV spreadsheets super easily [https://github.com/westonganger/spreadsheet_architect]"
+      end
+
+      def create_db_files
+        copy_file "seeds.rb", "db/seeds.rb", force: true
+        migration_template "migrations/create_users.rb", "#{db_migrate_path}/create_users.rb"
+      end
+
+      def create_models
+        directory "models/admin", "app/models/admin"
+        copy_file "models/application_record.rb", "app/models/application_record.rb", force: true
+        copy_file "models/user.rb", "app/models/user.rb", force: true
+      end
+
+      def create_fixture_file
+        File.delete("test/fixtures/users.yml")
+        copy_file "test_unit/users.yml", "test/fixtures/users.yml"
+      end
+
+      def create_controllers
+        directory "controllers", "app/controllers", force: true
+      end
+
+      def create_views
+        directory "erb", "app/views"
+      end
+
+      def create_helpers
+        directory "helpers", "app/helpers"
+      end
+
+      def create_images
+        directory "images", "app/assets/images"
+      end
+
+      def create_jobs
+        directory "jobs", "app/jobs"
+      end
+
+      def copy_css_files
+        directory "css", "app/assets/stylesheets/admin"
+      end
+
+      def copy_javascript
+        directory "js", "app/javascript/admin"
+      end
+
+      def copy_modules
+        directory "modules", "app/modules"
+      end
+
+      def add_ejs_inflector
+        line = "ActiveSupport::Inflector.inflections "
+        RUBY_VERSION >= "3.4.0" ? line += "{ it.acronym \"EJS\" }" : line += "{ |it| it.acronym \"EJS\" }"
+        inject_into_file "config/initializers/inflections.rb", line
+      end
+
+      def add_admin_password_reset_mailer
+        inject_into_class "app/mailers/passwords_mailer.rb", "PasswordsMailer" do
+          "  def reset_admin(user)\n" +
+          "    @user = user\n" +
+          "    mail subject: \"Reset your admin's password\", to: user.email_address\n" +
+          "  end\n\n"
+        end
+
+        directory "passwords_mailer", "app/views/passwords_mailer"
+      end
+
+      def add_routes
+        route "get '/', to: 'home#index', as: 'root'", namespace: :admin
+        route "resources :users", namespace: :admin
+        route "get    'sign_in',  to: 'sessions#new'", namespace: :admin
+        route "post   'sign_in',  to: 'sessions#create'", namespace: :admin
+        route "post 'sign_out', to: 'sessions#destroy'", namespace: :admin
+        route "root to: 'admin/home#index'"
+        route 'get "profile", to: "profile#show"', namespace: :admin
+        route 'get "edit_profile", to: "profile#edit", as: "edit_profile"', namespace: :admin
+        route 'patch "profile", to: "profile#update"', namespace: :admin
+        route 'resources :passwords, except: %i[ index show ], param: :token', namespace: :admin
+      end
+
+      def create_test_files
+        File.delete('test/models/user_test.rb')
+        directory "test_unit/controllers", "test/controllers"
+        directory "test_unit/models", "test/models"
+        copy_file "test_unit/test_helper.rb", "test/test_helper.rb", force: true
+      end
+
+      def add_avatars_storage_config
+        empty_directory Rails.root.join("storage", "avatar_uploads_#{Rails.env}")
+        inject_into_file "config/storage.yml", "avatars_local_storage:\n" +
+          "  service: Disk\n" +
+          "  root: <%= Rails.root.join(\"storage\", \"avatar_uploads_\#{Rails.env}\") %>"
+      end
+
+      def restart_server
+        system "bin/rails restart"
+      end
+    end
+  end
+end

data/lib/generators/admin/install/templates/controllers/admin/base_controller.rb

@@ -0,0 +1,20 @@
+class Admin::BaseController < ActionController::Base
+  include Authentication
+  include Pagy::Backend
+
+  skip_before_action :require_authentication
+  before_action :authenticate_as_admin
+  around_action :set_time_zone
+
+  private
+    def set_time_zone
+      Time.use_zone(cookies[:time_zone]) { yield }
+    end
+
+    def authenticate_as_admin
+      resume_session
+      unless Current.user && Current.user.is_admin?
+        redirect_to admin_sign_in_path, alert: "Insufficient permissions for this action."
+      end
+    end
+end

data/lib/generators/admin/install/templates/controllers/admin/home_controller.rb

@@ -0,0 +1,4 @@
+class Admin::HomeController < Admin::BaseController
+  def index
+  end
+end

data/lib/generators/admin/install/templates/controllers/admin/passwords_controller.rb

@@ -0,0 +1,35 @@
+class Admin::PasswordsController < Admin::BaseController
+  skip_before_action :authenticate_as_admin
+  before_action :set_user_by_token, only: %i[ edit update ]
+
+  layout "admin/authentication"
+
+  def new
+  end
+
+  def create
+    if user = User.find_by(email_address: params[:email_address])
+      PasswordsMailer.reset_admin(user).deliver_later
+    end
+
+    redirect_to admin_sign_in_path, notice: "Password reset instructions sent (if user with that email address exists)."
+  end
+
+  def edit
+  end
+
+  def update
+    if @user.update(params.permit(:password, :password_confirmation))
+      redirect_to admin_sign_in_path, notice: "Password has been reset."
+    else
+      redirect_to edit_admin_password_path(params[:token]), alert: "Password does not match the confirmation or fails to meet the requirements."
+    end
+  end
+
+  private
+    def set_user_by_token
+      @user = User.find_by_password_reset_token!(params[:token])
+    rescue ActiveSupport::MessageVerifier::InvalidSignature
+      redirect_to new_admin_password_path, alert: "Password reset link is invalid or has expired."
+    end
+end

data/lib/generators/admin/install/templates/controllers/admin/profile_controller.rb

@@ -0,0 +1,23 @@
+class Admin::ProfileController < Admin::BaseController
+  before_action :set_user, only: %i[ show edit update ]
+
+  def show
+  end
+
+  def edit
+  end
+
+  def update
+    if @user.update params.require(:user).permit(:username, :email_address, :password, :password_confirmation)
+      redirect_to admin_profile_path, notice: "Profile has been updated"
+    else
+      render :edit, status: :unprocessable_entity
+    end
+  end
+
+  private
+
+  def set_user
+    @user = Current.user
+  end
+end

data/lib/generators/admin/install/templates/controllers/admin/sessions_controller.rb

@@ -0,0 +1,24 @@
+class Admin::SessionsController < Admin::BaseController
+  skip_before_action :authenticate_as_admin, except: :destroy
+  rate_limit to: 5, within: 10.minutes, only: :create, with: -> { redirect_to admin_sign_in_path, alert: "Try again later." }
+
+  layout "admin/authentication"
+
+  def new
+  end
+
+  def create
+    user = User.authenticate_by(params.permit(:email_address, :password))
+    if user && user.is_admin?
+      start_new_session_for user
+      redirect_to admin_root_path, notice: "Welcome!"
+    else
+      redirect_to admin_sign_in_path, alert: "Try another email address or password."
+    end
+  end
+
+  def destroy
+    terminate_session
+    redirect_to admin_sign_in_path, notice: "You've been signed out."
+  end
+end

data/lib/generators/admin/install/templates/controllers/admin/users_controller.rb

@@ -0,0 +1,54 @@
+class Admin::UsersController < Admin::BaseController
+  before_action :set_user, only: %i[ show edit update destroy ]
+
+  def index
+    @search = User.all.ransack(params[:q])
+
+    respond_to do |format|
+      format.html { @pagy, @users = pagy(@search.result) }
+      format.csv  { render csv: @search.result }
+    end
+  end
+
+  def show
+  end
+
+  def new
+    @user = User.new
+  end
+
+  def edit
+  end
+
+  def create
+    @user = User.new(user_params)
+
+    if @user.save
+      redirect_to admin_user_path(@user), notice: "User was successfully created."
+    else
+      render :new, status: :unprocessable_entity
+    end
+  end
+
+  def update
+    if @user.update(user_params)
+      redirect_to admin_user_path(@user), notice: "User was successfully updated."
+    else
+      render :edit, status: :unprocessable_entity
+    end
+  end
+
+  def destroy
+    @user.destroy
+    redirect_to admin_users_path, notice: "User was successfully destroyed.", status: :see_other
+  end
+
+  private
+    def set_user
+      @user = User.find_by(id: params[:id])
+    end
+
+    def user_params
+      params.require(:user).permit(:username, :email_address, :password, :password_confirmation, :is_admin)
+    end
+end

data/lib/generators/admin/install/templates/css/custom.css

@@ -0,0 +1,85 @@
+.form-group {
+  padding-top: 0.5rem;
+}
+.true {
+  color: var(--tblr-green);
+}
+.false {
+  color: var(--tblr-red);
+}
+
+.theme-switcher {
+  cursor: pointer;
+}
+
+/* Flash messages */
+
+.flash-messages-wrapper {
+  position: absolute;
+  top: 1rem;
+  left: calc((100% - 350px) / 2);
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+  z-index: 1050;
+  right: auto;
+}
+
+.toast {
+  animation-name: flash-message;
+  animation-duration: 3s;
+}
+
+.toast:not(:first-child) {
+  margin-top: 1rem;
+}
+
+.toast-body {
+  background-color: var(--tblr-gray-600);
+}
+
+.message-alert {
+  background-color: var(--tblr-warning);
+}
+
+@keyframes flash-message {
+  0% { opacity: 0 }
+  15% { opacity: 0.95 }
+  75% { opacity: 0.95 }
+  100% { opacity: 0 }
+}
+
+/* EditorJS */
+
+.ce-paragraph.cdx-block {
+  font-weight: 400;
+}
+
+.ce-toolbar__plus, .ce-toolbar__settings-btn {
+  background-color: var(--tblr-indigo);
+  color: var(--tblr-gray-100);
+}
+
+.ce-toolbar__plus:hover,
+.cdx-settings-button:hover,
+.ce-settings__button:hover,
+.ce-toolbox__button--active,
+.ce-toolbox__button:hover,
+.cdx-button:hover,
+.ce-inline-toolbar__dropdown:hover,
+.ce-inline-tool:hover,
+.ce-popover__item:hover,
+.ce-toolbar__settings-btn:hover {
+  background-color: var(--tblr-indigo-darken);
+  color: var(--tblr-gray-100);
+}
+
+@media (min-width: 768px) {
+  .ce-toolbar__content {
+    max-width: calc(100% - 8rem);
+  }
+  
+  .ce-block__content {
+    max-width: calc(100% - 10rem);
+  }
+}