dbsketch 0.0.1

data/lib/dbsketch/model/unique_constraint.rb

@@ -0,0 +1,33 @@
+########################################################################################################################
+# Unique constraint
+########################################################################################################################
+
+require_relative 'column'
+require_relative 'database_object'
+
+module Dbsketch
+	module Model
+
+		class UniqueConstraint < Database_Object
+			def initialize name, columns, meaning: nil, comment: nil
+				super name, :meaning => meaning, :comment => comment
+				@columns = columns.is_a?(Array) ? columns : [columns]
+				### Preconditions
+				@columns.each_with_index do |column, index|
+					raise ArgumentError, "columns[#{index}] is not a Dbsketch::Model::Column" unless column.is_a? Column
+				end
+				###
+			end
+
+			attr_reader :columns
+
+			def has_column? column_name
+				### Preconditions
+				raise ArgumentError, "column_name is not a String" unless column_name.is_a? String
+				###
+				nil != @columns.find { |c| c.name.downcase == column_name.downcase }
+			end
+		end
+
+	end
+end

data/lib/dbsketch/model/view.rb

@@ -0,0 +1,23 @@
+########################################################################################################################
+# Defines database view
+########################################################################################################################
+
+require_relative 'database_object'
+
+module Dbsketch
+	module Model
+
+		class View < Database_Object
+			def initialize name, query, meaning: nil, comment: nil, dependencies: []
+				super name, :meaning => meaning, :comment => comment, :dependencies => dependencies
+				### Preconditions
+				raise ArgumentError, "query is not a String" unless query.is_a? String
+				###
+				@query = query
+			end
+
+			attr_reader :query
+		end
+
+	end
+end

data/lib/dbsketch/rendering/meta/column_renderer.rb

@@ -0,0 +1,76 @@
+########################################################################################################################
+# Render a column into SQL
+########################################################################################################################
+
+require_relative '../../model/abstract_column'
+require_relative '../../model/column'
+require_relative '../../model/computed_column'
+
+require_relative 'type_renderer'
+
+module Dbsketch
+	module Rendering
+		module Meta
+
+			class ColumnRenderer
+				def initialize type_renderer: nil, keywords: {}
+					### Preconditions
+					raise ArgumentError, "keywords is not a Hash" unless keywords.is_a? Hash
+					###
+					@keywords = {
+						:column				=> "Dbsketch::Model::Column.new",
+						:computed_column	=> "Dbsketch::Model::ComputedColumn.new",
+						:type				=> "Dbsketch::Model::Type.new"
+					}.merge keywords
+					@type_renderer = (nil == type_renderer ? TypeRenderer.new(:type_keyword => @keywords[:type]) : type_renderer)
+				end
+
+				def create column
+					### Preconditions
+					raise ArgumentError, "column is not a Dbsketch::Model::AbstractColumn" unless column.is_a? Dbsketch::Model::AbstractColumn
+					###
+					if column.is_a? Dbsketch::Model::ComputedColumn
+						create_computed_column column
+					elsif column.is_a? Dbsketch::Model::Column
+						create_column column
+					else
+						raise ArgumentError, "#{column.class} is an unknown subclass of Dbsketch::Model::AbstractColumn"
+					end
+				end
+
+				private
+
+				def get_semantic column
+					str = ""
+					str << ", :meaning => '#{column.meaning}'" if column.meaning
+					str << ", :comment => '#{column.comment}'" if column.comment
+					str
+				end
+
+				def create_column column
+					str = "#{@keywords[:column]}('#{column.name}', #{@type_renderer.create column.type}"
+					str << ", :order => #{column.order}" if nil != column.order
+					str << ", :identity => true" if column.identity
+					str << ", :nullable => false" if not column.nullable
+					if nil != column.default
+						str << ", :default => #{column.default.is_a?(String) ? "'#{column.default}'" : column.default}"
+					end
+					str << get_semantic(column)
+					str << ")"
+					str
+				end
+
+				def create_computed_column column
+					str = "#{@keywords[:computed_column]}('#{column.name}', '#{column.query}'"
+					str << ", :nullable => false" if not column.nullable
+					str << ", :persisted => true" if column.persisted
+					str << get_semantic(column)
+					str << ")"
+					str
+				end
+
+			end
+
+		end
+	end
+end

