activefacts 0.7.3 → 0.8.5

data/spec/norma_sql_spec.rb

@@ -2,7 +2,8 @@
 # ActiveFacts tests: Parse all CQL files and check the generated Ruby.
 # Copyright (c) 2008 Clifford Heath. Read the LICENSE file.
 #
-require 'rubygems'
+
+require 'spec/spec_helper'
 require 'stringio'
 require 'activefacts/vocabulary'
 require 'activefacts/support'
@@ -35,8 +36,10 @@ describe "NORMA Loader with SQL output" do
       sql_text = sql(vocabulary)
       File.open(actual_file, "w") { |f| f.write sql_text }
 
-      pending unless File.exists? expected_file
-      sql_text.should == File.open(expected_file) {|f| f.read }
+      pending("expected output file #{expected_file} not found") unless File.exists? expected_file
+
+      expected_text = File.open(expected_file) {|f| f.read }
+      sql_text.should_not differ_from(expected_text)
       File.delete(actual_file)  # It succeeded, we don't need the file.
     end
   end

data/spec/norma_tables_spec.rb

@@ -6,7 +6,7 @@
 #
 # Copyright (c) 2008 Clifford Heath. Read the LICENSE file.
 #
-require 'rubygems'
+
 require 'stringio'
 require 'activefacts/vocabulary'
 require 'activefacts/persistence'
@@ -19,13 +19,15 @@ include ActiveFacts::Metamodel
 Exceptions = {
   "Blog" => ["Author", "Comment", "Paragraph", "Post", "Topic"],
   "JoinEquality" => ["Event", "Seat", "Ticket", "Venue"],
-  "Metamodel" => ["AllowedRange", "Constraint", "Derivation", "Fact", "FactType", "Feature", "Instance", "Join", "ParamValue", "Reading", "Role", "RoleRef", "RoleSequence", "RoleValue", "SetComparisonRoles", "Unit", "ValueRestriction"],
-  "MetamodelTerms" => ["AllowedRange", "Concept", "Constraint", "Derivation", "Fact", "FactType", "Import", "Instance", "Join", "ParamValue", "Reading", "Role", "RoleRef", "RoleSequence", "RoleValue", "SetComparisonRoles", "Term", "Unit", "ValueRestriction"],
+  "Metamodel" => ["AllowedRange", "Concept", "Constraint", "ContextAccordingTo", "ContextAgreedBy", "ContextNote", "Derivation", "Fact", "FactType", "Instance", "Join", "ParamValue", "Reading", "Role", "RoleRef", "RoleSequence", "RoleValue", "SetComparisonRoles", "Unit", "ValueRestriction" ],
+  "MetamodelTerms" => ["AllowedRange", "Constraint", "ContextAccordingTo", "ContextAgreedBy", "ContextNote", "Derivation", "Fact", "FactType", "Instance", "Join", "ParamValue", "Reading", "Role", "RoleRef", "RoleSequence", "RoleValue", "SetComparisonRoles", "Term", "Unit", "ValueRestriction"],
   "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"],
-  "RedundantDependency" => ["Address", "LegislativeDistrict", "StateOrProvince"],
+  "Portfolio" => ["AnnualDepreciation", "Attachment", "Collateral", "DepreciationSchedule", "Disposal", "Expenditure", "OwnedItem", "Revenue", "Transaction", "Valuation"],
+  "OrienteeringER" => ["Club", "Event", "EventControl", "EventCourse", "Map", "SeriesEvent"],
+  "RedundantDependency" => ["Address", "Politician", "StateOrProvince"],
 }
 
 def extract_created_tables_from_sql sql_file

data/spec/spec_helper.rb

@@ -1,10 +1,29 @@
-begin
-  require 'spec'
-rescue LoadError
-  require 'rubygems'
-  gem 'rspec'
-  require 'spec'
+#
+# A Custom Matcher for RSpec that shows the difference between two multi-line strings.
+#
+# Usage:
+#   actual_text.should_not differ_from(expected_text)
+#
+
+require 'spec/helpers/file_matcher.rb'
+
+class String
+  def strip_comments()
+    c_comment = %r{/\*((?!\*/).)*\*/}m
+    gsub(c_comment, '').gsub(%r{\n\n+},"\n")
+  end
 end
 
-$:.unshift(File.dirname(__FILE__) + '/../lib')
-require 'activefacts'
+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/status.html

@@ -0,0 +1,69 @@
+<!--#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>
+
+  <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.
+  </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.
+  </p>
+
+  <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.
+  </p>
+
+  <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.
+  </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

@@ -0,0 +1,60 @@
+<!--#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" -->

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: activefacts
 version: !ruby/object:Gem::Version 
-  version: 0.7.3
+  version: 0.8.5
 platform: ruby
 authors: 
 - Clifford Heath
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-15 00:00:00 +10:00
+date: 2009-09-24 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.2.4
+        version: 1.4.1
     version: 
 - !ruby/object:Gem::Dependency 
   name: newgem
@@ -30,7 +30,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.4.1
+        version: 1.5.2
     version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
@@ -40,9 +40,10 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.8.0
+        version: 2.3.2
     version: 
-description: |-
+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
@@ -60,6 +61,7 @@ description: |-
   allows creation of relational and object models that are guaranteed
   equivalent, and much more stable in the face of schema evolution than
   SQL is.
+
 email: 
 - cjh@dataconstellation.org
 executables: 
