ramen 0.4.0

data/lib/ramen/core.rb

@@ -0,0 +1,75 @@
+#--
+# Copyright (c) 2007 Gregory N. Houston
+# See ramen.rb for license information.
+#++
+# 'core.rb' contains additions to Ruby's core classes: String and NilClass
+
+module Kernel
+  unless Kernel.respond_to? :singleton_class
+    def singleton_class
+      class << self; self; end 
+    end
+  end
+end
+
+class String
+  # to_delimited_words #=> string
+  #
+  # Returns a string with CamelCase converted to underscore delimited words.
+  #
+  # usage:
+  #   "CamelCase".to_delimited_words #=> "camel_case"
+  #
+  # Links: readme.txt[link:files/readme_txt.html]; source[link:rcov/lib-ramen-core_rb.html]
+  #
+  def to_delimited_words
+    results = []
+    word = ''
+    (0...self.size).each do |i|
+      char = self[i,1]
+      if char.is_upcase?
+        unless word.size == 0
+          results << word
+          word = ''
+        end
+        word << char.downcase
+      else
+        word << char
+      end
+    end
+    unless word.size == 0
+      results << word
+    end
+    
+    results.join( '_')
+  end
+  
+  # is_upcase?
+  #
+  # Intention Revealing Message pattern. (Kent Beck. Smalltalk Best Practices
+  # Patterns. Perntice Hall PTR, Upper Saddle River, NJ 1997)
+  #
+  # Links: readme.txt[link:files/readme_txt.html]; source[link:rcov/lib-ramen-core_rb.html]
+  #
+  def is_upcase?
+    self.upcase == self
+  end
+end
+
+class NilClass
+  unless NilClass.method_defined? '<=>'.to_sym
+    # Comparison, returns -1,0,+1
+    #
+    # if argument is nil, returns 0 (same)
+    # otherwise returns -1 (self is < other)
+    #
+    # this allows sorting of collections that contain nil, the nil will sort to
+    # the front.
+    #
+    # Links: readme.txt[link:files/readme_txt.html]; source[link:rcov/lib-ramen-core_rb.html]
+    #
+    def <=> other
+      (other.nil?) ? 0 : -1
+    end
+  end
+end

data/lib/ramen/default_logger.rb

@@ -0,0 +1,29 @@
+#--
+# Copyright (c) 2007 Gregory N. Houston
+# See ramen.rb for license information.
+#++
+
+module Ramen
+  # A simple logger, just calls #puts to display warn, error and fatal messages.
+  #
+  # When creating a custom logger for Ramen#create or Home#new, these methods need
+  # to be defined.
+  #
+  # Links: readme.txt[link:files/readme_txt.html]; source[link:rcov/lib-ramen-default_logger_rb.html]
+  #
+  class DefaultLogger
+    def debug( msg )
+    end
+    def info( msg )
+    end
+    def warn( msg )
+      puts msg
+    end
+    def error( msg )
+      puts msg
+    end
+    def fatal( msg )
+      puts msg
+    end
+  end
+end

data/lib/ramen/engine/engine.rb

@@ -0,0 +1,34 @@
+#--
+# Copyright (c) 2007 Gregory N. Houston
+# See ramen.rb for license information.
+#++
+
+module Ramen
+  # This module is a mix-in into modules which contain the code specific to
+  # database engines.  For example, Sql2005 has the code for SQL Server 2005,
+  # and therefore it includes this module.
+  module Engine
+    class << self
+      def included( mod )
+        lineno, source = __LINE__, <<-SOURCE
+          class << self
+            def const_missing( name )
+              unless Ramen::Metadata.const_defined? name
+                raise NameError, "uninitialized constant \#{self.name}::\#{name}", caller
+              end
+
+              parent_class = Ramen::Metadata.const_get( name )
+              unless parent_class.instance_of? Class
+                raise NameError, "uninitialized constant \#{self.name}::\#{name}", caller 
+              end
+
+              self.module_eval "class \#{name} < \#{parent_class}; end", __FILE__, __LINE__
+              self.const_get( name )
+            end
+          end
+        SOURCE
+        mod.module_eval source, __FILE__, lineno
+      end
+    end
+  end
+end

data/lib/ramen/engine/mysql.rb

