archangel 0.0.2

data/app/controllers/archangel/backend/widgets_controller.rb

@@ -0,0 +1,264 @@
+# frozen_string_literal: true
+
+module Archangel
+  ##
+  # @see Archangel::BackendController
+  #
+  module Backend
+    ##
+    # Backend widgets controller
+    #
+    class WidgetsController < BackendController
+      before_action :set_resources, only: %i[index]
+      before_action :set_resource, only: %i[destroy edit show update]
+      before_action :set_new_resource, only: %i[create new]
+
+      ##
+      # Backend widgets
+      #
+      # Formats
+      #   HTML, JSON
+      #
+      # Request
+      #   GET /backend/widgets
+      #   GET /backend/widgets.json
+      #
+      # Response
+      #   [
+      #     {
+      #       "id": 123,
+      #       "site_id": 123,
+      #       "name": "Widget 1 Name",
+      #       "slug": "widget_1_slug",
+      #       "content": "</p>Content of Widget 1</p>",
+      #       "template_id": 123,
+      #       "deleted_at": null,
+      #       "created_at": "YYYY-MM-DDTHH:MM:SS.MSZ",
+      #       "updated_at": "YYYY-MM-DDTHH:MM:SS.MSZ"
+      #     },
+      #     ...
+      #   ]
+      #
+      def index
+        respond_with @widgets
+      end
+
+      ##
+      # Backend widget
+      #
+      # Formats
+      #   HTML, JSON
+      #
+      # Params
+      #   [String] slug - the widget slug
+      #
+      # Request
+      #   GET /backend/widgets/:slug
+      #   GET /backend/widgets/:slug.json
+      #
+      # Response
+      #   {
+      #     "id": 123,
+      #     "site_id": 123,
+      #     "name": "Widget Name",
+      #     "slug": "widget_slug",
+      #     "content": "</p>Content of the Widget</p>",
+      #     "template_id": 123,
+      #     "deleted_at": null,
+      #     "created_at": "YYYY-MM-DDTHH:MM:SS.MSZ",
+      #     "updated_at": "YYYY-MM-DDTHH:MM:SS.MSZ"
+      #   }
+      #
+      def show
+        respond_with @widget
+      end
+
+      ##
+      # New backend widget
+      #
+      # Formats
+      #   HTML, JSON
+      #
+      # Request
+      #   GET /backend/widgets/new
+      #   GET /backend/widgets/new.json
+      #
+      # Response
+      #   {
+      #     "id": null,
+      #     "site_id": 123,
+      #     "name": null,
+      #     "slug": null,
+      #     "content": null,
+      #     "template_id": null,
+      #     "deleted_at": null,
+      #     "created_at": null,
+      #     "updated_at": null
+      #   }
+      #
+      def new
+        respond_with @widget
+      end
+
+      ##
+      # Create backend widget
+      #
+      # Formats
+      #   HTML, JSON
+      #
+      # Request
+      #   POST /backend/widgets
+      #   POST /backend/widgets.json
+      #
+      # Paramaters
+      #   {
+      #     "widget": {
+      #       "name": "Widget Name",
+      #       "slug": "widget_slug",
+      #       "content": "</p>Content of the Widget</p>",
+      #       "template_id": 123
+      #     }
+      #   }
+      #
+      def create
+        @widget.save
+
+        respond_with @widget, location: -> { location_after_create }
+      end
+
+      ##
+      # Edit backend widget
+      #
+      # Formats
+      #   HTML, JSON
+      #
+      # Params
+      #   [String] slug - the widget slug
+      #
+      # Request
+      #   GET /backend/widgets/:slug/edit
+      #   GET /backend/widgets/:slug/edit.json
+      #
+      # Response
+      #   {
+      #     "id": 123,
+      #     "site_id": 123,
+      #     "name": "Widget Name",
+      #     "slug": "widget_slug",
+      #     "content": "</p>Content of the Widget</p>",
+      #     "template_id": 123,
+      #     "deleted_at": null,
+      #     "created_at": "YYYY-MM-DDTHH:MM:SS.MSZ",
+      #     "updated_at": "YYYY-MM-DDTHH:MM:SS.MSZ"
+      #   }
+      #
+      def edit
+        respond_with @widget
+      end
+
+      ##
+      # Update backend widget
+      #
+      # Formats
+      #   HTML, JSON
+      #
+      # Params
+      #   [String] slug - the widget slug
+      #
+      # Request
+      #   PATCH /backend/widgets/:slug
+      #   PATCH /backend/widgets/:slug.json
+      #   PUT   /backend/widgets/:slug
+      #   PUT   /backend/widgets/:slug.json
+      #
+      # Paramaters
+      #   {
+      #     "widget": {
+      #       "name": "Widget Name",
+      #       "slug": "widget_slug",
+      #       "content": "</p>Content of the Widget</p>",
+      #       "template_id": 123
+      #     }
+      #   }
+      #
+      def update
+        @widget.update(resource_params)
+
+        respond_with @widget, location: -> { location_after_update }
+      end
+
+      ##
+      # Destroy backend widget
+      #
+      # Formats
+      #   HTML, JSON
+      #
+      # Params
+      #   [String] slug - the widget slug
+      #
+      # Request
+      #   DELETE /backend/widgets/:slug
+      #   DELETE /backend/widgets/:slug.json
+      #
+      def destroy
+        @widget.destroy
+
+        respond_with @widget, location: -> { location_after_destroy }
+      end
+
+      protected
+
+      def permitted_attributes
+        %w[content name slug template_id]
+      end
+
+      def set_resources
+        @widgets = current_site.widgets
+                               .order(name: :asc)
+                               .page(page_num).per(per_page)
+
+        authorize @widgets
+      end
+
+      def set_resource
+        resource_id = params.fetch(:id)
+
+        @widget = current_site.widgets.find_by!(slug: resource_id)
+
+        authorize @widget
+      end
+
+      def set_new_resource
+        new_params = action_name.to_sym == :create ? resource_params : nil
+
+        @widget = current_site.widgets.new(new_params)
+
+        authorize @widget
+      end
+
+      def resource_params
+        params.require(resource_namespace).permit(permitted_attributes)
+      end
+
+      def resource_namespace
+        controller_name.singularize.to_sym
+      end
+
+      def location_after_create
+        location_after_save
+      end
+
+      def location_after_update
+        location_after_save
+      end
+
+      def location_after_destroy
+        location_after_save
+      end
+
+      def location_after_save
+        backend_widgets_path
+      end
+    end
+  end
+end

