activefacts 0.8.6 → 0.8.8

data/spec/norma_sql_spec.rb

@@ -11,14 +11,14 @@ require 'activefacts/persistence'
 require 'activefacts/input/orm'
 require 'activefacts/generate/sql/server'
 
-include ActiveFacts
-include ActiveFacts::Metamodel
-
 describe "NORMA Loader with SQL output" do
+  orm_failures = {
+    "SubtypePI" => "Has an illegal uniqueness join constraint",
+  }
   # Generate and return the SQL for the given vocabulary
   def sql(vocabulary)
     output = StringIO.new
-    @dumper = ActiveFacts::Generate::SQL::SERVER.new(vocabulary.constellation, "norma")
+    @dumper = ActiveFacts::Generate::SQL::SERVER.new(vocabulary.constellation)
     @dumper.generate(output)
     output.rewind
     output.read
@@ -28,9 +28,15 @@ describe "NORMA Loader with SQL output" do
   Dir["examples/norma/#{pattern}.orm"].each do |orm_file|
     expected_file = orm_file.sub(%r{examples/norma/(.*).orm\Z}, 'examples/SQL/\1.sql')
     actual_file = orm_file.sub(%r{examples/norma/(.*).orm\Z}, 'spec/actual/\1.sql')
+    base = File.basename(orm_file, ".orm")
 
     it "should load #{orm_file} and dump SQL matching #{expected_file}" do
-      vocabulary = ActiveFacts::Input::ORM.readfile(orm_file)
+      begin
+        vocabulary = ActiveFacts::Input::ORM.readfile(orm_file)
+      rescue => e
+        raise unless orm_failures.include?(base)
+        pending orm_failures[base]
+      end
 
       # Build and save the actual file:
       sql_text = sql(vocabulary)

data/spec/norma_tables_spec.rb

@@ -7,29 +7,28 @@
 # Copyright (c) 2008 Clifford Heath. Read the LICENSE file.
 #
 
+require 'spec/spec_helper'
 require 'stringio'
 require 'activefacts/vocabulary'
 require 'activefacts/persistence'
 require 'activefacts/support'
 require 'activefacts/input/orm'
 
