madmin 0.1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be4b01320deccbc46e6184ae804f74e278c909ec7b11f74274f09dc4442e78d4
-  data.tar.gz: cdecb4f3ca23924befe03dc43ec4dda63626adabc24c70cbc892e3e21dd0ca62
+  metadata.gz: f149452559626564a6b3888b89ddeaf7fb2bf1c3fedbbc4ac4ba3dc2a1df4e58
+  data.tar.gz: 8536e397b8d032d704b7e10c938af1ee1eda4911d9c6933ecd9c11f68fbac8f7
 SHA512:
-  metadata.gz: 7f8691c029a1f37cf1b515c1ec399481d12ee2a4320c1e564f586e38b2d7e12610796df1c3b391356496dfca4c6b1d156b5459850873dd6bda54940e69a2f951
-  data.tar.gz: 36e1b5138b977c5a7bb46b7e1a96078c645c204865de2df919fdef9909c4ac9ba6930b18ad905ca6489ff6e8b11656776561aa1c424b38d79ba3e9db3beee204
+  metadata.gz: e6a4a123086ee55711728e9f2b1bff5ca90d28c7238690d5f51e9b834f1f5eb15170b7e8e3b1aac7a79e08d4b55ee2500dc11f16d4f62c4a31cc4d0d5ab0b6ba
+  data.tar.gz: 49a20396c04c22fbe8001d53ed4cc567b441171943a090cd888b98e94cbf11b31ad5ec89fc67dd9cae98af03282adf8bdacec159075c73605ac743c994338e51

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2019 Jason Charnes
+Copyright 2020 Chris Oliver
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,102 +1,89 @@
 # Madmin
 
-Short description and motivation.
+### 🛠 A robust Admin Interface for Ruby on Rails apps
 