data/app/controllers/archangel/backend_controller.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Archangel
+  ##
+  # Backend base controller
+  #
+  class BackendController < ApplicationController
+    include Pundit
+
+    include Archangel::AuthenticatableConcern
+    include Archangel::AuthorizableConcern
+
+    rescue_from Pundit::NotAuthorizedError, with: :render_401_error
+
+    protected
+
+    def layout_from_theme
+      "backend"
+    end
+  end
+end

data/app/controllers/archangel/frontend/pages_controller.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+module Archangel
+  ##
+  # @see Archangel::FrontendController
+  #
+  module Frontend
+    ##
+    # Frontend pages controller
+    #
+    class PagesController < FrontendController
+      before_action :set_resource, only: %i[show]
+      before_action :assign_meta_tags, if: -> { request.get? },
+                                       unless: -> { request.xhr? }
+
+      ##
+      # Frontend page
+      #
+      # Formats
+      #   HTML, JSON
+      #
+      # Params
+      #   [String] path - the path to the page
+      #
+      # Request
+      #   GET /:path
+      #   GET /:path.json
+      #
+      # Response
+      #   {
+      #     "id": 123,
+      #     "title": "Page Title",
+      #     "path": "path/to/page",
+      #     "content": "</p>Content of the page</p>",
+      #     "homepage": false,
+      #     "meta_keywords": "keywords, for, the, page",
+      #     "meta_description": "Description of the page",
+      #     "published_at": "YYYY-MM-DDTHH:MM:SS.MSZ",
+      #     "created_at": "YYYY-MM-DDTHH:MM:SS.MSZ",
+      #     "updated_at": "YYYY-MM-DDTHH:MM:SS.MSZ",
+      #   }
+      #
+      def show
+        return redirect_to_homepage if redirect_to_homepage?
+
+        respond_to do |format|
+          format.html do
+            render inline: liquid_rendered_template_content,
+                   layout: layout_from_theme
+          end
+          format.json do
+            @page.content = liquid_rendered_content
+
+            render json: @page, layout: false
+          end
+        end
+      end
+
+      protected
+
+      ##
+      # Find and assign resource to the view
+      #
+      def set_resource
+        page_path = params.fetch(:path, nil)
+
+        @page = page_path.blank? ? find_homepage : find_page(page_path)
+      end
+
+      ##
+      # Assign meta tags to view
+      #
+      def assign_meta_tags
+        apply_meta_tags(page_meta_tags)
+      end
+
+      ##
+      # Meta tags for the page
+      #
+      # @return [Object] the page meta tags
+      #
+      def page_meta_tags
+        {
+          title: @page.title,
+          description: @page.meta_description,
+          keywords: @page.meta_keywords.to_s.split(",")
+        }
+      end
+
+      ##
+      # Check to redirect to homepage root path
+      #
+      # @return [Boolean] redirect or not
+      #
+      def redirect_to_homepage?
+        return false unless @page
+
+        (params.fetch(:path, nil) == @page.path) && @page.homepage?
+      end
+
+      ##
+      # Redirect to homepage root path is page is marked as the homepage
+      #
+      def redirect_to_homepage
+        redirect_to root_path, status: :moved_permanently
+      end
+
+      ##
+      # Find the homepage
+      #
+      # @return [Object] the homepage
+      #
+      def find_homepage
+        current_site.pages.published.homepage.first!
+      end
+
+      ##
+      # Find the requested page
+      #
+      # @return [Object] the page
+      #
+      def find_page(path)
+        current_site.pages.published.find_by!(path: path)
+      end
+
+      ##
+      # Render content
+      #
+      # @return [String] the rendered Liquid content
+      #
+      def liquid_rendered_content
+        variables = default_liquid_assign
+
+        Archangel::RenderService.call(@page.content, variables)
+      end
+
+      ##
+      # Render content with template
+      #
+      # @return [String] the rendered Liquid template
+      #
+      def liquid_rendered_template_content
+        content = liquid_rendered_content
+        variables = default_liquid_assign.merge(content_for_layout: content)
+
+        Archangel::TemplateRenderService.call(@page.template, variables)
+      end
+
+      def default_liquid_assign
+        {
+          current_page: request.fullpath,
+          page: @page.to_liquid,
+          site: current_site.to_liquid
+        }
+      end
+    end
+  end
+end

