ramen 0.4.0

data/lib/ramen/metadata/foreign_key.rb

@@ -0,0 +1,71 @@
+#--
+# Copyright (c) 2007 Gregory N. Houston
+# See ramen.rb for license information.
+#++
+module Ramen::Metadata
+
+  # ForeignKey contains meta-data about foreign keys within a Table.
+  # The attributes are database engine specific.  
+  # Only foreign_key_name and foreign_key_id are required by Ramen.
+  # See RowDataGateway for more information.
+  #
+  # ForeignKey also contains a collection of ForeignKeyColumn objects.  These
+  # are accessable by the column attribute.
+  #
+  # See Database for a description of how ForeignKey fits in the Ramen collection
+  # hierarchy.
+  #
+  # Links: readme.txt[link:files/readme_txt.html]; source[link:rcov/lib-ramen-foreign_key_rb.html]
+  #
+  class ForeignKey < Ramen::RowDataGateway
+    # :section: External Methods
+    # The following methods are intended for use by Ramen's clients.
+
+    # Comparison, returns -1,0,+1, compares foreign_key_name
+    def <=> other
+      Ramen::RowDataGateway.compare( foreign_key_name, other )
+    end
+    
+    # column() #=> RamenHash reference
+    #
+    # This attribute provides access to a RamenHash of all ForeignKeyColumn objects
+    # in the ForeignKey.  The hash is indexed by column_id and column_name.
+    #
+    # usage:
+    #   require 'lib/ramen'
+    #   db = Ramen.create( configuration )
+    #   schema = db.schema['HumanResources']
+    #   table = schema.table['Employee']
+    #   fk = table.fk['FK_Employee_Contact_ContactID']
+    #   fk_column = fk.column['ContactID'] #=> #<Ramen::ForeignKeyColumn ...
+    #
+    def column
+      @columns
+    end
+
+    # :section: Internal Methods
+    # The following methods are for Ramen's internal use.  They
+    # are not intended for clients of Ramen to use.
+    
+    def initialize( record, database )
+      super( record, database )
+      @columns = Ramen::RamenHash.new( ForeignKeyColumn, 'column' )
+    end
+    
+    # add_to( database )
+    #
+    # Add self to the given database.  (Choosing Message; Double Dispatch pattern)
+    # (Kent Beck. Smalltalk Best Practices Patterns. Perntice Hall PTR, Upper Saddle River, NJ 1997)
+    def add_to( database )
+      database.schema[ self.table_schema ].table[ self.table_name ].add_foreign_key( self )
+    end
+    
+    # add_column( obj ) #=> obj
+    #
+    # Adds the column to this table.  Throws a RamenError if the obj
+    # is not a ForeignKeyColumn.
+    def add_column( obj )
+      @columns.add( obj )
+    end
+  end
+end

data/lib/ramen/metadata/foreign_key_column.rb

@@ -0,0 +1,51 @@
+#--
+# Copyright (c) 2007 Gregory N. Houston
+# See ramen.rb for license information.
+#++
+
+module Ramen::Metadata
+  # ForeignKeyColumn contains meta-data about columns within a ForeignKey.
+  # The attributes are database engine specific.  
+  # Only column_name and column_id are required by Ramen.
+  # See RowDataGateway for more information.
+  #
+  # Reference Attributes:
+  # [column] the foreign key column in the table.
+  # [referenced_column] the column in the foreign table.
+  #
+  # See Database for a description of how ForeignKeyColumn fits in the Ramen collection
+  # hierarchy.
+  #
+  # Links: readme.txt[link:files/readme_txt.html]; source[link:rcov/lib-ramen-foreign_key_column_rb.html]
+  #
+  class ForeignKeyColumn < Ramen::RowDataGateway
+    attr_reader :column, :referenced_column
+    
+    # :section: External Methods
+    # The following methods are intended for use by Ramen's clients.
+
+    # Comparison, returns -1,0,+1, compares column_name
+    def <=> other
+      Ramen::RowDataGateway.compare( column_name, other )
+    end
+    
+    # :section: Internal Methods
+    # The following methods are for Ramen's internal use.  They
+    # are not intended for clients of Ramen to use.
+    
+    def initialize( record, database )
+      super( record, database )
+      @column = database.schema[ self.table_schema ].table[ self.table_name ].column[ self.column_name ]
+      @referenced_column = database.schema[ self.referenced_table_schema ].table[ self.referenced_table_name ].column[ self.referenced_column_name ]
+    end
+    
+    # add_to( database )
+    #
+    # Add self to the given database.  (Choosing Message; Double Dispatch pattern)
+    # (Kent Beck. Smalltalk Best Practices Patterns. Perntice Hall PTR, Upper Saddle River, NJ 1997)
+    def add_to( database )
+      database.schema[ self.table_schema ].table[ self.table_name ].
+        fk[ self.foreign_key_name ].add_column( self )
+    end
+  end
+end