-include ActiveFacts
-include ActiveFacts::Metamodel
-
-Exceptions = {
-  "Blog" => ["Author", "Comment", "Paragraph", "Post", "Topic"],
-  "JoinEquality" => ["Event", "Seat", "Ticket", "Venue"],
-  "Metamodel" => ["AllowedRange", "Concept", "Constraint", "ContextAccordingTo", "ContextAgreedBy", "ContextNote", "Derivation", "Fact", "FactType", "Instance", "Join", "ParamValue", "Reading", "Role", "RoleRef", "RoleSequence", "RoleValue", "SetComparisonRoles", "Unit", "ValueRestriction" ],
-  "MetamodelNext" => ["AllowedRange", "Constraint", "ContextAccordingTo", "ContextAgreedBy", "ContextNote", "Derivation", "Fact", "FactType", "Instance", "Join", "ParamValue", "Reading", "Role", "RoleRef", "RoleSequence", "RoleValue", "SetComparisonRoles", "Term", "Unit", "ValueConstraint"],
-  "OilSupply" => ["AcceptableSubstitutes", "Month", "ProductionForecast", "RegionalDemand", "TransportRoute"],
-  "Orienteering" => ["Club", "Entry", "Event", "EventControl", "EventScoringMethod", "Map", "Person", "Punch", "PunchPlacement", "Series", "Visit"],
-  "SeparateSubtype" => ["Claim", "VehicleIncident"],
-  "Warehousing" => ["Bin", "DirectOrderMatch", "DispatchItem", "Party", "Product", "PurchaseOrder", "PurchaseOrderItem", "ReceivedItem", "SalesOrder", "SalesOrderItem", "TransferRequest", "Warehouse"],
-  "Portfolio" => ["AnnualDepreciation", "Attachment", "Collateral", "DepreciationSchedule", "Disposal", "Expenditure", "OwnedItem", "Revenue", "Transaction", "Valuation"],
-  "OrienteeringER" => ["Club", "Event", "EventControl", "EventCourse", "Map", "SeriesEvent"],
-  "RedundantDependency" => ["Address", "Politician", "StateOrProvince"],
+# The exceptions table is keyed by the model name, and contains the added and removed table names vs NORMA
+orm_failures = {
 }
-
+norma_table_exceptions = {
+  "Metamodel" => [[], %w{Agreement Enforcement}],                   # ActiveFacts absorbs Agreement into ContextNote, Enforcement into Constraint
+  "MetamodelNext" => [[], %w{Agreement Enforcement}],
+  "Orienteering" => [%w{Punch}, []],                                # NORMA doesn't make a table for the IDENTITY field
+  "OrienteeringER" => [%w{SeriesEvent}, []],                        # NORMA doesn't make a table for the IDENTITY field
+  "RedundantDependency" => [%w{Politician StateOrProvince}, %w{LegislativeDistrict}],   # NORMA doesn't make a table for the 3 IDENTITY fields
+  "SeparateSubtype" => [%w{Claim}, %w{Incident}],                   # NORMA doesn't make a table for the IDENTITY field. Even when Claim is independent, it still doesn't absorb Incident either and I don't know why, must ask Matt.
+  "Warehousing" => [%w{Product Warehouse}, []],                     # NORMA doesn't make a table for the IDENTITY field
+  "ServiceDirector" => [%w{DataStoreService MonitorNotificationUser}, %w{DataStoreFileHostSystem }],
+  
+}
+  
 def extract_created_tables_from_sql sql_file
   File.open(sql_file) do |f|
     f.
@@ -47,28 +46,33 @@ end
 describe "Relational Composition from NORMA" do
   pattern = ENV["AFTESTS"] || "*"
   Dir["examples/norma/#{pattern}.orm"].each do |orm_file|
-    expected_tables = Exceptions[File.basename(orm_file, ".orm")]
-    if !expected_tables
-      sql_file_pattern = orm_file.sub(/\.orm\Z/, '*.sql')
-      sql_file = Dir[sql_file_pattern][0]
-      next unless sql_file
-    end
+    exception = norma_table_exceptions[File.basename(orm_file, ".orm")]
+    sql_file_pattern = orm_file.sub(/\.orm\Z/, '.*sql')
+    sql_file = Dir[sql_file_pattern][0]
+    next unless sql_file
+    base = File.basename(orm_file, ".orm")
 
     it "should load #{orm_file} and compute #{
-        expected_tables ?
-          "the expected list of tables" :
-          "a list of tables similar to those in #{sql_file}"
+        (exception ? "a modified" :  "the same") + " list of tables similar to those in #{sql_file}"
       }" do
 
       # Read the ORM file:
-      vocabulary = ActiveFacts::Input::ORM.readfile(orm_file)
+      begin
+        vocabulary = ActiveFacts::Input::ORM.readfile(orm_file)
+      rescue => e
+        raise unless orm_failures.include?(base)
+        pending orm_failures[base]
+      end
 
       # Get the list of tables from NORMA's SQL:
-      expected_tables ||= extract_created_tables_from_sql(sql_file)
+      expected_tables = extract_created_tables_from_sql(sql_file)
+      if exception
+        expected_tables = expected_tables + exception[0] - exception[1]
+      end
 
       # Get the list of tables from our composition:
       tables = vocabulary.tables
-      table_names = tables.map{|o| o.name }.sort
+      table_names = tables.map{|o| o.name.gsub(/\s/,'')}.sort
 
       # Save the actual and expected composition to files
       actual_tables_file = orm_file.sub(%r{examples/norma/(.*).orm\Z}, 'spec/actual/\1.tables')
@@ -77,7 +81,7 @@ describe "Relational Composition from NORMA" do
       File.open(expected_tables_file, "w") { |f| f.puts expected_tables*"\n" }
 
       # Check that the list matched:
-      table_names.should == expected_tables
+      table_names.should_not differ_from(expected_tables)
 
       # Calculate the columns and column names; REVISIT: check the results
       tables.each do |table|

data/spec/spec_helper.rb

@@ -5,7 +5,10 @@
 #   actual_text.should_not differ_from(expected_text)
 #
 
-require 'spec/helpers/file_matcher.rb'
+require 'spec/helpers/diff_matcher'
+require 'spec/helpers/array_matcher'
+require 'spec/helpers/file_matcher'
+require 'spec/helpers/string_matcher'
 
 class String
   def strip_comments()

