adminterface 0.0.0 → 0.2.3

data/lib/adminterface/initializers/formtastic.rb

@@ -0,0 +1,58 @@
+module Adminterface
+  module Initializers
+    module Formtastic
+      extend ActiveSupport::Concern
+
+      included do
+        initializer "base" do |_app|
+          require_relative("../extensions/form_builder")
+          require_relative("../extensions/inputs/base")
+          require_relative("../extensions/inputs/base/choices")
+          require_relative("../extensions/inputs/base/groupish")
+          require_relative("../extensions/inputs/base/stringish")
+          require_relative("../extensions/inputs/base/pluginish")
+        end
+
+        initializer "inputs" do |_app|
+          require_relative("../extensions/inputs/boolean_input")
+          require_relative("../extensions/inputs/check_boxes_input")
+          require_relative("../extensions/inputs/color_input")
+          require_relative("../extensions/inputs/country_input")
+          require_relative("../extensions/inputs/datalist_input")
+          require_relative("../extensions/inputs/date_picker_input")
+          require_relative("../extensions/inputs/date_select_input")
+          require_relative("../extensions/inputs/datetime_picker_input")
+          require_relative("../extensions/inputs/datetime_select_input")
+          require_relative("../extensions/inputs/email_input")
+          require_relative("../extensions/inputs/file_input")
+          require_relative("../extensions/inputs/number_input")
+          require_relative("../extensions/inputs/password_input")
+          require_relative("../extensions/inputs/phone_input")
+          require_relative("../extensions/inputs/radio_input")
+          require_relative("../extensions/inputs/range_input")
+          require_relative("../extensions/inputs/rich_text_area_input")
+          require_relative("../extensions/inputs/search_input")
+          require_relative("../extensions/inputs/select_input")
+          require_relative("../extensions/inputs/string_input")
+          require_relative("../extensions/inputs/switch_input")
+          require_relative("../extensions/inputs/text_input")
+          require_relative("../extensions/inputs/time_picker_input")
+          require_relative("../extensions/inputs/time_select_input")
+          require_relative("../extensions/inputs/time_zone_input")
+          require_relative("../extensions/inputs/url_input")
+        end
+
+        initializer "filters" do |_app|
+          require_relative("../extensions/filters/forms")
+          require_relative("../extensions/inputs/filters/base")
+          require_relative("../extensions/inputs/filters/base/search_method_select")
+          require_relative("../extensions/inputs/filters/boolean_input")
+          require_relative("../extensions/inputs/filters/check_boxes_input")
+          require_relative("../extensions/inputs/filters/date_picker_input")
+          require_relative("../extensions/inputs/filters/date_range_input")
+          require_relative("../extensions/inputs/filters/select_input")
+        end
+      end
+    end
+  end
+end

data/lib/adminterface/initializers/resource.rb

@@ -0,0 +1,20 @@
+module Adminterface
+  module Initializers
+    module Resource
+      extend ActiveSupport::Concern
+
+      included do
+        config.before_configuration do |_app|
+          require_relative("../extensions/dsl")
+          require_relative("../extensions/menu_item")
+          require_relative("../extensions/resource/action_items")
+          require_relative("../extensions/sidebar_section")
+        end
+
+        initializer "active_admin.controllers" do
+          require_relative("../extensions/base_controller")
+        end
+      end
+    end
+  end
+end

data/lib/adminterface/initializers/view_helpers.rb

@@ -0,0 +1,14 @@
+module Adminterface
+  module Initializers
+    module ViewHelpers
+      extend ActiveSupport::Concern
+
+      included do
+        initializer "view_helpers.overrides" do |_app|
+          require_relative("../extensions/view_helpers/alert_helper")
+          require_relative("../extensions/view_helpers/component_helper")
+        end
+      end
+    end
+  end
+end

data/lib/adminterface/initializers/views.rb

