hancock_cms_faq 1.0.2

data/lib/hancock/faq/configuration.rb

@@ -0,0 +1,53 @@
+module Hancock::Faq
+  include Hancock::PluginConfiguration
+
+  def self.config_class
+    Configuration
+  end
+
+  class Configuration
+    attr_accessor :author_name_required
+
+    attr_accessor :default_answer_author_name
+
+    attr_accessor :captcha
+    attr_accessor :captcha_error_message
+
+    attr_accessor :recaptcha_support
+    attr_accessor :simple_captcha_support
+
+    attr_accessor :seo_support
+    attr_accessor :cache_support
+
+    attr_accessor :breadcrumbs_on_rails_support
+
+    attr_accessor :localize
+
+    attr_accessor :model_settings_support
+    attr_accessor :user_abilities_support
+    attr_accessor :ra_comments_support
+
+    def initialize
+      @author_name_required = true
+
+      @default_answer_author_name  = "Администрация сайта"
+
+      @captcha_error_message = "Код с картинки введен неверно"
+
+      @recaptcha_support = !!defined?(Recaptcha)
+      @simple_captcha_support = !!defined?(SimpleCaptcha)
+      @captcha = @recaptcha_support || @simple_captcha_support
+
+      @seo_support = !!defined?(Hancock::Seo)
+      @cache_support  = !!defined?(Hancock::Cache)
+
+      @breadcrumbs_on_rails_support = !!defined?(BreadcrumbsOnRails)
+
+      @localize = Hancock.config.localize
+
+      @model_settings_support = !!defined?(RailsAdminModelSettings)
+      @user_abilities_support = !!defined?(RailsAdminUserAbilities)
+      @ra_comments_support = !!defined?(RailsAdminComments)
+    end
+  end
+end

data/lib/hancock/faq/controllers/categories.rb

@@ -0,0 +1,88 @@
+module Hancock::Faq
+  module Controllers
+    module Categories
+      extend ActiveSupport::Concern
+
+      included do
+
+        def index
+          @categories = category_class.enabled.sorted.page(params[:page]).per(per_page)
+          @root_categories = category_class.enabled.roots.sorted.all
+          # index_crumbs
+        end
+
+        def show
+          @category = category_class.enabled.find(params[:id])
+          if !@category.text_slug.blank? and @category.text_slug != params[:id]
+            redirect_to hancock_faq_category_path(@category), status_code: 301
+            return
+          end
+          @seo_parent_page = find_seo_page(hancock_faq_categories_path)
+
+          @children = @category.children.enabled.sorted.all
+          @questions = @category.questions.enabled.sorted.all.page(params[:page]).per(questions_per_page)
+
+          # index_crumbs
+          # category_crumbs
+        end
+
+        def page_title
+          if @category
+            @category.page_title
+          else
+            super
+          end
+        end
+
+        private
+        def category_class
+          Hancock::Faq::Category
+        end
+        def question_class
+          Hancock::Faq::Question
+        end
+
+        def per_page
+          10
+        end
+        def questions_per_page
+          10
+        end
+
+        # def index_crumbs
+        #   if @seo_parent_page
+        #     catalog_title   = Settings.ns('breadcrumbs').catalog_title(default: "Каталог", label: "'Каталог' в breadcrumbs")
+        #     _crumb = catalog_title
+        #     _crumb = @seo_parent_page.name if _crumb.blank?
+        #     _crumb = @seo_parent_page.title if _crumb.blank?
+        #     _crumb = @seo_parent_page.h1 if _crumb.blank?
+        #     add_crumb _crumb, @seo_parent_page.fullpath
+        #   else
+        #     catalog_title   = Settings.ns('breadcrumbs').catalog_title(default: "Каталог", label: "'Каталог' в breadcrumbs")
+        #     _crumb = catalog_title
+        #     add_crumb _crumb, item_categories_path
+        #   end
+        # end
+        #
+        # def category_crumbs
+        #   if @item_category
+        #     _parent = @item_category.parent
+        #     if _parent
+        #       _crumb = _parent.name if _crumb.blank?
+        #       _crumb = _parent.title if _crumb.blank?
+        #       _crumb = _parent.h1 if _crumb.blank?
+        #       add_crumb _crumb, item_category_path(_parent)
+        #       _crumb = nil
+        #     end
+        #     _crumb = @item_category.name if _crumb.blank?
+        #     _crumb = @item_category.title if _crumb.blank?
+        #     _crumb = @item_category.h1 if _crumb.blank?
+        #     add_crumb _crumb, item_category_path(@item_category)
+        #   end
+        # end
+
+      end
+
+    end
+  end
+end

data/lib/hancock/faq/controllers/questions.rb

