veritas 0.0.4 → 0.0.5

data/lib/veritas/relation/operation/order/direction_set.rb

@@ -12,18 +12,80 @@ module Veritas
 
           inheritable_alias(:| => :union)
 
+          # Instantiate a DirectionSet
+          #
+          # @example
+          #   directions = DirectionSet.new(directions)
+          #
+          # @param [#to_ary] directions
+          #   optional attributes
+          #
+          # @return [undefined]
+          #
+          # @api public
+          def self.new(directions)
+            directions = coerce_directions(directions.to_ary)
+            assert_unique_attributes(directions.map { |direction| direction.attribute })
+            super
+          end
+
+          # Coerce the attributes into an Array of Direction objects
+          #
+          # @param [Array<Direction>] attributes
+          #
+          # @return [Array<Direction>]
+          #
+          # @api private
+          def self.coerce_directions(directions)
+            directions.map { |direction| Ascending.coerce(direction) }
+          end
+
+          # Assert the attributes are unique
+          #
+          # @param [Array<Attribute>] attributes
+          #
+          # @return [undefined]
+          #
+          # @raise [DuplicateAttributeError]
+          #   raised if the attributes are not unique
+          #
+          # @api private
+          def self.assert_unique_attributes(attributes)
+            duplicates = duplicate_attributes(attributes)
+            if duplicates
+              raise DuplicateAttributeError, "duplicate attributes: #{duplicates.join(', ')}"
+            end
+          end
+
+          # Returns the duplicate attribute names, if any
+          #
+          # @param [Array<Attribute>] attributes
+          #
+          # @return [Array<Symbol>]
+          #   returns an array of duplicate attributes
+          #
+          # @return [nil]
+          #   returns nil if there are no duplicate attributes
+          #
+          # @api private
+          def self.duplicate_attributes(attributes)
+            names = attributes.map { |attribute| attribute.name }
+            names.select! { |name| names.count(name) > 1 }
+            names.uniq!
+          end
+
+          private_class_method :coerce_directions, :assert_unique_attributes, :duplicate_attributes
+
           # Initialize a DirectionSet
           #
-          # @param [Array<Direction, Attribute>] attribute
-          #   the attribute to sort on
+          # @param [Array<Direction>] directions
+          #   the directions to sort with
           #
           # @return [undefined]
           #
           # @api private
           def initialize(directions)
-            @directions = directions.to_ary.map do |direction|
-              Ascending.coerce(direction)
-            end
+            @directions = directions
           end
 
           EMPTY = new([])

data/lib/veritas/relation/operation/order.rb

@@ -29,7 +29,6 @@ module Veritas
         #
         # @api public
         def self.new(operand, directions)
-          directions = operand.header if directions.empty?
           directions = DirectionSet.coerce(directions)
           assert_order_by_full_header(operand, directions)
           super
@@ -123,11 +122,33 @@ module Veritas
 
           # Return an ordered relation
           #
+          # @example
+          #   order = relation.sort_by { |r| [ r.a.desc, r.b ] }
+          #
+          # @yield [relation]
+          #   optional block to evaluate for directions
+          #
+          # @yieldparam [Relation] relation
+          #
+          # @yieldreturn [Array<Direction>, Header]
+          #
+          # @return [Order]
+          #
+          # @api public
+          def sort_by
+            context = Evaluator::Context.new(header) { |context| yield context }
+            Order.new(self, Array(context.yield))
+          end
+
+          # Return an ordered relation (Deprecated)
+          #
+          # @deprecated Use #sort_by instead
+          #
           # @example with no directions
           #   order = relation.order  # sort by the header
           #
           # @example with a block
-          #   order = relation.order { |r| [ r[:a].desc, r[:b] ] }
+          #   order = relation.order { |r| [ r.a.desc, r.b ] }
           #
           # @yield [relation]
           #   optional block to evaluate for directions
@@ -140,7 +161,8 @@ module Veritas
           #
           # @api public
           def order
