help_kit 0.0.1

data/app/views/help_kit/_categories_panel.html.slim

@@ -0,0 +1,8 @@
+.panel.pad
+  h2 Browse articles by category
+  .grid-list.categories
+    -HelpKit::Category.top_level.each do |category|
+      .grid-item
+        .category =link_to category.name, category_path(category)
+        -category.descendants.each do |sub_category|
+          .sub-category =link_to sub_category.name, category_path(sub_category)

data/app/views/help_kit/_nav.html.slim

@@ -0,0 +1,12 @@
+.header
+  .nav
+    =link_to HelpKit.header.html_safe, landing_path,
+      class: 'brand'
+    .right
+      #article-search
+        = form_tag article_search_path, :method => :get
+          .input-container
+            input.search-input name="search[query]" placeholder="Ask a question"
+          .button-container
+            button.search-button type="submit"
+              = icon('search')

data/app/views/help_kit/admin/_nav.html.slim

@@ -0,0 +1,5 @@
+.header
+  .nav
+    .brand #{icon('book')}Knowledge<strong>Base</strong>
+    .right
+      =link_to icon('power-off'), landing_path

data/app/views/help_kit/admin/categories/_form.html.slim

@@ -0,0 +1,10 @@
+= simple_form_for [:admin, @category] do |f|
+  =f.input :name
+  =f.input :parent_id,
+    collection: category_options(@category),
+    label: 'Parent category',
+    include_blank: 'No parent'
+  hr/
+  =f.label :header_content
+  pre#editor.category-editor =@category.header_content
+  =f.hidden_field :header_content

data/app/views/help_kit/admin/categories/edit.html.slim

@@ -0,0 +1,7 @@
+-content_for :submenu do
+  =link_to icon('save', 'Save & Exit'), '#', class: 'save-category'
+  =link_to icon('trash-o','Delete Category'), admin_category_path(@category),
+    data: { method: 'delete',
+    confirm: 'Are you sure you want to delete this category?'}
+
+=render 'form'

data/app/views/help_kit/admin/categories/index.html.slim

@@ -0,0 +1,9 @@
+-content_for :submenu do
+  =link_to icon('plus', 'New Category'), new_admin_category_path, class: 'new-category'
+h1 Article categories
+p.subtitle Click any category to modify its properties.
+.category-list
+  =nested_li @categories  do |c|
+    .category-item
+      =link_to icon('circle-thin',c.name), [:edit, :admin, c]
+      span.count #{pluralize(c.articles.count, 'article')}

data/app/views/help_kit/admin/categories/new.html.slim

@@ -0,0 +1,3 @@
+-content_for :submenu do
+  =link_to icon('save', 'Save & Exit'), '#', class: 'save-category'
+= render 'form'

data/app/views/help_kit/admin/landing/land.html.slim

@@ -0,0 +1,17 @@
+h2 Recently updated articles
+.article-list
+  = render HelpKit::Article.recent(10)
+hr/
+h2 Unviewed articles
+.article-list
+  = render HelpKit::Article.unviewed(10)
+hr/
+h2 Popular articles
+.article-list
+  = render HelpKit::Article.popular(10)
+hr/
+h2 Empty categories
+-HelpKit::Category.no_articles.each do |category|
+  .breadcrumb
+    = category_breadcrumb(category, hide_home: true)
+

data/app/views/help_kit/articles/_article.html.slim

@@ -0,0 +1,6 @@
+.article-item
+  .article-item-glyph
+    = image_tag 'help_kit/document.png'
+  .article-item-info
+    .title =link_to article.title, help_kit.article_path(article)
+    .description =article.description

data/app/views/help_kit/articles/_form.html.slim

@@ -0,0 +1,22 @@
+-content_for :submenu
+  =link_to icon('cog', 'Article Settings'), '#', class: 'article-details'
+  =link_to icon('save', 'Save & Close'), "#", class: 'save-article'
+  =link_to icon('power-off', 'Exit'), landing_path, class: 'admin-link'
+=text_field_tag :article_title_temp, @article.title, class: 'article-title',
+  placeholder: 'Article Title'
+
+pre#editor.article-editor =@article.content
+
+.article-details-modal
+  h2 Article details
+  =simple_form_for @article, url: url do |f|
+    =f.input :category_id,
+      collection: category_options(@category),
+      prompt: 'No Category',
+      label: false
+    =f.input :description, input_html: { rows: 3 }, label: false,
+      placeholder: 'Article description'
+    =f.hidden_field :content, class: 'content'
+    =f.hidden_field :title
+    .form-actions
+      =button_tag 'Close', class: 'hide-article-modal'

