admin_core 0.0.1

data/lib/admin_core/resource_manager/buildable.rb

@@ -0,0 +1,42 @@
+module AdminCore
+  module ResourceManager
+    module Buildable
+      extend ActiveSupport::Concern
+
+      # @!method self.resource_class
+      #   @return [Class]
+      # @!method self.resource_name
+      #   @return [String]
+      # @!method self.resource_display_name
+      #   @return [String]
+      class_methods do
+        def resource_class
+          @model ||= "::#{name.demodulize}".constantize
+        end
+
+        def resource_name
+          resource_class.model_name.singular
+        end
+
+        def resource_display_name
+          resource_class.model_name.human
+        end
+
+        private
+
+        attr_writer :model
+      end
+
+      # @param params [ActionController::Parameters]
+      # @return [ActiveRecord::Base]
+      def build(params)
+        self.class.resource_class.new(params)
+      end
+
+      # @return [String]
+      def name
+        self.class.resource_class.model_name.singular
+      end
+    end
+  end
+end

data/lib/admin_core/resource_manager/convert.rb

@@ -0,0 +1,95 @@
+require 'admin_core/resource_router'
+
+module AdminCore
+  module ResourceManager
+    module Convert
+      extend ActiveSupport::Concern
+
+      # @!method self.to_hash
+      #   Implementation for ResourceManager type in flow.
+      #   @see client/javascripts/src/decls.js
+      #   @return [Hash]
+      # @!method self.param_name
+      #   @return [Symbol]
+      # @!method self.router
+      #   @return [AdminCore::ResourceRouter]
+      class_methods do
+        def to_hash
+          {
+            displayName: resource_display_name,
+            indexPath: router.index_path,
+            newPath: creatable? ? router.new_path : nil,
+            showPath: router.show_path(":#{param_name}"),
+            editPath: updatable? ? router.edit_path(":#{param_name}") : nil,
+          }
+        end
+
+        def param_name
+          :id
+        end
+
+        def router
+          @router ||= AdminCore::ResourceRouter.new(self)
+        end
+      end
+
+      # @!method convert_for_index_page(resource)
+      #   @param resource [ActiveRecord::Base]
+      #   @return [Hash] Resource representation for ResourcePage$Index type
+      # @!method convert_for_new_page(resource)
+      #   @param resource [ActiveRecord::Base]
+      #   @return [Hash] Resource representation for ResourcePage$New type
+      # @!method convert_for_show_page(resource)
+      #   @param resource [ActiveRecord::Base]
+      #   @return [Hash] Resource representation for ResourcePage$Show type
+      # @!method convert_for_edit_page(resource)
+      #   @param resource [ActiveRecord::Base]
+      #   @return [Hash] Resource representation for ResourcePage$Edit type
+      %i[index new show edit].each do |page|
+        define_method "convert_for_#{page}_page" do |resource|
+          convert(resource, field_builders_for(page), page)
+        end
+      end
+
+      # @return [Array<String>]
+      def human_attribute_names_for_index
+        self.class.field_names_for(:index).map do |name|
+          self.class.resource_class.human_attribute_name(name)
+        end
+      end
+
+      private
+
+      # Implementation for Resource type in flow.
+      # @see client/javascripts/src/qiita-admin/admin-core/decls.js
+      # @param resource [ActiveRecord::Base]
+      # @param field_builders [Array<AdminCore::ResourceFieldBuilder>]
+      # @param page [Symbol]
+      # @return [Hash]
+      def convert(resource, field_builders, page)
+        {
+          displayName: display_resource(resource),
+          name: name,
+          showPath: show_path_for(resource),
+          editPath: edit_path_for(resource),
+          destroyable: self.class.destroyable?,
+          fields: build_fields(resource, field_builders, page),
+        }
+      end
+
+      def show_path_for(resource)
+        resource.persisted? ? self.class.router.show_path(resource) : nil
+      end
+
+      def edit_path_for(resource)
+        resource.persisted? && self.class.updatable? ? self.class.router.edit_path(resource) : nil
+      end
+
+      def build_fields(resource, field_builders, page)
+        field_builders.map do |field_builder|
+          field_builder.build(resource, page).to_hash
+        end
+      end
+    end
+  end
+end

data/lib/admin_core/resource_manager/has_many_fields.rb

