veritas 0.0.4 → 0.0.5

data/.travis.yml

@@ -1,8 +1,10 @@
 bundler_args: --without guard metrics
 script: "bundle exec rake spec"
 rvm:
-  - ree
   - 1.8.7
   - 1.9.2
-  - ruby-head
   - rbx
+  # - rbx-2.0
+  - ree
+  # - jruby
+  - ruby-head

data/Gemfile

@@ -3,19 +3,18 @@
 source :rubygems
 
 group :development do
-  gem 'backports', '~> 2.2.1'
-  gem 'jeweler',   '~> 1.6.0'
-  gem 'rake',      '~> 0.9.0'
+  gem 'backports', '~> 2.3.0'
+  gem 'jeweler',   '~> 1.6.4'
+  gem 'rake',      '~> 0.9.2'
   gem 'rspec',     '~> 1.3.2'
-  gem 'yard',      '~> 0.7.1'
+  gem 'yard',      '~> 0.7.2'
 end
 
 group :guard do
-  gem 'growl',         '~> 1.0.3'
-  gem 'guard',         '~> 0.3.4'
+  gem 'guard',         '~> 0.5.1'
   gem 'guard-bundler', '~> 0.1.3'
   gem 'guard-ego',     '~> 0.0.1'
-  gem 'guard-rspec',   '~> 0.3.1'
+  gem 'guard-rspec',   '~> 0.4.0'
 end
 
 group :benchmarks do
@@ -33,7 +32,7 @@ platforms :mri_18 do
     gem 'flay',      '~> 1.4.2'
     gem 'flog',      '~> 2.5.1'
     gem 'heckle',    '~> 1.4.3'
-    gem 'json',      '~> 1.5.1'
+    gem 'json',      '~> 1.5.3'
     gem 'metric_fu', '~> 2.1.1'
     gem 'mspec',     '~> 1.5.17'
     gem 'rcov',      '~> 0.9.9'

data/README.rdoc

@@ -36,19 +36,19 @@ http://travis-ci.org/dkubb/veritas.png
   new_relation = relation.difference(other)  # OR relation - other
 
   # restriction
-  new_relation = relation.restrict { |r| r[:a].eq('other').and(r[:b].gte(42)) }
+  new_relation = relation.restrict { |r| r.a.eq('other').and(r.b.gte(42)) }
 
   # theta-join
-  new_relation = relation.join(other) { |r| r[:a].gte(r[:b]) }
+  new_relation = relation.join(other) { |r| r.a.gte(r.b) }
 
   # NOTE: theta-join is effectively restricting a product of the relations
 
   # extend
-  new_relation = relation.extend { |r| r.add(:total, r[:unit_price] * r[:quantity]) }
+  new_relation = relation.extend { |r| r.add(:total, r.unit_price * r.quantity) }
   new_relation = relation.extend { |r| r.add(:total) { |t| t[:unit_price] * t[:quantity] } }
 
   # summarize
-  new_relation = relation.summarize(relation.project([ :name ])) { |r| r.add(:count, r[:name].count) }
+  new_relation = relation.summarize(relation.project([ :name ])) { |r| r.add(:count, r.name.count) }
   new_relation = relation.summarize(relation.project([ :name ])) { |r| r.add(:count) { |acc, t| acc.to_i + 1 } }
 
   # Non-Relational Operators
@@ -57,14 +57,11 @@ http://travis-ci.org/dkubb/veritas.png
   # returns a set that represents the relation header
   header = relation.header
 
-  # simplifies and normalizes the relation operations
-  optimized_relation = relation.optimize
-
   # a relation is Enumerable
   relation = relation.each { |tuple| ... }
 
   # order by attribute and direction
-  new_relation = relation.order { |r| [ r[:a].desc, r[:b] ] }
+  new_relation = relation.sort_by { |r| [ r.a.desc, r.b ] }
 
   # reverse the relation (only allowed if ordered)
   new_relation = relation.reverse
@@ -83,14 +80,6 @@ http://travis-ci.org/dkubb/veritas.png
   new_relation = relation.last      # default is 1
   new_relation = relation.last(5)
 
-  # CRUD Operators
-  # --------------
-
-  # can only modify relations that project all candidate keys for the base relations
-  new_relation = relation.create(a: 'test', b: 'other', c: 'yet another')
-  new_relation = relation.update(a: 'test', b: 'other', c: 'yet another')
-  new_relation = relation.delete
-
 == Goals
 
 The purpose of this project is to expand my knowledge of relational algebra by attempting to implement a simple query system using the primitive operations defined in relational algebra.