data/lib/ramen/metadata/index.rb

@@ -0,0 +1,71 @@
+#--
+# Copyright (c) 2007 Gregory N. Houston
+# See ramen.rb for license information.
+#++
+module Ramen::Metadata
+
+  # Index contains meta-data about indexes within a Table.
+  # The attributes are database engine specific.  
+  # Only index_name and index_id are required by Ramen.
+  # See RowDataGateway for more information.
+  #
+  # Index also contains a collection of IndexColumn objects.  These
+  # are accessable by the column attribute.
+  #
+  # See Database for a description of how Index fits in the Ramen collection
+  # hierarchy.
+  #
+  # Links: readme.txt[link:files/readme_txt.html]; source[link:rcov/lib-ramen-index_rb.html]
+  #
+  class Index < Ramen::RowDataGateway
+    # :section: External Methods
+    # The following methods are intended for use by Ramen's clients.
+
+    # Comparison, returns -1,0,+1, compares index_name
+    def <=> other
+      Ramen::RowDataGateway.compare( index_name, other )
+    end
+    
+    # column() #=> RamenHash reference
+    #
+    # This attribute provides access to a RamenHash of all IndexColumn objects
+    # in the Index.  The hash is indexed by column_id and column_name.
+    #
+    # usage:
+    #   require 'lib/ramen'
+    #   db = Ramen.create( configuration )
+    #   schema = db.schema['HumanResources']
+    #   table = schema.table['Employee']
+    #   index = table.index['IX_Employee_ManagerID']
+    #   index_column = index.column['ManagerID'] #=> #<Ramen::IndexColumn ...
+    #
+    def column
+      @columns
+    end
+    
+    # :section: Internal Methods
+    # The following methods are for Ramen's internal use.  They
+    # are not intended for clients of Ramen to use.
+    
+    def initialize( record, database )
+      super( record, database )
+      @columns = Ramen::RamenHash.new( IndexColumn, 'column' )
+    end
+    
+    # add_to( database )
+    #
+    # Add self to the given database.  (Choosing Message; Double Dispatch pattern)
+    # (Kent Beck. Smalltalk Best Practices Patterns. Perntice Hall PTR, Upper Saddle River, NJ 1997)
+    def add_to( database )
+      database.schema[ self.table_schema ].table[ self.table_name ].add_index( self )
+    end
+    
+    # add_column( obj ) #=> obj
+    #
+    # Adds the column to this table.  Throws a RamenError if the obj
+    # is not a IndexColumn.
+    def add_column( obj )
+      @columns.add( obj )
+    end
+  end
+end

data/lib/ramen/metadata/index_column.rb

