admin_core 0.0.1

data/lib/admin_core/base_controller.rb

@@ -0,0 +1,114 @@
+require 'action_controller'
+
+module AdminCore
+  # @abstract
+  class BaseController < ActionController::Base
+    def index
+      respond_to do |format|
+        format.html do
+          render template: AdminCore.config.template
+        end
+        format.json do
+          render json: { page: AdminCore::ResourcePage::Index.new(resource_manager, params) }
+        end
+      end
+    end
+
+    def new
+      respond_to do |format|
+        format.html do
+          render template: AdminCore.config.template
+        end
+        format.json do
+          render json: { page: AdminCore::ResourcePage::New.new(resource_manager, params) }
+        end
+      end
+    end
+
+    def create
+      resource = resource_manager.build(params_for_create)
+      if resource.save
+        render json: { redirectTo: resource_router.show_path(resource) }
+      else
+        render_errors(resource)
+      end
+    end
+
+    def show
+      respond_to do |format|
+        format.html do
+          render template: AdminCore.config.template
+        end
+        format.json do
+          render json: { page: AdminCore::ResourcePage::Show.new(resource_manager, params) }
+        end
+      end
+    end
+
+    def edit
+      respond_to do |format|
+        format.html do
+          render template: AdminCore.config.template
+        end
+        format.json do
+          render json: { page: AdminCore::ResourcePage::Edit.new(resource_manager, params) }
+        end
+      end
+    end
+
+    def update
+      resource = resource_manager.find(params)
+      if resource.update(params_for_update)
+        render json: { redirectTo: resource_router.show_path(resource) }
+      else
+        render_errors(resource)
+      end
+    end
+
+    def destroy
+      resource = resource_manager.find(params)
+      if resource.destroy
+        render json: { redirectTo: resource_router.index_path }
+      else
+        render_errors(resource)
+      end
+    end
+
+    private
+
+    # @param resource [ActiveRecord::Base]
+    def render_errors(resource)
+      errors = {}
+      resource.errors.messages.keys.each do |key|
+        errors[key] = resource.errors.full_messages_for(key)
+      end
+      render json: { errors: errors }, status: :unprocessable_entity
+    end
+
+    # @return [AdminCore::BaseResourceManager]
+    def resource_manager
+      @resource_manager ||= resource_manager_class.new
+    end
+
+    # @return [AdminCore::ResourceRouter]
+    def resource_router
+      resource_manager_class.router
+    end
+
+    # @return [Class]
+    def resource_manager_class
+      resource_name = controller_path.singularize.split('/')[-1]
+      "#{AdminCore.config.module_name}::#{resource_name.camelize}".constantize
+    end
+
+    # @return [ActionController::Parameters]
+    def params_for_create
+      params.require(resource_manager.name).permit(resource_manager.permitted_field_names_for(:new))
+    end
+
+    # @return [ActionController::Parameters]
+    def params_for_update
+      params.require(resource_manager.name).permit(resource_manager.permitted_field_names_for(:edit))
+    end
+  end
+end

data/lib/admin_core/base_resource_manager.rb

@@ -0,0 +1,24 @@
+require_relative 'resource_manager/buildable'
+require_relative 'resource_manager/convert'
+require_relative 'resource_manager/has_many_fields'
+require_relative 'resource_manager/permission'
+require_relative 'resource_manager/searchable'
+
+module AdminCore
+  # @abstract
+  class BaseResourceManager
+    include AdminCore::ResourceManager::Buildable
+    include AdminCore::ResourceManager::Convert
+    include AdminCore::ResourceManager::HasManyFields
+    include AdminCore::ResourceManager::Searchable
+    include AdminCore::ResourceManager::Permission
+
+    private
+
+    # @param resource [ActiveRecord::Base]
+    # @return [String]
+    def display_resource(resource)
+      "#{resource.class} ##{resource.id}"
+    end
+  end
+end

data/lib/admin_core/configuration.rb

@@ -0,0 +1,20 @@
+module AdminCore
+  # Stores AdminCore configuration information.
+  class Configuration
+    DEFAULT_MODULE_NAME = 'Admin'.freeze
+
+    attr_accessor :route_name_prefix, :module_name, :template
+
+    def module_name
+      @module_name ||= DEFAULT_MODULE_NAME
+    end
+
+    def route_name_prefix
+      @route_name_prefix ||= module_name.underscore
+    end
+
+    def template
+      @template ||= "#{route_name_prefix}/application"
+    end
+  end
+end