data/app/controllers/archangel/frontend_controller.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Archangel
+  ##
+  # Frontend base controller
+  #
+  class FrontendController < ApplicationController
+    include Archangel::SeoableConcern
+  end
+end

data/app/controllers/concerns/archangel/actionable_concern.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+module Archangel
+  ##
+  # Controller action concern
+  #
+  module ActionableConcern
+    extend ActiveSupport::Concern
+
+    included do
+      helper_method :action,
+                    :action?,
+                    :collection_action?,
+                    :edit_action?,
+                    :index_action?,
+                    :member_action?,
+                    :new_action?,
+                    :restful_action?,
+                    :save_action?,
+                    :show_action?
+    end
+
+    # Controller action name as a symbol
+    #
+    # @return [Symbol] the action name
+    def action
+      action_name.to_sym
+    end
+
+    # Test if action is a collection action
+    #
+    # Actions include [:index]
+    #
+    # Collection actions can be modified by overwriting `#collection_actions`
+    #
+    # @return [Boolean] if action is a collection action
+    def collection_action?
+      collection_actions.include?(action)
+    end
+
+    # Test if action is an edit action
+    #
+    # Actions include [:edit, :update]
+    #
+    # Edit actions can be modified by overwriting `#edit_actions`
+    #
+    # @return [Boolean] if action is an edit action
+    def edit_action?
+      edit_actions.include?(action)
+    end
+
+    # Test if action is the `index` action
+    #
+    # @return [Boolean] if action is the index action
+    def index_action?
+      action?(:index)
+    end
+
+    # Test if action is a member action
+    #
+    # Actions include [:show, :edit, :update, :destroy]
+    #
+    # Member actions can be modified by overwriting `#member_actions`
+    #
+    # @return [Boolean] if action is an edit action
+    def member_action?
+      member_actions.include?(action)
+    end
+
+    # Test if action is a new action
+    #
+    # Actions include [:create, :new]
+    #
+    # New actions can be modified by overwriting `#new_actions`
+    #
+    # @return [Boolean] if action is an edit action
+    def new_action?
+      new_actions.include?(action)
+    end
+
+    # Test if action is a RESTful action
+    #
+    # Actions include [:index, :show, :new, :create, :edit, :update, :destroy]
+    #
+    # RESTful actions can be modified by overwriting `#restful_actions`
+    #
+    # @return [Boolean] if action is an edit action
+    def restful_action?
+      restful_actions.include?(action)
+    end
+
+    # Test if action is a save action
+    #
+    # Actions include [:create, :update, :destroy]
+    #
+    # Save actions can be modified by overwriting `#save_actions`
+    #
+    # @return [Boolean] if action is an edit action
+    def save_action?
+      save_actions.include?(action)
+    end
+
+    # Test if action is a show action
+    #
+    # Actions include [:show]
+    #
+    # Show actions can be modified by overwriting `#show_actions`
+    #
+    # @return [Boolean] if action is a show action
+    def show_action?
+      show_actions.include?(action)
+    end
+
+    protected
+
+    def action?(action_method)
+      action == action_method.to_sym
+    end
+
+    def collection_actions
+      %i[index]
+    end
+
+    def destroy_actions
+      %i[destroy]
+    end
+
+    def edit_actions
+      %i[edit update]
+    end
+
+    def member_actions
+      edit_actions + show_actions + destroy_actions
+    end
+
+    def new_actions
+      %i[create new]
+    end
+
+    def restful_actions
+      %i[create destroy edit index new show update]
+    end
+
+    def save_actions
+      %i[create destroy update]
+    end
+
+    def show_actions
+      %i[show]
+    end
+  end
+end