@@ -0,0 +1,39 @@
+module Adminterface
+  module Initializers
+    module Views
+      extend ActiveSupport::Concern
+
+      included do
+        config.before_configuration do |_app|
+          require_relative("../extensions/views/action_items")
+          require_relative("../extensions/views/columns")
+          require_relative("../extensions/views/components/active_admin_form")
+          require_relative("../extensions/views/components/attributes_table")
+          require_relative("../extensions/views/components/blank_slate")
+          require_relative("../extensions/views/components/dropdown_menu")
+          require_relative("../extensions/views/components/icon")
+          require_relative("../extensions/views/components/index_list")
+          require_relative("../extensions/views/components/menu_item")
+          require_relative("../extensions/views/components/menu")
+          require_relative("../extensions/views/components/paginated_collection")
+          require_relative("../extensions/views/components/panel")
+          require_relative("../extensions/views/components/scopes")
+          require_relative("../extensions/views/components/sidebar_section")
+          require_relative("../extensions/views/components/site_title")
+          require_relative("../extensions/views/components/status_tag")
+          require_relative("../extensions/views/components/table_for")
+          require_relative("../extensions/views/components/tabs")
+          require_relative("../extensions/views/footer")
+          require_relative("../extensions/views/header")
+          require_relative("../extensions/views/index_as_grid")
+          require_relative("../extensions/views/index_as_table")
+          require_relative("../extensions/views/pages/base")
+          require_relative("../extensions/views/pages/form")
+          require_relative("../extensions/views/pages/index")
+          require_relative("../extensions/views/pages/page")
+          require_relative("../extensions/views/title_bar")
+        end
+      end
+    end
+  end
+end

data/lib/adminterface/license.rb

@@ -0,0 +1,18 @@
+module Adminterface
+  class License
+    class_attribute :license, default: {}
+
+    class << self
+      def verify!
+        return if Rails.env.test?
+
+        self.license =
+          if ::Adminterface.license_key.present?
+            ::Adminterface::Licensing::Commercial
+          else
+            ::Adminterface::Licensing::Personal
+          end.call
+      end
+    end
+  end
+end

data/lib/adminterface/licensing/base.rb

@@ -0,0 +1,99 @@
+module Adminterface
+  module Licensing
+    class Base
+      extend Adminterface::Callable
+
+      ENDPOINT = "https://app.adminterface.io/api/v1/licenses/verify".freeze
+      CACHE_KEY = "adminterface.licensing.response".freeze
+      TIMEOUT = 5
+
+      attr_reader :license_key
+      delegate :cache_store, :rails6_and_up?, to: :Adminterface
+
+      def initialize(license_key = Adminterface.license_key)
+        @license_key = license_key
+      end
+
+      def call
+        response = send_and_cache_request.with_indifferent_access
+        Adminterface::Licensing::Notice
+          .call(response, license_key, **{external: request?, endpoint: ENDPOINT})
+        response
+      end
+
+      def payload
+        {
+          license_key: encrypted_license_key,
+          license: license,
+          adminterface_version: Adminterface::VERSION,
+          rails_version: Rails::VERSION::STRING,
+          ruby_version: RUBY_VERSION,
+          environment: Rails.env,
+          app_name: app_name,
+          verified: false
+        }
+      end
+
+      private
+
+      def encrypted_license_key
+        @encrypted_license_key ||=
+          license_key && Adminterface::Encryption::Encryptor.call(license_key)
+      end
+
+      def send_and_cache_request
+        return cached_response if has_cached_response?
+        return local_response unless request?
+
+        response = HTTParty.post(
+          ENDPOINT,
+          body: payload.to_json,
+          headers: {'Content-type': "application/json"},
+          timeout: TIMEOUT
+        )
+
+        case response.code
+        when 200 then cache_response response.code, response.parsed_response
+        else return_error response.code, response.body
+        end
+      rescue => e
+        return_error e.class, e.message
+      end
+
+      def local_response
+        payload.merge(verified: true)
+      end
+
+      def request?
+        true
+      end
+
+      def return_error(status, exception_message = "")
+        payload.merge(status: status, message: exception_message).stringify_keys!
+      end
+
+      def cache_response(status, response, time: 1.hour.to_i)
+        response = payload.merge!(status: status, expiry: time, **response).stringify_keys!
+        cache_store.write(CACHE_KEY, response, expires_in: time)
+        response
+      end
+
+      def license
+        self.class.name.split("::").last.underscore
+      end
+
+      def app_name
+        klass = Rails.application.class
+        rails6_and_up? ? klass.module_parent.name : klass.parent.name
+      end
+
+      def has_cached_response?
+        cache_store.exist? CACHE_KEY
+      end
+
+      def cached_response
+        cache_store.read CACHE_KEY
+      end
+    end
+  end
+end

