activefacts 0.6.0

data/spec/norma_cql_spec.rb

@@ -0,0 +1,48 @@
+#
+# ActiveFacts tests: Parse all NORMA files and check the generated CQL.
+# Copyright (c) 2008 Clifford Heath. Read the LICENSE file.
+#
+require 'rubygems'
+require 'stringio'
+require 'activefacts/vocabulary'
+require 'activefacts/support'
+require 'activefacts/input/orm'
+require 'activefacts/generate/cql'
+
+include ActiveFacts
+
+describe "Norma Loader" do
+  ORM_CQL_FAILURES = %w{
+    ServiceDirector
+  }
+  # Generate and return the CQL for the given vocabulary
+  def cql(vocabulary)
+    output = StringIO.new
+    @dumper = ActiveFacts::Generate::CQL.new(vocabulary.constellation)
+    @dumper.generate(output)
+    output.rewind
+    output.readlines
+  end
+
+  #Dir["examples/norma/Bl*.orm"].each do |orm_file|
+  #Dir["examples/norma/Meta*.orm"].each do |orm_file|
+  #Dir["examples/norma/[AC]*.orm"].each do |orm_file|
+  Dir["examples/norma/*.orm"].each do |orm_file|
+    expected_file = orm_file.sub(%r{/norma/(.*).orm\Z}, '/CQL/\1.cql')
+
+    actual_file = orm_file.sub(%r{examples/norma/(.*).orm\Z}, 'spec/actual/\1.cql')
+
+    it "should load #{orm_file} and dump CQL matching #{expected_file}" do
+      pending if ORM_CQL_FAILURES.include? File.basename(orm_file, ".orm")
+      vocabulary = ActiveFacts::Input::ORM.readfile(orm_file)
+
+      cql = cql(vocabulary)
+      # Save the actual file:
+      File.open(actual_file, "w") { |f| f.write cql*"" }
+
+      pending unless File.exists? expected_file
+      cql.should == File.open(expected_file) {|f| f.readlines}
+      File.delete(actual_file)
+    end
+  end
+end

data/spec/norma_ruby_spec.rb

@@ -0,0 +1,50 @@
+#
+# ActiveFacts tests: Parse all CQL files and check the generated Ruby.
+# Copyright (c) 2008 Clifford Heath. Read the LICENSE file.
+#
+require 'rubygems'
+require 'stringio'
+require 'activefacts/vocabulary'
+require 'activefacts/support'
+require 'activefacts/input/orm'
+require 'activefacts/generate/ruby'
+
+include ActiveFacts
+
+class String
+  def strip_comments()
+    c_comment = %r{/\*((?!\*/).)*\*/}m
+    gsub(c_comment, '').gsub(%r{\n\n+},"\n")
+  end
+end
+
+describe "NORMA Loader with Ruby output" do
+  # Generate and return the Ruby for the given vocabulary
+  def ruby(vocabulary)
+    output = StringIO.new
+    @dumper = ActiveFacts::Generate::RUBY.new(vocabulary.constellation)
+    @dumper.generate(output)
+    output.rewind
+    output.read
+  end
+
+  #Dir["examples/norma/Bl*.orm"].each do |orm_file|
+  #Dir["examples/norma/Meta*.orm"].each do |orm_file|
+  #Dir["examples/norma/[ACG]*.orm"].each do |orm_file|
+  Dir["examples/norma/*.orm"].each do |orm_file|
+    expected_file = orm_file.sub(%r{examples/norma/(.*).orm\Z}, 'examples/ruby/\1.rb')
+    actual_file = orm_file.sub(%r{examples/norma/(.*).orm\Z}, 'spec/actual/\1.rb')
+
+    it "should load #{orm_file} and dump Ruby matching #{expected_file}" do
+      vocabulary = ActiveFacts::Input::ORM.readfile(orm_file)
+
+      # Build and save the actual file:
+      ruby_text = ruby(vocabulary)
+      File.open(actual_file, "w") { |f| f.write ruby_text }
+
+      pending unless File.exists? expected_file
+      ruby_text.should == File.open(expected_file) {|f| f.read }
+      File.delete(actual_file)  # It succeeded, we don't need the file.
+    end
+  end
+end

data/spec/norma_sql_spec.rb

@@ -0,0 +1,45 @@
+#
+# ActiveFacts tests: Parse all CQL files and check the generated Ruby.
+# Copyright (c) 2008 Clifford Heath. Read the LICENSE file.
+#
+require 'rubygems'
+require 'stringio'
+require 'activefacts/vocabulary'
+require 'activefacts/support'
+require 'activefacts/persistence'
+require 'activefacts/input/orm'
+require 'activefacts/generate/sql/server'
+
+include ActiveFacts
+include ActiveFacts::Metamodel
+
+describe "NORMA Loader with SQL output" do
+  # 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
+
+  #Dir["examples/norma/Bl*.orm"].each do |orm_file|
+  #Dir["examples/norma/Meta*.orm"].each do |orm_file|
+  #Dir["examples/norma/[ACG]*.orm"].each do |orm_file|
+  Dir["examples/norma/*.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')
+
+    it "should load #{orm_file} and dump SQL matching #{expected_file}" do
+      vocabulary = ActiveFacts::Input::ORM.readfile(orm_file)
+
+      # Build and save the actual file:
+      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 }
+      File.delete(actual_file)  # It succeeded, we don't need the file.
+    end
+  end
+end