-            Order.new(self, block_given? ? Array(yield(self)) : header)
+            warn "#{self.class}#order is deprecated and will be removed from Veritas 0.0.6"
+            sort_by { |context| block_given? ? yield(context) : header }
           end
 
         end # module Methods

data/lib/veritas/relation/operation/set.rb

@@ -17,6 +17,7 @@ module Veritas
         #
         # @api private
         def self.included(descendant)
+          super
           descendant.extend ClassMethods
           self
         end

data/lib/veritas/relation.rb

@@ -13,6 +13,14 @@ module Veritas
     # @api private
     attr_reader :header
 
+    # The relation tuples
+    #
+    # @return [Enumerable]
+    #
+    # @api private
+    attr_reader :tuples
+    private :tuples
+
     # The relation sort order
     #
     # @return [Operation::Order::DirectionSet]
@@ -118,6 +126,18 @@ module Veritas
       Materialized.new(header, to_a, directions)
     end
 
+    # Return false for a non-Materialized relation
+    #
+    # @example
+    #   relation.materialized?  # => false
+    #
+    # @return [false]
+    #
+    # @api public
+    def materialized?
+      false
+    end
+
     # Compare the relation with other relation for equivalency
     #
     # @example
@@ -178,13 +198,6 @@ module Veritas
 
   private
 
-    # The relation tuples
-    #
-    # @return [Enumerable]
-    #
-    # @api private
-    attr_reader :tuples
-
     # Coerce an Enumerable into a Relation
     #
     # @param [Enumerable] tuples

data/lib/veritas/support/abstract_class.rb

@@ -12,6 +12,7 @@ module Veritas
     #
     # @api private
     def self.included(descendant)
+      super
       descendant.extend ClassMethods
       self
     end

data/lib/veritas/support/evaluator.rb

@@ -4,8 +4,7 @@ module Veritas
   module Evaluator
 
     # Provide a context to evaluate a Relation operation block
-    class Context
-      include Immutable
+    class Context < BasicObject
 
       # The functions to evaluate
       #
@@ -14,6 +13,13 @@ module Veritas
       # @api private
       attr_reader :functions
 
+      # Return the block results
+      #
+      # @return [Object]
+      #
+      # @api private
+      attr_reader :yield
+
       # Initialize a Context
       #
       # @param [Header] header
@@ -24,7 +30,7 @@ module Veritas
       def initialize(header)
         @header    = header
         @functions = {}
-        yield self
+        @yield     = yield self
         @functions.freeze
       end
 
@@ -68,6 +74,46 @@ module Veritas
         @header[name]
       end
 
+      # Test if the method is supported on this object
+      #
+      # @param [Symbol] name
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      def respond_to?(name, *)
+        !!self[name]
+      end
+
+      # Forward a message to the object
+      #
+      # @param [Array] *args
+      #
+      # @return [Object]
+      #
+      # @api private
+      def send(*args, &block)
+        __send__(*args, &block)
+      end
+
+    private
+
+      # Lookup the attribute in the header using the attribute name
+      #
+      # @example
+      #   attribute = context.id
+      #
+      # @param [Symbol] name
+      #
+      # @return [Attribute]
+      #
+      # @api private
+      def method_missing(name, *args)
+        return super unless respond_to?(name)
+        ::Kernel.raise ::ArgumentError, "wrong number of arguments (#{args.length} for 0)" unless args.empty?
+        self[name]
+      end
+
     end # class Context
   end # module Evaluator
 end # module Veritas

data/lib/veritas/support/immutable.rb

@@ -14,6 +14,7 @@ module Veritas
     #
     # @api private
     def self.included(descendant)
+      super
       descendant.extend ModuleMethods if descendant.kind_of?(Module)
       descendant.extend ClassMethods  if descendant.kind_of?(Class)
       self
@@ -94,7 +95,7 @@ module Veritas
     # @api public
     def self.freeze_object(object)
       case object
-        when Numeric, TrueClass, FalseClass, NilClass
+        when Numeric, TrueClass, FalseClass, NilClass, Symbol
           object
         else
           freeze_value(object)

