cmtool 0.4.0 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 369abd658923dd7a4e553cbfac70222833ba658c
+  data.tar.gz: 2f29749987090be6dfc6bcf21c886b941484df3a
+SHA512:
+  metadata.gz: 312166192bff4919c28323d6bd1a10579dc4c3b27f88c1d64d4cf2c69d6f8523f8611f6bdea6654591ca92f6c7ad3c48a50daf6c62b4aeee7db645873ff963bc
+  data.tar.gz: c0e59a0771ab62815653afd6fceb1a7909b6d00711b3061320f7735523ff9f840f64c31e07140bcf65249cc6acc333d1da743f1d6fdd91f9e88de3aac7771a96

data/.gitignore

@@ -0,0 +1,12 @@
+.bundle/
+log/*.log
+pkg/
+*.swp
+.DS_Store
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache
+spec/dummy/public
+*.gem
+routes.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+- 2.1
+services:
+- couchdb
+before_script:
+- curl -X PUT localhost:5984/cmtool_test

data/Gemfile

@@ -0,0 +1,51 @@
+source "http://rubygems.org"
+
+# Declare your gem's dependencies in cmtool.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+gem "rails", " ~> 4.2.3"
+group :assets do
+  gem 'sass-rails' #, ' ~> 5.0.0'
+  gem 'bourbon'
+  gem 'coffee-script'
+  #gem 'therubyracer', :platforms => :ruby
+  #gem 'less-rails'
+  gem 'foundation-rails'
+  gem 'ace-rails-ap'
+  gem "jquery-rails"
+  gem 'font-awesome-rails'
+  gem 'tinymce-rails'
+  gem 'pickadate-rails'
+end
+
+gem 'simply_stored' , github: 'bterkuile/simply_stored'
+gem 'orm_adapter', github: 'bterkuile/orm_adapter'
+gem 'devise'
+gem 'devise_simply_stored', github: 'bterkuile/devise_simply_stored'
+gem 'slim-rails'
+gem 'paperclip', ['>= 3.4', '!= 4.3.0']
+gem 'email_validator'
+gem 'actionpack-page_caching'
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+group :development, :test do
+  gem 'rspec-rails'
+  gem 'pry-rails'
+end
+group :test do
+  gem 'factory_girl_rails'
+  gem 'capybara'
+  gem 'poltergeist'
+  gem 'rspec-its'
+  gem 'launchy'
+end
+group :development do
+  gem 'thin'
+  #gem 'ruby-debug19', :require => 'ruby-debug'
+end

data/Gemfile.lock

@@ -0,0 +1,308 @@
+GIT
+  remote: git://github.com/bterkuile/devise_simply_stored.git
+  revision: 86f93782c607958e7f99a6fdbae5566e17047273
+  specs:
+    devise_simply_stored (0.3.0)
+      devise
+
+GIT
+  remote: git://github.com/bterkuile/orm_adapter.git
+  revision: e0b5f652c8d1eda8c0f6636f3b3d17d598603450
+  specs:
+    orm_adapter (0.4.0)
+
+GIT
+  remote: git://github.com/bterkuile/simply_stored.git
+  revision: 05cb3a06a9d4a3588efd4491db42fac84276befb
+  specs:
+    simply_stored (1.0.0)
+      activesupport
+      couch_potato (>= 0.2.15)
+      rest-client (>= 1.4.2)
+
+PATH
+  remote: .
+  specs:
+    cmtool (1.0.0)
+      ace-rails-ap
+      bourbon
+      email_validator
+      font-awesome-rails
+      foundation-rails
+      jquery-rails
+      paperclip
+      pickadate-rails
+      slim-rails
+      tinymce-rails
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ace-rails-ap (3.0.3)
+    actionmailer (4.2.3)
+      actionpack (= 4.2.3)
+      actionview (= 4.2.3)
+      activejob (= 4.2.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.3)
+      actionview (= 4.2.3)
+      activesupport (= 4.2.3)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionpack-page_caching (1.0.2)
+      actionpack (>= 4.0.0, < 5)
+    actionview (4.2.3)
+      activesupport (= 4.2.3)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.3)
+      activesupport (= 4.2.3)
+      globalid (>= 0.3.0)
+    activemodel (4.2.3)
+      activesupport (= 4.2.3)
+      builder (~> 3.1)
+    activerecord (4.2.3)
+      activemodel (= 4.2.3)
+      activesupport (= 4.2.3)
+      arel (~> 6.0)
+    activesupport (4.2.3)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.3.8)
+    arel (6.0.2)
+    bcrypt (3.1.10)
+    bourbon (4.2.3)
+      sass (~> 3.4)
+      thor
+    builder (3.2.2)
+    capybara (2.4.4)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (~> 2.0)
+    climate_control (0.0.3)
+      activesupport (>= 3.0)
+    cliver (0.3.2)
+    cocaine (0.5.7)
+      climate_control (>= 0.0.3, < 1.0)
+    coderay (1.1.0)
+    coffee-script (2.4.1)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.9.1.1)
+    couch_potato (1.4.0)
+      activemodel
+      couchrest (~> 1.2.0)
+      json (~> 1.6)
+    couchrest (1.2.1)
+      mime-types (>= 1.15)
+      multi_json (~> 1.7, ~> 1.0)
+      rest-client (~> 1.8.0)
+    daemons (1.2.3)
+    devise (3.5.1)
+      bcrypt (~> 3.0)
+      orm_adapter (~> 0.1)
+      railties (>= 3.2.6, < 5)
+      responders
+      thread_safe (~> 0.1)
+      warden (~> 1.2.3)
+    diff-lcs (1.2.5)
+    domain_name (0.5.24)
+      unf (>= 0.0.5, < 1.0.0)
+    email_validator (1.6.0)
+      activemodel
+    erubis (2.7.0)
+    eventmachine (1.0.7)
+    execjs (2.5.2)
+    factory_girl (4.5.0)
+      activesupport (>= 3.0.0)
+    factory_girl_rails (4.5.0)
+      factory_girl (~> 4.5.0)
+      railties (>= 3.0.0)
+    font-awesome-rails (4.3.0.0)
+      railties (>= 3.2, < 5.0)
+    foundation-rails (5.5.2.1)
+      railties (>= 3.1.0)
+      sass (>= 3.3.0, < 3.5)
+    globalid (0.3.5)
+      activesupport (>= 4.1.0)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    i18n (0.7.0)
+    jquery-rails (4.0.4)
+      rails-dom-testing (~> 1.0)
+      railties (>= 4.2.0)
+      thor (>= 0.14, < 2.0)
+    json (1.8.3)
+    launchy (2.4.3)
+      addressable (~> 2.3)
+    loofah (2.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    method_source (0.8.2)
+    mime-types (2.6.1)
+    mini_portile (0.6.2)
+    minitest (5.7.0)
+    multi_json (1.11.2)
+    netrc (0.10.3)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    paperclip (4.2.4)
+      activemodel (>= 3.2.0)
+      activesupport (>= 3.2.0)
+      cocaine (~> 0.5.5)
+      mime-types
+    pickadate-rails (3.5.6.0)
+      railties (>= 3.1.0)
+    poltergeist (1.6.0)
+      capybara (~> 2.1)
+      cliver (~> 0.3.1)
+      multi_json (~> 1.0)
+      websocket-driver (>= 0.2.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-rails (0.3.4)
+      pry (>= 0.9.10)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.3)
+      actionmailer (= 4.2.3)
+      actionpack (= 4.2.3)
+      actionview (= 4.2.3)
+      activejob (= 4.2.3)
+      activemodel (= 4.2.3)
+      activerecord (= 4.2.3)
+      activesupport (= 4.2.3)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.3)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.6)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.2)
+      loofah (~> 2.0)
+    railties (4.2.3)
+      actionpack (= 4.2.3)
+      activesupport (= 4.2.3)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    responders (2.1.0)
+      railties (>= 4.2.0, < 5)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-its (1.2.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-rails (3.3.3)
+      actionpack (>= 3.0, < 4.3)
+      activesupport (>= 3.0, < 4.3)
+      railties (>= 3.0, < 4.3)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    sass (3.4.16)
+    sass-rails (5.0.3)
+      railties (>= 4.0.0, < 5.0)
+      sass (~> 3.1)
+      sprockets (>= 2.8, < 4.0)
+      sprockets-rails (>= 2.0, < 4.0)
+      tilt (~> 1.1)
+    slim (3.0.6)
+      temple (~> 0.7.3)
+      tilt (>= 1.3.3, < 2.1)
+    slim-rails (3.0.1)
+      actionmailer (>= 3.1, < 5.0)
+      actionpack (>= 3.1, < 5.0)
+      activesupport (>= 3.1, < 5.0)
+      railties (>= 3.1, < 5.0)
+      slim (~> 3.0)
+    slop (3.6.0)
+    sprockets (3.2.0)
+      rack (~> 1.0)
+    sprockets-rails (2.3.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    temple (0.7.6)
+    thin (1.6.3)
+      daemons (~> 1.0, >= 1.0.9)
+      eventmachine (~> 1.0)
+      rack (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tilt (1.4.1)
+    tinymce-rails (4.2.1)
+      railties (>= 3.1.1)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
+    warden (1.2.3)
+      rack (>= 1.0)
+    websocket-driver (0.6.2)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+    xpath (2.0.0)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ace-rails-ap
+  actionpack-page_caching
+  bourbon
+  capybara
+  cmtool!
+  coffee-script
+  devise
+  devise_simply_stored!
+  email_validator
+  factory_girl_rails
+  font-awesome-rails
+  foundation-rails
+  jquery-rails
+  launchy
+  orm_adapter!
+  paperclip (>= 3.4, != 4.3.0)
+  pickadate-rails
+  poltergeist
+  pry-rails
+  rails (~> 4.2.3)
+  rspec-its
+  rspec-rails
+  sass-rails
+  simply_stored!
+  slim-rails
+  thin
+  tinymce-rails

data/README.md

@@ -0,0 +1,157 @@
+# Cmtool
+[<img src="https://secure.travis-ci.org/bterkuile/cmtool.png?branch=master"
+alt="Build Status" />](http://travis-ci.org/bterkuile/cmtool)
+## About
+Cmtool is a CMS to give you a quickstart for a website using CouchDB as
+database backend. It is in developing stage, but already used in production.
+It is designed as an engine. The thought behind is that you will have to
+create your own rails website, but get a lot of stuff for free. These things
+are:
+
+*   User management
+*   Page management
+*   Faq
+*   News
+*   Newsletter subscriptions
+*   Directory manager
+*   Image manager
+
+
+## Setup
+To start using Cmtool as website CMS add it to your Gemfile. Since it  depends
+on github gems and gem dependencies do not support those you have to
+explicitly add two dependencies to your Gemfile:
+    gem 'couch_potato' , github: 'bterkuile/couch_potato'
+    gem 'simply_stored' , github: 'bterkuile/simply_stored'
+    gem 'cmtool'
+
+Make sure that the locales you want to work with are specified in
+```config/application.rb```.
+```ruby
+  config.i18n.default_locale = :en
+  config.i18n.available_locales = [:en, :nl]
+```
+
+This will add some gems you might like anyway, here a list:
+
+*   bourbon
+*   jquery-rails
+*   tinymce-rails
+*   sass-rails
+*   paperclip
+*   email_validator (validates :email, email: true)
+
+
+### Controllers
+
+in `app/controllers/pages_controller.rb`:
+
+```ruby
+class PagesController < ApplicationController
+  include Cmtool::Includes::PagesController
+end
+```
+
+### Securing
+
+Cmtool is looking for an authorize_cmtool method present in the application
+controller. Something like:
+
+```ruby
+class ApplicationController
+  ...
+
+  private
+
+  def authorize_cmtool
+    redirect_to main_app.root_path, alert: t('general.unauthorized') unless current_user.present? && current_user.is_admin?
+  end
+end
+```
+
+### Routing
+
+Add the following routes with changes according to your application:
+```ruby
+ALLOWED_LOCALES = /nl|de|fr|en|es/
+devise_for :users, :controllers => {:sessions => 'cmtool/sessions', :passwords => 'cmtool/passwords'}
+mount Cmtool::Engine => '/cmtool'
+get '/:locale' => 'pages#home', constraints: {locale: ALLOWED_LOCALES}, as: :go_to_locale
+get '/sitemap(.:format)' => 'pages#sitemap'
+scope '(/:locale)', constraints: {locale: ALLOWED_LOCALES}, defaults: { locale: :nl } do
+  root to: 'pages#home'
+  get "/:name" => "pages#show", constraints: {name: /.*/},  as: :page
+end
+get "/*url" => "pages#not_found"
+```
+
+### User model
+The user model is important. We recommend you to create your own user model:
+```ruby
+class User
+  include Cmtool::User
+
+end
+```
+
+This is enough to start using Cmtool. But probably you want to add some
+goodies of your own. Remember that this is a SimplyStored model with almost
+all the ActiveModel features.
+
+### Page model
+The page model allows you to control some interesting things.
+
+in `app/models/page.rb`:
+```ruby
+class Page
+  include Cmtool::Includes::Page
+
+  # Define the layouts you want to use in your website. Be sure to create them in
+  # app/views/layouts/...
+  # The first specified layout will become the default
+  def self.layouts
+    %w[application home contact]
+  end
+end
+```
+
+### Controlling the language of the system
+If you add a method `cmtool_locale` to your application controller Cmtool will
+take this value:
+```ruby
+class ApplicationController
+  before_filter :set_locale
+
+  private
+
+  def set_locale
+    # Do some magic
+    I18n.locale = :en
+  end
+
+  def cmtool_locale
+    I18n.locale
+  end
+end
+```
+
+### Customize a page
+All pages by default are rendered using the view: app/pages/show. So adding
+and changing this file will change all displayed pages without their own
+specific page. To create a specific page, create a page with the name of the
+page you created in the Admin section. If for example you have created a page
+with the name: about Then you can give this page a custom look using the view:
+`app/views/about.html.slim` 
+
+### The menu and getting pages
+
+### Customize your 404
+You can customize what is shown when a page cannot be found. There is a
+standard view app/pages/404.html.erb with the following content:
+
+    <%= render template: 'pages/show' %>
+
+Overwrite this to get another page as show. To controll the content of the 404
+page, create a page in the Admin area having the name: 404.  You can make a
+404 page for every language in this manner. Here you can also give a custom
+layout if you do not want to use the default layout.