@@ -0,0 +1,49 @@
+#--
+# Copyright (c) 2007 Gregory N. Houston
+# See ramen.rb for license information.
+#++
+
+module Ramen::Metadata
+  # IndexColumn contains meta-data about columns within an Index.
+  # The attributes are database engine specific.  
+  # Only column_name and column_id are required by Ramen.
+  # See RowDataGateway for more information.
+  #
+  # Reference Attributes:
+  # [column] the column in the Index.
+  #
+  # See Database for a description of how IndexColumn fits in the Ramen collection
+  # hierarchy.
+  #
+  # Links: readme.txt[link:files/readme_txt.html]; source[link:rcov/lib-ramen-index_column_rb.html]
+  #
+  class IndexColumn < Ramen::RowDataGateway
+    attr_reader :column
+    
+    # :section: External Methods
+    # The following methods are intended for use by Ramen's clients.
+
+    # Comparison, returns -1,0,+1, compares column_name
+    def <=> other
+      Ramen::RowDataGateway.compare( column_name, other )
+    end
+    
+    # :section: Internal Methods
+    # The following methods are for Ramen's internal use.  They
+    # are not intended for clients of Ramen to use.
+    
+    def initialize( record, database )
+      super( record, database )
+      @column = database.schema[ self.table_schema ].table[ self.table_name ].column[ column_name ]
+    end
+
+    # add_to( database )
+    #
+    # Add self to the given database.  (Choosing Message; Double Dispatch pattern)
+    # (Kent Beck. Smalltalk Best Practices Patterns. Perntice Hall PTR, Upper Saddle River, NJ 1997)
+    def add_to( database )
+      database.schema[ self.table_schema ].table[ self.table_name ].
+        index[ self.index_name ].add_column( self )
+    end
+  end
+end

data/lib/ramen/metadata/key_constraint.rb

@@ -0,0 +1,56 @@
+#--
+# Copyright (c) 2007 Gregory N. Houston
+# See ramen.rb for license information.
+#++
+module Ramen::Metadata
+
+  # (KeyConstraint is left over from an earlier implementation of Ramen that
+  # was only concerned with Sql Server 2005.  For now, the class has been
+  # stripped of features (code commented out).  In the future, this will
+  # probably get transformed into a UniqueConstraint or simply Constraint class
+  # which is better suited for multiple database.)
+  # 
+  # KeyConstraint contains meta-data about key constraints within a Table.
+  # The attributes are database engine specific.  
+  # Only key_constraint_name and key_constraint_id are required by Ramen.
+  # See RowDataGateway for more information.
+  #
+  # Reference Attributes:
+  # [index] the index used by the key constraint.
+  # 
+  # See Database for a description of how ForeignKey fits in the Ramen collection
+  # hierarchy.
+  #
+  # Links: readme.txt[link:files/readme_txt.html]; source[link:rcov/lib-ramen-key_constraint_rb.html]
+  #
+  class KeyConstraint < Ramen::RowDataGateway
+=begin    
+    attr_reader :index
+
+    # :section: External Methods
+    # The following methods are intended for use by Ramen's clients.
+
+    # Comparison, returns -1,0,+1, compares key_name
+    def <=> other
+      Ramen::RowDataGateway.compare( key_name, other )
+    end
+    
+    # :section: Internal Methods
+    # The following methods are for Ramen's internal use.  They
+    # are not intended for clients of Ramen to use.
+    
+    def initialize( record, database )
+      super( record, database )
+      @index = database.schema[ self.table_schema ].table[ self.table_name ].index[ self.index_name ]
+    end
+    
+    # add_to( database )
+    #
+    # Add self to the given database.  (Choosing Message; Double Dispatch pattern)
+    # (Kent Beck. Smalltalk Best Practices Patterns. Perntice Hall PTR, Upper Saddle River, NJ 1997)
+    def add_to( database )
+      database.schema[ self.table_schema ].table[ self.table_name ].add_key_constraint( self )
+    end
+=end    
+  end
+end

data/lib/ramen/metadata/metadata.rb

@@ -0,0 +1,10 @@
+#--
+# Copyright (c) 2007 Gregory N. Houston
+# See ramen.rb for license information.
+#++
+
+module Ramen
+  # TODO document
+  module Metadata
+  end
+end

