spree-faq 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 61e852d5ccf4cdef6e871e7641a0eb40f5785835
+  data.tar.gz: abd135909a2d1f7716502a66d49401c3e6967dfd
+SHA512:
+  metadata.gz: f72f9618e2f0b45df23481be3af9d60ff46598cdb2fd7ecdd1b2a917865d8f288a866771dd1c07bc43cfd24ec44c677d2e0bd54d251d603f358c8231fc3edecd
+  data.tar.gz: a4e062c254e9973d862418ec27a0842a0e5dded6365a91f1e2695e6a0e3ae1bad1e9b5015536f3569f853ead203fd854f0a546d80fa562d579f4787988fe8c18

data/.gitignore

@@ -0,0 +1,13 @@
+\#*
+*~
+.#*
+.sass-cache
+.DS_Store
+.bundle
+coverage
+Gemfile.lock
+tmp
+pkg
+spec/dummy
+.rvmrc
+.localeapp

data/.hound.yml

@@ -0,0 +1,3 @@
+---
+LineLength:
+  Enabled: false

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+before_script:
+  - sh -e /etc/init.d/xvfb start
+  - export DISPLAY=:99.0
+  - bundle exec rake test_app
+script:
+  - bundle exec rspec spec
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/CONTRIBUTING.md

@@ -0,0 +1,30 @@
+# Contributing
+
+In the spirit of [free software][1], **everyone** is encouraged to help improve this project.
+
+Here are some ways *you* can contribute:
+
+* by using prerelease versions
+* by reporting [bugs][2]
+* by suggesting new features
+* by writing [translations][3]
+* by writing or editing documentation
+* by writing specifications
+* by writing code (*no patch is too small*: fix typos, add comments, clean up inconsistent whitespace)
+* by refactoring code
+* by resolving [issues][2]
+* by reviewing patches
+
+Starting point:
+
+* Fork the repo
+* Clone your repo
+* Run `bundle install`
+* Run `bundle exec rake test_app` to create the test application in `spec/test_app`
+* Make your changes
+* Ensure specs pass by running `bundle exec rspec spec`
+* Submit your pull request
+
+[1]: http://www.fsf.org/licensing/essays/free-sw.html
+[2]: https://github.com/futhr/spree-faq/issues
+[3]: http://www.localeapp.com/projects/6629

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'spree', github: 'spree/spree', branch: '2-0-stable'
+gem 'spree_auth_devise', github: 'spree/spree_auth_devise', branch: '2-0-stable'
+
+gemspec

data/Guardfile

@@ -0,0 +1,8 @@
+guard 'rspec', cmd: 'bundle exec rspec', all_on_start: true do
+  watch('spec/spec_helper.rb')            { 'spec' }
+  watch('config/routes.rb')               { 'spec/routing' }
+  watch(%r{^spec/(.+)_spec\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.+)_decorator\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^(app|lib)/(.+)(\.rb|\.erb)$}) { |m| "spec/#{m[2]}_spec.rb" }
+  watch(%r{^config/locales/(.+)\.yml$})   { 'spec/translations' }
+end

data/LICENSE.md

