activeldap 3.1.1 → 3.2.0

data/Gemfile

@@ -2,17 +2,4 @@
 
 source "http://rubygems.org"
 
-gem 'activemodel', '~> 3.1.0'
-gem 'locale'
-gem 'fast_gettext'
-gem 'gettext_i18n_rails'
-
-group :development, :test do
-  gem 'ruby-ldap'
-  gem 'net-ldap'
-  gem 'jeweler'
-  gem 'test-unit'
-  gem 'test-unit-notify'
-  gem "yard"
-  gem "RedCloth"
-end
+gemspec

data/benchmark/README.md

@@ -0,0 +1,64 @@
+# README
+
+This document describes how to run benchmarks under
+benchmark/ directory.
+
+## Configure your LDAP server
+
+You need a LDAP server to run benchmarks. This is dependes
+on your environment.
+
+In this document, we assume that you configure your LDAP
+server by the following configuration:
+
+* host: 127.0.0.1
+* base DN: dc=bench,dc=local
+* encryption: startTLS
+* bind DN: cn=admin,dc=local
+* password: secret
+
+## Configure ActiveLdap to connect to your LDAP server
+
+You need an ActiveLdap configuration in
+benchmark/config.yaml to connect to your LDAP server. There
+is a sample configuration in
+benchmark/config.yaml.sample. It's good to start from it.
+
+    % cp benchmark/config.yaml.sample benchmark/config.yaml
+    % editor benchmark/config.yaml
+
+The configuration uses the same format of ldap.yaml.
+
+## Run benchmarks
+
+You just run a bencmark script. It loads
+benchmark/config.yaml and populate benchmark data automatically.
+
+    % ruby benchmark/bench-backend.rb
+	Populating...
+
+	Rehearsal ---------------------------------------------------------------
+	  1x: AL(LDAP)                0.220000   0.000000   0.220000 (  0.234775)
+	  1x: AL(Net::LDAP)           0.280000   0.000000   0.280000 (  0.273048)
+	  1x: AL(LDAP: No Obj)        0.000000   0.000000   0.000000 (  0.009217)
+	  1x: AL(Net::LDAP: No Obj)   0.060000   0.000000   0.060000 (  0.056727)
+	  1x: LDAP                    0.000000   0.000000   0.000000 (  0.003261)
+	  1x: Net::LDAP               0.040000   0.000000   0.040000 (  0.029862)
+	------------------------------------------------------ total: 0.600000sec
+
+									  user     system      total        real
+	  1x: AL(LDAP)                0.200000   0.000000   0.200000 (  0.195660)
+	  1x: AL(Net::LDAP)           0.220000   0.000000   0.220000 (  0.213444)
+	  1x: AL(LDAP: No Obj)        0.010000   0.000000   0.010000 (  0.009000)
+	  1x: AL(Net::LDAP: No Obj)   0.030000   0.000000   0.030000 (  0.026847)
+	  1x: LDAP                    0.000000   0.000000   0.000000 (  0.003377)
+	  1x: Net::LDAP               0.020000   0.000000   0.020000 (  0.022662)
+
+	Entries processed by Ruby/ActiveLdap + LDAP: 100
+	Entries processed by Ruby/ActiveLdap + Net::LDAP: 100
+	Entries processed by Ruby/ActiveLdap + LDAP: (without object creation): 100
+	Entries processed by Ruby/ActiveLdap + Net::LDAP: (without object creation): 100
+	Entries processed by Ruby/LDAP: 100
+	Entries processed by Net::LDAP: 100
+
+	Cleaning...

data/benchmark/{bench-al.rb → bench-backend.rb}

@@ -7,7 +7,11 @@ require "benchmark"
 
 include ActiveLdap::GetTextSupport
 
