activefacts-compositions 1.9.5 → 1.9.6

data/lib/activefacts/generator/sql/server.rb

@@ -0,0 +1,62 @@
+#
+#       ActiveFacts Standard SQL Schema Generator
+#
+# Copyright (c) 2009-2016 Clifford Heath. Read the LICENSE file.
+#
+require 'digest/sha1'
+require 'activefacts/metamodel'
+require 'activefacts/registry'
+require 'activefacts/compositions'
+require 'activefacts/generator/sql'
+
+module ActiveFacts
+  module Generators
+    # Options are comma or space separated:
+    # * underscore 
+    class SQL
+      class Server < SQL
+	def boolean_type
+	  'BOOLEAN'
+	end
+
+	def surrogate_type
+	  'BIGINT IDENTITY NOT NULL'
+	end
+
+	def reserved_words
+	  @reserved_words ||= %w{
+	    ADD ALL ALTER AND ANY AS ASC AUTHORIZATION BACKUP BEGIN
+	    BETWEEN BREAK BROWSE BULK BY CASCADE CASE CHECK CHECKPOINT
+	    CLOSE CLUSTERED COALESCE COLLATE COLUMN COMMIT COMPUTE
+	    CONSTRAINT CONTAINS CONTAINSTABLE CONTINUE CONVERT CREATE
+	    CROSS CURRENT CURRENT_DATE CURRENT_TIME CURRENT_TIMESTAMP
+	    CURRENT_USER CURSOR DATABASE DBCC DEALLOCATE DECLARE
+	    DEFAULT DELETE DENY DESC DISK DISTINCT DISTRIBUTED DOUBLE
+	    DROP DUMMY DUMP ELSE END ERRLVL ESCAPE EXCEPT EXEC EXECUTE
+	    EXISTS EXIT FETCH FILE FILLFACTOR FOR FOREIGN FREETEXT
+	    FREETEXTTABLE FROM FULL FUNCTION GOTO GRANT GROUP HAVING
+	    HOLDLOCK IDENTITY IDENTITYCOL IDENTITY_INSERT IF IN INDEX
+	    INNER INSERT INTERSECT INTO IS JOIN KEY KILL LEFT LIKE
+	    LINENO LOAD NATIONAL NOCHECK NONCLUSTERED NOT NULL NULLIF
+	    OF OFF OFFSETS ON OPEN OPENDATASOURCE OPENQUERY OPENROWSET
+	    OPENXML OPTION OR ORDER OUTER OVER PERCENT PLAN PRECISION
+	    PRIMARY PRINT PROC PROCEDURE PUBLIC RAISERROR READ READTEXT
+	    RECONFIGURE REFERENCES REPLICATION RESTORE RESTRICT RETURN
+	    REVOKE RIGHT ROLLBACK ROWCOUNT ROWGUIDCOL RULE SAVE SCHEMA
+	    SELECT SESSION_USER SET SETUSER SHUTDOWN SOME STATISTICS
+	    SYSTEM_USER TABLE TEXTSIZE THEN TO TOP TRAN TRANSACTION
+	    TRIGGER TRUNCATE TSEQUAL UNION UNIQUE UPDATE UPDATETEXT
+	    USE USER VALUES VARYING VIEW WAITFOR WHEN WHERE WHILE
+	    WITH WRITETEXT
+	  }
+	end
+
+	def go s = ''
+	  "#{s}\nGO\n"  # REVISIT: This is an SQL-Serverism. Move it to a subclass.
+	end
+      end
+
+    end
+    publish_generator SQL::Server
+  end
+end

data/lib/activefacts/generator/summary.rb