data/lib/veritas/tuple.rb

@@ -13,6 +13,13 @@ module Veritas
     # @api private
     attr_reader :header
 
+    # The tuple data
+    #
+    # @return [Hash]
+    #
+    # @api private
+    attr_reader :data
+
     # Initialize a Tuple
     #
     # @param [Header] header
@@ -39,7 +46,7 @@ module Veritas
     #
     # @api public
     def [](attribute)
-      @data[header[attribute]]
+      data.fetch(header[attribute])
     end
 
     # Return a tuple with only the specified attributes
@@ -54,7 +61,7 @@ module Veritas
     #
     # @api public
     def project(header)
-      self.class.new(header, @data.values_at(*header))
+      self.class.new(header, data.values_at(*header))
     end
 
     # Append values to the tuple and return a new tuple
@@ -94,6 +101,17 @@ module Veritas
       )
     end
 
+    # Return the predicate matching the tuple
+    #
+    # @return [Function]
+    #
+    # @api private
+    def predicate
+      header.reduce(Function::Proposition::Tautology.instance) do |predicate, attribute|
+        predicate.and(attribute.eq(self[attribute]))
+      end
+    end
+
     # Convert the Tuple into an Array
     #
     # @example
@@ -103,7 +121,7 @@ module Veritas
     #
     # @api public
     def to_ary
-      @data.values_at(*header).freeze
+      data.values_at(*header).freeze
     end
 
     # Compare the tuple with other tuple for equivalency
@@ -118,10 +136,8 @@ module Veritas
     #
     # @api public
     def ==(other)
-      header = self.header
-      other  = self.class.coerce(header, other)
-      header == other.header &&
-      to_ary == other.project(header).to_ary
+      other = self.class.coerce(header, other)
+      data == other.data
     end
 
     # Compare the tuple with other tuple for equality
@@ -136,10 +152,8 @@ module Veritas
     #
     # @api public
     def eql?(other)
-      header = self.header
       instance_of?(other.class) &&
-      header.eql?(other.header) &&
-      to_ary.eql?(other.project(header).to_ary)
+      data.eql?(other.data)
     end
 
     # Return the hash of the tuple
@@ -151,19 +165,19 @@ module Veritas
     #
     # @api public
     def hash
-      self.class.hash ^ header.hash ^ @data.hash
+      self.class.hash ^ data.hash
     end
 
     # Return a string representing the tuple data
     #
     # @example
-    #   tuple.inspect  # => "[1, 2, 3]"
+    #   tuple.inspect  # => "{<Attribute::Integer name: id>=>1}"
     #
     # @return [String]
     #
     # @api public
     def inspect
-      to_ary.inspect
+      data.inspect
     end
 
     # Coerce an Array-like object into a Tuple
@@ -180,7 +194,7 @@ module Veritas
       object.kind_of?(Tuple) ? object : new(header, object)
     end
 
-    memoize :hash, :to_ary
+    memoize :hash, :predicate, :to_ary
 
   end # class Tuple
 end # module Veritas

data/lib/veritas/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Veritas
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end # module Veritas

data/lib/veritas.rb

@@ -125,9 +125,6 @@ require 'veritas/version'
 
 module Veritas
 
-  # Represent an undefined argument
-  module Undefined; end
-
   # Raised when the headers are invalid for Join and Product
   class InvalidHeaderError < ArgumentError; end
 
@@ -152,6 +149,12 @@ module Veritas
   # Raised when an attribute is a duplicate of another in the header
   class DuplicateAttributeError < StandardError; end
 
+  # Represent an undefined argument
+  Undefined = Object.new.freeze
+
+  # Represent a relation with an empty header and no tuples
   TABLE_DUM = Relation::Empty.new([])
+
+  # Represent a relation with an empty header and a single tuple
   TABLE_DEE = Relation.new([], [ [] ])
 end

data/spec/integration/veritas/algebra/projection_spec.rb

