help_kit 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7084e32bbb5f95b81127ad18e8f2cf09e6bcf500
-  data.tar.gz: 2da5fc2973e6bdf27669d0ad75d15adc0528fb6b
+  metadata.gz: 021c91d45805fdda1343e0a89777d15e0a6d3390
+  data.tar.gz: 4228d3820ed9b39bf2a6a918ffa91019ce7594a8
 SHA512:
-  metadata.gz: 85267fc0953084589bea06b92d87d8168e134abb4aef3d957db2d7376fbdaf205a8a1beb30e8ead63e3151813a17823737f7f3bea51b3cdc0bd45d2bb542007f
-  data.tar.gz: 293affd8f01969bc1555f0992c8f46b91034f4301f99633bcc5e69555b99eb5e4ffafa21f0ec58631839ee6a899fd7bebd0cfeb5a44651e4b8ec04cb36fb6a56
+  metadata.gz: f87e0b91e15b1433791b883256e16e2f3d72edf246ea1654e4d7bc10f8044af9b4b32de255d6a93a887a6a6fdc90708bfd6edfd40522eb58c9ea3bdeeb345756
+  data.tar.gz: bb96dd388b742aefe4d72b1568325e3797524dd01023f5f17f347743e85108cad3ae798a652aad37c9a089e0c619d9663987ab374235529f72fcecef85c801d5

data/app/assets/stylesheets/help_kit/application.scss

@@ -16,6 +16,7 @@
 @import "header";
 @import "syntax";
 @import "search";
+@import "flash";
 
 @import "admin/categories";
 @import "landing";

data/app/assets/stylesheets/help_kit/article.scss

