activefacts 0.8.16 → 0.8.18

data/lib/activefacts/generate/helpers/rails.rb

@@ -0,0 +1,57 @@
+module ActiveFacts
+  module Generate
+    module Rails
+      module Helpers
+	def rails_plural_name name
+	  # Crunch spaces and pluralise the first part, all in snake_case
+	  name.pop if name.is_a?(Array) and name.last == []
+	  name = name[0]*'_' if name.is_a?(Array) and name.size == 1
+	  if name.is_a?(Array)
+	    name = ActiveSupport::Inflector.tableize((name[0]*'_').gsub(/\s+/, '_')) +
+	      '_' +
+	      ActiveSupport::Inflector.underscore((name[1..-1].flatten*'_').gsub(/\s+/, '_'))
+	  else
+	    ActiveSupport::Inflector.tableize(name.gsub(/\s+/, '_'))
+	  end
+	end
+
+	def rails_singular_name name
+	  # Crunch spaces and convert to snake_case
+	  name = name.flatten*'_' if name.is_a?(Array)
+	  ActiveSupport::Inflector.underscore(name.gsub(/\s+/, '_'))
+	end
+
+	def rails_class_name name
+	  name = name*'_' if name.is_a?(Array)
+	  ActiveSupport::Inflector.camelize(name.gsub(/\s+/, '_'))
+	end
+
+      end
+    end
+  end
+
+  module Metamodel
+    class ObjectType
+    end
+  end
+
+  module Persistence
+    class ForeignKey
+      include Generate::Rails::Helpers
+
+      def rails_from_association_name
+	rails_singular_name(to_name.join('_'))
+      end
+
+      def rails_to_association
+	jump = jump_reference
+	if jump.is_one_to_one
+	  [ "has_one", rails_singular_name(from_name)]
+	else
+	  [ "has_many", rails_plural_name(from_name)]
+	end
+      end
+
+    end
+  end
+end

data/lib/activefacts/generate/html/glossary.rb

@@ -39,39 +39,127 @@ module ActiveFacts
         end
 
         def vocabulary_start