@@ -6,10 +6,10 @@ describe Algebra::Projection do
   context 'remove attributes in predicate' do
     subject { restriction.project([ :name ]) }
 
-    let(:left)        { Relation.new([ [ :id, Integer ] ], (1..100).map { |n| [ n ] })                           }
-    let(:right)       { Relation.new([ [ :name, String ] ], [ [ 'Dan Kubb' ], [ 'John Doe' ], [ 'Jane Doe' ] ])  }
-    let(:relation)    { left * right                                                                             }
-    let(:restriction) { relation.restrict { |r| r[:id].gte(1).and(r[:id].lte(10)).and(r[:name].eq('Dan Kubb')) } }
+    let(:left)        { Relation.new([ [ :id, Integer ] ], (1..100).map { |n| [ n ] })                          }
+    let(:right)       { Relation.new([ [ :name, String ] ], [ [ 'Dan Kubb' ], [ 'John Doe' ], [ 'Jane Doe' ] ]) }
+    let(:relation)    { left * right                                                                            }
+    let(:restriction) { relation.restrict { |r| r.id.gte(1).and(r.id.lte(10)).and(r.name.eq('Dan Kubb')) }      }
 
     it 'returns a relation with a single tuple' do
       should == [ [ 'Dan Kubb' ] ]

data/spec/integration/veritas/relation/efficient_enumerable_spec.rb

@@ -31,7 +31,7 @@ describe Relation do
     end
 
     it '#restrict should be efficient' do
-      restricted = relation.restrict{ |r| r[:id].gt(5) }
+      restricted = relation.restrict{ |r| r.id.gt(5) }
       sample(restricted).should == [ [ 6 ], [ 7 ], [ 8 ], [ 9 ], [ 10 ] ]
     end
 

data/spec/shared/each_method_behaviour.rb

@@ -6,10 +6,10 @@ shared_examples_for 'an #each method' do
   context 'with no block' do
     subject { object.each }
 
-    it { should be_kind_of(to_enum.class) }
+    it { should be_instance_of(to_enum.class) }
 
     it 'yields the expected values' do
-      subject.to_a.should == object.to_a
+      subject.to_a.should eql(object.to_a)
     end
   end
 end

data/spec/shared/hash_method_behavior.rb

@@ -3,9 +3,9 @@
 shared_examples_for 'a hash method' do
   it_should_behave_like 'an idempotent method'
 
-  it { should be_kind_of(Fixnum) }
+  it { should be_instance_of(Fixnum) }
 
   it 'memoizes the hash code' do
-    should == object.memoized('hash')
+    subject.should eql(object.memoized('hash'))
   end
 end

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@
 
 require 'rubygems'
 require 'backports'
+require 'backports/basic_object'
 require 'veritas'
 require 'spec'
 require 'spec/autorun'

data/spec/unit/date/pred_spec.rb

@@ -7,13 +7,13 @@ describe Date, '#pred' do
 
   let(:object) { described_class.today }
 
-  it { should be_kind_of(described_class) }
+  it { should be_instance_of(described_class) }
 
   it 'returns the date 1 day ago' do
-    should == (object - 1)
+    should eql(object - 1)
   end
 
   it 'is the inverse of #succ' do
-    subject.succ.should == object
+    subject.succ.should eql(object)
   end
 end

data/spec/unit/range/overlaps_spec.rb

@@ -17,7 +17,7 @@ describe Range, '#overlaps?' do
     it { should be(false) }
 
     it 'is symmetric' do
-      should == other.overlaps?(object)
+      should eql(other.overlaps?(object))
     end
   end
 
@@ -30,7 +30,7 @@ describe Range, '#overlaps?' do
     it { should be(false) }
 
     it 'is symmetric' do
-      should == other.overlaps?(object)
+      should eql(other.overlaps?(object))
     end
   end
 
@@ -43,7 +43,7 @@ describe Range, '#overlaps?' do
     it { should be(true) }
 
     it 'is symmetric' do
-      should == other.overlaps?(object)
+      should eql(other.overlaps?(object))
     end
   end
 