data/lib/adminterface/licensing/commercial.rb

@@ -0,0 +1,7 @@
+require_relative "./base"
+
+module Adminterface
+  module Licensing
+    class Commercial < Base; end
+  end
+end

data/lib/adminterface/licensing/notice.rb

@@ -0,0 +1,54 @@
+module Adminterface
+  module Licensing
+    class Notice
+      extend Adminterface::Callable
+      attr_reader :response, :license_key, :external, :endpoint
+
+      def initialize(response, license_key, external: true, endpoint: nil)
+        @response = response
+        @license_key = license_key
+        @external = external
+        @endpoint = endpoint
+      end
+
+      def call
+        return unless Rails.env.development?
+
+        log("========================================")
+        log(messages)
+        log("========================================")
+      end
+
+      private
+
+      def log(*msgs)
+        msgs.each { |x| puts(x) }
+      end
+
+      def external?
+        !!external
+      end
+
+      def title
+        "Adminterface #{response[:adminterface_version]} (\"#{response[:license]}\")"
+      end
+
+      def messages
+        return title unless external?
+
+        [title, "=> Verifying license on #{endpoint}", verified].flatten
+      end
+
+      def verified
+        if !!response[:verified]
+          Rainbow("=> [#{response[:status]}] #{response[:message]}").green
+        else
+          [
+            Rainbow("=> [#{response[:status]}] #{response[:message]}").red,
+            Rainbow("=> license_key: #{license_key}").red
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/adminterface/licensing/personal.rb

@@ -0,0 +1,13 @@
+require_relative "./base"
+
+module Adminterface
+  module Licensing
+    class Personal < Base
+      private
+
+      def request?
+        false
+      end
+    end
+  end
+end

data/lib/adminterface/public.pem

@@ -0,0 +1,9 @@
+-----BEGIN PUBLIC KEY-----
+MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAuH2AdyyQycs7DhFQo1f/
+9ssIqc5ek7OYZHlfwSYSFuWaTfq46HK66QZ1ebkUva/U33QzNyaxcMxYpTpRY2dF
+IPLtS1QNktC4U0T3Nz0sY3tZp/IwnWcE9b8MpS2FDFtMRiHu+/dtthWoG6kP6w5y
+P8pWDLwQuYPbPnqlLbp6yWaJB1G1qHoLmgKD1VPUxjk0gB0tGPPvaiciESObbGC3
+IgzeUKtz/+dhR4UBOZc1pmrftwacUfvNHrSuot0jaYCNrb98Oq8kkBpp79MgRghK
+SkPdTRidSlIokdxlEOrcRhoJsVka5w9fYLShJdv1yhmGh3VZdKkvSqM7MhwE+zML
+0QIDAQAB
+-----END PUBLIC KEY-----

data/lib/adminterface/version.rb

@@ -0,0 +1,3 @@
+module Adminterface
+  VERSION = "0.2.3"
+end

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,33 @@
+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 install_action_text
+        rails_command "action_text:install"
+      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"
+      source_root File.expand_path("templates", __dir__)
+
+      argument :namespace, type: :string, default: "Admin"
+
+      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,39 @@
+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__)
+
+      class_option :skip_comments,
+        type: :boolean, default: false,
+        desc: "Skip installation of ActionText for comments"
+      class_option :skip_examples,
+        type: :boolean, default: false,
+        desc: "Skip adding sample admin files"
+      class_option :use_webpacker,
+        type: :boolean, default: true,
+        desc: "Install assets with webpacker"
+      class_option :version,
+        aliases: "-v", type: :string, default: Adminterface::VERSION,
+        desc: "Install with a specific version"
+
+      def install_assets
+        return unless options[:use_webpacker]
+
+        generate "adminterface:webpacker -v #{options[:version]}"
+      end
+
+      def install_comments
+        return if options[:skip_comments]
+
+        generate "adminterface:comments"
+      end
+
+      def add_examples
+        return if options[:skip_examples]
+
+        template "dashboard.rb", "app/admin/dashboard.rb"
+      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
+===============================================================================