cream 0.8.3 → 0.8.4

data/Changelog.txt

@@ -1,3 +1,9 @@
+0.8.4 - Jan 1, 2011
+-----
+Fixed argument error in #routes_configure! in devise:config generator
+(Also fixed minor bug in 'rails3_assist' gem to allow block as argument in order to insert content into the routes file.
+Now the full_config generator should run just fine again!
+
 Dec 18, 2010
 ---
 Improved ORM validation and handling 

data/{README.markdown → README.textile}

@@ -1,15 +1,13 @@
-# Cream
+h1. Cream
 
 This project aims to assist you in setting up a complete Authentication and Authorization system for your Rails 3 app and supports multiple ORMs.
 Just run the *full_config* generator with arguments specifying: roles available, the role strategy to use and the ORM to target and you are set to go.
 
-_Note_: Cream leverages an extensive set of framework components I have created specifically to make it much easier/faster to create Rails 3 plugins and spec/test them, using more natural DSLs. Look into the code to see the magic!
-
 Cream targets smooth integration of the following systems:
 
-* [Devise](http://github.com/plataformatec/devise) - Authorization
-* [CanCan](http://github.com/ryanb/cancan) - Authentication
-* [Roles Generic](http://github.com/kristianmandrup/roles_generic) - Roles
+* "Devise":http://github.com/plataformatec/devise - Authentication
+* "CanCan":http://github.com/ryanb/cancan - Authorization
+* "Roles Generic":http://github.com/kristianmandrup/roles_generic - Roles
 
 For more advanced Authorization configuration, cream uses *cancan-permits* to enable use of *Permits* and *Licenses*.
 The gems *devise-links* and *cancan-rest-links* provide view helpers to facilitate working with authentication links and to enable REST links with permission logic.
@@ -20,51 +18,59 @@ The objectives of this project:
 * Integrate all these sub-systems
 * Provide generators that can auto-configure your Rails 3 app with these systems for a given ORM
 
-## Rails 3 demo apps with Cream
+For more information also see the "Cream Wiki":https://github.com/kristianmandrup/cream/wiki, which includes Cream status notes and a complete listing and usage examples of the latest *Roles Generic API*. The wiki also contains an overview of the full Cream API, which contains various helper methods to facilitate working with Users, Sessions, Roles and Permissions in both your views and controllers. Please let me know of other areas that you think should be covered in the Wiki or on this main page ;) 
+
+_Note_: Cream leverages an extensive set of framework components I have created specifically to make it much easier/faster to create Rails 3 plugins and spec/test them, using more natural DSLs. Look into the code to see the magic!
+
+h2. Cream user group
+
+The "Cream user group":http://groups.google.com/group/rails-cream is a google group where you can ask Cream related questions, provide suggestions etc. to the Cream community.
+
+h2. Rails 3 demo apps with Cream
 
 The following Rails 3 demo apps use Cream 0.7.7 and above and were created around Dec 1. 2010
 
-* [Cream app with Active Record](https://github.com/kristianmandrup/cream-app-active_record) 
-* [Cream app with Mongoid](https://github.com/kristianmandrup/cream-app-mongoid) 
-* [Cream app with Mongo Mapper](https://github.com/kristianmandrup/cream-app-mongo_mapper) 
+* "Cream app with Active Record":https://github.com/kristianmandrup/cream-app-active_record
+* "Cream app with Mongoid":https://github.com/kristianmandrup/cream-app-mongoid
+* "Cream app with Mongo Mapper":https://github.com/kristianmandrup/cream-app-mongo_mapper
 
-## Authentication systems
+h2. Authentication systems
 
-Cream targets [devise](http://github.com/plataformatec/devise) as the Authentication system of choice
+Cream targets "Devise":http://github.com/plataformatec/devise as the Authentication system of choice
 
-### Devise links
+h3. Devise links
 
-The project [devise links](http://github.com/kristianmandrup/devise-links) adds more convenience for creating view links to trigger Devise session actions.
+The project "devise links":http://github.com/kristianmandrup/devise-links adds more convenience for creating view links to trigger Devise session actions.
 
-## Authorization system
+h2. Authorization system
 
-There is support for the [CanCan](http://github.com/ryanb/cancan) Authorization system. 
-I have created a [Cancan permits](http://github.com/kristianmandrup/cancan-permits) gem that adds the concept of Permits for each role (see below).
+There is support for the "CanCan":http://github.com/ryanb/cancan Authorization system. 
+I have created a "Cancan permits":http://github.com/kristianmandrup/cancan-permits gem that adds the concept of Permits for each role (see below).
 
-## Roles
+h2. Roles
 
-I have developed a flexible [Roles Generic](http://github.com/kristianmandrup/roles_generic) system which is used as the basis for the default Role system.
+I have developed a flexible "Roles Generic":http://github.com/kristianmandrup/roles_generic system which is used as the basis for the default Role system.
 
 The *Roles Generic API* has been implemented for the following ORMs
 
-* [Roles Active Record](http://github.com/kristianmandrup/roles_active_record)
-* [Roles DataMapper](http://github.com/kristianmandrup/roles_data_mapper)
-* [Roles MongoMapper](http://github.com/kristianmandrup/roles_mongo_mapper)
-* [Roles Mongoid](http://github.com/kristianmandrup/roles_for_mongoid)
-* [Roles Simply Stored](https://github.com/kristianmandrup/roles_simply_stored)
+* "Roles Active Record":http://github.com/kristianmandrup/roles_active_record
+* "Roles DataMapper":http://github.com/kristianmandrup/roles_data_mapper
+* "Roles MongoMapper":http://github.com/kristianmandrup/roles_mongo_mapper
+* "Roles Mongoid":http://github.com/kristianmandrup/roles_for_mongoid
+* "Roles Simply Stored":https://github.com/kristianmandrup/roles_simply_stored
 
-_Note_: Any role system can be substituted as long as you have a method #has_role? on the user which returns true or false given a string or symbol that identifies the role.
+Any role system can be substituted as long as you have a method #has_role? on the user which returns true or false given a string or symbol that identifies the role.
 
-### Role Groups
+h3. Role Groups
 
 Document DBs such as *Mongo* and *Riak* are ideal for modeling a role-group hierarchical relationship. 
 Role-Group support is planned as a future add-on for the roles strategies integration. (Any assistance appreciated!)
 
-## ORMs
+h2. ORMs
 
 In general, it should now finally be pretty easy to set up a Rails 3 app, with a full Authentication and an Authorization system linked to a Role system using one of the following supported Cream ORMs. 
 
-Relational DB:
+Relational Databases:
 
 * Active Record
 * Data Mapper
@@ -77,47 +83,51 @@ Document stores:
 
 These ORMs are also supported for the *CanCan Permits* and *Roles* systems. 
 
-## Installation and configuration ##
+h2. Installation and configuration
 
-This gem has been designed for Rails 3 only.
+This gem has been designed for Rails 3 and Ruby 1.9 only. Some users have notified me that it doesn't work on Ruby 1.8.7, so be advised!
 
-### Install gems
+h3. Install gems
 
 Insert <pre>gem 'cream'</pre> in your Rails 3 Gemfile
 <pre>$ bundle install</pre>
 
-## Role system
+h2. Role system
 
-Role strategies can be set up using the [Roles Generic](http://github.com/kristianmandrup/roles_generic) gem or any of the ORM specific roles gems such as [Roles Active Record](http://github.com/kristianmandrup/roles_active_record). 
+Role strategies can be set up using the "Roles Generic":http://github.com/kristianmandrup/roles_generic gem or any of the ORM specific roles gems such as 
+"Roles Active Record":http://github.com/kristianmandrup/roles_active_record. 
 
-## CanCan
+h2. CanCan
 
-Role based authorization for [CanCan](http://github.com/ryanb/cancan) can be achieved by creating a *Permit* class for each role. 
+Role based authorization for "CanCan":http://github.com/ryanb/cancan can be achieved by creating a *Permit* class for each role. 
 
-### Permits
+h3. Permits
 
 A *Permit* lets a user in a given role do certain actions as defined in the Permit. 
 A Permit can also reuse permission logic in the form of Licenses for a more fine grained design if needed. 
 
 CanCan Permits comes with generators to generate Permit files which are placed in '/app/permits'. You can then edit the Permits to suit your needs.
 
-The project [CanCan REST links](http://github.com/kristianmandrup/cancan-rest-links) provides a convenient way to handle CanCan REST links, using a flexible API.
+The project "CanCan REST links":http://github.com/kristianmandrup/cancan-rest-links provides a convenient way to handle CanCan REST links, using a flexible API.
 
-Check out [Cancan permits](http://github.com/kristianmandrup/cancan-permits) for more info for how to use Permits.
+Check out "Cancan permits":http://github.com/kristianmandrup/cancan-permits for more info for how to use Permits.
 
 *Cancan permits* support all the ORMs that both Devise and Roles support.
 
-### Permits Editor
+h3. Permits Editor
 
-I have recently created a [Permits editor](http://github.com/kristianmandrup/permits_editor) application that demonstrates how you can let the user edit the Permits, Licenses and even individual User permissions directly as part of an admin section of the web app. The *Permits editor* updates yaml files that are now part of the *cancan-permits* infrastructure (if present and registered).
+I have recently created a "Permits editor":http://github.com/kristianmandrup/permits_editor application that demonstrates how you can let the user edit the Permits, Licenses and even individual User permissions directly as part of an admin section of the web app. 
 
-### Licenses
+The *Permits editor* updates yaml files that are now part of the *cancan-permits* infrastructure (if present and registered). 
+I plan to refactor the Permits Editor into a "mountable app":http://piotrsarnacki.com/2010/12/21/mountable-apps-tutorial/ when I have the time.
+
+h3. Licenses
 
 For more advanced authorization scenarios you can create reusable permission logic in license classed that are placed in '/app/licenses/'. A License can be reused in multiple Permits. 
 
-See [CanCan permits demo app](https://github.com/kristianmandrup/cancan-permits-demo) for an example of how to use cancan-permits and licenses.
+See "CanCan permits demo app":https://github.com/kristianmandrup/cancan-permits-demo for an example of how to use cancan-permits and licenses.
 
-## Generators
+h2. Generators
 
 The following generators are currently available:
 
@@ -136,20 +146,17 @@ Config generators:
 Other generators:
 
 * cancan:restlinks - Create REST links locale file 
-* devise:links - Create devise links locale file (rename to authlinks?)
-* cream:views - Generates partials for menu items
+* devise:links - Create devise links locale file (should I rename this to authlinks?)
+* cream:views - Generates partials for menu items (outdated)
 
-All the above generators have specs included in cream that demonstrate how to use them and should verify that they work as expected (Note: some of the generator specs may be outdated!?). 
+All the above generators have specs included in cream that demonstrate how to use them and should verify that they work as expected.
 
-In general, the *cream:full_config* generator can be seen as a kind of "super generator", in that it should call all the sub-generators in succession to fully configure
-the Rails 3 app in one go. 
+The *cream:full_config* generator should call all the sub-generators in succession to fully configure the Rails 3 app according to your preferences. 
 
-### Full Config Generator ###
+h3. Full Config Generator
 
 Master cream generator which calls the sub-generators in succession.
 
-<code>rails g cream:full_config --strategy ROLE_STRATEGY [--admin_user] [--orm ORM] [--roles ROLE1 ROLE2] [--logfile LOGFILE]</code>
-
 * --strategy      : role strategy to use (see *roles_generic* gem)
 * --admin-user    : create admin user model with separate devise configuration
 * --orm           : orm to be used
@@ -161,13 +168,13 @@ Example
 
 By default creates :guest and :admin roles.
 
-## Sub generators
+h2. Sub generators
 
 To view the run options of any of the sub generators, simply type $ rails g [GENERATOR_NAME]
 
 Example: <code>rails g permits:config</code>
 
-### Views Generator ###
+h3. Cream Views Generator
 
 Moves 'user menu' partials views into app/views/_user_menu
 
@@ -176,9 +183,9 @@ Moves 'user menu' partials views into app/views/_user_menu
 * scope  : The scope folder under views to copy the partials to, fx 'admin'
 * --haml : Use HAML as template language
 
-_Note_: This *views* generator is based on a similar generator from the devise project. It might be removed in the near future as these menu items would make more sense as simple view helpers (suggestions?).
+The *views* generator is based on a similar generator from the devise project. This generator might be removed in the near future, as the menu items would make more sense as simple view helpers (suggestions welcome).
 
-## Note on Patches/Pull Requests ##
+h2. Note on Patches/Pull Requests
  
 * Fork the project.
 * Make your feature addition or bug fix.
@@ -188,6 +195,6 @@ _Note_: This *views* generator is based on a similar generator from the devise p
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
-## Copyright ##
+h2. Copyright
 
 Copyright (c) 2010 Kristian Mandrup. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.8.3
+0.8.4

data/cream.gemspec

@@ -5,16 +5,16 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cream}
-  s.version = "0.8.3"
+  s.version = "0.8.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
-  s.date = %q{2010-12-20}
+  s.date = %q{2011-01-02}
   s.description = %q{Provides assistance for setting up Session, Role and Permission systems for a Rails 3 app. Support for multiple ORMs}
   s.email = %q{kmandrup@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
-    "README.markdown"
+    "README.textile"
   ]
   s.files = [
     ".bundle/config",
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
     "Changelog.txt",
     "Gemfile",
     "LICENSE",
-    "README.markdown",
+    "README.textile",
     "Rakefile",
     "VERSION",
     "app/views/cream/menu/_admin_login_items.html.erb",

data/lib/generators/devise/config/config_generator.rb

@@ -121,7 +121,7 @@ module Devise
         end
       end 
 
-      def routes_configure!
+      def routes_configure! orm=nil
         insert_into_routes do
           "devise_for #{model_routes}"
         end
@@ -137,7 +137,7 @@ module Devise
       end
         
 
-      def protection_configure! orm
+      def protection_configure! orm=nil
         logger.debug "Configuring: devise authentication filter"
         ## Add Devise protection to Application controller:
         insert_into_controller :application do
@@ -169,7 +169,7 @@ module Devise
         File.replace_content_from devise_initializer,  :where => orm_statement, :with => orm_replacement
       end
         
-      def mailer_configure! orm
+      def mailer_configure! orm=nil
         logger.debug "Configuring: devise mailer"            
         insert_application_config "action_mailer.default_url_options = { :host => 'localhost:3000' }"
       end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 8
-  - 3
-  version: 0.8.3
+  - 4
+  version: 0.8.4
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-20 00:00:00 +01:00
+date: 2011-01-02 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -445,7 +445,7 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.markdown
+- README.textile
 files: 
 - .bundle/config
 - .document
@@ -453,7 +453,7 @@ files:
 - Changelog.txt
 - Gemfile
 - LICENSE
-- README.markdown
+- README.textile
 - Rakefile
 - VERSION
 - app/views/cream/menu/_admin_login_items.html.erb