data/app/views/help_kit/articles/edit.html.slim

@@ -0,0 +1 @@
+=render 'form', url: article_path(@article)

data/app/views/help_kit/articles/index_category.html.slim

@@ -0,0 +1,44 @@
+.center-container
+  .panel
+    .split-view
+      .menu
+        -HelpKit::Category.top_level.each do |category|
+          -if @category == category
+            .menu-item class="active"
+              =link_to category.name, help_kit.category_path(category)
+            .sub-menu.sub-categories
+              -@category.children.each do |sub_category|
+                .sub-menu-item
+                  =link_to sub_category.name, help_kit.category_path(sub_category)
+          -elsif @category.is_descendant_of?(category)
+            .menu-item.active
+              =link_to category.name, help_kit.category_path(category)
+            .sub-menu.sub-categories
+              -category.children.each do |sub_category|
+                -if @category == sub_category
+                  .sub-menu-item.active
+                    =link_to sub_category.name, help_kit.category_path(sub_category)
+                -else
+                  .sub-menu-item
+                    =link_to sub_category.name, help_kit.category_path(sub_category)
+
+          -else
+            .menu-item.category
+              =link_to category.name, help_kit.category_path(category)
+      .content
+        h1 =@category.name
+        - if @category.header_content
+          .article
+            ==@category.header_content
+          hr/
+        .article-list
+          = render @category.articles
+        -@category.descendants.each do |category|
+          -if category.articles.count > 0
+            a name=category.slug
+            h2 =category.name
+            .article-list
+              =render category.articles
+
+
+

data/app/views/help_kit/articles/new.html.slim

@@ -0,0 +1 @@
+=render 'form', url: new_article_path

data/app/views/help_kit/articles/not_found.html.slim

@@ -0,0 +1,4 @@
+.article
+  h1 =params[:id]
+  p This article has not been created yet. Why dont you create it.
+  p =link_to 'Create Article', new_article_path(title: params[:id])

data/app/views/help_kit/articles/search.html.slim

@@ -0,0 +1,11 @@
+.center-container
+  .search
+    = form_for :search, url: article_search_path, :method => :get do |f|
+      = f.text_field :query
+      = button_tag icon('search')
+  .panel.pad
+    h1 Results for <em>"#{params[:search][:query]}"</em>
+    p.subtitle #{pluralize(@articles.count, 'result')} found
+    .article-list
+      =render @articles
+  =render 'help_kit/categories_panel'

data/app/views/help_kit/articles/show.html.slim

@@ -0,0 +1,24 @@
+-content_for :title, @article.title
+-content_for :submenu do
+  =link_to icon('edit', 'Edit Article'), help_kit.edit_article_path(@article),
+    class: 'edit-article'
+.page-container
+  .article-container
+    .article-header
+      -if @article.category
+        .breadcrumb
+          =category_breadcrumb(@article.category)
+    article.article
+      h1 =@article.title
+      p.subtitle =@article.description
+      .article-content
+        ==render_markdown @article.content
+    .details
+      -if @article.tags.count > 0
+        .tags
+          .inline-title tags
+          -@article.tags.each do |tag|
+            .tag =link_to tag.name, ''
+      .inline-detail
+        .inline-title last updated
+        span =time_ago_in_words @article.updated_at.to_s(:short)

data/app/views/help_kit/landing/land.html.slim

@@ -0,0 +1,16 @@
+.center-container
+  .search
+    = form_for :search, url: article_search_path, :method => :get do |f|
+      = f.text_field :query, placeholder: 'Search articles...'
+      = button_tag icon('search')
+  .panel.pad
+    .articles
+      .section
+        h2 Popular articles
+        .article-list
+          =render HelpKit::Article.popular(5)
+      .section
+        h2 Recent articles
+        .article-list
+          =render HelpKit::Article.recent(5)
+  =render 'help_kit/categories_panel'

data/app/views/layouts/help_kit/admin.html.slim

@@ -0,0 +1,18 @@
+doctype html
+html
+  head
+    title #{HelpKit.site_title} Admin
+    = stylesheet_link_tag "help_kit/application", media: "all"
+    = javascript_include_tag "help_kit/application"
+    = csrf_meta_tags
+  body
+    = render 'help_kit/admin/nav'
+    .submenu =yield :submenu
+
+    .split-view
+      .menu
+        .menu-item
+          =split_view_menu_item(icon('home','Welcome'), admin_landing_path, 'landing')
+          =split_view_menu_item(icon('list','Categories'), admin_categories_path, 'categories')
+      .content
+        = yield