-## Usage
+[![Build Status](https://github.com/excid3/madmin/workflows/Tests/badge.svg)](https://github.com/excid3/madmin/actions) [![Gem Version](https://badge.fury.io/rb/madmin.svg)](https://badge.fury.io/rb/madmin)
 
-How to use my plugin.
+Why another Ruby on Rails admin? We wanted an admin that was:
 
-## Installation
-
-Add this line to your application's Gemfile:
+* Familiar and customizable like Rails scaffolds (less DSL)
+* Supports all the Rails features out of the box (ActionText, ActionMailbox, etc)
+* Stimulus / Turbolinks / Hotwire ready
 
-```ruby
-gem 'madmin'
-```
-
-And then execute:
+## Installation
+Add `madmin` to your application's Gemfile:
 
 ```bash
-$ bundle
+bundle add madmin
 ```
 
-Or install it yourself as:
+Then run the madmin generator:
 
 ```bash
-$ gem install madmin
+rails g madmin:install
 ```
 
-Then you can run the installer to generate resources for all models in
-your app that inherit from `ActiveRecord::Base` by running:
+This will install Madmin and generate resources for each of the models it finds.
 
-```bash
-rails generate madmin:install
-```
+## Resources
+
+Madmin uses `Resource` classes to add models to the admin area.
 
-## Generating Resources
+### Generate a Resource
 
-To generate (or re-generate) a Madmin dashboard for a resource, you
-can run the following command and pass in the model name
+To generate a resource for a model, you can run:
 
 ```bash
-rails generate madmin:install User
+rails g madmin:resource ActionText::RichText
 ```
 
-## Implementing Authentication
+## Configuring Views
 
-To implement user authentication for your admin dashboard, you can override `authenticate!` in `app/controllers/madmin/application_controller.rb`.
+The views packaged within the gem are a great starting point, but inevitably people will need to be able to customize those views.
 
-To access this controller run the following command
+You can use the included generator to create the appropriate view files, which can then be customized.
 
+For example, running the following will copy over all of the views into your application that will be used for every resource:
 ```bash
-rails generate madmin:controller Application
+rails generate madmin:views
 ```
 
-If you're using Devise, simply have `authenticate!` authenticate your resource
+The view files that are copied over in this case includes all of the standard Rails action views (index, new, edit, show, and _form), as well as:
+* `application.html.erb` (layout file)
+* `_javascript.html.erb` (default JavaScript setup)
+* `_navigation.html.erb` (renders the navigation/sidebar menu)
 
-```ruby
-class Madmin::ApplicationController < Madmin::BaseController
-  ...
-
-  private
+As with the other views, you can specifically run the views generator for only the navigation or application layout views:
+```bash
+rails g madmin:views:navigation
+ # -> app/views/madmin/_navigation.html.erb
 
-  def authenticate!
-    authenticate_user!
-  end
-end
+rails g madmin:views:layout  # Note the layout generator includes the layout, javascript, and navigation files.
+ # -> app/views/madmin/application.html.erb
+ # -> app/views/madmin/_javascript.html.erb
+ # -> app/views/madmin/_navigation.html.erb
 ```
 
-If you're wanting to use simple HTTP Basic authentication, have `authenticate!` use `authenticate_with_http_basic` like the following
-
-```ruby
-class Madmin::ApplicationController < Madmin::BaseController
-  ...
-
-  private
-
-  def authenticate!
-    authenticated = authenticate_with_http_basic { |user, password|
-      user == "user" && password == "password"
-    }
-
-    request_http_basic_authentication unless authenticated
-  end
-end
+If you only need to customize specific views, you can restrict which views are copied by the generator:
+```bash
+rails g madmin:views:index
+ # -> app/views/madmin/application/index.html.erb
 ```
 
-## Autoloading Lib
-
-If you want to avoid having to restart your Rails application everytime you make an adjustment to a `lib/madmin/resources.rb`, add the following to `config/application.rb`:
-
-```ruby
-# Autoload Madmin
-config.autoload_paths += Dir["#{config.root}/lib/madmin/**/"]
+You can also scope the copied view(s) to a specific Resource/Model:
+```bash
+rails generate madmin:views:index Book
+ # -> app/views/madmin/books/index.html.erb
 ```
 
-## Contributing
+## Authentication
+
+You can use a couple of strategies to authenticate users who are trying to
+access your madmin panel: [Authentication Docs](docs/authentication.md)
 
-Contribution directions go here.
+## 🙏 Contributing
 
-## License
+This project uses Standard for formatting Ruby code. Please make sure to run standardrb before submitting pull requests.
 
+## 📝 License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -8,21 +8,20 @@ require "rdoc/task"
 
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = "rdoc"
-  rdoc.title    = "Madmin"
+  rdoc.title = "Madmin"
   rdoc.options << "--line-numbers"
   rdoc.rdoc_files.include("README.md")
   rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
-APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
-load "rails/tasks/engine.rake"
-
-load "rails/tasks/statistics.rake"
-
 require "bundler/gem_tasks"
 
 require "rake/testtask"
 
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+load "rails/tasks/statistics.rake"
+
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.pattern = "test/**/*_test.rb"

data/app/assets/config/manifest.js

@@ -0,0 +1,2 @@
+//= link_tree ../images
+//= link_directory ../stylesheets .css

data/app/assets/stylesheets/actiontext.scss

@@ -0,0 +1,36 @@
+//
+// Provides a drop-in pointer for the default Trix stylesheet that will format the toolbar and
+// the trix-editor content (whether displayed or under editing). Feel free to incorporate this
+// inclusion directly in any other asset bundle and remove this file.
+//
+//= require trix/dist/trix
+
+// We need to override trix.css’s image gallery styles to accommodate the
+// <action-text-attachment> element we wrap around attachments. Otherwise,
+// images in galleries will be squished by the max-width: 33%; rule.
+.trix-content {
+  .attachment-gallery {
+    > action-text-attachment,
+    > .attachment {
+      flex: 1 0 33%;
+      padding: 0 0.5em;
+      max-width: 33%;
+    }
+
+    &.attachment-gallery--2,
+    &.attachment-gallery--4 {
+      > action-text-attachment,
+      > .attachment {
+        flex-basis: 50%;
+        max-width: 50%;
+      }
+    }
+  }
+
+  action-text-attachment {
+    .attachment {
+      padding: 0 !important;
+      max-width: 100% !important;
+    }
+  }
+}

data/app/assets/stylesheets/{madmin/application.css → application.css}

@@ -2,8 +2,8 @@
  * This is a manifest file that'll be compiled into application.css, which will include all the files
  * listed below.
  *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, or any plugin's
+ * vendor/assets/stylesheets directory can be referenced here using a relative path.
  *
  * You're free to add application-wide styles to this file and they'll appear at the bottom of the
  * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
@@ -13,10 +13,3 @@
  *= require_tree .
  *= require_self
  */
-
-.sidebar {
-  height: 100%;
-  left: 0;
-  position: fixed;
-  top: 0;
-}

data/app/controllers/madmin/base_controller.rb

@@ -1,16 +1,12 @@
-require_dependency "madmin/resources"
-
 module Madmin
   class BaseController < ActionController::Base
-    before_action :validate_resources
+    include Pagy::Backend
 
-    private
+    protect_from_forgery with: :exception
 
-    # Taking a peek at all the resources will raise an error if one isn't found.
-    # Let's inform the user if we can't find a resource no matter what page
-    # they're on. This should fail to prevent surprises at run time.
-    def validate_resources
-      Madmin::Resources.all
+    # Loads all the models for the sidebar
+    before_action do
+      Rails.application.eager_load!
     end
   end
 end

data/app/controllers/madmin/dashboard_controller.rb

@@ -1,8 +1,6 @@
-require_dependency "madmin/application_controller"
-
 module Madmin
   class DashboardController < ApplicationController
-    def index
+    def show
     end
   end
 end

data/app/controllers/madmin/resource_controller.rb

@@ -0,0 +1,81 @@
+module Madmin
+  class ResourceController < ApplicationController
+    before_action :set_record, except: [:index, :new, :create]
+
+    def index
+      @pagy, @records = pagy(scoped_resources)
+    end
+
+    def show
+    end
+
+    def new
+      @record = resource.model.new
+    end
+
+    def create
+      @record = resource.model.new(resource_params)
+      if @record.save
+        redirect_to resource.show_path(@record)
+      else
+        render :new, status: :unprocessable_entity
+      end
+    end
+
+    def edit
+    end
+
+    def update
+      if @record.update(resource_params)
+        redirect_to resource.show_path(@record)
+      else
+        render :edit, status: :unprocessable_entity
+      end
+    end
+
+    def destroy
+      @record.destroy
+      redirect_to resource.index_path
+    end
+
+    private
+
+    def set_record
+      @record = resource.model.find(params[:id])
+    end
+
+    def resource
+      @resource ||= resource_name.constantize
+    end
+    helper_method :resource
+
+    def resource_name
+      "#{controller_path.singularize}_resource".delete_prefix("madmin/").classify
+    end
+
+    def scoped_resources
+      resource.model.send(valid_scope)
+    end
+
+    def valid_scope
+      scope = params.fetch(:scope, "all")
+      resource.scopes.include?(scope.to_sym) ? scope : :all
+    end
+
+    def resource_params
+      params.require(resource.param_key)
+        .permit(*resource.permitted_params)
+        .transform_values { |v| change_polymorphic(v) }
+    end
+
+    def change_polymorphic(data)
+      return data unless data.is_a?(ActionController::Parameters) && data[:type]
+
+      if data[:type] == "polymorphic"
+        GlobalID::Locator.locate(data[:value])
+      else
+        raise "Unrecognised param data: #{data.inspect}"
+      end
+    end
+  end
+end

data/app/helpers/madmin/application_helper.rb

@@ -1,15 +1,17 @@
 module Madmin
   module ApplicationHelper
-    def available_resources
-      @available_resources ||= Madmin::Resources.gather.map { |model| madmin_resource_for(model: model) }
-    end
+    include Pagy::Frontend
 
-    def madmin_resource_for(model:)
-      Object.const_get("::Madmin::Resources::#{model}").new
-    end
+    # Converts a Rails version to a NPM version
+    def npm_rails_version
+      version = [
+        Rails::VERSION::MAJOR,
+        Rails::VERSION::MINOR,
+        Rails::VERSION::TINY
+      ].join(".")
 
-    def pages
-      Madmin::Pages.all
+      version += "-#{Rails::VERSION::PRE}" if Rails::VERSION::PRE
+      version
     end
   end
 end

data/app/views/layouts/madmin/application.html.erb

@@ -1,30 +1,28 @@
 <!DOCTYPE html>
-<html>
-<head>
-  <title>Madmin</title>
-  <%= csrf_meta_tags %>
-  <%= csp_meta_tag %>
+<html lang="<%= I18n.locale %>">
+  <head>
+    <meta charset="utf-8">
+    <meta name="ROBOTS" content="NOODP">
+    <meta name="viewport" content="initial-scale=1">
+    <title>
+      Madmin: <%= Rails.application.class %>
+    </title>
+    <link href="https://unpkg.com/tailwindcss@^2.0/dist/tailwind.min.css" rel="stylesheet" />
+    <link href="https://unpkg.com/@tailwindcss/forms/dist/forms.min.css" rel="stylesheet" />
+    <link href="https://unpkg.com/@tailwindcss/typography/dist/typography.min.css" rel="stylesheet" />
+    <%= csrf_meta_tags %>
 
-  <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css" integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous">
-
-  <%= stylesheet_link_tag "madmin/application", media: "all" %>
-</head>
-<body>
-  <div class="container-fluid">
-    <div class="row">
-      <%= render 'application/navigation' %>
-      <div class="col-10 ml-sm-auto mt-4">
-        <div class="container">
-          <%= yield %>
-        </div>
+    <%= render "javascript" %>
+  </head>
+  <body class="prose" style="max-width:none">
+    <div class="flex w-full p-4">
+      <div id="sidebar" class="w-64 flex-shrink-0">
+        <%= render "navigation" -%>
       </div>
+      <main class="w-full" role="main">
+        <%#= render "flashes" -%>
+        <%= yield %>
+      </main>
     </div>
-  </div>
-
-  <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js" integrity="sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM" crossorigin="anonymous"></script>
-  <script src="https://code.jquery.com/jquery-3.3.1.slim.min.js" integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo" crossorigin="anonymous"></script>
-  <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.7/umd/popper.min.js" integrity="sha384-UO2eT0CpHqdSJQ6hJty5KVphtPhzWj9WO1clHTMGa3JDZwrnQq4sF86dIHNDz0W1" crossorigin="anonymous"></script>
-  <script src="https://unpkg.com/axios/dist/axios.min.js"></script>
-  <%= javascript_include_tag "madmin/application" %>
-</body>
+  </body>
 </html>