administration-zero 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 631eb6474ed5d2677353b675da33f5dc6ffe728a75c782f264386d5d70cf77bb
+  data.tar.gz: 977ff8b33aaeb393ff8d5a35eadb59fcf6436d3fe87e065fdeff319186c8442b
+SHA512:
+  metadata.gz: 464d70d9d38119bc9cbd519e9b0345f4db705a6be203b62893a6e5395a1f046a611f14d54a1191a934eb59d1ae65a5a8e719dd4dbac3f0802e1b01bf3d2576c6
+  data.tar.gz: 4ce3bcd7fa19c2cbe83b12c6339f324e269ca8fe7b527b5882abd9c02fa18098effbc0f9b5d1109278f23800a98aa894f8910c3b30e9d6f9cb6fc0eae17515ce

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at lazaronixon@hotmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

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

data/Gemfile.lock

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Nixon
+
+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 Zero
+
+The purpose of administration zero is to generate a pre-built administration panel into a rails application.
+
+## Features
+
+- [Beautiful interface](https://github.com/tabler/tabler)
+- [Paginated results](https://github.com/ddnexus/pagy)
+- [Sortable and filterable](https://github.com/activerecord-hackery/ransack)
+- [Exportable data](https://github.com/westonganger/spreadsheet_architect)
+- Easy authentication system
+- Admin scaffolds
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "authentication-zero"
+```
+
+Then run `bundle install`
+
+## Usage
+
+```
+$ rails generate admin:install
+```
+
+Then run `bundle install` again, now you're ready to generate your admin scaffolds.
+
+```
+$ rails generate admin:scaffold posts title:string body:text published:boolean
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lazaronixon/administration-zero. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/lazaronixon/administration-zero/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the AdministrationZero project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/lazaronixon/administration-zero/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/administration_zero.gemspec

@@ -0,0 +1,22 @@
+require_relative 'lib/administration_zero/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "administration-zero"
+  spec.version       = AdministrationZero::VERSION
+  spec.authors       = ["Nixon"]
+  spec.email         = ["lazaronixon@hotmail.com"]
+
+  spec.summary       = "An administration system generator for Rails applications"
+  spec.homepage      = "https://github.com/lazaronixon/authentication-zero"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/lazaronixon/administration-zero"
+  spec.metadata["changelog_uri"] = "https://github.com/lazaronixon/administration-zero/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-zero.rb

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

data/lib/administration_zero/version.rb

@@ -0,0 +1,3 @@
+module AdministrationZero
+  VERSION = "0.0.1"
+end

data/lib/administration_zero.rb

@@ -0,0 +1,4 @@
+require_relative "administration_zero/version"
+
+module AdministrationZero
+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,68 @@
+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_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_migrations
+        migration_template "migrations/create_admin_users.rb", "#{db_migrate_path}/create_admin_users.rb"
+      end
+
+      def create_models
+        directory "models/admin", "app/models/admin"
+        copy_file "models/admin_user.rb", "app/models/admin_user.rb"
+        copy_file "models/application_record.rb", "app/models/application_record.rb", force: true
+      end
+
+      def create_fixture_file
+        copy_file "test_unit/admin_users.yml", "test/fixtures/admin_users.yml"
+      end
+
+      def create_controllers
+        directory "controllers", "app/controllers"
+      end
+
+      def create_views
+        directory "erb", "app/views"
+      end
+
+      def create_helpers
+        directory "helpers", "app/helpers"
+      end
+
+      def create_mailers
+        directory "mailers", "app/mailers"
+      end
+
+      def create_images
+        directory "images", "app/assets/images"
+      end
+
+      def add_routes
+        route "resource  :password_reset", namespace: :admin
+        route "resources :users", namespace: :admin
+        route "delete 'sign_out', to: 'sessions#destroy'", namespace: :admin
+        route "post   'sign_in',  to: 'sessions#create'", namespace: :admin
+        route "get    'sign_in',  to: 'sessions#new'", namespace: :admin
+        route "get    '/',        to: 'home#index'", namespace: :admin
+      end
+
+      def create_test_files
+        directory "test_unit/controllers", "test/controllers"
+        directory "test_unit/system", "test/system"
+        copy_file "test_unit/test_helper.rb", "test/test_helper.rb", force: true
+        copy_file "test_unit/application_system_test_case.rb", "test/application_system_test_case.rb", force: true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+class Admin::ApplicationController < ActionController::Base
+  include Pagy::Backend
+
+  before_action :authenticate
+
+  def authenticate
+    if admin_user = AdminUser.find_by_id(session[:admin_user_id])
+      Admin::Current.user = admin_user
+    else
+      redirect_to admin_sign_in_path
+    end
+  end
+end

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

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

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

@@ -0,0 +1,41 @@
+class Admin::PasswordResetsController < Admin::ApplicationController
+  skip_before_action :authenticate
+
+  before_action :set_admin_user, only: %i[ edit update ]
+
+  layout "admin/authentication"
+
+  def new
+  end
+
+  def edit
+  end
+
+  def create
+    if @admin_user = AdminUser.find_by(email: params[:email])
+      Admin::UserMailer.with(admin_user: @admin_user).password_reset_provision.deliver_later
+      redirect_to admin_sign_in_path, notice: "Check your email for reset instructions"
+    else
+      redirect_to new_admin_password_reset_path, alert: "Sorry, we didn't recognize that email address"
+    end
+  end
+
+  def update
+    if @admin_user.update(admin_user_params)
+      redirect_to admin_sign_in_path, notice: "Your password was reset successfully. Please sign in"
+    else
+      render :edit, status: :unprocessable_entity
+    end
+  end
+
+  private
+    def set_admin_user
+      @admin_user = AdminUser.find_signed!(params[:token], purpose: :password_reset)
+    rescue
+      redirect_to new_admin_password_reset_path, alert: "That password reset link is invalid"
+    end
+
+    def admin_user_params
+      params.permit(:password, :password_confirmation)
+    end
+end

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

@@ -0,0 +1,25 @@
+class Admin::SessionsController < Admin::ApplicationController
+  skip_before_action :authenticate, only: %i[ new create ]
+
+  layout "admin/authentication"
+
+  def new
+    @admin_user = AdminUser.new
+  end
+
+  def create
+    @admin_user = AdminUser.find_by(email: params[:email])
+
+    if @admin_user && @admin_user.authenticate(params[:password])
+      session[:admin_user_id] = @admin_user.id
+
+      redirect_to admin_path
+    else
+      redirect_to admin_sign_in_path(email_hint: params[:email]), alert: "That email or password is incorrect"
+    end
+  end
+
+  def destroy
+    session[:admin_user_id] = nil; redirect_to admin_sign_in_path
+  end
+end

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

@@ -0,0 +1,54 @@
+class Admin::UsersController < Admin::ApplicationController
+  before_action :set_admin_user, only: %i[ show edit update destroy ]
+
+  def index
+    @search = AdminUser.all.ransack(params[:q])
+
+    respond_to do |format|
+      format.html { @pagy, @admin_users = pagy(@search.result) }
+      format.csv  { render csv: @search.result }
+    end
+  end
+
+  def show
+  end
+
+  def new
+    @admin_user = AdminUser.new
+  end
+
+  def edit
+  end
+
+  def create
+    @admin_user = AdminUser.new(admin_user_params)
+
+    if @admin_user.save
+      redirect_to @admin_user, notice: "User was successfully created."
+    else
+      render :new, status: :unprocessable_entity
+    end
+  end
+
+  def update
+    if @admin_user.update(admin_user_params)
+      redirect_to @admin_user, notice: "User was successfully updated."
+    else
+      render :edit, status: :unprocessable_entity
+    end
+  end
+
+  def destroy
+    @admin_user.destroy
+    redirect_to admin_users_url, notice: "User was successfully destroyed."
+  end
+
+  private
+    def set_admin_user
+      @admin_user = AdminUser.find(params[:id])
+    end
+
+    def admin_user_params
+      params.require(:admin_user).permit(:email, :password, :password_confirmation)
+    end
+end

data/lib/generators/admin/install/templates/erb/admin/application/_flash_messages.html.erb

@@ -0,0 +1,11 @@
+<% if flash[:notice] %>
+  <div class="alert alert-success mb-0 mt-3" role="alert">
+    <div class="text-muted"><%= flash[:notice] %></div>
+  </div>
+<% end %>
+
+<% if flash[:alert] %>
+  <div class="alert alert-danger mb-0 mt-3" role="alert">
+    <div class="text-muted"><%= flash[:alert] %></div>
+  </div>
+<% end %>

data/lib/generators/admin/install/templates/erb/admin/application/_footer.html.erb

@@ -0,0 +1,34 @@
+<footer class="footer footer-transparent d-print-none">
+  <div class="container-fluid">
+    <div class="row text-center align-items-center flex-row-reverse">
+      <div class="col-lg-auto ms-lg-auto">
+        <ul class="list-inline list-inline-dots mb-0">
+          <li class="list-inline-item"><a href="./docs/index.html" class="link-secondary">Documentation</a></li>
+          <li class="list-inline-item"><a href="./license.html" class="link-secondary">License</a></li>
+          <li class="list-inline-item"><a href="https://github.com/tabler/tabler" target="_blank" class="link-secondary" rel="noopener">Source code</a></li>
+          <li class="list-inline-item">
+            <a href="https://github.com/sponsors/codecalm" target="_blank" class="link-secondary" rel="noopener">
+              <!-- Download SVG icon from http://tabler-icons.io/i/heart -->
+              <svg xmlns="http://www.w3.org/2000/svg" class="icon text-pink icon-filled icon-inline" width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"/><path d="M19.5 13.572l-7.5 7.428l-7.5 -7.428m0 0a5 5 0 1 1 7.5 -6.566a5 5 0 1 1 7.5 6.572" /></svg>
+              Sponsor
+            </a>
+          </li>
+        </ul>
+      </div>
+      <div class="col-12 col-lg-auto mt-3 mt-lg-0">
+        <ul class="list-inline list-inline-dots mb-0">
+          <li class="list-inline-item">
+            Copyright &copy; 2022
+            <a href="." class="link-secondary">Tabler</a>.
+            All rights reserved.
+          </li>
+          <li class="list-inline-item">
+            <a href="./changelog.html" class="link-secondary" rel="noopener">
+              v1.0.0-beta6
+            </a>
+          </li>
+        </ul>
+      </div>
+    </div>
+  </div>
+</footer>

data/lib/generators/admin/install/templates/erb/admin/application/_javascript_tags.html.erb

@@ -0,0 +1,23 @@
+<!-- Tabler Core -->
+<script src="https://unpkg.com/@tabler/core@1.0.0-beta9/dist/js/tabler.min.js"></script>
+
+<!-- bring back data-confirm -->
+<script>
+  document.addEventListener("click", (event) => {
+    if (!event.target.matches("[data-confirm]")) return;
+    if (!window.confirm(event.target.dataset["confirm"])) event.preventDefault();
+  });
+</script>
+
+<!-- validation rails -->
+<script>
+  document.addEventListener("DOMContentLoaded", () => {
+    document.querySelectorAll(".field_with_errors").forEach((element) => {
+      const field = element.firstChild;
+      field.classList.add("is-invalid");
+
+      element.parentNode.insertBefore(field, element);
+      element.parentNode.removeChild(element);
+    })
+  });
+</script>

data/lib/generators/admin/install/templates/erb/admin/application/_page_header.html.erb

@@ -0,0 +1,8 @@
+<div class="container-fluid">
+  <div class="page-header">
+    <div class="row align-items-center">
+      <%= yield %>
+    </div>
+  </div>
+  <%= render "flash_messages" %>
+</div>

data/lib/generators/admin/install/templates/erb/admin/application/_page_header_actions.html.erb

@@ -0,0 +1,5 @@
+<div class="col-auto">
+  <div class="btn-list">
+    <%= yield %>
+  </div>
+</div>

data/lib/generators/admin/install/templates/erb/admin/application/_page_header_breadcrumb.html.erb

@@ -0,0 +1,12 @@
+<%= content_for :title, title %>
+
+<div class="col">
+  <div class="mb-1">
+    <ol class="breadcrumb" aria-label="breadcrumbs">
+      <%= yield %>
+    </ol>
+  </div>
+  <h2 class="page-title">
+    <span class="text-truncate"><%= title %></span>
+  </h2>
+</div>

data/lib/generators/admin/install/templates/erb/admin/application/_pagination.html.erb

@@ -0,0 +1,24 @@
+<%#
+  This template is i18n-ready: if you don't use i18n, then you can replace the pagy_t
+  calls with the actual strings ("&lsaquo; Prev", "Next &rsaquo;", "&hellip;").
+
+  The link variable is set to a proc that returns the link tag.
+  Usage: link.call( page_number [, text [, extra_attributes_string ]])
+-%>
+<% link = pagy_link_proc(pagy, link_extra: 'class="page-link"') -%>
+<%#                            -%><nav aria-label="pager" class="pagy-bootstrap-nav d-inline-block" role="navigation">
+<%#                            -%>  <ul class="pagination m-0">
+<% if pagy.prev                -%>    <li class="page-item prev"><%== link.call(pagy.prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"') %></li>
+<% else                        -%>    <li class="page-item prev disabled"><a href="#" class="page-link"><%== pagy_t('pagy.nav.prev') %></a></li>
+<% end                         -%>
+<% pagy.series.each do |item| # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36] -%>
+<%   if    item.is_a?(Integer) -%>    <li class="page-item"><%== link.call(item) %></li>
+<%   elsif item.is_a?(String)  -%>    <li class="page-item active"><%== link.call(item) %></li>
+<%   elsif item == :gap        -%>    <li class="page-item disabled gap"><a href="#" class="page-link"><%== pagy_t('pagy.nav.gap') %></a></li>
+<%   end                       -%>
+<% end                         -%>
+<% if pagy.next                -%>    <li class="page-item next"><%== link.call(pagy.next, pagy_t('pagy.nav.next'), 'aria-label="next"') %></li>
+<% else                        -%>    <li class="page-item next disabled"><a href="#" class="page-link"><%== pagy_t('pagy.nav.next') %></a></li>
+<% end                         -%>
+<%#                            -%>  </ul>
+<%#                            -%></nav>