@@ -0,0 +1,98 @@
+#
+# ActiveFacts Compositions, Metamodel aspect to create a textual summary of a composition and its Composites
+# 
+# Copyright (c) 2015 Clifford Heath. Read the LICENSE file.
+#
+require "activefacts/metamodel"
+require "activefacts/compositions/names"
+require "activefacts/compositions/constraints"
+require "activefacts/generator"
+
+module ActiveFacts
+  module Metamodel
+    class Composition
+      def summary
+	classify_constraints
+	"Summary of #{name}\n" +
+	all_composite.
+	sort_by{|composite| composite.mapping.name}.
+	flat_map do |composite|
+	  composite.summary
+	end*''
+      end
+    end
+
+    class Composite
+      def summary
+	indices = self.all_indices_by_rank
+
+	(
+	  [mapping.name+"\n"] +
+	  mapping.
+	  leaves.
+	  reject{|leaf| leaf.is_a?(Absorption) && leaf.forward_absorption}.
+	  flat_map do |leaf|
+
+	    # Build a display of the names in this absorption path, with FK and optional indicators
+	    path_names = leaf.path.map do |component|
+		is_mandatory = case component
+		  when Indicator
+		    false
+		  when Absorption
+		    component.parent_role.is_mandatory
+		  else
+		    true
+		  end
+
+		if component.is_a?(Absorption) && component.foreign_key
+		  "[#{component.name}]"
+		else
+		  component.name
+		end +
+		  (is_mandatory ? '' : '?')
+	      end*'->' 
+
+	    # Build a symbolic representation of the index participation of this leaf
+	    pos = 0
+	    indexing = indices.inject([]) do |a, index|
+	      pos += 1
+	      if part = index.position_in_index(leaf)
+		a << "#{pos}.#{part}"
+	      end
+	      a
+	    end
+	    if indexing.empty? 
+	      indexing = '' 
+	    else
+	      indexing = "[#{indexing*','}]"
+	    end
+
+	    column_name = leaf.column_name.capwords*' '
+	    ["\t#{path_names}#{indexing} as #{column_name.inspect}\n"] +
+	    leaf.all_leaf_constraint.map{|leaf_constraint| "\t\t### #{leaf_constraint.leaf_constraint.describe}\n"}
+	  end +
+	  all_local_constraint.map do |local_constraint|
+	    "\t### #{local_constraint.local_constraint.describe}\n"
+	  end.sort +
+	  all_spanning_constraint.map do |spanning_constraint|
+	    "### #{spanning_constraint.spanning_constraint.describe}\n"
+	  end.sort
+
+	)*''
+      end
+    end
+  end
+
+  module Generators
+    class Summary
+      def initialize composition
+	@composition = composition
+      end
+
+      def generate
+	@composition.summary
+      end
+    end
+    publish_generator Summary
+  end
+end

data/lib/activefacts/{compositions/validator.rb → generator/validate.rb}

@@ -1,138 +1,158 @@
 #
-# ActiveFacts Compositions validator.
+# ActiveFacts Compositions, Metamodel aspect to look for validation errors in a composition
 #
 # Quite a few constraints are not enforced during the construction of a composition.
 # This method does a post-validation to ensure that everything looks ok.
 # 
 # Copyright (c) 2015 Clifford Heath. Read the LICENSE file.
 #
+require "activefacts/metamodel"
 require "activefacts/compositions/compositor"
+require "activefacts/generator"
 
 module ActiveFacts
-  module Compositions
-    class Compositor
+  module Generators
+    class Validate
+      def initialize composition, options = {}
+	@composition = composition
+	@options = options
+      end
+
+      def generate &b
+	@composition.validate &b
+	nil
+      end
+    end
+    publish_generator Validate
+  end
+
+  module Metamodel
+    class Composition
       def validate &report
+        trace.enable 'composition_validator'
 	report ||= proc do |component, problem|
-	  raise "Problem with #{component.inspect}: #{problem}"
+	  trace :composition_validator, "!!PROBLEM!! #{component.inspect}: #{problem}"
 	end
 
-	@composition.all_composite.each do |composite|
-	  validate_composite composite, &report
+	all_composite.each do |composite|
+	  composite.validate &report
 	end
       end
+    end
 
