kuhsaft 0.3.6 → 1.0.0

data/README.md

@@ -1,9 +1,6 @@
-# Kuhsaft. A CMS as simple as it could be
-
-**IMPORTANT: Kuhsaft >= 0.3.0 runs only on Rails 3.1. If you are stuck on
-Rails 3 go for the 0.2 Versions**
+[![Build Status](https://api.travis-ci.org/screenconcept/kuhsaft.png)](http://travis-ci.org/screenconcept/kuhsaft)
 
-Yiiihaaaaaa! Howdy, Let's milk the cow!
+# Kuhsaft. A CMS as simple as it could be
 
 ## The Who, What and Why?
 
@@ -14,11 +11,17 @@ ourselves and our customers that makes the of-the-shelf website project a
 hasselfree 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
+Kuhsaft requires:
 
-* A Rails 3 app to be integrated into
+* A Rails 3.2 app to be integrated into
 * ImageMagick
 * An ActiveRecord compatible DB
 
@@ -36,108 +39,155 @@ to get the gem
 
 Then install the assets and the migrations and run them:
 
-    rails generate kuhsaft:install:migrations
+    rake kuhsaft:install:migrations
     rake db:migrate
+    rake db:seed
 
-If you are upgrading, run those installers again and hopefully we will generate just the migrations you need.
+You might want to change the language suffixes on the fields inside the create_kuhsaft_pages migration, depending on your app's default_locale.
 
-(NOTE: Steps below should hopefully not be necessary in future versions:)
+Mount the kuhsaft engine in your routing file:
 
-Finally, you need to add a before filter to the application controller (for now...)
+    MyApp::Application.routes.draw do
+      # add your app routes here
+      mount Kuhsaft::Engine => "/"
+    end
 
-    ApplicationController < ActionController::Base
-      before_filter :available_locales
+Load the Kuhsaft assets into your app, so you have working grids, widgets etc:
 
-      def available_locales
-        Kuhsaft::Page.translation_locales = ['de', 'en', 'fr']
-      end
-    end
+    # application.css.sass
+    @import 'kuhsaft/application'
 
-If you want to use devise for protecting the admin parts, do this in an initializer:
+    # application.js.coffee
+    //= require 'kuhsaft/application'
 
-    Kuhsaft::Cms::PagesController.class_eval do
-      before_filter :authenticate_user!
-    end
+## Modifying the backend CSS
+Simply override the custom css in your app with your own style at `assets/stylesheets/kuhsaft/cms/customizations.css.sass`
+
+## Modifying the backend javascript
+Simply override the custom javascript in your app with your own script at `assets/javascripts/kuhsaft/cms/customizations.js.coffee`
+
+## Testing
+
+There's a dummy app inside spec/dummy. Get it running by executing the following steps:
+
+* remove eventual migrations inside `spec/dummy/db/migrate`
+* run `rake kuhsaft:install:migrations` again
+* run `rake db:migrate` and `rake db:seed`
+
+Start up the dummy app. The first two steps also make sure you're ready to run `rspec spec` to run the test suite. (Todo: This workflow must be improved))
 
 # Usage
 
-## Building a navigation
+## 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:
 
-Create a toplevel page and set the page type to "navigation". You can now get the child pages by using the navigation helper with the slug of that page: 
+    class ApplicationController < ActionController::Base
+      helper Kuhsaft::Engine.helpers
+    end
 
-    navigation_for(:slug => 'main-navigation') { |pages| ... }
+## Adding sublime video
 
-## Integrating custom Models into Kuhsaft (aka Rails Admin Lite)
+Create an initializer file in your app inside `config/initializers` and set the `sublime_video_token`:
 
-There is a chance that Pages and Assets is not enough for you and you
-need custom models in your Rails app. It's your lucky day, because
-Kuhsaft was designed with the goal to easily integrate into a usual
- Rails app.
+    Kuhsaft::Engine.configure do
+      # Get the token from the MySites section on the sublime video site
+      config.sublime_video_token = '123abcd'
+    end
 
-There is one caveat though: You need to **stay in the Kuhsaft namespaces
-for your admin controllers and views** if you want to use the Kuhsaft UI
-as a backend to your models.
+Require the sublime javascript with the following helper:
 
-There is a high probability that we will ship our own generators for all
-this stuff in the future, meanwhile, you'll have to do some manual work:
+    # in your application layout in the head section
+    sublime_video_include_tag
 
-Add the route to your resource, within the locale scope and the cms
-namespace:
 
-```ruby
-scope ':locale' do
-  namespace :cms do
-    resources :projects
-  end
-end
-```
+## Configuring the image brick
 
-Put your admin controller for the model in question in
-`app/controllers/cms/` and keep it in the `Cms` namespace, e.g:
+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:
 
-```ruby
-module Cms
-  class ProjectsController < Kuhsaft::Cms::AdminController
-    def index
-      # do somethinng
+    # your_app/config/initializers/kuhsaft.rb
+    Kuhsaft::Engine.configure do
+      config.image_sizes.build_defaults! # creates 960x540 and 320x180 sizes
     end
-  end
-end
-```
 
-As you can see you have to inherit from `Kuhsaft::Cms::AdminController`
+You can also remove the default sizes:
 
-As with the controllers, you have to respect the namespaces when adding
-the view. For the example above, we would create an index view in
-`app/views/cms/projects/`
+    # your_app/config/initializers/kuhsaft.rb
+    Kuhsaft::Engine.configure do
+      config.image_sizes.clear! # .all is now empty
+    end
 
-As an example, the view might look something like this:
+And most importantly, you can add custom sizes:
 
-```ruby
-- content_for :admin_toolbar do
-  = link_to t('.create'), new_cms_project_path, :class => 'button'
+    # your_app/config/initializers/kuhsaft.rb
+    Kuhsaft::Engine.configure do
+      config.image_sizes.add(:side_box_vertical, 180, 460)
+      config.image_sizes.add(:footer_teaser, 320, 220)
+    end
 
-- content_for :cms_language_tabs do
-  - Kuhsaft::Page.translation_locales.each do |locale|
-    %li{ :class => (:current if params[:locale] == locale.to_s) }= link_to locale.to_s, cms_projects_path(:locale => locale)
+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:
 
-%ul.pages-root.sortable
-  -@projects.each do |project|
-    %li.can-drag.project
-      .branch
-        =link_to project.name, cms_project_path(project)
-```
+    activerecord.attributes.kuhsaft/image_size.sizes.#{name}
 
-Note that we can acess the admin_toolbar and the language tabs from here
-as well.
+## Adding custom templates with placeholder bricks
 
-Finally, you need to create a partial called
-`_admin_navigation.html.haml` in `app/views/cms/`. This partial is used
-to render the additional navigation tabs in the Kuhsaft UI:
+* 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`
 
-```ruby
-= admin_tab('Projects', cms_projects_path())
 ```
+de:
+  your_partial: Your Partial
+```
+
+## Adding additional content languages
+
+If you wan't 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]
+
+## 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.
+
+### 2 level navigation example using simple-navigation
+
+    SimpleNavigation::Configuration.run do |navigation|
+      navigation.items do |primary|
+        # build first level
+        Kuhsaft::Page.roots.published.each do |page|
+          primary.item page.id, page.title, page.link do |sub_item|
+            # build second level
+            page.children.published.each do |subpage|
+              sub_item.item subpage.id, subpage.title, subpage.link
+            end
+          end
+        end
+      end
+    end
+
+## 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.
 
 # LICENSE
 

data/Rakefile

@@ -1,16 +1,11 @@
-# encoding: UTF-8
-require 'rubygems'
+#!/usr/bin/env rake
 begin
-  require 'bundler'
-  Bundler::GemHelper.install_tasks
+  require 'bundler/setup'
 rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-require 'rake'
-require 'rdoc/task'
-
-require 'rspec/core'
+require 'rspec'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec) do |specs|
@@ -19,10 +14,20 @@ end
 
 task :default => :spec
 
-Rake::RDocTask.new(:rdoc) do |rdoc|
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'Kuhsaft'
-  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.options << '--line-numbers'
   rdoc.rdoc_files.include('README.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+Bundler::GemHelper.install_tasks

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

@@ -0,0 +1,2 @@
+//= require bootstrap
+//= require_self

data/app/assets/javascripts/kuhsaft/cms/application.js

@@ -4,8 +4,20 @@
 // It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
 // the compiled file.
 //
-//= require jquery.min
+//= require jquery
 //= require jquery_ujs
-//= require ./jquery-ui-1.8.12.custom.min
-//= require ./jquery.elastic.source
-//= require ./backend
+//= require redactor
+//= require bootstrap
+//= require_tree .
+
+function loadTextEditor(elem){
+  elem.find(".js-editor").redactor({})
+}
+
+$(function(){
+  loadTextEditor($("body"))
+})
+
+$("body").ajaxSuccess(function(){
+  loadTextEditor($("body"))
+})

data/app/assets/javascripts/kuhsaft/cms/customizations.js

@@ -0,0 +1 @@
+// Override this empty file to add custom JS behaviour!

data/app/assets/stylesheets/kuhsaft/application.css.sass

@@ -0,0 +1,4 @@
+// = require_self
+
+@import bootstrap
+

data/app/assets/stylesheets/kuhsaft/cms/application.css.sass

@@ -0,0 +1,125 @@
+// This is a manifest file that'll automatically include all the stylesheets available in this directory
+// and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+// the top of the compiled file, but it's generally better to create a new file per style scope.
+// = require redactor
+// = require_self
+// = require_tree .
+
+
+$baseBorderRadius: 0px
+$borderRadiusLarge: 0px
+$borderRadiusSmall: 0px
+
+@import bootstrap
+@import compass/css3
+
+// base styles
+
+h1
+  margin-top: 1em
+  margin-bottom: 0.5em
+  font-size: 3.5em
+
+form
+  margin: 0 !important
+
+// bootrap overrides
+
+.breadcrumb
+  background: #fff
+  opacity: 0.4
+  +single-transition(all, 0.3s)
+
+.breadcrumb:hover
+  opacity: 1
+
+.dropdown-menu
+  text-align: left
+
+.container.cms
+  padding-top: 60px
+
+// modules
+
+.brick-caption
+  font-size: 1.25em
+
+.brick-caption
+  @extend .muted
+  font-weight: normal
+  font-style: italic
+
+.brick-item-header
+  background: #efefef
+  padding: 0.5em
+
+  .btn
+    +opacity(0)
+    +single-transition(oapcity, 0.2s)
+
+  &:hover
+    .btn
+      +opacity(1)
+
+.brick-list
+  padding-left: 2em
+
+// The single column brick and the page-content (the "root") needs no level indentation
+// It usually acts as a helper container and is therefore not relevant
+// for the visual hierarchy
+.kuhsaft-column-brick
+  border: 0px solid #fff
+  > .brick-item-childs
+    > .brick-list
+      padding-left: 0
+#page-content
+  > .brick-list
+    padding-left: 0
+
+.tab-content
+  display: table
+  width: 100%
+
+.brick-item
+  border: 1px solid #e3e3e3
+  // collapse multiple borders
+  margin: -1px
+
+  .brick-item-content
+    padding: 1em
+
+.empty-state
+  margin: 1em
+
+  .muted
+    padding: 0.5em
+
+.clear
+  clear: both
+
+.centered
+  text-align: center
+
+.actions
+  margin-top: 1em
+  margin-bottom: 1em
+  text-align: right
+
+.branch
+  border-bottom: 1px solid #ccc
+  padding: 0.35em 0
+
+.branch-group
+  .branch-group
+    .branch-title
+      margin-left: 2em
+
+    .branch-group
+      .branch-title
+        margin-left: 4em
+
+      .branch-group
+        .branch-title
+          margin-left: 6em
+
+@import bootstrap-responsive