knowledge_base 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 902f665c6b7069b91bfb814f3ac35a037b84dba8
-  data.tar.gz: b07ccea2e4bbd55331fdf4450e7f2f3ae854d755
+  metadata.gz: 9cb5a753f0a330d1ecdc720b54f4d0110f0cd343
+  data.tar.gz: 520627e63ae829f121465e11c72483bc85bdeb94
 SHA512:
-  metadata.gz: 2b61a7f8da04f0203a213b49057ef44d4b4eb9901af0468000378bc475a0262322784b32b6b29897309b1f09fc9ead01e2dab5102785e53ab401dea25d625e72
-  data.tar.gz: 95974a702dcf790fa2a60d5f974fad3963c02817242c2b5121668354a1fdab44546b5840db151a61f4e4979a5cdf23beef122f9b556fe98c0e360f89436880c7
+  metadata.gz: b2a19eef373954ca57f9815dbf71d56bd92fa8f21f82a982bf823e63d587da2e38c3d3931e504e29fad27b9c439f7c33db661c2a812a78410d6aa2443bd45c4e
+  data.tar.gz: b110fa52196088f3e8cdd3be1ca30550dd05a88ba1af10ef2df55e5cc5b20be7dc7abf62ec58eb18a9f193d7114f03a89d415d00b0e77ba7e3fd7657a7f83048

data/Rakefile

@@ -1,3 +1,5 @@
+require 'thor'
+
 begin
   require 'bundler/setup'
 rescue LoadError
@@ -8,7 +10,7 @@ require 'rdoc/task'
 
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Mingle'
+  rdoc.title    = 'Knowledge Base'
   rdoc.options << '--line-numbers'
   rdoc.rdoc_files.include('README.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')

data/app/models/knowledge_base/category_article_association.rb

@@ -1,6 +1,5 @@
 module KnowledgeBase
   class CategoryArticleAssociation < ActiveRecord::Base
-    belongs_to :category
-    belongs_to :article
+    include Concerns::Models::CategoryArticleAssociation
   end
 end

data/app/models/knowledge_base/section.rb

@@ -1,9 +1,5 @@
 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
+    include Concerns::Models::Section
   end
 end

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

@@ -0,0 +1,7 @@
+module KnowledgeBase::Sectionables
+  module Attachments
+    def self.table_name_prefix
+      "knowledge_base_sectionables_attachments_"
+    end
+  end
+end

data/app/models/knowledge_base/sectionables/attachments/attachment.rb

@@ -0,0 +1,5 @@
+module KnowledgeBase
+  class Sectionables::Attachments::Attachment < ActiveRecord::Base
+    include Concerns::Models::Sectionables::Attachments::Attachment
+  end
+end

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

@@ -0,0 +1,5 @@
+module KnowledgeBase
+  class Sectionables::Attachments::List < Sectionables::Sectionable
+    include Concerns::Models::Sectionables::Attachments::List
+  end
+end

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

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

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

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

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

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

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

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

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

@@ -1,10 +1,5 @@
 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
+    include Concerns::Models::Sectionables::Links::Link
   end
 end

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

@@ -0,0 +1,5 @@
+module KnowledgeBase
+  class Sectionables::Links::List < Sectionables::Sectionable
+    include Concerns::Models::Sectionables::Links::List
+  end
+end

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

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

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

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

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

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

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

@@ -1,7 +1,5 @@
-module KnowledgeBase::Sectionables
-  class Text < Sectionable
-    def to_s
-      "#{super}: #{heading}"
-    end
+module KnowledgeBase
+  class Sectionables::Text < Sectionables::Sectionable
+    include Concerns::Models::Sectionables::Text
   end
 end

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

@@ -1,13 +1,5 @@
-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
+module KnowledgeBase
+  class Sectionables::Video < Sectionables::Sectionable
+    include Concerns::Models::Sectionables::Video
   end
 end

data/app/uploaders/knowledge_base/generic_file_uploader.rb

@@ -0,0 +1,7 @@
+module KnowledgeBase
+  class GenericFileUploader < CarrierWave::Uploader::Base
+    def store_dir
+      "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+    end
+  end
+end

data/app/uploaders/knowledge_base/image_uploader.rb

@@ -1,52 +1,4 @@
-# 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
-
-    # 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/_article.html.erb

@@ -9,9 +9,9 @@
 
   <div class="sections">
     <% article.sections.each do |section| %>
-    <div class="<%= section.sectionable.class.name.demodulize.downcase %> section">
-      <%= render section.sectionable %>
-    </div>
+      <div class="<%= section.sectionable.class.name.demodulize.downcase %> section <%= section.sectionable.style %>">
+        <%= render section.sectionable %>
+      </div>
     <% end %>
   </div>
 </div>

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

@@ -0,0 +1,6 @@
+<div class="search">
+  <%= search_form_for @search do |f| %>
+    <%= f.label :title_or_description_cont %>
+    <%= f.search_field :title_or_description_cont %>
+  <% end %>
+</div>

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

@@ -0,0 +1,11 @@
+<%= render "search" %>
+
+<div class="articles">
+  <% @articles.each do |article| %>
+  <div class="article">
+    <h2 class="title"><%= link_to article.title, article_path(article) %></h2>
+
+    <div class="description"><%= simple_format article.description %></div>
+  </div>
+  <% end %>
+</div>

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