@@ -94,7 +94,6 @@
   }
 }
 .article {
-
   font-size: 0.9em;
   h1 {
     font-family: 'Open Sans', sans-serif;

data/app/assets/stylesheets/help_kit/flash.scss

@@ -0,0 +1,25 @@
+.info {
+  text-align: right;
+  padding: 5px 8px;
+  font-weight: normal;
+  font-size: 0.8em;
+  margin-bottom: 10px;
+  border-radius: 4px;
+  &.warn {
+    $color: #F9F6CC;
+    color: darken($color, 60);
+  }
+}
+$flash-success-color: #DDF9DE;
+
+.flash {
+  padding: 5px 8px;
+  font-weight: 600;
+  font-size: 0.8em;
+  border-bottom: 1px solid;
+  &.success {
+    background-color: $flash-success-color;
+    border-color: darken($flash-success-color, 20);
+    color: darken($flash-success-color, 70);
+  }
+}

data/app/controllers/help_kit/admin/categories_controller.rb

@@ -5,6 +5,8 @@ module HelpKit
     layout 'help_kit/admin'
     before_action :set_category, only: [:show, :edit, :update, :destroy]
 
+    before_action :check_authorization
+
     def index
       @categories = Category.roots
     end
@@ -46,5 +48,12 @@ module HelpKit
     def category_params
       params.require(:category).permit(:name, :parent_id, :header_content)
     end
+
+    def check_authorization
+      unless HelpKit.is_authorized?
+        redirect_to landing_path
+        return false
+      end
+    end
   end
 end

data/app/controllers/help_kit/application_controller.rb

@@ -1,12 +1,5 @@
 module HelpKit
   class ApplicationController < ActionController::Base
-
-
     private
-
-    def is_authorized?
-      self.instance_exec(&HelpKit.authorization_method)
-    end
-    helper_method :is_authorized?
   end
 end

data/app/controllers/help_kit/articles_controller.rb

@@ -1,25 +1,27 @@
 require_dependency "help_kit/application_controller"
 module HelpKit
   class ArticlesController < ApplicationController
+
     rescue_from ActiveRecord::RecordNotFound, :with => :not_found
-    before_action :set_article, only: [:show, :edit, :update]
+    before_action :set_article,
+      only: [:show, :edit, :update, :destroy, :publish, :unpublish]
+
+    before_action :check_authorization,
+      only: [ :new, :create, :edit, :update, :destroy, :publish, :unpublish]
 
     layout 'help_kit/minimal'
 
 
     def index_category
       @category = Category.friendly.find(params[:category])
-      @articles = Article.for_category(@category)
+      @articles = Article.published.for_category(@category)
     end
 
     def search
       @articles = Article.search(params[:search][:query])
     end
 
-
-    def show
-        render 'show'
-    end
+    def show; end
 
     def new
       @article = Article.new(title: params[:title])
@@ -34,9 +36,7 @@ module HelpKit
       end
     end
 
-    def edit
-      render 'edit'
-    end
+    def edit; end
 
     def update
       if @article.update(article_params)
@@ -46,15 +46,39 @@ module HelpKit
       end
     end
 
+    def destroy
+      if @article.destroy
+        flash[:success] = "Article deleted."
+        redirect_to admin_landing_path
+      end
+    end
+
+    def publish
+      @article.publish!
+      flash[:success] = "Article published. It will now be viewable."
+      redirect_to article_path(@article)
+    end
+
+    def unpublish
+      @article.unpublish!
+      flash[:success] = "Article unpublished. This article will no longer be visible"
+      redirect_to article_path(@article)
+    end
+
     private
 
     def not_found
       @article = Article.new(title: params[:title])
       render 'not_found'
+      return false
     end
 
     def set_article
-      @article = Article.friendly.find(params[:id])
+      if HelpKit.is_authorized?
+        @article = Article.friendly.find(params[:id])
+      else
+        @article = Article.published.friendly.find(params[:id])
+      end
     end
 
     def article_params
@@ -66,5 +90,12 @@ module HelpKit
       )
     end
 
+    def check_authorization
+      unless HelpKit.is_authorized?
+        redirect_to article_path(Article.friendly.find(params[:id]))
+        return false
+      end
+    end
+
   end
 end

data/app/models/help_kit/article.rb

@@ -12,7 +12,6 @@ module HelpKit
     validates :title, presence: true
     validates :content, presence: true
 
-
     scope :for_category, -> (category) {
       where(category: category.self_and_descendants.pluck(:id))
     }
@@ -23,9 +22,23 @@ module HelpKit
       where('title LIKE :q OR content LIKE :q OR description LIKE :q',
             q: "%#{query}%")
     }
+    scope :published, -> { where(published: true) }
+    scope :unpublished, -> { where(published: [false, nil]) }
 
     def should_generate_new_friendly_id?
         title_changed?
     end
+
+    def is_published?
+      published
+    end
+
+    def publish!
+      self.update(published:true, published_at: Time.current)
+    end
+
+    def unpublish!
+      self.update(published:false, published_at: nil)
+    end
   end
 end

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

@@ -1,15 +1,23 @@
+h2 Unpublished articles
+.article-list
+  = render HelpKit::Article.unpublished
+hr/
+
 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

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

@@ -2,6 +2,9 @@
   =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'
+  -unless @article.new_record?
+    =link_to icon('trash', 'Delete'), article_path(@article),
+      method: 'delete', class: 'delete-article'
 =text_field_tag :article_title_temp, @article.title, class: 'article-title',
   placeholder: 'Article Title'
 

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

@@ -1,9 +1,22 @@
 -content_for :title, @article.title
 -content_for :submenu do
-  =link_to icon('edit', 'Edit Article'), help_kit.edit_article_path(@article),
-    class: 'edit-article'
+  -if HelpKit.is_authorized?
+    = link_to icon('edit', 'Edit Article'), help_kit.edit_article_path(@article),
+      class: 'edit-article'
+    - if @article.is_published?
+      = link_to icon('share', 'Unpublish'),
+        help_kit.unpublish_article_path(@article),
+        class: 'unpublish-article'
+    - else
+      = link_to icon('share', 'Publish'),
+        help_kit.publish_article_path(@article),
+        class: 'publish-article'
+
 .page-container
   .article-container
