activefacts-compositions 1.9.20 → 1.9.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 074d060502e336f08e6e114ace5990b6d890f890
-  data.tar.gz: 4ddff75043dc0ce04ef5651fe69b105bee492827
+  metadata.gz: 844f00a51607447cf1d629f514f7afe06d20a996
+  data.tar.gz: 6274fe0597c71587a0102637e2f83540b907919d
 SHA512:
-  metadata.gz: cfb954b0e3a018ca4bfc959644e2b8780e98789f500dbc9891629c299a8bc3e641c5830a9ae796938f57be90e65909487154fce22e70700b0bac03a653cf2152
-  data.tar.gz: e17f5f23cffeecd28f859a2a71bccfd1306dc2da94aa2a79b2eb34f29c5e121746156fe6fb63b6c2e275290c5b36081bf48834b65825eea71d327d4de29c0d95
+  metadata.gz: fd447a4faf7b38663e95bce5b1576f6097ac3ecee9779f0e5a63ef15119ce9983445916e02371579ab3dca77115fdf175eca01ba6d571e85a4f5783ded448a55
+  data.tar.gz: 1ebdb686870e87e07287f66a770d4711b5f7b0bf72e9e7cc271f5e13f2e94e5ac26c0b1c0b58e7631dee787323683c9e3ecd203af08a93e8eb19861df839a638

data/bin/afcomp

@@ -62,11 +62,11 @@ class SchemaCompositor
         option = compositor
       end
 
-      if action = ActiveFacts::Compositions.compositors[option]
+      if action, helptext = ActiveFacts::Compositions.compositors[option]
         options.delete(option)
         check_options(action, modes)
         @compositors << [action, modes, option]
-      elsif action = ActiveFacts::Generators.generators[option]
+      elsif action, helptext = ActiveFacts::Generators.generators[option]
         options.delete(option)
         check_options(action, modes)
         @generators << [action, modes, option]

data/bin/schema_compositor

@@ -36,16 +36,19 @@ class SchemaCompositor
     trace :loading, "Enumerating under #{path.inspect}" do
       Loadable.new(path).
       enumerate.
-      select do |filename|
+      map do |filename|
         begin
           require(pathname = path+"/"+filename)
           trace :loading, "Loaded #{pathname}"
+	  filename
         rescue LoadError => e
           trace :loading, "Can't load #{pathname}: #{e.class}: #{e.message} #{e.backtrace[0]}"
+	  nil
         rescue Exception => e
           $stderr.puts "Can't load #{pathname}: #{e.class}: #{e.message} #{e.backtrace[0]}"
+	  nil
         end
-      end
+      end.compact
     end
   end
 
@@ -70,6 +73,8 @@ class SchemaCompositor
         options.delete(option)
         check_options(action, modes)
         @generators << [action, modes, option]
+      elsif option == 'help'
+      	# Finish, then help
       else
         $stderr.puts "Action --#{option} is not recognised"
         exit 1
@@ -184,12 +189,18 @@ end
 sc = SchemaCompositor.new(ARGV)
 sc.enumerate_available('activefacts/compositions')
 sc.enumerate_available('activefacts/generator')
-if sc.options['help']
-  puts "Available compositors:\n\t#{ActiveFacts::Compositions.compositors.keys.sort*"\n\t"}\n\n"
-  puts "Available generators:\n\t#{ActiveFacts::Generators.generators.keys.sort*"\n\t"}\n\n"
+inputs = sc.enumerate_available('activefacts/input')
+sc.arrange_actions
+if sc.options['help'] || (sc.generators.empty? && sc.compositors.empty?)
+  compositors = (c = ActiveFacts::Compositions.compositors).keys.sort.map{|k| "%-15s %s" % [k, c[k][1]]}
+  generators = (c = ActiveFacts::Generators.generators).keys.sort.map{|k| "%-15s %s" % [k, c[k][1]]}
+  puts "You need to use a compositor to create the right kind of schema, and at least one generator to get output."
+  puts "Use '#{$PROGRAM_NAME} --<compositorname> --<generatorname> inputfile.ext'"
+  puts "Available input formats (file extensions):\n\t#{inputs*"\n\t"}\n\n"
+  puts "Available compositors:\n\t#{compositors*"\n\t"}\n\n"
+  puts "Available generators:\n\t#{generators*"\n\t"}\n\n"
   puts "To get help for a particular action, follow it by =help, e.g. --relational:help"
   exit
 end
 