data/app/views/layouts/help_kit/application.html.slim

@@ -0,0 +1,13 @@
+doctype html
+html
+  head
+    title #{HelpKit.site_title} | #{content_for(:title)}
+    = stylesheet_link_tag "help_kit/application", media: "all"
+    = javascript_include_tag "help_kit/application"
+    = csrf_meta_tags
+  body
+    .action-header
+      .right
+        =link_to icon('cog', 'Settings'), admin_landing_path, class: 'admin-link'
+    = yield
+  .site-footer powered by HelpKit

data/app/views/layouts/help_kit/minimal.html.slim

@@ -0,0 +1,19 @@
+doctype html
+html
+  head
+    - if content_for?(:title)
+        title #{HelpKit.site_title} | #{content_for(:title)}
+    - else
+        title #{HelpKit.site_title}
+    = stylesheet_link_tag "help_kit/application", media: "all"
+    = javascript_include_tag "help_kit/application"
+    = csrf_meta_tags
+  body.minimal
+    = render 'help_kit/nav'
+    .submenu
+      =yield :submenu
+      - if is_authorized?
+        =link_to icon('plus', 'New Article'), new_article_path
+        =link_to icon('cog', 'Settings'), admin_landing_path
+    = yield
+  .site-footer powered by HelpKit

data/config/cucumber.yml

@@ -0,0 +1,8 @@
+<%
+rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
+rerun_opts = rerun.to_s.strip.empty? ? "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
+std_opts = "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} --strict --tags ~@wip"
+%>
+default: <%= std_opts %> features
+wip: --tags @wip:3 --wip features
+rerun: <%= rerun_opts %> --format rerun --out rerun.txt --strict --tags ~@wip

data/config/initializers/simple_form.rb