data/lib/dbsketch/rendering/meta/database_renderer.rb

@@ -0,0 +1,112 @@
+########################################################################################################################
+# Render a database into ruby
+########################################################################################################################
+
+require_relative '../../comparison/database_comparator'
+require_relative '../../model/database'
+
+require_relative 'index_renderer'
+require_relative 'operation_renderer'
+require_relative 'table_renderer'
+require_relative 'trigger_renderer'
+require_relative 'view_renderer'
+
+module Dbsketch
+	module Rendering
+		module Meta
+
+			class DatabaseRenderer
+				def initialize index_renderer: nil, operation_renderer: nil, table_renderer: nil, trigger_renderer: nil, view_renderer: nil, options: {}, keywords: {}
+					### Preconditions
+					raise ArgumentError, "index_renderer is not a Dbsketch::Rendering::Meta::IndexRenderer" unless nil == index_renderer or index_renderer.is_a? IndexRenderer
+					raise ArgumentError, "operation_renderer is not a Dbsketch::Rendering::Meta::OperationRenderer" unless nil == operation_renderer or operation_renderer.is_a? OperationRenderer
+					raise ArgumentError, "table_renderer is not a Dbsketch::Rendering::Meta::TableRenderer" unless nil == table_renderer or table_renderer.is_a? TableRenderer
+					raise ArgumentError, "trigger_renderer is not a Dbsketch::Rendering::Meta::TriggerRenderer" unless nil == trigger_renderer or trigger_renderer.is_a? TriggerRenderer
+					raise ArgumentError, "view_renderer is not a Dbsketch::Rendering::Meta::ViewRenderer" unless nil == view_renderer or view_renderer.is_a? ViewRenderer
+					raise ArgumentError, "options is not a Hash" unless options.is_a? Hash
+					raise ArgumentError, "keywords is not a Hash" unless keywords.is_a? Hash
+					###
+					@options = {
+						:order_by_dependencies	=> true,
+						:pretty					=> false
+					}.merge options
+					@keywords = keywords
+					@index_renderer = (nil == index_renderer ? IndexRenderer.new : index_renderer)
+					@operation_renderer = (nil == operation_renderer ? OperationRenderer.new : operation_renderer)
+					@table_renderer = (nil == table_renderer ? TableRenderer.new(:options => @options, :keywords => @keywords) : table_renderer)
+					@trigger_renderer = (nil == trigger_renderer ? TriggerRenderer.new : trigger_renderer)
+					@view_renderer = (nil == view_renderer ? ViewRenderer.new : view_renderer)
+				end
+
+				def create database
+					### Preconditions
+					raise ArgumentError, "database is not a Dbsketch::Model::Database" unless database.is_a? Dbsketch::Model::Database
+					###
+					separator = @options[:pretty] ? "\n\n" : "\n"
+					database.order_items! if @options[:order_by_dependencies]
+					database.items.map { |i| create_item i }.flatten.compact.join(separator) + separator
+				end
+
+				def alter database_diff
+					### Preconditions
+					raise ArgumentError, "database_diff is not a Dbsketch::Comparison::DatabaseDiff" unless database_diff.is_a? Dbsketch::Comparison::DatabaseDiff
+					###
+					separator = "\n"
+
+					diffs = database_diff.indexes + database_diff.operations + database_diff.tables + database_diff.triggers + database_diff.views
+					deletions = diffs.select { |d| d.deletion? }.map { |i| drop_item i.old_value }
+					changes = diffs.select { |d| d.change? }.map { |i| alter_item(i) }
+					creations = diffs.select { |d| d.addition? }.map { |i| create_item i.new_value }
+
+					(deletions + changes + creations).flatten.compact.join(separator) + separator
+				end
+
+				private
+
+				def create_item item
+					if item.is_a? Dbsketch::Model::Index
+						@index_renderer.create item
+					elsif item.is_a? Dbsketch::Model::Operation
+						@operation_renderer.create item
+					elsif item.is_a? Dbsketch::Model::Table
+						@table_renderer.create item
+					elsif item.is_a? Dbsketch::Model::Trigger
+						@trigger_renderer.create item
+					elsif item.is_a? Dbsketch::Model::View
+						@view_renderer.create item
+					end
+				end
+
+				def drop_item item
+					if item.is_a? Dbsketch::Model::Index
+						@index_renderer.drop item
+					elsif item.is_a? Dbsketch::Model::Operation
+						@operation_renderer.drop item
+					elsif item.is_a? Dbsketch::Model::Table
+						@table_renderer.drop item
+					elsif item.is_a? Dbsketch::Model::Trigger
+						@trigger_renderer.drop item
+					elsif item.is_a? Dbsketch::Model::View
+						@view_renderer.drop item
+					end
+				end
+
+				def alter_item item_diff
+					if item_diff.old_value.is_a? Dbsketch::Model::Index
+						"Index.alter #{create_item(item_diff.new_value)}"
+					elsif item_diff.old_value.is_a? Dbsketch::Model::Operation
+						"Operation.alter #{create_item(item_diff.new_value)}"
+					elsif item_diff.old_value.is_a? Dbsketch::Model::Table
+						@table_renderer.alter item_diff
+					elsif item_diff.old_value.is_a? Dbsketch::Model::Trigger
+						"Trigger.alter #{create_item(item_diff.new_value)}"
+					elsif item_diff.old_value.is_a? Dbsketch::Model::View
+						"View.alter #{create_item(item_diff.new_value)}"
+					end
+				end
+
+			end
+
+		end
+	end
+end