-          puts "<link rel='stylesheet' href='css/orm2.css' media='screen' type='text/css'/>"
-          puts "<h1>#{@vocabulary.name}</h1>"
-          puts "<dl>"
+          # puts "<link rel='stylesheet' href='css/orm2.css' media='screen' type='text/css'/>"
+	  File.open(File.dirname(__FILE__)+"/../../../../css/orm2.css") do |f|
+	    puts "<style media='screen' type='text/css'>"
+	    puts f.read
+	    puts %Q{
+	      .glossary-facttype, .glossary-constraints { display: block; }
+	      .glossary-doc.hide-alternates .glossary-alternates { display: none; }
+	      .glossary-doc.hide-constraints .glossary-constraints { display: none; }
+	      .glossary-doc.hide-examples .glossary-example { display: none; }
+	    }.gsub(/^\s+/, '')
+	    puts "</style>"
+	  end
+
+	  puts %Q{
+	    <style media='print' type='text/css'>
+	    .keyword { color: #0000CC; font-style: italic; display: inline; }
+	    .vocabulary, .object_type { color: #8A0092; font-weight: bold; }
+	    .copula { color: #0E5400; }
+	    .value { color: #FF990E; display: inline; }
+	    .glossary-toc { display: none; }
+	    .glossary-facttype, .glossary-reading { display: inline; }
+	    </style>
+	  }.gsub(/^\s+/, '')
         end
 
         def vocabulary_end
-          puts "</dl>"
+	  puts %Q{
+	  <script type="text/javascript">
+	  function toggle_class(e, c) {
+	    if (!e) return;
+	    var n = e.className;
+	    var i = n.indexOf(c);
+	    if (i == -1) {
+	      e.className = n+' '+c;
+	    } else {
+	      e.className = n.slice(0, i)+n.slice(i+c.length);
+	    }
+	    if (document.location.toString().indexOf('#') >= 0)
+	      document.location = document.location; // Re-scroll to the current fragment
+	  }
+	  function toggle_constraints() {
+	    toggle_class(document.getElementById('glossary-doc'), 'hide-constraints');
+	  }
+	  function toggle_alternates() {
+	    toggle_class(document.getElementById('glossary-doc'), 'hide-alternates');
+	  }
+	  function toggle_examples() {
+	    toggle_class(document.getElementById('glossary-doc'), 'hide-examples');
+	  }
+	  </script>
+	  }.gsub(/^\s+/, '')
         end
 
         def object_types_dump
-          @vocabulary.
-            all_object_type.
-            sort_by{|o| o.name.gsub(/ /,'').downcase}.
-            each do |o|
-              case o
-              when ActiveFacts::Metamodel::TypeInheritance
-                nil
-              when ActiveFacts::Metamodel::ValueType
-                value_type_dump(o)
-              else
-                if o.fact_type
-                  objectified_fact_type_dump(o)
-                else
-                  entity_type_dump(o)
-                end
-              end
-            end
-        end
+	  all_object_type =
+	    @vocabulary.
+	      all_object_type.
+	      sort_by{|o| o.name.gsub(/ /,'').downcase}
+
+	  # Put out a table of contents first:
+	  puts '<div class="glossary-sidebar">'
+	  puts '<ol class="glossary-toc">'
+	  all_object_type.
+	  reject do |o|
+	    o.name == '_ImplicitBooleanValueType' or
+	    o.kind_of?(ActiveFacts::Metamodel::ValueType) && o.all_role.size == 0 or
+	    o.kind_of?(ActiveFacts::Metamodel::TypeInheritance)
+	  end.
+	    each do |o|
+	      puts "<li>#{termref(o.name)}</li>"
+	    end
+	  puts '</ol>'
+	  puts '<div class="glossary-controls">'
+	  puts '  <input type="button" onclick="toggle_constraints()" value="Constraints" class="glossary-toggle-constraint">'
+	  puts '  <input type="button" onclick="toggle_alternates()" value="Alternates" class="glossary-toggle-alternates">'
+	  puts '  <input type="button" onclick="toggle_examples()" value="Examples" class="glossary-toggle-examples">'
+	  puts '</div>'
+	  puts '</div>'
+
+	  puts '<div class="glossary-doc hide-alternates hide-constraints" id="glossary-doc">'
+	    puts "<h1>#{@vocabulary.name}</h1>"
+	    puts '<dl>'
+	    all_object_type.
+	      each do |o|
+		case o
+		when ActiveFacts::Metamodel::TypeInheritance
+		  nil
+		when ActiveFacts::Metamodel::ValueType
+		  value_type_dump(o)
+		else
+		  if o.fact_type
+		    objectified_fact_type_dump(o)
+		  else
+		    entity_type_dump(o)
+		  end
+		end
+	      end
+	    puts '</dl>'
+	  puts '</div>'
+	end
 
         def element(text, attrs, tag = 'span')
           "<#{tag}#{attrs.empty? ? '' : attrs.map{|k,v| " #{k}='#{v}'"}*''}>#{text}</#{tag}>"
         end
 
+	def span(text, klass = nil)
+	  element(text, klass ? {:class => klass} : {})
+	end
+
+	def div(text, klass = nil)
+	  element(text, klass ? {:class => klass} : {}, 'div')
+	end
+
+	def h1(text, klass = nil)
+	  element(text, klass ? {:class => klass} : {}, 'h1')
+	end
+
+	def dl(text, klass = nil)
+	  element(text, klass ? {:class => klass} : {}, 'dl')
+	end
+
         # A definition of a term
         def termdef(name)
           element(name, {:name => name, :class => 'object_type'}, 'a')
@@ -89,30 +177,75 @@ module ActiveFacts
         end
 
         def value_type_dump(o)
-          return if o.all_role.size == 0  # Skip value types that are only used as supertypes
+          return if o.all_role.size == 0 or  # Skip value types that are only used as supertypes
+	    o.name == '_ImplicitBooleanValueType'
           puts "  <dt>" +
-            "Value Type: #{termdef(o.name)}" +
-            (o.supertype ? " (written as #{termref(o.supertype.name)})" : "") +
+            "#{termdef(o.name)} " +
+	    (if o.supertype
+	      span('is written as ', :keyword) + termref(o.supertype.name)
+	    else
+	      " (a fundamental data type)"
+	    end) +
             "</dt>"
 
           puts "  <dd>"
+	  value_sub_types(o)
           relevant_facts_and_constraints(o)
+	  values(o)
           puts "  </dd>"
         end
 
+	def value_sub_types(o)
+	  o.
+	    all_value_type_as_supertype.    # All value types for which o is a supertype
+	    sort_by{|sub| sub.name}.
+	    each do |sub|
+	      puts div(
+		"#{termref(sub.name)} #{span('is written as', 'keyword')} #{termref(o.name)}",
+		'glossary-facttype'
+	      )
+	    end
+	end
+
+	def values(o)
+	  o.all_instance.
+	  sort_by{|i|
+	    [i.population.name, i.value.literal]
+	  }.
+	  each do |i|
+	    v = i.value
+	    puts div(
+		(i.population.name.empty? ? '' : i.population.name+': ') +
+		termref(o.name) + ' ' +
+		div(
+		# v.is_literal_string ? v.literal.inspect : v.literal,
+		  v.literal.inspect,
+		  'value'
+		),
+		'glossary-example'
+	      )
+	  end
+	end
+
         def relevant_facts_and_constraints(o)
           puts(
             o.
               all_role.
               map{|r| r.fact_type}.
               uniq.
-              reject{|ft| ft.is_a?(ActiveFacts::Metamodel::TypeInheritance) || ft.is_a?(ActiveFacts::Metamodel::ImplicitFactType) }.
-              map { |ft| "    #{fact_type_with_constraints(ft, o)}</br>" }.
-              sort * "\n"
+              reject do |ft|
+		ft.is_a?(ActiveFacts::Metamodel::LinkFactType)
+	      end.
+              map { |ft| [ft, "    #{fact_type_with_constraints(ft, o)}"] }.
+              sort_by{|ft, text|
+		[ ft.is_a?(ActiveFacts::Metamodel::TypeInheritance) ? 0 : 1, text]
+	      }.
+	      map{|ft, text| text}.
+	      join "\n"
           )
         end
 
-        def role_ref rr, freq_con, l_adj, name, t_adj, role_name_def, literal
+        def role_ref(rr, freq_con, l_adj, name, t_adj, role_name_def, literal)
           term_parts = [l_adj, termref(name), t_adj].compact
           [
             freq_con ? element(freq_con, :class=>:keyword) : nil,
@@ -122,30 +255,67 @@ module ActiveFacts
           ]
         end
 
-        def expand_reading(r)
+        def expand_reading(reading, include_rolenames = true)
           element(
-            r.expand do |*a|
-              role_ref(*a)
+            reading.expand([], include_rolenames) do |rr, freq_con, l_adj, name, t_adj, role_name_def, literal|
+	      if role_name_def
+		role_name_def = role_name_def.gsub(/\(as ([^)]+)\)/) {
+		  span("(as #{ termref(rr.role.object_type.name, $1) })", 'keyword')
+		}
+	      end
+              role_ref rr, freq_con, l_adj, name, t_adj, role_name_def, literal
             end,
             {:class => 'copula'}
           )
         end
 
-        def fact_type(ft, wrt = nil)
+        def fact_type_block(ft, include_alternates = true, wrt = nil, include_rolenames = true)
+	  div(fact_type(ft, include_alternates, wrt, include_rolenames), 'glossary-facttype')
+	end
+
+        def fact_type(ft, include_alternates = true, wrt = nil, include_rolenames = true)
           role = ft.all_role.detect{|r| r.object_type == wrt}
           preferred_reading = ft.reading_preferably_starting_with_role(role)
           alternate_readings = ft.all_reading.reject{|r| r == preferred_reading}
-          expand_reading(preferred_reading) +
-            (alternate_readings.size > 0 ?
-              ' (alternatively, ' +
-              alternate_readings.map { |r| expand_reading(r)}*', ' +
-              ')' : '')
+
+	  div(
+	    expand_reading(preferred_reading, include_rolenames),
+	    'glossary-reading'
+	  )+
+	  (if include_alternates and alternate_readings.size > 0
+	    div(
+	      "(alternatively: " +
+	      alternate_readings.map do |reading|
+		div(
+		  expand_reading(reading, include_rolenames),
+		  'glossary-reading'
+		)
+	      end*",\n"+')',
+	      'glossary-alternates'
+	    )
+	  else
+	    ''
+	  end
+	  )
         end
 
         def fact_type_with_constraints(ft, wrt = nil)
-          fact_type(ft, wrt) +
-            "<br/>\n<ul>\n" +
-            fact_type_constraints(ft) +
+	  if ft.entity_type
+	    div(
+	      termref(ft.entity_type.name) +
+		div(' is where ', 'keyword') +
+		fact_type(ft, true, wrt),
+	      'glossary-objectification'
+	    )
+	  else
+	    fact_type_block(ft, true, wrt)
+	  end +
+            %Q{\n<ul class="glossary-constraints">\n}+
+	    (unless ft.is_a?(ActiveFacts::Metamodel::TypeInheritance)
+	      fact_type_constraints(ft)
+	    else
+	      ''
+	    end) +
             "</ul>"
         end
 
@@ -157,25 +327,29 @@ module ActiveFacts
                 reading.role_sequence.all_role_ref_in_order[reading.role_numbers[-1]].role == residual_role
               }
             next nil unless reading
-            element(
-              reading.expand_with_final_presence_constraint { |*a| role_ref(*a) },
-              {:class => 'copula'}
-            )+"<br/>\n"
+	    div(
+	      element(
+		reading.expand_with_final_presence_constraint { |*a| role_ref(*a) },
+		{:class => 'copula'}
+	      ),
+	      'glossary-constraint'
+	    )+"\n"
           end.compact*''
         end
 
         def objectified_fact_type_dump(o)
           puts "  <dt>" +
-            "Entity Type: #{termdef(o.name)}" +
-            " (objectification of #{fact_type(o.fact_type)})" +
+            "#{termdef(o.name)}" +
+            # " (#{span('in which', 'keyword')} #{fact_type(o.fact_type, false, nil, nil)})" +
             "</dt>"
           # REVISIT: Handle separate identification
 
           puts "  <dd>"
-          puts fact_type_constraints(o.fact_type)
+	  puts fact_type_with_constraints(o.fact_type)
+
           o.fact_type.all_role_in_order.each do |r|
             n = r.object_type.name
-            puts "#{termref(o.name)} involves exactly one #{termref(r.role_name || n, n)}<br/>"
+            puts div("#{termref(o.name)} involves #{span('one', 'keyword')} #{termref(r.role_name || n, n)}", "glossary-facttype")
           end
           relevant_facts_and_constraints(o)
           puts "  </dd>"
@@ -189,21 +363,67 @@ module ActiveFacts
           end
 
           puts "  <dt>" +
-            "Entity Type: #{termdef(o.name)}" +
-            " (" +
+            "#{termdef(o.name)} " +
             [
-              (supers.size > 0 ? "Subtype of #{supers.map{|s| s.name}*', '})" : nil),
-              (pi ? "identified by "+pi.role_sequence.describe : nil)
+              (supers.size > 0 ? "#{span('is a kind of', 'keyword')} #{supers.map{|s| termref(s.name)}*', '}" : nil),
+              (if pi
+		"#{span('is identified by', 'keyword')} " +
+		pi.role_sequence.all_role_ref_in_order.map do |rr|
+		  termref(
+		    rr.role.object_type.name,
+		    [ rr.leading_adjective,
+		      rr.role.role_name || rr.role.object_type.name,
+		      rr.trailing_adjective
+		    ].compact*'-'
+		  )
+		end*", "
+	      else
+		nil
+	      end)
             ].compact*', '
-            ")" +
             "</dt>"
 
           puts "  <dd>"
           relevant_facts_and_constraints(o)
+	  entities(o)
           puts "  </dd>"
         end
 
+	def entities(o)
+	  return if o.preferred_identifier.role_sequence.all_role_ref.size > 1 # REVISIT: Composite identification
+	  o.all_instance.each do |i|
+	    v = i.value
+	    ii = i    # The identifying instance
+
+	    until v
+	      pi = ii.object_type.preferred_identifier		  # ii is an Entity Type
+	      break if pi.role_sequence.all_role_ref.size > 1	  # REVISIT: Composite identification
+
+	      identifying_fact_type = pi.role_sequence.all_role_ref.single.role.fact_type
+	      # Find the role played by this instance through which it is identified:
+	      irv = i.all_role_value.detect{|rv| rv.fact.fact_type == identifying_fact_type }
+	      # Get the other RoleValue in what must be a binary fact type:
+	      orv = irv.fact.all_role_value.detect{|rv| rv != irv}
+	      ii = orv.instance
+	      v = ii.value    # Does this instance have a value? If so, we're done.
+	    end
+
+	    next unless v
+	    puts div(
+		(i.population.name.empty? ? '' : i.population.name+': ') +
+		termref(o.name) + ' ' +
+		div(
+		# v.is_literal_string ? v.literal.inspect : v.literal,
+		  v.literal.inspect,
+		  'value'),
+		'glossary-example'
+	      )
+	  end
+	end
+
       end
     end
   end
 end
+
+ActiveFacts::Registry.generator('html/glossary', ActiveFacts::Generate::HTML::GLOSSARY)