knowledge_base 0.1.0 → 0.2.0

data/lib/knowledge_base/concerns/models/category.rb

@@ -9,13 +9,12 @@ module KnowledgeBase::Concerns::Models::Category
     friendly_id :title, use: :slugged
 
     belongs_to :category
-    has_many :category_article_associations
+    has_many :category_article_associations, -> { order 'position ASC' }
     has_many :articles, through: :category_article_associations
 
-    accepts_nested_attributes_for :category_article_associations
+    accepts_nested_attributes_for :category_article_associations, allow_destroy: true
 
     scope :root, -> { where parent_id: nil }
-    scope :published, -> { where published: true }
 
     def to_s
       title

data/lib/knowledge_base/concerns/models/category_article_association.rb

@@ -0,0 +1,8 @@
+module KnowledgeBase::Concerns::Models::CategoryArticleAssociation
+  extend ActiveSupport::Concern
+
+  included do
+    belongs_to :category
+    belongs_to :article
+  end
+end

data/lib/knowledge_base/concerns/models/section.rb

@@ -0,0 +1,13 @@
+module KnowledgeBase::Concerns::Models::Section
+  extend ActiveSupport::Concern
+
+  included do
+    # 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
+
+    validates :sectionable, presence: true
+  end
+end

data/lib/knowledge_base/concerns/models/sectionables/attachments/attachment.rb

@@ -0,0 +1,11 @@
+module KnowledgeBase::Concerns::Models::Sectionables::Attachments::Attachment
+  extend ActiveSupport::Concern
+
+  included do
+    belongs_to :list, foreign_key: :attachment_list_id
+
+    mount_uploader :file, KnowledgeBase::GenericFileUploader
+
+    validates :title, :file, :list, presence: true
+  end
+end

data/lib/knowledge_base/concerns/models/sectionables/attachments/list.rb

@@ -0,0 +1,15 @@
+module KnowledgeBase::Concerns::Models::Sectionables::Attachments::List
+  extend ActiveSupport::Concern
+
+  included do
+    has_many :sections, as: :sectionable, dependent: :destroy
+
+    has_many :attachments, dependent: :destroy, inverse_of: :list,
+      foreign_key: :attachment_list_id
+    accepts_nested_attributes_for :attachments, allow_destroy: true
+
+    def to_s
+      "#{super} ##{id}: #{title}"
+    end
+  end
+end

data/lib/knowledge_base/concerns/models/sectionables/gallery.rb

@@ -0,0 +1,17 @@
+module KnowledgeBase::Concerns::Models::Sectionables::Gallery
+  extend ActiveSupport::Concern
+
+  included do
+    has_many :images, -> { order position: :asc },
+      dependent: :destroy
+
+    has_many :sections, as: :sectionable, dependent: :destroy
+
+    accepts_nested_attributes_for :images, allow_destroy: true
+
+    def to_s
+      "#{super} ##{id}: #{title}"
+    end
+  end
+end
+

data/lib/knowledge_base/concerns/models/sectionables/gallery/image.rb

@@ -0,0 +1,9 @@
+module KnowledgeBase::Concerns::Models::Sectionables::Gallery::Image
+  extend ActiveSupport::Concern
+
+  included do
+    belongs_to :gallery
+
+    mount_uploader :image, KnowledgeBase.config.gallery_image_uploader
+  end
+end

data/lib/knowledge_base/concerns/models/sectionables/image.rb

@@ -0,0 +1,13 @@
+module KnowledgeBase::Concerns::Models::Sectionables::Image
+  extend ActiveSupport::Concern
+
+  included do
+    mount_uploader :image, KnowledgeBase.config.image_image_uploader
+
+    has_many :sections, as: :sectionable, dependent: :destroy
+
+    def to_s
+      "#{super} ##{id}: #{caption}"
+    end
+  end
+end

data/lib/knowledge_base/concerns/models/sectionables/links/link.rb

@@ -0,0 +1,7 @@
+module KnowledgeBase::Concerns::Models::Sectionables::Links::Link
+  extend ActiveSupport::Concern
+
+  included do
+    belongs_to :list, foreign_key: :links_id
+  end
+end

data/lib/knowledge_base/concerns/models/sectionables/links/list.rb