data/status.html

@@ -1,7 +1,7 @@
 <!--#include virtual="/header.html" -->
 <!--#include virtual="navbar.html" -->
 
-<link rel="stylesheet" href="css/offline.css" media="screen" type="text/css" />
+<link rel="stylesheet" href="../css/offline.css" media="screen" type="text/css" />
 <div id="sidebar"></div>
 
 <div id="top" class="content">
@@ -11,52 +11,121 @@
     ActiveFacts Project Status
   </h2>
 
+  <h4>Constellation Query Language</h4>
+
   <p>
-  The Constellation Query Language has DDL support sufficient to allow
-  conversion of any ORM2 model. The Ruby generator is complete. The SQL
-  generator is complete, but with a couple of known defects in corner cases.
-  The generated Ruby code has only a partial implementation of the mapping
-  data needed to convert to and from SQL tables, and even that has to be
-  enabled using an option.
+  The Constellation Query Language implementation available in
+  version 0.8.5 compiles all features of ORM2 implemented by NORMA
+  with only minuscule differences. Entity Types, Value Types, Fact
+  Types (including objectified), Reference Modes, and all types of
+  constraints - Value and Role Value Constraints, Presence
+  Constraints (which covers Mandatory, Uniqueness, and Frequency
+  constraints), Subset, Equality, Exclusion, Mandatory Exclusion,
+  and Ring constraints.
   </p>
+  
+  <p> At this version Terms (object type names) may not contain
+  spaces.  Terms may not appear in readings (unless in lower-case)
+  and readings may only contain single adjectives (hyphen-binding).
+  Deontic constraints are recognised using the annotation (otherwise
+  <b>action</b>). Join Constraints may also be defined beyond those
+  available in NORMA.  Example data may be declared.  </p>
 
   <p>
-  CQL is not yet handling imported vocabularies, example fact populations or
-  value type units yet. It has limited model validation facilities, and it's
-  not yet possible to add a new reading to an existing fact type.  It's also
-  only parsing query syntax, with no semantic analysis or SQL generation.
+  This version provides functionality not available in NORMA. Additions
+  include:
   </p>
+  <ul>
+  <li> Business Context Notes, which are annotations indicating why a
+      particular modeling construct was used, and who approved that.
+  </li>
+  <li> Definition of Units using conversion formulae.  A library of
+      500 standard unit conversions is provided.  </li>
+  <li> Value Types may be defined to utilise those units. </li>
+  </ul>
 
   <p>
-  The Constellation API (in Ruby) supports the generated Ruby code, allowing
-  any fact population to be constructed for a given vocabulary.  There is
-  not yet any support within the API for database persistence, but that's
-  coming up for implementation soon.
+  New features are being developed for an upcoming 0.9.0 release:
   </p>
+  <ul>
+  <li> Multi-word terms, and multiple adjectives.
+  <li> Improvements on the use of the hyphen to allow hyphenated words in readings.
+  <li> Term Synonyms
+  <li> Imported vocabularies (including multi-lingual versioning)
+  <li> Improved model validation
+  </ul>
 
   <p>
-  The Metamodel is generated to Ruby from CQL or ORM2 to support the
-  creation and manipulation of any semantic model. Some changes are upcoming
-  to support a vocabulary that provides a translation of an existing
-  vocabulary, such as a Dutch or Japanese version of an English language
-  model.
+  Beyond that, the query syntax will be completed and queries will be generated
+  to SQL.
   </p>
 
+  <h4>Constellation Query Language generators</h4>
+
+  <p>
+  The CQL generator allows conversion of NORMA files. At the present release,
+  deontic constraints and example fact populations are not emitted.
+  </p>
+
+  <p>
+  The Ruby generator is functional. Not all constraints are emitted to Ruby yet,
+  but any combination of facts allowed by the vocabulary may be represented.
+  </p>
+  
   <p>