data/lib/dbsketch/rendering/meta/foreign_key_renderer.rb

@@ -0,0 +1,31 @@
+########################################################################################################################
+# Render a column into ruby
+########################################################################################################################
+
+require_relative '../../model/foreign_key'
+
+module Dbsketch
+	module Rendering
+		module Meta
+
+			class ForeignKeyRenderer
+
+				def initialize foreign_key_keyword: "Dbsketch::Model::ForeignKey.new"
+					### Preconditions
+					raise ArgumentError, "foreign_key_keyword is not a String" unless foreign_key_keyword.is_a? String
+					###
+					@foreign_key_keyword = foreign_key_keyword
+				end
+
+				def create foreign_key
+					### Preconditions
+					raise ArgumentError, "foreign_key is not a Dbsketch::Model::ForeignKey" unless foreign_key.is_a? Dbsketch::Model::ForeignKey
+					###
+					"#{@foreign_key_keyword}(\"#{foreign_key.name}\", #{foreign_key.constricted_column.name}, #{foreign_key.referenced_table.name}, #{foreign_key.referenced_table.name}['#{foreign_key.referenced_column.name}'])"
+				end
+
+			end
+
+		end
+	end
+end

data/lib/dbsketch/rendering/meta/index_renderer.rb

@@ -0,0 +1,30 @@
+########################################################################################################################
+# Render an index into ruby
+########################################################################################################################
+
+require_relative '../../model/index'
+
+module Dbsketch
+	module Rendering
+		module Meta
+
+			class IndexRenderer
+
+				def create index
+					### Preconditions
+					raise ArgumentError, "index is not a Dbsketch::Model::Index" unless index.is_a? Dbsketch::Model::Index
+					###
+					columns = index.columns.map {|c| c.name }
+					columns = columns.count > 1 ? "[#{columns.join(", ")}]" : columns.first
+					"Dbsketch::Model::Index.new(\"#{index.name}\", #{index.target.name}, #{columns})"
+				end
+
+				def drop index
+					"Index.drop #{index.name} from #{index.target.name}"
+				end
+
+			end
+
+		end
+	end
+end

