activefacts 0.6.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.6.0 2008-11-27
+
+* 1 major enhancement:
+  * Initial public release

data/Manifest.txt

@@ -0,0 +1,83 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+bin/afgen
+bin/cql
+examples/CQL/Address.cql
+examples/CQL/Blog.cql
+examples/CQL/CompanyDirectorEmployee.cql
+examples/CQL/Death.cql
+examples/CQL/Genealogy.cql
+examples/CQL/Marriage.cql
+examples/CQL/Metamodel.cql
+examples/CQL/MultiInheritance.cql
+examples/CQL/OilSupply.cql
+examples/CQL/Orienteering.cql
+examples/CQL/PersonPlaysGame.cql
+examples/CQL/SchoolActivities.cql
+examples/CQL/SimplestUnary.cql
+examples/CQL/SubtypePI.cql
+examples/CQL/Warehousing.cql
+examples/CQL/WindowInRoomInBldg.cql
+lib/activefacts.rb
+lib/activefacts/api.rb
+lib/activefacts/api/concept.rb
+lib/activefacts/api/constellation.rb
+lib/activefacts/api/entity.rb
+lib/activefacts/api/instance.rb
+lib/activefacts/api/numeric.rb
+lib/activefacts/api/role.rb
+lib/activefacts/api/standard_types.rb
+lib/activefacts/api/support.rb
+lib/activefacts/api/value.rb
+lib/activefacts/api/vocabulary.rb
+lib/activefacts/cql.rb
+lib/activefacts/cql/Rakefile
+lib/activefacts/cql/CQLParser.treetop
+lib/activefacts/cql/Concepts.treetop
+lib/activefacts/cql/DataTypes.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/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/ordered.rb
+lib/activefacts/generate/ruby.rb
+lib/activefacts/generate/sql/server.rb
+lib/activefacts/generate/text.rb
+lib/activefacts/input/cql.rb
+lib/activefacts/input/orm.rb
+lib/activefacts/persistence.rb
+lib/activefacts/persistence/composition.rb
+lib/activefacts/support.rb
+lib/activefacts/version.rb
+lib/activefacts/vocabulary.rb
+lib/activefacts/vocabulary/extensions.rb
+lib/activefacts/vocabulary/metamodel.rb
+script/txt2html
+spec/absorption_spec.rb
+spec/api/autocounter.rb
+spec/api/constellation.rb
+spec/api/entity_type.rb
+spec/api/instance.rb
+spec/api/roles.rb
+spec/api/value_type.rb
+spec/api_spec.rb
+spec/cql_cql_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/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

data/README.rdoc

@@ -0,0 +1,81 @@
+= activefacts
+
+* http://dataconstellation.com/ActiveFacts/
+
+== 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.
+
+== FEATURES/PROBLEMS:
+
+ * Queries are parsed, but not yet generated to SQL. DDL is complete.
+
+ * SQL generation handles some one-to-one relationships wrongly,
+   including subtypes when independent of the supertype's table.
+
+ * The Constellation API lacks SQL persistence (but is already useful;
+   the CQL compiler uses the generated Ruby code extensively)
+
+ * Re-invoking a fact type to add new readings doesn't work
+
+ * Some types of external constraints (when adjectives mis-match)
+   don't yet pass the CQL parser's semantic analysis.
+
+ * Validation of semantic models (and many other areas) is incomplete
+
+ * There's no interactive CQL interpreter yet; the cql command merely
+   shows the parse tree.
+
+== SYNOPSIS:
+
+  afgen --sql/server myfile.cql
+  afgen --ruby myfile.cql
+  afgen --cql myfile.orm
+
+== REQUIREMENTS:
+
+* Treetop parser generator
+* Optional: NORMA, see <http://www.ormfoundation.org/files/>
+  (needs Visual Studio pro edition), if you want to use ORM
+
+== INSTALL:
+
+* sudo gem install activefacts
+
+== LICENSE:
+
+Copyright (c) 2008 Clifford Heath.
+
+This software is provided 'as-is', without any express or implied warranty.
+In no event will the authors be held liable for any damages arising from the
+use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+1. The origin of this software must not be misrepresented; you must not
+   claim that you wrote the original software. If you use this software
+   in a product, an acknowledgment in the product documentation would be
+   appreciated but is not required.
+
+2. Altered source versions must be plainly marked as such, and must not be
+   misrepresented as being the original software.
+
+3. This notice may not be removed or altered from any source distribution.

data/Rakefile