@@ -0,0 +1,15 @@
+module KnowledgeBase::Concerns::Models::Sectionables::Links::List
+  extend ActiveSupport::Concern
+
+  included do
+    has_many :links, dependent: :destroy, foreign_key: :links_id
+
+    has_many :sections, as: :sectionable, dependent: :destroy
+
+    accepts_nested_attributes_for :links, allow_destroy: true
+
+    def to_s
+      "#{super} ##{id}: #{links.map(&:title).join(', ')}"
+    end
+  end
+end

data/lib/knowledge_base/concerns/models/sectionables/list.rb

@@ -0,0 +1,17 @@
+module KnowledgeBase::Concerns::Models::Sectionables::List
+  extend ActiveSupport::Concern
+
+  included do
+    mount_uploader :image, KnowledgeBase.config.list_image_uploader
+
+    has_many :items, -> { order 'position ASC' }
+
+    has_many :sections, as: :sectionable, dependent: :destroy
+
+    accepts_nested_attributes_for :items, allow_destroy: true
+
+    def to_s
+      "#{super} ##{id}: #{title}"
+    end
+  end
+end

data/lib/knowledge_base/concerns/models/sectionables/list/item.rb

@@ -0,0 +1,7 @@
+module KnowledgeBase::Concerns::Models::Sectionables::List::Item
+  extend ActiveSupport::Concern
+
+  included do
+    belongs_to :list
+  end
+end

data/lib/knowledge_base/concerns/models/sectionables/sectionable.rb

@@ -0,0 +1,28 @@
+module KnowledgeBase::Concerns::Models::Sectionables::Sectionable
+  extend ActiveSupport::Concern
+
+  included do
+    extend Enumerize
+
+    def self.inherited(child)
+      model_name = snake_case_class_name child.name
+      styles = KnowledgeBase.config.section_styles[model_name] || [ ]
+      child.enumerize :style, in: styles
+
+      super
+    end
+
+    self.abstract_class = true
+
+    def to_s
+      self.class.model_name.human
+    end
+
+    private
+
+    def self.snake_case_class_name(class_name)
+      class_name.gsub("KnowledgeBase::Sectionables::", "").underscore.gsub("/", "_").to_sym
+    end
+
+  end
+end

data/lib/knowledge_base/concerns/models/sectionables/text.rb

@@ -0,0 +1,13 @@
+module KnowledgeBase::Concerns::Models::Sectionables::Text
+  extend ActiveSupport::Concern
+
+  included do
+    mount_uploader :image, KnowledgeBase.config.text_image_uploader
+
+    has_many :sections, as: :sectionable, dependent: :destroy
+
+    def to_s
+      "#{super} ##{id}: #{heading}"
+    end
+  end
+end

data/lib/knowledge_base/concerns/models/sectionables/video.rb

@@ -0,0 +1,15 @@
+module KnowledgeBase::Concerns::Models::Sectionables::Video
+  extend ActiveSupport::Concern
+
+  included do
+    include Embeddable
+
+    embeddable :video, from: :url
+
+    has_many :sections, as: :sectionable, dependent: :destroy
+
+    def to_s
+      "#{super} ##{id}: #{url}"
+    end
+  end
+end

data/lib/knowledge_base/configuration.rb

@@ -1,23 +1,16 @@
 module KnowledgeBase
   class Configuration
-    configs = {
-      storage: :file,
-      categories_path: 'categories',
-      articles_path: 'articles'
-    }
+    attr_accessor :categories_path, :articles_path, :text_image_uploader,
+      :image_image_uploader, :gallery_image_uploader, :list_image_uploader, :section_styles
 
-    configs.each do |config, default|
-      attr_writer config
-
-      define_method config do
-        value = instance_variable_get "@#{config}"
-
-        if value.nil?
-          default
-        else
-          value
-        end
-      end
+    def initialize
+      @categories_path        = 'categories'
+      @articles_path          = 'articles'
+      @text_image_uploader    = KnowledgeBase::ImageUploader
+      @image_image_uploader   = KnowledgeBase::ImageUploader
+      @gallery_image_uploader = KnowledgeBase::ImageUploader
+      @list_image_uploader    = KnowledgeBase::ImageUploader
+      @section_styles         = { }
     end
   end
 end