data/lib/dbsketch/rendering/meta/operation_renderer.rb

@@ -0,0 +1,66 @@
+########################################################################################################################
+# Render a column into ruby
+########################################################################################################################
+
+require_relative '../../model/function'
+require_relative '../../model/procedure'
+
+module Dbsketch
+	module Rendering
+		module Meta
+
+			class OperationRenderer
+
+				def create operation
+					### Preconditions
+					raise ArgumentError, "operation is not a Dbsketch::Model::Operation" unless operation.is_a? Dbsketch::Model::Operation
+					###
+					if operation.is_a? Dbsketch::Model::Function
+						create_function operation
+					elsif operation.is_a? Dbsketch::Model::Procedure
+						create_procedure operation
+					else
+						raise ArgumentError, "#{operation.class} is an unknown subclass of Dbsketch::Model::Operation"
+					end
+				end
+
+				def drop operation
+					### Preconditions
+					raise ArgumentError, "operation is not a Dbsketch::Model::Operation" unless operation.is_a? Dbsketch::Model::Operation
+					###
+					if operation.is_a? Dbsketch::Model::Function
+						keyword = "Function"
+					elsif operation.is_a? Dbsketch::Model::Procedure
+						keyword = "Procedure"
+					else
+						raise ArgumentError, "#{operation.class} is an unknown subclass of Dbsketch::Model::Operation"
+					end
+					"#{keyword}.drop #{operation.name}"
+				end
+
+				private
+
+				def create_function function
+					arguments = function.arguments.map {|a| "\"#{a}\"" }
+					arguments = function.arguments.count > 1 ? "[#{arguments.join(", ")}]" : arguments.first
+					sql = "Dbsketch::Model::Function.new(\"#{function.name}\""
+					sql << ", :arguments => #{arguments}" if nil != arguments
+					sql << ", :returns => \"#{function.returns}\""
+					sql << ", :algo => \"#{function.algo}\")"
+					sql
+				end
+
+				def create_procedure procedure
+					arguments = procedure.arguments.map {|a| "\"#{a}\"" }
+					arguments = procedure.arguments.count > 1 ? "[#{arguments.join(", ")}]" : arguments.first
+					sql = "Dbsketch::Model::Procedure.new(\"#{procedure.name}\""
+					sql << ", :arguments => #{arguments}" if nil != arguments
+					sql << ", :algo => \"#{procedure.algo}\")"
+					sql
+				end
+
+			end
+
+		end
+	end
+end

data/lib/dbsketch/rendering/meta/table_renderer.rb

