adminterface 0.0.0 → 0.2.0

data/lib/adminterface.rb

@@ -0,0 +1,55 @@
+require "activeadmin"
+require "rainbow"
+require "httparty"
+
+# Adminterface main file
+module Adminterface
+  autoload :VERSION, "adminterface/version"
+  autoload :Configs, "adminterface/configs"
+  autoload :Data, "adminterface/data"
+  autoload :License, "adminterface/license"
+  autoload :Callable, "adminterface/callable"
+
+  # Load Initializers
+  module Initializers
+    autoload :BatchActions, "adminterface/initializers/batch_actions"
+    autoload :Comments, "adminterface/initializers/comments"
+    autoload :Configurations, "adminterface/initializers/configurations"
+    autoload :Formtastic, "adminterface/initializers/formtastic"
+    autoload :Resource, "adminterface/initializers/resource"
+    autoload :ViewHelpers, "adminterface/initializers/view_helpers"
+    autoload :Views, "adminterface/initializers/views"
+  end
+
+  module Licensing
+    autoload :Notice, "adminterface/licensing/notice"
+    autoload :Commercial, "adminterface/licensing/commercial"
+    autoload :Personal, "adminterface/licensing/personal"
+  end
+
+  module Encryption
+    autoload :Encryptor, "adminterface/encryption/encryptor"
+  end
+
+  # License key
+  mattr_accessor :license_key
+  @@license_key = nil
+
+  def self.setup
+    yield self
+  end
+
+  def self.rails6_and_up?
+    Rails::VERSION::MAJOR >= 6
+  end
+
+  def self.cache_store
+    if Rails.cache.instance_of?(ActiveSupport::Cache::NullStore)
+      ActiveSupport::Cache::MemoryStore.new
+    else
+      Rails.cache
+    end
+  end
+end
+
+require "adminterface/engine"

data/lib/generators/adminterface/comments/comments_generator.rb

@@ -0,0 +1,29 @@
+module Adminterface
+  module Generators
+    class CommentsGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      desc "Generate action_text migrations and initializers for ActiveAdmin::Comment"
+      source_root File.expand_path("templates", __dir__)
+
+      def self.next_migration_number(dirname)
+        next_migration_number = current_migration_number(dirname) + 1
+        ActiveRecord::Migration.next_migration_number(next_migration_number)
+      end
+
+      def create_initializer
+        template "active_admin_comment_action_text.rb",
+          "config/initializers/active_admin_comment_action_text.rb"
+      end
+
+      def create_migrations
+        migration_template "migrations/drop_body_for_active_admin_comments.rb.erb",
+          "db/migrate/drop_body_for_active_admin_comments.rb"
+      end
+
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/adminterface/comments/templates/README

@@ -0,0 +1,13 @@
+===============================================================================
+Command: `rails generate adminterface:comments`
+This command does the following:
+
+  1. Create a migration `drop_body_for_active_admin_comments.rb`
+     - Your existing data is saved inside the `body_backup` column by default
+     - Un-comment the lines inside this file to migrate existing data from the `ActiveAdmin::Comment` table to `ActionText::RichText`
+
+  2. Create an initializer `initializers/active_admin_comment_action_text.rb`
+     - This tells the `ActiveAdmin::Comment` model to use ActionText instead of the `body` database column
+
+  3. For guides, please visit https://github.com/CMDBrew/adminterface
+===============================================================================

data/lib/generators/adminterface/comments/templates/active_admin_comment_action_text.rb

@@ -0,0 +1,18 @@
+module Adminterface
+  module ActionTextComment
+    extend ActiveSupport::Concern
+
+    included do
+      # Fix author validation issue— https://github.com/activeadmin/activeadmin/issues/5258
+      _validate_callbacks.each do |callback|
+        callback.raw_filter.attributes.delete :author
+      end
+
+      has_rich_text :body
+    end
+  end
+end
+
+Rails.configuration.to_prepare do
+  ActiveAdmin::Comment.send :include, Adminterface::ActionTextComment
+end

data/lib/generators/adminterface/comments/templates/migrations/drop_body_for_active_admin_comments.rb.erb

@@ -0,0 +1,28 @@
+class DropBodyForActiveAdminComments < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version.to_s %>]
+  def up
+    rename_column :active_admin_comments, :body, :body_backup
+
+    ## Add migration to migrate existing data if necessary
+    # ActiveAdmin::Comment.reset_column_information
+    # ActiveAdmin::Comment.find_each do |comment|
+    #   comment.body = comment.body_backup
+    #   comment.save
+    # end
+
+    # remove_column :active_admin_comments, :body_backup, :text
+  end
+
+  def down
+    # add_column :active_admin_comments, :body_backup, :text
+
+    ## Add migration to migrate existing data if necessary
+    # ActiveAdmin::Comment.reset_column_information
+    # ActiveAdmin::Comment.find_each do |comment|
+    #   comment.body_backup = comment.body.to_plain_text
+    #   comment.save
+    # end
+
+    rename_column :active_admin_comments, :body_backup, :body
+  end
+end
+