@@ -0,0 +1,71 @@
+require 'admin_core/resource_field_builder'
+
+module AdminCore
+  module ResourceManager
+    module HasManyFields
+      extend ActiveSupport::Concern
+
+      # @!method self.field_builders
+      #   @return [Hash<Symbol, AdminCore::ResourceFieldBuilder>]
+      # @!method self.field_names_for(page)
+      #   @param page [Symbol]
+      #   @return [Array<Symbol>]
+      class_methods do
+        def field_builders
+          @field_builders ||= {}
+        end
+
+        def field_names_for(page)
+          @page_fields ||= {}
+          @page_fields[page] || []
+        end
+
+        private
+
+        # @param name [Symbol]
+        # @param type [Symbol, Class] built-in type name or a resoure field class
+        # @param options [Hash]
+        def define_field(name, type, options = {})
+          field_builders[name] = AdminCore::ResourceFieldBuilder.new(name, type, options)
+        end
+
+        # @param pages [Array<Symbol>]
+        # @param fields [Array<Symbol>]
+        def register_fields_for(*pages, fields)
+          @page_fields ||= {}
+          pages.each do |page|
+            @page_fields[page] = fields
+          end
+        end
+      end
+
+      # @param page [Symbol]
+      # @return [Array<Symbol>]
+      def permitted_field_names_for(page)
+        field_builders_for(page).map(&:permitted_field_name)
+      end
+
+      # @param params [ActionController::Parameters]
+      # @return [Array<AdminCore::ResourceFilter::Base>]
+      def build_filters(params)
+        self.class.filter_builders.map do |filter_builder|
+          filter_builder.build(self, params[:filter] || {})
+        end
+      end
+
+      private # rubocop:disable Lint/UselessAccessModifier
+
+      # @param page [Symbol]
+      # @return [Array<AdminCore::ResourceFieldBuilder>]
+      def field_builders_for(page)
+        self.class.field_names_for(page).map(&method(:field_builder_for))
+      end
+
+      # @param name [Symbol]
+      # @return [AdminCore::ResourceFieldBuilder]
+      def field_builder_for(name)
+        self.class.field_builders[name]
+      end
+    end
+  end
+end

data/lib/admin_core/resource_manager/permission.rb

@@ -0,0 +1,35 @@
+module AdminCore
+  module ResourceManager
+    module Permission
+      extend ActiveSupport::Concern
+
+      # @!method self.creatable?
+      #   @return [Boolean]
+      # @!method self.updatable?
+      #   @return [Boolean]
+      # @!method self.destroyable?
+      #   @return [Boolean]
+      class_methods do
+        def creatable?
+          field_names_for(:new).present?
+        end
+
+        # @return [Boolean]
+        def updatable?
+          field_names_for(:edit).present?
+        end
+
+        # @return [Boolean]
+        def destroyable?
+          instance_variable_defined?(:@destroyable) ? @destroyable : true
+        end
+
+        private
+
+        def destroyable(value)
+          @destroyable = value
+        end
+      end
+    end
+  end
+end

data/lib/admin_core/resource_manager/searchable.rb

@@ -0,0 +1,57 @@
+require 'admin_core/resource_filter_builder'
+require 'admin_core/resource_search'
+
+module AdminCore
+  module ResourceManager
+    module Searchable
+      extend ActiveSupport::Concern
+
+      # @!method self.filter_builders
+      #   @return [Array<AdminCore::ResourceFieldBuilder>]
+      # @!method self.scopes
+      #   @return [Array<Symbol>]
+      class_methods do
+        def filter_builders
+          @filter_builders ||= []
+        end
+
+        def scopes
+          @scopes || []
+        end
+
+        private
+
+        # @param values [Array<Symbol>]
+        def register_scopes(values)
+          @scopes = values
+        end
+
+        # @param name [Symbol]
+        # @param type [Symbol]
+        # @param options [Hash]
+        def define_and_register_filter(name, type, options = {})
+          filter_builders.push(AdminCore::ResourceFilterBuilder.new(name, type, options))
+        end
+      end
+
+      # @!method search
+      #   Delegate to {AdminCore::ResourceSearch#search}
+      included do
+        delegate :search, to: :resource_search
+      end
+
+      # @param params [ActionController::Parameters]
+      # @return [ActiveRecord::Base]
+      def find(params)
+        self.class.resource_class.find_by(self.class.param_name => params[self.class.param_name])
+      end
+
+      private # rubocop:disable Lint/UselessAccessModifier
+
+      # @return [AdminCore::ResourceSearch]
+      def resource_search
+        AdminCore::ResourceSearch.new(self)
+      end
+    end
+  end
+end

data/lib/admin_core/resource_page/base.rb

@@ -0,0 +1,17 @@
+module AdminCore
+  module ResourcePage
+    # @abstract
+    class Base
+      # @param resource_manager [AdminCore::BaseResourceManager]
+      # @param params [ActionController::Parameters]
+      def initialize(resource_manager, params)
+        @resource_manager = resource_manager
+        @params = params
+      end
+
+      private
+
+      attr_reader :resource_manager, :params
+    end
+  end
+end

