activefacts 1.6.0 → 1.7.1

data/spec/norma_sql_spec.rb

@@ -1,57 +0,0 @@
-#
-# ActiveFacts tests: Parse all CQL files and check the generated Ruby.
-# Copyright (c) 2008 Clifford Heath. Read the LICENSE file.
-#
-
-require 'spec_helper'
-require 'stringio'
-require 'activefacts/vocabulary'
-require 'activefacts/support'
-require 'activefacts/persistence'
-require 'activefacts/input/orm'
-require 'activefacts/generate/sql/server'
-
-describe "NORMA Loader with SQL output" do
-  orm_failures = {
-    "SubtypePI" => "Has an illegal uniqueness constraint",
-  }
-  # Generate and return the SQL for the given vocabulary
-  def sql(vocabulary)
-    output = StringIO.new
-    @dumper = ActiveFacts::Generate::SQL::SERVER.new(vocabulary.constellation)
-    @dumper.generate(output)
-    output.rewind
-    output.read
-  end
-
-  pattern = ENV["AFTESTS"] || "*"
-  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")
-
-    next unless ENV["AFTESTS"] || File.exists?(expected_file)
-
-    it "should load #{orm_file} and dump SQL matching #{expected_file}" do
-      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)
-      Dir.mkdir "spec/actual" rescue nil
-      File.open(actual_file, "w") { |f| f.write sql_text }
-
-      pending("expected output file #{expected_file} not found") unless File.exists? expected_file
-
-      expected_text = File.open(expected_file) {|f| f.read }
-      sql_text.gsub!(/ INDEX (\[[^\]]*\]|`[^`]*`|[^ ]*) ON /, ' INDEX <Name is hidden> ON ')
-      expected_text.gsub!(/ INDEX (\[[^\]]*\]|`[^`]*`|[^ ]*) ON /, ' INDEX <Name is hidden> ON ')
-      sql_text.should_not differ_from(expected_text)
-      File.delete(actual_file)  # It succeeded, we don't need the file.
-    end
-  end
-end

data/spec/norma_tables_spec.rb

@@ -1,95 +0,0 @@
-#
-# ActiveFacts test:
-#
-# Parse all NORMA files, compute the composition (list of tables)
-# and compare that with NORMA's output.
-#
-# Copyright (c) 2008 Clifford Heath. Read the LICENSE file.
-#
-
-require 'spec_helper'
-require 'stringio'
-require 'activefacts/vocabulary'
-require 'activefacts/persistence'
-require 'activefacts/support'
-require 'activefacts/input/orm'
-
-# The exceptions table is keyed by the model name, and contains the added and removed table names vs NORMA
-orm_failures = {
-}
-norma_table_exceptions = {
-  "Corporate" => [%w{}, %w{Comment ContactReport ID Money Name Nr Photo ReferenceCheck Resource TimeDivision}],          # ActiveFacts absorbs Agreement into ContextNote, Enforcement into Constraint, lots into Concept
-  "Metamodel" => [%w{Query}, %w{Agreement Enforcement Comment ContactReport ID Money Nr Photo ReferenceCheck Resource TimeDivision Constraint ContextNote Fact Instance Query Unit}],          # ActiveFacts absorbs Agreement into ContextNote, Enforcement into Constraint, lots into Concept
-  "MetamodelNext" => [[], %w{Agreement Enforcement TypeInheritance}],
-  "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
-  "Warehousing" => [%w{Product Warehouse}, %w{Dispatch Receipt}],                     # NORMA doesn't make a table for the IDENTITY field
-  "ServiceDirector" => [%w{DataStoreService MonitorNotificationUser}, %w{DataStoreFileHostSystem }],
-  "SeparateSubtype" => [%w{Claim}, %w{Incident}],
-}
-  
-def extract_created_tables_from_sql sql_file
-  File.open(sql_file) do |f|
-    f.
-    readlines.
-    select do |l|
-      l =~ /CREATE TABLE/
-    end.
-    map do |l|
-      l.chomp.gsub(/.*CREATE TABLE\s+\W*(\w+\.)?"?(\w+)"?.*/, '\2')
-    end.
-    sort
-  end
-end
-
-describe "Relational Composition from NORMA" do
-  pattern = ENV["AFTESTS"] || "*"
-  Dir["examples/norma/#{pattern}.orm"].each do |orm_file|
-    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 #{
-        (exception ? "a modified" :  "the same") + " list of tables similar to those in #{sql_file}"
-      }" do
-
-      # Read the 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)
-      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.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')
-      File.open(actual_tables_file, "w") { |f| f.puts table_names*"\n" }
-      expected_tables_file = orm_file.sub(%r{examples/norma/(.*).orm\Z}, 'spec/actual/\1.expected.tables')
-      File.open(expected_tables_file, "w") { |f| f.puts expected_tables*"\n" }
-
-      # Check that the list matched:
-      table_names.should_not differ_from(expected_tables)
-
-      # Calculate the columns and column names; REVISIT: check the results
-      tables.each do |table|
-        table.columns
-      end
-
-      File.delete(actual_tables_file)
-      File.delete(expected_tables_file)
-    end
-  end
-end

