madmin 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be4b01320deccbc46e6184ae804f74e278c909ec7b11f74274f09dc4442e78d4
-  data.tar.gz: cdecb4f3ca23924befe03dc43ec4dda63626adabc24c70cbc892e3e21dd0ca62
+  metadata.gz: 3ae907c78952efd333b7151ef50818dc6b171017239a11152c129c17bb45af10
+  data.tar.gz: 923a8e6ecb3e84bffd6973a511845cc16cc599e36adc5116525ab01e46bc1c16
 SHA512:
-  metadata.gz: 7f8691c029a1f37cf1b515c1ec399481d12ee2a4320c1e564f586e38b2d7e12610796df1c3b391356496dfca4c6b1d156b5459850873dd6bda54940e69a2f951
-  data.tar.gz: 36e1b5138b977c5a7bb46b7e1a96078c645c204865de2df919fdef9909c4ac9ba6930b18ad905ca6489ff6e8b11656776561aa1c424b38d79ba3e9db3beee204
+  metadata.gz: c696a1782666fdcc4a113d7709775c41e245a9f92ef298c93a6fb98a1c1f2db4f5a34f36d59a1c3da476a6db44bfcc864f5b37c8136ef8f8a155415344b74660
+  data.tar.gz: d7eef669f0b0366ccaf73f3cd68f85525067172ade70c55397b9cd27e7132c3008a067d68d5bc3d073e94441f1cbf8a9e893a11a2b91fbfd0dbdd6a695487230

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,27 @@
 # 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)
 
+## Usage
 How to use my plugin.
 
 ## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'madmin'
-```
-
-And then execute:
-
-```bash
-$ bundle
-```
-
-Or install it yourself as:
-
-```bash
-$ gem install madmin
-```
-
-Then you can run the installer to generate resources for all models in
-your app that inherit from `ActiveRecord::Base` by running:
-
-```bash
-rails generate madmin:install
-```
-
-## Generating Resources
-
-To generate (or re-generate) a Madmin dashboard for a resource, you
-can run the following command and pass in the model name
+Add `madmin` to your application's Gemfile:
 
 ```bash
-rails generate madmin:install User
+bundle add madmin
 ```
 
-## Implementing Authentication
-
-To implement user authentication for your admin dashboard, you can override `authenticate!` in `app/controllers/madmin/application_controller.rb`.
-
-To access this controller run the following command
+Then run the madmin generator:
 
 ```bash