data/spec/norma_tables_spec.rb

@@ -0,0 +1,94 @@
+#
+# 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 'rubygems'
+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"],
+  "DeathAsBinary" => ["Person"],
+  "Metamodel" => ["AllowedRange", "Constraint", "Correspondence", "Fact", "FactType", "Feature", "Instance", "JoinPath", "Reading", "Role", "RoleRef", "RoleSequence", "RoleValue", "SetComparisonRoles", "Unit", "UnitBasis", "ValueRestriction"],
+  "OilSupplyWithCosts" => ["AcceptableSubstitutes", "Month", "ProductionForecast", "RegionalDemand", "TransportRoute"],
+  "Orienteering" => ["Club", "Entry", "Event", "EventControl", "EventScoringMethod", "Map", "Person", "Punch", "PunchPlacement", "Series", "Visit"],
+  "Warehousing" => ["Bin", "DirectOrderMatch", "DispatchItem", "Party", "Product", "PurchaseOrder", "PurchaseOrderItem", "ReceivedItem", "SalesOrder", "SalesOrderItem", "TransferRequest", "Warehouse"]
+}
+
+describe "Relational Composition from NORMA" do
+  #Dir["examples/norma/B*.orm"].each do |orm_file|
+  #Dir["examples/norma/Ins*.orm"].each do |orm_file|
+  #Dir["examples/norma/W*.orm"].each do |orm_file|
+  Dir["examples/norma/*.orm"].each do |orm_file|
+    sql_tables = Exceptions[File.basename(orm_file, ".orm")]
+    if !sql_tables
+      sql_file_pattern = orm_file.sub(/\.orm\Z/, '*.sql')
+      sql_files = Dir[sql_file_pattern]
+      next unless sql_files.size > 0
+    end
+
+    it "should load #{orm_file} and compute #{
+        sql_tables ? "the expected list of tables" :
+          "a list of tables similar to those in #{sql_files[0]}"
+      }" do
+
+      vocabulary = ActiveFacts::Input::ORM.readfile(orm_file)
+
+      # Get the list of tables from NORMA's SQL:
+      sql_tables ||= File.open(sql_files[0]) 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
+
+      # Get the list of tables from our composition:
+      composition = vocabulary.tables.map{|o| o.name }.sort
+
+      # Save the actual and expected composition to files
+      actual_tables = orm_file.sub(%r{examples/norma/(.*).orm\Z}, 'spec/actual/\1.tables')
+      File.open(actual_tables, "w") { |f| f.puts composition*"\n" }
+      norma_tables = orm_file.sub(%r{examples/norma/(.*).orm\Z}, 'spec/actual/\1.norma.tables')
+      File.open(norma_tables, "w") { |f| f.puts sql_tables*"\n" }
+
+      # Calculate the columns and column names; REVISIT: check the results
+      vocabulary.tables.each {|table| table.absorbed_roles }
+
+      if false && composition != sql_tables
+        #puts "="*20 + " reasons " + "="*20
+        # Show only the reasons for the differences:
+        #((composition+sql_tables).uniq-(composition&sql_tables)).
+        # Show the reasons for all entity types:
+        vocabulary.
+        all_feature.
+        select{|f| EntityType === f || f.independent }.
+        map{|f| f.name}.
+        sort.
+        each do |concept_name|
+          concept = vocabulary.constellation.Feature(concept_name, vocabulary)
+          puts "#{concept_name}:\n\t#{concept.dependency_reasons*"\n\t"}"
+        end
+      end
+
+      composition.should == sql_tables
+
+      File.delete(actual_tables)
+      File.delete(norma_tables)
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'activefacts'

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification 
+name: activefacts
+version: !ruby/object:Gem::Version 
+  version: 0.6.0
+platform: ruby
+authors: 
+- Clifford Heath
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-28 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: treetop
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+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.
+email: 
+- cjh@dataconstellation.org
+executables: 
+- afgen
+- cql
+extensions: 
+- lib/activefacts/cql/Rakefile
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- 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
+has_rdoc: true
+homepage: http://dataconstellation.com/ActiveFacts/
+post_install_message: For more information on ActiveFacts, see http://dataconstellation.com/ActiveFacts
+rdoc_options: 
+- -x
+- lib/activefacts/cql/.*.rb
+- -x
+- lib/activefacts/vocabulary/.*.rb
+- -x
+- lib/activefacts/persistence/.*.rb
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: cjheath@rubyforge.org
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+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
+test_files: []
+