-    private
-      MM = ActiveFacts::Metamodel
-
-      def validate_composite composite, &report
-	trace :composition_validator?, "Validating #{composite.inspect}" do
-	  report.call(composite, "Has no Mapping") unless composite.mapping
-	  report.call(composite, "Mapping is not a mapping") unless composite.mapping.class == MM::Mapping
-	  report.call(composite.mapping, "Has no ObjectType") unless composite.mapping.object_type
-	  report.call(composite.mapping, "Has no Name") unless composite.mapping.name
-	  report.call(composite.mapping, "Should not have an Ordinal rank") if composite.mapping.ordinal
-	  report.call(composite.mapping, "Should not have a parent mapping") if composite.mapping.parent
-	  report.call(composite.mapping, "Should be the root of its mapping") if composite.mapping.root != composite
-
-	  validate_members composite.mapping, &report
-	  validate_access_paths composite, &report
+    class Composite
+      def validate &report
+	trace :composition_validator?, "Validating #{inspect}" do
+	  report.call(self, "Has no Mapping") unless mapping
+	  report.call(self, "Mapping is not a mapping") unless mapping.class == Mapping
+	  report.call(mapping, "Has no ObjectType") unless mapping.object_type
+	  report.call(mapping, "Has no Name") unless mapping.name
+	  report.call(mapping, "Should not have an Ordinal rank") if mapping.ordinal
+	  report.call(mapping, "Should not have a parent mapping") if mapping.parent
+	  report.call(mapping, "Should be the root of its mapping") if mapping.root != self
+
+	  mapping.validate_members &report
+	  validate_access_paths &report
+	end
+      end
+
+      def validate_access_paths &report
+	all_access_path.each do |access_path|
+	  report.call(access_path, "Must contain at least one IndexField") unless access_path.all_index_field.size > 0
+	  access_path.all_index_field.each do |index_field|
+	    report.call(access_path, "#{index_field.inspect} must be an Indicator or played by a ValueType") unless index_field.component.is_a?(Indicator) || index_field.component.object_type.is_a?(ValueType)
+	    report.call(access_path, "#{index_field.inspect} must be within its composite") unless index_field.component.root == self
+	  end
+	  if ForeignKey === access_path
+	    if access_path.all_index_field.size == access_path.all_foreign_key_field.size
+	      access_path.all_index_field.to_a.zip(access_path.all_foreign_key_field.to_a).each do |index_field, foreign_key_field|
+		report.call(access_path, "#{index_field.inspect} must have matching target type") unless index_field.component.class == foreign_key_field.component.class
+		unless index_field.component.class == foreign_key_field.component.class
+		  report.call(access_path, "#{index_field.inspect} must have component type matching #{foreign_key_field.inspect}")
+		else
+		  report.call(access_path, "#{index_field.inspect} must have matching target type") unless !index_field.component.is_a?(Absorption) or index_field.component.object_type == foreign_key_field.component.object_type
+		end
+		report.call(access_path, "#{foreign_key_field.inspect} must be within the target composite") unless foreign_key_field.component.root == access_path.source_composite
+	      end
+	    else
+	      report.call(access_path, "has #{access_path.all_index_field.size} index fields but #{access_path.all_foreign_key_field.size} ForeignKeyField")
+	    end
+	  end
 	end
       end
+    end
 
-      def validate_members mapping, &report
+    class Mapping
+      def validate_members &report
 	# Names (except of subtype/supertype absorption) must be unique:
-	names = mapping.
-	  all_member.
-	  reject{|m| m.is_a?(MM::Absorption) && m.parent_role.fact_type.is_a?(MM::TypeInheritance)}.
+	names = all_member.
+	  reject{|m| m.is_a?(Absorption) && m.parent_role.fact_type.is_a?(TypeInheritance)}.
 	  map(&:name).
 	  compact
 	duplicate_names = names.select{|name| names.count(name) > 1}.uniq
-	report.call(mapping, "Contains duplicated names #{duplicate_names.map(&:inspect)*', '}") unless duplicate_names.empty?
+	report.call(self, "Contains duplicated names #{duplicate_names.map(&:inspect)*', '}") unless duplicate_names.empty?
 
-	mapping.all_member.each do |member|
+	all_member.each do |member|
 	  trace :composition_validator?, "Validating #{member.inspect}" do
-	    report.call(member, "Requires a name") unless MM::Absorption === member && member.flattens or member.name && !member.name.empty?
+	    report.call(member, "Requires a name") unless Absorption === member && member.flattens or member.name && !member.name.empty?
 	    case member
-	    when MM::Absorption
+	    when Absorption
 	      p = member.parent_role
 	      c = member.child_role
 	      report.call(member, "Roles should belong to the same fact type, but instead we have #{p.name} in #{p.fact_type.default_reading} and #{c.name} in #{c.fact_type.default_reading}") unless p.fact_type == c.fact_type
 	      report.call(member, "Object type #{member.object_type.name} should play the child role #{c.name}") unless member.object_type == c.object_type
