jav_madmin 2.6.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5d92b6e04ea290f8ea0692b83ed2a324fc76d51cb1c63a35435a34552cdeecba
+  data.tar.gz: 24f2b178256dc83dd6c5dd9ed6d276be5b174b9ea34bc2fb4c99549d618488f9
+SHA512:
+  metadata.gz: 384f3b0526579449b6dc3e58f3e633ca7d5bb193070a17b052d6d38863f671fc9a84b054b1349912f71d479743b5b7f69f2518e67b693ea7941deb95a55d4b6e
+  data.tar.gz: '0293d9d07f98036e8ff5895753aa87549b81345e5356fa8b171fe9bd5fbd3578842669a5c6682fa92efd84683b009eeb997a13dcc095b0e2f71ccab000468f81'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+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
+"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,294 @@
+# Madmin
+
+### 🛠 A robust Admin Interface for Ruby on Rails apps
+
+[![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)
+
+Why another Ruby on Rails admin? We wanted an admin that was:
+
+- Familiar and customizable like Rails scaffolds (less DSL)
+- Supports all the Rails features out of the box (ActionText, ActionMailbox, has_secure_password, etc)
+- Stimulus / Turbolinks / Hotwire ready
+- Works with Import maps and Sprockets
+
+![Madmin Screenshot](docs/images/screenshot.png)
+
+## Installation
+
+Add `madmin` to your application's Gemfile:
+
+```bash
+bundle add madmin
+```
+
+Then run the madmin generator:
+
+```bash
+rails g madmin:install
+```
+
+This will install Madmin and generate resources for each of the models it finds.
+
+## Resources
+
+Madmin uses `Resource` classes to add models to the admin area.
+
+### Generate a Resource
+
+To generate a resource for a model, you can run:
+
+```bash
+rails g madmin:resource ActionText::RichText
+```
+
+### Avoid N+1 queries
+
+In case of N+1 queries, you can preload the association by overriding the `scoped_resource` method in the controller:
+
+```ruby
+module Madmin
+  class PostsController < Madmin::ResourceController
+    private
+
+    def scoped_resources
+      super.includes(:user)
+    end
+  end
+end
+
+```
+
+### Read-only Resources
+
+To expose a resource in the admin without allowing writes, override `readonly?` in the resource:
+
+```ruby
+class AuditLogResource < Madmin::Resource
+  def self.readonly?
+    true
+  end
+end
+```
+
+The new, edit, and delete links are hidden for read-only resources, and any write actions redirect back to the index.
+
+### Scopes
+
+Declare scopes on a resource to render filter buttons on the index page. Each scope must be a scope or class method on the model:
+
+```ruby
+class PostResource < Madmin::Resource
+  scope :published
+  scope :draft
+end
+```
+
+Button labels default to the humanized scope name. To customize or translate them, define an I18n key — `madmin.scopes.<param_key>.<scope>` for one resource, or `madmin.scopes.<scope>` shared across resources:
+
+```yaml
+en:
+  madmin:
+    scopes:
+      post:
+        published: Live
+```
+
+For labels that need logic (e.g. looking up a record name), override `scope_label`:
+
+```ruby
+class PostResource < Madmin::Resource
+  def self.scope_label(name)
+    name.to_s.titleize
+  end
+end
+```
+
+## Configuring Views
+
+The views packaged within the gem are a great starting point, but inevitably people will need to be able to customize those views.
+
+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:views
+```
+
+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)
+
+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
+
+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 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
+```
+
+You might want to make some of your model's attributes visible in some views but invisible in others.
+The `attribute` method in model_resource.rb gives you that flexibility.
+
+```bash
+ # -> app/madmin/resources/book_resource.rb
+```
+
+```ruby
+class BookResource < Madmin::Resource
+  attribute :id, form: false
+  attribute :title
+  attribute :subtitle, index: false
+  attribute :author
+  attribute :genre
+  attribute :pages, show: false
+end
+```
+
+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
+```
+
+### Specifying Field Types
+
+You can set a field type as the second argument. Field types may have additional options to render the field UI.
+
+
+For example, we can use a select for the genre attribute and specify the collection of options to choose from.
+
+```ruby
+class BookResource < Madmin::Resource
+  attribute :genre, :select, collection: ["Fiction", "Mystery", "Thriller"]
+end
+```
+
+## Custom Fields
+
+You can generate a custom field with:
+
+```bash
+rails g madmin:field Custom
+```
+
+This will create a `CustomField` class in `app/madmin/fields/custom_field.rb`
+And the related views:
+
+```bash
+# -> app/views/madmin/fields/custom_field/_form.html.erb
+# -> app/views/madmin/fields/custom_field/_index.html.erb
+# -> app/views/madmin/fields/custom_field/_show.html.erb
+```
+
+You can then use this field on our resource:
+
+```ruby
+class PostResource < Madmin::Resource
+  attribute :title, field: CustomField
+end
+```
+
+## Actions
+
+### Member Actions
+
+`member_action` lets you add custom buttons to a resource's **show** page. Each block receives the current `record` and is rendered in the header's `.actions` div:
+
+```ruby
+class PostResource < Madmin::Resource
+  member_action do |record|
+    link_to "Publish", publish_admin_post_path(record), class: "btn btn-secondary"
+  end
+end
+```
+
+Pass `collection: true` to also render the action on the **index** page, in each row next to the built-in "View" and "Edit" links:
+
+```ruby
+class PostResource < Madmin::Resource
+  member_action collection: true do |record|
+    link_to "Publish", publish_admin_post_path(record), class: "btn btn-secondary"
+  end
+end
+```
+
+### Collection Actions
+
+`collection_action` is the index-page counterpart to `member_action`. Blocks are rendered in the index header's `.actions` div, immediately before the built-in "New \<Resource\>" link.
+
+Unlike `member_action`, blocks receive **no** arguments. Each block is `instance_exec`-ed on the index view context, so `link_to`, route helpers, `policy`, `current_user`, `params`, `resource`, and `@records` are all available. Multiple blocks render in registration order.
+
+Each block is responsible for its own authorization gating — if a button should be hidden for some users, guard it inside the block.
+
+```ruby
+class PostResource < Madmin::Resource
+  collection_action do
+    link_to "Bulk Import", bulk_import_admin_posts_path, class: "btn btn-secondary"
+  end
+
+  collection_action do
+    link_to "Export CSV", export_admin_posts_path(format: :csv), class: "btn btn-secondary"
+  end
+end
+```
+
+## Extending Madmin
+
+Madmin runs `ActiveSupport` load hooks on its core classes so you can extend them from an initializer without reopening or monkey patching them. This is the recommended way for engines and gems to add behavior to Madmin.
+
+| Hook | Base | Use it for |
+| --- | --- | --- |
+| `:madmin_resource` | `Madmin::Resource` | Adding to the resource DSL |
+| `:madmin_field` | `Madmin::Field` | Shared behavior across every field type |
+| `:madmin_search` | `Madmin::Search` | Customizing how the search query is built |
+| `:madmin_base_controller` | `Madmin::BaseController` | Layouts, helpers, `rescue_from`, authentication |
+| `:madmin_resource_controller` | `Madmin::ResourceController` | CRUD callbacks, scoping records, audit logging |
+
+Blocks are `class_eval`-ed on the base class, so `self` is the class itself:
+
+```ruby
+# config/initializers/madmin.rb
+ActiveSupport.on_load(:madmin_resource) do
+  # self == Madmin::Resource, so `extend` adds class-level DSL to every resource
+  extend MyAdmin::ResourceExtensions
+end
+
+ActiveSupport.on_load(:madmin_base_controller) do
+  # self == Madmin::BaseController
+  rescue_from Pundit::NotAuthorizedError, with: :admin_not_authorized
+end
+```
+
+Hooks registered after a class has already loaded run immediately, so ordering in your initializers doesn't matter. The controllers live in the engine's `app/` directory and are reloadable, which means their hooks re-run on every reload in development — keep the blocks idempotent.
+
+## Authentication
+
+You can use a couple of strategies to authenticate users who are trying to
+access your madmin panel: [Authentication Docs](docs/authentication.md)
+
+## Assets
+You can customize the JavaScript and CSS assets used by Madmin for your application. To learn how
+see the [Assets Doc](docs/assets.md)
+
+## 🙏 Contributing
+
+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

@@ -0,0 +1,30 @@
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "rdoc/task"
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "Madmin"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/madmin_manifest.js

@@ -0,0 +1,3 @@
+//= link_directory ../stylesheets/madmin .css
+//= link_directory ../../javascript/madmin .js
+//= link_tree ../../javascript/madmin/controllers .js

data/app/assets/stylesheets/madmin/actiontext.css

@@ -0,0 +1,31 @@
+/*
+ * 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
+*/
+
+/*
+ * 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,
+.trix-content .attachment-gallery > .attachment {
+  flex: 1 0 33%;
+  padding: 0 0.5em;
+  max-width: 33%;
+}
+
+.trix-content .attachment-gallery.attachment-gallery--2 > action-text-attachment,
+.trix-content .attachment-gallery.attachment-gallery--2 > .attachment, .trix-content .attachment-gallery.attachment-gallery--4 > action-text-attachment,
+.trix-content .attachment-gallery.attachment-gallery--4 > .attachment {
+  flex-basis: 50%;
+  max-width: 50%;
+}
+
+.trix-content action-text-attachment .attachment {
+  padding: 0 !important;
+  max-width: 100% !important;
+}

data/app/assets/stylesheets/madmin/application-sprockets.css

@@ -0,0 +1,11 @@
+/*
+ *= require trix
+ *= require madmin/actiontext
+ *= require madmin/reset
+ *= require madmin/base
+ *= require madmin/sidebar
+ *= require madmin/buttons
+ *= require madmin/forms
+ *= require madmin/tables
+ *= require madmin/pagination
+*/

data/app/assets/stylesheets/madmin/application.css

@@ -0,0 +1,9 @@
+@import url("/trix.css");
+@import url("/madmin/actiontext.css");
+@import url("/madmin/reset.css");
+@import url("/madmin/base.css");
+@import url("/madmin/sidebar.css");
+@import url("/madmin/buttons.css");
+@import url("/madmin/forms.css");
+@import url("/madmin/tables.css");
+@import url("/madmin/pagination.css");

data/app/assets/stylesheets/madmin/base.css

@@ -0,0 +1,144 @@
+:root {
+  --primary-color: rgb(37 99 235);
+  --border-color: rgb(229 231 235);
+  --background-color: rgb(249 250 251);
+  --text-color: rgb(2 6 23);
+  --light-text-color: rgb(71 85 105);
+  --sidebar-width: 16rem;
+}
+
+body {
+  color: var(--text-color);
+  font-size: 14px;
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+
+  display: grid;
+  min-height: 100dvh;
+  grid-template-rows: auto auto 1fr auto;
+}
+
+a {
+  color: var(--primary-color);
+}
+
+.size-5 {
+  width: 1.25rem;
+  height: 1.25rem;
+}
+
+.alert {
+  font-weight: 500;
+  padding: 1rem;
+
+  ul {
+    margin-top: 0.5rem;
+    margin-bottom: 0;
+    padding-left: 2rem;
+  }
+
+  svg {
+    display: inline-block;
+    height: 1rem;
+    margin-right: 0.25rem;
+    width: 1rem;
+    vertical-align: text-bottom;
+  }
+
+  &.alert-danger {
+    background-color: oklch(.936 .032 17.717);
+    color: oklch(.444 .177 26.899);
+
+    svg {
+      color: oklch(.637 .237 25.331);
+    }
+  }
+
+  &.alert-notice {
+    background-color: oklch(.962 .044 156.743);
+    color: oklch(.448 .119 151.328);
+
+    svg {
+      color: oklch(.723 .219 149.579);
+    }
+  }
+}
+
+.search {
+  display: flex;
+  align-items: center;
+}
+
+.header {
+  display: flex;
+  flex-wrap: wrap;
+  justify-content: space-between;
+  align-items: center;
+  padding-top: 1rem;
+  padding-bottom: 1rem;
+  gap: 0.5rem;
+
+  h1 {
+    margin: 0;
+  }
+
+  a {
+    text-decoration: none;
+
+    &:hover {
+      text-decoration: underline;
+    }
+  }
+
+  .actions {
+    align-items: center;
+    display: flex;
+    flex-wrap: wrap;
+    gap: 0.5rem;
+  }
+}
+
+.metrics {
+  display: grid;
+  grid-template-columns: repeat(2, minmax(0, 1fr));
+
+
+  .metric {
+    border: 1px solid rgb(229 231 235);
+    border-radius: 0.25rem;
+    padding: 1rem;
+    margin: 1rem;
+    flex: 1 1 0%;
+
+    h4 {
+      color: rgb(75 85 99);
+      font-weight: 600;
+      margin-top: 0;
+      margin-bottom: 0.5rem;
+    }
+
+    p {
+      font-size: 2rem;
+      font-weight: 600;
+      margin: 0;
+    }
+  }
+}
+
+.scopes {
+  margin-bottom: 1rem;
+}
+
+.hidden {
+  display: none;
+}
+
+@media (min-width: 768px) {
+  .md\:inline-block {
+    display: inline-block;
+  }
+
+  .md\:hidden {
+    display: none;
+  }
+}

data/app/assets/stylesheets/madmin/buttons.css

@@ -0,0 +1,53 @@
+.btn {
+  border-radius: 0.375rem;
+  display: inline-block;
+  font-weight: 600;
+  text-decoration: none;
+
+  font-size: 0.875rem;
+  line-height: 1.25rem;
+  padding-bottom: 0.5rem;
+  padding-top: 0.5rem;
+  padding-left: 0.75rem;
+  padding-right: 0.75rem;
+
+  &:hover,
+  &:focus {
+    cursor: pointer;
+    text-decoration: none !important;
+  }
+
+  &:disabled {
+    opacity: 60%;
+    cursor: not-allowed;
+  }
+
+  &.btn-primary {
+    background-color: var(--primary-color);
+    color: white;
+  }
+
+  &.btn-secondary {
+    background-color: white;
+    color: rgb(31 41 55);
+    box-shadow: inset 0 0 0 1px rgb(156 163 175);
+
+    &:hover {
+      background-color: rgb(243 244 246);
+    }
+
+    &.active {
+      background-color: rgb(243 244 246);
+    }
+  }
+
+  &.btn-danger {
+    background-color: white;
+    color: rgb(239 68 68);
+    box-shadow: inset 0 0 0 1px rgb(239 68 68);
+
+    &:hover {
+      background-color: rgb(243 244 246);
+    }
+  }
+}

data/app/assets/stylesheets/madmin/forms.css

@@ -0,0 +1,90 @@
+.error {
+  color: rgb(239 68 68);
+}
+
+.form-hint {
+  font-size: 0.875rem;
+  margin-top: 0.5rem;
+}
+
+.form-group {
+  margin-bottom: 1rem;
+}
+
+.form-input {
+  width: 100%;
+}
+
+.form-description {
+  color: var(--light-text-color);
+}
+
+label {
+  color: rgb(17 24 39);
+  line-height: 1.5rem;
+  font-weight: 500;
+  font-size: 0.875rem;
+}
+
+button,
+input,
+optgroup,
+select,
+textarea {
+  font-family: inherit;
+  font-feature-settings: inherit;
+  font-variation-settings: inherit;
+  font-size: 100%;
+  font-weight: inherit;
+  line-height: inherit;
+  letter-spacing: inherit;
+  color: inherit;
+  margin: 0;
+  padding: 0;
+}
+
+[type='text'],
+input:where(:not([type])),
+[type='email'],
+[type='url'],
+[type='password'],
+[type='number'],
+[type='date'],
+[type='datetime-local'],
+[type='month'],
+[type='search'],
+[type='tel'],
+[type='time'],
+[type='week'],
+[multiple],
+textarea,
+select {
+  -webkit-appearance: none;
+  -moz-appearance: none;
+  appearance: none;
+  background-color: #fff;
+
+  border-radius: 0.375rem;
+  box-shadow: inset 0 0 0 1px rgb(156 163 175);
+  line-height: 1.5rem;
+  padding-bottom: 0.375rem;
+  padding-left: 0.75rem;
+  padding-right: 0.75rem;
+  padding-top: 0.375rem;
+
+  &:focus {
+    box-shadow: inset 0 0 0 1px rgb(var(--primary-color));
+  }
+}
+
+.required {
+  color: rgb(239 68 68);
+  font-weight: 600;
+}
+
+.nested-fields {
+  border: 1px solid #e5e7eb;
+  border-radius: 0.5rem;
+  padding: 1.25rem;
+  margin-bottom: 1rem;
+}