data/lib/admin_core/engine.rb

@@ -0,0 +1,6 @@
+require 'rails'
+
+module AdminCore
+  class Engine < Rails::Engine
+  end
+end

data/lib/admin_core/errors.rb

@@ -0,0 +1,17 @@
+module AdminCore
+  # Base of any errors raised by AdminCore.
+  class Error < StandardError
+  end
+
+  class ResourceManagerAlreadyRegistered < Error
+  end
+
+  class ResourceFieldAlreadyRegistered < Error
+  end
+
+  class ResourceFieldNotFound < Error
+  end
+
+  class InvalidResourceFieldDefinition < Error
+  end
+end

data/lib/admin_core/resource_field/base.rb

@@ -0,0 +1,69 @@
+require 'admin_core/resource_field_builder'
+
+module AdminCore
+  module ResourceField
+    # @abstract Subclass and override {#field_value} to implement a custom resource field class.
+    class Base
+      # @return [Symbol]
+      def self.type
+        name.demodulize.underscore.to_sym
+      end
+
+      # @param name [Symbol]
+      # @return [Symbol]
+      def self.permitted_field_name_of(name)
+        name
+      end
+
+      def self.register
+        AdminCore::ResourceFieldBuilder.register(type, self)
+      end
+
+      # @param resource [ActiveRecord::Base]
+      # @param name [Symbol]
+      # @param options [Hash]
+      # @param page [Symbol] :index, :new, :show or :edit
+      # @raise [AdminCore::InvalidFieldDefinition]
+      def initialize(resource, name, options, page)
+        @resource = resource
+        @name = name
+        @options = options
+        @page = page
+        validate
+      end
+
+      # Representation of ResourceField type.
+      #
+      # @return [Hash]
+      def to_hash
+        {
+          type: self.class.type,
+          name: name,
+          displayName: human_attribute_name,
+          value: field_value,
+        }
+      end
+
+      private
+
+      attr_reader :resource, :name, :options, :page
+
+      def field_value
+        raise NotImplementedError
+      end
+
+      # Override this method to validate field definition.
+      #
+      # @raise [AdminCore::InvalidFieldDefinition]
+      def validate; end
+
+      def data
+        resource.public_send(name)
+      end
+
+      def human_attribute_name
+        resource.class.human_attribute_name(name)
+      end
+    end
+  end
+end

data/lib/admin_core/resource_field/belongs_to.rb

@@ -0,0 +1,38 @@
+require_relative 'base'
+require_relative '../errors'
+
+module AdminCore
+  module ResourceField
+    class BelongsTo < Base
+      private
+
+      def field_value
+        {
+          # Remove fields to avoid infinite field dependency loop
+          resource: associated_resource_manager.convert_for_index_page(associated_resource).merge(fields: []),
+        }
+      end
+
+      def validate
+        return if associated_resource_manager_class
+        raise AdminCore::InvalidResourceFieldDefinition, 'resource_manager_class option is required'
+      end
+
+      def associated_resource
+        data || associated_resource_manager.build({})
+      end
+
+      def associated_resource_manager
+        @associated_resource_manager ||= associated_resource_manager_class.new
+      end
+
+      def associated_resource_manager_class
+        options[:resource_manager_class] || AdminCore.resource_managers.find do |manager_class|
+          manager_class.resource_name.to_sym == name
+        end
+      end
+    end
+
+    AdminCore.register_resource_field(BelongsTo)
+  end
+end

data/lib/admin_core/resource_field/boolean.rb

@@ -0,0 +1,18 @@
+require_relative 'base'
+
+module AdminCore
+  module ResourceField
+    # @!attribute [r] data
+    #   @return [Boolean]
+    class Boolean < Base
+      private
+
+      # @note Implementation for {QiitaAdmin::ResourceField::Base#field_value}
+      def field_value
+        data
+      end
+    end
+
+    AdminCore.register_resource_field(Boolean)
+  end
+end

data/lib/admin_core/resource_field/date.rb

@@ -0,0 +1,18 @@
+require_relative 'base'
+
+module AdminCore
+  module ResourceField
+    # @!attribute [r] data
+    #   @return [ActiveSupport::TimeWithZone]
+    class Date < Base
+      private
+
+      # @note Implementation for {QiitaAdmin::ResourceField::Base#field_value}
+      def field_value
+        data.to_s
+      end
+    end
+
+    AdminCore.register_resource_field(Date)
+  end
+end