data/lib/generators/adminterface/configs/configs_generator.rb

@@ -0,0 +1,19 @@
+module Adminterface
+  module Generators
+    class ConfigsGenerator < Rails::Generators::Base
+      desc "Copies config files into a directory for customization"
+      argument :namespace, type: :string, default: "Admin"
+
+      source_root File.expand_path("templates", __dir__)
+
+      def copy
+        directory Adminterface::Engine.root.join("lib/adminterface/fixtures"),
+          "config/adminterface/#{namespace.underscore}/"
+      end
+
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/adminterface/configs/templates/README

@@ -0,0 +1,33 @@
+===============================================================================
+Depending on how you want to structure your application, you can use configs files to update:
+  1. Global Settings
+    ```
+    # config/initializers/active_admin.rb
+    ActiveAdmin.setup do
+      config.css_classes = YAML.load_file(Rails.root.join("config/adminterface/css_classes.yml").to_s)
+      config.components = YAML.load_file(Rails.root.join("config/adminterface/components.yml").to_s)
+    end
+    ```
+
+  2. Namespace Settings
+    ```
+    # config/initializers/active_admin.rb
+    ActiveAdmin.setup do
+      config.namespace :site_1 do |site|
+        config.css_classes = YAML.load_file(Rails.root.join("config/adminterface/site_1/css_classes.yml").to_s)
+        config.components = YAML.load_file(Rails.root.join("config/adminterface/site_1/components.yml").to_s)
+      end
+    end
+    ```
+
+  3. Resource Settings
+    ```
+    # app/admin/users.rb
+    ActiveAdmin.register User do
+      config.css_classes = YAML.load_file(Rails.root.join("config/adminterface/admin/users/css_classes.yml").to_s)
+      config.components = YAML.load_file(Rails.root.join("config/adminterface/admin/users/components.yml").to_s)
+    end
+    ```
+
+  4. For guides, please visit https://github.com/CMDBrew/adminterface
+===============================================================================

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

@@ -0,0 +1,41 @@
+module Adminterface
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Installs Adminterface and generates necessary files and migrations"
+      source_root File.expand_path("templates", __dir__)
+
+      def install_rails_addons
+        invoke "action_text:install"
+      end
+
+      def install_assets
+        install_webpacker? do
+          generate "adminterface:webpacker"
+        end
+      end
+
+      def install_action_text_for_comments
+        generate "adminterface:comments"
+      end
+
+      def add_samples
+        template "dashboard.rb", "app/admin/dashboard.rb"
+      end
+
+      private
+
+      def install_webpacker?
+        return yield if defined?(Webpacker)
+
+        puts Rainbow("Adminterface requires webpacker:").yellow
+        if yes?("Install webpacker and continue?")
+          gem "webpacker"
+          rails_command "webpacker:install"
+          yield
+        else
+          puts Rainbow("Installation aborted").red
+        end
+      end
+    end
+  end
+end

data/lib/generators/adminterface/install/templates/dashboard.rb

@@ -0,0 +1,32 @@
+ActiveAdmin.register_page "Dashboard" do
+  menu priority: 1
+
+  content title: proc { I18n.t("active_admin.dashboard") } do
+    div class: "alert alert-info" do
+      h4 I18n.t("active_admin.dashboard_welcome.welcome"), class: "alert-heading"
+      para I18n.t("active_admin.dashboard_welcome.call_to_action").html_safe
+      hr
+      para I18n.t("active_admin.dashboard_welcome.footnote").html_safe, class: "mb-0"
+    end
+
+    # Here is an example of a simple dashboard with columns and panels.
+    #
+    # columns do
+    #   column do
+    #     panel "Recent Posts" do
+    #       ul do
+    #         Post.recent(5).map do |post|
+    #           li link_to(post.title, admin_post_path(post))
+    #         end
+    #       end
+    #     end
+    #   end
+
+    #   column do
+    #     panel "Info" do
+    #       para "Welcome to ActiveAdmin."
+    #     end
+    #   end
+    # end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Adminterface
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base
+      desc "Copies view templates for customization"
+
+      source_root Adminterface::Engine.root.join("app/views")
+
+      def copy
+        directory "active_admin", "app/views/active_admin"
+        directory "kaminari/active_admin", "app/views/kaminari/active_admin"
+        directory "layouts/active_admin_logged_out.html.erb", "app/views/layouts/active_admin_logged_out.html.erb"
+      end
+    end
+  end
+end