-rails generate madmin:controller Application
-```
-
-If you're using Devise, simply have `authenticate!` authenticate your resource
-
-```ruby
-class Madmin::ApplicationController < Madmin::BaseController
-  ...
-
-  private
-
-  def authenticate!
-    authenticate_user!
-  end
-end
-```
-
-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
-```
-
-## 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/**/"]
+rails g madmin:install
 ```
 
 ## Contributing
-
 Contribution directions go here.
 
 ## License
-
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -8,17 +8,12 @@ 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"

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/application_controller.rb

@@ -1,16 +1,12 @@
 module Madmin
-  class ApplicationController < BaseController
-    protect_from_forgery with: :exception
-
-    before_action :authenticate!
+  class ApplicationController < ActionController::Base
+    include Pagy::Backend
 
-    private
+    protect_from_forgery with: :exception
 
-    def authenticate!
-      # redirect_to x_path unless current_user
-      #
-      # If using Devise, set this method to call:
-      # authenticate_user!
+    # 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,72 @@
+module Madmin
+  class ResourceController < ApplicationController
+    before_action :set_record, except: [:index, :new, :create]
+
+    def index
+      @pagy, @records = pagy(resource.model.all)
+    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
+      end
+    end
+
+    def edit
+    end
+
+    def update
+      if @record.update(resource_params)
+        redirect_to resource.show_path(@record)
+      else
+        render :edit
+      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 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,5 @@
 module Madmin
   module ApplicationHelper
-    def available_resources
-      @available_resources ||= Madmin::Resources.gather.map { |model| madmin_resource_for(model: model) }
-    end
-
-    def madmin_resource_for(model:)
-      Object.const_get("::Madmin::Resources::#{model}").new
-    end
-
-    def pages
-      Madmin::Pages.all
-    end
+    include Pagy::Frontend
   end
 end

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

@@ -1,30 +1,29 @@
 <!DOCTYPE html>
-<html>
-<head>
-  <title>Madmin</title>
-  <%= csrf_meta_tags %>
-  <%= csp_meta_tag %>
-
-  <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>
+<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" />
+    <%= stylesheet_link_tag "application", "data-turbo-track": "reload" %>
+    <%= javascript_pack_tag "madmin", "data-turbo-track": "reload" %>
+    <%= csrf_meta_tags %>
+  </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>
+    <%#= render "javascript" %>
+  </body>
 </html>

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

@@ -0,0 +1,25 @@
+<%= form_with model: [:madmin, record], url: (record.persisted? ? resource.show_path(record) : resource.index_path), local: true do |form| %>
+  <% if form.object.errors.any? %>
+    <div class="mb-4 rounded-md text-sm text-red-700 bg-red-100 p-4">
+      <div class="mb-2 font-medium leading-5 text-red-800">There was <%= pluralize form.object.errors.full_messages.count, "error" %> with your submission</div>
+
+      <% form.object.errors.full_messages.each do |message| %>
+        <div class="ml-4"><%= message %></div>
+      <% end %>
+    </div>
+  <% end %>
+
+  <% resource.attributes.each do |attribute| %>
+    <% next if attribute[:field].nil? %>
+    <% next unless attribute[:field].visible?(action_name) %>
+    <% next unless attribute[:field].visible?(:form) %>
+
+    <% field = attribute[:field] %>
+
+    <div class="mb-4 flex">
+      <%= render partial: field.to_partial_path("form"), locals: { field: field, record: record, form: form, resource: resource } %>
+    </div>
+  <% end %>
+
+  <%= form.submit class: "bg-white hover:bg-gray-100 text-gray-800 font-semibold py-2 px-4 border border-gray-400 rounded shadow" %>
+<% end %>

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

@@ -0,0 +1,6 @@
+<div class="text-sm">
+  <%= link_to "← Back to App", main_app.root_url, class: "block p-1" if main_app.respond_to?(:root_url) %>
+  <% Madmin.resources.each do |resource| %>
+    <%= link_to resource.friendly_name.pluralize, resource.index_path, class: "block p-1" %>
+  <% end %>
+</div>

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

@@ -0,0 +1,3 @@
+<h1><%= link_to resource.friendly_name.pluralize, resource.index_path %> / Edit <%= resource.friendly_name %> #<%= @record.id %></h1>
+
+<%= render partial: "form", locals: { record: @record, resource: resource } %>

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

@@ -0,0 +1,35 @@
+<h1><%= resource.friendly_name.pluralize %></h1>
+<%= link_to "New #{resource.friendly_name}", resource.new_path %>
+
+<table class="table-auto">
+  <thead>
+    <tr>
+      <% resource.attributes.each do |attribute| %>
+        <% next if attribute[:field].nil? %>
+        <% next unless attribute[:field].visible?(action_name) %>
+
+        <th><%= attribute[:name].to_s.titleize %></th>
+      <% end %>
+      <th>Actions</th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <% @records.each do |record| %>
+      <tr>
+        <% resource.attributes.each do |attribute| %>
+          <% next if attribute[:field].nil? %>
+          <% next unless attribute[:field].visible?(action_name) %>
+
+          <% field = attribute[:field] %>
+
+          <td><%= render partial: field.to_partial_path("index"), locals: { field: field, record: record } %></td>
+        <% end %>
+
+        <td><%= link_to "View", resource.show_path(record) %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+
+<%== pagy_nav(@pagy) if @pagy.pages > 1 %>