data/lib/admin_core/resource_page/edit.rb

@@ -0,0 +1,22 @@
+require_relative 'base'
+
+module AdminCore
+  module ResourcePage
+    class Edit < Base
+      # Implementation for ResourcePage$New type.
+      # @see client/javascripts/src/qiita-admin/admin-core/decls.js
+      def to_hash
+        {
+          resource: resource_manager.convert_for_edit_page(resource)
+        }
+      end
+
+      private
+
+      # @return [ActiveRecord::Base]
+      def resource
+        @resource ||= resource_manager.find(params)
+      end
+    end
+  end
+end

data/lib/admin_core/resource_page/index.rb

@@ -0,0 +1,52 @@
+require_relative 'base'
+
+module AdminCore
+  module ResourcePage
+    class Index < Base
+      # Implementation for ResourcePage$Index type.
+      # @see client/javascripts/src/qiita-admin/admin-core/decls.js
+      def to_hash
+        {
+          attributes: attributes,
+          resources: resources.map { |resource| resource_manager.convert_for_index_page(resource) },
+          filters: filters,
+          scopes: scopes,
+          pagination: {
+            current: resources.current_page,
+            total: resources.total_pages,
+          },
+        }
+      end
+
+      private
+
+      def attributes
+        resource_manager.human_attribute_names_for_index
+      end
+
+      def scopes
+        resource_manager.class.scopes.map do |scope|
+          { name: scope, count: searched_resources.public_send(scope).count }
+        end
+      end
+
+      def searched_resources
+        @searched_resources ||= resource_manager.search(filters)
+      end
+
+      def resources
+        @resources ||= searched_resources.public_send(scope).page(params[:page])
+      end
+
+      # @return [Array<AdminCore::ResourceFilter::Base>]
+      def filters
+        @filters ||= resource_manager.build_filters(params)
+      end
+
+      # @return [Symbol]
+      def scope
+        params[:scope] || :all
+      end
+    end
+  end
+end

data/lib/admin_core/resource_page/new.rb

@@ -0,0 +1,26 @@
+require_relative 'base'
+
+module AdminCore
+  module ResourcePage
+    class New < Base
+      # Implementation for ResourcePage$New type.
+      # @see client/javascripts/src/qiita-admin/admin-core/decls.js
+      def to_hash
+        {
+          resource: resource_manager.convert_for_new_page(resource)
+        }
+      end
+
+      private
+
+      # @return [ActiveRecord::Base]
+      def resource
+        @resource ||= resource_manager.build(permitted_params)
+      end
+
+      def permitted_params
+        params[resource_manager.name].try(:permit, resource_manager.permitted_field_names_for(:new))
+      end
+    end
+  end
+end

data/lib/admin_core/resource_page/show.rb

@@ -0,0 +1,22 @@
+require_relative 'base'
+
+module AdminCore
+  module ResourcePage
+    class Show < Base
+      # Implementation for ResourcePage$Show type.
+      # @see client/javascripts/src/qiita-admin/admin-core/decls.js
+      def to_hash
+        {
+          resource: resource_manager.convert_for_show_page(resource)
+        }
+      end
+
+      private
+
+      # @return [ActiveRecord::Base]
+      def resource
+        @resource ||= resource_manager.find(params)
+      end
+    end
+  end
+end

data/lib/admin_core/resource_router.rb

@@ -0,0 +1,58 @@
+require 'admin_core'
+
+module AdminCore
+  class ResourceRouter
+    def self.url_helpers
+      @url_helpers ||= Rails.application.routes.url_helpers
+    end
+
+    # @param resource_manager_class [Class]
+    def initialize(resource_manager_class)
+      @resource_manager_class = resource_manager_class
+    end
+
+    # @return [String]
+    def index_path
+      url_for(controller: controller, action: 'index', only_path: true)
+    end
+
+    # @return [String]
+    def new_path
+      url_for(controller: controller, action: 'new', only_path: true)
+    end
+
+    # @param param [String, ActiveRecord::Base]
+    # @return [String]
+    def show_path(param)
+      url_for(controller: controller, action: 'show', id: strip(param), only_path: true)
+    end
+
+    # @param param [String]
+    # @return [String]
+    def edit_path(param)
+      url_for(controller: controller, action: 'edit', id: strip(param), only_path: true)
+    end
+
+    private
+
+    attr_reader :resource_manager_class
+
+    delegate :resource_class, to: :resource_manager_class
+    delegate :url_for, to: :url_helpers
+
+    def controller
+      "#{AdminCore.config.route_name_prefix}/#{resource_class.model_name.plural}"
+    end
+
+    def url_helpers
+      self.class.url_helpers
+    end
+
+    # @param param [String, ActiveRecord::Base]
+    # @return [String]
+    def strip(param)
+      return param.public_send(resource_manager_class.param_name) if param.is_a?(ActiveRecord::Base)
+      param
+    end
+  end
+end