@@ -70,14 +72,20 @@ extensions:
 extra_rdoc_files: 
 - History.txt
 - Manifest.txt
-- README.rdoc
 files: 
 - History.txt
+- LICENSE
 - Manifest.txt
 - README.rdoc
 - Rakefile
 - bin/afgen
 - bin/cql
+- css/offline.css
+- css/orm2.css
+- css/print.css
+- css/style-print.css
+- css/style.css
+- download.html
 - examples/CQL/Address.cql
 - examples/CQL/Blog.cql
 - examples/CQL/CompanyDirectorEmployee.cql
@@ -94,6 +102,11 @@ files:
 - examples/CQL/SubtypePI.cql
 - examples/CQL/Warehousing.cql
 - examples/CQL/WindowInRoomInBldg.cql
+- examples/CQL/unit.cql
+- examples/index.html
+- examples/intro.html
+- examples/local.css
+- index.html
 - lib/activefacts.rb
 - lib/activefacts/api.rb
 - lib/activefacts/api/concept.rb
@@ -112,12 +125,15 @@ files:
 - lib/activefacts/cql.rb
 - lib/activefacts/cql/CQLParser.treetop
 - lib/activefacts/cql/Concepts.treetop
-- lib/activefacts/cql/DataTypes.treetop
+- lib/activefacts/cql/Context.treetop
 - lib/activefacts/cql/Expressions.treetop
 - lib/activefacts/cql/FactTypes.treetop
 - lib/activefacts/cql/Language/English.treetop
 - lib/activefacts/cql/LexicalRules.treetop
 - lib/activefacts/cql/Rakefile
+- lib/activefacts/cql/Terms.treetop
+- lib/activefacts/cql/ValueTypes.treetop
+- lib/activefacts/cql/compiler.rb
 - lib/activefacts/cql/parser.rb
 - lib/activefacts/generate/absorption.rb
 - lib/activefacts/generate/cql.rb
@@ -144,6 +160,7 @@ files:
 - lib/activefacts/vocabulary/extensions.rb
 - lib/activefacts/vocabulary/metamodel.rb
 - script/txt2html
+- spec/absorption_ruby_spec.rb
 - spec/absorption_spec.rb
 - spec/api/autocounter.rb
 - spec/api/constellation.rb
@@ -152,19 +169,25 @@ files:
 - spec/api/roles.rb
 - spec/api/value_type.rb
 - spec/api_spec.rb
+- spec/cql/context_spec.rb
+- spec/cql/samples_spec.rb
+- spec/cql/unit_spec.rb
 - spec/cql_cql_spec.rb
+- spec/cql_mysql_spec.rb
 - spec/cql_parse_spec.rb
 - spec/cql_ruby_spec.rb
 - spec/cql_sql_spec.rb
 - spec/cql_symbol_tables_spec.rb
-- spec/cql_unit_spec.rb
 - spec/cqldump_spec.rb
+- spec/helpers/file_matcher.rb
 - spec/norma_cql_spec.rb
 - spec/norma_ruby_spec.rb
 - spec/norma_sql_spec.rb
 - spec/norma_tables_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+- status.html
+- why.html
 has_rdoc: true
 homepage: http://dataconstellation.com/ActiveFacts/
 licenses: []
@@ -201,9 +224,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: cjheath@rubyforge.org
-rubygems_version: 1.3.3
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: 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
+summary: A semantic modeling and query language (CQL) and application runtime (the Constellation API)
 test_files: []
 

data/lib/activefacts/cql/DataTypes.treetop

@@ -1,81 +0,0 @@
-#
-#       ActiveFacts CQL Parser.
-#       Parse rules relating to ValueType definitions.
-#
-# Copyright (c) 2009 Clifford Heath. Read the LICENSE file.
-#
-module ActiveFacts
-  module CQL
-    grammar DataTypes
-      rule data_type
-        s name:id
-        ( s '=' s / written_as )
-        base:id s
-        '(' s tpl:type_parameter_list? ')' s
-        u0:(!restricted u1:unit s)?
-        r:restriction?
-        s ';' s
-        {
-          def defined_type
-            [
-              :data_type,
-              base.text_value,
-              tpl.empty? ? [] : tpl.value,
-              !u0.empty? ? u0.u1.text_value : nil,
-              !r.empty? ? r.ranges : [],
-            ]
-          end
-
-          def value
-            [ name.text_value,
-              defined_type
-            ]
-          end
-        }
-      end
-
-      rule unit_definition
-	numerator:number denominator:(s '/' s number)?
-	baseunits:(unit+ (s '/' s unit+)?) s
-	offset:(('+' / '-') s number)
-	'makes' s ('approximately' s)?
-	singular:id plural:(s '/' s id)?
-	(s '[' s 'ephemeral' s ']')?
-      end
-
-      rule type_parameter_list
-        head:number s tail:( ',' s number s )*
-        {
-          def value
-            [head.value] + tail.elements.map{|i| i.number.value}
-          end
-        }
-      end
-
-      rule unit
-        unit_name:id ('^' '-'? [0-9])?
-      end
-
-      rule restriction
-        restricted s to s range_list s unit?
-        {
-          def ranges
-            range_list.ranges
-          end
-        }
-      end
-
-      rule range_list
-        '{' s
-          head:range s tail:( ',' s range )*
-        '}' s
-        {
-          def ranges
-            [head.value] + tail.elements.map{|e| e.range.value }
-          end
-        }
-      end
-
-    end
-  end
-end