alchemy_cms 3.0.4 → 3.1.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a98f349ff1159991c93354c2cd40b77793ade10
-  data.tar.gz: a7378076e929a7fe8f80fc59256041260f3ff7dd
+  metadata.gz: d8ff921fd176dd5ee1ffbbb6c23b73d3a03f6f05
+  data.tar.gz: 09825c9d513e598cab488839e88f80ef301f2c67
 SHA512:
-  metadata.gz: 081d537f1cc0a4528039e2466885fbe41b072f24131d08f4757cca4e91bafa6867c6ee4b255d90db5a3fb0b07f12f4c02714d4b4c6b5915781b652ab81c7e4f8
-  data.tar.gz: eea901691a4b7351154098e8ff0f8635b3233381e20529ef284d463213fab9b2b9a224f78183a83fb9924df9505844c3a8a3ada02451c326b04be525df54f5c8
+  metadata.gz: 5baf66ef54d6670f7f8f05d5a55bdfef93d7725c9084d12dd84cd430851ff261190473837555fb767fd9822326582474c71b15e088a53dbf4e96e44473a3d85d
+  data.tar.gz: e3cfe5a46b73571a77da7296df1b1d8c978b7ab6004e6f7ce9e8b9c42e1910cd0e24cac3ab81f1edc5238e7d7a492889d9e266b3cfa47f975de6daa1a5b11e1a

data/.travis.yml

@@ -1,19 +1,17 @@
 language: ruby
-sudo: false
-cache: bundler
 rvm:
   - 1.9.3
   - 2.0.0
   - 2.1
 branches:
   only:
-    - 3.0-stable
-before_script: 'bundle exec rake alchemy:spec:prepare'
-script: 'bundle exec rspec'
+    - master
+before_script: 'rake alchemy:spec:prepare'
+script: rspec
 env:
   - DB=mysql
   - DB=postgresql
-  - RAILS_VERSION=4.0.13
+  - RAILS_VERSION=4.1.5
 notifications:
   irc:
     on_success: change

data/Gemfile

@@ -3,15 +3,12 @@ source 'http://rubygems.org'
 gemspec
 
 if ENV['RAILS_VERSION']
-  gem 'rails', ENV['RAILS_VERSION']
+  gem 'rails', "~> #{ENV['RAILS_VERSION']}"
 end
 
 # Code coverage plattform
 gem 'coveralls', require: false
 
-# Fixes issues with wrong exit codes. See: https://github.com/colszowka/simplecov/issues/269
-gem 'simplecov', '0.7.1'
-
 gem 'database_cleaner'
 
 group :test do
@@ -19,6 +16,7 @@ group :test do
   gem 'mysql2'                if ENV['DB'] == 'mysql'
   gem 'pg'                    if ENV['DB'] == 'postgresql'
   gem 'poltergeist'
+  gem 'rspec-activemodel-mocks'
   unless ENV['CI']
     gem 'launchy'
   end
@@ -27,12 +25,11 @@ end
 group :development, :test do
   unless ENV['CI']
     gem 'annotate'
-    gem 'pry'
     gem 'bumpy'
     gem 'yard'
     gem 'redcarpet'
-    gem 'pry-rails'
-    gem 'spring', '~> 1.1.0.beta2'
+    gem 'pry-byebug'
+    gem 'spring'
     gem 'spring-commands-rspec'
   end
   gem 'jasmine-rails', github: 'searls/jasmine-rails'

data/README.md