@@ -0,0 +1,174 @@
+module Hancock::Faq
+  module Controllers
+    module Questions
+      extend ActiveSupport::Concern
+
+      included do
+
+        helper_method :hancock_faq_update_captcha_path
+
+        def index
+          if Hancock::Faq.config.breadcrumbs_on_rails_support
+            add_breadcrumb I18n.t('hancock.breadcrumbs.faq'), :hancock_faq_path
+          end
+
+          @questions = question_class.enabled.sorted.page(params[:page]).per(per_page)
+          # index_crumbs
+          after_initialize
+          render locals: locals unless xhr_checker
+        end
+
+        def show
+          if Hancock::Faq.config.breadcrumbs_on_rails_support
+            add_breadcrumb I18n.t('hancock.breadcrumbs.faq'), :hancock_faq_path
+          end
+
+          @question = question_class.enabled.find(params[:id])
+          if !@question.text_slug.blank? and @question.text_slug != params[:id]
+            redirect_to hancock_faq_question_path(@question), status_code: 301
+            return
+          end
+          @parent_seo_page = find_seo_page(hancock_faq_categories_path) if @seo_page.blank?
+          # item_crumbs
+        end
+
+        def page_title
+          if @question
+            @question.page_title
+          else
+            super
+          end
+        end
+
+        def create
+          @question = question_class.new(question_params)
+
+          if Hancock::Faq.config.captcha
+            if Hancock::Faq.config.recaptcha_support
+              if verify_recaptcha
+                meth = :save
+              else
+                meth = :valid?
+                @recaptcha_error = I18n.t('hancock.errors.faq.recaptcha')
+              end
+
+            elsif Hancock::Faq.config.simple_captcha_support
+              meth = :save_with_captcha
+
+            else
+              meth = :save
+            end
+          else
+            meth = :save
+          end
+
+          if @question.send(meth)
+            after_create
+            if request.xhr? && process_ajax
+              ajax_success
+            else
+              redirect_after_done
+            end
+          else
+            render_faq_error
+          end
+        end
+
+        def update_captcha
+          render layout: false
+        end
+
+        def hancock_faq_question_update_captcha_path
+          url_for(action: :update_captcha, time: Time.new.to_i, only_path: true)
+        end
+        def is_cache_fields
+          cache_fields?
+        end
+        def cache_fields?
+          ['new', 'index'].include? action_name
+        end
+        def cache_key
+          'hancock_faq_question_fields'.freeze
+        end
+        def fields_partial
+          "hancock/faq/questions/#{(Hancock::Faq.config.model_settings_support ? 'fields' : 'fields_with_settings')}".freeze
+        end
+        def settings_scope
+          if Hancock::Faq.config.model_settings_support
+            question_class.settings
+          elsif defined?(Settings)
+            Settings.ns('FAQ')
+          else
+            nil
+          end
+        end
+        def recaptcha_options
+          {}
+        end
+        def locals
+          {
+            is_cache_fields:    is_cache_fields,
+            cache_key:          cache_key,
+            fields_partial:     fields_partial,
+            settings_scope:     settings_scope,
+            recaptcha_options:  recaptcha_options
+          }
+        end
+
+        private
+        def render_faq_error
+          if request.xhr? && process_ajax
+            render partial: form_partial, status: 422
+            # render json: {errors: @contact_message.errors}, status: 422
+          else
+            flash.now[:alert] = @question.errors.full_messages.join("\n")
+            render action: Hancock::Faq.configuration.recreate_contact_message_action, status: 422
+          end
+        end
+        def process_ajax
+          true
+        end
+        def ajax_success
+          render partial: success_partial
+          # render json: {ok: true}
+        end
+        def redirect_after_done
+          redirect_to action: :sent
+        end
+        def xhr_checker
+          if request.xhr?
+            render layout: false, locals: locals
+            return true
+          end
+        end
+        def after_initialize
+        end
+        def after_create
+          # overrideable hook for updating message
+        end
+        def form_partial
+          "hancock/faq/questions/form"
+        end
+        def success_partial
+          "hancock/faq/questions/success"
+        end
+        def question_params
+          params[:hancock_faq_question].permit(:question_text, :author_name, :author_email, :captcha, :captcha_key)
+        end
+
+        def category_class
+          Hancock::Faq::Category
+        end
+        def question_class
+          Hancock::Faq::Question
+        end
+
+        def per_page
+          10
+        end
+
+      end
+
+    end
+  end
+end

data/lib/hancock/faq/engine.rb

@@ -0,0 +1,7 @@
+module Hancock
+  module Faq
+    class Engine < ::Rails::Engine
+      # isolate_namespace Hancock::Faq
+    end
+  end
+end

data/lib/hancock/faq/models/category.rb