@@ -0,0 +1,177 @@
+########################################################################################################################
+# Render a table into Ruby
+########################################################################################################################
+
+require_relative '../../comparison/table_comparator'
+require_relative '../../model/table'
+
+require_relative 'column_renderer'
+require_relative 'foreign_key_renderer'
+
+module Dbsketch
+	module Rendering
+		module Meta
+
+			class TableRenderer
+				def initialize column_renderer: nil, fk_renderer: nil, options: {}, keywords: {}
+					### Preconditions
+					raise ArgumentError, "options is not a Hash" unless options.is_a? Hash
+					raise ArgumentError, "keywords is not a Hash" unless keywords.is_a? Hash
+					###
+					@options = {
+						:pretty	=> false,
+					}.merge options
+					@keywords = {
+						:check_constraint	=> "Dbsketch::Model::CheckConstraint.new",
+						:primary_key		=> "Dbsketch::Model::PrimaryKey.new",
+						:foreign_key		=> "Dbsketch::Model::ForeignKey.new",
+						:table				=> "Dbsketch::Model::Table.new",
+						:unique_constraint	=> "Dbsketch::Model::UniqueConstraint.new"
+					}.merge keywords
+					@column_renderer = (nil == column_renderer ? ColumnRenderer.new(:keywords => @keywords) : column_renderer)
+					@fk_renderer = (nil == fk_renderer ? ForeignKeyRenderer.new(:foreign_key_keyword => @keywords[:foreign_key] ) : fk_renderer)
+				end
+
+				def create table
+					### Preconditions
+					raise ArgumentError, "table is not a Dbsketch::Model::Table" unless table.is_a? Dbsketch::Model::Table
+					###
+					columns = collect_columns table
+					str = "#{@keywords[:table]}(\"#{table.name}\""
+					str << ", :meaning => \"#{table.meaning}\"" if nil != table.meaning
+					str << ", :comment => \"#{table.comment}\"" if nil != table.comment
+					str << ", #{columns}" if not columns.empty?
+					str << ")"
+					constraints = collect_constraints table
+					str << "\n#{constraints.join("\n")}" if not constraints.empty?
+					str
+				end
+
+				def drop table
+					### Preconditions
+					raise ArgumentError, "table is not a Dbsketch::Model::Table" unless table.is_a? Dbsketch::Model::Table
+					###
+					"Table.drop #{table.name}"
+				end
+
+				def alter table_diff
+					### Preconditions
+					raise ArgumentError, "table_diff is not a Dbsketch::Comparison::TableDiff" unless table_diff.is_a? Dbsketch::Comparison::TableDiff
+					###
+					queries = []
+
+					# Columns
+					deleted_columns = table_diff.columns.select { |d| d.deletion? }
+					if not deleted_columns.empty?
+						queries << "Table.alter #{table_diff.new_table.name} drop column\n\t#{deleted_columns.map { |d| d.old_column.name }.join("\n\t")}"
+					end
+					added_columns = table_diff.columns.select { |d| d.addition? }
+					if not added_columns.empty?
+						queries << "Table.alter #{table_diff.new_table.name} add column\n\t#{added_columns.map { |d| @column_renderer.create d.new_column }.join("\n\t")}"
+					end
+					changed_columns = table_diff.columns.select { |d| d.change? }
+					if not changed_columns.empty?
+						queries << "Table.alter #{table_diff.new_table.name} alter column\n\t#{changed_columns.map { |d| @column_renderer.create d.new_column }.join("\n\t")}"
+					end
+
+					# Primary key
+					if nil != table_diff.primary_key
+						queries << "Table.alter #{table_diff.new_table.name} drop primary key #{table_diff.primary_key.old_key.name}" if table_diff.primary_key.deletion?
+						queries << "Table.alter #{table_diff.new_table.name} alter #{create_primary_key table_diff.new_table, table_diff.primary_key.new_key}" if table_diff.primary_key.change?
+						queries << "Table.alter #{table_diff.new_table.name} add #{create_primary_key table_diff.new_table, table_diff.primary_key.new_key}" if table_diff.primary_key.addition?
+					end
+
+					# Check constraints
+					deleted = table_diff.check_constraints.select { |d| d.deletion? }
+					if not deleted.empty?
+						queries << "Table.alter #{table_diff.new_table.name} drop check constraint\n\t#{deleted.map { |d| d.old_constraint.name }.join("\n\t")}"
+					end
+					added = table_diff.check_constraints.select { |d| d.addition? }
+					if not added.empty?
+						queries << "Table.alter #{table_diff.new_table.name} add\n\t#{added.map { |d| create_check_constraint d.new_constraint }.join("\n\t")}"
+					end
+					changed = table_diff.check_constraints.select { |d| d.change? }
+					if not changed.empty?
+						queries << "Table.alter #{table_diff.new_table.name} alter\n\t#{changed.map { |d| create_check_constraint d.new_constraint }.join("\n\t")}"
+					end
+					queries.flatten.join("\n")
+
+					# Foreign keys
+					deleted = table_diff.foreign_keys.select { |d| d.deletion? }
+					if not deleted.empty?
+						queries << "Table.alter #{table_diff.new_table.name} drop foreign key\n\t#{deleted.map { |d| d.old_key.name }.join("\n\t")}"
+					end
+					added = table_diff.foreign_keys.select { |d| d.addition? }
+					if not added.empty?
+						queries << "Table.alter #{table_diff.new_table.name} add\n\t#{added.map { |d| @fk_renderer.create d.new_key }.join("\n\t")}"
+					end
+					changed = table_diff.foreign_keys.select { |d| d.change? }
+					if not changed.empty?
+						queries << "Table.alter #{table_diff.new_table.name} alter\n\t#{changed.map { |d| @fk_renderer.create d.new_key }.join("\n\t")}"
+					end
+					queries.flatten.join("\n")
+
+					# Unique constraints
+					deleted = table_diff.unique_constraints.select { |d| d.deletion? }
+					if not deleted.empty?
+						queries << "Table.alter #{table_diff.new_table.name} drop unique constraint\n\t#{deleted.map { |d| d.old_constraint.name }.join("\n\t")}"
+					end
+					added = table_diff.unique_constraints.select { |d| d.addition? }
+					if not added.empty?
+						queries << "Table.alter #{table_diff.new_table.name} add\n\t#{added.map { |d| create_unique_constraint d.new_constraint, table_diff.new_table }.join("\n\t")}"
+					end
+					changed = table_diff.unique_constraints.select { |d| d.change? }
+					if not changed.empty?
+						queries << "Table.alter #{table_diff.new_table.name} alter\n\t#{changed.map { |d| create_unique_constraint d.new_constraint, table_diff.new_table }.join("\n\t")}"
+					end
+					queries.flatten.join("\n")
+				end
+
+				private
+
+				def create_primary_key table, primary_key = nil
+					primary_key = table.primary_key if nil == primary_key
+					columns = primary_key.columns.map {|c| "#{table.name.downcase}['#{c.name}']" }
+					columns = columns.count > 1 ? "[#{columns.join(", ")}]" : columns.first
+					"#{@keywords[:primary_key]}(\"#{primary_key.name}\", #{columns})"
+				end
+
+				def create_check_constraint constraint
+					"#{@keywords[:check_constraint]}(\"#{constraint.name}\", \"#{constraint.condition}\")"
+				end
+
+				def create_unique_constraint constraint, table
+					columns = constraint.columns.map {|c| "#{table.name.downcase}['#{c.name}']" }
+					columns = columns.count > 1 ? "[#{columns.join(", ")}]" : columns.first
+					"#{@keywords[:unique_constraint]}(\"#{constraint.name}\", #{columns})"
+				end
+
+				def collect_columns table
+					columns = table.columns.sort { |a,b| a.order <=> b.order }.map { |c| @column_renderer.create c }
+					if columns.count > 1
+						if @options[:pretty]
+							":columns => [\n\t#{columns.join(",\n\t")}\n]"
+						else
+							":columns => [#{columns.join(", ")}]"
+						end
+					elsif columns.count > 0
+						":columns => #{columns.first}"
+					else
+						""
+					end
+				end
+
+				def collect_constraints table
+					items = []
+					if nil != table.primary_key then items << "#{table.name.downcase}.add(#{create_primary_key(table)})" end
+					items << table.check_constraints.map { |c| "#{table.name.downcase}.add(#{create_check_constraint c})" }
+					items << table.unique_constraints.map { |c| "#{table.name.downcase}.add(#{create_unique_constraint c, table})" }
+					items << table.foreign_keys.map { |k| "#{table.name.downcase}.add(#{@fk_renderer.create k})" }
+					items.flatten.compact
+				end
+
+			end
+
+		end
+	end
+end