@@ -56,7 +56,7 @@ describe Range, '#overlaps?' do
     it { should be(true) }
 
     it 'is symmetric' do
-      should == other.overlaps?(object)
+      should eql(other.overlaps?(object))
     end
   end
 
@@ -69,7 +69,7 @@ describe Range, '#overlaps?' do
     it { should be(true) }
 
     it 'is symmetric' do
-      should == other.overlaps?(object)
+      should eql(other.overlaps?(object))
     end
   end
 
@@ -82,7 +82,7 @@ describe Range, '#overlaps?' do
     it { should be(true) }
 
     it 'is symmetric' do
-      should == other.overlaps?(object)
+      should eql(other.overlaps?(object))
     end
   end
 
@@ -95,7 +95,7 @@ describe Range, '#overlaps?' do
     it { should be(true) }
 
     it 'is symmetric' do
-      should == other.overlaps?(object)
+      should eql(other.overlaps?(object))
     end
   end
 
@@ -108,7 +108,7 @@ describe Range, '#overlaps?' do
     it { should be(true) }
 
     it 'is symmetric' do
-      should == other.overlaps?(object)
+      should eql(other.overlaps?(object))
     end
   end
 
@@ -121,7 +121,7 @@ describe Range, '#overlaps?' do
     it { should be(true) }
 
     it 'is symmetric' do
-      should == other.overlaps?(object)
+      should eql(other.overlaps?(object))
     end
   end
 
@@ -134,7 +134,7 @@ describe Range, '#overlaps?' do
     it { should be(true) }
 
     it 'is symmetric' do
-      should == other.overlaps?(object)
+      should eql(other.overlaps?(object))
     end
   end
 
@@ -147,7 +147,7 @@ describe Range, '#overlaps?' do
     it { should be(true) }
 
     it 'is symmetric' do
-      should == other.overlaps?(object)
+      should eql(other.overlaps?(object))
     end
   end
 
@@ -160,7 +160,7 @@ describe Range, '#overlaps?' do
     it { should be(true) }
 
     it 'is symmetric' do
-      should == other.overlaps?(object)
+      should eql(other.overlaps?(object))
     end
   end
 
@@ -173,7 +173,7 @@ describe Range, '#overlaps?' do
     it { should be(true) }
 
     it 'is symmetric' do
-      should == other.overlaps?(object)
+      should eql(other.overlaps?(object))
     end
   end
 
@@ -186,7 +186,7 @@ describe Range, '#overlaps?' do
     it { should be(false) }
 
     it 'is symmetric' do
-      should == other.overlaps?(object)
+      should eql(other.overlaps?(object))
     end
   end
 end

data/spec/unit/range/to_inclusive_spec.rb

@@ -14,10 +14,10 @@ describe Range, '#to_inclusive' do
       let(:range_start) { 1 }
       let(:range_end)   { 3 }
 
-      it { should be_kind_of(described_class) }
+      it { should be_instance_of(described_class) }
 
       it 'returns an inclusive Range' do
-        should == described_class.new(1, 2)
+        should eql(described_class.new(1, 2))
       end
     end
 

data/spec/unit/time/pred_spec.rb

@@ -7,13 +7,13 @@ describe Time, '#pred' do
 
   let(:object) { described_class.now }
 
-  it { should be_kind_of(described_class) }
+  it { should be_instance_of(described_class) }
 
   it 'returns the time 1 second ago' do
-    should == (object - 1)
+    should eql(object - 1)
   end
 
   it 'is the inverse of #succ' do
-    subject.succ.should == object
+    subject.succ.should eql(object)
   end
 end

data/spec/unit/veritas/abstract_class/class_methods/new_spec.rb

@@ -10,7 +10,7 @@ describe AbstractClass::ClassMethods, '#new' do
   context 'called on a subclass' do
     let(:object) { Class.new(abstract_class) }
 
-    it { should be_kind_of(object) }
+    it { should be_instance_of(object) }
   end
 
   context 'called on the class' do