activefacts-compositions 1.9.1 → 1.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0c06e12306cedaf28c2c97bb4402eefcca710b1
-  data.tar.gz: 3e04e43481658439e3ede1b0617e7894b3396f6b
+  metadata.gz: bad26d18580fa095acc7cbb4a2722694f0020c30
+  data.tar.gz: 45c9fc0cf6516095c7794bd7fb291ce33c80b074
 SHA512:
-  metadata.gz: bb18efed6ff85d453708918973589714f30d39e7e65132337d64919146e21be7a28a6e79b9769f4ff94c45dfed9fc7b9abe22a0999bdd76044666ea7151ee348
-  data.tar.gz: f32477f6a63fec1b57c7d387f4ef9a61371e1ff0944105e47ceff312cddd8099fc9563e2cd50b66c762279c0885e7cba19a09441438cc9e6abdac6325a2e0155
+  metadata.gz: 76fafc569a0516de38ddb19e604c243ec7b87318823fffac3bd3b8b84ec491e131d4429dae139944322a2882574e2c6d9693fad176fa9962dcf2f5495851f13b
+  data.tar.gz: ca70f4978bffffea9737812c3199503a81242809f0f0a27674be0c769b96d82aef6937a7cbd0213ac50ac971684ee2ec476e9c6c517729de1d92a109b45bd782

data/Gemfile

@@ -2,10 +2,9 @@ source 'https://rubygems.org'
 
 gemspec
 
