activefacts-api 0.8.9

data/spec/api/roles_spec.rb

@@ -0,0 +1,124 @@
+#
+# ActiveFacts tests: Roles of object_type classes in the Runtime API
+# Copyright (c) 2008 Clifford Heath. Read the LICENSE file.
+#
+require 'activefacts/api'
+
+describe "Roles" do
+  before :each do
+    Object.send :remove_const, :Mod if Object.const_defined?("Mod")
+    module Mod
+      class Name < String
+        value_type
+      end
+      class LegalEntity
+        identified_by :name
+        has_one :name
+      end
+      class Contract
+        identified_by :first, :second
+        has_one :first, :class => LegalEntity
+        has_one :second, :class => LegalEntity
+      end
+      class Person < LegalEntity
+        # identified_by         # No identifier needed, inherit from superclass
+        # New identifier:
+        identified_by :family, :given
+        has_one :family, :class => Name
+        has_one :given, :class => Name
+        has_one :related_to, :class => LegalEntity
+      end
+    end
+    # print "object_type: "; p Mod.object_type
+  end
+
+  it "should associate a role name with a matching existing object_type" do
+    module Mod
+      class Existing1 < String
+        value_type
+        has_one :name
+      end
+    end
+    role = Mod::Existing1.roles(:name)
+    role.should_not be_nil
+    role.counterpart_object_type.should == Mod::Name
+  end
+
+  it "should inject the respective role name into the matching object_type" do
+    module Mod
+      class Existing1 < String
+        value_type
+        has_one :name
+      end
+    end
+    Mod::Name.roles(:all_existing1).should_not be_nil
+    Mod::LegalEntity.roles(:all_contract_as_first).should_not be_nil
+  end
+
+  it "should associate a role name with a matching object_type after it's created" do
+    module Mod
+      class Existing2 < String
+        value_type
+        has_one :given_name
+      end
+    end
+    # print "Mod::Existing2.roles = "; p Mod::Existing2.roles
+    r = Mod::Existing2.roles(:given_name)
+    r.should_not be_nil
+    Symbol.should === r.counterpart_object_type
+    module Mod
+      class GivenName < String
+        value_type
+      end
+    end
+    # puts "Should resolve now:"
+    r = Mod::Existing2.roles(:given_name)
+    r.should_not be_nil
+    r.counterpart_object_type.should == Mod::GivenName
+  end
+
+  it "should handle subtyping a value type" do
+    module Mod
+      class FamilyName < Name
+        value_type
+        one_to_one :patriarch, :class => Person
+      end
+    end
+    r = Mod::FamilyName.roles(:patriarch)
+    r.should_not be_nil
+    r.counterpart_object_type.should == Mod::Person
+    r.counterpart_object_type.roles(:family_name_as_patriarch).counterpart_object_type.should == Mod::FamilyName
+  end
+
+  it "should instantiate the matching object_type on assignment" do
+    c = ActiveFacts::API::Constellation.new(Mod)
+    bloggs = c.LegalEntity("Bloggs")
+    acme = c.LegalEntity("Acme, Inc")
+    contract = c.Contract("Bloggs", acme)
+    #contract = c.Contract("Bloggs", "Acme, Inc")
+    contract.first.should == bloggs
+    contract.second.should == acme
+    end
+
+  it "should append the counterpart into the respective role array in the matching object_type" do
+    foo = Mod::Name.new("Foo")
+    le = Mod::LegalEntity.new(foo)
+    le.respond_to?(:name).should be_true
+    name = le.name
+    name.respond_to?(:all_legal_entity).should be_true
+
+    #pending
+    Array(name.all_legal_entity).should === [le]
+  end
+
+  it "should instantiate subclasses sensibly" do
+    c = ActiveFacts::API::Constellation.new(Mod)
+    bloggs = c.LegalEntity("Bloggs & Co")
+    #pending
+    p = c.Person("Fred", "Bloggs")
+    p.related_to = "Bloggs & Co"
+    p.related_to.should be_is_a(Mod::LegalEntity)
+    bloggs.object_id.should == p.related_to.object_id
+  end
+
+end

data/spec/api/value_type_spec.rb