data/lib/ramen/metadata/primary_key.rb

@@ -0,0 +1,71 @@
+#--
+# Copyright (c) 2007 Gregory N. Houston
+# See ramen.rb for license information.
+#++
+module Ramen::Metadata
+
+  # PrimaryKey contains meta-data about the primary key for a Table.
+  # The attributes are database engine specific.  
+  # Only primary_key_name is required by Ramen.
+  # See RowDataGateway for more information.
+  #
+  # PrimaryKey also contains a collection of PrimaryKeyColumn objects.  These
+  # are accessable by the column attribute.
+  #
+  # See Database for a description of how PrimaryKey fits in the Ramen collection
+  # hierarchy.
+  #
+  # Links: readme.txt[link:files/readme_txt.html]; source[link:rcov/lib-ramen-primary_key_rb.html]
+  #
+  class PrimaryKey < Ramen::RowDataGateway
+    # :section: External Methods
+    # The following methods are intended for use by Ramen's clients.
+
+    # Comparison, returns -1,0,+1, compares primary_key_name
+    def <=> other
+      Ramen::RowDataGateway.compare( primary_key_name, other )
+    end
+    
+    # column() #=> RamenHash reference
+    #
+    # This attribute provides access to a RamenHash of all PrimaryKeyColumn objects
+    # in the PrimaryKey.  The hash is indexed by column_name and column_id (if available).
+    #
+    # usage:
+    #   require 'lib/ramen'
+    #   db = Ramen.create( configuration )
+    #   schema = db.schema['HumanResources']
+    #   table = schema.table['Employee']
+    #   pk = table.pk['PK_Employee_EmployeeID']
+    #   pk_column = pk.column['EmployeeID'] #=> #<Ramen::PrimaryKeyColumn ...
+    #
+    def column
+      @columns
+    end
+
+    # :section: Internal Methods
+    # The following methods are for Ramen's internal use.  They
+    # are not intended for clients of Ramen to use.
+    
+    def initialize( record, database )
+      super( record, database )
+      @columns = Ramen::RamenHash.new( PrimaryKeyColumn, 'column' )
+    end
+    
+    # add_to( database )
+    #
+    # Add self to the given database.  (Choosing Message; Double Dispatch pattern)
+    # (Kent Beck. Smalltalk Best Practices Patterns. Perntice Hall PTR, Upper Saddle River, NJ 1997)
+    def add_to( database )
+      database.schema[ self.table_schema ].table[ self.table_name ].set_primary_key( self )
+    end
+    
+    # add_column( obj ) #=> obj
+    #
+    # Adds the column to this table.  Throws a RamenError if the obj
+    # is not a ForeignKeyColumn.
+    def add_column( obj )
+      @columns.add( obj )
+    end
+  end
+end

data/lib/ramen/metadata/primary_key_column.rb

@@ -0,0 +1,49 @@
+#--
+# Copyright (c) 2007 Gregory N. Houston
+# See ramen.rb for license information.
+#++
+
+module Ramen::Metadata
+  # PrimaryKeyColumn contains meta-data about columns within a PrimaryKey.
+  # The attributes are database engine specific.  
+  # Only column_name and column_id are required by Ramen.
+  # See RowDataGateway for more information.
+  #
+  # Reference Attributes:
+  # [column] the primary key column in the table.
+  #
+  # See Database for a description of how PrimaryKeyColumn fits in the Ramen
+  # collection hierarchy.
+  #
+  # Links: readme.txt[link:files/readme_txt.html]; source[link:rcov/lib-ramen-primary_key_column_rb.html]
+  #
+  class PrimaryKeyColumn < Ramen::RowDataGateway
+    attr_reader :column
+    
+    # :section: External Methods
+    # The following methods are intended for use by Ramen's clients.
+
+    # Comparison, returns -1,0,+1, compares column_name
+    def <=> other
+      Ramen::RowDataGateway.compare( column_name, other )
+    end
+    
+    # :section: Internal Methods
+    # The following methods are for Ramen's internal use.  They
+    # are not intended for clients of Ramen to use.
+    
+    def initialize( record, database )
+      super( record, database )
+      @column = database.schema[ self.table_schema ].table[ self.table_name ].column[ self.column_name ]
+    end
+    
+    # add_to( database )
+    #
+    # Add self to the given database.  (Choosing Message; Double Dispatch pattern)
+    # (Kent Beck. Smalltalk Best Practices Patterns. Perntice Hall PTR, Upper Saddle River, NJ 1997)
+    def add_to( database )
+      database.schema[ self.table_schema ].table[ self.table_name ].
+        pk.add_column( self )
+    end
+  end
+end