-if ENV['PWD'] =~ %r{\A#{ENV['HOME']}/work}
+if ENV['PWD'] =~ %r{\A#{ENV['HOME']}/work}i
   $stderr.puts "Using work area gems for #{File.basename(File.dirname(__FILE__))} from activefacts-compositions"
-  gem 'activefacts-api', path: '/Users/cjh/work/activefacts/api'
-  gem 'activefacts-metamodel', path: '/Users/cjh/work/activefacts/metamodel'
-  gem 'activefacts-cql', path: '/Users/cjh/work/activefacts/cql'
-  # gem 'activefacts-metamodel', git: 'git://github.com/cjheath/activefacts-metamodel.git'
+  gem 'activefacts-api', path: '../api'
+  gem 'activefacts-metamodel', path: '../metamodel'
+  gem 'activefacts-cql', path: '../cql'
 end

data/README.md

@@ -1,12 +1,17 @@
 # ActiveFacts::Compositions
 
-Create and represent composite schemas, schema transforms and data transforms over a fact-based model.
+Fact-based schemas are always in highly normalised or *elementary* form.
+Most other schemas are composite (object-oriented, relational, warehousing, analytical, messaging, APIs, etc).
+This gem provides the framework for *Compositions*, which are representations of the two-way mapping between an elementary schema and a composite schema.
+As such, it supports any-to-any mappings between different composite forms.
+
+It also provides automated generators for some types of composite schemas, especially relational and Data Vault schemas.
 
 This gem works with the Fact Modeling tools as part of ActiveFacts.
 
 ## Installation
 
-Install via the activefacts gem bundle, or add this line to your application's Gemfile:
+Install as part of activefacts, just "gem install" directly, or add this line to your application's Gemfile:
 
 ```ruby
 gem 'activefacts-compositions'
@@ -16,16 +21,17 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install activefacts-compositions
-
 ## Usage
 
-This gem adds schema manipulation tools (mappers, composers, transformations, generators) to the generator framework for activefacts. Refer to the afgen command-line tool for help:
+This gem adds schema manipulation tools (mappers, composers, transformations) to the generator framework for *activefacts*.
+Refer to the afgen command-line tool for help:
 
     $ afgen --help
 
+A stand-alone relational generator program is provided, mostly for exploratory purposes; use tracing to see what it is doing, e.g.:
+
+    $ TRACE=relational bin/schema_compositor --surrogate spec/relational/CompanyDirectorEmployee.cql
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests.
@@ -36,7 +42,6 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/cjheath/activefacts-compositions.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -4,3 +4,20 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+
+desc "Bump gem version patch number"
+task :bump do
+  path = File.expand_path('../lib/activefacts/compositions/version.rb', __FILE__)
+  lines = File.open(path) do |fp| fp.readlines; end
+  File.open(path, "w") do |fp|
+    fp.write(
+      lines.map do |line|
+	line.gsub(/(VERSION *= *"[0-9.]*\.)([0-9]+)"\n/) do
+	  version = "#{$1}#{$2.to_i+1}"
+	  puts "Version bumped to #{version}\""
+	  version+"\"\n"
+	end
+      end*''
+    )
+  end
+end

data/activefacts-compositions.gemspec

@@ -23,7 +23,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.3"
 
-  spec.add_runtime_dependency("activefacts-metamodel", ">= 1.9", "~> 1.9.0")
-  spec.add_development_dependency "activefacts", "~> 1.8", "~> 1.8.0"
-  spec.add_development_dependency "activefacts-cql", "~> 1.8", "~> 1.8.0"
+  spec.add_runtime_dependency("activefacts-api", "~> 1", ">= 1.9.2")
+  spec.add_runtime_dependency("activefacts-metamodel", "~> 1", ">= 1.9.1")
+  spec.add_runtime_dependency "tracing", "~> 2", ">= 2.0.5"
+
+  spec.add_development_dependency "activefacts", "~> 1", ">= 1.8"
+  spec.add_development_dependency "activefacts-cql", "~> 1", ">= 1.8"
 end

data/bin/schema_compositor

@@ -11,12 +11,19 @@ $:.unshift File.dirname(File.expand_path(__FILE__))+"/../lib"
 require 'activefacts/metamodel'
 require 'activefacts/compositions/binary'
 require 'activefacts/compositions/relational'
+require 'activefacts/compositions/validator'
 
-arg = ARGV.shift
+options = {}
+while arg = ARGV.shift and arg =~ /^-/
+  option, value = arg.split(/=/, 2)
+  options[option.sub(/^-*/,'')] = value =~ /,/ ? value.split(',') : (value || true)
+end
+
+validate = options.delete('validate')
 
 # Load the file type input method
 if arg
-  arg, *options = *arg.split(/=/)
+  arg, input_options = *arg.split(/=/, 2)
   extension = arg.sub(/\A.*\./,'').downcase
   input_handler = "activefacts/input/#{extension}"
   require input_handler
@@ -29,7 +36,7 @@ end
 # Read the input file:
 begin
   if input_klass
-    vocabulary = input_klass.readfile(arg, *options)
+    vocabulary = input_klass.readfile(arg, *input_options)
   else
     vocabulary = true
   end
@@ -38,8 +45,12 @@ begin
 
   vocabulary.finalise unless vocabulary == true
 
-  compositor = ActiveFacts::Compositions::Relational.new(vocabulary.constellation, "test")
+  compositor = ActiveFacts::Compositions::Relational.new(vocabulary.constellation, "test", options)
   compositor.generate
+  trace.enable 'composition_validator'
+  compositor.validate do |component, problem|
+    trace :composition_validator, "!!PROBLEM!! #{component.inspect}: #{problem}"
+  end if validate
 
 rescue => e
   $stderr.puts "#{e.message}"

data/lib/activefacts/compositions/binary.rb

@@ -13,14 +13,14 @@ module ActiveFacts
       def generate
 	super
 
-	trace :binary_, "Constructing Binary Composition" do
+	trace :binary!, "Constructing Binary Composition" do
 	  @binary_mappings.keys.sort_by(&:name).each do |object_type|
 	    mapping = @binary_mappings[object_type]
 	    mapping.re_rank
 	  end
 	end
 
-	trace :binary_, "Full binary composition" do
+	trace :binary!, "Full binary composition" do
 	  @binary_mappings.keys.sort_by(&:name).each do |object_type|
 	    mapping = @binary_mappings[object_type]
 	    mapping.show_trace 

data/lib/activefacts/compositions/compositor.rb

@@ -16,6 +16,8 @@ require "activefacts/metamodel"
 module ActiveFacts
   module Compositions
     class Compositor
+      attr_reader :options, :name
+
       def initialize constellation, name, options = {}
 	@constellation = constellation
 	@name = name
@@ -32,10 +34,17 @@ module ActiveFacts
 	end
 
 	@composition = @constellation.Composition(:new, :name => @name)
+	preload_preferred_identifiers
 	populate_references
       end
 
     private
+      # Preferred identifiers are cached, but the process produces trace output
+      # that appears in the "tutti" mode used in testing. This precludes that.
+      def preload_preferred_identifiers
+	@constellation.EntityType.map{|k, et| et.preferred_identifier }
+      end
+
       def populate_reference object_type, role
 	parent = @binary_mappings[role.object_type]
 
@@ -44,12 +53,12 @@ module ActiveFacts
 	  counterpart = role.counterpart
 	  rt = role_type(counterpart)
 	  if rt == :many_many
-	    raise "Can't absorb many-to-many (until we absorb derived fact types, or don't require explicit objectification)"
+	    raise "Fact type must be objectified: #{role.fact_type.default_reading}"
 	  end
 
 	  a = @constellation.Absorption(
 	      :new,
-	      name: counterpart.name,
+	      name: role_name(counterpart),
 	      parent: parent,
 	      object_type: counterpart.object_type,
 	      parent_role: role,
@@ -59,9 +68,9 @@ module ActiveFacts
 	  if r = @component_by_fact[role.fact_type]
 	    # Second occurrence of this fact type, set the direction:
 	    if a.is_preferred_direction
-	      a.absorption = r
-	    else  # Set this as the reverse absorption
 	      a.reverse_absorption = r
+	    else  # Set this as the reverse absorption
+	      a.forward_absorption = r
 	    end
 	  else
 	    # First occurrence of this fact type
@@ -95,7 +104,8 @@ module ActiveFacts
 	    @binary_mappings[object_type]  # Ensure we create the top Mapping even if it has no references
 
 	    object_type.all_role.each do |role|
-	      next if role.mirror_role_as_base_role # Exclude base roles, just use link fact types
+	      # Exclude base roles in objectified fact types (unless unary); just use link fact types
+	      next if role.fact_type.entity_type && role.fact_type.all_role.size != 1
 	      next if role.variable_as_projection   # REVISIT: Continue to ignore roles in derived fact types?
 	      populate_reference object_type, role
 	    end
@@ -112,6 +122,13 @@ module ActiveFacts
 	end
       end
 
+      def role_name role
+#	if role.fact_type.is_a?(ActiveFacts::Metamodel::TypeInheritance) && role == role.fact_type.subtype_role
+#	  return "Is "+role.object_type.name
+#	end
+	String::Words.new(role.base_role.preferred_reference.role_name(nil)).capwords*' '
+      end
+
       def role_type role
 	fact_type = role.fact_type
 	if fact_type.is_a?(ActiveFacts::Metamodel::TypeInheritance)