knowledge_base 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38e4e16f46ef1177b0e10c1b766ef129cc048e1f
+  data.tar.gz: 67ee73a4192942beb16046819390f5a4a254ef64
+SHA512:
+  metadata.gz: 2c2a9d4670ade1caeec6f06c3dd5c7951a77337703402d53762de1fc7f9022f5bcb32e5bef01444ead630c4b4b6ab4ffd27b24ca6c719edecf2e2e9d8f2bd239
+  data.tar.gz: 55ec149fc0c0ae60a07ad90b4861f68cbc76718f7ccdd3de8e0031f6d4c146802359a063f9ed8ae584f9f07abfd4d6a82123e7eb325d9627a2415b29c23d4b98

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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/Rakefile

@@ -0,0 +1,28 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Mingle'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc 'Run all specs in spec directory (excluding plugin specs)'
+RSpec::Core::RakeTask.new spec: 'app:db:test:prepare'
+
+task default: :spec

data/app/assets/javascripts/knowledge_base/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/knowledge_base/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/knowledge_base/application_controller.rb

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

data/app/controllers/knowledge_base/articles_controller.rb

@@ -0,0 +1,17 @@
+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
+  end
+end

data/app/controllers/knowledge_base/categories_controller.rb

@@ -0,0 +1,13 @@
+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
+  end
+end

data/app/helpers/knowledge_base/application_helper.rb

@@ -0,0 +1,4 @@
+module KnowledgeBase
+  module ApplicationHelper
+  end
+end

data/app/models/knowledge_base/article.rb

@@ -0,0 +1,13 @@
+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
+  end
+end

data/app/models/knowledge_base/category.rb

@@ -0,0 +1,16 @@
+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 }
+  end
+end

data/app/models/knowledge_base/category_article_association.rb

@@ -0,0 +1,6 @@
+module KnowledgeBase
+  class CategoryArticleAssociation < ActiveRecord::Base
+    belongs_to :category
+    belongs_to :article
+  end
+end

data/app/models/knowledge_base/section.rb

@@ -0,0 +1,9 @@
+module KnowledgeBase
+  class Section < ActiveRecord::Base
+    # It sounds wrong that a section "belongs to" a sectionable, but we want the foreign
+    # key to be on this side and declaring `belongs_to` is the only way to do that.
+    belongs_to :sectionable, polymorphic: true
+
+    belongs_to :container, polymorphic: true
+  end
+end

data/app/models/knowledge_base/sectionables.rb

@@ -0,0 +1,7 @@
+module KnowledgeBase
+  module Sectionables
+    def self.table_name_prefix
+      'knowledge_base_sectionables_'
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module KnowledgeBase
+  class Sectionables::Gallery < ActiveRecord::Base
+    has_many :images, -> { order 'position DESC' }
+  end
+end

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

@@ -0,0 +1,7 @@
+module KnowledgeBase
+  class Sectionables::Gallery::Image < ActiveRecord::Base
+    belongs_to :gallery
+
+    mount_uploader :image, ImageUploader
+  end
+end

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

@@ -0,0 +1,5 @@
+module KnowledgeBase
+  class Sectionables::Image < ActiveRecord::Base
+    mount_uploader :image, ImageUploader
+  end
+end

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

@@ -0,0 +1,5 @@
+module KnowledgeBase
+  class Sectionables::Links < ActiveRecord::Base
+    has_many :links
+  end
+end

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

@@ -0,0 +1,10 @@
+module KnowledgeBase
+  class Sectionables::Links::Link < ActiveRecord::Base
+    # ActiveRecord assumes our table will be called 'knowledge_base_sectionables_link_links'
+    # because it likes to singularize modules. 'Links' It is not a module, however, but rather
+    # a class that represents a collection of links.
+    self.table_name = 'knowledge_base_sectionables_links_links'
+
+    belongs_to :links
+  end
+end

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

@@ -0,0 +1,5 @@
+module KnowledgeBase
+  class Sectionables::List < ActiveRecord::Base
+    has_many :items, -> { order 'position ASC' }
+  end
+end

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

