dbsketch 0.0.1

data/lib/dbsketch/comparison/unique_constraint_comparator.rb

@@ -0,0 +1,58 @@
+########################################################################################################################
+# Database differences between two existing unique constraint
+########################################################################################################################
+
+require_relative '../model/unique_constraint'
+require_relative 'diff'
+
+module Dbsketch
+	module Comparison
+
+		class UniqueConstraintDiff < Diff
+			def initialize old_constraint, new_constraint, columns
+				super old_constraint, new_constraint
+				### Preconditions
+				columns.each_with_index { |column, index| raise ArgumentError, "columns[#{index}] is not a Dbsketch::Comparison::Diff" unless column.is_a? Dbsketch::Comparison::Diff }
+				###
+				@columns = columns
+			end
+
+			attr_reader :columns
+			alias :old_constraint :old_value
+			alias :new_constraint :new_value
+		end
+
+		class UniqueConstraintComparator
+
+			def are_equivalent? old_constraint, new_constraint
+				### Preconditions
+				raise ArgumentError, "old_constraint is not a Dbsketch::Model::UniqueConstraint" unless nil == old_constraint or old_constraint.is_a? Dbsketch::Model::UniqueConstraint
+				raise ArgumentError, "new_constraint is not a Dbsketch::Model::UniqueConstraint" unless nil == new_constraint or new_constraint.is_a? Dbsketch::Model::UniqueConstraint
+				###
+				(nil != old_constraint and nil != new_constraint) and columns(old_constraint, new_constraint).empty?
+			end
+
+			# Returns a UniqueConstraintDiff if tables are different, nil otherwise
+			def compare old_constraint, new_constraint
+				### Preconditions
+				raise ArgumentError, "old_constraint is not a Dbsketch::Model::UniqueConstraint" unless nil == old_constraint or old_constraint.is_a? Dbsketch::Model::UniqueConstraint
+				raise ArgumentError, "new_constraint is not a Dbsketch::Model::UniqueConstraint" unless nil == new_constraint or new_constraint.is_a? Dbsketch::Model::UniqueConstraint
+				###
+				UniqueConstraintDiff.new(old_constraint, new_constraint, columns(old_constraint, new_constraint)) if not are_equivalent? old_constraint, new_constraint
+			end
+
+			private
+
+			def columns old_constraint, new_constraint
+				diffs = []
+				if nil != old_constraint and nil != new_constraint
+					diffs << old_constraint.columns.select { |old_c| not new_constraint.has_column? old_c.name }.map { |old_c| Diff.new old_c.name, nil }
+					diffs << new_constraint.columns.select { |new_c| not old_constraint.has_column? new_c.name }.map { |new_c| Diff.new nil, new_c.name }
+				end
+				diffs.flatten.compact
+			end
+
+		end
+
+	end
+end

data/lib/dbsketch/comparison/view_comparator.rb

@@ -0,0 +1,54 @@
+########################################################################################################################
+# Compute differences between two existing check constraint
+########################################################################################################################
+
+require_relative '../model/view'
+require_relative 'comparison_error'
+require_relative 'diff'
+
+module Dbsketch
+	module Comparison
+
+		class ViewDiff < Diff
+			def initialize old_view, new_view
+				super old_view, new_view
+			end
+			alias :old_view :old_value
+			alias :new_view :new_value
+
+			def query
+				### Preconditions
+				raise ComparisonError, "no change found" if not change?
+				###
+				Diff.new old_view.query, new_view.query
+			end
+		end
+
+	end
+end
+
+module Dbsketch
+	module Comparison
+
+		class ViewComparator
+
+			def are_equivalent? old_view, new_view
+				### Preconditions
+				raise ArgumentError, "old_view is not a Dbsketch::Model::View" unless nil == old_view or old_view.is_a? Dbsketch::Model::View
+				raise ArgumentError, "new_view is not a Dbsketch::Model::View" unless nil == new_view or new_view.is_a? Dbsketch::Model::View
+				###
+				(nil != old_view and nil != new_view) and (old_view.query == new_view.query)
+			end
+
+			def compare old_view, new_view
+				### Preconditions
+				raise ArgumentError, "old_view is not a Dbsketch::Model::View" unless nil == old_view or old_view.is_a? Dbsketch::Model::View
+				raise ArgumentError, "new_view is not a Dbsketch::Model::View" unless nil == new_view or new_view.is_a? Dbsketch::Model::View
+				###
+				ViewDiff.new(old_view, new_view) if not are_equivalent? old_view, new_view
+			end
+
+		end
+
+	end
+end

data/lib/dbsketch/model/abstract_column.rb