data/spec/ruby_api_spec.rb

@@ -1,23 +0,0 @@
-#
-# ActiveFacts tests: Compare column lists created by aborption and by generated Ruby.
-# Copyright (c) 2008 Clifford Heath. Read the LICENSE file.
-#
-
-require 'spec_helper'
-require 'stringio'
-require 'activefacts/vocabulary'
-require 'activefacts/support'
-
-describe "Requiring vocabularies in Ruby" do
-  ruby_failures = {
-    "MetamodelNext" => "Has a duplicate role name",
-  }
-  pattern = ENV["AFTESTS"] || "*"
-  Dir["examples/ruby/#{pattern}.rb"].each do |ruby_file|
-    base = File.basename(ruby_file, ".rb")
-    next if ruby_failures.include?(base)
-    it "#{ruby_file} should load cleanly" do
-      require "./"+ruby_file
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,35 +0,0 @@
-#
-# A Custom Matcher for RSpec that shows the difference between two multi-line strings.
-#
-# Usage:
-#   actual_text.should_not differ_from(expected_text)
-#
-
-require 'helpers/diff_matcher'
-require 'helpers/array_matcher'
-require 'helpers/file_matcher'
-require 'helpers/string_matcher'
-require 'helpers/parse_to_ast_matcher'
-
-Dir[File.dirname(__FILE__)+"/helpers/**rb"].each do |helper| require helper; end
-
-class String
-  def strip_comments()
-    c_comment = %r{/\*((?!\*/).)*\*/}m
-    gsub(c_comment, '').gsub(%r{\n\n+},"\n")
-  end
-end
-
-class Array
-  def diff_strings(a2)
-    d = Diff::LCS::diff(self, a2)
-    d.map do |chunk|
-      added_at = (add = chunk.detect{|d| d.action == '+'}) && add.position+1
-      removed_at = (remove = chunk.detect{|d| d.action == '-'}) && remove.position+1
-      "Line #{added_at}/#{removed_at}:\n"+
-      chunk.map do |change|
-        "#{change.action} #{change.element}"
-      end*"\n"
-    end*"\n"
-  end
-end

data/spec/transform_surrogate_spec.rb

@@ -1,59 +0,0 @@
-#
-# ActiveFacts tests: Parse all CQL files and check the surrogate key transformation
-# Copyright (c) 2012 Clifford Heath. Read the LICENSE file.
-#
-
-require 'spec_helper'
-require 'stringio'
-require 'activefacts/vocabulary'
-require 'activefacts/support'
-require 'activefacts/input/cql'
-require 'activefacts/generate/absorption'
-require 'activefacts/generate/transform/surrogate'
-
-describe "CQL Loader with Surrogate transformation" do
-  cql_failures = {
-  }
-
-  pattern = ENV["AFTESTS"] || "*"
-  Dir["examples/CQL/#{pattern}.cql"].each do |cql_file|
-    expected_file = cql_file.sub(%r{/CQL/(.*).cql\Z}, '/transform-surrogate/\1.transform-surrogate')
-    actual_file = cql_file.sub(%r{examples/CQL/(.*).cql\Z}, 'spec/actual/\1.transform-surrogate')
-
-    next unless ENV["AFTESTS"] || File.exists?(expected_file)
-
-    it "should load #{cql_file} and make transformations like #{expected_file}" do
-      vocabulary = nil
-      broken = cql_failures[File.basename(cql_file, ".cql")]
-      if broken
-        pending(broken) {
-          vocabulary = ActiveFacts::Input::CQL.readfile(cql_file)
-        }
-      else
-        vocabulary = ActiveFacts::Input::CQL.readfile(cql_file)
-      end
-      vocabulary.finalise
-
-      # Build and save the actual file:
-      output = StringIO.new
-
-      transformer = ActiveFacts::Generate::Transform::Surrogate.new(vocabulary)
-      transformer.generate(output)
-
-      absorption = ActiveFacts::Generate::Absorption.new(vocabulary)
-      absorption.generate(output)
-
-      # Save the output from the StringIO:
-      output.rewind
-      transformed_text = output.read
-      Dir.mkdir "spec/actual" rescue nil
-      File.open(actual_file, "w") { |f| f.write transformed_text }
-
-      pending("expected output file #{expected_file} not found") unless File.exists? expected_file
-
-      expected_text = File.open(expected_file) {|f| f.read }
-      transformed_text.should_not differ_from(expected_text)
-      File.delete(actual_file)  # It succeeded, we don't need the file.
-    end
-  end
-end