@@ -0,0 +1,5 @@
+module KnowledgeBase
+  class Sectionables::List::Item < ActiveRecord::Base
+    belongs_to :list
+  end
+end

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

@@ -0,0 +1,4 @@
+module KnowledgeBase
+  class Sectionables::Text < ActiveRecord::Base
+  end
+end

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

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

data/app/uploaders/knowledge_base/image_uploader.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+module KnowledgeBase
+  class ImageUploader < CarrierWave::Uploader::Base
+
+    # Include RMagick or MiniMagick support:
+    # include CarrierWave::RMagick
+    # include CarrierWave::MiniMagick
+
+    # 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:
+    def store_dir
+      "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+    end
+
+    # Provide a default URL as a default if there hasn't been a file uploaded:
+    # def default_url
+    #   # For Rails 3.1+ asset pipeline compatibility:
+    #   # ActionController::Base.helpers.asset_path("fallback/" + [version_name, "default.png"].compact.join('_'))
+    #
+    #   "/images/fallback/" + [version_name, "default.png"].compact.join('_')
+    # end
+
+    # Process files as they are uploaded:
+    # process :scale => [200, 300]
+    #
+    # def scale(width, height)
+    #   # do something
+    # end
+
+    # Create different versions of your uploaded files:
+    # version :thumb do
+    #   process :resize_to_fit => [50, 50]
+    # end
+
+    # Add a white list of extensions which are allowed to be uploaded.
+    # For images you might use something like this:
+    # def extension_white_list
+    #   %w(jpg jpeg gif png)
+    # end
+
+    # Override the filename of the uploaded files:
+    # Avoid using model.id or version_name here, see uploader/store.rb for details.
+    # def filename
+    #   "something.jpg" if original_filename
+    # end
+
+  end
+end

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

@@ -0,0 +1,11 @@
+<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>

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

@@ -0,0 +1,11 @@
+<h1>Categories</h1>
+
+<div class="categories">
+  <% @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>
+  <% end %>
+</div>

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

@@ -0,0 +1,15 @@
+<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>

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

@@ -0,0 +1,17 @@
+<h1 class="title"><%= gallery.title %></h1>
+
+<div class="description">
+  <%= simple_format gallery.description %>
+</div>
+
+<div class="images">
+  <% gallery.images.each do |image| %>
+    <div class="image">
+      <%= image_tag image.image %>
+
+      <div class="caption">
+        <%= simple_format image.caption %>
+      </div>
+    </div>
+  <% end %>
+</div>

data/app/views/knowledge_base/sectionables/images/_image.html.erb

@@ -0,0 +1,5 @@
+<%= image_tag image.image %>
+
+<p class="caption">
+  <%= image.caption %>
+</p>

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

@@ -0,0 +1,5 @@
+<nav class="links">
+  <% links.links.each do |link| %>
+    <%= link_to link.title, link.url %>
+  <% end %>
+</div>

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

@@ -0,0 +1,17 @@
+<h1 class="title"><%= list.title %></h1>
+
+<div class="description">
+  <%= simple_format list.description %>
+</div>
+
+<ul class="items">
+  <% list.items.each do |item| %>
+    <li class="item">
+      <h2><%= item.title %></h2>
+
+      <div class="body">
+        <%= simple_format item.body %>
+      </div>
+    </li>
+  <% end %>
+</div>

data/app/views/knowledge_base/sectionables/texts/_text.html.erb

@@ -0,0 +1,9 @@
+<h2 class="heading"><%= text.heading %></h2>
+
+<div class="lead">
+  <%= simple_format text.lead %>
+</div>
+
+<div class="body">
+  <%= simple_format text.body %>
+</div>

data/app/views/knowledge_base/sectionables/videos/_video.html.erb

@@ -0,0 +1 @@
+<iframe width="420" height="315" src="//www.youtube.com/embed/<%= video.youtube_id %>" frameborder="0" allowfullscreen></iframe>

data/app/views/layouts/knowledge_base/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>KnowledgeBase</title>
+  <%= stylesheet_link_tag    "knowledge_base/application", media: "all" %>
+  <%= javascript_include_tag "knowledge_base/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>