@@ -0,0 +1,25 @@
+########################################################################################################################
+# Common structure for database columns
+########################################################################################################################
+
+require_relative 'database_object'
+
+module Dbsketch
+	module Model
+
+		class AbstractColumn < Database_Object
+			def initialize name, meaning: nil, comment: nil, nullable: true, order: nil
+				super name, :meaning => meaning, :comment => comment
+				### Preconditions
+				raise ArgumentError, "nullable is not a boolean" unless nullable.is_a? TrueClass or nullable.is_a? FalseClass
+				raise ArgumentError, "order is not an Integer" unless nil == order or order.is_a? Integer
+				###
+				@nullable = nullable
+				@order = order
+			end
+
+			attr_reader :nullable, :order
+		end
+
+	end
+end

data/lib/dbsketch/model/check_constraint.rb

@@ -0,0 +1,23 @@
+########################################################################################################################
+# Check constraint
+########################################################################################################################
+
+require_relative 'database_object'
+
+module Dbsketch
+	module Model
+
+		class CheckConstraint < Database_Object
+			def initialize name, condition, meaning: nil, comment: nil
+				super name, :meaning => meaning, :comment => comment
+				### Preconditions
+				raise ArgumentError, "condition is not a String" unless condition.is_a? String
+				###
+				@condition = condition
+			end
+
+			attr_reader :condition
+		end
+
+	end
+end

data/lib/dbsketch/model/column.rb

@@ -0,0 +1,35 @@
+########################################################################################################################
+# Defines database column
+########################################################################################################################
+
+require_relative 'abstract_column'
+require_relative 'type'
+
+module Dbsketch
+	module Model
+
+		class Column < AbstractColumn
+			def initialize name, type, meaning: nil, comment: nil, nullable: true, order: nil, identity: false, default: nil
+				super(name, :meaning => meaning, :comment => comment, :nullable => nullable, :order => order)
+				### Preconditions
+				raise ArgumentError, "type is not a Dbsketch::Model::Type" unless type.is_a? Dbsketch::Model::Type
+				raise ArgumentError, "identity is not a boolean" unless identity.is_a? TrueClass or identity.is_a? FalseClass
+				###
+				@type = type
+				@identity = identity
+				@default = default
+			end
+
+			attr_reader :type, :identity, :default
+			attr_writer :default
+
+			def compatible_with? other_column
+				### Preconditions
+				raise ArgumentError, "other_column is not a Dbsketch::Model::Column" unless other_column.is_a? Column
+				###
+				(@type.compatible_with? other_column.type) and (not @nullable or other_column.nullable)
+			end
+		end
+
+	end
+end

data/lib/dbsketch/model/computed_column.rb

@@ -0,0 +1,27 @@
+########################################################################################################################
+# Defines database computed column
+########################################################################################################################
+
+require_relative 'abstract_column'
+require_relative 'model_error'
+
+module Dbsketch
+	module Model
+
+		class ComputedColumn < AbstractColumn
+			def initialize name, query, meaning: nil, comment: nil, nullable: true, order: nil, persisted: false
+				super(name, :meaning => meaning, :comment => comment, :nullable => nullable, :order => order)
+				### Preconditions
+				raise ArgumentError, "query is not a String" unless query.is_a? String
+				raise ArgumentError, "persisted is not a boolean" unless persisted.is_a? TrueClass or persisted.is_a? FalseClass
+				raise ModelError, "column is not persisted althought not nullable" if not nullable and not persisted
+				###
+				@query = query
+				@persisted = persisted
+			end
+
+			attr_reader :query, :persisted
+		end
+
+	end
+end

data/lib/dbsketch/model/custom_code.rb

@@ -0,0 +1,21 @@
+########################################################################################################################
+# Defines database custom code, so developers can write specific code
+########################################################################################################################
+
+require_relative 'database_object'
+
+module Dbsketch
+	module Model
+
+		class CustomCode < Database_Object
+			def initialize name, do_code, undo_code: nil, meaning: nil, comment: nil, dependencies: []
+				super name, :meaning => meaning, :comment => comment, :dependencies => dependencies
+				@do_code = do_code
+				@undo_code = undo_code
+			end
+
+			attr_reader :do_code, :undo_code
+		end
+
+	end
+end

data/lib/dbsketch/model/database.rb