data/lib/admin_core/resource_field/date_time.rb

@@ -0,0 +1,18 @@
+require_relative 'base'
+
+module AdminCore
+  module ResourceField
+    # @!attribute [r] data
+    #   @return [ActiveSupport::TimeWithZone]
+    class DateTime < Base
+      private
+
+      # @note Implementation for {QiitaAdmin::ResourceField::Base#field_value}
+      def field_value
+        data.to_s
+      end
+    end
+
+    AdminCore.register_resource_field(DateTime)
+  end
+end

data/lib/admin_core/resource_field/enum.rb

@@ -0,0 +1,26 @@
+require_relative 'base'
+
+module AdminCore
+  module ResourceField
+    # @!attribute [r] data
+    #   @return [String]
+    class Enum < Base
+      private
+
+      # @note Implementation for {QiitaAdmin::ResourceField::Base#field_value}
+      def field_value
+        {
+          value: data,
+          values: values,
+        }
+      end
+
+      # @return [Array<String>]
+      def values
+        options.fetch(:values, [])
+      end
+    end
+
+    AdminCore.register_resource_field(Enum)
+  end
+end

data/lib/admin_core/resource_field/number.rb

@@ -0,0 +1,18 @@
+require_relative 'base'
+
+module AdminCore
+  module ResourceField
+    # @!attribute [r] data
+    #   @return [Integer, Float]
+    class Number < Base
+      private
+
+      # @note Implementation for {QiitaAdmin::ResourceField::Base#field_value}
+      def field_value
+        data
+      end
+    end
+
+    AdminCore.register_resource_field(Number)
+  end
+end

data/lib/admin_core/resource_field/string.rb

@@ -0,0 +1,18 @@
+require_relative 'base'
+
+module AdminCore
+  module ResourceField
+    # @!attribute [r] data
+    #   @return [String]
+    class String < Base
+      private
+
+      # @note Implementation for {QiitaAdmin::ResourceField::Base#field_value}
+      def field_value
+        data
+      end
+    end
+
+    AdminCore.register_resource_field(String)
+  end
+end

data/lib/admin_core/resource_field/text.rb

@@ -0,0 +1,23 @@
+require_relative 'base'
+
+module AdminCore
+  module ResourceField
+    # @!attribute [r] data
+    #   @return [String]
+    class Text < Base
+      private
+
+      # @note Implementation for {QiitaAdmin::ResourceField::Base#field_value}
+      def field_value
+        data.to_s[0...truncate_length]
+      end
+
+      # @return [Integer]
+      def truncate_length
+        options.fetch(:truncate, 50)
+      end
+    end
+
+    AdminCore.register_resource_field(Text)
+  end
+end

data/lib/admin_core/resource_field_builder.rb

@@ -0,0 +1,48 @@
+require 'set'
+require 'admin_core/errors'
+
+module AdminCore
+  class ResourceFieldBuilder
+    # @param type [Symbol]
+    # @return [Class]
+    # @raise [AdminCore::FieldNotFound]
+    def self.resolve(type)
+      unless AdminCore.resource_field_map.key?(type)
+        raise AdminCore::FieldNotFound, "Unknown field: #{type}"
+      end
+      AdminCore.resource_field_map[type]
+    end
+
+    # @param name [Symbol]
+    # @param type [Symbol, Class]
+    # @param options [Symbol]
+    def initialize(name, type, options)
+      @name = name
+      @type = type
+      @options = options
+    end
+
+    # @param resource [ActiveRecord::Base]
+    # @param page [Symbol]
+    # @return [AdminCore::ResourceField::Base]
+    # @raise [AdminCore::FieldNotFound]
+    def build(resource, page)
+      resource_field_class.new(resource, name, options, page)
+    end
+
+    # @return [Symbol]
+    # @raise [AdminCore::FieldNotFound]
+    def permitted_field_name
+      resource_field_class.permitted_field_name_of(name)
+    end
+
+    private
+
+    attr_reader :name, :type, :options
+
+    # @return [Class]
+    def resource_field_class
+      @resource_field_class ||= self.class.resolve(type)
+    end
+  end
+end

data/lib/admin_core/resource_filter/base.rb