data/lib/admin_core/resource_search.rb

@@ -0,0 +1,22 @@
+module AdminCore
+  class ResourceSearch
+    # @param resource_manager
+    def initialize(resource_manager)
+      @resource_manager = resource_manager
+    end
+
+    # @param filters [Array<AdminCore::ResourceFilter::Base>]
+    # @return [ActiveRecord::Relation] resources for index page.
+    def search(filters)
+      resources = resource_manager.class.resource_class.all
+      filters.reject(&:empty?).each do |filter|
+        resources = filter.apply(resources)
+      end
+      resources
+    end
+
+    private
+
+    attr_reader :resource_manager
+  end
+end

data/lib/admin_core/rspec/matchers.rb

@@ -0,0 +1,18 @@
+module AdminCore
+  module RSpec
+    module Matchers
+      extend RSpec::Matchers::DSL
+
+      matcher :have_shape_of_ResourceField do |type_value: nil, value_type: nil|
+        match do |actual|
+          expect(actual).to match(
+            'displayName' => be_a(String),
+            'name' => be_a(String),
+            'type' => type_value ? type_value : be_a(String),
+            'value' => be_a(value_type ? value_type : Object)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/admin_core/rspec/resource_field_spec_helper.rb

@@ -0,0 +1,54 @@
+require_relative 'matchers'
+
+module AdminCore
+  module RSpec
+    module ResourceFieldSpecHelper
+      extend ActiveSupport::Concern
+      include AdminCore::RSpec::Matchers
+
+      included do
+        shared_context 'with resource field instance' do |create_resource:, name:, options:, page:|
+          let(:resource_field) do
+            described_class.new(create_resource.call, name, options, page)
+          end
+        end
+
+        shared_examples_for 'AdminCore::ResourceField' do |create_resource:, name:, options: {}|
+          describe '.type' do
+            subject do
+              described_class.type
+            end
+
+            it { should be_a Symbol }
+          end
+
+          describe '.permitted_field_name_of' do
+            subject do
+              described_class.permitted_field_name_of(name)
+            end
+
+            it { should be_a String }
+          end
+
+          describe '#to_hash' do
+            %i[index new show edit].each do |page|
+              context "when page is #{page}" do
+                include_context 'with resource field instance',
+                                create_resource: create_resource,
+                                name: name,
+                                options: options,
+                                page: page
+
+                subject do
+                  resource_field.to_hash.as_json
+                end
+
+                it { should have_shape_of_ResourceField }
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/admin_core/version.rb

@@ -0,0 +1,11 @@
+module AdminCore
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 1
+
+    def self.to_s
+      [MAJOR, MINOR, PATCH].join('.')
+    end
+  end
+end

data/lib/admin_core/view_object/sidebar_dropdown.rb

@@ -0,0 +1,21 @@
+module AdminCore
+  module ViewObject
+    class SidebarDropdown
+      # @param name [String]
+      # @param links [Array<SidebarLink, SidebarResourceLink>]
+      def initialize(name, links)
+        @name = name
+        @links = links
+      end
+
+      # @note Implements SidebarDropdown flow type
+      def to_hash
+        {
+          displayName: @name,
+          links: @links,
+          type: 'dropdown'
+        }
+      end
+    end
+  end
+end

data/lib/admin_core/view_object/sidebar_link.rb

@@ -0,0 +1,24 @@
+module AdminCore
+  module ViewObject
+    class SidebarLink
+      # @param name [String]
+      # @param link [String]
+      # @param external [Boolean]
+      def initialize(name, link, external = false)
+        @name = name
+        @link = link
+        @external = external
+      end
+
+      # @note Implements SidebarLink flow type
+      def to_hash
+        {
+          displayName: @name,
+          link: @link,
+          external: @link =~ %r{://} || @external,
+          type: 'link'
+        }
+      end
+    end
+  end
+end

data/lib/admin_core/view_object/sidebar_resource_link.rb

@@ -0,0 +1,23 @@
+module AdminCore
+  module ViewObject
+    class SidebarResourceLink
+      # @param resource_manager [AdminCore::BaseResourceManager]
+      def initialize(resource_manager)
+        @resource_manager = resource_manager
+      end
+
+      def to_hash
+        {
+          displayName: resource_manager_hash[:displayName],
+          link: resource_manager_hash[:indexPath],
+          external: false,
+          type: 'link'
+        }
+      end
+
+      def resource_manager_hash
+        @resource_manager_hash ||= @resource_manager.to_hash
+      end
+    end
+  end
+end