data/app/controllers/concerns/archangel/authenticatable_concern.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Archangel
+  ##
+  # Controller authenticate concern
+  #
+  module AuthenticatableConcern
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :authenticate_user!
+    end
+  end
+end

data/app/controllers/concerns/archangel/authorizable_concern.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Archangel
+  ##
+  # Controller authorize concern
+  #
+  module AuthorizableConcern
+    extend ActiveSupport::Concern
+
+    included do
+      after_action :verify_authorized
+    end
+  end
+end

data/app/controllers/concerns/archangel/paginatable_concern.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Archangel
+  ##
+  # Controller pagination concern
+  #
+  module PaginatableConcern
+    extend ActiveSupport::Concern
+
+    included do
+      helper_method :page_num, :per_page
+    end
+
+    # Record limt count
+    #
+    # @return [Integer] the record count limit
+    def per_page
+      params.fetch(:per, per_page_default).to_i
+    end
+
+    # Current page number
+    #
+    # @return [Integer] the page number
+    def page_num
+      params.fetch(Kaminari.config.param_name, 1).to_i
+    end
+
+    protected
+
+    def per_page_default
+      Kaminari.config.default_per_page
+    end
+  end
+end

data/app/controllers/concerns/archangel/seoable_concern.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Archangel
+  ##
+  # Controller SEO concern
+  #
+  module SeoableConcern
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :apply_default_meta_tags, if: -> { request.get? },
+                                              unless: -> { request.xhr? }
+    end
+
+    # Set meta tags
+    #
+    # @param meta_tags [Hash] list of meta tags
+    def apply_meta_tags(meta_tags = {})
+      set_meta_tags(meta_tags.reject { |_name, value| value.blank? })
+    end
+
+    protected
+
+    def apply_default_meta_tags
+      apply_meta_tags default_meta_tags
+    end
+
+    def default_meta_tags
+      {
+        reverse:     true,
+        site:        current_site.name,
+        canonical:   request.url,
+        image_src:   current_site.logo.url,
+        description: current_site.meta_description,
+        keywords:    current_site.meta_keywords.to_s.split(","),
+        icon:        current_site.favicon.url
+      }
+    end
+  end
+end