+  The SQL generators are generating correct and useful SQL, using a relational
+  mapping algorithm that produces similar results to NORMA. This algorithm will
+  be extended to emit more constraints, and to provide more control over
+  the generation of object names, and to directly support Ruby on Rails.
+  Deontic constraints are still handled as Alethic.
+  </p>
+
+  <h4>The Constellation API</h4>
+
+  <p>
+  The Constellation API (in Ruby) supports the generated Ruby code, by
+  allowing any fact population to be asserted into a constellation for
+  a given vocabulary. The generated Ruby module for a vocabulary can be
+  told which object types are tables in the SQL, and can infer all the
+  column names and object mappings from that.
+  </p>
+  
+  <p> Processing of the retract operation (which removes facts from a
+  constellation) does not yet propagate retraction through mandatory roles.
+  There is not yet a validate operation to verify that all verifible
+  constraints are met.  Where a constellation is known to be
+  incomplete, that's not yet able to be recorded (this will be used
+  in determining which constraints can be checked)
+  There is not yet any support within the API for database persistence
+  (creating a constellation from query results, and creating, deleting or
+  updating database rows by saving a constellation).
+  </p>
+
+  <h4>The ORM2 Metamodel</h4>
+
+  <p>
+  The ORM2 Metamodel is generated to Ruby from CQL or ORM2 to support
+  the creation and manipulation of any semantic model. Some changes are
+  upcoming to support synonyms, including allowing a vocabulary to
+  provide a translation of an existing vocabulary, such as a Dutch or
+  Japanese version of an English language model.
+  </p>
+
+  <!--p>
   ActiveFacts can currently read models from NORMA, which are in elementary
   form, and it can reverse engineer the schemas of existing databases in SQL
   Server, DB2, Oracle, and open-source databases not yet tested including
   MySQL, PostgreSQL, etc.  Reverse-engineered models are still in composite
   form - the mapping to elementary form is incomplete.  Reverse engineering
   does not yet analyse actual data.
-  </p>
+  </p-->
 
-  <p>
+  <!--p>
   ActiveFacts has no database adapter infrastructure yet. The
   previously-available reverse engineering tools used used the
   infrastructure of ActiveRecord with DRYSql and Composite Primary Keys, but
   future versions will probably just use the ActiveRecord adapters directly.
-  </p>
+  </p-->
 
   <!--p>
   APRIMO allows the definition of vocabulary aspects as well as the addition

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: activefacts
 version: !ruby/object:Gem::Version 
-  version: 0.8.6
+  hash: 47
+  prerelease: false
+  segments: 
+  - 0
+  - 8
+  - 8
+  version: 0.8.8
 platform: ruby
 authors: 
 - Clifford Heath
@@ -9,58 +15,80 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-09 00:00:00 +10:00
+date: 2010-08-09 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: treetop
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 1
+        - 4
+        - 1
         version: 1.4.1
-    version: 
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: newgem
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
         version: 1.5.2
-    version: 
+  type: :development
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
+        - 3
         version: 2.3.3
-    version: 
+  type: :development
+  version_requirements: *id004
 description: |
   
-  ActiveFacts is a semantic modeling toolkit, comprising an implementation
-  of the Constellation Query Language, the Constellation API, and code
-  generators that receive CQL or ORM (Object Role Modeling files, from
-  NORMA) to emit CQL, Ruby and SQL.
-  
-  Semantic modeling is a refinement of fact-based modeling techniques
-  that draw on natural language verbalisation and formal logic. Fact
-  based modeling is essentially the same as relational modeling in the
-  sixth normal form. The tools provided here automatically condense
-  that to third normal form for efficient storage. They also generate
-  object models as a Ruby module which has an effective mapping to
-  both the original semantic model and to the generated SQL.
-  
-  The result is a formal language that reads like plain English, and
-  allows creation of relational and object models that are guaranteed
-  equivalent, and much more stable in the face of schema evolution than
-  SQL is.
+  ActiveFacts provides a semantic modeling language, the Constellation
+  Query Language (CQL).  CQL combines natural language verbalisation and
+  formal logic, producing a formal language that reads like plain
+  English. ActiveFacts converts semantic models from CQL to relational
+  and object models in SQL, Ruby and other languages.
 
 email: 
 - cjh@dataconstellation.org
@@ -90,16 +118,33 @@ files:
 - examples/CQL/Blog.cql
 - examples/CQL/CompanyDirectorEmployee.cql
 - examples/CQL/Death.cql
+- examples/CQL/Diplomacy.cql
 - examples/CQL/Genealogy.cql
