Cantango Configuration

Configuration for CanTango.

The Configuration DSL has now been almost fully "spec'ed".

169 examples, 12 failures, 4 pending

Please help fix the remaining specs ;)

This extension depends on the CanTango core and follows the extension conventions as described there.

• YAML Loader - use of Config to set where (which folder) to load the YAML file from

Configuration allows configuration of the following components:

• Ability
• Account
• Accounts
• Adapters
• Categories
• Debug
• Engines
• Guest
• Hooks
• Localhosts
• Models
• Modes
• Orms
• User
• Users

Example:

CanTango.config.accounts do |accounts|
  # configure accounts
end

• modes
• default_executor_class
• default_executor_class= clazz
• default_class # CanTango::Ability::Base
• factory_class_method # :default_executor_class

Is a type of Registry::Clazz

CanTango.config.ability do |ability|
  ability.modes.register 
end

Also has an Execution object

ability.modes.execution

• available # [:cache, :no_cache]
• default # [:no_cache]

• clear!
• base_class
• base_class= clazz

• register_account clazz

• adapter name # load an adapter!
• use *names # use one or more adapters
• available # list adapters available

auto-load models and/or permits

TODO: Refactor! Mofe all permits functionality to cantango-permits!

• [] label
• category label, &block
• has_any? subject, &block
• category_names_of_subject subject, &block
• categories_of_subject subject, &block

• Available
• Order

• available
• available? name
• all state # - all engines in states :on or :off
• any? state # any engine in state :on or :off ?

• clear_order!
• set_execution_order *names
• dont_execute name
• execute_first name
• execute_last name
• execute_before existing, name
• execute_after existing, name
• execution_order

• clear!
• user user = nil, &block
• account acc = nil, &block
• default_user?
• default_account?

• enable *names
• enable_rest # enable REST

Kind of Hash Registry

• value_methods

Kind of Base Registry

• default # 'localhost', '127.0.0.1'

• use *names
• actions
• by_reg_exp reg_exp
• by_category label
• exclude *names
• excluded
• available

Adapters:

• ActiveRecord
• DataMapper
• Generic
• Mongo
• MongoMapper
• Mongoid

Actions

• actions_for type
• add_member action
• add_collection action

• available_models

include on/off functionality

• on!
• off!
• on?
• off?

Kind of Base Registry

• clear!
• base_class
• base_class= clazz
• unique_key_field
• unique_key_field= key
• relations= *relations
• relations
• default_relations # [:owner, :author, :writer, :user]

Kind of Clazz registry

• register_user clazz

The Registry namespace contains registries useful for configuration and other purposes.

• CanTango::Registry
  • Base
  • Hash
  • Clazz

• types= *classes
• types
• clean! or clear!
• reset!
• register list or << list
• [] index
• registered
• registered? label
• valid? label
• available

Inherits from Base

• #register cache: Caching
• << {cache: Caching, no_cache: NoCache}
• registered
• clean!
• registered_classes
• registered? name
• registered_class? name
• name_registry
• class_registry
• value_methods
• value_types

Inherits from Base

• registered_names
• registered_values

• Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
• Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
• Fork the project
• Start a feature/bugfix branch
• Commit and push until you are happy with your contribution
• Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
• Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright (c) 2011 Kristian Mandrup. See LICENSE.txt for further details.