@@ -0,0 +1,166 @@
+# Use this setup block to configure all options available in SimpleForm.
+SimpleForm.setup do |config|
+  # Wrappers are used by the form builder to generate a
+  # complete input. You can remove any component from the
+  # wrapper, change the order or even add your own to the
+  # stack. The options given below are used to wrap the
+  # whole input.
+  config.wrappers :default, class: :input,
+    hint_class: :field_with_hint, error_class: :field_with_errors do |b|
+    ## Extensions enabled by default
+    # Any of these extensions can be disabled for a
+    # given input by passing: `f.input EXTENSION_NAME => false`.
+    # You can make any of these extensions optional by
+    # renaming `b.use` to `b.optional`.
+
+    # Determines whether to use HTML5 (:email, :url, ...)
+    # and required attributes
+    b.use :html5
+
+    # Calculates placeholders automatically from I18n
+    # You can also pass a string as f.input placeholder: "Placeholder"
+    b.use :placeholder
+
+    ## Optional extensions
+    # They are disabled unless you pass `f.input EXTENSION_NAME => true`
+    # to the input. If so, they will retrieve the values from the model
+    # if any exists. If you want to enable any of those
+    # extensions by default, you can change `b.optional` to `b.use`.
+
+    # Calculates maxlength from length validations for string inputs
+    b.optional :maxlength
+
+    # Calculates pattern from format validations for string inputs
+    b.optional :pattern
+
+    # Calculates min and max from length validations for numeric inputs
+    b.optional :min_max
+
+    # Calculates readonly automatically from readonly attributes
+    b.optional :readonly
+
+    ## Inputs
+    b.use :label_input
+    b.use :hint,  wrap_with: { tag: :span, class: :hint }
+    b.use :error, wrap_with: { tag: :span, class: :error }
+
+    ## full_messages_for
+    # If you want to display the full error message for the attribute, you can
+    # use the component :full_error, like:
+    #
+    # b.use :full_error, wrap_with: { tag: :span, class: :error }
+  end
+
+  # The default wrapper to be used by the FormBuilder.
+  config.default_wrapper = :default
+
+  # Define the way to render check boxes / radio buttons with labels.
+  # Defaults to :nested for bootstrap config.
+  #   inline: input + label
+  #   nested: label > input
+  config.boolean_style = :nested
+
+  # Default class for buttons
+  config.button_class = 'btn'
+
+  # Method used to tidy up errors. Specify any Rails Array method.
+  # :first lists the first message for each field.
+  # Use :to_sentence to list all errors for each field.
+  # config.error_method = :first
+
+  # Default tag used for error notification helper.
+  config.error_notification_tag = :div
+
+  # CSS class to add for error notification helper.
+  config.error_notification_class = 'error_notification'
+
+  # ID to add for error notification helper.
+  # config.error_notification_id = nil
+
+  # Series of attempts to detect a default label method for collection.
+  # config.collection_label_methods = [ :to_label, :name, :title, :to_s ]
+
+  # Series of attempts to detect a default value method for collection.
+  # config.collection_value_methods = [ :id, :to_s ]
+
+  # You can wrap a collection of radio/check boxes in a pre-defined tag, defaulting to none.
+  # config.collection_wrapper_tag = nil
+
+  # You can define the class to use on all collection wrappers. Defaulting to none.
+  # config.collection_wrapper_class = nil
+
+  # You can wrap each item in a collection of radio/check boxes with a tag,
+  # defaulting to :span. Please note that when using :boolean_style = :nested,
+  # SimpleForm will force this option to be a label.
+  # config.item_wrapper_tag = :span
+
+  # You can define a class to use in all item wrappers. Defaulting to none.
+  # config.item_wrapper_class = nil
+
+  # How the label text should be generated altogether with the required text.
+  # config.label_text = lambda { |label, required, explicit_label| "#{required} #{label}" }
+
+  # You can define the class to use on all labels. Default is nil.
+  # config.label_class = nil
+
+  # You can define the default class to be used on forms. Can be overriden
+  # with `html: { :class }`. Defaulting to none.
+  # config.default_form_class = nil
+
+  # You can define which elements should obtain additional classes
+  # config.generate_additional_classes_for = [:wrapper, :label, :input]
+
+  # Whether attributes are required by default (or not). Default is true.
+  # config.required_by_default = true
+
+  # Tell browsers whether to use the native HTML5 validations (novalidate form option).
+  # These validations are enabled in SimpleForm's internal config but disabled by default
+  # in this configuration, which is recommended due to some quirks from different browsers.
+  # To stop SimpleForm from generating the novalidate option, enabling the HTML5 validations,
+  # change this configuration to true.
+  config.browser_validations = false
+
+  # Collection of methods to detect if a file type was given.
+  # config.file_methods = [ :mounted_as, :file?, :public_filename ]
+
+  # Custom mappings for input types. This should be a hash containing a regexp
+  # to match as key, and the input type that will be used when the field name
+  # matches the regexp as value.
+  # config.input_mappings = { /count/ => :integer }
+
+  # Custom wrappers for input types. This should be a hash containing an input
+  # type as key and the wrapper that will be used for all inputs with specified type.
+  # config.wrapper_mappings = { string: :prepend }
+
+  # Namespaces where SimpleForm should look for custom input classes that
+  # override default inputs.
+  # config.custom_inputs_namespaces << "CustomInputs"
+
+  # Default priority for time_zone inputs.
+  # config.time_zone_priority = nil
+
+  # Default priority for country inputs.
+  # config.country_priority = nil
+
+  # When false, do not use translations for labels.
+  # config.translate_labels = true
+
+  # Automatically discover new inputs in Rails' autoload path.
+  # config.inputs_discovery = true
+
+  # Cache SimpleForm inputs discovery
+  # config.cache_discovery = !Rails.env.development?
+
+  # Default class for inputs
+  # config.input_class = nil
+
+  # Define the default class of the input wrapper of the boolean input.
+  config.boolean_label_class = 'checkbox'
+
+  # Defines if the default input wrapper class should be included in radio
+  # collection wrappers.
+  # config.include_default_input_wrapper_class = true
+
+  # Defines which i18n scope will be used in Simple Form.
+  # config.i18n_scope = 'simple_form'
+end

data/config/locales/simple_form.en.yml

@@ -0,0 +1,31 @@
+en:
+  simple_form:
+    "yes": 'Yes'
+    "no": 'No'
+    required:
+      text: 'required'
+      mark: '*'
+      # You can uncomment the line below if you need to overwrite the whole required html.
+      # When using html, text and mark won't be used.
+      # html: '<abbr title="required">*</abbr>'
+    error_notification:
+      default_message: "Please review the problems below:"
+    # Examples
+    # labels:
+    #   defaults:
+    #     password: 'Password'
+    #   user:
+    #     new:
+    #       email: 'E-mail to sign in.'
+    #     edit:
+    #       email: 'E-mail.'
+    # hints:
+    #   defaults:
+    #     username: 'User name to sign in.'
+    #     password: 'No special characters, please.'
+    # include_blanks:
+    #   defaults:
+    #     age: 'Rather not say'
+    # prompts:
+    #   defaults:
+    #     age: 'Select your age'

data/config/routes.rb

