cream 0.8.6 → 0.8.7

data/wiki/Cream-generators-overview.textile

@@ -0,0 +1,79 @@
+Perhaps the most powerful part of Cream is the set of generators that work to configure your application for your requirements. 
+
+h2. Full application configuration
+
+The _full_config_ generator is the main generator and attempts to configure an application with Devise, CanCan, Roles and Permits for a given ORM.
+
+As of 2011, it now also supports options to set which class names to use for the main model classes generated, including the abstract User, Role and for relational databases 
+the model for the join table between User and Role (default: UserRole).
+
+The generator will only run if you pass it a valid strategy and orm combination.
+
+1. Create Cream initializer - which sets up the roles available to Cream (for use in Roles configuration)
+2. Optionally generate default locale files for Cream labels (please provide other translations)
+3. Run sub generators
+4. Optionally run migrations (currently only for Active Record) 
+
+h3. Sub generators
+
+The _full_config_ generator executes the following generators in succession:
+
+1. Cream application configuration 
+2. Devise configuration
+3. CanCan configuration
+4. Roles configuration
+5. Permits configuration
+
+The order is very important! 
+
+Note: the Devise configuration is split into 'general configuration' followed by a special _devise users__ generator which sets up User models with devise strategies.
+
+h2. Cream application configuration 
+
+1. Remove AR code from application if non-AR ORM is used
+2. Add Welcome controller and view and setup root route if no such exists
+3. Add flash message logic to application layout file (as required by devise)
+
+In case an ORM is specified other than Active Record (A.R) the generator will attempt to strip A.R code from the application by replacing A.R specific code from the _application.rb_ file.
+For the application to demonstrate that it works in the end, it is ensured that root route is defined and linked to a Welcome controller action with page. 
+This Welcome controller will be set up with a :before filter to redirect to the login page if the user is not logged in.
+
+h2. Devise configuration
+
+Consists of:
+
+* Devise basic configuration
+* Devise User configuration
+
+h3. Devise basic configuration
+
+1. Run _Devise installer_ (if it hasn't been run before - i.e no _devise.rb_ initializer present)
+2. Configure Devise for ORM chosen (installing relevant ORM adapter for Devise)
+3. Insert default mailer configuration in _application.rb_ (localhost:3000) - change this for production!
+4. Insert a before filter in the Application controller to always require authenticated user (customize this later)
+
+As part of this configuration, relevant gem files will be added to the _Gemfile_ and <pre>$ bundle install</pre> will be run to install them and make them available to the app :)
+
+h3. Devise users configuration
+
+1. Create devise base User model (note: name of model can be customized) if the user model doesn't already exist
+2. Optionally insert default devise strategy in the User model (if not exist)
+3. Optionally create an Admin user. The Admin user will always inherit from the base User (using Single Table Inheritance strategy if using Active Record)
+4. Create similar models for each role as for Admin user
+5. Create special devise routes for each User role with code and notes to aid in further customization if needed
+
+With regard to item 3 (creating Admin model), I'm not sure if it makes sense to treat the Admin user as something special or just let it be like any other role?
+Suggestions and comments welcome!   
+
+h2. Roles configuration
+
+1. Rune the _Roles generator_ for the ORM selected
+2. Replace the valid_roles_are statement in the base User class as generated by the Roles generator with a reference to the roles available defined in Cream initializer (see Cream app generator)
+
+h2. Permits configuration
+
+1. Run _CanCan permits_ generator to generate permits for each role for the ORM selected
+2. Generate default licenses
+
+
+

data/wiki/How to gollum wiki.txt

@@ -0,0 +1,13 @@
+Start server
+
+$ gollum
+
+Go to home page
+
+http://localhost:4567
+
+Edit individual page: "Cream-generators-overview"
+
+http://localhost:4567/edit/Cream-generators-overview
+
+Enjoy!

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 8
-  - 6
-  version: 0.8.6
+  - 7
+  version: 0.8.7
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-04 00:00:00 +01:00
+date: 2011-01-09 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -78,8 +78,23 @@ dependencies:
   prerelease: false
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: devise
+  name: colorize
   requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 8
