knowledge_base 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38e4e16f46ef1177b0e10c1b766ef129cc048e1f
-  data.tar.gz: 67ee73a4192942beb16046819390f5a4a254ef64
+  metadata.gz: 902f665c6b7069b91bfb814f3ac35a037b84dba8
+  data.tar.gz: b07ccea2e4bbd55331fdf4450e7f2f3ae854d755
 SHA512:
-  metadata.gz: 2c2a9d4670ade1caeec6f06c3dd5c7951a77337703402d53762de1fc7f9022f5bcb32e5bef01444ead630c4b4b6ab4ffd27b24ca6c719edecf2e2e9d8f2bd239
-  data.tar.gz: 55ec149fc0c0ae60a07ad90b4861f68cbc76718f7ccdd3de8e0031f6d4c146802359a063f9ed8ae584f9f07abfd4d6a82123e7eb325d9627a2415b29c23d4b98
+  metadata.gz: 2b61a7f8da04f0203a213b49057ef44d4b4eb9901af0468000378bc475a0262322784b32b6b29897309b1f09fc9ead01e2dab5102785e53ab401dea25d625e72
+  data.tar.gz: 95974a702dcf790fa2a60d5f974fad3963c02817242c2b5121668354a1fdab44546b5840db151a61f4e4979a5cdf23beef122f9b556fe98c0e360f89436880c7

data/app/controllers/knowledge_base/application_controller.rb

@@ -1,4 +1,4 @@
 module KnowledgeBase
-  class ApplicationController < ActionController::Base
+  class ApplicationController < ::ApplicationController
   end
 end

data/app/controllers/knowledge_base/articles_controller.rb

@@ -2,16 +2,6 @@ require_dependency "knowledge_base/application_controller"
 
 module KnowledgeBase
   class ArticlesController < ApplicationController
-    before_action :set_category
-
-    def show
-      @article = @category.articles.friendly.find params[:id]
-    end
-
-    private
-
-    def set_category
-      @category = Category.friendly.find params[:category_id]
-    end
+    include Concerns::Controllers::ArticlesController
   end
 end

data/app/controllers/knowledge_base/categories_controller.rb

@@ -2,12 +2,6 @@ require_dependency "knowledge_base/application_controller"
 
 module KnowledgeBase
   class CategoriesController < ApplicationController
-    def index
-      @categories = Category.all
-    end
-
-    def show
-      @category = Category.friendly.find params[:id]
-    end
+    include Concerns::Controllers::CategoriesController
   end
 end

data/app/models/knowledge_base/article.rb

@@ -1,13 +1,5 @@
 module KnowledgeBase
   class Article < ActiveRecord::Base
-    extend FriendlyId
-
-    publishable
-
-    friendly_id :title, use: :slugged
-
-    has_many :category_article_associations
-    has_many :categories, through: :category_article_associations
-    has_many :sections, -> { order 'position ASC' }, as: :container
+    include Concerns::Models::Article
   end
 end

data/app/models/knowledge_base/category.rb

@@ -1,16 +1,5 @@
 module KnowledgeBase
   class Category < ActiveRecord::Base
-    extend FriendlyId
-
-    publishable
-
-    friendly_id :title, use: :slugged
-
-    belongs_to :category
-    has_many :category_article_associations
-    has_many :articles, through: :category_article_associations
-
-    scope :root, -> { where parent_id: nil }
-    scope :published, -> { where published: true }
+    include Concerns::Models::Category
   end
 end

data/app/models/knowledge_base/sectionables/gallery.rb

@@ -1,5 +1,9 @@
-module KnowledgeBase
-  class Sectionables::Gallery < ActiveRecord::Base
+module KnowledgeBase::Sectionables
+  class Gallery < Sectionable
     has_many :images, -> { order 'position DESC' }
+
+    def to_s
+      "#{super}: #{title}"
+    end
   end
 end

data/app/models/knowledge_base/sectionables/image.rb

@@ -1,5 +1,9 @@
-module KnowledgeBase
-  class Sectionables::Image < ActiveRecord::Base
+module KnowledgeBase::Sectionables
+  class Image < Sectionable
     mount_uploader :image, ImageUploader
+
+    def to_s
+      "#{super}: #{caption}"
+    end
   end
 end

data/app/models/knowledge_base/sectionables/links.rb

@@ -1,5 +1,9 @@
-module KnowledgeBase
-  class Sectionables::Links < ActiveRecord::Base
+module KnowledgeBase::Sectionables
+  class Links < Sectionable
     has_many :links
+
+    def to_s
+      "#{super}: #{links.map(&:title).join(', ')}"
+    end
   end
 end

data/app/models/knowledge_base/sectionables/list.rb

@@ -1,5 +1,9 @@
-module KnowledgeBase
-  class Sectionables::List < ActiveRecord::Base
+module KnowledgeBase::Sectionables
+  class List < Sectionable
     has_many :items, -> { order 'position ASC' }
