activefacts-compositions 1.9.22 → 1.9.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 300cb201900fd72d2938ad450aacb8628553b4d8
-  data.tar.gz: cd98524b4e5525f9fe2ff0ee5f420bbef51f36ea
+SHA256:
+  metadata.gz: 3e35af2337e08f47fa7bbd7fcf24b3f56872aca5941ef5e7613a214cdc0957e8
+  data.tar.gz: 1952c7f7199348bf3c6a41496edca9103b37379ed63a0d6ec34c6978f23b5fc0
 SHA512:
-  metadata.gz: 7a0ed81d7d13fd33579be4c56b765c3b804f311fb8c5da85c9d75ca6a190d23a136d3abab4459851efa4b4891117013501a17325535f951ee047782a1ff2687f
-  data.tar.gz: ca7e4c460031087fb52f9655ea3a603098827bfbd7f74704d9eddfdce9e9f1322709a0b705f2bb6fed3c1d491ecfa4e8f1577da572203148fef81d5caa2cc5e4
+  metadata.gz: c15889850396034caa48eb039f858dddf8217101a6ef1e0049e6d17db628448c00353e5f518cd73cfca3448c1885cc9599629fb93091a88a6257c6e91827e726
+  data.tar.gz: ce9ec2671c7a4826d747c67c580bf9507561b7e1a3db98f30e06fb169a812225b7ffa554af2a2147db8430916572e486c4b1b73eb6f63003ab44df0e1aa32ca5

data/README.md

@@ -29,7 +29,7 @@ And then execute:
 
 ## Development
 
-After checking out the repo, run `bundle` to install dependencies. Then, run `rake rspec` to run the tests.
+After checking out the repo, run `bundle` to install dependencies. Then, run `rake spec` to run the tests.
 
 To install this gem onto your local machine from local source code, run `rake install`.
 

data/activefacts-compositions.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", ">= 1.11"
-  spec.add_development_dependency "rake", "> 10"
+  spec.add_development_dependency "rake", ">= 10"
   spec.add_development_dependency "rspec", "~> 3.3"
 
   spec.add_runtime_dependency "activesupport", ">= 4.2.7"

data/bin/schema_compositor

@@ -22,9 +22,10 @@ class SchemaCompositor
 
   # Parse options into a hash, and values for each option into a hash
   def initialize argv
+    @argv = argv.dup
     @options = {}
-    while argv[0] =~ /^-/
-      option, value = argv.shift.split(/[=:]/, 2)
+    while @argv[0] =~ /^-/
+      option, value = @argv.shift.split(/[=:]/, 2)
       csv = (value =~ /,/ ? value.split(',') : Array(value))
       modes = csv.inject({}){|h,s| k, v = s.split(/=/, 2); h[k] = v || true; h }
       @options[option.sub(/^-*/,'')] = modes
@@ -40,13 +41,13 @@ class SchemaCompositor
         begin
           require(pathname = path+"/"+filename)
           trace :loading, "Loaded #{pathname}"
-	  filename
+          filename
         rescue LoadError => e
           trace :loading, "Can't load #{pathname}: #{e.class}: #{e.message} #{e.backtrace[0]}"
-	  nil
+          nil
         rescue Exception => e
           $stderr.puts "Can't load #{pathname}: #{e.class}: #{e.message} #{e.backtrace[0]}"
-	  nil
+          nil
         end
       end.compact
     end
@@ -65,16 +66,26 @@ class SchemaCompositor
         option = compositor
       end
 
-      if (action, helptext = ActiveFacts::Compositions.compositors[option]) && action
+      # Is it a compositor?
+      action, helptext = ActiveFacts::Compositions.compositors[option]
+      if action
         options.delete(option)
         check_options(action, modes)
         @compositors << [action, modes, option]
-      elsif (action, helptext = ActiveFacts::Generators.generators[option]) && action
+	next
+      end
+
+      # Is it a generator?
+      action, helptext = ActiveFacts::Generators.generators[option]
+      if action
         options.delete(option)
         check_options(action, modes)
         @generators << [action, modes, option]
-      elsif option == 'help'
-      	# Finish, then help
+	next
+      end
+
+      if option == 'help'
+        # Finish, then help
       else
         $stderr.puts "Action --#{option} is not recognised"
         exit 1