data/lib/knowledge_base/engine.rb

@@ -11,6 +11,10 @@ module KnowledgeBase
       end
     end
 
+    initializer 'tasks.factories', after: 'factory_girl.set_factory_paths' do
+      FactoryGirl.definition_file_paths << File.expand_path('../../../spec/factories', __FILE__) if defined?(FactoryGirl)
+    end
+
     config.generators do |g|
       g.test_framework :rspec, fixture: false
       g.fixture_replacement :factory_girl, dir: 'spec/factories'

data/lib/knowledge_base/seeds.rb

@@ -6,8 +6,8 @@ def fixture file
   File.open "#{File.expand_path File.dirname(__FILE__)}/../../fixtures/#{file}"
 end
 
-category    = KnowledgeBase::Category.create! title: Faker::Lorem.words.join, description: Faker::Lorem.sentence
-article     = KnowledgeBase::Article.create! title: Faker::Lorem.words.join, description: Faker::Lorem.sentence
+category    = KnowledgeBase::Category.create! title: Faker::Lorem.words.join, description: Faker::Lorem.sentence, published_at: Time.now
+article     = KnowledgeBase::Article.create! title: Faker::Lorem.words.join, description: Faker::Lorem.sentence, published_at: Time.now
 association = KnowledgeBase::CategoryArticleAssociation.create! category: category, article: article
 
 text    = KnowledgeBase::Sectionables::Text.create! heading: Faker::Lorem.words.join, lead: Faker::Lorem.sentence, body: Faker::Lorem.paragraph
@@ -27,6 +27,10 @@ list = KnowledgeBase::Sectionables::List.create! title: Faker::Lorem.sentence, d
 2.times { list.items.create title: Faker::Lorem.sentence, body: Faker::Lorem.paragraph }
 section = KnowledgeBase::Section.create! sectionable: list, container: article, position: 5
 
-links = KnowledgeBase::Sectionables::Links.create!
+links = KnowledgeBase::Sectionables::Links::List.create!
 2.times { links.links.create title: Faker::Lorem.word, url: 'http://example.org' }
 section = KnowledgeBase::Section.create! sectionable: links, container: article, position: 6
+
+attachments = KnowledgeBase::Sectionables::Attachments::List.create!
+2.times { attachments.attachments.create! title: Faker::Lorem.word, file: fixture('sample.pdf') }
+section = KnowledgeBase::Section.create! sectionable: attachments, container: article, position: 7

data/lib/knowledge_base/version.rb

@@ -1,3 +1,3 @@
 module KnowledgeBase
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/controllers/knowledge_base/articles_controller_spec.rb

@@ -4,13 +4,24 @@ module KnowledgeBase
   describe ArticlesController do
     routes { KnowledgeBase::Engine.routes }
 
+    describe "GET 'index'" do
+      let!(:articles) { create_list :article, 3, :published }
+
+      it "returns http success" do
+        get :index
+
+        articles = assigns :articles
+
+        expect(response).to be_success
+        expect(articles.count).to eq 3
+      end
+    end
+
     describe "GET 'show'" do
       it "returns http success" do
-        category    = create :category
-        article     = create :article
-        association = create :category_article_association, category: category, article: article
+        article = create :article, :published
 
-        get :show, category_id: category.slug, id: article.slug
+        get :show, id: article.slug
 
         response.should be_success
       end

data/spec/controllers/knowledge_base/categories_controller_spec.rb

@@ -13,7 +13,7 @@ module KnowledgeBase
 
     describe "GET 'show'" do
       it "returns http success" do
-        category = create :category
+        category = create :category, :published
 
         get :show, id: category.slug
 

data/spec/dummy/db/schema.rb

@@ -11,7 +11,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20140307092719) do
+ActiveRecord::Schema.define(version: 20140930121510) do
 
   create_table "knowledge_base_articles", force: true do |t|
     t.string   "title"
@@ -27,7 +27,7 @@ ActiveRecord::Schema.define(version: 20140307092719) do
     t.string   "slug"
     t.text     "description"
     t.integer  "category_id"