@@ -0,0 +1,87 @@
+########################################################################################################################
+# Database representation
+########################################################################################################################
+
+require_relative 'custom_code'
+require_relative 'index'
+require_relative 'model_error'
+require_relative 'operation'
+require_relative 'table'
+require_relative 'trigger'
+require_relative 'view'
+
+module Dbsketch
+	module Model
+
+		class Database
+			def initialize
+				@items = []
+			end
+
+			attr_reader :items
+
+			def add object
+				objects = object.is_a?(Array) ? object : [object]
+				### Preconditions
+				objects.each_with_index do |o, index|
+					raise ArgumentError, "object n°#{index + 1} is not a Dbsketch::Model::CustomCode, Index, Operation, Table nor View" unless o.is_a? CustomCode or o.is_a? Index or o.is_a? Operation or o.is_a? Table or o.is_a? Trigger or o.is_a? View
+					raise ModelError, "object #{o.name} already exists" if nil != (@items.find { |i| i.name.downcase == o.name.downcase })
+				end
+				###
+				@items = @items + objects
+			end
+
+			def get_by_class given_class
+				@items.select { |i| i.is_a? given_class }
+			end
+
+			def custom_code
+				get_by_class CustomCode
+			end
+
+			def indexes
+				get_by_class Index
+			end
+
+			def operations
+				get_by_class Operation
+			end
+
+			def tables
+				get_by_class Table
+			end
+
+			def triggers
+				get_by_class Trigger
+			end
+
+			def views
+				get_by_class View
+			end
+
+			def has_item? item_name
+				### Preconditions
+				raise ArgumentError, "item_name is not a String" unless item_name.is_a? String
+				###
+				nil != @items.find { |t| t.name.downcase == item_name.downcase }
+			end
+
+			def [] item_name
+				### Preconditions
+				raise ArgumentError, "item_name is not a String" unless item_name.is_a? String
+				###
+				item = @items.find { |t| t.name.downcase == item_name.downcase }
+				raise ModelError, "item #{item_name} not found in database" if nil == item
+				item
+			end
+
+			def order_items!
+				@items.map! { |i| i.reset_order!; i }
+				@items.map! { |i| i.compute_order!; i }
+				@items.sort! { |a,b| (a.order != b.order) ? (a.order <=> b.order) : (a.name <=> b.name) }
+			end
+
+		end
+
+	end
+end

data/lib/dbsketch/model/database_object.rb

@@ -0,0 +1,71 @@
+########################################################################################################################
+# Defines database common object
+########################################################################################################################
+
+require_relative 'model_error'
+
+module Dbsketch
+	module Model
+
+		class Database_Object
+			def initialize name, meaning: nil, comment: nil, dependencies: []
+				dependencies = dependencies.is_a?(Array) ? dependencies : [dependencies]
+				### Preconditions
+				raise ArgumentError, "name is not a String" unless name.is_a? String
+				raise ModelError, "name (#{name}) shall not contain special chars (apart from underscore)" if name.match(/\W/)
+				raise ArgumentError, "meaning is not a String" unless nil == meaning or meaning.is_a? String
+				raise ArgumentError, "comment is not a String" unless nil == comment or comment.is_a? String
+				dependencies.each_with_index do |d, index|
+					raise ArgumentError, "dependencies[#{index}] is not a Dbsketch::Model::Database_Object" unless d.is_a? Database_Object
+				end
+				###
+				@name = name
+				@meaning = meaning
+				@comment = comment
+				@dependencies = dependencies
+				@order = nil
+			end
+
+			attr_reader :name, :meaning, :comment, :dependencies, :order
+
+			def add_dependencies dependencies
+				dependencies = dependencies.is_a?(Array) ? dependencies : [dependencies]
+				### Preconditions
+				dependencies.each_with_index do |d, index|
+					raise ArgumentError, "dependencies[#{index}] is not a Dbsketch::Model::Database_Object" unless d.is_a? Database_Object
+				end
+				###
+				@dependencies = (@dependencies.concat(dependencies)).uniq
+			end
+
+			def class_name
+				self.class.name.gsub(/^Dbsketch::Model::/, '')
+			end
+
+			def inspect
+				"#{self.class_name}:#{object_id} #{@name}"
+			end
+
+			def reset_order!
+				@order = nil
+			end
+
+			def compute_order! trace = []
+				if nil == @order
+					current_trace = trace.clone
+					current_trace << self
+					if nil != trace.find { |t| t.object_id == self.object_id }
+						raise ModelError, "circular dependencies found. Trace: #{current_trace.map { |t| "#{t.class_name} #{t.name}" }.join(" < ")}"
+					end
+					if @dependencies.empty?
+						@order = 1
+					else
+						@order = @dependencies.map {|d| d.compute_order! current_trace }.max + 1
+					end
+				end
+				@order
+			end
+		end
+
+	end
+end

data/lib/dbsketch/model/foreign_key.rb

@@ -0,0 +1,29 @@
+########################################################################################################################
+# Primary Key
+########################################################################################################################
+
+require_relative 'column'
+require_relative 'database_object'
+require_relative 'table'
+
+module Dbsketch
+	module Model
+
+		class ForeignKey < Database_Object
+			def initialize name, constricted_column, referenced_table, referenced_column, meaning: nil, comment: nil
+				super name, :meaning => meaning, :comment => comment
+				### Preconditions
+				raise ArgumentError, "constricted column is not a Dbsketch::Model::Column" unless constricted_column.is_a? Column
+				raise ArgumentError, "name is not a Dbsketch::Model::Table" unless referenced_table.is_a? Table
+				raise ArgumentError, "referenced column is not a Dbsketch::Model::Column" unless referenced_column.is_a? Column
+				###
+				@constricted_column = constricted_column
+				@referenced_table = referenced_table
+				@referenced_column = referenced_column
+			end
+
+			attr_reader :constricted_column, :referenced_table, :referenced_column
+		end
+
+	end
+end