@@ -85,9 +96,9 @@ class SchemaCompositor
     end
   end
 
-  def process_files argv
+  def process_files
     # Process each input file:
-    argv.each do |arg|
+    @argv.each do |arg|
       filename, input_options = *arg.split(/=/, 2)
 
       # Load the correct file type input method
@@ -119,20 +130,53 @@ class SchemaCompositor
         end
       exit 0 unless vocabulary
       vocabulary.finalise unless vocabulary == true
+      constellation = vocabulary.constellation
 
-      # Run one compositor
-      if @compositors.size != 1
-        raise "Expected one compositor, use --help for a list"
-      end
-
-      compositor_klass, modes, option = @compositors[0]
-      compositor = compositor_klass.new(vocabulary.constellation, basename, modes)
-      compositor.generate
+      compositions =
+        @compositors.map do |compositor_klass, modes, option|
+          compositor = compositor_klass.new(constellation, basename, modes)
+          compositor.generate
+          [compositor_klass, compositor.composition]
+        end
 
-      # Run each generator
-      @generators.each do |generator_klass, modes|
-        output = generator_klass.new(compositor.composition, modes).generate
-        puts output if output
+      begin
+        # Run each generator
+        @generators.each do |generator_klass, modes|
+          arity, composition_types = generator_klass.compatibility
+          type_list = composition_types ? composition_types.map(&:to_s)*' or ' : nil
+          compatible_compositions =
+            compositions.
+              select{|k, c| composition_types ? (composition_types&k.compatibility).size > 0 : true}
+
+          if arity == 0
+            # No composition is required
+            output = generator_klass.new(constellation, compositions.map{|k,c| c}, modes).generate
+            puts output if output
+          elsif arity == 1
+            # This generator processes each composition in turn
+            if compatible_compositions.size == 0
+              raise "#{generator_klass.basename} expects a #{type_list} compositor; use --help for a list"
+            end
+            compatible_compositions.
+              each do |k, c|
+                output = generator_klass.new(constellation, c, modes).generate
+                puts output if output
+              end
+          else
+            # This generator either accepts "arity" compositions or any number
+            if arity && compositions.size != arity
+              raise "#{generator_klass.basename} expects #{arity} #{type_list} compositions; use --help for a list"
+            end
+            # Pass all compositions:
+            output = generator_klass.new(constellation, compositions.map{|k,c| c}, modes).generate
+            puts output if output
+          end
+        end
+      rescue => e
+        $stderr.puts "#{e.message}"
+        if trace :exception
+          $stderr.puts "\t#{e.backtrace*"\n\t"}"
+        end
       end
     end
   end
@@ -159,13 +203,13 @@ class SchemaCompositor
             ' num'
           when Pathname
             ' file'
-	  when Array
-	    " { #{type.map(&:to_s)*' | '} }"
+          when Array
+            " { #{type.map(&:to_s)*' | '} }"
           else
             ' str'
           end
 
-	spaces = (s = 24-tag.size) < 2 ? 2 : s
+        spaces = (s = 24-tag.size) < 2 ? 2 : s
         stream.puts "\t#{tag}#{' '*spaces}#{description}"
       end
     end
@@ -203,4 +247,4 @@ if sc.options['help'] || (sc.generators.empty? && sc.compositors.empty?)
   exit
 end
 
-sc.process_files ARGV
+sc.process_files

data/lib/activefacts/compositions/binary.rb

@@ -18,6 +18,10 @@ module ActiveFacts
         {}
       end
 
+      def self.compatibility
+        %i{binary}
+      end
+
       def generate
         super
 

data/lib/activefacts/compositions/datavault.rb

@@ -40,6 +40,10 @@ module ActiveFacts
         })
       end
 
+      def self.compatibility
+        %i{datavault relational}
+      end
+
       def initialize constellation, name, options = {}
         # Extract recognised options:
         datavault_initialize options

data/lib/activefacts/compositions/relational.rb

@@ -19,6 +19,10 @@ module ActiveFacts
         }.merge(Compositor.options)
       end
 