@@ -0,0 +1,63 @@
+module AdminCore
+  module ResourceFilter
+    class Base
+      # @return [String]
+      def self.default_query_operator
+        'is'
+      end
+
+      # @return [String]
+      def self.type
+        name.demodulize.underscore.to_sym
+      end
+
+      # @param resource_manager [AdminCore::BaseResourceManager]
+      # @param name [Symbol]
+      # @param options [Hash]
+      # @param query_operator [String]
+      # @param query_value [String]
+      def initialize(resource_manager, name, options, query_operator, query_value)
+        @resource_manager = resource_manager
+        @name = name
+        @options = options
+        @query_operator = query_operator
+        @query_value = query_value
+      end
+
+      def empty?
+        query_value ? query_value.empty? : true
+      end
+
+      def to_hash
+        {
+          type: self.class.type,
+          name: name,
+          displayName: display_name,
+          query: {
+            operator: query_operator,
+            value: query_value,
+          },
+        }
+      end
+
+      # @param relation [ActiveRecord::Relation]
+      # @return [ActiveRecord::Relation]
+      def apply(relation) # rubocop:disable Lint/UnusedMethodArgument
+        raise NotImplementedError
+      end
+
+      private
+
+      attr_reader :resource_manager, :name, :options, :query_value
+
+      # @return [String]
+      def display_name
+        resource_manager.class.resource_class.human_attribute_name(name)
+      end
+
+      def query_operator
+        @query_operator || self.class.default_query_operator
+      end
+    end
+  end
+end

data/lib/admin_core/resource_filter/boolean.rb

@@ -0,0 +1,17 @@
+require_relative 'base'
+
+module AdminCore
+  module ResourceFilter
+    class Boolean < Base
+      # @note Implementation for {AdminCore::ResourceFilter::Base#apply}
+      def apply(relation)
+        case query_operator
+        when 'is'
+          relation.where(name => %w[true yes on 1].include?(query_value))
+        else
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/admin_core/resource_filter/number.rb

@@ -0,0 +1,25 @@
+require_relative 'base'
+
+module AdminCore
+  module ResourceFilter
+    class Number < Base
+      def self.default_query_operator
+        'equals'
+      end
+
+      # @note Implementation for {AdminCore::ResourceFilter::Base#apply}
+      def apply(relation) # rubocop:disable Metrics/AbcSize
+        case query_operator
+        when 'equals'
+          relation.where(name => query_value)
+        when 'greater_than'
+          relation.where(relation.arel_table[name].gt(query_value))
+        when 'less_than'
+          relation.where(relation.arel_table[name].lt(query_value))
+        else
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/admin_core/resource_filter/string.rb

@@ -0,0 +1,27 @@
+require_relative 'base'
+
+module AdminCore
+  module ResourceFilter
+    class String < Base
+      def self.default_query_operator
+        'equals'
+      end
+
+      # @note Implementation for {AdminCore::ResourceFilter::Base#apply}
+      def apply(relation) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+        case query_operator
+        when 'contains'
+          relation.where(relation.arel_table[name].matches("%#{query_value}%"))
+        when 'equals'
+          relation.where(name => query_value)
+        when 'starts_with'
+          relation.where(relation.arel_table[name].matches("#{query_value}%"))
+        when 'ends_with'
+          relation.where(relation.arel_table[name].matches("%#{query_value}"))
+        else
+          raise NotImplementedError, query_operator
+        end
+      end
+    end
+  end
+end

data/lib/admin_core/resource_filter_builder.rb

@@ -0,0 +1,37 @@
+module AdminCore
+  # @!attribute name
+  #   @return [Symbol]
+  # @!attribute type
+  #   @return [Symbol]
+  # @!attribute options
+  #   @return [Symbol]
+  ResourceFilterBuilder = Struct.new(:name, :type, :options) do
+    # @param resource_manager [AdminCore::BaseResourceManager]
+    # @param params [ActionController::Parameters]
+    # @return [AdminCore::ResourceFilter::Base]
+    def build(resource_manager, params)
+      query_operator, query_value = parse(params)
+      resource_filter_class.new(resource_manager, name, options, query_operator, query_value)
+    end
+
+    private
+
+    # @return [Class]
+    def resource_filter_class
+      @resource_filter_class ||= "AdminCore::ResourceFilter::#{type.to_s.camelize}".constantize
+    end
+
+    def regexp
+      @regexp = /\A#{name}(?::(\w+))?\z/
+    end
+
+    def parse(params)
+      params.keys.each do |key|
+        if (match = regexp.match(key))
+          return [match[1] || resource_filter_class.default_query_operator, params[key]]
+        end
+      end
+      []
+    end
+  end
+end