+        version: 0.5.8
+  type: :runtime
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: devise
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -91,10 +106,10 @@ dependencies:
         version: 1.1.5
   type: :runtime
   prerelease: false
-  version_requirements: *id005
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: cancan
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -106,10 +121,10 @@ dependencies:
         version: 1.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *id006
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: rails
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -121,10 +136,10 @@ dependencies:
         version: 3.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *id007
+  version_requirements: *id008
 - !ruby/object:Gem::Dependency 
   name: rails3_artifactor
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -136,10 +151,10 @@ dependencies:
         version: 0.3.2
   type: :runtime
   prerelease: false
-  version_requirements: *id008
+  version_requirements: *id009
 - !ruby/object:Gem::Dependency 
   name: logging_assist
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -151,10 +166,10 @@ dependencies:
         version: 0.1.6
   type: :runtime
   prerelease: false
-  version_requirements: *id009
+  version_requirements: *id010
 - !ruby/object:Gem::Dependency 
   name: r3_plugin_toolbox
-  requirement: &id010 !ruby/object:Gem::Requirement 
+  requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -166,10 +181,10 @@ dependencies:
         version: 0.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *id010
+  version_requirements: *id011
 - !ruby/object:Gem::Dependency 
   name: sugar-high
-  requirement: &id011 !ruby/object:Gem::Requirement 
+  requirement: &id012 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -181,10 +196,10 @@ dependencies:
         version: 0.3.1
   type: :runtime
   prerelease: false
-  version_requirements: *id011
+  version_requirements: *id012
 - !ruby/object:Gem::Dependency 
   name: rspec
-  requirement: &id012 !ruby/object:Gem::Requirement 
+  requirement: &id013 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -196,10 +211,10 @@ dependencies:
         version: 2.0.1
   type: :development
   prerelease: false
-  version_requirements: *id012
+  version_requirements: *id013
 - !ruby/object:Gem::Dependency 
   name: generator-spec
-  requirement: &id013 !ruby/object:Gem::Requirement 
+  requirement: &id014 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -211,10 +226,10 @@ dependencies:
         version: 0.7.0
   type: :development
   prerelease: false
-  version_requirements: *id013
+  version_requirements: *id014
 - !ruby/object:Gem::Dependency 
   name: rspec-action_view
-  requirement: &id014 !ruby/object:Gem::Requirement 
+  requirement: &id015 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -226,10 +241,10 @@ dependencies:
         version: 0.3.1
   type: :development
   prerelease: false
-  version_requirements: *id014
+  version_requirements: *id015
 - !ruby/object:Gem::Dependency 
   name: rails-app-spec
-  requirement: &id015 !ruby/object:Gem::Requirement 
+  requirement: &id016 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -241,10 +256,10 @@ dependencies:
         version: 0.3.0
   type: :development
   prerelease: false
-  version_requirements: *id015
+  version_requirements: *id016
 - !ruby/object:Gem::Dependency 
   name: devise-spec
-  requirement: &id016 !ruby/object:Gem::Requirement 
+  requirement: &id017 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -256,10 +271,10 @@ dependencies:
         version: 0.1.3
   type: :development
   prerelease: false
-  version_requirements: *id016
+  version_requirements: *id017
 - !ruby/object:Gem::Dependency 
   name: roles-spec
-  requirement: &id017 !ruby/object:Gem::Requirement 
+  requirement: &id018 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -271,10 +286,10 @@ dependencies:
         version: 0.1.3
   type: :development
   prerelease: false
-  version_requirements: *id017
+  version_requirements: *id018
 - !ruby/object:Gem::Dependency 
   name: require_all
-  requirement: &id018 !ruby/object:Gem::Requirement 
+  requirement: &id019 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -286,10 +301,25 @@ dependencies:
         version: 1.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *id018
