Class: Treequel::Schema::Table

Inherits:

Object

Object
Treequel::Schema::Table

show all

Extended by:: Forwardable, Loggability

Includes:: Enumerable, Constants::Patterns, Normalization

Defined in:: lib/treequel/schema/table.rb

Overview

This is an object that is used to store LDAP schema information in a case-insensitive table.

Constant Summary collapse

KEYED_METHODS = The list of methods that should be delegated through the key-normalization method.

[ :"[]", :"[]=", :delete, :fetch, :key?, :has_key?, :include?,
:member?, :store ]

Constants included from Constants::Patterns

Class Method Summary collapse

.def_normalized_delegators(delegate, *syms) ⇒ Object

Auto-generate methods which call the given delegate after normalizing their first argument via normalize_key.

Instance Method Summary collapse

#initialize(initial_values = {}) ⇒ Table constructor

Create a new Treequel::Table using the given hash for initial values.
#initialize_copy(orig_table) ⇒ Object

Make sure @hash is unique on Table duplications.
#merge(other_table, &merge_callback) ⇒ Object (also: #update)

Return a new table which is the result of merging the receiver with other_table in the same fashion as Hash#merge.
#merge!(other_table, &merge_callback) ⇒ Object (also: #update!)

Merge other_table into the receiver.
#to_h ⇒ Object (also: #to_hash)

Return the Table as a hash.
#to_s ⇒ Object

Return the Table in LDIF format.
#values_at(*keys) ⇒ Object

Return an array containing the values associated with the given keys.

Methods included from Normalization

normalize_hash, normalize_key

Constructor Details

#initialize(initial_values = {}) ⇒ `Table`

Create a new Treequel::Table using the given hash for initial values.

# File 'lib/treequel/schema/table.rb', line 47

def initialize( initial_values={} )
  @hash = {}
  initial_values.each {|k,v| self.append(k => v) }
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(sym, *args) ⇒ `Object` (protected)

Proxy method: handle getting/setting headers via methods instead of the index operator.

# File 'lib/treequel/schema/table.rb', line 124

def method_missing( sym, *args )
  # work magic
  return super unless sym.to_s =~ /^([a-z]\w+)(=)?$/

  # If it's an assignment, the (=)? will have matched
  key, assignment = $1, $2

  method_body = nil
  if assignment
    method_body = self.make_setter( key )
  else
    method_body = self.make_getter( key )
  end

  self.class.send( :define_method, sym, &method_body )
  return self.method( sym ).call( *args )
end

Class Method Details

.def_normalized_delegators(delegate, *syms) ⇒ `Object`

Auto-generate methods which call the given delegate after normalizing their first argument via normalize_key

# File 'lib/treequel/schema/table.rb', line 34

def self::def_normalized_delegators( delegate, *syms )
  syms.each do |methodname|
    define_method( methodname ) do |key, *args|
      nkey = normalize_key( key )
      instance_variable_get( delegate ).
        __send__( methodname, nkey, *args )
    end
  end
end

Instance Method Details

#initialize_copy(orig_table) ⇒ `Object`

Make sure @hash is unique on Table duplications.



54
55
56

# File 'lib/treequel/schema/table.rb', line 54

def initialize_copy( orig_table ) # :nodoc:
  @hash = orig_table.to_hash
end

#merge(other_table, &merge_callback) ⇒ `Object` Also known as: update

Return a new table which is the result of merging the receiver with other_table in the same fashion as Hash#merge. If the optional merge_callback block is provided, it is called whenever there is a key collision between the two.

# File 'lib/treequel/schema/table.rb', line 103

def merge( other_table, &merge_callback ) # :yields: key, original_value, new_value
  other = self.dup
  other.merge!( other_table, &merge_callback )
  return other
end

#merge!(other_table, &merge_callback) ⇒ `Object` Also known as: update!

Merge other_table into the receiver.

# File 'lib/treequel/schema/table.rb', line 92

def merge!( other_table, &merge_callback )
  nhash = normalize_hash( other_table.to_hash )
  @hash.merge!( nhash, &merge_callback )
end

#to_h ⇒ `Object` Also known as: to_hash

Return the Table as a hash.



85
86
87

# File 'lib/treequel/schema/table.rb', line 85

def to_h
  @hash.dup
end

#to_s ⇒ `Object`

Return the Table in LDIF format

# File 'lib/treequel/schema/table.rb', line 77

def to_s
  @hash.collect do |oid,value|
    "%s: %s" % [ oid, value ]
  end.flatten.sort.join( "\r\n" ) + "\r\n"
end

#values_at(*keys) ⇒ `Object`

Return an array containing the values associated with the given keys.



113
114
115

# File 'lib/treequel/schema/table.rb', line 113

def values_at( *keys )
  @hash.values_at( *(keys.collect {|k| normalize_key(k)}) )
end

Class: Treequel::Schema::Table

Overview

Constant Summary collapse

Constants included from Constants::Patterns

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Normalization

Constructor Details

#initialize(initial_values = {}) ⇒ Table

Dynamic Method Handling

#method_missing(sym, *args) ⇒ Object (protected)

Class Method Details

.def_normalized_delegators(delegate, *syms) ⇒ Object

Instance Method Details

#initialize_copy(orig_table) ⇒ Object

#merge(other_table, &merge_callback) ⇒ Object Also known as: update

#merge!(other_table, &merge_callback) ⇒ Object Also known as: update!

#to_h ⇒ Object Also known as: to_hash

#to_s ⇒ Object

#values_at(*keys) ⇒ Object