@@ -0,0 +1,225 @@
+#--
+# Copyright (c) 2007 Gregory N. Houston
+# See ramen.rb for license information.
+#++
+
+module Ramen
+  # Responsible for returning T-SQL statements for various Sql Server 2005 queries.
+  #
+  # Links: readme.txt[link:files/readme_txt.html]; source[link:rcov/lib-ramen-sql2005_rb.html]
+  #
+  module MySql500
+    include Ramen::Engine
+    
+    class Sql
+      # returns the query for all schemas and their meta-data.
+      #
+      # the query must include the schema_name
+      def Sql.schemas
+<<SQL
+select
+  catalog_name,
+  schema_name,
+  default_character_set_name,
+  default_collation_name,
+  sql_path
+from information_schema.schemata
+SQL
+      end
+
+      # returns the query for all tables and their meta-data.
+      #
+      # the query must include the table_schema and table_name.
+      def Sql.tables
+<<SQL
+select
+  table_catalog,
+  table_schema,
+  table_name,
+  table_type,
+  engine,
+  version,
+  row_format,
+  table_rows,
+  avg_row_length,
+  data_length,
+  max_data_length,
+  index_length,
+  data_free,
+  auto_increment,
+  create_time,
+  update_time,
+  check_time,
+  table_collation,
+  checksum,
+  create_options,
+  table_comment
+from information_schema.tables
+SQL
+      end
+
+      # selects all tables, via a different query.  used for testing only.
+      # 
+      # returns table_schema and table_name for every table.
+      def Sql.list_tables
+<<SQL
+SELECT table_schema, table_name from information_schema.tables
+SQL
+      end
+
+      # returns the query for all columns and their meta-data.
+      #
+      # the query must include the table_schema, table_name and column_name.
+      def Sql.columns
+<<SQL
+select
+  table_catalog,
+  table_schema,
+  table_name,
+  column_name,
+  ordinal_position,
+  column_default,
+  is_nullable,
+  data_type,
+  character_maximum_length,
+  character_octet_length,
+  numeric_precision,
+  numeric_scale,
+  character_set_name,
+  collation_name,
+  column_type,
+  column_key,
+  extra,
+  privileges,
+  column_comment
+from information_schema.columns
+SQL
+      end
+
+      # returns the query for all primary keys and their meta-data.
+      #
+      # the query must include the table_schema, table_name and
+      # primary_key_name.
+      def Sql.primary_keys
+<<SQL
+select
+  constraint_schema as table_schema,
+  table_name,
+  constraint_name as primary_key_name
+from information_schema.table_constraints tc
+where tc.constraint_type = 'PRIMARY KEY'
+SQL
+      end
+
+      # returns the query for all primary key columns and their meta-data.
+      #
+      # the query must include the table_schema, table_name, 
+      # primary_key_name, and column_name.
+      def Sql.primary_key_columns
+<<SQL
+select
+  tc.constraint_schema as table_schema,
+  tc.table_name,
+  tc.constraint_name as primary_key_name,
+  kcu.column_name,
+  kcu.ordinal_position,
+  kcu.position_in_unique_constraint,
+  kcu.referenced_table_schema,
+  kcu.referenced_table_name,
+  kcu.referenced_column_name
+from information_schema.table_constraints tc
+inner join information_schema.key_column_usage kcu
+  on  tc.constraint_schema = kcu.constraint_schema
+  and tc.table_name        = kcu.table_name
+  and tc.constraint_name   = kcu.constraint_name
+where tc.constraint_type = 'PRIMARY KEY'
+SQL
+      end
+
+      # returns the query for all indexes and their meta-data.
+      #
+      # the query must include the table_schema, table_name, 
+      # and index_name.
+      def Sql.indexes
+<<SQL
+select
+  s.table_schema,
+  s.table_name,
+  s.index_name,
+  s.index_type,
+  s.non_unique
+from information_schema.statistics s
+where s.index_name not in ('PRIMARY')
+      -- foreign keys dont appear in statistics table
+      -- use a full outer join if foreign keys are needed.
+group by s.table_schema, s.table_name, s.index_name, s.index_type, s.non_unique
+SQL
+      end
+
+      # returns the query for all index columns and their meta-data.
+      #
+      # the query must include the table_schema, table_name, index_name,
+      # and column_name.
+      def Sql.index_columns
+<<SQL
+select
+  s.table_schema,
+  s.table_name,
+  s.index_name,
+  s.column_name,
+  s.seq_in_index,
+  s.collation,
+  s.cardinality,
+  s.sub_part,
+  s.packed,
+  s.nullable,
+  s.comment
+from information_schema.statistics s
+where s.index_name not in ('PRIMARY')
+      -- foreign keys dont appear in statistics table
+      -- use a full outer join if foreign keys are needed.
+SQL
+      end
+
+      # returns the query for all foreign keys and their meta-data.
+      #
+      # the query must include the table_schema, table_name, and foreign_key_name.
+      def Sql.foreign_keys
+<<SQL
+select
+  constraint_schema as table_schema,
+  table_name,
+  constraint_name as foreign_key_name
+from information_schema.table_constraints tc
+where tc.constraint_type = 'FOREIGN KEY'
+SQL
+      end
+
+      # returns the query for all foreign key columns and their meta-data.
+      #
+      # the query must include foreign_key_name, table_schema, table_name, 
+      # column_name, referenced_table_schema, referenced_table_name,
+      # referenced_column_name.
+      def Sql.foreign_key_columns
+<<SQL
+select
+  tc.constraint_schema as table_schema,
+  tc.table_name,
+  tc.constraint_name as foreign_key_name,
+  kcu.column_name,
+  kcu.ordinal_position,
+  kcu.position_in_unique_constraint,
+  kcu.referenced_table_schema,
+  kcu.referenced_table_name,
+  kcu.referenced_column_name
+from information_schema.table_constraints tc
+inner join information_schema.key_column_usage kcu
+  on  tc.constraint_schema = kcu.constraint_schema
+  and tc.table_name        = kcu.table_name
+  and tc.constraint_name   = kcu.constraint_name
+where tc.constraint_type = 'FOREIGN KEY'
+SQL
+      end
+    end
+  end
+end