madmin 0.1.1 → 1.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ae907c78952efd333b7151ef50818dc6b171017239a11152c129c17bb45af10
-  data.tar.gz: 923a8e6ecb3e84bffd6973a511845cc16cc599e36adc5116525ab01e46bc1c16
+  metadata.gz: 25bf67586811ced1dc2612fe0382c517f656895261e5b24b6c90c0cd6d9f21f6
+  data.tar.gz: a41bbd0a7be385b1aad8fef678ee61a56f90964fc1dc749cf728d3cc52739d54
 SHA512:
-  metadata.gz: c696a1782666fdcc4a113d7709775c41e245a9f92ef298c93a6fb98a1c1f2db4f5a34f36d59a1c3da476a6db44bfcc864f5b37c8136ef8f8a155415344b74660
-  data.tar.gz: d7eef669f0b0366ccaf73f3cd68f85525067172ade70c55397b9cd27e7132c3008a067d68d5bc3d073e94441f1cbf8a9e893a11a2b91fbfd0dbdd6a695487230
+  metadata.gz: 99bdd270af3258778d08d0b7ec69f1cbb3406d7f14fe29a10892afaf09f3857c0fa114287f6aaa4f253aefc40f2bad5d626109caa0340638ed091e8c9f7fdeef
+  data.tar.gz: 21a2fb128bcc6e2e89e443694d4bceac0e9b94838da425333845539eef99ae1696bdf1d385ed530b1262ccdaa6746d10ab864424796be193192165996d4352f2

data/README.md

@@ -1,11 +1,14 @@
 # Madmin
 
-### A robust admin interface for Ruby on Rails apps
+### 🛠 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)
 
-## Usage
-How to use my plugin.
+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, etc)
+* Stimulus / Turbolinks / Hotwire ready
 
 ## Installation
 Add `madmin` to your application's Gemfile:
@@ -20,8 +23,23 @@ Then run the madmin generator:
 rails g madmin:install
 ```
 
-## Contributing
-Contribution directions go here.
+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
+```
+
+## 🙏 Contributing
+
+This project uses Standard for formatting Ruby code. Please make sure to run standardrb before submitting pull requests.
 
-## License
+## 📝 License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -18,6 +18,10 @@ 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/controllers/madmin/{application_controller.rb → base_controller.rb}

@@ -1,5 +1,5 @@
 module Madmin
-  class ApplicationController < ActionController::Base
+  class BaseController < ActionController::Base
     include Pagy::Backend
 
     protect_from_forgery with: :exception

data/app/controllers/madmin/resource_controller.rb

@@ -3,7 +3,7 @@ module Madmin
     before_action :set_record, except: [:index, :new, :create]
 
     def index
-      @pagy, @records = pagy(resource.model.all)
+      @pagy, @records = pagy(scoped_resources)
     end
 
     def show
@@ -18,7 +18,7 @@ module Madmin
       if @record.save
         redirect_to resource.show_path(@record)
       else
-        render :new
+        render :new, status: :unprocessable_entity
       end
     end
 
@@ -29,7 +29,7 @@ module Madmin
       if @record.update(resource_params)
         redirect_to resource.show_path(@record)
       else
-        render :edit
+        render :edit, status: :unprocessable_entity
       end
     end
 
@@ -53,6 +53,15 @@ module Madmin
       "#{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)

data/app/helpers/madmin/application_helper.rb

@@ -1,5 +1,17 @@
 module Madmin
   module ApplicationHelper
     include Pagy::Frontend
+
+    # Converts a Rails version to a NPM version
+    def npm_rails_version
+      version = [
+        Rails::VERSION::MAJOR,
+        Rails::VERSION::MINOR,
+        Rails::VERSION::TINY
+      ].join(".")
+
+      version += "-#{Rails::VERSION::PRE}" if Rails::VERSION::PRE
+      version
+    end
   end
 end

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

@@ -10,9 +10,9 @@
     <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 %>
+
+    <%= render "javascript" %>
   </head>
   <body class="prose" style="max-width:none">
     <div class="flex w-full p-4">
@@ -24,6 +24,5 @@
         <%= yield %>
       </main>
     </div>
-    <%#= render "javascript" %>
   </body>
 </html>

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