@@ -0,0 +1,21 @@
+HelpKit::Engine.routes.draw do
+
+  namespace :admin do
+    get '/' => 'landing#land', :as => :landing
+    resources :categories
+  end
+
+
+  get '/' => 'landing#land', :as => :landing
+  get '/search' => 'articles#search', :as => :article_search
+
+  get '/categories/:category' => 'articles#index_category',
+    :as => :category
+
+  get 'new' => 'articles#new', :as => :new_article
+  post 'new' => 'articles#create'
+  get 'edit/:id' =>  'articles#edit', :as => :edit_article
+  get ':id' => 'articles#show', :as => :article
+  patch ':id' => 'articles#update'
+
+end

data/config/spring.rb

@@ -0,0 +1 @@
+Spring.application_root = './spec/dummy'

data/db/migrate/20150125225416_create_help_kit_articles.rb

@@ -0,0 +1,18 @@
+class CreateHelpKitArticles < ActiveRecord::Migration
+  def change
+    create_table :help_kit_articles do |t|
+      t.string :title
+      t.boolean :published
+      t.text :content
+      t.text :description
+      t.datetime :published_at
+      t.integer :view_count
+      t.references :creator, index: true
+      t.references :last_editor, index: true
+      t.references :category, index: true
+      t.references :parent_article, index: true
+      t.string :slug
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20150126022104_create_help_kit_categories.rb

@@ -0,0 +1,15 @@
+class CreateHelpKitCategories < ActiveRecord::Migration
+  def change
+    create_table :help_kit_categories do |t|
+      t.string :name
+      t.string :slug
+      t.references :parent, index: true
+      t.integer :lft
+      t.integer :rgt
+      t.integer :depth
+      t.integer :children_count
+      t.text :header_content
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20150127175303_create_help_kit_tags.rb

@@ -0,0 +1,8 @@
+class CreateHelpKitTags < ActiveRecord::Migration
+  def change
+    create_table :help_kit_tags do |t|
+      t.string :name
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20150127175326_create_help_kit_article_tags.rb

@@ -0,0 +1,9 @@
+class CreateHelpKitArticleTags < ActiveRecord::Migration
+  def change
+    create_table :help_kit_article_tags do |t|
+      t.references :tag, index: true
+      t.references :article, index: true
+      t.timestamps null: false
+    end
+  end
+end

data/lib/generators/help_kit/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Creates config initializer, database migration files, and mounts help_kit
+into the routes file.
+Example:
+    rails generate help_kit:install
+
+    This will create:
+        config/initializers/help_kit.rb

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

@@ -0,0 +1,34 @@
+class HelpKit::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+
+  def copy_migrations
+    rake "help_kit:install:migrations"
+  end
+
+  def copy_initializer
+    initializer "help_kit.rb", <<-FILE
+HelpKit.config do |config|
+  # config.site_title is used to display the page titles.
+  # config.site_title = "KnowledgeBase"
+
+  # config.header is used to display the branded text in the header bar on all
+  # pages.
+  # config.header = '<i class="fa fa-book"></i>Knowledge<strong>Base</strong>'
+
+  # config.authorize should check if the current session is capable of editing
+  # and managing the help system. If it does not return false or nil article
+  # management will be alllowed.
+  #  NOTE: If this value is not set managment will always be allowed!
+
+  #config.authorize do
+  #  User.find(session[:user_id]).is_admin?
+  #end
+end
+    FILE
+  end
+
+  def setup_routes
+    route %Q|mount HelpKit::Engine => "/kb"|
+  end
+end

data/lib/generators/help_kit/install/templates/help_kit.rb

@@ -0,0 +1,13 @@
+HelpKit.config do |config|
+  # config.title is used to display the page titles.
+  config.title = "Knowledgebase"
+
+  # config.authorize should check if the current session is capable of editing
+  # and managing the help system. If it does not return false or nil article
+  # management will be alllowed.
+  #  NOTE: If this value is not set managment will always be allowed!
+
+  #config.authorize do
+  #  User.find(session[:user_id]).is_admin?
+  #end
+end

data/lib/help_kit/configuration.rb

@@ -0,0 +1,25 @@
+module HelpKit
+
+  mattr_writer :site_title
+  def self.site_title; @site_title || 'KnowledgeBase'; end
+
+  mattr_writer :header
+  def self.header
+    '<i class="fa fa-book"></i>Knowledge<strong>Base</strong>'
+  end
+
+  mattr_writer :authorization_method
+  def self.authorization_method
+    @authorization_method ||= proc.new {True}
+  end
+
+
+  def self.authorize(&block)
+    self.authorization_method = block
+  end
+
+  def self.config(&block)
+    yield(self)
+  end
+
+end