madmin 0.1.0

data/lib/generators/madmin/controller/controller_generator.rb

@@ -0,0 +1,10 @@
+class Madmin::ControllerGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path("../../../../../", __FILE__)
+
+  def copy_controller
+    copy_file(
+      "app/controllers/madmin/#{file_name}_controller.rb",
+      "app/controllers/madmin/#{file_name}_controller.rb"
+    )
+  end
+end

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

@@ -0,0 +1,31 @@
+require "rails/generators/base"
+require "madmin/generator_helpers"
+
+module Madmin
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Madmin::GeneratorHelpers
+
+      def generate_resources
+        resources.each do |model|
+          call_generator "madmin:resource", model.to_s
+        end
+      end
+
+      def install_route
+        inject_into_file(
+          Rails.root.join("config/routes.rb"),
+          after: "Rails.application.routes.draw do\n"
+        ) { "  namespace :madmin do\n  end\n  mount Madmin::Engine => \"/madmin\"\n" }
+      end
+
+      private
+
+      def resources
+        Rails.application.eager_load! unless Rails.application.config.cache_classes
+
+        ActiveRecord::Base.descendants.reject(&:abstract_class?)
+      end
+    end
+  end
+end

data/lib/generators/madmin/page/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate custom_controller Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/madmin/page/page_generator.rb

@@ -0,0 +1,20 @@
+class Madmin::PageGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path("templates", __dir__)
+
+  def copy_template
+    template(
+      "template.rb.erb",
+      Rails.root.join("app/controllers/madmin/#{file_name}_controller.rb"),
+    )
+
+    template(
+      "template.html.erb",
+      Rails.root.join("app/views/madmin/#{file_name}/index.html.erb"),
+    )
+
+    inject_into_file(
+      Rails.root.join("config/routes.rb"),
+      after: "namespace :madmin do\n"
+    ) { "    get \"#{file_name}\", to: \"#{file_name}#index\"\n" }
+  end
+end

data/lib/generators/madmin/page/templates/template.html.erb

@@ -0,0 +1,2 @@
+<h1><%= name %></h1>
+<p>Find me in apps/views/madmin/<%= file_name %>/index.erb</p>

data/lib/generators/madmin/page/templates/template.rb.erb

@@ -0,0 +1,10 @@
+class Madmin::<%= name %>Controller < Madmin::ApplicationController
+  def index
+  end
+
+  private
+
+  def in_menu?
+    true
+  end
+end

data/lib/generators/madmin/resource/resource_generator.rb

@@ -0,0 +1,76 @@
+require "rails/generators/named_base"
+require "madmin/generator_helpers"
+
+module Madmin
+  module Generators
+    class ResourceGenerator < Rails::Generators::NamedBase
+      ATTRIBUTE_TYPE_MAPPING = {
+        boolean: "Field::CheckBox",
+        date: "Field::DateTime",
+        datetime: "Field::DateTime",
+        enum: "Field::Text",
+        float: "Field::Number",
+        integer: "Field::Number",
+        time: "Field::DateTime",
+        text: "Field::TextArea",
+        string: "Field::Text",
+      }
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def create_resource_file
+        template(
+          "resource.rb.erb",
+          Rails.root.join("app/madmin/resources/#{file_name}.rb"),
+        )
+      end
+
+      private
+
+      def attributes
+        klass.attribute_types.map { |name, attr|
+          # Skip attributes related to associations
+          next if ignored_attributes.include?(name)
+
+          [name, madmin_type_for_column(attr.type)]
+        }.compact
+      end
+
+      def associations
+        klass.reflections.map do |name, association|
+          if association.polymorphic?
+            [name, "Field::Polymorphic"]
+          elsif association.belongs_to?
+            [name, "Field::BelongsTo"]
+          elsif association.has_one?
+            [name, "Field::HasOne"]
+          else
+            [name, "Field::HasMany"]
+          end
+        end
+      end
+
+      def ignored_attributes
+        attrs = []
+
+        klass.reflections.map do |name, association|
+          if association.polymorphic?
+            attrs += [association.foreign_key, association.foreign_type]
+          elsif association.belongs_to?
+            attrs += [association.foreign_key]
+          end
+        end
+
+        attrs
+      end
+
+      def klass
+        @klass ||= Object.const_get(class_name)
+      end
+
+      def madmin_type_for_column(column_type)
+        ATTRIBUTE_TYPE_MAPPING[column_type]
+      end
+    end
+  end
+end

