hancock_cms_faq 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b805ff6820575b001725be796416aa508ad6c7f9
+  data.tar.gz: 87add6a36016ec18182aaf15cb415d6a539149fd
+SHA512:
+  metadata.gz: 34a23e6577df41b03b5af99565649eae6f344cbf8f17737b316f6795b7e147d363537f63b3bf69e768e4b8959092801e3b440307f0f16787addb74daae002272
+  data.tar.gz: f57864e1be1a6fe8a19ef665ec457de39bb856d5c818ca7300cd565c28f0e0b75d3f9b951def2278df51e4ae3166537294496848328c772e87541d3230d1cde6

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-gemset

@@ -0,0 +1 @@
+hancock_cms_faq

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hancock_cms_faq.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alexander Kiseliev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# HancockCmsFaq
+
+### Remaded from [EnjoyCMSFaq](https://github.com/enjoycreative/enjoy_cms_faq)
+
+FAQ system for [HancockCMS](https://github.com/red-rocks/hancock_cms).
+Question send form, question categories, captcha support
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hancock_cms_faq'
+```
+
+Then add this
+```ruby
+gem "recaptcha", require: "recaptcha/rails" # Recaptcha
+```
+or this
+```ruby
+gem "glebtv-simple_captcha" # simple_captcha
+```
+before it for captcha you need. And configure it. If you need
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hancock_cms_faq
+
+## Usage
+
+Add in config/routes.rb
+
+```ruby
+  hancock_cms_faq_routes
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/red-rocks/hancock_cms_faq.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/assets/javascripts/hancock/faq.coffee

@@ -0,0 +1,6 @@
+#= require ./faq/init
+#= require ./faq/form
+
+#= require_self
+
+window.hancock_cms.faq.create_ajax_form()

data/app/assets/javascripts/hancock/faq/form.coffee

@@ -0,0 +1,9 @@
+window.hancock_cms.faq.create_ajax_form = (form_selector = "#new_hancock_faq_question", wrapper_selector = "#hancock_faq_form" )->
+
+  $(document).delegate form_selector, "ajax:complete", (event, xhr, status)->
+    $(event.currentTarget).closest(wrapper_selector).html(xhr.responseText)
+
+  $(document).delegate form_selector + " .input", 'click', (e) ->
+    e.preventDefault()
+    $(e.currentTarget).removeClass("field_with_errors").find('span.error').hide()
+    return false

data/app/assets/javascripts/hancock/faq/init.coffee

@@ -0,0 +1,2 @@
+window.hancock_cms ||= {}
+window.hancock_cms.faq ||= {}

data/app/controllers/concerns/hancock/faq/decorators/categories.rb

@@ -0,0 +1,17 @@
+module Hancock::Faq::Decorators
+  module Categories
+    extend ActiveSupport::Concern
+
+    # included do
+    #
+    #   def category_class
+    #     Hancock::Faq::Category
+    #   end
+    #   def question_class
+    #     Hancock::Faq::Question
+    #   end
+    #
+    # end
+
+  end
+end

data/app/controllers/concerns/hancock/faq/decorators/questions.rb

@@ -0,0 +1,71 @@
+module Hancock::Faq::Decorators
+  module Questions
+    extend ActiveSupport::Concern
+
+    # included do
+    #
+    #   def hancock_faq_update_captcha_path
+    #     url_for(action: :update_captcha, time: Time.new.to_i, only_path: true)
+    #   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 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
+    #     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
+    #
+    # end
+
+  end
+end

data/app/controllers/hancock/faq/categories_controller.rb

@@ -0,0 +1,7 @@
+module Hancock::Faq
+  class CategoriesController < ApplicationController
+    include Hancock::Faq::Controllers::Categories
+
+    include Hancock::Faq::Decorators::Categories
+  end
+end

data/app/controllers/hancock/faq/questions_controller.rb

@@ -0,0 +1,7 @@
+module Hancock::Faq
+  class QuestionsController < ApplicationController
+    include Hancock::Faq::Controllers::Questions
+
+    include Hancock::Faq::Decorators::Questions
+  end
+end

data/app/models/concerns/hancock/faq/decorators/category.rb

@@ -0,0 +1,36 @@
+module Hancock::Faq::Decorators
+  module Category
+    extend ActiveSupport::Concern
+
+    included do
+      # def self.default_cache_keys
+      #   []
+      # end
+      #
+      # #############   rails_admin ##############
+      # def self.rails_admin_add_fields
+      #   {}
+      # end
+      #
+      # def self.rails_admin_add_config(config)
+      # end
+      #
+      # def self.admin_can_user_defined_actions
+      #   [].freeze
+      # end
+      # def self.admin_cannot_user_defined_actions
+      #   [].freeze
+      # end
+      # def self.manager_can_user_defined_actions
+      #   [].freeze
+      # end
+      # def self.manager_cannot_user_defined_actions
+      #   [].freeze
+      # end
+      # def self.rails_admin_user_defined_visible_actions
+      #   [].freeze
+      # end
+    end
+
+  end
+end

data/app/models/concerns/hancock/faq/decorators/question.rb

@@ -0,0 +1,48 @@
+module Hancock::Faq::Decorators
+  module Question
+    extend ActiveSupport::Concern
+
+    included do
+      # def self.default_cache_keys
+      #   []
+      # end
+      #
+      # def send_emails?
+      #   true
+      # end
+      #
+      # def mailer_class
+      #   Hancock::Feedback::ContactMailer
+      # end
+      #
+      # def mailer_method
+      #   :new_message_email
+      # end
+      #
+      # #############   rails_admin ##############
+      # def self.rails_admin_add_fields
+      #   {}
+      # end
+      #
+      # def self.rails_admin_add_config(config)
+      # end
+      #
+      # def self.admin_can_user_defined_actions
+      #   [].freeze
+      # end
+      # def self.admin_cannot_user_defined_actions
+      #   [].freeze
+      # end
+      # def self.manager_can_user_defined_actions
+      #   [].freeze
+      # end
+      # def self.manager_cannot_user_defined_actions
+      #   [].freeze
+      # end
+      # def self.rails_admin_user_defined_visible_actions
+      #   [].freeze
+      # end
+    end
+
+  end
+end

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

@@ -0,0 +1,11 @@
+module Hancock::Faq
+  class Category
+    include Hancock::Faq::Models::Category
+
+    include Hancock::Faq::Decorators::Category
+
+    rails_admin(&Hancock::Faq::Admin::Category.config(rails_admin_add_fields) { |config|
+      rails_admin_add_config(config)
+    })
+  end
+end

data/app/models/hancock/faq/question.rb

@@ -0,0 +1,11 @@
+module Hancock::Faq
+  class Question
+    include Hancock::Faq::Models::Question
+
+    include Hancock::Faq::Decorators::Question
+
+    rails_admin(&Hancock::Faq::Admin::Question.config(rails_admin_add_fields) { |config|
+      rails_admin_add_config(config)
+    })
+  end
+end

data/app/views/hancock/faq/categories/index.html.slim

@@ -0,0 +1,10 @@
+- _partial_path = (Hancock::Faq.config.seo_support ? 'shared/obj_with_seo' : 'shared/obj')
+= render _partial_path, obj: (@seo_page || @seo_parent_page)
+  
+  
+- @categories.each do |c|
+  p= link_to c.name, hancock_faq_category_path(c), title: c.name
+
+.newquestionform
+  p.newquestiontitle Задать свой вопрос:
+  = render partial: "hancock/faq/questions/form_with_wrapper"

data/app/views/hancock/faq/categories/show.html.slim

@@ -0,0 +1,8 @@
+/ - _cache_helper = (Hancock::Faq.config.cache_support ? :hancock_cache : :cache)
+
+- _partial_path = (Hancock::Faq.config.seo_support ? 'shared/obj_with_seo' : 'shared/obj')
+= render _partial_path, obj: @category
+  
+h1= @category.name
+- @questions.each do |q|
+  = link_to q.name.html_safe, hancock_faq_question_path(q), title: q.name

data/app/views/hancock/faq/questions/_fields.html.slim

@@ -0,0 +1,11 @@
+- label = t('hancock.faq_plugin.fields.author_name.label')
+- placeholder = t('hancock.faq_plugin.fields.author_name.placeholder')
+= f.input :author_name, label: label, input_html: {placeholder: placeholder, autofocus: true}
+
+- label = t('hancock.faq_plugin.fields.author_email.label')
+- placeholder = t('hancock.faq_plugin.fields.author_email.placeholder')
+= f.input :author_email, label: label, input_html: {placeholder: placeholder}
+
+- label = t('hancock.faq_plugin.fields.question_text.label')
+- placeholder = t('hancock.faq_plugin.fields.question_text.placeholder')
+= f.input :question_text, as: :text, label: label, input_html: {placeholder: placeholder}

data/app/views/hancock/faq/questions/_fields_with_settings.html.slim

@@ -0,0 +1,20 @@
+ruby:
+  cache_key ||= 'views/hancock_faq_question_fields'.freeze
+  if Hancock::Faq.config.model_settings_support
+    settings_scope ||= Hancock::Faq::Question.settings
+  elsif defined?(Settings)
+    settings_scope ||= Settings.ns('FAQ')
+  end
+
+
+- label = settings_scope.author_name_label(default: t('hancock.faq_plugin.fields.author_name.label'), label: "Заголовок поля ФИО", cache_keys: cache_key)
+- placeholder = settings_scope.author_name_placeholder(default: t('hancock.faq_plugin.fields.author_name.placeholder'), label: "Placeholder поля ФИО", cache_keys: cache_key)
+= f.input :author_name, label: label, input_html: {placeholder: placeholder, autofocus: true}
+
+- label = settings_scope.author_email_label(default: t('hancock.faq_plugin.fields.author_email.label'), label: "Заголовок поля e-mail", cache_keys: cache_key)
+- placeholder = settings_scope.author_email_placeholder(default: t('hancock.faq_plugin.fields.author_email.placeholder'), label: "Placeholder поля e-mail", cache_keys: cache_key)
+= f.input :author_email, label: label, input_html: {placeholder: placeholder}
+
+- label = settings_scope.question_text_label(default: t('hancock.faq_plugin.fields.question_text.label'), label: "Заголовок поля текст вопроса", cache_keys: cache_key)
+- placeholder = settings_scope.question_text_placeholder(default: t('hancock.faq_plugin.fields.question_text.placeholder'), label: "Placeholder поля текст вопроса", cache_keys: cache_key)
+= f.input :question_text, as: :text, label: label, input_html: {placeholder: placeholder}

data/app/views/hancock/faq/questions/_form.html.slim

@@ -0,0 +1,66 @@
+ruby:
+  is_cache_fields ||= ['new', 'index'].include? action_name
+  cache_key ||= 'hancock_faq_question_fields'.freeze
+  if Hancock::Faq.config.model_settings_support
+    settings_scope ||= Hancock::Faq::Question.settings
+  elsif defined?(Settings)
+    settings_scope ||= Settings.ns('FAQ')
+  end
+  fields_partial ||= "hancock/faq/questions/#{(Hancock::Faq.config.model_settings_support ? 'fields_with_settings' : 'fields')}".freeze
+  recaptcha_options ||= {}
+  @question ||= Hancock::Faq::Question.new
+  _cache_helper ||= (Hancock::Catalog.config.cache_support ? :hancock_cache : :cache)
+  
+= simple_form_for @question, url: hancock_faq_questions_path, html: {data: {remote: true }} do |f|
+  - if is_cache_fields
+    - send _cache_helper, cache_key, skip_digest: true do
+      = render partial: fields_partial, locals: {f: f, cache_key: "views/#{cache_key}", settings_scope: settings_scope}
+  - else
+    = render partial: fields_partial, locals: {f: f, settings_scope: settings_scope}
+  
+  - if Hancock::Faq.config.captcha
+    - if Hancock::Faq.config.recaptcha_support
+      .input
+        - if @recaptcha_error
+          span.error.recaptcha_error= @recaptcha_error
+        = recaptcha_tags
+    - elsif Hancock::Faq.config.simple_captcha_support
+      = render partial: "hancock/faq/questions/simple_captcha", locals: {f: f, settings_scope: settings_scope}
+        
+  - if Hancock::Faq.config.model_settings_support
+    - label = settings_scope.submit_label(default: t('hancock.send'), label: "Текст на кнопке отправки")
+  - else
+    - label = t('hancock.send')
+  = f.submit label
+
+
+
+/ - @question ||= Hancock::Faq::Question.new
+/ - if @question.new_record?
+/   = simple_form_for @question, url: hancock_faq_questions_path do |f|
+/     - unless @message.blank?
+/       h3= @message
+/     .inputtextblock_q
+/     
+/       - label = Settings.ns('faq_form').author_name_label( default: "ФИО", label: "Заголовок поля ФИО")
+/       = f.input :author_name, label: label
+/       
+/       - label = Settings.ns('faq_form').author_email_label( default: "E-mail", label: "Заголовок поля E-mail")
+/       = f.input :author_email, as: :email, label: label
+/       
+/       - label = Settings.ns('faq_form').question_text_label( default: "Текст вопроса", label: "Заголовок поля Текст вопроса")
+/       = f.input :question_text, as: :text, label: label
+/       
+/       
+/       - if Hancock::Faq.configuration.save_with_captcha
+/         .question_captcha
+/           - label = Settings.ns('faq_form').captcha_label( default: "Код проверки", label: "Заголовок поля Код проверки")
+/           = f.simple_captcha label: label, required: true
+/           - unless @question.errors[:captcha].blank?
+/             span.error= @question.errors[:captcha].join("<br />").html_safe
+/         
+/       - label = Settings.ns('faq_form').submit_label( default: "Отправить", label: "Заголовок кнопки Отправить")
+/       = f.button :submit, label
+/ - else
+/   - unless @message.blank?
+/     h3= @message