+    - unless @article.is_published?
+      .info.warn
+        = icon('info', 'This article has not been published')
     .article-header
       -if @article.category
         .breadcrumb
@@ -21,4 +34,8 @@
             .tag =link_to tag.name, ''
       .inline-detail
         .inline-title last updated
-        span =time_ago_in_words @article.updated_at.to_s(:short)
+        span =time_ago_in_words @article.updated_at
+        -if HelpKit.is_authorized? && @article.is_published?
+          .inline-detail
+            .inline-title published at
+            span =time_ago_in_words @article.published_at

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

@@ -8,11 +8,14 @@ html
   body
     = render 'help_kit/admin/nav'
     .submenu =yield :submenu
-
+    - if flash[:success].present?
+      .flash.success =flash[:success]
     .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')
+          =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/minimal.html.slim

@@ -10,10 +10,12 @@ html
     = csrf_meta_tags
   body.minimal
     = render 'help_kit/nav'
-    - if is_authorized?
+    - if HelpKit.is_authorized?
       .submenu
         =yield :submenu
         =link_to icon('plus', 'New Article'), new_article_path
         =link_to icon('cog', 'Settings'), admin_landing_path
+    - if flash[:success].present?
+      .flash.success =flash[:success]
     = yield
   .site-footer powered by HelpKit

data/config/routes.rb

@@ -15,7 +15,11 @@ HelpKit::Engine.routes.draw do
   get 'new' => 'articles#new', :as => :new_article
   post 'new' => 'articles#create'
   get 'edit/:id' =>  'articles#edit', :as => :edit_article
+  get 'publish/:id' => 'articles#publish', :as => :publish_article
+  get 'unpublish/:id' => 'articles#unpublish', :as => :unpublish_article
   get ':id' => 'articles#show', :as => :article
   patch ':id' => 'articles#update'
+  delete ':id' => 'articles#destroy'
+
 
 end

data/lib/help_kit.rb

@@ -15,4 +15,7 @@ require 'pygmentize'
 require 'help_kit/configuration.rb'
 
 module HelpKit
+  def self.is_authorized?
+    self.instance_exec(&HelpKit.authorization_method)
+  end
 end

data/lib/help_kit/version.rb

@@ -1,3 +1,3 @@
 module HelpKit
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/controllers/help_kit/admin/categories_controller_spec.rb

@@ -2,87 +2,134 @@ require 'rails_helper'
 
 module HelpKit
   RSpec.describe Admin::CategoriesController, :type => :controller do
-
-    describe "#index" do
-      let(:category) { create(:category) }
+    let(:category) { create(:category) }
+    context "authorized" do
       before {
-        create(:category, parent_id:category.id)
-        get :index
+        allow(HelpKit).to receive(:is_authorized?)
+          .and_return(true)
       }
-      it "should assing @categories" do
-        expect(assigns(:categories)).to eq([category])
+      describe "#index" do
+        before {
+          create(:category, parent_id:category.id)
+          get :index
+        }
+        it "should assing @categories" do
+          expect(assigns(:categories)).to eq([category])
+        end
+        it "should not contain sub category" do
+          expect(assigns(:categories).count).to eq(1)
+        end
+        it { should render_template('index') }
       end
-      it "should not contain sub category" do
-        expect(assigns(:categories).count).to eq(1)
+
+      describe "#new" do
+        before { get :new }
+        it "should assing @categories" do
+          expect(assigns(:category)).to be_a_new(Category)
+        end
+        it { should render_template('new') }
       end
-      it { should render_template('index') }
-    end
 