@@ -107,18 +96,28 @@ Not only does this work nicely with associations, but it will allow DataMapper t
 
 The first phase of this project will be to implement all the operations listed below using in-memory data structures. I'm focusing on the API, and making sure the specs ensure the desired results are obtained from each operation.
 
-This is 100% complete now.
+This is 100% complete.
 
 === Phase 2: RDBMS Engines
 
 The second phase of this project will be to add a RDBMS based engine, and move the in-memory matching to it's own engine. I'll also be working on a system where if the primary engine cannot carry out some operation, that it first look at alternate forms (eg. using a join instead of an intersection), and then fall-back to in-memory matching. I also want to look at re-arranging queries so that all the operations that can be performed natively are "pushed down" the hierarchy and then the in-memory matching is performed last.
 
-This is 90% complete. I have finished a first pass on the veritas-sql-compiler[https://github.com/dkubb/veritas-sql-compiler] which is a visitor that walks the AST and produces SQL for every operation except extend and summarize. To finish those I will need to add function support to veritas that are introspectable (i.e. not Proc objects). Once I can introspect them, then I can serialize them to SQL and other query languages.
+This is 95% complete. I have completed a first pass on veritas-sql-generator[https://github.com/dkubb/veritas-sql-generator] which is a visitor that walks the AST and produces SQL for every operatione. More work is needed to write adapters that use the veritas-sql-generator and manage database connections/execution.
 
 === Phase 3: DataMapper Integration
 
 The third phase of this project will be to add a few NoSQL engines (like MongoDB[http://www.mongodb.org/] and CouchDB[http://couchdb.org/]) and then look at writing a DataMapper adapter that translates Query objects into Veritas relations. I want to make sure all the DM specs pass with this adapter and each engine, and if everything goes well I will look at updating DM to work directly on top of Veritas.
 
+== Related Projects
+
+* veritas-optimizer[https://github.com/dkubb/veritas-optimizer]
+
+This is an optimizer that takes a veritas relation, scalar or aggregate function and will transform it into something equivalent but simpler in structure to the original.
+
+* veritas-sql-generator[https://github.com/dkubb/veritas-sql-generator]
+
+This is a visitor class that takes a veritas relation and generates valid SQL from it.
+
 == Note on Patches/Pull Requests
 
 * If you want your code merged into the mainline, please discuss

data/Rakefile

@@ -5,7 +5,7 @@ require 'rake'
 require File.expand_path('../lib/veritas/version', __FILE__)
 
 begin
-  gem('jeweler', '~> 1.6.0') if respond_to?(:gem, true)
+  gem('jeweler', '~> 1.6.2') if respond_to?(:gem, true)
   require 'jeweler'
 
   Jeweler::Tasks.new do |gem|
@@ -23,5 +23,5 @@ begin
 
   FileList['tasks/**/*.rake'].each { |task| import task }
 rescue LoadError
-  puts 'Jeweler (or a dependency) not available. Install it with: gem install jeweler -v 1.6.0'
+  puts 'Jeweler (or a dependency) not available. Install it with: gem install jeweler -v 1.6.2'
 end

data/TODO

@@ -1,3 +1,8 @@
+* Materialized relations need to hold a reference to the original relation.
+  * Especially "empty" relations should hold a reference to the original
+    relation so that insert/update can be performed on them if they are
+    empty not because they are valid, but because the source object is empty
+
 * Remove Order, Reverse, Limit and Offset from the Relation inheritance chain
   * Instead make it so they are proxy classes that wrap Relations, but
     proxy method calls to the Relation methods, and then wrap the return
@@ -12,7 +17,7 @@
     and instead wrap materialized relations in the Order object
     if any.
 
-* Add Relation#nest and Relation#unnest
+* Add Relation#group and Relation#ungroup
 
 * Update Attributes so that constraints are modelled using predicates,
   so that when "join-ability" is tested, the predicates can just be
@@ -40,16 +45,15 @@
     * The #call method should propagate the Tuple down to each callable entry
       in the Enumerable.
 
-* Update context to return an object that allows aliasing of ruby-ish predicates
-  to specific operations, eg:
-  * Predicates:
-    * Alias #== to #eq (may break alot)
-    * Alias #!= to #ne (in 1.9 only)
-    * Alias #>= to #gte
-    * Alias #> to #gt
-    * Alias #<= to #lte
-    * Alias #< to #lt
-    * Alias #=~ to #match
-  * Direction:
-    * Alias #@+ to #asc
-    * Alias #@- to #desc
+* Within the restriction context, make sure the attributes have aliases for:
+  * Alias #== to #eq (may break alot)
+  * Alias #!= to #ne (in 1.9 only)
+  * Alias #>= to #gte
+  * Alias #> to #gt
+  * Alias #<= to #lte
+  * Alias #< to #lt
+  * Alias #=~ to #match
+
+* Within the sort_by context, make sure the attributes have aliases for:
+  * Alias #@+ to #asc
+  * Alias #@- to #desc

data/benchmarks/memory.rb

@@ -7,6 +7,7 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
 require 'backports'
+require 'backports/basic_object'
 
 unless GC.respond_to?(:enable_stats)
   puts 'Error: benchmark works on ree, or ruby with Railsbench GC patch only'
@@ -94,7 +95,7 @@ end
 
 each_count do |array, relation, count|
   gc_statistics "restriction (#{count} tuples)" do
-    relation.restrict { |r| r[:id].gte(1) }.each {}
+    relation.restrict { |r| r.id.gte(1) }.each {}
   end
 end
 
@@ -130,12 +131,12 @@ end
 
 each_count do |array, relation, count|
   gc_statistics "order (#{count} tuples)" do
-    relation.order { |r| [ r[:id].desc, r[:name] ] }.each {}
+    relation.sort_by { |r| [ r.id.desc, r.name ] }.each {}
   end
 end
 
 each_count do |array, relation, count|
-  relation = relation.order(relation.header)
+  relation = relation.sort_by { |r| [ r.id, r.name ] }
 
   gc_statistics "take (#{count} tuples)" do
     relation.take(count).each {}
@@ -143,7 +144,7 @@ each_count do |array, relation, count|
 end
 
 each_count do |array, relation, count|
-  relation = relation.order(relation.header)
+  relation = relation.sort_by { |r| [ r.id, r.name ] }
 
   gc_statistics "drop (#{count} tuples)" do
     relation.drop(1).each {}
@@ -151,7 +152,7 @@ each_count do |array, relation, count|
 end
 
 each_count do |array, relation, count|
-  relation = relation.order(relation.header)
+  relation = relation.sort_by { |r| [ r.id, r.name ] }
 
   gc_statistics "first (#{count} tuples)" do
     relation.first(count).each {}
@@ -159,7 +160,7 @@ each_count do |array, relation, count|
 end
 
 each_count do |array, relation, count|
-  relation = relation.order(relation.header)
+  relation = relation.sort_by { |r| [ r.id, r.name ] }
 
   gc_statistics "last (#{count} tuples)" do
     relation.last(count).each {}
@@ -167,7 +168,7 @@ each_count do |array, relation, count|
 end
 
 each_count do |array, relation, count|
-  relation = relation.order(relation.header)
+  relation = relation.sort_by { |r| [ r.id, r.name ] }
 
   gc_statistics "reverse (#{count} tuples)" do
     relation.reverse.each {}

data/benchmarks/speed.rb

@@ -7,6 +7,7 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
 require 'backports'
+require 'backports/basic_object'
 require 'rbench'
 require 'veritas'
 include Veritas
@@ -18,7 +19,7 @@ array    = (1..100).map { |n| Tuple.new(header, [ n, 'Dan Kubb' ]) }
 relation = Relation.new(header, array)
 join     = Relation.new([ [ :id, Integer, ], [ :age, Integer ] ], [ [ 1, 35 ] ])
 product  = Relation.new([ [ :age, Integer ] ], [ [ 35 ] ])
-ordered  = relation.order(relation.header)
+ordered  = relation.sort_by { |r| [ r.id, r.name ] }
 
 RBench.run(TIMES) do
   column :ruby,    :title => 'Ruby'
@@ -42,7 +43,7 @@ RBench.run(TIMES) do
 
   report 'restriction' do
     ruby    { array.select { |tuple| tuple[:id] >= 1 }.each {} }
-    veritas { relation.restrict { |r| r[:id].gte(1) }.each {}  }
+    veritas { relation.restrict { |r| r.id.gte(1) }.each {}  }
   end
 
   report 'join' do
@@ -71,7 +72,7 @@ RBench.run(TIMES) do
 
   report 'order' do
     ruby    { array.sort_by { |tuple| [ -tuple[:id], tuple[:name] ] }.each {} }
-    veritas { relation.order { |r| [ r[:id].desc, r[:name] ] }.each {}        }
+    veritas { relation.sort_by { |r| [ r.id.desc, r.name ] }.each {}      }
   end
 
   report 'take' do

data/config/flay.yml

@@ -1,3 +1,3 @@
 ---
 threshold: 68
-total_score: 654
+total_score: 738

data/lib/veritas/aggregate.rb

@@ -86,6 +86,9 @@ module Veritas
 
     # Return the type returned from #call
     #
+    # @example
+    #   type = aggregate.type
+    #
     # @return [Class<Attribute>]
     #
     # @api public

data/lib/veritas/algebra/join.rb

@@ -7,6 +7,13 @@ module Veritas
     class Join < Relation
       include Relation::Operation::Combination
 
+      # The common headers between the operands
+      #
+      # @return [Header]
+      #
+      # @api private
+      attr_reader :join_header
+
       # Instantiate a new Join
       #
       # @example
@@ -54,7 +61,7 @@ module Veritas
         super
         right_header      = right.header
         @join_header      = left.header  & right_header
-        @remainder_header = right_header - @join_header
+        @remainder_header = right_header - join_header
       end
 
       # Iterate over each tuple in the set
@@ -73,8 +80,8 @@ module Veritas
       # @api public
       def each(&block)
         return to_enum unless block_given?
-        index = build_index
         util  = Relation::Operation::Combination
+        index = build_index
 
         left.each do |left_tuple|
           right_tuples = index[join_tuple(left_tuple)]
@@ -109,7 +116,7 @@ module Veritas
       #
       # @api private
       def join_tuple(tuple)
-        tuple.project(@join_header)
+        tuple.project(join_header)
       end
 
       # Generate a tuple with the disjoint attributes to use in the join
@@ -132,7 +139,7 @@ module Veritas
         #   join = relation.join(other)
         #
         # @example theta-join using a block
-        #   join = relation.join(other) { |r| r[:a].gte(r[:b]) }
+        #   join = relation.join(other) { |r| r.a.gte(r.b) }
         #
         # @param [Relation] other
         #   the other relation to join

data/lib/veritas/algebra/product.rb

@@ -58,8 +58,9 @@ module Veritas
       # @api public
       def each(&block)
         return to_enum unless block_given?
+        right_tuples = right.to_a
         left.each do |left_tuple|
-          Relation::Operation::Combination.combine_tuples(header, left_tuple, right, &block)
+          Relation::Operation::Combination.combine_tuples(header, left_tuple, right_tuples, &block)
         end
         self
       end

data/lib/veritas/algebra/restriction.rb

@@ -83,7 +83,7 @@ module Veritas
         # Return a relation with restricted tuples
         #
         # @example restriction using a block
-        #   restriction = relation.restrict { |r| r[:a].eq('other').and(r[:b].gte(42)) }
+        #   restriction = relation.restrict { |r| r.a.eq('other').and(r.b.gte(42)) }
         #
         # @yield [relation]
         #   optional block to restrict the tuples with
@@ -98,7 +98,8 @@ module Veritas
         #
         # @api public
         def restrict
-          Restriction.new(self, yield(self))
+          context = Evaluator::Context.new(header) { |context| yield context }
+          Restriction.new(self, context.yield)
         end
 
       end # module Methods

data/lib/veritas/algebra/summarization.rb

@@ -155,14 +155,19 @@ module Veritas
 
         # Return a summarized relation
         #
+        # @example with no arguments
+        #   summarization = relation.summarize do |context|
+        #     context.add(:count, context[:id].count)
+        #   end
+        #
         # @example with a relation
         #   summarization = relation.summarize(relation.project([ :name ])) do |context|
-        #     context.add(:count, context[:name].count)
+        #     context.add(:count, context[:id].count)
         #   end
         #
         # @example with a header
         #   summarization = relation.summarize([ :name ]) do |context|
-        #     context.add(:count, context[:name].count)
+        #     context.add(:count, context[:id].count)
         #   end
         #
         # @param [Relation, Header, #to_ary] summarize_with
@@ -176,7 +181,7 @@ module Veritas
         # @return [Summarization]
         #
         # @api public
-        def summarize(summarize_with)
+        def summarize(summarize_with = TABLE_DEE)
           summarize_per = coerce_to_relation(summarize_with)
           context       = Evaluator::Context.new(header - summarize_per.header) { |context| yield context }
           Summarization.new(self, summarize_per, context.functions)

data/lib/veritas/attribute/string.rb

@@ -93,7 +93,9 @@ module Veritas
       #
       # @api public
       def joinable?(other)
-        super && length.eql?(other.length)
+        super                             &&
+        min_length.eql?(other.min_length) &&
+        max_length.eql?(other.max_length)
       end
 
     private

data/lib/veritas/attribute.rb

@@ -31,7 +31,7 @@ module Veritas
     # @api private
     def self.inherited(descendant)
       superclass = self.superclass
-      superclass.inherited(descendant) unless superclass.equal?(::Object)
+      superclass.inherited(descendant) if superclass.respond_to?(:descendants)
       descendants.unshift(descendant)
       self
     end

data/lib/veritas/function/binary.rb

@@ -85,6 +85,7 @@ module Veritas
         #
         # @api private
         def self.included(descendant)
+          super
           descendant.memoize :inverse
         end
 

data/lib/veritas/function/comparable.rb

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

data/lib/veritas/function/connective/negation.rb

@@ -65,6 +65,8 @@ module Veritas
           # @example with other argument
           #   conjunction = expression.not(other)
           #
+          # @return [Connective]
+          #
           # @overload not
           #   Negates the expression
           #

data/lib/veritas/function/proposition.rb

@@ -5,7 +5,11 @@ module Veritas
 
     # Abstract base class for logical propositions
     class Proposition < Function
-      include AbstractClass, Singleton
+      include AbstractClass,
+              Singleton,
+              Function::Connective::Conjunction::Methods,
+              Function::Connective::Disjunction::Methods,
+              Function::Connective::Negation::Methods
 
       # Instantiate a new Proposition
       #

data/lib/veritas/function/unary.rb

@@ -79,6 +79,7 @@ module Veritas
           #
           # @api private
           def self.included(descendant)
+            super
             descendant.memoize :inverse
           end
 

data/lib/veritas/function.rb

@@ -41,6 +41,9 @@ module Veritas
 
     # Evaluate the function using the operands
     #
+    # @example
+    #   object = function.call(*args)
+    #
     # @return [Object]
     #
     # @api public

data/lib/veritas/relation/base.rb

@@ -9,7 +9,7 @@ module Veritas
       # The base relation name
       #
       # @example
-      #   name = base_relation.name
+      #   name = base.name
       #
       # @return [#to_s]
       #
@@ -28,11 +28,40 @@ module Veritas
       # @return [undefined]
       #
       # @api private
-      def initialize(name, *args)
-        super(*args)
+      def initialize(name, header, tuples = Empty::ZERO_TUPLE)
+        super(header, tuples)
         @name = Immutable.freeze_object(name.to_s)
       end
 
+      # Compare the base relation with other relation for equality
+      #
+      # @example
+      #   base.eql?(other)  # => true or false
+      #
+      # @param [Relation] other
+      #   the other relation to compare with
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def eql?(other)
+        super && name.eql?(other.name)
+      end
+
+      # Return the hash of the base relation
+      #
+      # @example
+      #   hash = base.hash
+      #
+      # @return [Fixnum]
+      #
+      # @api public
+      def hash
+        super ^ name.hash
+      end
+
+      memoize :hash
+
     end # class Base
   end # class Relation
 end # module Veritas

data/lib/veritas/relation/header.rb

@@ -26,7 +26,7 @@ module Veritas
       #
       # @api public
       def self.new(attributes = [])
-        attributes = coerce_attributes(attributes).freeze
+        attributes = coerce_attributes(attributes.to_ary)
         assert_unique_attributes(attributes)
         super
       end
@@ -39,7 +39,7 @@ module Veritas
       #
       # @api private
       def self.coerce_attributes(attributes)
-        attributes.to_ary.map { |attribute| Attribute.coerce(attribute) }
+        attributes.map { |attribute| Attribute.coerce(attribute) }
       end
 
       # Assert the attributes are unique

data/lib/veritas/relation/materialized.rb

@@ -42,6 +42,18 @@ module Veritas
         self
       end
 
+      # Return true for a Materialized relation
+      #
+      # @example
+      #   relation.materialized?  # => true
+      #
+      # @return [true]
+      #
+      # @api public
+      def materialized?
+        true
+      end
+
       # Test if there are no tuples
       #
       # @example

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

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

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

@@ -71,7 +71,7 @@ module Veritas
         #
         # @api private
         def self.assert_valid_limit(limit)
-          if limit < 0
+          if limit.nil? || limit < 0
             raise InvalidLimitError, "limit must be greater than or equal to 0, but was #{limit.inspect}"
           end
         end

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

@@ -71,7 +71,7 @@ module Veritas
         #
         # @api private
         def self.assert_valid_offset(offset)
-          if offset < 0
+          if offset.nil? || offset < 0
             raise InvalidOffsetError, "offset must be greater than or equal to 0, but was #{offset.inspect}"
           end
         end