+- examples/CQL/Insurance.cql
+- examples/CQL/JoinEquality.cql
 - examples/CQL/Marriage.cql
 - examples/CQL/Metamodel.cql
+- examples/CQL/MetamodelNext.cql
+- examples/CQL/Monogamy.cql
+- examples/CQL/MonthInSeason.cql
+- examples/CQL/Moon.cql
 - examples/CQL/MultiInheritance.cql
+- examples/CQL/NonRoleId.cql
+- examples/CQL/OddIdentifier.cql
 - examples/CQL/OilSupply.cql
+- examples/CQL/OneToOnes.cql
 - examples/CQL/Orienteering.cql
+- examples/CQL/OrienteeringER.cql
 - examples/CQL/PersonPlaysGame.cql
+- examples/CQL/RedundantDependency.cql
 - examples/CQL/SchoolActivities.cql
+- examples/CQL/SeparateSubtype.cql
+- examples/CQL/ServiceDirector.cql
 - examples/CQL/SimplestUnary.cql
 - examples/CQL/SubtypePI.cql
+- examples/CQL/Supervision.cql
+- examples/CQL/Tests.Test5.Load.cql
+- examples/CQL/WaiterTips.cql
 - examples/CQL/Warehousing.cql
 - examples/CQL/WindowInRoomInBldg.cql
 - examples/CQL/unit.cql
@@ -134,10 +179,16 @@ files:
 - lib/activefacts/cql/Terms.treetop
 - lib/activefacts/cql/ValueTypes.treetop
 - lib/activefacts/cql/compiler.rb
+- lib/activefacts/cql/compiler/constraint.rb
+- lib/activefacts/cql/compiler/entity_type.rb
+- lib/activefacts/cql/compiler/fact.rb
+- lib/activefacts/cql/compiler/fact_type.rb
+- lib/activefacts/cql/compiler/reading.rb
+- lib/activefacts/cql/compiler/shared.rb
+- lib/activefacts/cql/compiler/value_type.rb
 - lib/activefacts/cql/parser.rb
 - lib/activefacts/generate/absorption.rb
 - lib/activefacts/generate/cql.rb
-- lib/activefacts/generate/cql/html.rb
 - lib/activefacts/generate/null.rb
 - lib/activefacts/generate/oo.rb
 - lib/activefacts/generate/ordered.rb
@@ -159,8 +210,8 @@ files:
 - lib/activefacts/vocabulary.rb
 - lib/activefacts/vocabulary/extensions.rb
 - lib/activefacts/vocabulary/metamodel.rb
+- lib/activefacts/vocabulary/verbaliser.rb
 - script/txt2html
-- spec/absorption_ruby_spec.rb
 - spec/absorption_spec.rb
 - spec/api/autocounter.rb
 - spec/api/constellation.rb
@@ -170,6 +221,8 @@ files:
 - spec/api/value_type.rb
 - spec/api_spec.rb
 - spec/cql/context_spec.rb
+- spec/cql/deontic_spec.rb
+- spec/cql/matching_spec.rb
 - spec/cql/samples_spec.rb
 - spec/cql/unit_spec.rb
 - spec/cql_cql_spec.rb
@@ -179,9 +232,15 @@ files:
 - spec/cql_sql_spec.rb
 - spec/cql_symbol_tables_spec.rb
 - spec/cqldump_spec.rb
+- spec/helpers/array_matcher.rb
+- spec/helpers/ctrl_c_support.rb
+- spec/helpers/diff_matcher.rb
 - spec/helpers/file_matcher.rb
+- spec/helpers/string_matcher.rb
+- spec/helpers/test_parser.rb
 - spec/norma_cql_spec.rb
 - spec/norma_ruby_spec.rb
+- spec/norma_ruby_sql_spec.rb
 - spec/norma_sql_spec.rb
 - spec/norma_tables_spec.rb
 - spec/spec.opts
@@ -195,6 +254,7 @@ licenses: []
 post_install_message: For more information on ActiveFacts, see http://dataconstellation.com/ActiveFacts
 rdoc_options: 
 - -S
+- -S
 - -T
 - hanna
 - -A
@@ -210,21 +270,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: cjheath@rubyforge.org
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A semantic modeling and query language (CQL) and application runtime (the Constellation API)