+
+    def to_s
+      "#{super}: #{title}"
+    end
   end
 end

data/app/models/knowledge_base/sectionables/sectionable.rb

@@ -0,0 +1,9 @@
+module KnowledgeBase::Sectionables
+  class Sectionable < ActiveRecord::Base
+    self.abstract_class = true
+
+    def to_s
+      self.class.model_name.human
+    end
+  end
+end

data/app/models/knowledge_base/sectionables/text.rb

@@ -1,4 +1,7 @@
-module KnowledgeBase
-  class Sectionables::Text < ActiveRecord::Base
+module KnowledgeBase::Sectionables
+  class Text < Sectionable
+    def to_s
+      "#{super}: #{heading}"
+    end
   end
 end

data/app/models/knowledge_base/sectionables/video.rb

@@ -1,9 +1,13 @@
-module KnowledgeBase
-  class Sectionables::Video < ActiveRecord::Base
+module KnowledgeBase::Sectionables
+  class Video < Sectionable
     VIDEO_ID_EXPRESSION = %r{^https?://(?:(?:www|m)\.)?youtube\.com/watch\?v=([^&]+)}
 
     def youtube_id
       url[VIDEO_ID_EXPRESSION, 1]
     end
+
+    def to_s
+      "#{super}: #{url}"
+    end
   end
 end

data/app/uploaders/knowledge_base/image_uploader.rb

@@ -9,7 +9,6 @@ module KnowledgeBase
 
     # Choose what kind of storage to use for this uploader:
     storage KnowledgeBase.config.storage
-    # storage :fog
 
     # Override the directory where uploaded files will be stored.
     # This is a sensible default for uploaders that are meant to be mounted:

data/app/views/knowledge_base/articles/_article.html.erb

@@ -0,0 +1,17 @@
+<div class="article">
+  <div class="meta">
+    <h1 class="title"><%= article.title %></h1>
+
+    <div class="description">
+      <%= simple_format article.description %>
+    </div>
+  </div>
+
+  <div class="sections">
+    <% article.sections.each do |section| %>
+    <div class="<%= section.sectionable.class.name.demodulize.downcase %> section">
+      <%= render section.sectionable %>
+    </div>
+    <% end %>
+  </div>
+</div>

data/app/views/knowledge_base/articles/show.html.erb

@@ -1,11 +1 @@
-<h1 class="title"><%= @article.title %></h1>
-
-<div class="description">
-  <%= simple_format @article.description %>
-
-  <% @article.sections.each do |section| %>
-    <div class="<%= section.sectionable.class.name.demodulize.downcase %> section">
-      <%= render section.sectionable %>
-    </div>
-  <% end %>
-</div>
+<%= render @article %>

data/app/views/knowledge_base/categories/_category.html.erb

@@ -0,0 +1,19 @@
+<div class="category">
+  <div class="meta">
+    <h1 class="title"><%= category.title %></h1>
+
+    <div class="description">
+      <%= simple_format category.description %>
+    </div>
+  </div>
+
+  <div class="articles">
+    <% category.articles.each do |article| %>
+    <div class="article">
+      <h2 class="title"><%= link_to article.title, category_article_path(category, article) %></h2>
+
+      <div class="description"><%= simple_format article.description %></div>
+    </div>
+    <% end %>
+  </div>
+</div>

data/app/views/knowledge_base/categories/index.html.erb

@@ -1,11 +1,13 @@
-<h1>Categories</h1>
-
 <div class="categories">
-  <% @categories.each do |category| %>
-  <div class="category">
-    <h2 class="title"><%= link_to category.title, category %></h2>
+  <h1>Categories</h1>
+
+  <div class="list">
+    <% @categories.each do |category| %>
+    <div class="category">
+      <h2 class="title"><%= link_to category.title, category %></h2>
 
-    <div class="description"><%= simple_format category.description %></div>
+      <div class="description"><%= simple_format category.description %></div>
+    </div>
+    <% end %>
   </div>
-  <% end %>
 </div>

data/app/views/knowledge_base/categories/show.html.erb

@@ -1,15 +1 @@
-<h1 class="title"><%= @category.title %></h1>
-
-<div class="description">
-  <%= simple_format @category.description %>
-</div>
-
-<div class="articles">
-  <% @category.articles.each do |article| %>
-  <div class="article">
-    <h2 class="title"><%= link_to article.title, category_article_path(@category, article) %></h2>
-
-    <div class="description"><%= simple_format article.description %></div>
-  </div>
-  <% end %>
-</div>
+<%= render @category %>

data/app/views/knowledge_base/sectionables/galleries/_gallery.html.erb

@@ -1,4 +1,4 @@
-<h1 class="title"><%= gallery.title %></h1>
+<h2 class="title"><%= gallery.title %></h2>
 
 <div class="description">
   <%= simple_format gallery.description %>

data/app/views/knowledge_base/sectionables/links/_links.html.erb

@@ -2,4 +2,4 @@
   <% links.links.each do |link| %>
     <%= link_to link.title, link.url %>
   <% end %>
-</div>
+</nav>

data/app/views/knowledge_base/sectionables/lists/_list.html.erb

@@ -1,4 +1,4 @@
-<h1 class="title"><%= list.title %></h1>
+<h2 class="title"><%= list.title %></h2>
 
 <div class="description">
   <%= simple_format list.description %>
@@ -14,4 +14,4 @@
       </div>
     </li>
   <% end %>
-</div>
+</ul>

data/config/initializers/routing.rb

@@ -0,0 +1,15 @@
+module KnowledgeBase
+  module ApplicationHelper
+
+    # Knowledge base uses the layout of the client application, which causes Rails' url helpers to get confused
+    # and require you to prepend 'main_app' to your own routes. This hack allows developers to keep referring to
+    # routes without a prefix by sending undefined routes to 'main_app' before failing.
+    def method_missing(method, *args, &block)
+      if (method.to_s.end_with?('_path') || method.to_s.end_with?('_url')) && main_app.respond_to?(method)
+        main_app.send(method, *args)
+      else
+        super
+      end
+    end
+  end
+end

data/config/locales/nb.yml

@@ -0,0 +1,49 @@
+nb:
+  activerecord:
+    models:
+      knowledge_base/category:
+        one: Kategori
+        other: Kategorier
+      knowledge_base/article:
+        one: Artikkel
+        other: Artikler
+      knowledge_base/category_article_association:
+        one: Lenke
+        other: Lenker
+      knowledge_base/section:
+        one: Seksjon
+        other: Seksjoner
+    attributes:
+      knowledge_base/category:
+        title: Tittel
+        slug: Slug
+        description: Beskrivelse
+        category: Kategori
+        category_id: Kategori
+        position: Plassering
+        published_at: Publisert
+        created_at: Opprettet
+        updated_at: Oppdatert
+      knowledge_base/article:
+        title: Tittel
+        slug: slug
+        description: Beskrivelse
+        category_article_assocations: Lenker mellom kategorier og artikler
+        categories: Kategorier
+        sections: Seksjoner
+        published_at: Publisert
+        created_at: Opprettet
+        updated_at: Oppdatert
+      knowledge_base/category_article_association:
+        category: Kategori
+        category_id: Kategori
+        article: Artikkel
+        article_id: Artikkel
+        position: Plassering
+        created_at: Opprettet
+        updated_at: Oppdatert
+      knowledge_base/section:
+        sectionable: Innhold
+        position: Plassering
+        created_at: Opprettet
+        updated_at: Oppdatert

data/config/routes.rb

@@ -1,5 +1,5 @@
 KnowledgeBase::Engine.routes.draw do
-  resources :categories, only: [:index, :show] do
-    resources :articles, only: [:show]
+  resources :categories, path: KnowledgeBase.config.categories_path, only: [:index, :show] do
+    resources :articles, path: KnowledgeBase.config.articles_path, only: [:show]
   end
 end

data/lib/knowledge_base.rb

@@ -1,5 +1,6 @@
 require "knowledge_base/engine"
 require "knowledge_base/configuration"
+require "knowledge_base/concerns"
 require "carrierwave"
 
 module KnowledgeBase
@@ -11,5 +12,9 @@ module KnowledgeBase
     def config
       @config ||= KnowledgeBase::Configuration.new
     end
+
+    def reset
+      @config = nil
+    end
   end
 end

data/lib/knowledge_base/concerns.rb

@@ -0,0 +1,4 @@
+module KnowledgeBase::Concerns
+  require 'knowledge_base/concerns/models'
+  require 'knowledge_base/concerns/controllers'
+end

data/lib/knowledge_base/concerns/controllers.rb

@@ -0,0 +1,4 @@
+module KnowledgeBase::Concerns::Controllers
+  require 'knowledge_base/concerns/controllers/categories_controller'
+  require 'knowledge_base/concerns/controllers/articles_controller'
+end

data/lib/knowledge_base/concerns/controllers/articles_controller.rb

@@ -0,0 +1,19 @@
+module KnowledgeBase
+  module Concerns::Controllers::ArticlesController
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :set_category
+
+      def show
+        @article = @category.articles.friendly.find params[:id]
+      end
+
+      private
+
+      def set_category
+        @category = Category.friendly.find params[:category_id]
+      end
+    end
+  end
+end

data/lib/knowledge_base/concerns/controllers/categories_controller.rb

@@ -0,0 +1,15 @@
+module KnowledgeBase
+  module Concerns::Controllers::CategoriesController
+    extend ActiveSupport::Concern
+
+    included do
+      def index
+        @categories = Category.all
+      end
+
+      def show
+        @category = Category.friendly.find params[:id]
+      end
+    end
+  end
+end