@@ -0,0 +1,24 @@
+<%= stylesheet_link_tag "https://cdn.skypack.dev/flatpickr/dist/flatpickr.min.css", "data-turbo-track": "reload" %>
+<%= stylesheet_link_tag "https://cdn.skypack.dev/slim-select/dist/slimselect.min.css", "data-turbo-track": "reload" %>
+<%= stylesheet_link_tag "https://cdn.skypack.dev/trix/dist/trix.css", "data-turbo-track": "reload" %>
+
+<script type="module">
+  import { Application } from 'https://cdn.skypack.dev/stimulus'
+  const application = Application.start()
+
+  import stimulusFlatpickr from 'https://cdn.skypack.dev/stimulus-flatpickr'
+  application.register("flatpickr", stimulusFlatpickr)
+
+  import stimulusSlimselect from 'https://cdn.skypack.dev/stimulus-slimselect'
+  application.register("slimselect", stimulusSlimselect)
+
+  import Rails from 'https://cdn.skypack.dev/@rails/ujs@<%= npm_rails_version %>'
+  import * as ActiveStorage from 'https://cdn.skypack.dev/@rails/activestorage@<%= npm_rails_version %>'
+  import 'https://cdn.skypack.dev/trix'
+  import 'https://cdn.skypack.dev/@rails/actiontext@<%= npm_rails_version %>'
+
+  Rails.start()
+  ActiveStorage.start()
+
+  import * as Turbo from "https://cdn.skypack.dev/@hotwired/turbo"
+</script>

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

@@ -1,5 +1,5 @@
 <div class="text-sm">
-  <%= link_to "← Back to App", main_app.root_url, class: "block p-1" if main_app.respond_to?(:root_url) %>
+  <%= link_to "← Back to App", main_app.root_url, class: "block p-1", data: { turbo: false } 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 %>

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

@@ -1,5 +1,17 @@
-<h1><%= resource.friendly_name.pluralize %></h1>
-<%= link_to "New #{resource.friendly_name}", resource.new_path %>
+<div class="flex justify-between">
+  <h1><%= resource.friendly_name.pluralize %></h1>
+  <%= link_to "New #{resource.friendly_name}", resource.new_path %>
+</div>
+
+<div>
+  <% if resource.scopes.any? %>
+    <%= link_to "All", resource.index_path %>
+  <% end %>
+
+  <% resource.scopes.each do |scope| %>
+    <%= link_to scope.to_s.humanize, resource.index_path(scope: scope) %>
+  <% end %>
+</div>
 
 <table class="table-auto">
   <thead>

data/app/views/madmin/fields/belongs_to/_form.html.erb

@@ -1,2 +1,2 @@
 <%= form.label field.attribute_name, class: "inline-block w-32 flex-shrink-0" %>
-<%= form.select field.to_param, field.options_for_select(record), { prompt: true }, { class: "form-select" } %>
+<%= form.select field.to_param, field.options_for_select(record), { prompt: true }, { class: "form-select", data: { controller: "slimselect", data: { controller: "slimselect" } } } %>

data/app/views/madmin/fields/date/_form.html.erb

@@ -1,2 +1,2 @@
 <%= form.label field.attribute_name, class: "inline-block w-32 flex-shrink-0" %>
-<%= form.date_select field.attribute_name, {}, { class: "form-select" } %>
+<%= form.text_field field.attribute_name, { class: "form-select", data: { controller: "flatpickr" } } %>

data/app/views/madmin/fields/date_time/_form.html.erb

@@ -1,2 +1,2 @@
 <%= form.label field.attribute_name, class: "inline-block w-32 flex-shrink-0" %>
-<%= form.datetime_select field.attribute_name, {}, { class: "form-select" } %>
+<%= form.text_field field.attribute_name, data: { controller: "flatpickr", flatpickr_enable_time: true } %>

data/app/views/madmin/fields/decimal/_form.html.erb

@@ -0,0 +1,2 @@
+<%= form.label field.attribute_name, class: "inline-block w-32 flex-shrink-0" %>
+<%= form.number_field field.attribute_name, step: :any, class: "form-input" %>

data/app/views/madmin/fields/decimal/_index.html.erb

@@ -0,0 +1 @@
+<%= field.value(record) %>

data/app/views/madmin/fields/decimal/_show.html.erb

@@ -0,0 +1 @@
+<%= field.value(record) %>

data/app/views/madmin/fields/float/_form.html.erb

@@ -1,2 +1,2 @@
 <%= form.label field.attribute_name, class: "inline-block w-32 flex-shrink-0" %>
-<%= form.number_field field.attribute_name, class: "form-input" %>
+<%= form.number_field field.attribute_name, step: :any, class: "form-input" %>

data/app/views/madmin/fields/has_many/_form.html.erb

@@ -1,2 +1,2 @@
 <%= form.label field.attribute_name, class: "inline-block w-32 flex-shrink-0" %>
-<%= form.select "#{field.attribute_name.to_s.singularize}_ids", field.options_for_select(record), { prompt: true }, { multiple: true, class: "form-select" } %>
+<%= form.select "#{field.attribute_name.to_s.singularize}_ids", field.options_for_select(record), { prompt: true }, { multiple: true, class: "form-select", data: { controller: "slimselect" } } %>

data/app/views/madmin/fields/polymorphic/_form.html.erb