+  version_requirements: *id019
+- !ruby/object:Gem::Dependency 
+  name: colorize
+  requirement: &id020 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 8
+        version: 0.5.8
+  type: :runtime
+  prerelease: false
+  version_requirements: *id020
 - !ruby/object:Gem::Dependency 
   name: devise-links
-  requirement: &id019 !ruby/object:Gem::Requirement 
+  requirement: &id021 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -297,14 +327,14 @@ dependencies:
         segments: 
         - 0
         - 2
-        - 0
-        version: 0.2.0
+        - 1
+        version: 0.2.1
   type: :runtime
   prerelease: false
-  version_requirements: *id019
+  version_requirements: *id021
 - !ruby/object:Gem::Dependency 
   name: cancan-rest-links
-  requirement: &id020 !ruby/object:Gem::Requirement 
+  requirement: &id022 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -312,14 +342,14 @@ dependencies:
         segments: 
         - 0
         - 2
-        - 0
-        version: 0.2.0
+        - 1
+        version: 0.2.1
   type: :runtime
   prerelease: false
-  version_requirements: *id020
+  version_requirements: *id022
 - !ruby/object:Gem::Dependency 
   name: cancan-permits
-  requirement: &id021 !ruby/object:Gem::Requirement 
+  requirement: &id023 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -327,14 +357,14 @@ dependencies:
         segments: 
         - 0
         - 3
-        - 2
-        version: 0.3.2
+        - 7
+        version: 0.3.7
   type: :runtime
   prerelease: false
-  version_requirements: *id021
+  version_requirements: *id023
 - !ruby/object:Gem::Dependency 
   name: devise
-  requirement: &id022 !ruby/object:Gem::Requirement 
+  requirement: &id024 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -346,10 +376,10 @@ dependencies:
         version: 1.1.5
   type: :runtime
   prerelease: false
-  version_requirements: *id022
+  version_requirements: *id024
 - !ruby/object:Gem::Dependency 
   name: cancan
-  requirement: &id023 !ruby/object:Gem::Requirement 
+  requirement: &id025 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -361,10 +391,10 @@ dependencies:
         version: 1.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *id023
+  version_requirements: *id025
 - !ruby/object:Gem::Dependency 
   name: rails
-  requirement: &id024 !ruby/object:Gem::Requirement 
+  requirement: &id026 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -376,10 +406,10 @@ dependencies:
         version: 3.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *id024
+  version_requirements: *id026
 - !ruby/object:Gem::Dependency 
   name: rails3_artifactor
-  requirement: &id025 !ruby/object:Gem::Requirement 
+  requirement: &id027 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -387,14 +417,14 @@ dependencies:
         segments: 
         - 0
         - 3
-        - 1
-        version: 0.3.1
+        - 2
+        version: 0.3.2
   type: :runtime
   prerelease: false
-  version_requirements: *id025
+  version_requirements: *id027
 - !ruby/object:Gem::Dependency 
   name: logging_assist
-  requirement: &id026 !ruby/object:Gem::Requirement 
+  requirement: &id028 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -406,10 +436,10 @@ dependencies:
         version: 0.1.6
   type: :runtime
   prerelease: false
-  version_requirements: *id026
+  version_requirements: *id028
 - !ruby/object:Gem::Dependency 
   name: r3_plugin_toolbox
-  requirement: &id027 !ruby/object:Gem::Requirement 
+  requirement: &id029 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -421,10 +451,10 @@ dependencies:
         version: 0.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *id027
+  version_requirements: *id029
 - !ruby/object:Gem::Dependency 
   name: sugar-high
-  requirement: &id028 !ruby/object:Gem::Requirement 
+  requirement: &id030 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -436,8 +466,8 @@ dependencies:
         version: 0.3.1
   type: :runtime
   prerelease: false