-    t.integer  "position"
+    t.integer  "position",     default: 0
     t.datetime "published_at"
     t.datetime "created_at"
     t.datetime "updated_at"
@@ -39,7 +39,7 @@ ActiveRecord::Schema.define(version: 20140307092719) do
   create_table "knowledge_base_category_article_associations", force: true do |t|
     t.integer  "category_id"
     t.integer  "article_id"
-    t.integer  "position"
+    t.integer  "position",    default: 0
     t.datetime "created_at"
     t.datetime "updated_at"
   end
@@ -47,17 +47,34 @@ ActiveRecord::Schema.define(version: 20140307092719) do
   add_index "knowledge_base_category_article_associations", ["article_id"], name: "index_knowledge_base_c_a_association_on_article_id"
   add_index "knowledge_base_category_article_associations", ["category_id"], name: "index_knowledge_base_c_a_association_on_category_id"
 
+  create_table "knowledge_base_sectionables_attachments_attachments", force: true do |t|
+    t.string  "title"
+    t.string  "file"
+    t.integer "attachment_list_id"
+    t.text    "description"
+  end
+
+  add_index "knowledge_base_sectionables_attachments_attachments", ["attachment_list_id"], name: "index_knowledge_base_attachments_on_attachment_list_id"
+
+  create_table "knowledge_base_sectionables_attachments_lists", force: true do |t|
+    t.datetime "created_at"
+    t.datetime "updated_at"
+    t.string   "style"
+    t.string   "title"
+  end
+
   create_table "knowledge_base_sectionables_galleries", force: true do |t|
     t.string   "title"
-    t.string   "description"
+    t.text     "description"
     t.datetime "created_at"
     t.datetime "updated_at"
+    t.string   "style"
   end
 
   create_table "knowledge_base_sectionables_gallery_images", force: true do |t|
     t.string   "caption"
     t.string   "image"
-    t.integer  "position"
+    t.integer  "position",   default: 0
     t.integer  "gallery_id"
     t.datetime "created_at"
     t.datetime "updated_at"
@@ -70,26 +87,29 @@ ActiveRecord::Schema.define(version: 20140307092719) do
     t.string   "image"
     t.datetime "created_at"
     t.datetime "updated_at"
-  end
-
-  create_table "knowledge_base_sectionables_links", force: true do |t|
-    t.datetime "created_at"
-    t.datetime "updated_at"
+    t.string   "style"
   end
 
   create_table "knowledge_base_sectionables_links_links", force: true do |t|
     t.string   "title"
     t.string   "url"
-    t.integer  "position"
+    t.integer  "position",    default: 0
     t.integer  "links_id"
     t.datetime "created_at"
     t.datetime "updated_at"
+    t.text     "description"
+  end
+
+  create_table "knowledge_base_sectionables_links_lists", force: true do |t|
+    t.datetime "created_at"
+    t.datetime "updated_at"
+    t.string   "style"
   end
 
   create_table "knowledge_base_sectionables_list_items", force: true do |t|
     t.string   "title"
     t.text     "body"
-    t.integer  "position"
+    t.integer  "position",   default: 0
     t.integer  "list_id"
     t.datetime "created_at"
     t.datetime "updated_at"
@@ -102,6 +122,8 @@ ActiveRecord::Schema.define(version: 20140307092719) do
     t.text     "description"
     t.datetime "created_at"
     t.datetime "updated_at"
+    t.string   "image"
+    t.string   "style"
   end
 
   create_table "knowledge_base_sectionables_texts", force: true do |t|
@@ -110,18 +132,22 @@ ActiveRecord::Schema.define(version: 20140307092719) do
     t.text     "body"
     t.datetime "created_at"
     t.datetime "updated_at"
+    t.string   "image"
+    t.string   "style"
   end
 
   create_table "knowledge_base_sectionables_videos", force: true do |t|
     t.string   "url"
     t.datetime "created_at"
     t.datetime "updated_at"
+    t.string   "style"
+    t.string   "title"
   end
 
   create_table "knowledge_base_sections", force: true do |t|
     t.integer  "sectionable_id"
     t.string   "sectionable_type"
-    t.integer  "position"
+    t.integer  "position",         default: 0
     t.datetime "created_at"
     t.datetime "updated_at"
     t.integer  "container_id"