@@ -1,5 +1,5 @@
 <%= form.fields_for field.attribute_name do |pf| %>
   <%= pf.label field.attribute_name, class: "inline-block w-32 flex-shrink-0" %>
-  <%= pf.select :value, field.options_for_select(record).map(&:to_global_id), { selected: field.value(record)&.to_global_id, prompt: true }, { class: "form-select" } %>
+  <%= pf.select :value, field.options_for_select(record).map(&:to_global_id), { selected: field.value(record)&.to_global_id, prompt: true }, { class: "form-select", data: { controller: "slimselect" } } %>
   <%= pf.hidden_field :type, value: "polymorphic" %>
 <% end %>

data/app/views/madmin/fields/rich_text/_form.html.erb

@@ -1,4 +1,4 @@
 <%= form.label field.attribute_name, class: "inline-block w-32 flex-shrink-0" %>
-<div>
-  <%= form.rich_text_area field.attribute_name, class: "form-input" %>
+<div class="flex-1">
+  <%= form.rich_text_area field.attribute_name, class: "form-input block" %>
 </div>

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

@@ -5,10 +5,16 @@ module Madmin
     class InstallGenerator < Rails::Generators::Base
       include Madmin::GeneratorHelpers
 
+      source_root File.expand_path("../templates", __FILE__)
+
       def eager_load
         Rails.application.eager_load!
       end
 
+      def copy_controller
+        template("controller.rb.tt", "app/controllers/madmin/application_controller.rb")
+      end
+
       def generate_routes
         if route_namespace_exists?
           route "root to: \"dashboard#show\"", indentation: 4, sentinel: /namespace :madmin do\s*\n/m

data/lib/generators/madmin/install/templates/controller.rb.tt

@@ -0,0 +1,22 @@
+module Madmin
+  class ApplicationController < Madmin::BaseController
+    before_action :authenticate_admin_user
+
+    def authenticate_admin_user
+      # TODO: Add your authentication logic here
+
+      # For example, we could redirect if the user isn't an admin
+      # redirect_to "/", alert: "Not authorized." unless user_signed_in? && current_user.admin?
+    end
+
+    # Authenticate with Clearance
+    # include Clearance::Controller
+    # before_action :require_login
+
+    # Authenticate with Devise
+    # before_action :authenticate_user!
+
+    # Authenticate with Basic Auth
+    # http_basic_authenticate_with(name: Rails.application.credentials.admin_username, password: Rails.application.credentials.admin_password)
+  end
+end

data/lib/madmin.rb

@@ -14,6 +14,7 @@ module Madmin
     autoload :Text, "madmin/fields/text"
     autoload :Date, "madmin/fields/date"
     autoload :DateTime, "madmin/fields/date_time"
+    autoload :Decimal, "madmin/fields/decimal"
     autoload :Json, "madmin/fields/json"
     autoload :Enum, "madmin/fields/enum"
     autoload :Float, "madmin/fields/float"

data/lib/madmin/field.rb

@@ -1,13 +1,14 @@
 module Madmin
   class Field
-    attr_reader :attribute_name, :options
+    attr_reader :attribute_name, :model, :options
 
     def self.field_type
       to_s.split("::").last.underscore
     end
 
-    def initialize(attribute_name:, **options)
+    def initialize(attribute_name:, model:, **options)
       @attribute_name = attribute_name
+      @model = model
       @options = options
     end
 
@@ -31,5 +32,9 @@ module Madmin
     def visible?(action, default: true)
       options.fetch(action.to_sym, default)
     end
+
+    def required?
+      model.validators_on(attribute_name).any? { |v| v.is_a? ActiveModel::Validations::PresenceValidator }
+    end
   end
 end

data/lib/madmin/fields/decimal.rb

@@ -0,0 +1,6 @@
+module Madmin
+  module Fields
+    class Decimal < Field
+    end
+  end
+end

data/lib/madmin/resource.rb

@@ -29,7 +29,7 @@ module Madmin
       def attribute(name, type = nil, **options)
         attributes << {
           name: name,
-          field: field_for_type(name, type).new(**options.merge(attribute_name: name))
+          field: field_for_type(name, type).new(**options.merge(attribute_name: name, model: model))
         }
       end
 
@@ -37,8 +37,10 @@ module Madmin
         model_name.gsub("::", " / ")
       end
 
-      def index_path
-        "/madmin/#{model.model_name.collection}"
+      def index_path(options = {})
+        path = "/madmin/#{model.model_name.collection}"
+        path += "?#{options.to_param}" if options.any?
+        path
       end
 
       def new_path
