domain 1.0.0.rc2 → 1.0.0.rc3

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-# 0.0.1 / FIX ME
+# 1.0.0 / FIX ME
 
 * Enhancements
 

data/domain.noespec

@@ -7,7 +7,7 @@ variables:
   upper:
     Domain
   version:
-    1.0.0.rc2
+    1.0.0.rc3
   summary: |-
     Provide tools for implementing domains (aka data types)
   description: |-

data/lib/domain/api.rb

@@ -1,39 +1,6 @@
 module Domain
   module API
 
-    # Returns the super domain of `self`.
-    #
-    # @return [Class]
-    #   the super domain of `self` as a ruby class
-    #
-    # @api public
-    def super_domain
-      superclass
-    end
-
-    # Returns the sub domains of `self`.
-    #
-    # @return [Array]
-    #   an array of sub domains (possibly empty)
-    #
-    # @api public
-    def sub_domains
-      []
-    end
-
-    # Returns true if this domain is a super domain of `dom`.
-    #
-    # @param [Class] dom
-    #   a domain
-    #
-    # @return [Boolean]
-    #   true if self is a super domain of `dom`, false otherwise
-    #
-    # @api public
-    def super_domain_of?(dom)
-      sub_domains.include?(dom)
-    end
-
     # Raises a type error for `args`.
     #
     # @param [Array] args

data/lib/domain/factory/union.rb

@@ -2,7 +2,7 @@ module Domain
   module Union
 
     def self.new(*sub_domains)
-      DomainFactory.factor [ Methods, class_module(sub_domains) ]
+      DomainFactory.factor [ Methods, Comparisons, class_module(sub_domains) ]
     end
 
     def self.class_module(sub_domains)
@@ -29,6 +29,22 @@ module Domain
         predicate.call(value)
       end
 
+      # Compares with another domain
+      def <=>(other)
+        mine, yours = sub_domains_of(self), sub_domains_of(other)
+        return 0  if self==other || mine==yours
+        return -1 if mine.subset?(yours)
+        return 1  if mine.superset?(yours)
+        super
+      end
+
+    private
+
+      def sub_domains_of(x)
+        return x.sub_domains.to_set if x.respond_to?(:sub_domains)
+        [ x ].to_set
+      end
+
     end # module Methods
 
   end # class Union

data/lib/domain/support.rb

@@ -1,2 +1,3 @@
 require_relative 'support/equalizer'
+require_relative 'support/comparisons'
 require_relative 'support/domain_factory'

data/lib/domain/support/comparisons.rb

@@ -0,0 +1,21 @@
+module Domain
+  module Comparisons
+
+    def >(other)
+      (x = (self <=> other)) && (x > 0)
+    end
+
+    def >=(other)
+      (x = (self <=> other)) && (x >= 0)
+    end
+
+    def <(other)
+      (x = (self <=> other)) && (x < 0)
+    end
+
+    def <=(other)
+      (x = (self <=> other)) && (x <= 0)
+    end
+
+  end # module Comparisons
+end # module Domain

data/lib/domain/support/equalizer.rb

@@ -31,21 +31,6 @@ module Domain
         equality_components.map{|c| c.hash }.reduce(self.class.hash, :^)
       end
 
-      # Compare the object with other object for equality
-      #
-      # @example
-      #   object.eql?(other)  # => true or false
-      #
-      # @param [Object] other
-      #   the other object to compare with
-      #
-      # @return [Boolean]
-      #
-      # @api public
-      def eql?(other)
-        instance_of?(other.class) and cmp?(__method__, other)
-      end
-
       # Compare the object with other object for equivalency
       #
       # @example
@@ -61,6 +46,7 @@ module Domain
         return false unless self.class <=> other.class
         cmp?(__method__, other)
       end
+      alias :eql? :==
 
     private
 

data/lib/domain/version.rb

@@ -3,7 +3,7 @@ module Domain
 
     MAJOR = 1
     MINOR = 0
-    TINY  = "0.rc2"
+    TINY  = "0.rc3"
 
     def self.to_s
       [ MAJOR, MINOR, TINY ].join('.')