-	      report.call(member, "Parent mapping object type #{mapping.object_type.name} should play the parent role #{p.name}") unless mapping.object_type == p.object_type
-
-	      validate_reverse member, &report
-	      validate_nesting member, &report if member.all_nesting.size > 0
+	      report.call(member, "Parent mapping object type #{object_type.name} should play the parent role #{p.name}") unless object_type == p.object_type
 
-	      validate_members member, &report
+	      member.validate_reverse &report
+	      member.validate_nesting &report if member.all_nesting.size > 0
+	      member.validate_members &report
 
-	    when MM::Scoping
+	    when Scoping
 	      report.call(member, "REVISIT: Unexpected and unchecked Scoping")
 
-	    when MM::ValueField
+	    when ValueField
 	      # Nothing to check here
 
-	    when MM::SurrogateKey
+	    when SurrogateKey
 	      # Nothing to check here
 
-	    when MM::Injection
+	    when Injection
 	      report.call(member, "REVISIT: Unexpected and unchecked Injection")
 
-	    when MM::Mapping
+	    when Mapping
 	      report.call(member, "A child Component should not be a bare Mapping")
 
-	    when MM::Indicator
+	    when Indicator
 	      report.call(member, "Indicator requires a Role") unless member.role
 
-	    when MM::Discriminator
+	    when Discriminator
 	      report.call(member, "Discriminator requires at least one Discriminated Role") if member.all_discriminated_role.empty?
 	      member.all_discriminated_role.each do |role|
-		report.call(member, "Discriminated Role #{role.name} is not played by parent object type #{mapping.object_type.name}") unless role.object_type == mapping.object_type
+		report.call(member, "Discriminated Role #{role.name} is not played by parent object type #{object_type.name}") unless role.object_type == object_type
 	      end
 	      # REVISIT: Discriminated Roles must have distinct values matching the type of the Role
 	    end
 	  end
 	end
       end
+    end
 
-      def validate_reverse absorption, &report
-	reverse = absorption.forward_absorption || absorption.reverse_absorption
+    class Absorption
+      def validate_reverse &report
+	reverse = forward_absorption || reverse_absorption
 	return unless reverse
-	report.call(absorption, "Opposite absorption's child role #{reverse.child_role.name} should match parent role #{absorption.parent_role.name}") unless reverse.child_role == absorption.parent_role
-	report.call(absorption, "Opposite absorption's parent role #{reverse.parent_role.name} should match child role #{absorption.child_role.name}") unless reverse.parent_role == absorption.child_role
+	report.call(self, "Opposite absorption's child role #{reverse.child_role.name} should match parent role #{parent_role.name}") unless reverse.child_role == parent_role
+	report.call(self, "Opposite absorption's parent role #{reverse.parent_role.name} should match child role #{child_role.name}") unless reverse.parent_role == child_role
       end
 
-      def validate_nesting absorption, &report
-	report.call(absorption, "REVISIT: Unexpected and unchecked Nesting")
-	report.call(absorption, "Nesting Mode must be specified") unless absorption.nesting_mode
+      def validate_nesting &report
+	report.call(self, "REVISIT: Unexpected and unchecked Nesting")
+	report.call(self, "Nesting Mode must be specified") unless self.nesting_mode
 	# REVISIT: Nesting names must be unique
 	# REVISIT: Nesting roles must be played by...
 	# REVISIT: Nesting roles must be value types
       end