data/lib/generators/madmin/resource/templates/resource.rb.erb

@@ -0,0 +1,11 @@
+module Madmin
+  class Resources
+    class <%= class_name %>
+      include Madmin::Resourceable
+
+<% (attributes + associations ).each do |name, type| -%>
+      field :<%= name %>, Madmin::<%= type %>
+<% end -%>
+    end
+  end
+end

data/lib/generators/madmin/views/views_generator.rb

@@ -0,0 +1,15 @@
+require "rails/generators/base"
+
+module Madmin
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base
+      desc("Copies views for customizing Madmin's views")
+
+      source_root File.expand_path("../../../../..", __FILE__)
+
+      def copy_views
+        directory "app/views/madmin", "app/views/madmin"
+      end
+    end
+  end
+end

data/lib/madmin.rb

@@ -0,0 +1,30 @@
+require "madmin/engine"
+require "madmin/resourceable"
+require "madmin/resources"
+
+module Madmin
+  class NoResourcesError < StandardError; end
+  class ResourceNotFoundError < StandardError; end
+  class WrongArgumentError < StandardError; end
+  class UndefinedScopeError < StandardError; end
+  class ScopeWithArgumentsError < StandardError; end
+
+  autoload :Field,        "madmin/field"
+  autoload :Resourceable, "madmin/resourceable"
+
+  class Field
+    autoload :Associatable, "madmin/field/associatable"
+    autoload :BelongsTo,    "madmin/field/belongs_to"
+    autoload :CheckBox,     "madmin/field/check_box"
+    autoload :DateTime,     "madmin/field/date_time"
+    autoload :Email,        "madmin/field/email"
+    autoload :HasMany,      "madmin/field/has_many"
+    autoload :HasOne,       "madmin/field/has_one"
+    autoload :Number,       "madmin/field/number"
+    autoload :Password,     "madmin/field/password"
+    autoload :Polymorphic,  "madmin/field/polymorphic"
+    autoload :Select,       "madmin/field/select"
+    autoload :TextArea,     "madmin/field/text_area"
+    autoload :Text,         "madmin/field/text"
+  end
+end

data/lib/madmin/engine.rb

@@ -0,0 +1,9 @@
+module Madmin
+  class Engine < ::Rails::Engine
+    isolate_namespace Madmin
+
+    config.to_prepare do
+      Dir.glob("#{Rails.root}/app/madmin/**/*.rb").each { |r| require_dependency(r) }
+    end
+  end
+end

data/lib/madmin/field.rb

@@ -0,0 +1,64 @@
+module Madmin
+  class Field
+    attr_reader :form
+    attr_reader :index
+    attr_reader :key
+    attr_reader :label
+    attr_reader :model
+    attr_reader :options
+    attr_reader :show
+    attr_reader :type
+
+    def initialize(args)
+      @key     = args[:key]
+      @options = args
+      @model   = args[:model]
+      @label   = option_or_default(:label, label_from_attribute(key))
+      @form    = option_or_default(:form, false)
+      @index   = option_or_default(:index, false)
+      @show    = option_or_default(:show, true)
+    end
+
+    ##
+    # Returns an array of key(s) to use in strong
+    # params for the resources controller.
+    def strong_params_keys
+      [key]
+    end
+
+    ##
+    # Returns the partial path for the field type
+    def to_partial_path
+      "madmin/fields/#{self.class.to_s.split("Madmin::Field::").last.underscore}"
+    end
+
+    ##
+    # Returns the value for a given resource
+    def value_for(resource)
+      resource.send(key)
+    end
+
+    private
+
+    ##
+    # This method takes an attribute and converts it
+    # into a human readable format for form labels.
+    def label_from_attribute(attribute)
+      attribute.to_s.humanize
+    end
+
+    ##
+    # This method verifies options are present
+    # (as a hash).
+    def options?
+      options.is_a?(Hash)
+    end
+
+    ##
+    # This method extracts the many option checks
+    # performed when assigning field options.
+    def option_or_default(key, default)
+      options? ? options.fetch(key, default) : default
+    end
+  end
+end