@@ -0,0 +1,41 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen spec spec/rake/spectask].each { |f| require f }
+
+require File.dirname(__FILE__) + '/lib/activefacts'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('activefacts', ActiveFacts::VERSION) do |p|
+  p.developer('Clifford Heath', 'cjh@dataconstellation.org')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'For more information on ActiveFacts, see http://dataconstellation.com/ActiveFacts'
+  p.rubyforge_name       = "cjheath@rubyforge.org"
+  p.extra_deps         = [
+    ['treetop','>= 1.2.4'],
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  p.spec_extras[:extensions] = 'lib/activefacts/cql/Rakefile'
+  p.spec_extras[:rdoc_options] = [
+      "-x", "lib/activefacts/cql/.*.rb",
+      "-x", "lib/activefacts/vocabulary/.*.rb",
+      "-x", "lib/activefacts/persistence/.*.rb",
+    ]
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]
+
+Spec::Rake::SpecTask.new(:spec) do |t|
+    t.ruby_opts = ['-I', "lib"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    # t.rcov = true
+    # t.rcov_opts = ['--exclude', 'spec,/usr/lib/ruby' ]
+end

data/bin/afgen

@@ -0,0 +1,46 @@
+#! env ruby
+#
+# Read an ORM2 Vocabulary from a NORMA, CQL or other file
+#
+# Copyright (c) 2007 Clifford Heath. Read the LICENSE file.
+#
+$:.unshift File.dirname(File.expand_path(__FILE__))+"/../lib"
+
+require 'rubygems'
+require 'ruby-debug'
+require 'activefacts'
+require 'activefacts/vocabulary'
+
+arg = ARGV.shift
+
+# Load the required generator, or the default "text" generator:
+generator = "text"
+if arg =~ /^--([^=]*)(?:=(.*))?/
+  generator = $1
+  generator_options = ($2||"").split(/,/)
+  arg = ARGV.shift
+end
+output_handler = "activefacts/generate/#{generator.downcase}"
+require output_handler
+output_class = generator.upcase.gsub(%r{[/\\]+},'::')
+output_klass = eval("ActiveFacts::Generate::#{output_class}")
+raise "Expected #{output_handler} to define #{output_class}" unless output_klass
+
+# Load the file type input method
+extension = arg.sub(/\A.*\./,'').downcase
+input_handler = "activefacts/input/#{extension}"
+require input_handler
+input_class = extension.upcase
+input_klass = ActiveFacts::Input.const_get(input_class.to_sym)
+raise "Expected #{input_handler} to define #{input_class}" unless input_klass
+
+# Read the input file:
+begin
+  vocabulary = input_klass.readfile(arg)
+rescue => e
+  puts "#{e.message}"
+  puts "#{e}:\n\t#{e.backtrace*"\n\t"}" if debug
+end
+
+# Generate the output:
+output_klass.new(vocabulary, *generator_options).generate if vocabulary

data/bin/cql

@@ -0,0 +1,52 @@
+#! env ruby
+#
+# Interactive CQL command-line.
+# Copyright (c) 2007 Clifford Heath. Read the LICENSE file.
+#
+
+require 'activefacts'
+require 'activefacts/cql/parser'
+require 'readline'
+
+puts "This is a stub for the CQL interactive commandline. At the moment it only parses CQL and shows the parse trees."
+
+parser = ActiveFacts::CQLParser.new
+parser.root = :definition
+statement = nil
+while line = Readline::readline(statement ? "CQL+ " : "CQL? ", [])
+  statement = statement ? statement + "\n"+line : line
+  if line =~ %r{\A/}
+    # meta-commands start with /
+    case (words = line.split).shift
+    when "/root"
+      parser.root = words[0] && words[0].to_sym || :definition
+      puts "ok"
+    else
+      puts "Unknown metacommand #{line}, did you mean /root <rule>?"
+    end
+    statement = nil
+  elsif parser.root != :definition or
+      line.gsub(/(['"])([^\1\\]|\\.)*\1/,'') =~ /;/
+    # After stripping string literals the line contains a ';', it's the last line of the command:
+    begin
+      result = parser.parse(statement)
+      if result
+        begin
+          p result.value
+        rescue => e
+          puts e.to_s+":"
+          p result  # In case the root is changed and there's no value()
+        end
+        #p parser.definition(result)
+      else
+        p parser.failure_reason
+      end
+    rescue => e
+      puts e
+      puts "\t"+e.backtrace*"\n\t"
+    end
+    statement = nil
+  end
+end
+puts
+

data/examples/CQL/Address.cql

@@ -0,0 +1,46 @@
+vocabulary Address;
+
+/*
+ * Value Types
+ */
+City is defined as VariableLengthText(64);
+CompanyName is defined as VariableLengthText();
+FamilyName is defined as VariableLengthText(20);
+GivenNames is defined as VariableLengthText(20);
+Number is defined as VariableLengthText(12);
+Postcode is defined as VariableLengthText();
+StreetLine is defined as VariableLengthText(64);
+
+/*
+ * Entity Types
+ */
+Company is identified by its Name;
+
+Family is identified by its Name;
+
+Person is identified by Family and GivenNames where
+	Person is of one Family,
+	Family includes Person,
+	Person has one GivenNames;
+
+Street is identified by first-StreetLine and second-StreetLine and third-StreetLine where
+	Street includes one first-StreetLine,
+	Street includes at most one second-StreetLine,
+	Street includes at most one third-StreetLine;
+
+Address is identified by street-Number and Street and City and Postcode where
+	Address is at at most one street-Number,
+	Address is at one Street,
+	Address is in one City,
+	Address is in at most one Postcode,
+	Postcode is of Address;
+Company has head office at at most one Address;
+Person lives at at most one Address;
+
+/*
+ * Constraints:
+ */
+Street includes third-StreetLine
+	only if Street includes second-StreetLine;
+Street includes second-StreetLine
+	only if Street includes first-StreetLine;

data/examples/CQL/Blog.cql

@@ -0,0 +1,54 @@
+vocabulary Blog;
+
+/*
+ * Value Types
+ */
+AuthorId is defined as AutoCounter();
+CommentId is defined as AutoCounter();
+Name is defined as VariableLengthText(64);
+Ordinal is defined as UnsignedInteger(32);
+PostId is defined as AutoCounter();
+Style is defined as VariableLengthText(20);
+Text is defined as LargeLengthText();
+TopicId is defined as AutoCounter();
+
+/*
+ * Entity Types
+ */
+Author is identified by its Id;
+author-Name is of at most one Author,
+	Author is called one Name;
+
+Comment is identified by its Id;
+Author wrote Comment,
+	Comment was written by one Author;
+
+Content is identified by Style and Text where
+	Content is of at most one Style,
+	Content has one Text,
+	Text is of Content;
+Content provides text of at most one Comment,
+	Comment consists of one text-Content;
+
+Post is identified by its Id;
+Post was written by one Author;
+Paragraph is where
+	Post includes Ordinal paragraph;
+Content is of at most one Paragraph,
+	Paragraph contains one Content;
+Paragraph has Comment,
+	Comment is on one Paragraph;
+
+Topic is identified by its Id;
+Post belongs to one Topic,
+	Topic contains Post;
+Topic belongs to at most one parent-Topic [acyclic];
+Topic is called one topic-Name,
+	Name is of at most one Topic;
+
+/*
+ * Constraints:
+ */
+for each Content exactly one of these holds:
+	Content provides text of Comment,
+	Content is of Paragraph;

data/examples/CQL/CompanyDirectorEmployee.cql

@@ -0,0 +1,51 @@
+vocabulary CompanyDirector;
+
+/*
+ * Value Types
+ */
+CompanyName is defined as VariableLengthText(48);
+EmployeeNr is defined as SignedInteger(32);
+Name is defined as VariableLengthText(48);
+
+/*
+ * Entity Types
+ */
+Company is identified by its Name where
+	Company is called CompanyName;
+Company is listed;
+
+Meeting is identified by Date and Meeting is board meeting and Company where
+	Meeting is held on one Date,
+	Meeting is board meeting,
+	Company held Meeting,
+	Meeting is held by one Company;
+
+Person is identified by given-Name and family-Name where
+	Person has one given-Name,
+	given-Name is of Person,
+	family-Name is of Person,
+	Person is called at most one family-Name;
+Person was born on at most one birth-Date;
+Attendance is where
+	Person (as Attendee) attended Meeting,
+	Meeting was attended by Attendee;
+Directorship is where
+	Person (as Director) directs Company,
+	Company is directed by at least one Director;
+Directorship began on one appointment-Date;
+
+Employee is a kind of Person identified by its Nr;
+Employee works at one Company,
+	Company employs Employee;
+
+Manager is a kind of Employee;
+Employee is supervised by at most one Manager [acyclic],
+	Manager supervises Employee;
+Manager is ceo;
+
+/*
+ * Constraints:
+ */
+for each Employee exactly one of these holds:
+	that Employee is ceo,
+	that Employee is supervised by some Manager;