data/lib/ramen/metadata/schema.rb

@@ -0,0 +1,86 @@
+#--
+# Copyright (c) 2007 Gregory N. Houston
+# See ramen.rb for license information.
+#++
+module Ramen::Metadata
+
+  # Schema contains a collection of Tables.  Attributes available for Schema
+  # are database engine specific.  Ramen only requires the attributes
+  # schema_name and schema_id.  See RowDataGateway for more information.
+  #
+  # See Database for a description of how Schema fits in the Ramen collection
+  # hierarchy.
+  #
+  # Links: readme.txt[link:files/readme_txt.html]; source[link:rcov/lib-ramen-schema_rb.html]
+  #
+  class Schema < Ramen::RowDataGateway
+    # :section: External Methods
+    # The following methods are intended for use by Ramen's clients.
+
+    # Comparison, returns -1,0,+1, compares schema_name
+    def <=> other
+      Ramen::RowDataGateway.compare( schema_name, other )
+    end
+    
+    # table() #=> RamenHash reference
+    #
+    # This attribute provides access to a RamenHash of all Table objects in the
+    # Schema.  The hash is indexed by table_name and table_id.
+    #
+    # usage:
+    #   require 'lib/ramen'
+    #   db = Ramen.create( configuration )
+    #   schema = db.schema['Sales']  #=> #<Schema schema_name='Sales', schema_id='1234567' ...>
+    #   table = schema.table['Products'] #=> #<Table table_name='Products', table_id='1111111111'> 
+    #   table = schema.table[1111111111] #=> #<Table table_name='Products', table_id='1111111111'> 
+    #
+    def table
+      @tables
+    end
+    
+    # inspect() #=> string
+    #
+    # Returns a nice and brief output of the schema and it's tables.  This
+    # was redefined since the default inspect would typically output many
+    # pages of details.
+    #
+    # Each table is listed by id:name.
+    #
+    # usage:
+    #   db = Ramen.create()
+    #   schema = db.schema['Sales']
+    #   schema.inspect  #=> "#<Ramen::Schema:0x2da0669 table=[1:Promotions, 2:Orders,..."
+    #
+    def inspect
+      children = []
+      @tables.each_by_id do |id,table|
+        children << (id.to_s+':'+table.table_name)
+      end
+      to_s[0..-2]+' schema_name=\''+ schema_name+ '\'' + ((self.respond_to?:schema_id)?' schema_id=' + schema_id.to_s : '') + ' tables=['+children.join(', ')+']>'
+    end
+    
+    # :section: Internal Methods
+    # The following methods are for Ramen's internal use.  They
+    # are not intended for clients of Ramen to use.
+    
+    def initialize( record, database )
+      super(record, database)
+      @tables = Ramen::RamenHash.new( Table )
+    end
+    
+    # add_to( database )
+    #
+    # Add self to the given database.  (Choosing Message; Double Dispatch pattern)
+    def add_to( database )
+      database.add_schema( self )
+    end
+    
+    # add_table( obj ) #=> obj
+    #
+    # Adds the given table to this schema.  Throws a RamenError if the obj
+    # is not a Table.
+    def add_table( table )
+      @tables.add( table )
+    end
+  end
+end