data/lib/madmin/field/associatable.rb

@@ -0,0 +1,58 @@
+module Madmin
+  class Field
+    module Associatable
+      class << self
+        def included(_base)
+          attr_reader :association_class
+          attr_reader :association_display_value
+          attr_reader :association_foreign_key
+          attr_reader :association_scope
+        end
+      end
+
+      def initialize(args)
+        super(args)
+        implement_association!
+      end
+
+      def association_collection
+        association_class.send(association_scope)
+      end
+
+      def association_id_for(resource)
+        value_for(resource).id
+      end
+
+      def association_id_or_blank_for(resource)
+        value_for(resource).try(:id)
+      end
+
+      def association_param
+        ActiveModel::Naming.param_key(association_class)
+      end
+
+      def association_slug
+        Object.const_get("::Madmin::Resources::#{association_class}").new.slug
+      end
+
+      def association_value_for(resource)
+        value_for(resource).send(association_display_value)
+      end
+
+      def strong_params_keys
+        [association_foreign_key]
+      end
+
+      private
+
+      def implement_association!
+        association = model.reflect_on_all_associations.find { |assc| assc.name == key }
+
+        @association_class         = association.klass
+        @association_display_value = option_or_default(:display_value, :name)
+        @association_foreign_key   = association.foreign_key
+        @association_scope         = :all
+      end
+    end
+  end
+end

data/lib/madmin/field/belongs_to.rb

@@ -0,0 +1,9 @@
+module Madmin
+  class Field
+    ##
+    # This field represents a :belongs_to relationship within a Rails model.
+    class BelongsTo < Madmin::Field
+      include Madmin::Field::Associatable
+    end
+  end
+end

data/lib/madmin/field/check_box.rb

@@ -0,0 +1,8 @@
+module Madmin
+  class Field
+    ##
+    # This field represents a checkbox (boolean) value.
+    class CheckBox < Madmin::Field
+    end
+  end
+end

data/lib/madmin/field/date_time.rb

@@ -0,0 +1,8 @@
+module Madmin
+  class Field
+    ##
+    # This field represents a datetime value.
+    class DateTime < Madmin::Field
+    end
+  end
+end

data/lib/madmin/field/email.rb

@@ -0,0 +1,8 @@
+module Madmin
+  class Field
+    ##
+    # This field represents an email value.
+    class Email < Madmin::Field
+    end
+  end
+end

data/lib/madmin/field/has_many.rb

@@ -0,0 +1,9 @@
+module Madmin
+  class Field
+    ##
+    # This field represents a :has_many relationship within a Rails model.
+    class HasMany < Madmin::Field
+      include Madmin::Field::Associatable
+    end
+  end
+end

data/lib/madmin/field/has_one.rb

@@ -0,0 +1,9 @@
+module Madmin
+  class Field
+    ##
+    # This field represents a :has_one relationship within a Rails model.
+    class HasOne < Madmin::Field
+      include Madmin::Field::Associatable
+    end
+  end
+end

data/lib/madmin/field/number.rb

@@ -0,0 +1,8 @@
+module Madmin
+  class Field
+    ##
+    # This field represents a number value.
+    class Number < Madmin::Field
+    end
+  end
+end

data/lib/madmin/field/password.rb

@@ -0,0 +1,8 @@
+module Madmin
+  class Field
+    ##
+    # This field represents a password value.
+    class Password < Madmin::Field
+    end
+  end
+end