-  version_requirements: *id028
-description: Provides assistance for setting up Session, Role and Permission systems for a Rails 3 app. Support for multiple ORMs
+  version_requirements: *id030
+description: An integrated Authentication, Authorization and Roles solution for your Rails 3 app with support for multiple ORMs
 email: kmandrup@gmail.com
 executables: []
 
@@ -451,6 +481,7 @@ files:
 - .document
 - .rspec
 - Changelog.txt
+- Design Ideas.textile
 - Gemfile
 - LICENSE
 - README.textile
@@ -459,6 +490,7 @@ files:
 - app/views/cream/menu/_admin_login_items.html.erb
 - app/views/cream/menu/_login_items.html.erb
 - app/views/cream/menu/_registration_items.html.erb
+- config/locales/cream.da.yml
 - config/locales/cream.en.yml
 - cream.gemspec
 - features/FEATURE_NOTES.txt
@@ -470,6 +502,7 @@ files:
 - lib/cream/configure/after_init/role_config.rb
 - lib/cream/configure/rails.rb
 - lib/cream/controller/ability.rb
+- lib/cream/controller/application_controller.rb
 - lib/cream/helper/host.rb
 - lib/cream/helper/role.rb
 - lib/cream/namespaces.rb
@@ -485,20 +518,28 @@ files:
 - lib/generators/cream/helpers/all.rb
 - lib/generators/cream/helpers/args_helper.rb
 - lib/generators/cream/helpers/execute_helper.rb
+- lib/generators/cream/helpers/gemfile_helper.rb
 - lib/generators/cream/helpers/orm_helper.rb
 - lib/generators/cream/helpers/strategy_helper.rb
 - lib/generators/cream/views/haml_util.rb
 - lib/generators/cream/views/views_generator.rb
-- lib/generators/cream_refactor.rb
 - lib/generators/devise/config/app_helper.rb
 - lib/generators/devise/config/config_generator.rb
-- lib/generators/devise/config/gem_helper.rb
+- lib/generators/devise/config/gem_config_helper.rb
+- lib/generators/devise/customize/customize_generator.rb
+- lib/generators/devise/customize/customize_messages.rb
+- lib/generators/devise/customize/helpers/query_customizers.rb
+- lib/generators/devise/customize/helpers/recover_login.rb
+- lib/generators/devise/customize/helpers/username_helper.rb
 - lib/generators/devise/users/helper.rb
 - lib/generators/devise/users/routes_helper.rb
 - lib/generators/devise/users/users_generator.rb
 - lib/generators/permits/config/config_generator.rb
 - lib/generators/roles/config/config_generator.rb
 - log/development.log
+- sandbox/any_user.rb
+- sandbox/cream_refactor.rb
+- sandbox/str_test.rb
 - sandbox/test.rb
 - spec/configure_helper.rb
 - spec/cream/configure/rails_custom_roles_spec.rb
@@ -518,16 +559,10 @@ files:
 - spec/generators/permits/config/permits_config_generator_spec.rb
 - spec/generators/roles/config/roles_config_generator_spec.rb
 - spec/spec_helper.rb
-- wiki/CONFIG_GENERATOR.txt
-- wiki/DESIGN.txt
-- wiki/INSTALLATION.txt
-- wiki/PERMITS.txt
-- wiki/ROLE_STRATEGIES.txt
-- wiki/SPEC_NOTES.txt
-- wiki/VIEWS_GENERATOR.txt
-- wiki/VIEW_HELPERS.txt
+- wiki/Cream-generators-overview.textile
+- wiki/How to gollum wiki.txt
 has_rdoc: true
-homepage: http://github.com/kristianmandrup/devise-assistant
+homepage: http://github.com/kristianmandrup/cream
 licenses: []
 
 post_install_message: 
@@ -557,7 +592,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Integrates Devise, Roles and CanCan with Permits for a Rails 3 app
+summary: Integrates Devise, CanCan with permits and Roles generic for multiple ORMs
 test_files: 
 - spec/configure_helper.rb
 - spec/cream/configure/rails_custom_roles_spec.rb