+      def self.compatibility
+        %i{relational}
+      end
+
       def initialize constellation, name, options = {}, compositor_name = 'Relational'
         @option_surrogates = options.delete('surrogates')
 

data/lib/activefacts/compositions/staging.rb

@@ -24,6 +24,10 @@ module ActiveFacts
         merge(Relational.options)
       end
 
+      def self.compatibility
+        %i{relational}
+      end
+
       def initialize constellation, name, options = {}
         # Extract recognised options:
         @option_cdc = options.delete('cdc')

data/lib/activefacts/compositions/version.rb

@@ -1,5 +1,5 @@
 module ActiveFacts
   module Compositions
-    VERSION = "1.9.22"
+    VERSION = "1.9.23"
   end
 end

data/lib/activefacts/generator/doc/css/glossary-print.css

@@ -0,0 +1,72 @@
+.glossary-toc {
+  display: none;
+}
+
+.glossary-doc h1 {
+  margin-bottom: 1em;
+}
+
+.glossary-doc dt,
+.glossary-facttype > .glossary-reading,
+.glossary-objectification {
+  margin-left: 20px;
+  text-indent: -20px;
+}
+
+.glossary-alternates {
+  font-size: smaller;
+  text-indent: -10px;
+  padding-left: 10px;
+}
+
+.glossary-doc dd .glossary-constraints {
+  margin-left: -40px;	/* Extend the highlight further left */
+  text-indent: 40px;
+}
+
+.glossary-alternates .glossary-reading,
+.glossary-objectification .glossary-reading {
+  display: inline;
+}
+
+.screenheight {
+  margin-bottom: 0px;
+}
+
+.glossary-controls {
+  display:none;
+}
+
+.glossary-doc dd {
+  margin-bottom: 30px;
+  max-height: auto;
+  margin-left: 40px;	/* Indent it from the head term */
+}
+
+.glossary-constraints {
+  /* a block of constraints */
+  margin: 0px 0px 0px 2em;
+  padding: 0px;
+}
+
+.glossary-constraint {
+  text-indent: 2em;
+  font-size: smaller;
+}
+
+.glossary-alternates {
+  font-size: smaller;
+}
+
+.glossary-constraint .constraint {
+  font-style: italic;
+}
+
+.glossary-doc dd .glossary-constraints {
+  margin-left: 0px;
+  text-indent: 0px;
+}
+
+a {
+  text-decoration: none;
+}

data/lib/activefacts/generator/doc/css/glossary.css

