cream 0.5.6

data/wiki/SPEC_NOTES.txt

@@ -0,0 +1,6 @@
+# Notes and Status
+
+Currently these specs are a work in progress. 
+I am first building up a skeleton structure for the specs and then plan to gradually implement them as described in the DESIGN.txt document :)
+
+You are most welcome to help in the effort!

data/wiki/VIEWS_GENERATOR.txt

@@ -0,0 +1,35 @@
+The `views` generator generates views (partials) for use with menus.
+
+It is sometimes the case that you want to have menu items in a main navigation menu that enable the user to log in/out, register a new user account or edit an existing user account. The menu items partials ensure that these menuitems are only shown as appropriate in relation to the current user login status, so that log out and edit account is only shown if the user is currently logged in and vice-versa.   
+
+<pre>$ rails g cream:views</pre>
+
+Create HAML views
+
+<pre>$ rails g cream:views --template_engine haml</pre>
+
+Example usage:
+<pre>ul.menu
+    render 'cream/login_items'                              
+    render 'cream/registration_items'
+
+  ul.admin_menu_
+    render 'cream/admin_login_items'</pre>
+    
+    
+<pre>module RolePermit
+  class Moderator
+    def initialize(ability)
+      super
+    end
+
+
+    def permit?(user)
+      super
+      return if !user.role?(:moderator)
+      can :read, :all
+      user.owns(Comment)
+      user.owns(Book, :author)
+    end
+  end
+end</pre>

data/wiki/VIEW_HELPERS.txt

@@ -0,0 +1,162 @@
+## View helpers ##
+
+Currently the view helpers only target use with devise and cancan.
+The default labels are always loaded from the `cream` locale file, which is generated by the `config` generator.
+
+### Rest link helpers ###
+
+Display a link (anchor tag) for a given object only if the current user has permission to execute that action.
+
+* show_link or read_link
+* edit_link or update_link
+* create_link or new_link
+* destroy_link or delete_link
+
+Each Rest helper method takes an object for which to create the link. Optionally provide a label as the second argument. 
+
+Example usage:
+
+<%= create_link project %>
+<%= create_link project, 'Create new project' %>
+
+### Session link helpers ###
+
+Show links for performing user authentication and registration actions 
+
+* log_out_link or sign_out_link
+* log_in_link or sign_in_link  
+
+Each of these methods take an optional options hash. 
+If no role option given, they default to create link for basic 'user' role.
+
+Example usage:
+
+<%= log_out_link %> 
+<%= log_out_link :label => 'Log me out' %>
+<%= log_out_link :role => 'admin', :label => 'Log me out' %>
+
+
+### Registration link helpers ###
+
+Show links for performing user authentication and registration actions 
+
+* register_link or sign_up_link    
+* edit_profile_link or edit_registration_link   
+
+Each of these methods take an optional options hash. 
+If no role option given, they default to create link for basic 'user' role.
+
+Example usage:
+
+<%= register_link %> 
+<%= register_link :label => 'Register me' %>
+<%= register_link :role => 'admin', :label => 'Register me' %>
+
+### Registration Menu item helpers ###
+
+Show menu links for registration conditionally
+
+* edit_user_menu_item or edit_registration_menu_item   
+* register_menu_item or sign_up_menu_item
+
+1) only shown if user is currently logged in
+2) only shown if user is NOT currently logged in (and hence already registered)
+
+Example usage:
+
+ul.menu
+  <%= register_menu_item %> 
+
+### Session Menu item helpers ###
+
+Show menu links for session operations conditionally
+
+* logout_menu_item or sign_out_menu_item 
+* login_menu_item or sign_in_menu_item 
+                                      
+1) only shown if user is currently logged in
+2) only shown if user is NOT currently logged in
+
+ul.menu
+  <%= login_menu_item %> 
+  <%= logout_menu_item %> 
+
+
+## Block helpers ##
+
+Execute block if user is logged in (or not logged in)
+* user_block
+* not_user_block
+
+Execute block if user is logged and is admin (or not admin)
+* admin_block
+* not_admin_block
+
+Execute block if ip is localhost (or not localhost)
+* localhost_block
+* not_localhost_block
+  
+Execute block if role is included in list of roles (or not)
+* roles_block
+* not_roles_block
+
+## Block area helpers ##
+
+Create div.user 'area' and execute block if user is logged in as a user (or not) 
+
+* user_area
+* not_user_area
+
+Create div.admin 'area' and execute block if user is admin (or not admin)
+
+* admin_area
+* not_admin_area
+
+Example:
+<pre>
+<% admin_area do %> 
+  ul.admin_menu
+  ...
+
+If logged in as admin, results in:
+
+div.admin
+  ul.admin_menu  
+   ...
+</pre>
+
+## Roles block area helpers ##
+
+Creates are if role is one included in list of roles (or not)
+
+* roles_area
+* not_roles_area
+
+Example:
+<pre>
+<% roles_area 'admin, 'editor', :class => 'special' do %> 
+  ul.admin_menu
+  ...
+  
+If logged in as either 'editor' or 'admin', results in:
+
+div.special
+  ul.admin_menu  
+   ...
+    
+</pre>
+
+## Misc helpers ##
+
+* user? - 
+* admin?
+* role?
+* localhost?
+
+Examples
+<pre>     
+<%= current_user.username if user? %>
+<%= "Admin: #{current_user.username}" if admin? %>  
+<%= "Special user!" if role?('admin', 'reviewer') %>  
+<%= "Running on localhost!" if localhost? %>  
+</pre>

