cream 0.8.1 → 0.8.2

data/Changelog.txt

@@ -1,3 +1,7 @@
+Dec 18, 2010
+---
+Improved ORM validation and handling 
+
 Dec 8, 2010
 ---
 Set mongoid dependency to >= 2.0.0.beta.20 (issue 5)

data/Gemfile

@@ -2,7 +2,7 @@ source :rubygems
 source 'http://gems.github.com/'
 
 group :default do
-  gem "devise-links",      "~> 0.2.0"    
+  gem "devise-links",      ">= 0.2.0"    
   gem "cancan-rest-links", ">= 0.2.0" 
   gem "cancan-permits",    ">= 0.3.4" 
 
@@ -12,7 +12,7 @@ group :default do
   gem "cancan",            ">= 1.4.0" 
   gem "rails",             ">= 3.0.1"
 
-  gem "rails3_artifactor", "~> 0.3.0"
+  gem "rails3_artifactor", ">= 0.3.2"
   gem 'logging_assist',    "~> 0.1.6"
 
   gem "r3_plugin_toolbox", ">= 0.4.0" 

data/README.markdown

@@ -1,52 +1,36 @@
 # Cream
 
-This project aims to assist you in setting up a complete Authentication and Authorization system for your Rails 3 app.
+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.
 
-It targets
+_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
 
-For more advanced Authorization configuration, cream uses cancan-permits to enabel use of Permits and Licenses.
-The gems *devise-links* and *cancan-rest-links* provide view helpers to facilitate working with authentication links and model REST links with permission logic.
-Cream itself provides generators to easily configure your Rails 3 app with these gems and also includes various view and controller helpers to guard view or controller logic. The project targets a collection of common ORMs for Rails, for both Relational and Document based datastores. 
+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.
+Cream itself provides generators to easily configure your Rails 3 app with these gems and also includes various view and controller helpers to guard specific view and/or controller logic with permission requirements. Cream targets a set of common ORMs for Rails for Relational and Document based datastores. 
 
-The objective of this project is to 
+The objectives of this project:
 
 * Integrate all these sub-systems
-* Provide generators that can auto-configure your Rails 3 app with these sub-systems for a given ORM
-
-_UPDATE_: 1. Dec 2010
-Rhe 'full_config' generator ha snow been tested in a fresh Rails 3.0.3 app and works with the following orms:
-* active_record
-* mongoid
-
-I will shortly go through the other ORMs and create Rails 3 demo apps for each with instructions.
+* Provide generators that can auto-configure your Rails 3 app with these systems for a given ORM
 
 ## Rails 3 demo apps with Cream
 
-The following Rails 3 demo apps use Cream 0.7.7 and above and were created Dec 1. 2010
+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) 
 
-## Status
-
-[CanCan permits demo](https://github.com/kristianmandrup/cancan-permits-demo) is a recent Rails 3 app I created to demonstrate configuration of a Rails 3 app using
-*cancan-permits* and *cancan-rest-links*. I will build on this in the near future to provide a full Rails 3 app with all the cream features enabled. 
-Stay tuned! Or even better, help me create such template/tutorial projects ;)
-
-### Update Nov 28, 2010
-
-Finally cream again installs from a clean base without any dependency problems :) I just switched to Ruby 1.9.3-dev and tested cream from a clean ruby gems.
-
 ## Authentication systems
 