-sc.arrange_actions
 sc.process_files ARGV

data/lib/activefacts/compositions.rb

@@ -8,8 +8,8 @@ module ActiveFacts
       @@compositors ||= {}
     end
 
-    def self.publish_compositor klass
-      compositors[klass.name.sub(/^ActiveFacts::Compositions::/,'').gsub(/::/, '/').downcase] = klass
+    def self.publish_compositor klass, helptext = ''
+      compositors[klass.name.sub(/^ActiveFacts::Compositions::/,'').gsub(/::/, '/').downcase] = [klass, helptext]
     end
   end
 end

data/lib/activefacts/compositions/binary.rb

@@ -38,6 +38,6 @@ module ActiveFacts
 
       end
     end
-    publish_compositor(Binary)
+    publish_compositor Binary, "A composition reduced to binary relationships, suitable for object-oriented programming"
   end
 end

data/lib/activefacts/compositions/datavault.rb

@@ -717,6 +717,6 @@ module ActiveFacts
 
     end
 
-    publish_compositor(DataVault)
+    publish_compositor DataVault, "A relational composition suitable for full-history storage along Data Vault lines"
   end
 end

data/lib/activefacts/compositions/relational.rb

@@ -970,6 +970,6 @@ module ActiveFacts
 
     end
 
-    publish_compositor(Relational)
+    publish_compositor Relational, "A relational composition for operational databases in optimal normal form"
   end
 end

data/lib/activefacts/compositions/staging.rb

@@ -161,6 +161,6 @@ module ActiveFacts
 
     end
 
-    publish_compositor(Staging)
+    publish_compositor Staging, "A relational composition augmented with audit attributes for staging data transformations"
   end
 end

data/lib/activefacts/compositions/version.rb

@@ -1,5 +1,5 @@
 module ActiveFacts
   module Compositions
-    VERSION = "1.9.20"
+    VERSION = "1.9.21"
   end
 end

data/lib/activefacts/generator.rb

@@ -7,8 +7,8 @@ module ActiveFacts
       @@generators ||= {}
     end
 
-    def self.publish_generator klass
-      generators[klass.name.sub(/^ActiveFacts::Generators::/,'').gsub(/::/, '/').downcase] = klass
+    def self.publish_generator klass, helptext = ''
+      generators[klass.name.sub(/^ActiveFacts::Generators::/,'').gsub(/::/, '/').downcase] = [klass, helptext]
     end
   end
 end

data/lib/activefacts/generator/doc/cwm.rb

@@ -1,7 +1,7 @@
 #
 #       ActiveFacts Common Warehouse Metamodel Generator
 #
-# This generator produces an CWM XMI-formated model of a Composition.
+# This generator produces an CWM XMI-formatted model of a Composition.
 #
 # Copyright (c) 2016 Infinuendo. Read the LICENSE file.
 #
@@ -519,6 +519,6 @@ module ActiveFacts
         
       end
     end
-    publish_generator Doc::CWM
+    publish_generator Doc::CWM, "Common Warehouse Metamodel represented as an XMI file. Use a relational compositor"
   end
 end

data/lib/activefacts/generator/doc/graphviz.rb

@@ -128,7 +128,7 @@ END
       end
 
     end
-    publish_generator Doc::Graphviz
+    publish_generator Doc::Graphviz, "Input file for graphvis automated diagram layout"
   end
 end
 