data/status.html

@@ -1,138 +0,0 @@
-<!--#include virtual="/header.html" -->
-<!--#include virtual="navbar.html" -->
-
-<link rel="stylesheet" href="../css/offline.css" media="screen" type="text/css" />
-<div id="sidebar"></div>
-
-<div id="top" class="content">
-
-<a name="status"></a>
-  <h2 class="title">
-    ActiveFacts Project Status
-  </h2>
-
-  <h4>Constellation Query Language</h4>
-
-  <p>
-  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>
-  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>
-  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>
-  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>
-  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>
-  APRIMO allows the definition of vocabulary aspects as well as the addition
-  of entity and value objects and the fact types that link them.  Subtyping,
-  data types and units, and complex constraints are still to be implemented.
-  </p-->
-
-</div>
-
-<!--#include virtual="/footer.html" -->

data/why.html

@@ -1,60 +0,0 @@
-<!--#include virtual="/header.html" -->
-
-  <div class="content">
-      <h2>Why Semantic Modeling?</h2>
-
-      <p>
-      Software is not mainly about <em>how</em>, but about <em>what</em> and
-      <em>why</em>. Software projects fail most commonly because they build
-      the <em>wrong thing</em>, not because they build it wrongly.  Other
-      forms of modeling, such as object modeling and entity relationship
-      modeling, attempt to capture <em>what</em>, but the models are shaped
-      from the start by the needs of implementation (<em>how</em>).  That
-      shuts out the non-technical business expert, and bends the model out
-      of shape, losing track of <em>why</em> each feature is needed, what it
-      means and under what terms, the roles it plays in the overall system.
-      <strong>Semantic modeling</strong> incorporates and transcends both
-      approaches, and works in either Agile or traditional environments.
-      </p>
-
-      <p>
-      ActiveFacts uses a <strong>fact-oriented</strong> approach to
-      constructing models in <strong>elementary</strong> form. Every
-      concept, whether a business entity or a relationship, is represented
-      in the simplest possible form, isolated from all other concerns.
-      Every role that each concept plays in the system is incorporated in
-      simple <strong>business rules</strong> that can be effectively
-      verbalised in plain language, displayed on diagrams, and managed in a
-      system ontology (vocabulary).  The elementary form is the most direct
-      mind-map of the business domain that can be constructed, is based on
-      pure logic, and is unsullied by implementation concerns. That makes it
-      much easier to understand and validate by all parties, especially the
-      business expert. Purely for its benefits in specification, semantic
-      modeling is revolutionary.
-      </p>
-
-      <p>
-      Because the semantic approach is based in pure logic, it can be
-      automatically <strong>transformed</strong> into working software,
-      in the form of executable code and database designs in efficient
-      normalised form.  It's an established truth that very small changes
-      (even additions) in business rules can require large changes to
-      the structure of an database.  Contrary to existing methods used
-      to design and access databases, semantic modeling allows you to
-      make radical changes in the underlying physical table structures
-      without the huge ramifications in your application code. The
-      advantages in business agility are manifold.
-      </p>
-
-      <!--p>
-      Queries in CQL span tables transparently, crossing conceptual
-      relationships (fact types) without explicit database joins, and
-      return structured data in a nested-relational form (called
-      constellation form). For every user action in an application, a
-      single query can be defined that provides all the data required to
-      respond to that action.  There's no need to fetch this, that, and
-      the other. All required results are fetched at once, which
-      improves application structure, performance, and even concurrency.
-      </p-->
-
-<!--#include virtual="/footer.html" -->