-Cream targets [Devise](http://github.com/plataformatec/devise) as the Authentication system of choice
-
-* [devise](http://github.com/plataformatec/devise) 
+Cream targets [devise](http://github.com/plataformatec/devise) as the Authentication system of choice
 
 ### Devise links
 
@@ -57,52 +41,41 @@ The project [devise links](http://github.com/kristianmandrup/devise-links) adds
 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).
 
-_Note:_
-You are most welcome to provide "plugins" for other permission frameworks!
-
 ## Roles
 
-I have developed a flexible *Generic Roles* strategy 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.
 
-* [Generic Role Strategies](http://github.com/kristianmandrup/roles_generic)
-
-Roles for popular ORMs
-
-The Roles Generic API has been implemented for the following ORMs
+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 Mongoid](http://github.com/kristianmandrup/roles_for_mongoid)
 * [Roles Simply Stored](https://github.com/kristianmandrup/roles_simply_stored)
 
-_Role Groups_
-Document DBs such as *Mongo* and *Riak* are good 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!)
+_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.
 
-_Note:_
-You are most welcome to provide "plugins" for any other role frameworks. Please follow the API conventions of Roles generic.
+### Role Groups
 
-_Update:_
-Roles Generic has recently been upgraded with a better API, architecture, framework for testing and more and better functionality. It should also now be more DRY and
-easier/simpler to add more strategies and Datastore adapters.
+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
 
 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:
+
 * Active Record
 * Data Mapper
 
-Document datastores:
-* Mongo DB
-** Mongo Mapper
-** Mongoid
+Document stores:
+
+* Mongo Mapper
+* Mongoid
 * Couch DB
 
-These ORMs are also supported for the CanCan Permits and Roles systems. 
+These ORMs are also supported for the *CanCan Permits* and *Roles* systems. 
 
 ## Installation and configuration ##
 
@@ -115,25 +88,11 @@ Insert <pre>gem 'cream'</pre> in your Rails 3 Gemfile
 
 ## 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). There are currently Roles implementations for the following ORMs:
-
-* Active Record
-* Data Mapper
-* Mongo Mapper
-* Mongoid
-* Couch DB (via SimplyStored)
-
-_Note_: 
-Roles for SimplyStored is "shaky" and works only with the admin_flag strategy. I won't develop more on this particular ORM adapter until requested to do so.
-If you need to use Roles with Couch DB, please help implement this adapter, maybe using another (better?) object-mapping solution for Couch DB.
-
-### Update
-
-The Role systems all ORMs (except SimplyStored which is in progress) have recently been upgraded to take advantage of a new Roles Generic API and archictecture. 
+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
 
-Role based authorization for [CanCan](http://github.com/ryanb/cancan) can be done 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
 
@@ -146,7 +105,11 @@ The project [CanCan REST links](http://github.com/kristianmandrup/cancan-rest-li
 
 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 Generic support.
+*Cancan permits* support all the ORMs that both Devise and Roles support.
+
+### 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).
 
 ### Licenses
 
@@ -156,45 +119,36 @@ See [CanCan permits demo app](https://github.com/kristianmandrup/cancan-permits-
 
 ## Generators
 
-The following generators are currently available 
+The following generators are currently available:
+
+Main generator: 
 
-* cream:config    - Configure Rails 3 application with Cream (master generator)
+* cream:full_config    - Configure Rails 3 application with Cream (master generator)
 
-Sub-generators
+Config generators:
 
-* cream:views     - Generates partials for menu items
 * devise:config   - Configure Rails 3 application with Devise
 * devise:users    - Configure Rails 3 application with Devise users
 * cancan:config   - Configures app with CanCan
 * permits:config  - Configures app with CanCan Permits
 * roles:config    - Configures app with Roles
 
-* cancan:restlinks - create REST links locale file 
-* devise:links - create devise links locale file (should maybe be renamed authlinks?)
+Other generators:
 
-All the above generators have specs included in cream that demonstrate how to use them and should verify that they work as expected. 
+* cancan:restlinks - Create REST links locale file 
+* devise:links - Create devise links locale file (rename to authlinks?)
+* cream:views - Generates partials for menu items
 
-In general, the cream: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. I need more people to test this out to see how well it works. I am sure there are still a few bugs and issues here... 
+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!?). 
 
-Cream target these ORMs:
+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. 
 
-Relational DB (SQL)
-* Active Record
-* Data Mapper
-
-Mongo Mapper (NoSQL Document store)
-* Mongo Mapper
-* Mongoid 
-
-Couch DB (NoSQL Document store)
-* SimplyStored ()
-
-### Config Generator ###
+### Full Config Generator ###
 
 Master cream generator which calls the sub-generators in succession.
 
-<code>rails g cream::config --strategy ROLE_STRATEGY [--admin_user] [--orm ORM] [--roles ROLE1 ROLE2] [--logfile LOGFILE]</code>
+<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
@@ -203,7 +157,7 @@ Master cream generator which calls the sub-generators in succession.
 
 Example
 
-<code>rails g cream:config --strategy admin_flag --admin-user --orm AR</code>
+<code>rails g cream:full_config --strategy admin_flag --admin-user --orm AR</code>
 
 By default creates :guest and :admin roles.
 
@@ -217,11 +171,13 @@ Example: <code>rails g permits:config</code>
 
 Moves 'user menu' partials views into app/views/_user_menu
 
-<code>rails g cream::views [scope] [--haml]</code>
+<code>rails g cream:views [scope] [--haml]</code>
 
 * 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?).
+
 ## Note on Patches/Pull Requests ##
  
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.8.1
+0.8.2

data/cream.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cream}
-  s.version = "0.8.1"
+  s.version = "0.8.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
-  s.date = %q{2010-12-08}
+  s.date = %q{2010-12-18}
   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 = [
@@ -118,14 +118,14 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<devise-links>, ["~> 0.2.0"])
+      s.add_runtime_dependency(%q<devise-links>, [">= 0.2.0"])
       s.add_runtime_dependency(%q<cancan-rest-links>, [">= 0.2.0"])
       s.add_runtime_dependency(%q<cancan-permits>, [">= 0.3.4"])
       s.add_runtime_dependency(%q<require_all>, ["~> 1.2.0"])
       s.add_runtime_dependency(%q<devise>, [">= 1.1.5"])
       s.add_runtime_dependency(%q<cancan>, [">= 1.4.0"])
       s.add_runtime_dependency(%q<rails>, [">= 3.0.1"])
-      s.add_runtime_dependency(%q<rails3_artifactor>, ["~> 0.3.0"])
+      s.add_runtime_dependency(%q<rails3_artifactor>, [">= 0.3.2"])
       s.add_runtime_dependency(%q<logging_assist>, ["~> 0.1.6"])
       s.add_runtime_dependency(%q<r3_plugin_toolbox>, [">= 0.4.0"])
       s.add_runtime_dependency(%q<sugar-high>, ["~> 0.3.1"])
@@ -147,14 +147,14 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<r3_plugin_toolbox>, [">= 0.4.0"])
       s.add_runtime_dependency(%q<sugar-high>, ["~> 0.3.1"])
     else
-      s.add_dependency(%q<devise-links>, ["~> 0.2.0"])
+      s.add_dependency(%q<devise-links>, [">= 0.2.0"])
       s.add_dependency(%q<cancan-rest-links>, [">= 0.2.0"])
       s.add_dependency(%q<cancan-permits>, [">= 0.3.4"])
       s.add_dependency(%q<require_all>, ["~> 1.2.0"])
       s.add_dependency(%q<devise>, [">= 1.1.5"])
       s.add_dependency(%q<cancan>, [">= 1.4.0"])
       s.add_dependency(%q<rails>, [">= 3.0.1"])
-      s.add_dependency(%q<rails3_artifactor>, ["~> 0.3.0"])
+      s.add_dependency(%q<rails3_artifactor>, [">= 0.3.2"])
       s.add_dependency(%q<logging_assist>, ["~> 0.1.6"])
       s.add_dependency(%q<r3_plugin_toolbox>, [">= 0.4.0"])
       s.add_dependency(%q<sugar-high>, ["~> 0.3.1"])
@@ -177,14 +177,14 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<sugar-high>, ["~> 0.3.1"])
     end
   else
-    s.add_dependency(%q<devise-links>, ["~> 0.2.0"])
+    s.add_dependency(%q<devise-links>, [">= 0.2.0"])
     s.add_dependency(%q<cancan-rest-links>, [">= 0.2.0"])
     s.add_dependency(%q<cancan-permits>, [">= 0.3.4"])
     s.add_dependency(%q<require_all>, ["~> 1.2.0"])
     s.add_dependency(%q<devise>, [">= 1.1.5"])
     s.add_dependency(%q<cancan>, [">= 1.4.0"])
     s.add_dependency(%q<rails>, [">= 3.0.1"])
-    s.add_dependency(%q<rails3_artifactor>, ["~> 0.3.0"])
+    s.add_dependency(%q<rails3_artifactor>, [">= 0.3.2"])
     s.add_dependency(%q<logging_assist>, ["~> 0.1.6"])
     s.add_dependency(%q<r3_plugin_toolbox>, [">= 0.4.0"])
     s.add_dependency(%q<sugar-high>, ["~> 0.3.1"])

data/lib/generators/cream/full_config/full_config_generator.rb

@@ -3,6 +3,7 @@ require 'sugar-high/module'
 require 'cream'
 require 'rails3_artifactor'
 require 'logging_assist'
+require 'active_support'
 
 module Cream
   module Generators
@@ -28,9 +29,10 @@ module Cream
       class_option :gems,           :type => :boolean,  :default => true,             :desc => "Add gems to gemfile?"       
       class_option :migrations,     :type => :boolean,  :default => false,            :desc => "Autorun database migrations?", :aliases => '-m'
 
-      def main_flow             
+      def main_flow 
+        return nil if !validate_orm            
         cream_initializer
-        cream_gems if gems?
+        # cream_gems if gems?
         run_generators
         run_migrations if run_migrations?      
       end
@@ -43,6 +45,14 @@ module Cream
 
       use_helpers :app, :special, :file
 
+      def validate_orm
+         if !valid_orms.include?(orm)
+           say "ORM #{orm} is not currently supported. Please use one of: #{valid_orms}", :red
+           false
+         end
+         true
+      end
+
       def run_migrations?
         options[:migrations]
       end
@@ -105,7 +115,31 @@ module Cream
       end
 
       def orm
-        options[:orm]
+        @orm ||= get_orm options[:orm].underscore.to_sym
+      end
+
+      def valid_orms
+        active_record + data_mapper + mongo_mapper + [:couch_db, :mongoid]
+      end
+
+      def active_record
+        [:ar, :active_record]
+      end
+
+      def mongo_mapper
+        [:mm, :mongo_mapper]
+      end
+
+      def data_mapper
+        [:dm, :data_mapper]
+      end
+
+      def get_orm orm_name
+        return :active_record if active_record.include? orm_name
+        return :mongo_mapper if mongo_mapper.include? orm_name
+        return :data_mapper if data_mapper.include? orm_name
+        return :couch_db if orm_name == :couch_db
+        return :mongoid if orm_name == :mongoid
       end
 
       def default_roles?
@@ -141,12 +175,11 @@ module Cream
       end
 
 
-      def cream_gems
-        if !has_gem? :cream
-          gem 'cream' 
-          # bundle_install
-        end
-      end      
+      # def cream_gems
+      #   if !has_gem? :cream
+      #     gem 'cream' 
+      #   end
+      # end      
 
       def cream_initializer
         create_initializer :cream do         

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

@@ -71,6 +71,18 @@ module Devise
       def gems_mongo_db
         add_gem 'bson_ext', '>= 1.1.4'
       end
+
+      def is_active_record?
+        [:ar, :active_record].include? orm.to_sym
+      end
+
+      def is_mongo_mapper?
+        [:mm, :mongo_mapper].include? orm.to_sym
+      end
+
+      def is_data_mapper?
+        [:dm, :data_mapper].include? orm.to_sym
+      end
             
       def devise_gems 
         say "Configuring devise gems for #{orm}", :green
@@ -78,19 +90,24 @@ module Devise
 
         # Devise ORM integration        
         case orm.to_sym
+        when is_active_record?
+          say "Configuring for Active Record"
+        when is_mongo_mapper?
+          say "Configuring for Mongo Mapper"
+          add_gem 'mm-devise'
+          gems_mongo_db          
+        when is_data_mapper?
+          say "Configuring for Data Mapper"
+          add_gem 'dm-devise'
         when :mongoid
+          say "Configuring for Mongoid"
           say "Please configure Devise for Mongoid similar to Rails 3 example app: http://github.com/fortuity/rails3-mongoid-devise"
           add_gem 'mongoid', '>= 2.0.0.beta.20'
           gems_mongo_db
-        when :mongo_mapper
-          add_gem 'mm-devise'
-          gems_mongo_db          
-        when :data_mapper
-          add_gem 'dm-devise'
         when :couch_db
+          say "Configuring for Couch DB"
           add_gem 'devise_couch'
-          say "Please note that Couch DB does not currently have a Roles implementation. Feel free to provide one."
-          say "Look at Roles DataMapper (roles_data_mapper) for an example ;)"
+          say "Please note that Couch DB does not currently have a complete Roles implementation. Please help implement strategies for this adapter."
         else
           say "Orm #{orm} is not currently supported by Cream. You are most welcome to provide a Cream adapter for that ORM ;)"
         end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 8
-  - 1
-  version: 0.8.1
+  - 2
+  version: 0.8.2
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-08 00:00:00 +01:00
+date: 2010-12-18 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,7 +22,7 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         segments: 
         - 0
@@ -127,13 +127,13 @@ dependencies:
   requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         segments: 
         - 0
         - 3
-        - 0
-        version: 0.3.0
+        - 2
+        version: 0.3.2
   type: :runtime
   prerelease: false
   version_requirements: *id008