-    describe "#new" do
-      before {get :new}
-      it "should assing @categories" do
-        expect(assigns(:category)).to be_a_new(Category)
+      describe "#create" do
+        let(:attributes) {{ category: attributes_for(:category) }}
+        context "with valid attributes" do
+          it "should redirect to category list" do
+            post :create, attributes
+            expect(response).to redirect_to(admin_categories_path)
+          end
+          it "should create category record" do
+            expect {
+              post :create, attributes
+            }.to change(Category, :count).by(1)
+          end
+        end
+        context "with invalid attributes" do
+          before do
+            expect_any_instance_of(Category).to receive(:save) { false }
+          end
+          it "should render new template" do
+            post :create, attributes
+            expect(response).to render_template('new')
+          end
+          it "should assign @category" do
+            post :create, attributes
+            expect(assigns(:category)).to be_a_new(Category)
+          end
+          it "should not create database record" do
+            expect {
+              post :create, attributes
+            }.to change(Category, :count).by(0)
+          end
+        end
       end
-      it { should render_template('new') }
-    end
 
-    describe "#create" do
-      let(:attributes) {{ category: attributes_for(:category) }}
-      context "with valid attributes" do
-        before do
-          post :create, attributes
+      describe "#edit" do
+        before { get :edit, id: category.id }
+        it { should render_template('edit') }
+        it "should assing @category" do
+          expect(assigns(:category)).to eq(category)
         end
-        it { should redirect_to admin_categories_path }
       end
-      context "with invalid attributes" do
-        before do
-          expect_any_instance_of(Category).to receive(:save) { false }
-          post :create, attributes
+
+      describe "#update" do
+        let(:attributes) {{ category: attributes_for(:category), id: category.id}}
+        context "with valid attributes" do
+          it "should call update on record" do
+            expect_any_instance_of(Category).to receive(:update) {true}
+            patch :update, attributes
+          end
+          it "should redirect to index" do
+            patch :update, attributes
+            expect(response).to redirect_to(admin_categories_path)
+          end
         end
-        it { should render_template('new') }
-        it "should assign @category" do
-          expect(assigns(:category)).to be_a_new(Category)
+        context "with invalid attributes do" do
+          before do
+            expect_any_instance_of(Category).to receive(:update) {false}
+            patch :update, attributes
+          end
+          it { should render_template('edit') }
         end
       end
-    end
 
-    describe "#edit" do
-      let(:category) { create(:category) }
-      before { get :edit, id: category.id }
-      it { should render_template('edit') }
-      it "should assing @category" do
-        expect(assigns(:category)).to eq(category)
-      end
-    end
-    describe "#update" do
-      let(:category) { create :category }
-      let(:attributes) {{ category: attributes_for(:category), id: category.id}}
-      context "with valid attributes" do
-        it "should call update on record" do
-          expect_any_instance_of(Category).to receive(:update) {true}
-          patch :update, attributes
+      describe "#destroy" do
+        it "should receive #destroy" do
+          expect_any_instance_of(Category).to receive(:destroy) { true }
+          delete :destroy, id: category.id
         end
-        it "should redirect to index" do
-          patch :update, attributes
+        it "should redirect to category list" do
+          delete :destroy, id: category.id
           expect(response).to redirect_to(admin_categories_path)
         end
       end
-      context "with invalid attributes do" do
-        before do
-          expect_any_instance_of(Category).to receive(:update) {false}
-          patch :update, attributes
-        end
-        it { should render_template('edit') }
-      end
+
     end
 
-    describe "#destroy" do
-      let(:category) { create :category }
-      it "should receive #destroy" do
-        expect_any_instance_of(Category).to receive(:destroy) { true }
-        delete :destroy, id: category.id
+    context "unauthorized" do
+      before {
+        allow(HelpKit).to receive(:is_authorized?)
+          .and_return(false)
+      }
+      let(:attributes) {{
+        id: category.id,
+        category: attributes_for(:category)
+      }}
+      %w{index edit update new create destroy}.each do |action|
+        describe "##{action}" do
+          before {
+            if %w{index edit new}.include? action
+              get action.to_sym, attributes
+            end
+            if %w{update create}.include? action
+              post action.to_sym, attributes
+            end
+            if action == 'destroy'
+              delete :destroy, attributes
+            end
+          }
+          it { should redirect_to landing_path }
+        end
       end
     end
-
   end
 end