Cmsino

Ruby on rails gem (Rails Engine) for developers to add small cms capabilities to their application. Not usable now unless you want to help developing :-)

Old project. Not active.

Authorization is done with https://github.com/CanCanCommunity/cancancan but easy to change.

Installation

Add theses lines to your application's Gemfile:

    gem 'cmsino', git: '[email protected]:donapieppo/cmsino.git'

And then execute:

    $ bundle update
    $ rails g cancan:ability
    $ bundle exec rake cmsino_engine:install:migrations # populates migrations
    $ bundle exec rake db:migrate                       # creates cmsino_* tables

To configure use config/initializers/cmsino.rb as

    Cmsino::Conf.setup do |config|
      config.locales = ['it', 'en', 'es']
    end

Cmsino gets the locale from I18n.locale. You can see http://guides.rubyonrails.org/i18n.html for Rails Internationalization.

Usage

Include Cmsino::ControllerHelpers in app/controllers/application_controller.rb and for CanCanCan provide a current_user method in the controller and give ability to manage Cmsino::Content.

For example in app/controllers/application_controller.rb

class ApplicationController < ActionController::Base
  [...]

  include Cmsino::ControllerHelpers

  def current_user
    User.new(cmsino_user: session[:cmsino_user])
  end 
end

and in app/models/ability.rb

  [...]
    can :manage, Cmsino::Content

Of course in real cases you use something like https://github.com/plataformatec/devise to handle current_user

Include cmsino/cmsino in your stylesheet and javascript assets:

app/assets/stylesheets/application.css

  *= require cmsino/cmsino

app/assets/javascripts/application.js

  //= require cmsino/cmsino

If you want to provide editable content to home#index update the file config/cmsino.yml with

home: Home Page

add the tag editable_page to app/controllers/home_controller.rb

class HomeController < ApplicationController
  def index
    editable_page(:home)
  end
end

and editable_content in the view app/views/home/index.html.erb

<h2>Main content</h2>
<%= editable_content(:main) %>

When you visit /home for the first time the content named :main for the page :home and the locale "I18n.locale" is created in the database as an empty string.

When authenticated (see cancancan) you get an editable form (a http://xing.github.io/wysihtml5 styled form for now).

See https://github.com/donapieppo/cmsino/wiki/Usage for details and https://github.com/donapieppo/cmsino-example for example.

Why

For those searching for a tiny cms which allows your users to change only the contents (snippets) leaving you, the rails developer and web designer, with your editor (vim?), your rails gems and no web interface.

When https://github.com/geraudmathe/Locomotive-fundamentals says "Developing a LocomotiveCMS site should not require Ruby on Rails knowledge" we say "Developing site with Cmsino require Ruby on Rails knowledge".

TODO

Use https://github.com/flavorjones/loofah for cleaning html posted by authenticated user.

Note on database

in db/migrate/2013011001_create_cmsino_content_schema.rb you find the definition of the Cmsino::Content table in database.

Type, Umbrella and Name for a content are hardcoded in the code.

Type field

Identifies Rails classes (see app/models/)

• Cmsino::Page
• Cmsino::Post
• Cmsino::Medium

Umbrella field

Groups together contents (for example Cmsino::Content in the same page) or posts (for example Cmsino::Post to be displayed in the same place).

Example of umbrella: 'home', 'news', 'where_we_are'

Name field

Defined in code with the param of editable_page .

Records with the same umbrella and name identifies the same content with different locales.

From code to database:

Content

app/controllers/home_controller.rb

class HomeController < ApplicationController
  def index
    editable_page(:home, 'Home Page')
  end
end

app/views/home/index.html.erb

<p><%= editable_content(:contacts) %></p>

In the database the record will be

Field    | Content                 | Where it comes from 
---------|-------------------------|---------------------------------
umbrella | home                    | from programmer (in code)
name     | contacts                | from programmer (in code)
locale   | it                      | actual locale
title    | Selling contacts        | title submitted by csmino user
text     | tel +3221222 <br/> ciao | content submitted by csmino user

Media

Example of an image (media) from code to database:

app/views/welcome/index.html.erb

<p><%= selectable_image(:feature_image_for_contacts) %></p>

In the database the record will be represented by

** cmsino_contents **

Field    | Content                    | Where it comes from 
---------|----------------------------|---------------------------------
name     | feature_image_for_contacts | from programmer (in code)
locale   | it                         | actual locale

** cmsino_media_uses **

association between feature_image_for_contacts contents and the media with the selected image.

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Added some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request