@@ -71,16 +73,51 @@ module Madmin
         type ||= infer_type(name)
 
         {
+          binary: Fields::String,
+          blob: Fields::Text,
+          boolean: Fields::Boolean,
           date: Fields::Date,
           datetime: Fields::DateTime,
+          decimal: Fields::Decimal,
           enum: Fields::Enum,
           float: Fields::Float,
+          hstore: Fields::Json,
           integer: Fields::Integer,
           json: Fields::Json,
+          jsonb: Fields::Json,
+          primary_key: Fields::String,
           string: Fields::String,
           text: Fields::Text,
           time: Fields::Time,
-          boolean: Fields::Boolean,
+          timestamp: Fields::Time,
+
+          # Postgres specific types
+          bit: Fields::String,
+          bit_varying: Fields::String,
+          box: Fields::String,
+          cidr: Fields::String,
+          circle: Fields::String,
+          citext: Fields::Text,
+          daterange: Fields::String,
+          inet: Fields::String,
+          int4range: Fields::String,
+          int8range: Fields::String,
+          interval: Fields::String,
+          line: Fields::String,
+          lseg: Fields::String,
+          ltree: Fields::String,
+          macaddr: Fields::String,
+          money: Fields::String,
+          numrange: Fields::String,
+          oid: Fields::String,
+          path: Fields::String,
+          point: Fields::String,
+          polygon: Fields::String,
+          tsrange: Fields::String,
+          tstzrange: Fields::String,
+          tsvector: Fields::String,
+          uuid: Fields::String,
+          xml: Fields::Text,
 
           # Associations
           attachment: Fields::Attachment,
@@ -91,6 +128,15 @@ module Madmin
           has_one: Fields::HasOne,
           rich_text: Fields::RichText
         }.fetch(type)
+      rescue
+        raise ArgumentError, <<~MESSAGE
+          Couldn't find attribute or association '#{name}' with type '#{type}' on #{model} model
+
+            To fix this, either:
+
+            1. Remove 'attribute #{name}' from app/madmin/resources/#{model.to_s.underscore}_resource.rb
+            2. Or add the missing attribute or association to the #{model} model
+        MESSAGE
       end
 
       def infer_type(name)

data/lib/madmin/version.rb

@@ -1,3 +1,3 @@
 module Madmin
-  VERSION = "0.1.1"
+  VERSION = "1.0.0.beta1"
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: madmin
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0.beta1
 platform: ruby
 authors:
 - Chris Oliver
 - Andrea Fomera
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-15 00:00:00.000000000 Z
+date: 2021-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -45,20 +45,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: It's an admin, obviously.
 email:
 - excid3@gmail.com
@@ -73,12 +59,13 @@ files:
 - app/assets/config/manifest.js
 - app/assets/stylesheets/actiontext.scss
 - app/assets/stylesheets/application.css
-- app/controllers/madmin/application_controller.rb
+- app/controllers/madmin/base_controller.rb
 - app/controllers/madmin/dashboard_controller.rb
 - app/controllers/madmin/resource_controller.rb
 - app/helpers/madmin/application_helper.rb
 - app/views/layouts/madmin/application.html.erb
 - app/views/madmin/application/_form.html.erb
+- app/views/madmin/application/_javascript.html.erb
 - app/views/madmin/application/_navigation.html.erb
 - app/views/madmin/application/edit.html.erb
 - app/views/madmin/application/index.html.erb
@@ -103,6 +90,9 @@ files:
 - app/views/madmin/fields/date_time/_form.html.erb
 - app/views/madmin/fields/date_time/_index.html.erb
 - app/views/madmin/fields/date_time/_show.html.erb
+- app/views/madmin/fields/decimal/_form.html.erb
+- app/views/madmin/fields/decimal/_index.html.erb
+- app/views/madmin/fields/decimal/_show.html.erb
 - app/views/madmin/fields/enum/_form.html.erb
 - app/views/madmin/fields/enum/_index.html.erb
 - app/views/madmin/fields/enum/_show.html.erb
@@ -137,6 +127,7 @@ files:
 - app/views/madmin/fields/time/_index.html.erb
 - app/views/madmin/fields/time/_show.html.erb
 - lib/generators/madmin/install/install_generator.rb
+- lib/generators/madmin/install/templates/controller.rb.tt
 - lib/generators/madmin/resource/resource_generator.rb
 - lib/generators/madmin/resource/templates/controller.rb.tt
 - lib/generators/madmin/resource/templates/resource.rb.tt
@@ -149,6 +140,7 @@ files:
 - lib/madmin/fields/boolean.rb
 - lib/madmin/fields/date.rb
 - lib/madmin/fields/date_time.rb
+- lib/madmin/fields/decimal.rb
 - lib/madmin/fields/enum.rb
 - lib/madmin/fields/float.rb
 - lib/madmin/fields/has_many.rb
@@ -168,7 +160,7 @@ homepage: https://github.com/excid3/madmin
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -179,12 +171,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: A modern admin for Ruby on Rails apps
 test_files: []