@@ -0,0 +1,194 @@
+body {
+  margin: 0px;
+  padding: 0px;
+}
+
+/* Size of sections when dynamically hidden by controls (incl with a transition) */
+.glossary-doc.hide-facts dd { max-height: 0px; margin-bottom: 0px; }
+.glossary-doc.hide-alternates .glossary-alternates { max-height: 0px; }
+.glossary-doc.hide-constraints .glossary-constraints { max-height: 0px; }
+.glossary-doc.hide-examples .glossary-example { max-height: 0px; }
+
+.glossary {
+  position: relative;
+  height: 100%;
+  font-family: "Helvetica Neue", Helvetica, "Arial Unicode MS", Arial, sans-serif;
+}
+
+.glossary-compositions {
+  position: absolute;
+  left: 0px; right: 456px;	  /* as main item with glossary on right */
+  margin-right: 0px;
+  overflow: auto;
+  height: 100%;
+}
+
+.glossary-doc {
+  position: absolute;
+  display: block;
+  background: #FFF;
+  overflow: auto;
+  top: 0px;
+  bottom: 0px;
+}
+
+.glossary-doc > * {
+  padding-left: 20px;
+}
+
+.glossary-doc.glossary-toc-right {
+  /* Table of contents at right */
+  left: 0px; right: 450px;
+  border-right: solid #EEE 3px;
+}
+
+.glossary-doc.glossary-toc-left {
+  /* Table of contents at right */
+  left: 450px; right: 0px;
+}
+
+.glossary-controls
+{
+  /* the glossary is the table of contents for something else */
+  width: 450px; right: 0px;
+  border-left: solid #DDD 3px;
+  border-right: solid #DDD 3px;	  /* To here */
+}
+
+.glossary-doc.glossary-is-toc
+{
+  /* the glossary is the table of contents for something else */
+  width: 450px; right: 0px;
+  border-left: solid #DDD 3px;
+  border-right: solid #DDD 3px;	  /* To here */
+  bottom: 25px;			  /* Leave room for the controls */
+}
+
+.glossary-toc {
+  position: absolute;
+  display: block;
+  height: 100%;
+  margin: 0;
+  border-left: solid #DDD 3px;
+  border-right: solid #DDD 3px;
+  background: #EEE;
+  font-family: "Helvetica Neue", Helvetica, "Arial Unicode MS", Arial, sans-serif;
+}
+
+.glossary-toc.glossary-toc-right {
+  right: 0px; width: 450px;	  /* Sidebar at right */
+}
+
+.glossary-toc.glossary-toc-left {
+  left: 0px; width: 450px;	  /* Sidebar at left */
+}
+
+.glossary-toc.glossary-is-toc {
+  right: 0px; width: 0px;	  /* Hidden */
+}
+
+.glossary-toc-list {
+  position: absolute;
+  top: 0px;
+  bottom: 24px;
+  width: 100%;
+  overflow: auto;
+  margin: 0;
+  padding: 0 0;
+  list-style: none;
+}
+
+.glossary-controls {
+  position: absolute; bottom: 0px;
+  border: solid #DDD 3px;
+  background: #DDD;
+}
+
+.glossary-controls > * {
+  width: 24%;
+  padding: 0px;
+}
+
+.glossary-toc-list li {
+  padding: 0px 1em 0px 1em;
+}
+
+.glossary-toc-list li:hover {
+  background: #DDD;
+}
+
+.glossary-doc dl,
+.screenheight {
+  margin-bottom: 2400px;  /* ensure we can scroll any item to the top of the screen */
+}
+
+/* Hover controls: comment out to leave it under toggle button control */
+.glossary-doc dt:hover + dd,				/* When hovering over the head, show the contents */
+.glossary-doc dd:hover,					/* Keep showing the contents when we slide into it */
+/* .glossary-doc dt:hover + dd .glossary-alternates,	/* Show the alternates when you hover over the head */
+/* .glossary-doc dt:hover + dd .glossary-constraints,	/* Show the constraints when you hover over the head */
+.glossary-doc dt:hover + dd .glossary-example,		/* Show the examples when hovering over the head */
+.glossary-doc dd:hover .glossary-example		/* Keep showing the examples when we slide into the body */
+{ max-height: 2000px;
+  XXmargin-bottom: 30px;  /* ease-out works both ways if animating this :( */
+  background: #DDD;
+}
+
+/* After the hover moves away, wait a while before hiding */
+.glossary-doc dd {
+  transition: max-height 1s;
+  transition-timing-function: ease-out;
+  overflow: hidden;
+  max-height: 2000px;	/* Animate this to zero to hide */
+  margin-bottom: 30px;	/* Some clearance from the next term */
+  margin-left: 40px;	/* Indent it from the head term */
+}
+
+.glossary-doc dd > * {
+  font-size: smaller;
+}
+
+.glossary-doc dt,
+.glossary-facttype > .glossary-reading,
+.glossary-objectification {
+  margin-left: 20px;
+  text-indent: -20px;
+}
+
+.glossary-alternates .glossary-reading,
+.glossary-objectification .glossary-reading
+{
+  display: inline;
+}
+
+.glossary-alternates {
+  font-size: smaller;
+  overflow: hidden;
+  text-indent: -10px;
+  padding-left: 10px;
+}
+
+.glossary-example {
+  overflow: hidden;
+}
+
+.glossary-doc dd .glossary-constraints {
+  margin-left: -40px;	/* Extend the highlight further left */
+  text-indent: 40px;
+}
+
+.glossary-constraints {
+  /* a block of constraints */
+  background: #EDC;
+  padding: 0px;
+  overflow: hidden;
+}
+.glossary-constraint {
+  margin-left: 70px;  /* 30 added to the 40 from above */
+  text-indent: -10px; /* Ensure that wrap is indented */
+  font-size: smaller;
+}
+.glossary-constraint .keyword {
+  background: #EDC;
+  font-style: italic;
+}