@@ -8,9 +8,9 @@
   </div>
 
   <div class="articles">
-    <% category.articles.each do |article| %>
+    <% @articles.each do |article| %>
     <div class="article">
-      <h2 class="title"><%= link_to article.title, category_article_path(category, article) %></h2>
+      <h2 class="title"><%= link_to article.title, article_path(article) %></h2>
 
       <div class="description"><%= simple_format article.description %></div>
     </div>

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

@@ -0,0 +1,14 @@
+<section class="attachments">
+  <% list.attachments.each do |attachment| %>
+    <div class="link"><%= link_to attachment.title,
+      attachment.file.to_s,
+      download: File.basename(attachment.file.to_s) %>
+    </div>
+
+    <% if attachment.description.present? %>
+      <div class="description">
+        <%= simple_format attachment.description %>
+      </div>
+    <% end %>
+  <% end %>
+</section>

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

@@ -0,0 +1,13 @@
+<nav class="links">
+  <% list.links.each do |link| %>
+    <div class="link">
+      <%= link_to link.title, link.url %>
+    </div>
+
+    <% if link.description.present? %>
+      <div class="description">
+        <%= simple_format link.description %>
+      </div>
+    <% end %>
+  <% end %>
+</nav>

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

@@ -1,5 +1,9 @@
 <h2 class="title"><%= list.title %></h2>
 
+<% if list.image? %>
+  <%= image_tag list.image %>
+<% end %>
+
 <div class="description">
   <%= simple_format list.description %>
 </div>

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

@@ -1,5 +1,9 @@
 <h2 class="heading"><%= text.heading %></h2>
 
+<% if text.image? %>
+  <%= image_tag text.image %>
+<% end %>
+
 <div class="lead">
   <%= simple_format text.lead %>
 </div>

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

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

data/config/locales/en.yml

@@ -0,0 +1,131 @@
+en:
+  activerecord:
+    models:
+      knowledge_base/category:
+        one: Category
+        other: Categories
+      knowledge_base/article:
+        one: Article
+        other: Articles
+      knowledge_base/category_article_association:
+        one: Link
+        other: Links
+      knowledge_base/section:
+        one: Section
+        other: Sections
+      knowledge_base/sectionable:
+        one: Sectionable
+        other: Sectionables
+      knowledge_base/sectionables/attachments/attachment:
+        one: Attachment
+        other: Attachments
+      knowledge_base/sectionables/attachments/list:
+        one: Attachment list
+        other: Attachment lists
+      knowledge_base/sectionables/text:
+        one: Text
+        other: Texts
+      knowledge_base/sectionables/image:
+        one: Image
+        other: Images
+      knowledge_base/sectionables/gallery:
+        one: Gallery
+        other: Galleries
+      knowledge_base/sectionables/gallery/image:
+        one: Image
+        other: Images
+      knowledge_base/sectionables/list:
+        one: List
+        other: Lists
+      knowledge_base/sectionables/list/item:
+        one: List item
+        other: List items
+      knowledge_base/sectionables/links/list:
+        one: Link list
+        other: Link lists
+      knowledge_base/sectionables/links/link:
+        one: Link
+        other: Links
+      knowledge_base/sectionables/video:
+        one: Video
+        other: Videos
+
+    attributes:
+      common: &common
+        title: Title
+        slug: Slug
+        description: Description
+        position: Position
+        created_at: Created at
+        updated_at: Updated at
+
+      sectionables: &sectionables
+        style: Style
+
+      knowledge_base/category:
+        <<: *common
+        category: Category
+        category_id: Category
+        published_at: Published at
+      knowledge_base/article:
+        <<: *common
+        categories: Categories
+        category_article_assocations: Links between categories and articles
+        published_at: Published at
+        sections: Sections
+      knowledge_base/category_article_association:
+        <<: *common
+        article: Article
+        article_id: Article
+        category: Category
+        category_id: Category
+      knowledge_base/section:
+        <<: *common
+        sectionable: Sectionable
+        sectionable_type: Sectionable type
+      knowledge_base/sectionables/attachments/attachment:
+        <<: *common
+        file: File
+        title: Title
+      knowledge_base/sectionables/attachments/list:
+        <<: *common
+        <<: *sectionables
+        attachments: Attachments
+        file: File
+        title: Title
+      knowledge_base/sectionables/text:
+        <<: *common
+        <<: *sectionables
+        body: Body text
+        heading: Heading
+        lead: Lead paragraph
+        remove_image: Remove image
+      knowledge_base/sectionables/image:
+        <<: *common
+        <<: *sectionables
+        caption: Image caption
+        image: Image
+      knowledge_base/sectionables/gallery:
+        <<: *common
+        <<: *sectionables
+      knowledge_base/sectionables/gallery/image:
+        <<: *common
+        caption: Image caption
+        image: Image
+      knowledge_base/sectionables/list:
+        <<: *common
+        <<: *sectionables
+        remove_image: Remove image
+      knowledge_base/sectionables/list/item:
+        <<: *common
+        body: Body text
+      knowledge_base/sectionables/links/list:
+        <<: *common
+        <<: *sectionables
+      knowledge_base/sectionables/links/link:
+        <<: *common
+        url: URL
+      knowledge_base/sectionables/video:
+        <<: *common
+        <<: *sectionables
+        url: URL