-
-      def validate_access_paths composite, &report
-	composite.all_access_path.each do |access_path|
-	  report.call(access_path, "Must contain at least one IndexField") unless access_path.all_index_field.size > 0
-	  access_path.all_index_field.each do |index_field|
-	    report.call(access_path, "#{index_field.inspect} must be an Indicator or played by a ValueType") unless index_field.component.is_a?(MM::Indicator) || index_field.component.object_type.is_a?(MM::ValueType)
-	    report.call(access_path, "#{index_field.inspect} must be within its composite") unless index_field.component.root == composite
-	  end
-	  if MM::ForeignKey === access_path
-	    if access_path.all_index_field.size == access_path.all_foreign_key_field.size
-	      access_path.all_index_field.to_a.zip(access_path.all_foreign_key_field.to_a).each do |index_field, foreign_key_field|
-		report.call(access_path, "#{index_field.inspect} must have matching target type") unless index_field.component.class == foreign_key_field.component.class
-		unless index_field.component.class == foreign_key_field.component.class
-		  report.call(access_path, "#{index_field.inspect} must have component type matching #{foreign_key_field.inspect}")
-		else
-		  report.call(access_path, "#{index_field.inspect} must have matching target type") unless !index_field.component.is_a?(MM::Absorption) or index_field.component.object_type == foreign_key_field.component.object_type
-		end
-		report.call(access_path, "#{foreign_key_field.inspect} must be within the target composite") unless foreign_key_field.component.root == access_path.source_composite
-	      end
-	    else
-	      report.call(access_path, "has #{access_path.all_index_field.size} index fields but #{access_path.all_foreign_key_field.size} ForeignKeyField")
-	    end
-	  end
-	end
-      end
     end
+
   end
 end

data/lib/activefacts/loadable.rb

@@ -0,0 +1,28 @@
+#
+# Enumerate files with "extension" in directories called "path" anywhere in the Ruby LOAD_PATH
+#
+class Loadable
+  def initialize path = "", extension = '.rb'
+    @path = path
+    @extension = extension
+  end
+
+  def enumerate
+    $LOAD_PATH.
+    flat_map do |dir|
+      dir_path = (dir+"/"+@path).gsub(%r{//+}, '/')
+      pattern = dir_path+"/**/*"+@extension
+      Dir[pattern].
+      map do |p|
+	p.
+	sub(%r{#{Regexp.escape(dir_path)}/}, '').
+	sub(%r{#{@extension}}, '')
+      end
+    end
+
+  end
+end
+
+if __FILE__ == $0
+  p Loadable.new(*ARGV).enumerate
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activefacts-compositions
 version: !ruby/object:Gem::Version
-  version: 1.9.5
+  version: 1.9.6
 platform: ruby
 authors:
 - Clifford Heath
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2016-01-29 00:00:00.000000000 Z
+date: 2016-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -59,7 +59,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.3'
 - !ruby/object:Gem::Dependency
-  name: activefacts-api
+  name: activefacts
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -67,8 +67,8 @@ dependencies:
         version: '1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.9.4
-  type: :runtime
+        version: '1.8'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -77,9 +77,9 @@ dependencies:
         version: '1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.9.4
+        version: '1.8'
 - !ruby/object:Gem::Dependency
-  name: activefacts-metamodel
+  name: activefacts-api
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -99,45 +99,45 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.9.5
 - !ruby/object:Gem::Dependency
-  name: tracing
+  name: activefacts-metamodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.6
+        version: 1.9.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.6
+        version: 1.9.6
 - !ruby/object:Gem::Dependency
-  name: activefacts
+  name: tracing
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :development
+        version: 2.0.6
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 2.0.6
 - !ruby/object:Gem::Dependency
   name: activefacts-cql
   requirement: !ruby/object:Gem::Requirement
@@ -148,7 +148,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.8'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -162,7 +162,8 @@ description: Create and represent composite schemas, schema transforms and data
   over a fact-based model
 email:
 - clifford.heath@gmail.com
-executables: []
+executables:
+- schema_compositor
 extensions: []
 extra_rdoc_files: []
 files:
@@ -178,9 +179,18 @@ files:
 - lib/activefacts/compositions.rb
 - lib/activefacts/compositions/binary.rb
 - lib/activefacts/compositions/compositor.rb
+- lib/activefacts/compositions/constraints.rb
+- lib/activefacts/compositions/names.rb
 - lib/activefacts/compositions/relational.rb
-- lib/activefacts/compositions/validator.rb
 - lib/activefacts/compositions/version.rb
+- lib/activefacts/generator.rb
+- lib/activefacts/generator/oo.rb
+- lib/activefacts/generator/ruby.rb
+- lib/activefacts/generator/sql.rb
+- lib/activefacts/generator/sql/server.rb
+- lib/activefacts/generator/summary.rb
+- lib/activefacts/generator/validate.rb
+- lib/activefacts/loadable.rb
 homepage: https://github.com/cjheath/activefacts-compositions
 licenses:
 - MIT