-argv, opts, options = ActiveLdap::Command.parse_options do |opts, options|
+argv = ARGV.dup
+unless argv.include?("--config")
+  argv.unshift("--config", File.join(base, "config.yaml"))
+end
+argv, opts, options = ActiveLdap::Command.parse_options(argv) do |opts, options|
   options.prefix = "ou=People"
 
   opts.on("--prefix=PREFIX",
@@ -129,27 +133,7 @@ rescue LoadError
 end
 
 def populate_base
-  suffixes = []
-  ActiveLdap::Base.base.split(/,/).reverse_each do |suffix|
-    prefix = suffixes.join(",")
-    suffixes.unshift(suffix)
-    name, value = suffix.split(/=/, 2)
-    next unless name == "dc"
-    dc_class = Class.new(ActiveLdap::Base)
-    dc_class.ldap_mapping :dn_attribute => "dc",
-                          :prefix => "",
-                          :scope => :base,
-                          :classes => ["top", "dcObject", "organization"]
-    dc_class.instance_variable_set("@base", prefix)
-    next if dc_class.exists?(value, :prefix => "dc=#{value}")
-    dc = dc_class.new(value)
-    dc.o = dc.dc
-    begin
-      dc.save
-    rescue ActiveLdap::OperationNotPermitted
-    end
-  end
-
+  ActiveLdap::Populate.ensure_base
   if ActiveLdap::Base.search.empty?
     raise "Can't populate #{ActiveLdap::Base.base}"
   end

data/benchmark/bench-instantiate.rb

@@ -0,0 +1,98 @@
+base = File.dirname(__FILE__)
+$LOAD_PATH.unshift(File.expand_path(base))
+$LOAD_PATH.unshift(File.expand_path(File.join(base, "..", "lib")))
+
+require "active_ldap"
+require "benchmark"
+
+include ActiveLdap::GetTextSupport
+
+argv = ARGV.dup
+unless argv.include?("--config")
+  argv.unshift("--config", File.join(base, "config.yaml"))
+end
+argv, opts, options = ActiveLdap::Command.parse_options(argv) do |opts, options|
+  options.prefix = "ou=People"
+
+  opts.on("--prefix=PREFIX",
+          _("Specify prefix for benchmarking"),
+          _("(default: %s)") % options.prefix) do |prefix|
+    options.prefix = prefix
+  end
+end
+
+ActiveLdap::Base.setup_connection
+config = ActiveLdap::Base.configuration
+
+LDAP_PREFIX = options.prefix
+LDAP_USER = config[:bind_dn]
+LDAP_PASSWORD = config[:password]
+
+N_USERS = 100
+
+class ALUser < ActiveLdap::Base
+  ldap_mapping :dn_attribute => 'uid', :prefix => LDAP_PREFIX,
+               :classes => ['posixAccount', 'person']
+end
+
+def populate_base
+  ActiveLdap::Populate.ensure_base
+  if ActiveLdap::Base.search.empty?
+    raise "Can't populate #{ActiveLdap::Base.base}"
+  end
+end
+
+def populate_users
+  ou_class = Class.new(ActiveLdap::Base)
+  ou_class.ldap_mapping :dn_attribute => "ou",
+                        :prefix => "",
+                        :classes => ["top", "organizationalUnit"]
+  ou_class.new(LDAP_PREFIX.split(/=/)[1]).save!
+
+  N_USERS.times do |i|
+    name = i.to_s
+    user = ALUser.new(name)
+    user.uid_number = 100000 + i
+    user.gid_number = 100000 + i
+    user.cn = name
+    user.sn = name
+    user.home_directory = "/nonexistent"
+    user.save!
+  end
+end
+
+def populate
+  populate_base
+  populate_users
+end
+
+def main(do_populate)
+  if do_populate
+    puts(_("Populating..."))
+    dumped_data = ActiveLdap::Base.dump(:scope => :sub)
+    ActiveLdap::Base.delete_all(nil, :scope => :sub)
+    populate
+    puts
+  end
+
+  Benchmark.bmbm(20) do |x|
+    n = 100
+    GC.start
+    x.report("search 100 entries") do
+      n.times {ALUser.search}
+    end
+    GC.start
+    x.report("instantiate 1 entry") do
+      n.times {ALUser.first}
+    end
+  end
+ensure
+  if do_populate
+    puts
+    puts(_("Cleaning..."))
+    ActiveLdap::Base.delete_all(nil, :scope => :sub)
+    ActiveLdap::Base.load(dumped_data)
+  end
+end
+
+main(LDAP_USER && LDAP_PASSWORD)

data/benchmark/config.yaml.sample

@@ -1,5 +1,5 @@
 host: 127.0.0.1
-base: dc=bench,dc=localcomain
+base: dc=bench,dc=local
 method: :tls
-bind_dn: cn=user-name,dc=localdomain
+bind_dn: cn=admin,dc=local
 password: secret

data/doc/text/news.textile

@@ -1,5 +1,43 @@
 h1. News
 
+h2(#3-2-0). 3.2.0: 2012-08-29
+
+* [GitHub:#39] Supported Rails 3.2.8. [Reported by Ben Langfeld]
+* [GitHub:#13] Don't use deprecated Gem.available?. [Patch by sailesh]
+* [GitHub:#19] Supported new entry by @ha_many :wrap@. [Patch by Alex Tomlins]
+* Supported @:only@ option in XML output.
+* [GitHub:#14] Supported nil as single value. [Reported by n3llyb0y]
+* [GitHub:#20] Supported ActiveModel::MassAssignmentSecurity.
+  [Reported by mihu]
+* [GitHub:#24] Supported Ruby 1.9 style Hash syntax in generator.
+  [Patch by ursm]
+* [GitHub:#25][GitHub:#39] Supported ActiveModel::Dirty.
+  [Patch by mihu][Reported by Ben Langfeld]
+* [GitHub:#26] Improved speed for dirty. [Patch by mihu]
+* [GitHub:#28] Improved speed for initialization. [Patch by mihu]
+* [GitHub:#29] Added .gemspec. [Suggested by mklappstuhl]
+* [GitHub:#34] Removed an unused method. [Patch by mihu]
+* [GitHub:#37] Improved will_paginate support. [Patch by Craig White]
+* [GitHub:#40] Added missing test files to .gemspec. [Reported by Vít Ondruch]
+* [GitHub:#41] Improved speed for find. [Patch by unixmechanic]
+* Changed i18n backend to gettext from fast_gettext again.
+* [GitHub:#42] Fixed a bug that optional second is required for GeneralizedTime.
+  [Reported by masche842]
+
+h3. Thanks
+
+* sailesh
+* Alex Tomlins
+* n3llyb0y
+* mihu
+* ursm
+* Ben Langfeld
+* mklappstuhl
+* Craig White
+* Vít Ondruch
+* unixmechanic
+* masche842
+
 h2(#3-1-1). 3.1.1: 2011-11-03
 
 * Supported Rails 3.1.1.

data/lib/active_ldap.rb

@@ -2,8 +2,9 @@ require "rubygems"
 require "active_model"
 require "active_support/core_ext"
 
+require "active_ldap/version"
+
 module ActiveLdap
-  VERSION = "3.1.1"
   autoload :Command, "active_ldap/command"
 end
 
@@ -13,11 +14,6 @@ else
   require 'active_ldap/timeout_stub'
 end
 
-begin
-  require "locale"
-  require "fast_gettext"
-rescue LoadError
-end
 require 'active_ldap/get_text'
 
 require 'active_ldap/compatible'
@@ -32,6 +28,12 @@ require 'active_ldap/persistence'
 
 require 'active_ldap/associations'
 require 'active_ldap/attributes'
+require 'active_ldap/attribute_methods'
+require 'active_ldap/attribute_methods/query'
+require 'active_ldap/attribute_methods/before_type_cast'
+require 'active_ldap/attribute_methods/read'
+require 'active_ldap/attribute_methods/write'
+require 'active_ldap/attribute_methods/dirty'
 require 'active_ldap/configuration'
 require 'active_ldap/connection'
 require 'active_ldap/operations'
@@ -50,15 +52,22 @@ require 'active_ldap/callbacks'
 
 
 ActiveLdap::Base.class_eval do
+  include ActiveLdap::Persistence
+
   include ActiveLdap::Associations
+  include ActiveModel::MassAssignmentSecurity
   include ActiveLdap::Attributes
+  include ActiveLdap::AttributeMethods
+  include ActiveLdap::AttributeMethods::BeforeTypeCast
+  include ActiveLdap::AttributeMethods::Write
+  include ActiveLdap::AttributeMethods::Dirty
+  include ActiveLdap::AttributeMethods::Query
+  include ActiveLdap::AttributeMethods::Read
   include ActiveLdap::Configuration
   include ActiveLdap::Connection
   include ActiveLdap::Operations
   include ActiveLdap::ObjectClass
 
-  include ActiveLdap::Persistence
-
   include ActiveLdap::Acts::Tree
 
   include ActiveLdap::Validations

data/lib/active_ldap/association/has_many_wrap.rb

@@ -18,7 +18,7 @@ module ActiveLdap
         new_value = (old_value + current_value).uniq.sort
         if old_value != new_value
           @owner[@options[:wrap]] = new_value
-          @owner.save
+          @owner.save unless @owner.new_entry?
         end
       end
 
@@ -34,7 +34,7 @@ module ActiveLdap
         new_value = new_value.uniq.sort
         if old_value != new_value
           @owner[@options[:wrap]] = new_value
-          @owner.save
+          @owner.save unless @owner.new_entry?
         end
       end
 
@@ -57,6 +57,19 @@ module ActiveLdap
       def foreign_key
         @options[:primary_key_name] || foreign_class.dn_attribute
       end
+
+      def add_entries(*entries)
+        result = true
+        load_target
+
+        flatten_deeper(entries).each do |entry|
+          infect_connection(entry)
+          insert_entry(entry) or result = false
+          @target << entry
+        end
+
+        result && self
+      end
     end
   end
 end

data/lib/active_ldap/attribute_methods.rb

@@ -0,0 +1,23 @@
+module ActiveLdap
+  module AttributeMethods
+    extend ActiveSupport::Concern
+    include ActiveModel::AttributeMethods
+
+    def methods(singleton_methods = true)
+      target_names = entry_attribute.all_names
+      target_names -= ['objectClass', 'objectClass'.underscore]
+      super + target_names.uniq.collect do |attr|
+        self.class.attribute_method_matchers.collect do |matcher|
+          :"#{matcher.prefix}#{attr}#{matcher.suffix}"
+        end
+      end.flatten
+    end
+
+    protected
+
+    # overiding ActiveModel::AttributeMethods
+    def attribute_method?(method_name)
+      have_attribute?(method_name, ['objectClass'])
+    end
+  end
+end

data/lib/active_ldap/attribute_methods/before_type_cast.rb

@@ -0,0 +1,24 @@
+module ActiveLdap
+  module AttributeMethods
+    module BeforeTypeCast
+      extend ActiveSupport::Concern
+
+      included do
+        attribute_method_suffix '_before_type_cast'
+      end
+
+    protected
+      def attribute_before_type_cast(attr)
+        get_attribute_before_type_cast(attr)[1]
+      end
+
+      def get_attribute_before_type_cast(name, force_array=false)
+        name = to_real_attribute_name(name)
+
+        value = @data[name]
+        value = [] if value.nil?
+        [name, array_of(value, force_array)]
+      end
+    end
+  end
+end

data/lib/active_ldap/attribute_methods/dirty.rb

@@ -0,0 +1,43 @@
+#
+module ActiveLdap
+  module AttributeMethods
+    module Dirty
+      extend ActiveSupport::Concern
+      include ActiveModel::Dirty
+
+      # Attempts to +save+ the record and clears changed attributes if successful.
+      def save(*) #:nodoc:
+        succeeded = super
+        if succeeded
+          @previously_changed = changes
+          @changed_attributes.clear
+        end
+        succeeded
+      end
+
+      # Attempts to <tt>save!</tt> the record and clears changed attributes if successful.
+      def save!(*) #:nodoc:
+        super.tap do
+          @previously_changed = changes
+          @changed_attributes.clear
+        end
+      end
+
+      # <tt>reload</tt> the record and clears changed attributes.
+      def reload(*) #:nodoc:
+        super.tap do
+          @previously_changed.clear
+          @changed_attributes.clear
+        end
+      end
+
+    protected
+      def set_attribute(name, value)
+        if name != "objectClass"
+          attribute_will_change!(name) unless value == get_attribute(name)
+        end
+        super
+      end
+    end
+  end
+end