metadata

@@ -0,0 +1,374 @@
+--- !ruby/object:Gem::Specification 
+name: cream
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 6
+  version: 0.5.6
+platform: ruby
+authors: 
+- Kristian Mandrup
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-26 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 22
+        version: 2.0.0.beta.22
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: generator-spec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 4
+        version: 0.6.4
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec-action_view
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 1
+        version: 0.3.1
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rails-app-spec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 13
+        version: 0.2.13
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: require_all
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: devise-links
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 1
+        version: 0.1.1
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: cancan-rest-links
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 1
+        version: 0.1.1
+  type: :runtime
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: cancan-permits
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 1
+        version: 0.1.1
+  type: :runtime
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: devise
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 2
+        version: 1.1.2
+  type: :runtime
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: cancan
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 4
+        version: 1.3.4
+  type: :runtime
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id011
+- !ruby/object:Gem::Dependency 
+  name: rails3_artifactor
+  prerelease: false
+  requirement: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 4
+        version: 0.2.4
+  type: :runtime
+  version_requirements: *id012
+- !ruby/object:Gem::Dependency 
+  name: logging_assist
+  prerelease: false
+  requirement: &id013 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 3
+        version: 0.1.3
+  type: :runtime
+  version_requirements: *id013
+- !ruby/object:Gem::Dependency 
+  name: r3_plugin_toolbox
+  prerelease: false
+  requirement: &id014 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 6
+        version: 0.3.6
+  type: :runtime
+  version_requirements: *id014
+- !ruby/object:Gem::Dependency 
+  name: sugar-high
+  prerelease: false
+  requirement: &id015 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 10
+        version: 0.2.10
+  type: :runtime
+  version_requirements: *id015
+description: Provides assistance for setting up Session, Role and Permission systems for a Rails 3 app. Support for multiple ORMs
+email: kmandrup@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- .rspec
+- Changelog.txt
+- Gemfile
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- app/views/auth_assist/menu/_admin_login_items.html.erb
+- app/views/auth_assist/menu/_login_items.html.erb
+- app/views/auth_assist/menu/_registration_items.html.erb
+- config/locales/en.yml
+- cream.gemspec
+- features/FEATURE_NOTES.txt
+- features/permission/adds_permission.feature
+- features/role_strategy/adds_role_strategy.feature
+- features/role_strategy/clears_role_strategy.feature
+- init.rb
+- lib/cream.rb
+- lib/cream/configure.rb
+- lib/cream/configure/after_init/role_config.rb
+- lib/cream/configure/rails.rb
+- lib/cream/controller/ability.rb
+- lib/cream/helper/authlabels.rb
+- lib/cream/helper/host.rb
+- lib/cream/helper/role.rb
+- lib/cream/namespaces.rb
+- lib/cream/role.rb
+- lib/cream/view/host_area.rb
+- lib/cream/view/role_area.rb
+- lib/cream/view/user_action_menu.rb
+- lib/generators/cream/config/DESIGN NOTES.markdown
+- lib/generators/cream/config/config_generator.rb
+- lib/generators/cream/config/modules/cancan_config.rb
+- lib/generators/cream/config/modules/cream_config.rb
+- lib/generators/cream/config/modules/devise_config.rb
+- lib/generators/cream/config/modules/helper.rb
+- lib/generators/cream/config/modules/permits_config.rb
+- lib/generators/cream/config/modules/roles_config.rb
+- lib/generators/cream/views/haml_util.rb
+- lib/generators/cream/views/views_generator.rb
+- lib/generators/cream_refactor.rb
+- log/development.log
+- sandbox/test.rb
+- spec/cream/configure/rails_spec.rb
+- spec/cream/helper/host_spec.rb
+- spec/cream/helper/role_spec.rb
+- spec/cream/view/host_area_spec.rb
+- spec/cream/view/role_area_spec.rb
+- spec/cream/view/role_ext_spec.rb
+- spec/generator_spec_helper.rb
+- spec/generators/cream/config/devise/existing_devise_users.rb
+- spec/generators/cream/config/empty_app/default_args_spec.rb
+- spec/generators/cream/config/permits/existing_permits_spec.rb
+- spec/generators/cream/config/permits/no_permits_spec.rb
+- spec/generators/cream/config/roles/default_roles.rb
+- spec/generators/cream/config/roles/roles_spec.rb
+- spec/generators/cream/shared_examples.rb
+- spec/generators/cream/views_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
+has_rdoc: true
+homepage: http://github.com/kristianmandrup/devise-assistant
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+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
+test_files: 
+- spec/cream/configure/rails_spec.rb
+- spec/cream/helper/host_spec.rb
+- spec/cream/helper/role_spec.rb
+- spec/cream/view/host_area_spec.rb
+- spec/cream/view/role_area_spec.rb
+- spec/cream/view/role_ext_spec.rb
+- spec/generator_spec_helper.rb
+- spec/generators/cream/config/devise/existing_devise_users.rb
+- spec/generators/cream/config/empty_app/default_args_spec.rb
+- spec/generators/cream/config/permits/existing_permits_spec.rb
+- spec/generators/cream/config/permits/no_permits_spec.rb
+- spec/generators/cream/config/roles/default_roles.rb
+- spec/generators/cream/config/roles/roles_spec.rb
+- spec/generators/cream/shared_examples.rb
+- spec/generators/cream/views_generator_spec.rb
+- spec/spec_helper.rb