[![Build Status](https://travis-ci.org/screenconcept/kuhsaft.png)](https://travis-ci.org/screenconcept/kuhsaft)
[![Code Climate](https://codeclimate.com/github/screenconcept/kuhsaft.png)](https://codeclimate.com/github/screenconcept/kuhsaft)
[![Gem Version](https://badge.fury.io/rb/kuhsaft.png)](http://badge.fury.io/rb/kuhsaft)

# Kuhsaft. A CMS as simple as it could be

## The Who, What and Why?

Kuhsaft is made by some Rails developers at Screen Concept that got tired of
fiddling with unusable content management sytems. We are trying hard to make a
minimalistic and developer friendly CMS. Our goal is to provide a system for
ourselves and our customers that makes the of-the-shelf website project a
hasslefree thing. On one side easy to set up, integrate and customize (good for
devs) on the other hand it should be easily usable by anyone.

## What's in it

* A modular system to integrate any type of content structure
* Multilanguage content
* much more

# Requirements

Kuhsaft requires:

* A Rails 4 app to be integrated into
* ImageMagick
* An ActiveRecord compatible DB

# Installation

Add Kuhsaft to your Gemfile:

    gem 'kuhsaft'

And run

    bundle install

to get the gem

Then install the assets and the migrations and run them:

    rake kuhsaft:install:migrations
    rake db:migrate
    rake db:seed
    rails generate kuhsaft:assets:install

You might want to change the language suffixes on the fields inside the create_kuhsaft_pages migration, depending on your app's default_locale.

Mount the kuhsaft engine in your routing file:

    MyApp::Application.routes.draw do
      # add your app routes here
      mount Kuhsaft::Engine => "/"
    end

Load the Kuhsaft assets into your app, so you have working grids, widgets etc:

    # application.css.sass
    @import 'kuhsaft/application'

    # application.js.coffee
    //= require 'kuhsaft/application'

Finally, you need to define the image sizes for the image brick or use
the defaults:

    # your_app/config/initializers/kuhsaft.rb
    Rails.application.config.to_prepare do
      Kuhsaft::Engine.configure do
        config.image_sizes.build_defaults! # creates 960x540 and 320x180 sizes
      end
    end

See "Configuring the image brick" for more details.

## Authentication

Kuhsaft itself does not ship with any form of authentication. However, it is fairly easy to add by plugging into the Kuhsaft::Cms::AdminController. An example with devise:

```ruby
# config/initializers/kuhsaft.rb
Rails.application.config.to_prepare do
  Kuhsaft::Cms::AdminController.class_eval do
    before_filter :authenticate_user!
  end
end
```

Also, be sure to have override the navigation partial in `app/views/kuhsaft/cms/admin/_main_navigation.html.haml` so you get a working logout button.

## Extending the backend CSS/javascript
Kuhsaft installs a sass file in `assets/stylesheets/kuhsaft/cms/customizations.css.sass` and a coffeescript file in `assets/javascripts/kuhsaft/cms/customizations.js.coffee` which are loaded by the backend layout. Those files can be installed by running `rails generate kuhsaft:assets:install`.

Make sure they are in the `config.assets.precompile` array in environments like production where you usually precompile the assets. The generator will only add the necessary configs for the production env!

## Testing

There's a dummy app inside spec/dummy. Get it running by executing the following steps:

```
rake setup
rake start_dummy
```

# Usage

## Making Kuhsaft helpers available to your app

As defined in the rails docs, load the helpers from our isolated Kuhsaft engine inside your application controller:

    class ApplicationController < ActionController::Base
      helper Kuhsaft::Engine.helpers
    end

## Adding sublime video

Create an initializer file in your app inside `config/initializers` and set the `sublime_video_token`:

    Rails.application.config.to_prepare do
      Kuhsaft::Engine.configure do
        # Get the token from the MySites section on the sublime video site
        config.sublime_video_token = '123abcd'
      end
    end

Require the sublime javascript with the following helper:

    # in your application layout in the head section
    sublime_video_include_tag


## Configuring the image brick

The image brick can process uploaded images into specific sizes. These sizes can be configured inside the engine configuration. You can also use the built-in default sizes:

    # your_app/config/initializers/kuhsaft.rb
    Rails.application.config.to_prepare do
      Kuhsaft::Engine.configure do
        config.image_sizes.build_defaults! # creates 960x540 and 320x180 sizes
      end
    end

You can also remove the default sizes:

    # your_app/config/initializers/kuhsaft.rb
    Rails.application.config.to_prepare do
      Kuhsaft::Engine.configure do
        config.image_sizes.clear! # .all is now empty
      end
    end

And most importantly, you can add custom sizes:

    # your_app/config/initializers/kuhsaft.rb
    Rails.application.config.to_prepare do
      Kuhsaft::Engine.configure do
        config.image_sizes.add(:side_box_vertical, 180, 460)
        config.image_sizes.add(:footer_teaser, 320, 220)
      end
    end

The `name` option is a unique identifier, which is also used for translating the dropdown in the brick. You can add your translation by using the translation path:

    activerecord.attributes.kuhsaft/image_size.sizes.#{name}

## Configuring custom styles for bricks

Implement the `available_display_styles` on a brick model and return an array of css classnames: `['module-big', 'module-small']`. These styles can be applied to a brick instance through the UI. In the frontend, use `to_style_class` to get the configured styles:

    %my-brick{ :class => brick.to_style_class}
      = brick.text # ... etc


## Adding custom templates with placeholder bricks

* Save your partial in `views/kuhsaft/placeholder_bricks/partials/_your_partial.html.haml`
* Add translations for your partial in `config/locales/models/kuhsaft/placeholder_brick/locale.yml`

```
de:
  your_partial: Your Partial
```

## Adding additional content languages

If you want to translate your pages into another language, generate a new translation migration:

    # translate your pages into french
    rails g kuhsaft:translations:add fr

This creates a new migration file inside `db/migrate` of your app. Run the migration as you normally do:

    rake db:migrate

Finally, add the new translation locale to your `available_locales` inside your apps `application.rb`:

    config.available_locales = [:en, :fr]

## Adding a language switch

Add scope around routes:

    scope "(:locale)", locale: /de|en|fr/ do
      root 'kuhsaft/pages#show'
    end

Set the locale in the ApplicationController in a before_action and set default url options:

    before_action :set_locale

    def set_locale
      if I18n.available_locales.map{|sym| sym.to_s }.include?(params[:locale])
        I18n.locale = params[:locale]
      else
        I18n.locale = I18n.default_locale
      end
    end

    def default_url_options(options={})
      { locale: I18n.locale }
    end

Add method to ApplicationHelper which redirects to homepage when current page is not translated.
Make sure to have the homepage translated in every available language.

    def localized_url(url, target_locale)
      page = Kuhsaft::Page.find_by_url("#{I18n.locale}/#{url}")
      I18n.with_locale target_locale do
        translated_url = page.presence && page.url
        if translated_url.present?
          "/#{translated_url}"
        else
          root_path(locale: target_locale)
        end
      end
    end

    def language_link(url, locale)
      localized_url(params[:url], locale)
    end

Add language switch to navigation:

    SimpleNavigation::Configuration.run do |navigation|
      I18n.available_locales.each do |locale|
        primary.item locale, locale.to_s.upcase, language_link(params[:url], locale), highlights_on: Proc.new { I18n.locale == locale }
      end
    end

Make sure to render only pages which are translated and published by using `published` and `translated` scope, so pages
without translation and which are not published will not be displayed in the navigation.
Here is an example of a possible navigation:

    SimpleNavigation::Configuration.run do |navigation|
      navigation.items do |primary|
        primary.dom_class = 'right'
        primary.selected_class = 'active'
        Kuhsaft::Page.find_by(slug_de: 'meta-navigation').children.published.translated.each do |page|
          primary.item page.id, page.title, page.link, class: 'contact icon'
        end

        primary.item '', 'Sprache', '#', class: 'language icon has-dropdown'do |language|
          I18n.available_locales.each do |locale|
            language.dom_class = 'dropdown'
            language.item locale, language_text(locale), language_link(params[:url], locale), highlights_on: Proc.new { I18n.locale == locale }, class: "icon lang-#{locale}"
          end
        end
      end
    end

## Styling the content

By default, the text editor lets you add the following tags, for which you should supply some styles in your app:

    p, h1, h2, h3, h4, table, a, strong, em

## Building a navigation

Building a navigation is simple, access to the page tree is available through the common methods built into the ancestry gem.
Just make sure you are only accessing published pages for your production site, using the `published` scope.
Or if your page is translated, using the `translated` scope and the `published` scope.

### 2 level navigation example using simple-navigation

    SimpleNavigation::Configuration.run do |navigation|
      navigation.items do |primary|
        # build first level
        Kuhsaft::Page.roots.published.translated.each do |page|
          primary.item page.id, page.title, page.link do |sub_item|
            # build second level
            page.children.published.translated.each do |subpage|
              sub_item.item subpage.id, subpage.title, subpage.link
            end
          end
        end
      end
    end

## Use the `page_title` attribute in your app

Kuhsaft::Pages will provide a `%title` tag containing its `page_title`
(or the required `title`if no title is present). Simply yield for
`:head` in your `application.html` to use it.

    %head
      = yield(:head)

## Modifying the backend navigation

Simply override the default partial for the main navigation in your app with your own file at `kuhsaft/cms/admin/_main_navigation.html.haml`

## Adding your own Bricks

* Create your Brick model in `app/models`, for example `CaptionBrick`, which inherits from `Kuhsaft::Brick`.
* Create a migration which adds the necessary fields to the `kuhsaft_bricks` table.
* If your brick should be accessible via UI, add a BrickType into the seeds or add a migration:
    `Kuhsaft::BrickType.create(:class_name => 'CaptionBrick', :group => 'elements')`
* Add the `edit` and `show` partials to your views, e.g: `app/views/caption_bricks/caption_brick/_edit.html.haml`
* Add the `childs` partial to your views, if you want to render your bricks childs with your own html: `app/views/caption_bricks/caption_brick/_childs.html.haml`
* Implement the `fulltext` method on your brick, return anything you want to be searchable.
* Customize the edit form behaviour of your brick by overriding methods like `to_style_class?`. See the `Brick` and `BrickList` files for more methods.

### Use the Kuhsaft ImageBrickImageUploader for your own Brick

Kuhsaft has a module called `ImageUploaderMounting`. This module mounts the ImageBrickImageUploader
and includes a callback method which handles that the image sizes will be updated after save.

    class CustomBrick < Brick
      include Kuhsaft::ImageUploaderMounting
      ...
    end

If you do not include this module, then the images will not be changed when selecting one of your own image
sizes. See "Configuring the image brick" for more details on creating your own image sizes.

## Integrating search

Kuhsaft supports fulltext search when using PostgreSQL with a simple
LIKE fallback for any other ActiveRecord DB.

Add a call to the `search_page_form` helper in your views. This renders
the default search form. The query will be executed by kuhsaft.

    # e.g. _footer.html.haml
    = search_page_form

To customize the search and result views you can add your own partials
to your rails app. The following partials are overridable.

    app/views/kuhsaft/search
    ├── _form.html.haml           # Search form
    ├── _results.html.haml        # Results list (@pages)
    └── _results_entry.html.haml  # Single result entry (@page)

When using PostgreSQL, an additional attribute `excerpt` will be
available on the page model. It includes a highlighted excerpt of the
matching `fulltext` column.

# LICENSE

See the file LICENSE.