data/spec/factory/sbyc_domain/test_comparison.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+module Domain
+  describe SByC, "<=>" do
+
+    it 'detects a super-domain' do
+      (NegInt <=> Integer).should eq(-1)
+      (NegInt <=> Numeric).should eq(-1)
+    end
+
+    it 'detects a non ancestor' do
+      (NegInt <=> String).should be_nil
+    end
+
+  end
+end

data/spec/factory/union_domain/test_comparison.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+module Domain
+  describe Union, "<=>" do
+
+    it 'returns 1 when a super domain' do
+      (Boolean <=> TrueClass).should eq(1)
+    end
+    
+    it 'returns 0 on itself' do
+      (Boolean <=> Boolean).should eq(0)
+    end
+    
+    it 'returns 0 on equivalent' do
+      (Boolean <=> Domain.union(TrueClass, FalseClass)).should eq(0)
+    end
+    
+    it 'returns 1 on superset of domains ' do
+      (Boolean <=> Domain.union(TrueClass)).should eq(1)
+    end
+
+    it 'returns -1 on subset of domains ' do
+      (Domain.union(TrueClass) <=> Boolean).should eq(-1)
+    end
+
+    it 'returns -1 when compared with Object' do
+      (Boolean <=> Object).should eq(-1)
+    end
+
+    it 'returns nil when not a super domain' do
+      (Boolean <=> Integer).should be_nil
+    end
+
+  end
+end

data/spec/factory/union_domain/test_greater_or_equal_to.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+module Domain
+  describe Union, ">=" do
+
+    it 'returns true when a super domain' do
+      (Boolean >= TrueClass).should be_true
+    end
+
+    it 'returns true on itself' do
+      (Boolean >= Boolean).should be_true
+    end
+
+    it 'returns false when not a super domain' do
+      (Boolean >= Integer).should be_false
+    end
+
+  end
+end

data/spec/factory/{sbyc_domain/test_super_domain_of.rb → union_domain/test_greater_than.rb}

@@ -1,17 +1,17 @@
 require 'spec_helper'
 module Domain
-  describe SByC, "super_domain_of?" do
+  describe Union, ">" do
 
     it 'returns true when a super domain' do
-      Boolean.should be_super_domain_of(TrueClass)
+      (Boolean > TrueClass).should be_true
     end
 
     it 'returns false on itself' do
-      Boolean.should_not be_super_domain_of(Boolean)
+      (Boolean > Boolean).should be_false
     end
 
     it 'returns false when not a super domain' do
-      Boolean.should_not be_super_domain_of(Integer)
+      (Boolean > Integer).should be_false
     end
 
   end

data/spec/shared/a_domain_class.rb

@@ -2,9 +2,29 @@ shared_examples_for 'a domain class' do
 
   it{ should be_a(Class)  }
 
-  it{ should respond_to(:sub_domains) }
-  it{ should respond_to(:super_domain) }
-
   it{ should respond_to(:third_party_extension) }
 
+  context 'comparisons' do
+
+    it 'should compare with itself' do
+      (subject <=> subject).should eq(0)
+    end
+
+    it 'should <= with itself' do
+      (subject <= subject).should be_true
+    end
+
+    it 'should < with itself' do
+      (subject < subject).should be_false
+    end
+
+    it 'should >= with itself' do
+      (subject >= subject).should be_true
+    end
+
+    it 'should > with itself' do
+      (subject > subject).should be_false
+    end
+  end
+
 end

data/spec/support/test_equalizer.rb

@@ -68,7 +68,7 @@ module Domain
 
       context 'with equivalent of a subclass' do
         let(:other){ Class.new(domain).new(1, 2) }
-        it{ should be_false }
+        it{ should be_true }
       end
 
       context 'with non equivalent' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: domain
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc2
+  version: 1.0.0.rc3
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-28 00:00:00.000000000 Z
+date: 2012-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,6 +66,7 @@ files:
 - lib/domain/factory/union.rb
 - lib/domain/factory.rb
 - lib/domain/loader.rb
+- lib/domain/support/comparisons.rb
 - lib/domain/support/domain_factory.rb
 - lib/domain/support/equalizer.rb
 - lib/domain/support.rb
@@ -81,11 +82,10 @@ files:
 - spec/factory/reuse_domain/test_recoat.rb
 - spec/factory/reuse_domain/test_reuse.rb
 - spec/factory/reuse_domain/test_values.rb