data/lib/generators/adminterface/webpacker/templates/README

@@ -0,0 +1,27 @@
+===============================================================================
+Command: `rails generate adminterface:webpacker`
+Depending on your application's configuration, you might need to perform some manual steps:
+
+  1. Change your ActiveAdmin config to use webpacker
+    ```
+    # config/initializers/active_admin.rb
+    # ...
+    #
+    # == Webpacker
+    #
+    # By default, Active Admin uses Sprocket's asset pipeline.
+    # You can switch to using Webpacker here.
+    #
+    config.use_webpacker = true
+    ```
+
+  2. Migrate your custom javascripts and stylesheets to webpacker
+    - app/assets/javascripts/active_admin.js -> app/javascript/packs/active_admin.js
+    - app/assets/stylesheets/active_admin.scss -> app/javascript/stylesheets/active_admin.scss
+
+  3. Remove unnecessary sprockets files
+    - app/assets/javascripts/active_admin.js
+    - app/assets/stylesheets/active_admin.scss
+
+  4. For guides, please visit https://github.com/CMDBrew/adminterface
+===============================================================================

data/lib/generators/adminterface/webpacker/templates/active_admin.js

@@ -0,0 +1,12 @@
+// Load Adminterface styles into Webpacker,
+// see `adminterface.scss` for customization.
+import '../stylesheets/active_admin'
+
+import Rails from '@rails/ujs'
+import '@cmdbrew/adminterface'
+
+require('@rails/activestorage').start()
+require('trix')
+require('@rails/actiontext')
+
+Rails.start()

data/lib/generators/adminterface/webpacker/templates/active_admin.scss

@@ -0,0 +1,8 @@
+// Sass variable overrides must be declared before loading up Adminterface styles.
+//
+// To view the variables that Adminterface provides, take a look at
+// `app/assets/stylesheets/adminterface/mixins/_variables.scss` in the
+// Adminterface source.
+
+// Adminterface got SASS!
+@import "~@cmdbrew/adminterface/src/scss/base";

data/lib/generators/adminterface/webpacker/templates/print.scss

@@ -0,0 +1,3 @@
+// Active Admin Print Stylesheet
+// Keeping this file for activeadmin <= 2.9.0 backward compatibility. The latest ActiveAdmin has combined print.scss into the main file.
+// https://github.com/activeadmin/activeadmin/pull/6922/commits/14b64cdf946449091a467ea22adbafd88782b614

data/lib/generators/adminterface/webpacker/webpacker_generator.rb

@@ -0,0 +1,55 @@
+module Adminterface
+  module Generators
+    class WebpackerGenerator < Rails::Generators::Base
+      desc "Install Stylesheets and JavaScripts using Webpacker"
+      class_option :version,
+        aliases: "-v", type: :string, default: Adminterface::VERSION,
+        desc: "Install with a specific npm package version"
+
+      source_root File.expand_path("templates", __dir__)
+
+      def install_packages
+        insert_into_file "config/webpack/environment.js", after: /require\(('|")@rails\/webpacker\1\);?\n/ do
+          <<~EOF
+
+            environment.loaders.get('sass').use.splice(-1, 0, {
+              loader: 'resolve-url-loader'
+            })
+          EOF
+        end
+
+        run "yarn add @cmdbrew/adminterface@v#{find_npm_version}"
+      end
+
+      def install_assets
+        template "active_admin.js", "app/javascript/packs/active_admin.js"
+        template "active_admin.scss", "app/javascript/stylesheets/active_admin.scss"
+        template "print.scss", "app/javascript/packs/active_admin/print.scss"
+      end
+
+      def update_active_admin_configs
+        gsub_file "config/initializers/active_admin.rb", "# config.use_webpacker = true", "config.use_webpacker = true"
+      end
+
+      def remove_activeadmin_dependencies
+        run "yarn remove @activeadmin/activeadmin"
+        remove_file "config/webpack/plugins/jquery.js"
+        gsub_file "config/webpack/environment.js", "environment.plugins.prepend('jquery', jquery)\n", ""
+        gsub_file "config/webpack/environment.js", "const jquery = require('./plugins/jquery')\n", ""
+      end
+
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+
+      private
+
+      def find_npm_version
+        version = options[:version]
+        return version unless version.include?(".rc")
+
+        version.gsub(".rc", "-rc")
+      end
+    end
+  end
+end

data/lib/tasks/adminterface_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :adminterface do
+#   # Task goes here
+# end