@@ -0,0 +1,114 @@
+#
+# ActiveFacts tests: Value types in the Runtime API
+# Copyright (c) 2008 Clifford Heath. Read the LICENSE file.
+#
+require 'activefacts/api'
+
+describe "Value Type class definitions" do
+  before :each do
+    Object.send :remove_const, :Mod if Object.const_defined?("Mod")
+    module Mod
+      class Name < String
+        value_type
+        has_one :name
+      end
+      class Year < Int
+        value_type
+        has_one :name
+      end
+      class Weight < Real
+        value_type
+        has_one :name
+      end
+    end
+
+    @classes = [Mod::Name, Mod::Year,Mod::Weight]
+    @attrs = [:name, :name, :name]
+
+  end
+
+  it "should respond_to verbalise" do
+    @classes.each { |klass|
+        klass.respond_to?(:verbalise).should be_true
+      }
+  end
+
+  it "should not pollute the value class" do
+    @classes.each { |klass|
+        klass.superclass.respond_to?(:verbalise).should_not be_true
+      }
+  end
+
+  it "should return a string from verbalise" do
+    @classes.each { |klass|
+        v = klass.verbalise
+        v.should_not be_nil
+        v.should_not =~ /REVISIT/
+      }
+  end
+
+  it "should respond_to vocabulary" do
+    @classes.each { |klass|
+        klass.respond_to?(:vocabulary).should be_true
+      }
+  end
+
+  it "should return the parent module as the vocabulary" do
+    @classes.each { |klass|
+        vocabulary = klass.vocabulary
+        vocabulary.should == Mod
+      }
+  end
+
+  it "should return a vocabulary that knows about this object_type" do
+    @classes.each { |klass|
+        vocabulary = klass.vocabulary
+        vocabulary.respond_to?(:object_type).should be_true
+        vocabulary.object_type.has_key?(klass.basename).should be_true
+      }
+  end
+
+  it "should respond to roles()" do
+    @classes.each { |klass|
+        klass.respond_to?(:roles).should be_true
+      }
+  end
+
+  it "should contain only the added role definitions" do
+    Mod::Name.roles.size.should == 4
+    (@classes-[Mod::Name]).each { |klass|
+        klass.roles.size.should == 1
+      }
+  end
+
+  it "should return the role definition" do
+    # Check the role definition may not be accessed by passing an index:
+    Mod::Name.roles(0).should be_nil
+
+    @classes.zip(@attrs).each { |pair|
+        klass, attr = *pair
+        role = klass.roles(attr)
+        role.should_not be_nil
+
+        role = klass.roles(attr.to_s)
+        role.should_not be_nil
+
+        # Check the role definition may be accessed by indexing the returned array:
+        role = klass.roles[attr]
+        role.should_not be_nil
+
+        # Check the role definition array by .include?
+        klass.roles.include?(attr).should be_true
+      }
+  end
+
+  # REVISIT: role value constraints
+
+  it "should fail on a non-ValueClass" do
+    lambda{
+      class NameNotString
+        value_type
+      end
+    }.should raise_error
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'activefacts/api'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification 
+name: activefacts-api
+version: !ruby/object:Gem::Version 
+  hash: 45
+  prerelease: false
+  segments: 
+  - 0
+  - 8
+  - 9
+  version: 0.8.9
+platform: ruby
+authors: 
+- Clifford Heath
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-08 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  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
+  type: :development
+  version_requirements: *id003
+description: |
+  
+  The ActiveFacts API is a Ruby DSL for managing constellations of elementary facts.
+  Each fact is either existential (a value or an entity), characteristic (boolean) or
+  binary relational (A rel B). Relational facts are consistently co-referenced, so you
+  can traverse them efficiently in any direction. Each constellation maintains constraints
+  over the fact population.
+
+email: clifford.heath@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/activefacts/api.rb
+- lib/activefacts/api/constellation.rb
+- lib/activefacts/api/entity.rb
+- lib/activefacts/api/instance.rb
+- lib/activefacts/api/instance_index.rb
+- lib/activefacts/api/numeric.rb
+- lib/activefacts/api/object_type.rb
+- lib/activefacts/api/role.rb
+- lib/activefacts/api/role_proxy.rb
+- lib/activefacts/api/role_values.rb
+- lib/activefacts/api/standard_types.rb
+- lib/activefacts/api/support.rb
+- lib/activefacts/api/value.rb
+- lib/activefacts/api/vocabulary.rb
+- spec/api/autocounter_spec.rb
+- spec/api/constellation_spec.rb
+- spec/api/entity_type_spec.rb
+- spec/api/instance_spec.rb
+- spec/api/roles_spec.rb
+- spec/api/value_type_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/cjheath/activefacts-api
+licenses: 
+- MIT
+post_install_message: 
+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"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A semantic modeling and query language (CQL) and application runtime (the Constellation API)
+test_files: 
+- spec/api/autocounter_spec.rb
+- spec/api/constellation_spec.rb
+- spec/api/entity_type_spec.rb
+- spec/api/instance_spec.rb
+- spec/api/roles_spec.rb
+- spec/api/value_type_spec.rb
+- spec/spec_helper.rb