data/lib/activefacts/generator/doc/ldm.rb

@@ -693,6 +693,6 @@ module ActiveFacts
         MM = ActiveFacts::Metamodel unless const_defined?(:MM)
       end
     end
-    publish_generator Doc::LDM
+    publish_generator Doc::LDM, "Logical Data Model documentation in HTML. Use a relational compositor"
   end
 end

data/lib/activefacts/generator/etl/unidex.rb

@@ -369,6 +369,6 @@ module ActiveFacts
 
       end
     end
-    publish_generator ETL::Unidex
+    publish_generator ETL::Unidex, "Generate SQL views to populate a Unified Index, steered by Search parameters on the value types"
   end
 end

data/lib/activefacts/generator/rails/models.rb

@@ -250,6 +250,6 @@ module ActiveFacts
         MM = ActiveFacts::Metamodel unless const_defined?(:MM)
       end
     end
-    publish_generator Rails::Models
+    publish_generator Rails::Models, "Generate models in Ruby for use with ActiveRecord and Rails. Use a relational compositor"
   end
 end

data/lib/activefacts/generator/rails/schema.rb

@@ -298,7 +298,7 @@ module ActiveFacts
 
       end
     end
-    publish_generator Rails::Schema
+    publish_generator Rails::Schema, "Generate schema.rb in Ruby for use with ActiveRecord and Rails. Use a relational compositor"
   end
 end
 

data/lib/activefacts/generator/ruby.rb

@@ -126,6 +126,6 @@ module ActiveFacts
         super
       end
     end
-    publish_generator Ruby
+    publish_generator Ruby, "Generate Ruby code for fact-based programming with the activefacts-api. Use the binary compositor"
   end
 end

data/lib/activefacts/generator/sql.rb

@@ -179,6 +179,6 @@ module ActiveFacts
       end
     end
 
-    publish_generator SQL
+    publish_generator SQL, "Generate a schema in standard SQL-99 using any relational compositor"
   end
 end

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

@@ -20,6 +20,6 @@ module ActiveFacts
       end
 
     end
-    publish_generator SQL::MySQL
+    publish_generator SQL::MySQL, "Generate a schema for MySQL using any relational compositor"
   end
 end

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

@@ -20,6 +20,6 @@ module ActiveFacts
       end
 
     end
-    publish_generator SQL::Oracle
+    publish_generator SQL::Oracle, "Generate a schema for Oracle using any relational compositor"
   end
 end

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

@@ -20,6 +20,6 @@ module ActiveFacts
       end
 
     end
-    publish_generator SQL::Postgres
+    publish_generator SQL::Postgres, "Generate a schema for Postgres using any relational compositor"
   end
 end

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

@@ -20,6 +20,6 @@ module ActiveFacts
       end
 
     end
-    publish_generator SQL::Server
+    publish_generator SQL::Server, "Generate a schema for SQL Server using any relational compositor"
   end
 end

data/lib/activefacts/generator/summary.rb

@@ -115,6 +115,6 @@ module ActiveFacts
         @composition.summary
       end
     end
-    publish_generator Summary
+    publish_generator Summary, "Succinctly display the full structure of any composition"
   end
 end

data/lib/activefacts/generator/transgen.rb

@@ -139,6 +139,6 @@ module ActiveFacts
         # regenerate_compound_matching(composite.mapping, 0, '') + ";\n"
       end
     end
-    publish_generator TransGen
+    publish_generator TransGen, "Generate a transform between two related fact-based schemas"
   end
 end

data/lib/activefacts/generator/validate.rb

@@ -38,6 +38,6 @@ module ActiveFacts
         nil
       end
     end
-    publish_generator Validate
+    publish_generator Validate, "Perform a thorough validation to check that a compositor is working correctly"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activefacts-compositions
 version: !ruby/object:Gem::Version
-  version: 1.9.20
+  version: 1.9.21
 platform: ruby
 authors:
 - Clifford Heath