madmin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: be4b01320deccbc46e6184ae804f74e278c909ec7b11f74274f09dc4442e78d4
+  data.tar.gz: cdecb4f3ca23924befe03dc43ec4dda63626adabc24c70cbc892e3e21dd0ca62
+SHA512:
+  metadata.gz: 7f8691c029a1f37cf1b515c1ec399481d12ee2a4320c1e564f586e38b2d7e12610796df1c3b391356496dfca4c6b1d156b5459850873dd6bda54940e69a2f951
+  data.tar.gz: 36e1b5138b977c5a7bb46b7e1a96078c645c204865de2df919fdef9909c4ac9ba6930b18ad905ca6489ff6e8b11656776561aa1c424b38d79ba3e9db3beee204

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Jason Charnes
+
+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,102 @@
+# Madmin
+
+Short description and motivation.
+
+## 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
+
+```bash
+rails generate madmin:install User
+```
+
+## 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
+
+```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/**/"]
+```
+
+## 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

@@ -0,0 +1,32 @@
+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
+
+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"
+
+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,2 @@
+//= link_directory ../javascripts/madmin .js
+//= link_directory ../stylesheets/madmin .css

data/app/assets/javascripts/madmin/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require activestorage
+//= require_tree .

data/app/assets/javascripts/madmin/dashboard.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/javascripts/madmin/resources.js

@@ -0,0 +1,36 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.
+
+var updateResourceOptions = function(polymorphicField) {
+  var idField = document.getElementById("commentable_id");
+  var slug =
+    polymorphicField.options[polymorphicField.selectedIndex].dataset.slug;
+
+  idField.options.length = 0;
+
+  if (!slug) {
+    idField.classList.add("d-none");
+    return;
+  }
+
+  axios.get("/madmin/" + slug + ".json").then(function(response) {
+    response.data.forEach(function(resource) {
+      var option = document.createElement("option");
+      option.text = resource.display_value;
+      option.value = resource.id;
+      idField.add(option);
+    });
+
+    idField.classList.remove("d-none");
+  });
+};
+
+if (window.polymorphicFields) {
+  window.polymorphicFields.forEach(function(field) {
+    var polymorphicField = document.getElementById(field + "_type");
+
+    polymorphicField.addEventListener("change", function() {
+      updateResourceOptions(polymorphicField);
+    });
+  });
+}

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

@@ -0,0 +1,22 @@
+/*
+ * 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.
+ *
+ * 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
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */
+
+.sidebar {
+  height: 100%;
+  left: 0;
+  position: fixed;
+  top: 0;
+}

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

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

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

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/madmin/application_controller.rb

@@ -0,0 +1,16 @@
+module Madmin
+  class ApplicationController < BaseController
+    protect_from_forgery with: :exception
+
+    before_action :authenticate!
+
+    private
+
+    def authenticate!
+      # redirect_to x_path unless current_user
+      #
+      # If using Devise, set this method to call:
+      # authenticate_user!
+    end
+  end
+end

data/app/controllers/madmin/base_controller.rb

@@ -0,0 +1,16 @@
+require_dependency "madmin/resources"
+
+module Madmin
+  class BaseController < ActionController::Base
+    before_action :validate_resources
+
+    private
+
+    # 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
+    end
+  end
+end

data/app/controllers/madmin/dashboard_controller.rb

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

data/app/controllers/madmin/resources_controller.rb

@@ -0,0 +1,97 @@
+require_dependency "madmin/application_controller"
+
+module Madmin
+  class ResourcesController < ApplicationController
+    include ActiveSupport::Inflector
+
+    before_action :find_resource, only: [:show, :edit, :update, :destroy]
+
+    helper_method :madmin_resource
+
+    def index
+      @scopes = madmin_resource.scopes
+      @headers = madmin_resource.index_headers
+
+      if params[:scope]&.to_sym&.in?(@scopes)
+        begin
+          @collection = resource.send(params[:scope])
+        rescue ArgumentError
+          raise ScopeWithArgumentsError, "The scope #{params[:scope.to_sym]} on #{resource.name} takes arguments, which are currently unsupported."
+        end
+      else
+        @collection = resource.all
+      end
+
+      respond_to do |format|
+        format.html
+        format.json { render json: @collection.map { |c| {id: c.id, display_value: c.title} } }
+      end
+    end
+
+    def show
+    end
+
+    def new
+      @resource = ResourceDecorator.new(resource.new(resource_params))
+    end
+
+    def create
+      @resource = ResourceDecorator.new(resource.new(resource_params))
+
+      if @resource.save
+        redirect_to resource_path(id: @resource.id)
+      else
+        render :new
+      end
+    end
+
+    def edit
+    end
+
+    def update
+      if @resource.update(resource_params)
+        redirect_to resource_path(id: @resource.id)
+      else
+        render :edit
+      end
+    end
+
+    def destroy
+      if @resource.destroy
+        redirect_to resources_path(params[:resource])
+      else
+        flash[:error] = "There was an issue deleting the record."
+        redirect_to :back
+      end
+    end
+
+    private
+
+    def find_resource
+      @resource ||= Madmin::ResourceDecorator.new(resource.find(params[:id]))
+    end
+
+    def form_keys
+      madmin_resource.form_fields.map { |field| field.strong_params_keys }.flatten
+    end
+
+    def madmin_resource
+      Object.const_get("::Madmin::Resources::#{resource_name}").new
+    end
+
+    def resource
+      Object.const_get(resource_name)
+    end
+
+    def resource_name
+      camelize(params[:resource].singularize)
+    end
+
+    def resource_params
+      param_key = resource_name.downcase.to_sym
+      return unless params.dig(param_key)
+
+      params.require(param_key).permit(form_keys)
+    end
+  end
+end

data/app/decorators/madmin/resource_decorator.rb

@@ -0,0 +1,16 @@
+module Madmin
+  class ResourceDecorator < SimpleDelegator
+    def initialize(resource)
+      @resource = resource
+      super
+    end
+
+    def name
+      resource.class.name
+    end
+
+    private
+
+    attr_reader :resource
+  end
+end

data/app/helpers/madmin/application_helper.rb

@@ -0,0 +1,15 @@
+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
+  end
+end

data/app/helpers/madmin/fields/polymorphic_helper.rb

@@ -0,0 +1,25 @@
+module Madmin
+  module Fields
+    module PolymorphicHelper
+      def polymorphic_models(type)
+        all_resources = Madmin::Resources.all.map { |r| Madmin::ResourceDecorator.new(r) }
+
+        polymorphic_resources = all_resources.select { |resource|
+          associations = resource.model.reflect_on_all_associations
+          associations.select { |a| a.options.dig(:as) === type }.any?
+        }
+
+        polymorphic_resources.map(&:model)
+      end
+
+      def polymorphic_options_for_selected_type(form:, field:)
+        options_from_collection_for_select(
+          form.object.send(field.polymorphic_type_param).constantize.send(field.polymorphic_scope),
+          :id,
+          field.polymorphic_display_value,
+          form.object.send(field.polymorphic_id_param)
+        )
+      end
+    end
+  end
+end