@@ -0,0 +1,50 @@
+module Hancock::Faq
+  module Models
+    module Category
+      extend ActiveSupport::Concern
+      include Hancock::Model
+      include Hancock::Enableable
+
+      if Hancock::Faq.config.seo_support
+        include Hancock::Seo::Seoable
+        include Hancock::Seo::SitemapDataField
+      end
+      include ManualSlug
+
+      if Hancock::Pages.config.cache_support
+        include Hancock::Cache::Cacheable
+      end
+
+      include Hancock::Faq.orm_specific('Category')
+
+      included do
+        if Hancock::Feedback.config.model_settings_support
+          include RailsAdminModelSettings::ModelSettingable
+        end
+
+        manual_slug :name
+
+        def self.manager_can_add_actions
+          ret = [:nested_set]
+          ret << :model_settings if Hancock::Faq.config.model_settings_support
+          # ret << :model_accesses if Hancock::Faq.config.user_abilities_support
+          ret << :hancock_touch if Hancock::Faq.config.cache_support
+          ret += [:comments, :model_comments] if Hancock::Faq.config.ra_comments_support
+          ret.freeze
+        end
+        def self.rails_admin_add_visible_actions
+          ret = [:nested_set]
+          ret << :model_settings if Hancock::Faq.config.model_settings_support
+          ret << :model_accesses if Hancock::Faq.config.user_abilities_support
+          ret << :hancock_touch if Hancock::Faq.config.cache_support
+          ret += [:comments, :model_comments] if Hancock::Faq.config.ra_comments_support
+          ret.freeze
+        end
+      end
+
+      def question_class
+        Hancock::Faq::Question
+      end
+    end
+  end
+end

data/lib/hancock/faq/models/mongoid/category.rb

@@ -0,0 +1,33 @@
+module Hancock::Faq
+  module Models
+    module Mongoid
+      module Category
+        extend ActiveSupport::Concern
+
+        include Hancock::HtmlField
+
+        included do
+          index({enabled: 1, lft: 1}, {background: true})
+          index({parent_id: 1},       {background: true})
+
+          field :name,          type: String, localize: Hancock::Faq.configuration.localize
+
+          acts_as_nested_set
+          scope :sorted, -> { order_by([:lft, :asc]) }
+
+          hancock_cms_html_field :excerpt,   type: String, localize: Hancock::Faq.configuration.localize, default: ""
+          hancock_cms_html_field :content,   type: String, localize: Hancock::Faq.configuration.localize, default: ""
+        end
+
+        def questions
+          question_class.in(category_ids: self.id)
+        end
+
+        def all_questions
+          question_class.any_in(category_ids: self.and_descendants.map(&:id))
+        end
+
+      end
+    end
+  end
+end

data/lib/hancock/faq/models/mongoid/question.rb

@@ -0,0 +1,72 @@
+module Hancock::Faq
+  module Models
+    module Mongoid
+      module Question
+        extend ActiveSupport::Concern
+
+        include Hancock::HtmlField
+
+        included do
+          index({main_category_id: 1},            {background: true})
+          index({enabled: 1, lft: 1},             {background: true})
+          index({category_ids: 1},                {background: true})
+          index({answered: 1, answered_time: 1},  {background: true})
+          index({created_at: 1},                  {background: true})
+
+          field :question_text
+          hancock_cms_html_field :question_text_after_editing, localize: Hancock::Faq.configuration.localize
+          field :author_name
+          field :author_name_text_after_editing, localize: Hancock::Faq.configuration.localize
+          field :author_email
+
+          field :answered, type: Boolean, default: false
+          hancock_cms_html_field :answer_text, localize: Hancock::Faq.configuration.localize
+          field :answered_time, type: Time
+          field :answer_author_name, default: Hancock::Faq.configuration.default_answer_author_name
+
+          has_and_belongs_to_many :categories, class_name: "Hancock::Faq::Category", inverse_of: nil
+
+          acts_as_nested_set
+          scope :sorted, -> { order_by([:lft, :asc]) }
+
+          scope :after_now, -> { where(:created_at.lt => Time.now) }
+          scope :by_date, -> { desc(:created_at) }
+          scope :by_answered_date, -> { desc(:answered_time) }
+          scope :answered,      -> { where(answered: true)  }
+          scope :not_answered,  -> { where(answered: false) }
+
+          scope :recent, ->(count = 5) { enabled.after_now.by_date.limit(count) }
+
+
+          def category
+            self.categories.enabled.sorted.first
+          end
+
+          def question_text_output
+            self.question_text_after_editing.blank? ? self.question_text : self.question_text_after_editing
+          end
+
+          def author_name_output
+            self.author_name_text_after_editing.blank? ? self.author_name : self.author_name_text_after_editing
+          end
+
+
+          if Hancock.rails5?
+            if relations.has_key?("updater") and defined?(::Mongoid::History)
+              belongs_to :updater, class_name: ::Mongoid::History.modifier_class_name, optional: true, validate: false
+              _validators.delete(:updater)
+              _validate_callbacks.each do |callback|
+                if callback.raw_filter.respond_to?(:attributes) and callback.raw_filter.attributes.include?(:updater)
+                  _validate_callbacks.delete(callback)
+                end
+              end
+            end
+          end
+
+        end
+
+
+      end
+    end
+  end
+end