activeldap 5.2.4 → 6.1.0

data/doc/text/{rails.textile → rails.md}

@@ -1,26 +1,26 @@
-h1. Rails
+# Rails
 
 ActiveLdap supports Rails 4.0 or later.
 
-h2. Install
+## Install
 
 To install, simply add the following code to your Gemfile:
 
-<pre>
+```ruby
 gem 'activeldap', :require => 'active_ldap/railtie'
-</pre>
+```
 
 You should also depend on an LDAP adapter such as Net::LDAP
 or Ruby/LDAP. The following example uses Ruby/LDAP:
 
-<pre>
+```ruby
 gem 'ruby-ldap'
-</pre>
+```
 
 Bundler will install the gems automatically when you run
-'bundle install'.
+`bundle install`.
 
-h2. Configuration
+## Configuration
 
 You can use a LDAP configuration per environment. They are in
 a file named 'ldap.yml' in the config directory of your
@@ -32,54 +32,65 @@ development, test, and production environments.
 
 You can generate 'config/ldap.yml' by the following command:
 
-<pre class="command">
+```console
 % script/rails generate active_ldap:scaffold
-</pre>
+```
 
 You need to modify 'config/ldap.yml' generated by
-active_ldap:scaffold. For instance, the development entry
+`active_ldap:scaffold`. For instance, the development entry
 would look something like the following:
 
-<pre>
-!!!plain
+```yaml
 development:
   host: 127.0.0.1
   port: 389
   base: dc=localhost
   bind_dn: cn=admin,dc=localhost
   password: secret
-</pre>
+```
 
 When your application starts up,
 ActiveLdap::Base.setup_connection will be called with the
 parameters specified for your current environment.
 
 You can replace default orm generators with gems one
-to skip active_ldap prefix in 'config/application.rb':
-<pre>config.app_generators.orm :active_ldap</pre>
+to skip `active_ldap prefix` in `config/application.rb`:
 
-h2. Model
+```ruby
+config.app_generators.orm :active_ldap
+```
+
+Concurrency is now enabled by default to ensure thread safe searches and modifications. This can
+still be disabled if desired.
+
+```ruby
+# config/initializers/active_ldap.rb
+
+ActiveLdap::Base.allow_concurrency = false
+```
+
+## Model
 
 You can generate a User model that represents entries under
 ou=Users by the following command:
 
-<pre class="command">
+```console
 % script/rails generate active_ldap:model User --dn-attribute uid --classes person PosixAccount
-</pre>
+```
 
 It generates the following app/model/user.rb:
 
-<pre>
+```ruby
 class User < ActiveLdap::Base
   ldap_mapping :dn_attribute => "uid",
                :prefix => "ou=Users",
                :classes => ["person", "PosixAccount"]
 end
-</pre>
+```
 
 You can add relationships by modifying app/model/user.rb:
 
-<pre>
+```ruby
 class User < ActiveLdap::Base
   ldap_mapping :dn_attribute => 'uid',
                :prefix => "ou=Users",
@@ -91,27 +102,27 @@ class User < ActiveLdap::Base
   belongs_to :groups,
              :many => 'memberUid'
 end
-</pre>
+```
 
 You can also generate a Group model by the following command:
 
-<pre class="command">
+```console
 % script/rails generate active_ldap:model Group --classes PosixGroup
-</pre>
+```
 
 app/model/group.rb:
 
-<pre>
+```ruby
 class Group < ActiveLdap::Base
   ldap_mapping :dn_attribute => "cn",
                :prefix => "ou=Groups",
                :classes => ["PosixGroup"]
 end
-</pre>
+```
 
 You can add relationships by modifying app/model/group.rb:
 
-<pre>
+```ruby
 class Group < ActiveLdap::Base
   ldap_mapping :dn_attribute => "cn",
                :prefix => "ou=Groups",
@@ -124,18 +135,18 @@ class Group < ActiveLdap::Base
            :foreign_key => "gidNumber",
            :primary_key => "gidNumber"
 end
-</pre>
+```
 
 You can also generate a Ou model by the following command:
 
-<pre class="command">
+```console
 % script/rails generate active_ldap:model Ou --prefix '' --classes organizationalUnit
-</pre>
+```
 
-<pre>
+```ruby
 class Ou < ActiveLdap::Base
   ldap_mapping :dn_attribute => "cn",
                :prefix => "",
                :classes => ["organizationalUnit"]
 end
-</pre>
+```