qbrick 2.5.0.pre → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa68b302bf2fad31f0d1e24afa8d9b0408ffc9bb
-  data.tar.gz: e76b64ee8157ef3a183db7b4a938b603d3bf2065
+  metadata.gz: cbc6383e5dcb546e55e7bb7ee0031c30fe1444a1
+  data.tar.gz: df58035ffe10022dd61d3b3125428cb2d7d9e37e
 SHA512:
-  metadata.gz: 0c57ecb2927fc22070a4418d622722e7d778d93abc97869f16f02465f0628658d7eb7e884b003e80ed5f9c9ba8e37f83d6f29db1123e8980f73288b9c771b060
-  data.tar.gz: ab7e185baadf339aaa5c4edce29ef1eb55888e26fd4c00160ba768414859f973c2ffa28d52b59324d888503d1386e111dcf8bf60a6c5f27bc927acb7b782d7e4
+  metadata.gz: f5b3d0e6dc9aecc3ab98fca0292822f41e26cdde76f34a28f16522164bc7fb850f66f2c9c027ca915223aadeb2f763808316b0901a4b794b07234690c499f2c9
+  data.tar.gz: aac7dffced31342c8a6fd4afded9f15eeb5dfb874138840ec0fa4197734b796c887c4d41700e70e0dd720d0031eb34bf64cedd1642e6a507c79b5cac87337d77

data/README.md

@@ -1,423 +1,113 @@
-[![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)
+[![Build Status](https://travis-ci.org/screenconcept/qbrick.png)](https://travis-ci.org/screenconcept/qbrick)
+[![Code Climate](https://codeclimate.com/github/screenconcept/qbrick.png)](https://codeclimate.com/github/screenconcept/qbrick)
+[![Gem Version](https://badge.fury.io/rb/qbrick.png)](http://badge.fury.io/rb/qbrick)
 
-# Kuhsaft. A CMS as simple as it could be
+![qBrick
+logo](https://raw.githubusercontent.com/wiki/screenconcept/qbrick/logo.png)
 
-## The Who, What and Why?
+# qBrick - The Ruby on Rails CMS you want
 
-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.
+*Formerly known as: Kuhsaft*
 
-## What's in it
+**qBrick is currently undergoing rapid changes as we are ramping up for
+our first official release under the new name. Until 2.5 is out, expect
+things to break.**
 
-* A modular system to integrate any type of content structure
-* Multilanguage content
-* much more
+qBrick started as a side project of the Screen Concept team as we got
+tired of fiddling with unusable content management systems. By following
+common rails practices and not being to opinionated, qBirck aims to be a
+plug and play CMS Engine that does not stand in your way or dictates how you
+have to build your Rails application, while still providing some
+sensible defaults and the basic functionality you would expect form a
+CMS system.
 
-# Requirements
+# Dependencies
 
-Kuhsaft requires:
-
-* A Rails 4 app to be integrated into
+* A Rails 4 application
 * ImageMagick
 * An ActiveRecord compatible DB
 
 # Installation
 
-Add Kuhsaft to your Gemfile:
-
-    gem 'kuhsaft'
+Add it to your Gemfile:
 
-And run
+```ruby
+gem 'qbrick', '2.5.0.pre'
+```
 
-    bundle install
+Run the following command to install it:
 
-to get the gem
+```console
+bundle install
+```
 
 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
+```console
+rake qbrick:install:migrations
+rake db:migrate
+rake db:seed
+rails generate qbrick:assets:install
+```
 
-Load the Kuhsaft assets into your app, so you have working grids, widgets etc:
+Load the Qbrick assets into your app, so you have working grids, widgets etc:
 
-    # application.css.sass
-    @import 'kuhsaft/application'
+```sass
+# application.css.sass
+@import 'qbrick/application'
+```
 
-    # application.js.coffee
-    //= require 'kuhsaft/application'
+```coffee
+# application.js.coffee
+//= require 'qbrick/application'
+```
 
-Finally, you need to define the image sizes for the image brick or use
+Also, 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
+# your_app/config/initializers/qbrick.rb
 Rails.application.config.to_prepare do
-  Kuhsaft::Cms::AdminController.class_eval do
-    before_filter :authenticate_user!
+  Qbrick::Engine.configure do
+    config.image_sizes.build_defaults! # creates 960x540 and 320x180 sizes
   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
-
-After setting up display styles in specific model add your translations
-for the UI dropdown. E.g. you've added display styles to the TextBrick model:
-
-```
-de:
-  text_brick:
-    display_styles:
-      style1: 'My Style 1'
-      style2: 'My Style 2'
-```
-
-## Configuring Grid settings for Bricks
-
-Include the Kuhsaft::Gridded Module on every Brick you want to display in a grid. Default grid options are 1 to 12 (representing columns) wich can be configured via the class method `available_grid_sizes` (should return an array of integers).
-Each instance of a gridded class will have a method `gridded?` wich returns true if a column size is set.
-
-If the Gridded Module is added to a Custom Brick, it should provide a col_count integer field with default value 0.
-
-```
-add_column :your_awesome_brick, :col_count, :integer, default: 0
-```
-
-## 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
-```
-
-## Invalidating placeholder bricks containing other models on model changes
-
-Include the TouchPlaceholders module if your model is used within a
-placeholder brick and define which templates it appears in:
+If you would like to use the qBrick helpers in your app, include them in
+your application controller:
 
 ```ruby
-class Dummy < ActiveRecord::Base
-  include Kuhsaft::TouchPlaceholders
-  placeholder_templates 'some_template', 'some_other_template'
+class ApplicationController < ActionController::Base
+  helper Qbrick::Engine.helpers
 end
 ```
 
-## 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
-Or
-
-    # translate your pages into swiss german
-    rails g kuhsaft:translations:add de-CH
-
-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]
-Or
-
-    config.available_locales = [:en, 'de-CH']
-
-## 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
+Finally, mount the qBrick engine in your routes file:
 
-## 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`.
-* If u use a string field add a max-length validation of 255 characters.
-  To prevent a `ActiveRecord::StatementInvalid` Error.
-* 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)
+```ruby
+mount Qbrick::Engine => '/'
+```
 
-When using PostgreSQL, an additional attribute `excerpt` will be
-available on the page model. It includes a highlighted excerpt of the
-matching `fulltext` column.
+You can now access the qBrick interface by visiting `/cms` in your
+browser. By default, qBrick creates the first admin user with the
+email `admin@admin.com` and password: `change-me-soon!`. Which you can
+use to log in the first time.
 
-## Selecting CMS pages in CKEditor (API)
+# Using and Customizing qBrick
+See our [wiki](https://github.com/screenconcept/qbrick/wiki)
 
-The pages API is available under `/:locale/api/pages.json`. Only the
-title and url attribute is rendered in the json.
+# Issues
 
-### Usage
-Add the following lines to your `ck-config.js` file. The first line
-disables the standard link plugin. The second line enables the adv_link
-plugin, which we need for the CMS Page link dialogue in CKEditor.
+Before reporiting a problem, please read how to [File an
+issue](CONTRIBUTING.md#file-an-issue).
 
-```
-config.removePlugins = 'link'
-config.extraPlugins = 'adv_link'
-```
+# Roadmap
+See our [roadmap](doc/ROADMAP.md)
 
-Do not forget to update your `config.assets.precompile` array. Add the
-following to your existing array `ckeditor/adv_link/*`.
+# Contributing
+See the [Contributing Guidelines](CONTRIBUTING.md)
 
-# LICENSE
+# License
 
-See the file LICENSE.
+See the [LICENSE file](LICENSE)