@@ -1,32 +1,31 @@
-[![Gem Version](https://badge.fury.io/rb/alchemy_cms.svg)](http://badge.fury.io/rb/alchemy_cms)
-[![Build Status](https://travis-ci.org/AlchemyCMS/alchemy_cms.svg?branch=3.0-stable)](https://travis-ci.org/AlchemyCMS/alchemy_cms) [![Code Climate](https://codeclimate.com/github/AlchemyCMS/alchemy_cms.svg)](https://codeclimate.com/github/AlchemyCMS/alchemy_cms) [![Coverage Status](https://img.shields.io/coveralls/AlchemyCMS/alchemy_cms.svg)](https://coveralls.io/r/AlchemyCMS/alchemy_cms?branch=3.0-stable)
+[![Gem Version](https://badge.fury.io/rb/alchemy_cms.png)](http://badge.fury.io/rb/alchemy_cms)
+[![Build Status](https://travis-ci.org/magiclabs/alchemy_cms.svg?branch=master)](https://travis-ci.org/magiclabs/alchemy_cms) [![Code Climate](https://codeclimate.com/github/magiclabs/alchemy_cms.png)](https://codeclimate.com/github/magiclabs/alchemy_cms) [![Coverage Status](https://coveralls.io/repos/magiclabs/alchemy_cms/badge.png?branch=master)](https://coveralls.io/r/magiclabs/alchemy_cms?branch=master)
+
+**CAUTION: This master branch is a development branch that can contain bugs. For productive environments you should use the [current Ruby gem version](http://rubygems.org/gems/alchemy_cms/versions/3.0.0), or the [latest stable branch (3.0-stable)](https://github.com/magiclabs/alchemy_cms/tree/3.0-stable).**
 
 About
 -----
 
 ![Alchemy CMS](http://alchemy-cms.com/assets/alchemy_logo.svg)
 
-Alchemy is the most powerful, userfriendly and flexible Rails CMS.
+Alchemy is a powerful, flexible and user centric Rails CMS.
 
-Read more on the [website](http://alchemy-cms.com) and in the [guidelines](http://guides.alchemy-cms.com).
+Read more about Alchemy on the [website](http://alchemy-cms.com) and in the [guidelines](http://guides.alchemy-cms.com).
 
 Features
 --------
 
-- Highly flexible Templating
-- Gorgious End-User centric interface
-- Multilingual
-- Multidomain
-- SEO friendly
-- Access Control
-- RSS Feeds
-- Contactforms
+- Highly flexible templating that completely separates content from markup
+- End-User centric graphical user interface
+- Multi language and multi domain
+- SEO friendly urls
+- User Access Control
+- Build in contact form mailer
 - Attachments and downloads
 - Powerful image rendering
-- Extendable
-- Integrates in existing Rails Apps
-- Caching
-- BSD License
+- Extendable via Rails engines
+- Integrates into existing Rails Apps
+- Flexible caching
 - Hostable on any Server that supports Ruby on Rails, a SQL Database and ImageMagick
 
 Rails Version
@@ -34,181 +33,261 @@ Rails Version
 
 **This version of Alchemy CMS runs with Rails 4 (including 4.1)**
 
-If you are looking for a Rails 3.2 compatible version check the [2.8-stable branch](https://github.com/AlchemyCMS/alchemy_cms/tree/2.8-stable).
-
-If you are looking for a Rails 3.1 compatible version check the [2.1-stable branch](https://github.com/AlchemyCMS/alchemy_cms/tree/2.1-stable).
+**Rails 4.2 support is coming soon. Watch [this pull request](https://github.com/magiclabs/alchemy_cms/pull/655).**
 
-If you are looking for a Rails 3.0 compatible version check the [2.0-stable branch](https://github.com/AlchemyCMS/alchemy_cms/tree/2.0-stable).
-
-If you are looking for a Rails 2.3 compatible version check the [1.6-stable branch](https://github.com/AlchemyCMS/alchemy_cms/tree/1.6-stable).
+* For a Rails 3.2 compatible version use the [`2.8-stable` branch](https://github.com/magiclabs/alchemy_cms/tree/2.8-stable).
+* For a Rails 3.1 compatible version use the [`2.1-stable` branch](https://github.com/magiclabs/alchemy_cms/tree/2.1-stable).
+* For a Rails 3.0 compatible version use the [`2.0-stable` branch](https://github.com/magiclabs/alchemy_cms/tree/2.0-stable).
+* For a Rails 2.3 compatible version use the [`1.6-stable` branch](https://github.com/magiclabs/alchemy_cms/tree/1.6-stable).
 
 Ruby Version
 ------------
 
 Alchemy runs with Ruby >= 1.9.3 (including Ruby 2.0 and 2.1).
 
-For a Ruby 1.8.7 compatible version use the [2.3-stable branch](https://github.com/AlchemyCMS/alchemy_cms/tree/2.3-stable).
+For a Ruby 1.8.7 compatible version use the [`2.3-stable` branch](https://github.com/magiclabs/alchemy_cms/tree/2.3-stable).
 
 
 Installation
 ------------
 
-### Translation requirements
+### Install as a standalone project
 
-#### Russian:
+Use the installer:
 
-If you want to use Russian translation and have better i18n support, you should put:
+```shell
+$ gem install alchemy_cms --pre
+$ alchemy new my_magicpage
+```
 
-    gem 'russian', '~> 0.6.0'
+and follow the instructions to finish the installation.
 
-or similar in functionality gem into your Gemfile before running:
+The installer has some options (like choosing the database). See them with:
 
-    bundle install
+```shell
+$ alchemy --help
+```
 
-### As a standalone project
+### Install into an existing Rails project
 
-#### 1. Use the installer:
+#### 1. Add the Alchemy gem:
 
-    gem install alchemy_cms
-    alchemy new my_magicpage
-    cd my_magicpage
+Put this into your `Gemfile`:
 
-Run
+```ruby
+gem 'alchemy_cms', github: 'magiclabs/alchemy_cms', branch: 'master'
+```
 
-    bundle install
+**NOTE:** You normally want to use a stable branch, like `3.0-stable`.
 
-to finish installation process.
+#### 2. Update your bundle:
 
-#### 2. Start the local server:
+```shell
+$ bundle install
+```
 
-    bin/rails server
+#### 3. Set the authentication user
 
-#### 3. Switch to your browser:
+Now you have to decide, if you want to use your own user model or if you want to use
+the Devise based user model that Alchemy provides and was extracted [into its own gem](https://github.com/magiclabs/alchemy-devise).
 
-Open `http://localhost:3000` and follow the on screen instructions.
+##### Use Alchemy user
 
-### Into an existing Rails project
+If you don't have your own user class, you can use the Alchemy user model. Just add the following gem into your `Gemfile`:
 
-#### 1. Add the Alchemy gem:
+```ruby
+gem 'alchemy-devise', '~> 2.0'
+```
 
-In your App's Gemfile:
+Then run:
 
-    gem 'alchemy_cms', github: 'AlchemyCMS/alchemy_cms', branch: '3.0-stable'
+```shell
+$ bundle install
+$ bin/rake alchemy_devise:install:migrations
+```
 
-#### 2. Install Alchemy into your app:
+##### Use your User model
 
-Run in terminal:
+In order to use your own user model you need to tell Alchemy about it.
 
-    bundle install
-    bin/rake alchemy:install
+The best practice is to use an initializer:
 
-### Authentication User Model
+```ruby
+# config/initializers/alchemy.rb
+Alchemy.user_class_name = 'YourUserClass'       # Defaults to 'User'
+Alchemy.login_path      = '/your/login/path'    # Defaults to '/login'
+Alchemy.logout_path     = '/your/logout/path'   # Defaults to '/logout'
+```
 
-With Version 3.0 we extracted the Alchemy user model [into its own gem](https://github.com/AlchemyCMS/alchemy-devise).
+The only thing Alchemy needs to know from your user class is the `alchemy_roles` method.
 
-In order to get the former Alchemy user model back, add the following gem into your Gemfile:
+This method has to return an `Array` (or `ActiveRecord::Relation`) with at least one of the following roles: `member`, `author`, `editor`, `admin`.
 
-    gem 'alchemy-devise', '~> 2.0'
+Example:
 
-Run in terminal:
+```ruby
+# app/models/user.rb
 
-    bundle install
-    bin/rake alchemy_devise:install:migrations db:migrate
+def alchemy_roles
+  if admin?
+    %w(admin)
+  end
+end
+```
 
-**In order to use your own user model, you can add e.g.**
+Please follow [this guide](http://guides.alchemy-cms.com/edge/custom_authentication.html) for further instructions on how to customize your user class even more.
 
-    # config/initializers/alchemy.rb
-    Alchemy.user_class_name = 'YourUserClass'
-    Alchemy.login_path = '/your/login/path'
-    Alchemy.logout_path = '/your/logout/path'
+#### 4. Install Alchemy into your app:
 
-The only thing Alchemy needs to know from your user model is the `alchemy_roles` method.
+**After** you set the user model you need to run the Alchemy install task:
 
-This method has to return an `Array` or `ActiveRecord::Relation` with at least one of the following roles:
+```shell
+$ bin/rake alchemy:install
+```
 
-* `member`
-* `author`
-* `editor`
-* `admin`
+Now everything should be set up and you should be able to visit the Alchemy Dashboard at:
 
-Example:
+<http://localhost:3000/admin>
 
-    def alchemy_roles
-      self.admin?
-        %w(admin)
-      end
-    end
+*) Use your custom path if you mounted Alchemy at something else then `'/'`
 
-**Optionally** you can add a `alchemy_display_name` method that returns a name representing the currently logged in user. This is used in the admin views.
 
-Example:
+Customizing
+-----------
 
-    def alchemy_display_name
-      "#{first_name} #{last_name}".strip
-    end
+Alchemy has very flexible ways to organize and manage content. Please be sure to read [the introduction guide](http://guides.alchemy-cms.com/edge/index.html) in order to understand the basic idea of how Alchemy works.
 
-Testing
--------
 
-Before running tests (which refer to Alchemy), please make sure to run the rake task
+Upgrading
+---------
 
-    bundle exec rake alchemy:spec:prepare
+The Alchemy team takes upgrades very seriously and tries to make them as smooth as we can. Therefore we have build in upgrade tasks, that try to automate as much as possible.
 
-to set up the database for testing.
+That's why after updating the Alchemy gem you should **always run the upgrader**:
 
-Now you can run your tests, e. g. with RSpec:
+```shell
+$ bundle update alchemy_cms
+$ bin/rake alchemy:upgrade
+```
 
-    bundle exec rspec spec/...
+Alchemy will print out useful information after running the automated tasks that help a smooth upgrade path. So please **take your time and read them**.
 
-**Alternatively** you can just run:
+Always be sure to keep an eye on the `config/alchemy/config.yml.defaults` file and update your `config/alchemy/config.yml` accordingly.
 
-    bundle exec rake
+Also, `git diff` is your friend. You are using git to track changes of your projects, right?
 
-This default task executes the database preparations and runs all defined test cases.
 
 Deployment
 ----------
 
-Alchemy ships with a generator that creates a Capistrano `config/deploy.rb` file, which
-takes care of everything you need to deploy an Alchemy site.
+Alchemy ships with Capistrano based deployment receipts which takes care of everything you need to deploy an Alchemy site.
 
-So, if you don't have your own deploy file, we encourage you to use this generator:
+#### Add Capistrano gem
 
-    $ bin/rails g alchemy:deploy_script
+First you need to add Capistrano to your `Gemfile`:
 
-If you have your own Capistrano receipts, you should require the Alchemy tasks in your app's `config/deploy.rb` file:
+```ruby
+# Gemfile
+gem 'capistrano', '2.15.5', group: 'development'
+```
 
-    # deploy.rb
-    require 'alchemy/capistrano'
+**A note about Capistrano version:**
 
-If you don't use Capistrano you have to **make sure that the `uploads`, `tmp/cache/assets`, `public/assets` and `public/pictures` cache folders get shared** between deployments, otherwise you **will loose data**.
+Alchemy's deploy script is currently **only compatible with Capistrano 2.x** ([See this pull request](https://github.com/magiclabs/alchemy_cms/pull/616) if you want to help us upgrade to 3.x).
 
-Please take a look into the `lib/alchemy/capistrano.rb` file, to see how to achieve this.
+#### Generate the deploy file
 
-Upgrading
----------
+To generate the deploy file you need to use this generator:
 
-After updating the Alchemy gem in your App, you should run the upgrader.
+```shell
+$ bin/rails g alchemy:deploy_script
+```
 
-Run in terminal:
+and follow the instructions.
 
-    bin/rake alchemy:upgrade
+If you *have your own Capistrano receipts* you can require the Alchemy tasks in your `config/deploy.rb` file:
 
+```ruby
+# deploy.rb
+require 'alchemy/capistrano'
+```
 
-Tips
------
+#### Synchronize your data
+
+Alchemy Capistrano receipts offer much more then only deployment related tasks. We also have tasks to make your local development easier. To get a list of all receipts type:
+
+```shell
+$ bundle exec cap -T alchemy
+```
+
+##### Import data from server
+
+```shell
+$ bundle exec cap alchemy:import:all
+```
+
+This imports your servers data onto your local development machine. This is very handy if you want to clone the current server state.
+
+##### Export data to server
+
+That even works the other way around:
+
+```shell
+$ bundle exec cap alchemy:export:all
+```
+
+**NOTE:** This will **overwrite the database** on your server. But calm down my dear friend, Alchemy will ask you to perform a backup before overwriting it.
+
+#### Without Capistrano
 
-- Read the guidelines: http://guides.alchemy-cms.com.
-- Read the documentation: http://rubydoc.info/github/AlchemyCMS/alchemy_cms
-- Ask the community: http://groups.google.com/group/alchemy-cms
+If you don't use Capistrano you have to **make sure** that the `uploads`, `tmp/cache/assets`, `public/assets` and `public/pictures` folders get **shared between deployments**, otherwise you **will loose data**. No, not really, but you know, just keep them in sync.
+
+Please take a look into Alchemys [Capistrano receipt](https://github.com/magiclabs/alchemy_cms/blob/master/lib/alchemy/capistrano.rb) in order to see how you could achieve this.
+
+
+Testing
+-------
+
+If you want to contribute to Alchemy ([and we encourage you to do so](https://github.com/magiclabs/alchemy_cms/blob/master/CONTRIBUTING.md)) we have a strong test suite that helps you to not break anything.
+
+To prepare the tests of your Alchemy fork please make sure to run the preparation task:
+
+```shell
+# ~/your/local/alchemy_cms
+$ bin/rake alchemy:spec:prepare
+```
+
+to set up the database for testing.
+
+##### Run your tests with:
+
+```shell
+$ bundle exec rspec
+```
+
+**Alternatively** you can just run:
+
+```shell
+$ bundle exec rake
+```
+
+*) This default task executes the database preparations and runs all defined test cases.
+
+**A note about RSpec version:**
+
+Alchemy specs are written **in RSpec 3**. Please **do not use depricated RSpec 2.x syntax**. Thanks
 
 
 Getting Help
 ------------
 
-* If you have bugs, please use the [issue tracker on Github](https://github.com/AlchemyCMS/alchemy_cms/issues).
-* For Q&A and general usage, please use the [User Group](http://groups.google.com/group/alchemy-cms) or the IRC channel.
-* New features should be discussed on our [Trello Board](https://trello.com/alchemycms). *PLEASE* don't use the Github issues for new features.
+* Read the guidelines: http://guides.alchemy-cms.com.
+* Read the documentation: http://rubydoc.info/github/magiclabs/alchemy_cms
+* If you found a bug please use the [issue tracker on Github](https://github.com/magiclabs/alchemy_cms/issues).
+* For questions about general usage please use [Stack Overflow](http://stackoverflow.com/questions/tagged/alchemy-cms), [the User Group](http://groups.google.com/group/alchemy-cms) or the [IRC channel](irc://irc.freenode.net#alchemy_cms).
+* New features should be discussed on our [Trello Board](https://trello.com/alchemycms).
+
+**PLEASE** don't use the Github issues for feature requests. If you want to contribute to Alchemy please [read the contribution guidelines](https://github.com/magiclabs/alchemy_cms/blob/master/CONTRIBUTING.md) before doing so.
 
 
 Resources
@@ -216,12 +295,14 @@ Resources
 
 * Homepage: <http://alchemy-cms.com>
 * Live-Demo: <http://demo.alchemy-cms.com> (user: demo, password: demo123)
-* API Documentation: <http://rubydoc.info/github/AlchemyCMS/alchemy_cms>
-* Issue-Tracker: <https://github.com/AlchemyCMS/alchemy_cms/issues>
-* Sourcecode: <https://github.com/AlchemyCMS/alchemy_cms>
+* API Documentation: <http://rubydoc.info/github/magiclabs/alchemy_cms>
+* Issue-Tracker: <https://github.com/magiclabs/alchemy_cms/issues>
+* Sourcecode: <https://github.com/magiclabs/alchemy_cms>
 * User Group: <http://groups.google.com/group/alchemy-cms>
-* IRC Channel: #alchemy_cms on irc.freenode.net
+* IRC Channel: <irc://irc.freenode.net#alchemy_cms>
 * Discussion Board: <https://trello.com/alchemycms>
+* Twitter: <https://twitter.com/alchemy_cms>
+
 
 Authors
 ---------
@@ -232,7 +313,18 @@ Authors
 * Hendrik Mans: <https://github.com/hmans>
 * Carsten Fregin: <https://github.com/cfregin>
 
+
 License
 -------
 
-* BSD: <https://raw.github.com/AlchemyCMS/alchemy_cms/master/LICENSE>
+* BSD: <https://raw.github.com/magiclabs/alchemy_cms/master/LICENSE>
+
+
+Spread the love
+---------------
+
+If you like Alchemy, please help us to spread the word about Alchemy and star this repo [on GitHub](https://github.com/magiclabs/alchemy_cms), upvote it [on The Ruby Toolbox](https://www.ruby-toolbox.com/projects/alchemy_cms), mention us [on Twitter](https://twitter.com/alchemy_cms) and vote for it [on Bitnami](https://bitnami.com/stack/alchemy).
+
+That will help us to keep Alchemy awesome.
+
+Thank you <3!