@@ -0,0 +1,26 @@
+Copyright (c) 2009-2014 Josh Nussbaum, Tobias Bohwalli, and other contributors.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Spree nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,37 @@
+# Spree Frequently Asked Question
+
+[![Build Status](https://travis-ci.org/futhr/spree-faq.png?branch=2-0-stable)](https://travis-ci.org/futhr/spree-faq)
+[![Coverage Status](https://coveralls.io/repos/futhr/spree-faq/badge.png?branch=2-0-stable)](https://coveralls.io/r/futhr/spree-faq)
+[![Code Climate](https://codeclimate.com/github/futhr/spree-faq.png)](https://codeclimate.com/github/futhr/spree-faq)
+[![Gem Version](https://badge.fury.io/rb/spree_postal_service.png)](http://badge.fury.io/rb/spree_postal_service)
+
+An Spree Commerce extension for managing FAQs.
+
+## Installation
+
+In your `Gemfile`
+
+```ruby
+gem 'spree_faq', '~> 2.0.0'
+```
+
+Then run from the command line:
+
+    bundle install
+    rails g spree_faq:install
+
+---
+
+## Contributing
+
+See corresponding [guiedlines][1].
+
+---
+
+Copyright (c) 2009-2014 [Josh Nussbaum][2], [Tobias Bohwalli][3], and other [contributors][4], released under the [New BSD License][5]
+
+[1]: https://github.com/futhr/spree-faq/blob/master/CONTRIBUTING.md
+[2]: https://github.com/joshnuss
+[3]: https://github.com/futhr
+[4]: https://github.com/futhr/spree-faq/graphs/contributors
+[5]: https://github.com/futhr/spree-faq/blob/master/LICENSE.md

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/common_rake'
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_faq'
+  Rake::Task['common:test_app'].invoke
+end

data/app/assets/javascripts/admin/spree_faq.js.coffee

@@ -0,0 +1,23 @@
+#= require admin/spree_backend
+
+(($) ->
+  $('form').on 'click', '.add_fields', ->
+    time = new Date().getTime()
+    regexp = new RegExp($(this).data('id'), 'g')
+    $(this).before($(this).data('fields').replace(regexp, time))
+    event.preventDefault()
+
+  $('form').on 'click', '.remove', ->
+    $(this).parent('.question').children(':hidden[id$=delete]').val(1)
+    $(this).parent('.question').slideUp('slow')
+    event.preventDefault()
+
+  $('#new_question_link').on 'click', ->
+    $('#questions').append(new_question_html.replace(/NEW_RECORD/g, $('#questions .question').size()))
+    $('#questions .question:last .remove').on 'click', ->
+      $(this).parent('.question').remove()
+
+    $.scrollTo($('#questions .question:last'), 800)
+    $('.question:last input:first').focus()
+
+) jQuery

data/app/assets/javascripts/store/spree_faq.js.coffee

@@ -0,0 +1,10 @@
+#= require store/spree_frontend
+
+(($) ->
+  $('.answer').hide()
+  $('.question').on 'click', ->
+    id = $(this).attr('id').split('_')[1]
+    $('#answer_' + id).slideToggle()
+    return false
+
+) jQuery

data/app/assets/stylesheets/admin/spree_faq.css

@@ -0,0 +1,3 @@
+/*
+ *= require admin/spree_backend
+*/

data/app/assets/stylesheets/store/spree_faq.css.scss

@@ -0,0 +1,18 @@
+/*
+ *= require store/spree_frontend
+*/
+
+#questions .question {
+  margin-bottom: 1em;
+  padding: 1em;
+  border: solid 1px #ccc;
+
+  textarea, input {
+    width: 600px;
+  }
+
+  textarea {
+    height: 40px;
+    padding: 0;
+  }
+}

data/app/controllers/spree/admin/question_categories_controller.rb

@@ -0,0 +1,13 @@
+module Spree
+  module Admin
+    class QuestionCategoriesController < ResourceController
+      before_filter :question_category, only: [:new, :edit]
+
+      private
+
+      def question_category
+        @question_category ||= @object
+      end
+    end
+  end
+end

data/app/controllers/spree/faqs_controller.rb

@@ -0,0 +1,13 @@
+module Spree
+  class FaqsController < StoreController
+    helper 'spree/products'
+
+    def index
+      @categories = QuestionCategory.all(include: :questions)
+    end
+
+    def default_title
+      Spree.t(:frequently_asked_questions, scope: :spree_faq)
+    end
+  end
+end

data/app/models/spree/question.rb

@@ -0,0 +1,7 @@
+class Spree::Question < ActiveRecord::Base
+  acts_as_list
+
+  belongs_to :question_category, class_name: 'Spree::QuestionCategory'
+  validates  :question_category_id, :question, :answer, presence: true
+  attr_accessible :question, :answer, :question_category_id, :question_category
+end

data/app/models/spree/question_category.rb

@@ -0,0 +1,9 @@
+class Spree::QuestionCategory < ActiveRecord::Base
+  acts_as_list
+
+  has_many :questions, class_name: 'Spree::Question'
+  validates :name, presence: true
+  validates :name, uniqueness: { case_sensitive: false }
+  accepts_nested_attributes_for :questions, allow_destroy: true
+  attr_accessible :name, :questions_attributes, :question, :answer
+end

data/app/overrides/add_faq_admin_tab.rb

@@ -0,0 +1,5 @@
+Deface::Override.new(virtual_path:  "spree/admin/shared/_configuration_menu",
+                     name:          "add_faq_configuration_line",
+                     insert_bottom: "[data-hook='admin_configurations_sidebar_menu']",
+                     text:          "<%= configurations_sidebar_menu_item Spree.t(:question_categories_admin, scope: :spree_faq), admin_question_categories_url %>",
+                     disabled:      false)

data/app/views/spree/admin/question_categories/_question.html.erb

@@ -0,0 +1,14 @@
+<div class="question" id="<%= dom_id f.object %>">
+	<fieldset class="no-border-bottom">
+	  <div class="field">
+	    <%= f.label :question, Spree::Question.model_name.human(count: 1) %> <span class="required">*</span><br />
+	    <%= f.text_field :question, class: 'fullwidth title' %>
+	  </div>
+	  <div class="field">
+	    <%= f.label :answer, Spree.t(:answer, scope: :spree_faq) %> <span class="required">*</span><br />
+	    <%= f.text_area :answer, rows: 2, class: 'fullwidth' %>
+	  </div>
+	  <%= f.hidden_field :_destroy %>
+	  <%= link_to_with_icon 'icon-trash', 'remove', '#', class: 'remove' %>
+  </fieldset>
+</div>

data/app/views/spree/admin/question_categories/edit.html.erb

@@ -0,0 +1,38 @@
+<%= render 'spree/admin/shared/configuration_menu' %>
+
+<% content_for :page_title do %>
+  <%= Spree.t(:editing_category_questions, scope: :spree_faq) %>
+<% end %>
+
+<% content_for :page_actions do %>
+  <li>
+    <%= button_link_to Spree.t(:add_question, scope: :spree_faq), '#', icon: 'icon-plus', id: 'new_question_link' %>
+    <%= button_link_to Spree.t(:back_to_categories, scope: :spree_faq), spree.admin_question_categories_path, icon: 'icon-arrow-left' %>
+  </li>
+<% end %>
+
+<%= render 'spree/shared/error_messages', target: @question_category %>
+
+<%= form_for [:admin, @question_category] do |f| %>
+  <%= javascript_tag do %>
+     var new_question_html = '<%= generate_template(f, :questions) %>';
+  <% end %>
+  <div class="field">
+    <%= f.field_container :name do %>
+      <%= f.label :name, Spree.t(:category_name, scope: :spree_faq) %> <span class="required">*</span><br />
+      <%= f.text_field :name, class: 'fullwidth title' %>
+      <%= f.error_message_on :name %>
+    <% end %>
+  </div>
+  <div id="questions" style="margin-bottom: 20px">
+    <h3>Questions</h3>
+      <%= f.fields_for :questions do |question_form| %>
+        <%= render 'question', f: question_form %>
+      <% end %>
+  </div>
+  <div class="form-buttons filter-actions actions" data-hook="buttons">
+    <%= button Spree.t(:update), 'icon-refresh' %>
+    <span class="or"><%= Spree.t(:or) %></span>
+    <%= link_to_with_icon 'icon-remove', Spree.t(:cancel), admin_question_categories_url, class: 'button' %>
+  </div>
+<% end %>

data/app/views/spree/admin/question_categories/index.html.erb

@@ -0,0 +1,48 @@
+<%= render 'spree/admin/shared/configuration_menu' %>
+
+<% content_for :page_title do %>
+  <%= Spree.t(:question_categories, scope: :spree_faq) %>
+<% end %>
+
+<% content_for :page_actions do %>
+  <li id="new_question_category_link">
+    <%= button_link_to Spree.t(:new_question_category, scope: :spree_faq), new_admin_question_category_url,
+        { remote: true, icon: 'icon-plus', 'data-update' => 'new_question_category', id: 'new_question_category_link' } %>
+  </li>
+<% end %>
+
+<div id="new_question_category"></div>
+
+<% if @question_categories.any? %>
+<table class="index" id="listing_faq">
+  <colgroup>
+    <col style="width: 40%">
+    <col style="width: 40%">
+    <col style="width: 20%">
+  </colgroup>
+  <thead>
+    <tr data-hook="admin_faq_category_index_headers">
+      <th><%= Spree::QuestionCategory.model_name.human(count: 2) %></td>
+      <th><%= Spree::Question.model_name.human(count: 2) %></td>
+      <th data-hook="admin_faq_category_index_header_actions" class="actions"></th>
+    </tr>
+  <thead>
+  <tbody>
+    <% @question_categories.each do |category| %>
+      <tr id="<%= spree_dom_id category %>" data-hook="admin_faq_category_index_rows" class="<%= cycle('odd', 'even') %>">
+        <td class="align-center"><%= h category.name %></td>
+        <td class="align-center"><%= category.questions.count %></td>
+        <td data-hook="admin_faq_category_index_row_actions" class="actions">
+          <%= link_to_edit category, no_text: true %>
+          <%= link_to_delete category, no_text: true %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+<% else %>
+  <div class="alpha twelve columns no-objects-found">
+    <%= Spree.t(:no_resource_found, resource: Spree::QuestionCategory.model_name.human(count: 2)) %>,
+    <%= link_to Spree.t(:add_one), spree.new_admin_question_category_path %>!
+  </div>
+<% end %>

data/app/views/spree/admin/question_categories/new.html.erb

@@ -0,0 +1,19 @@
+<%= render 'spree/admin/shared/configuration_menu' %>
+
+<% content_for :page_title do %>
+  <%= Spree.t(:new_question_category, scope: :spree_faq) %>
+<% end %>
+
+<%= render 'spree/shared/error_messages', target: @question_category %>
+<%= form_for [:admin, @question_category] do |f| %>
+  <fieldset class="no-border-top">
+      <%= f.field_container :name do %>
+          <%= f.label :name, Spree.t(:name) %> <span class="required">*</span><br />
+          <%= f.text_field :name, class: 'fullwidth title'  %>
+          <%= f.error_message_on :name %>
+      <% end %>
+      <div data-hook="buttons" class="filter-actions actions">
+      	<%= button Spree.t(:create), 'icon-ok' %>
+    	</div>
+  </fieldset>
+<% end %>

data/app/views/spree/admin/question_categories/new.js.erb

@@ -0,0 +1,2 @@
+$('#new_question_category').html('<%= escape_javascript(render template: "spree/admin/question_categories/new", formats: [:html], handlers: [:erb]) %>');
+$('#new_question_category_link').parent().hide();

data/app/views/spree/faqs/index.html.erb

@@ -0,0 +1,29 @@
+<h1><%= Spree.t(:frequently_asked_questions, scope: :spree_faq) %></h1>
+
+<div id="faqs">
+  <% @categories.each do |category| %>
+    <div id="<%= dom_id category -%>" class="category">
+      <h2><%= h category.name %></h2>
+      <ul class="answers">
+        <% category.questions.each do |question| %>
+          <li>
+            <a class="question" id="<%= dom_id question -%>" href="#<%= "answer_#{question.id}" %>">
+              <%= raw(question.question) -%>
+            </a>
+            <div class="answer" id="<%= "answer_#{question.id}"-%>">
+              <%= raw(question.answer) %>
+            </div>
+          </li>
+        <% end %>
+      </ul>
+    </div>
+  <% end %>
+</div>
+
+<% content_for :sidebar do %>
+  <% if defined? @products && defined? @taxon %>
+    <%= render 'spree/shared/filters' %>
+  <% elsif defined? @taxonomies %>
+    <%= render 'spree/shared/taxonomies' %>
+  <% end %>
+<% end %>

data/config/locales/en.yml

@@ -0,0 +1,22 @@
+---
+en:
+  activerecord:
+    models:
+      spree/question_category:
+        one: Question Category
+        other: Question Categories
+      spree/question:
+        one: Question
+        other: Questions
+  spree:
+    spree_faq:
+      add_question: Add Question
+      answer: Answer
+      back_to_categories: Back to Categories
+      category_name: Category Name
+      create_category: Create Category
+      editing_category_questions: Editing Category Questions
+      frequently_asked_questions: Frequently Asked Questions
+      new_question_category: New Category
+      question_categories: Frequently Asked Questions
+      question_categories_admin: FAQ

data/config/locales/sv.yml

@@ -0,0 +1,22 @@
+---
+sv:
+  activerecord:
+    models:
+      spree/question_category:
+        one: Kategori
+        other: Kategorier
+      spree/question:
+        one: Fråga
+        other: Frågor
+  spree:
+    spree_faq:
+      add_question: Lägg till fråga
+      answer: Svar
+      back_to_categories: Tillbaka till kategorier
+      category_name: Kategorinamn
+      create_category: Skapa kategori
+      editing_category_questions: Ändra kategori frågor
+      frequently_asked_questions: Vanliga frågor och svar
+      new_question_category: Ny kategori
+      question_categories: Vanliga frågor och svar
+      question_categories_admin: FAQ

data/config/routes.rb

@@ -0,0 +1,6 @@
+Spree::Core::Engine.routes.draw do
+  namespace :admin do
+    resources :question_categories
+  end
+  get 'faq', to: 'faqs#index'
+end

data/db/migrate/20090526213535_create_questions.rb

@@ -0,0 +1,16 @@
+class CreateQuestions < ActiveRecord::Migration
+  def self.up
+    create_table :questions do |t|
+      t.integer :question_category_id
+      t.text    :question
+      t.text    :answer
+      t.integer :position
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :questions
+  end
+end

data/db/migrate/20090526213550_create_question_categories.rb

@@ -0,0 +1,14 @@
+class CreateQuestionCategories < ActiveRecord::Migration
+  def self.up
+    create_table :question_categories do |t|
+      t.string  :name
+      t.integer :position
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :question_categories
+  end
+end

data/db/migrate/20140331032743_rename_questions_to_spree_questions.rb

@@ -0,0 +1,5 @@
+class RenameQuestionsToSpreeQuestions < ActiveRecord::Migration
+  def change
+    rename_table :questions, :spree_questions
+  end
+end

data/db/migrate/20140331032751_rename_question_categories_to_spree_question_categories.rb

@@ -0,0 +1,5 @@
+class RenameQuestionCategoriesToSpreeQuestionCategories < ActiveRecord::Migration
+  def change
+    rename_table :question_categories, :spree_question_categories
+  end
+end

data/lib/generators/spree_faq/install/install_generator.rb

@@ -0,0 +1,30 @@
+module SpreeFaq
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :auto_run_migrations, type: :boolean, default: false
+
+      def add_javascripts
+        append_file 'app/assets/javascripts/store/all.js', "//= require store/spree_faq\n"
+        append_file 'app/assets/javascripts/admin/all.js', "//= require admin/spree_faq\n"
+      end
+
+      def add_stylesheets
+        inject_into_file 'app/assets/stylesheets/store/all.css', " *= require store/spree_faq\n", before: /\*\//, verbose: true
+        inject_into_file 'app/assets/stylesheets/admin/all.css', " *= require admin/spree_faq\n", before: /\*\//, verbose: true
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_faq'
+      end
+
+      def run_migrations
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask 'Would you like to run the migrations now? [Y/n]')
+        if run_migrations
+          run 'bundle exec rake db:migrate'
+        else
+          puts 'Skipping rake db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/spree_faq/engine.rb

@@ -0,0 +1,21 @@
+module SpreeFaq
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_faq'
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/overrides/*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare &method(:activate).to_proc
+  end
+end

data/lib/spree_faq/version.rb

@@ -0,0 +1,16 @@
+module SpreeFaq
+
+  # Returns the version of the currently loaded SpreeFaq as a <tt>Gem::Version</tt>
+  def self.version
+    Gem::Version.new VERSION::STRING
+  end
+
+  module VERSION
+    MAJOR = 2
+    MINOR = 0
+    TINY  = 0
+    PRE   = nil
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
+  end
+end

data/lib/spree_faq.rb

@@ -0,0 +1,4 @@
+require 'spree_core'
+require 'spree_faq/version'
+require 'spree_faq/engine'
+require 'coffee_script'

data/script/rails

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/spree_faq/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'