+- spec/factory/sbyc_domain/test_comparison.rb
 - spec/factory/sbyc_domain/test_new.rb
 - spec/factory/sbyc_domain/test_predicate.rb
-- spec/factory/sbyc_domain/test_sub_domains.rb
 - spec/factory/sbyc_domain/test_super_domain.rb
-- spec/factory/sbyc_domain/test_super_domain_of.rb
 - spec/factory/sbyc_domain/test_triple_equal.rb
 - spec/factory/scalar_domain/test_component_reader.rb
 - spec/factory/scalar_domain/test_hash.rb
@@ -94,11 +94,12 @@ files:
 - spec/factory/test_sbyc.rb
 - spec/factory/test_scalar.rb
 - spec/factory/test_union.rb
+- spec/factory/union_domain/test_comparison.rb
+- spec/factory/union_domain/test_greater_or_equal_to.rb
+- spec/factory/union_domain/test_greater_than.rb
 - spec/factory/union_domain/test_new.rb
 - spec/factory/union_domain/test_predicate.rb
 - spec/factory/union_domain/test_sub_domains.rb
-- spec/factory/union_domain/test_super_domain.rb
-- spec/factory/union_domain/test_super_domain_of.rb
 - spec/factory/union_domain/test_triple_equal.rb
 - spec/fixtures/attr_list.rb
 - spec/fixtures/boolean.rb
@@ -146,11 +147,10 @@ test_files:
 - spec/factory/reuse_domain/test_recoat.rb
 - spec/factory/reuse_domain/test_reuse.rb
 - spec/factory/reuse_domain/test_values.rb
+- spec/factory/sbyc_domain/test_comparison.rb
 - spec/factory/sbyc_domain/test_new.rb
 - spec/factory/sbyc_domain/test_predicate.rb
-- spec/factory/sbyc_domain/test_sub_domains.rb
 - spec/factory/sbyc_domain/test_super_domain.rb
-- spec/factory/sbyc_domain/test_super_domain_of.rb
 - spec/factory/sbyc_domain/test_triple_equal.rb
 - spec/factory/scalar_domain/test_component_reader.rb
 - spec/factory/scalar_domain/test_hash.rb
@@ -159,11 +159,12 @@ test_files:
 - spec/factory/test_sbyc.rb
 - spec/factory/test_scalar.rb
 - spec/factory/test_union.rb
+- spec/factory/union_domain/test_comparison.rb
+- spec/factory/union_domain/test_greater_or_equal_to.rb
+- spec/factory/union_domain/test_greater_than.rb
 - spec/factory/union_domain/test_new.rb
 - spec/factory/union_domain/test_predicate.rb
 - spec/factory/union_domain/test_sub_domains.rb
-- spec/factory/union_domain/test_super_domain.rb
-- spec/factory/union_domain/test_super_domain_of.rb
 - spec/factory/union_domain/test_triple_equal.rb
 - spec/fixtures/attr_list.rb
 - spec/fixtures/boolean.rb

data/spec/factory/sbyc_domain/test_sub_domains.rb

@@ -1,14 +0,0 @@
-require 'spec_helper'
-module Domain
-  describe SByC, "sub_domains" do
-
-    it 'returns the sub domains passed at construction' do
-      Boolean.sub_domains.should eq([TrueClass, FalseClass])
-    end
-
-    it 'defaults an empty array' do
-      NegInt.sub_domains.should eq([])
-    end
-
-  end
-end

data/spec/factory/union_domain/test_super_domain.rb

@@ -1,10 +0,0 @@
-require 'spec_helper'
-module Domain
-  describe Union, "super_domain" do
-
-    it 'returns the super domain passed at construction' do
-      Boolean.super_domain.should be(Object)
-    end
-
-  end
-end

data/spec/factory/union_domain/test_super_domain_of.rb

@@ -1,18 +0,0 @@
-require 'spec_helper'
-module Domain
-  describe Union, "super_domain_of?" do
-
-    it 'returns true when a super domain' do
-      Boolean.should be_super_domain_of(TrueClass)
-    end
-
-    it 'returns false on itself' do
-      Boolean.should_not be_super_domain_of(Boolean)
-    end
-
-    it 'returns false when not a super domain' do
-      Boolean.should_not be_super_domain_of(Integer)
-    end
-
-  end
-end