arel 1.0.1 → 2.0.0

data/MIT-LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2007-2010 Nick Kallen, Bryan Helmkamp, Emilio Tagua, Aaron Patterson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,105 @@
+History.txt
+MIT-LICENSE.txt
+Manifest.txt
+README.markdown
+Rakefile
+arel.gemspec
+lib/arel.rb
+lib/arel/attributes.rb
+lib/arel/attributes/attribute.rb
+lib/arel/compatibility/wheres.rb
+lib/arel/crud.rb
+lib/arel/delete_manager.rb
+lib/arel/deprecated.rb
+lib/arel/expression.rb
+lib/arel/expressions.rb
+lib/arel/insert_manager.rb
+lib/arel/nodes.rb
+lib/arel/nodes/and.rb
+lib/arel/nodes/assignment.rb
+lib/arel/nodes/avg.rb
+lib/arel/nodes/between.rb
+lib/arel/nodes/binary.rb
+lib/arel/nodes/count.rb
+lib/arel/nodes/delete_statement.rb
+lib/arel/nodes/does_not_match.rb
+lib/arel/nodes/equality.rb
+lib/arel/nodes/exists.rb
+lib/arel/nodes/function.rb
+lib/arel/nodes/greater_than.rb
+lib/arel/nodes/greater_than_or_equal.rb
+lib/arel/nodes/group.rb
+lib/arel/nodes/grouping.rb
+lib/arel/nodes/having.rb
+lib/arel/nodes/in.rb
+lib/arel/nodes/inner_join.rb
+lib/arel/nodes/insert_statement.rb
+lib/arel/nodes/join.rb
+lib/arel/nodes/less_than.rb
+lib/arel/nodes/less_than_or_equal.rb
+lib/arel/nodes/lock.rb
+lib/arel/nodes/matches.rb
+lib/arel/nodes/max.rb
+lib/arel/nodes/min.rb
+lib/arel/nodes/node.rb
+lib/arel/nodes/not_equal.rb
+lib/arel/nodes/not_in.rb
+lib/arel/nodes/offset.rb
+lib/arel/nodes/on.rb
+lib/arel/nodes/or.rb
+lib/arel/nodes/ordering.rb
+lib/arel/nodes/outer_join.rb
+lib/arel/nodes/select_core.rb
+lib/arel/nodes/select_statement.rb
+lib/arel/nodes/sql_literal.rb
+lib/arel/nodes/string_join.rb
+lib/arel/nodes/sum.rb
+lib/arel/nodes/table_alias.rb
+lib/arel/nodes/unqualified_column.rb
+lib/arel/nodes/update_statement.rb
+lib/arel/nodes/values.rb
+lib/arel/relation.rb
+lib/arel/select_manager.rb
+lib/arel/sql/engine.rb
+lib/arel/sql_literal.rb
+lib/arel/table.rb
+lib/arel/tree_manager.rb
+lib/arel/update_manager.rb
+lib/arel/visitors.rb
+lib/arel/visitors/dot.rb
+lib/arel/visitors/join_sql.rb
+lib/arel/visitors/mysql.rb
+lib/arel/visitors/oracle.rb
+lib/arel/visitors/order_clauses.rb
+lib/arel/visitors/postgresql.rb
+lib/arel/visitors/to_sql.rb
+lib/arel/visitors/where_sql.rb
+spec/activerecord_compat_spec.rb
+spec/attributes/attribute_spec.rb
+spec/attributes_spec.rb
+spec/crud_spec.rb
+spec/delete_manager_spec.rb
+spec/insert_manager_spec.rb
+spec/nodes/count_spec.rb
+spec/nodes/delete_statement_spec.rb
+spec/nodes/equality_spec.rb
+spec/nodes/insert_statement_spec.rb
+spec/nodes/or_spec.rb
+spec/nodes/select_core_spec.rb
+spec/nodes/select_statement_spec.rb
+spec/nodes/sql_literal_spec.rb
+spec/nodes/sum_spec.rb
+spec/nodes/update_statement_spec.rb
+spec/select_manager_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+spec/support/check.rb
+spec/support/fake_record.rb
+spec/support/matchers.rb
+spec/support/matchers/be_like.rb
+spec/support/shared/tree_manager_shared.rb
+spec/table_spec.rb
+spec/update_manager_spec.rb
+spec/visitors/join_sql_spec.rb
+spec/visitors/oracle_spec.rb
+spec/visitors/to_sql_spec.rb

data/README.markdown

@@ -1,14 +1,18 @@
-## Abstract ##
+# ARel
+
+* http://github.com/rails/arel
+
+## DESCRIPTION
 
 Arel is a Relational Algebra for Ruby. It 1) simplifies the generation complex of SQL queries and it 2) adapts to various RDBMS systems. It is intended to be a framework framework; that is, you can build your own ORM with it, focusing on innovative object and collection modeling as opposed to database compatibility and query generation.
 
-## Status ##
+## Status
 
 For the moment, Arel uses ActiveRecord's connection adapters to connect to the various engines, connection pooling, perform quoting, and do type conversion. On the horizon is the use of DataObjects instead.
 
 The long term goal, following both LINQ and DataMapper, is to have Arel adapt to engines beyond RDBMS, including XML, IMAP, YAML, etc.
 
-## A Gentle Introduction ##
+## A Gentle Introduction
 
 Generating a query with ARel is simple. For example, in order to produce
 
@@ -29,7 +33,7 @@ In other words, Arel relations implement Ruby's Enumerable interface. Let's have
 
 As you can see, Arel converts the rows from the database into a hash, the values of which are sublimated to the appropriate Ruby primitive (integers, strings, and so forth).
 
-### More Sophisticated <strike>Queries</strike> Relations ###
+### More Sophisticated Queries
 
 Here is a whirlwind tour through the most common relational operators. These will probably cover 80% of all interaction with the database.
 
@@ -56,7 +60,7 @@ What are called `LIMIT` and `OFFSET` in SQL are called `take` and `skip` in Arel
 
     users.group(users[:name]) # => SELECT * FROM users GROUP BY name
 
-The best property of the Relational Algebra is its "composability", or closure under all operations. For example, to select AND project, just "chain" the method invocations:
+The best property of the Relational Algebra is its "composability", or closure under all operations. For example, to restrict AND project, just "chain" the method invocations:
 
     users                                 \
       .where(users[:name].eq('amy'))      \
@@ -85,11 +89,11 @@ Finally, most operations take a block form. For example:
 
 This provides a (sometimes) convenient alternative syntax.
 
-### The Crazy Features ###
+### The Crazy Features
 
 The examples above are fairly simple and other libraries match or come close to matching the expressiveness of Arel (e.g., `Sequel` in Ruby).
 
-#### Complex Joins ####
+#### Complex Joins
 
 Where Arel really shines in its ability to handle complex joins and aggregations. As a first example, let's consider an "adjacency list", a tree represented in a table. Suppose we have a table `comments`, representing a threaded discussion:
 
@@ -124,7 +128,7 @@ Note that you do NOT want to do something like:
 
 This does NOT have the same meaning as the previous query, since the comments[:parent_id] reference is effectively ambiguous.
 
-#### Complex Aggregations ####
+#### Complex Aggregations
 
 My personal favorite feature of Arel, certainly the most difficult to implement, and possibly only of marginal value, is **closure under joining even in the presence of aggregations**. This is a feature where the Relational Algebra is fundamentally easier to use than SQL. Think of this as a preview of the kind of radical functionality that is to come, stuff no other "ORM" is doing.
 
@@ -180,27 +184,3 @@ As you can see, we're completely missing data for user with id 3. `dumpty` has n
     FROM users
     LEFT OUTER JOIN (SELECT user_id, count(*) as cnt FROM photos GROUP BY user_id) AS photos_aggregation
       ON photos_aggregation.user_id = users.id
-
-## ActiveRecord Adapter Support
-
-Arel provides built-in support for the following ActiveRecord DB adapters:
-
-* IBM DB
-* MySQL
-* Oracle
-* PostgreSQL
-* SQLite
-
-You can add support for other adapters by defining a SQL compiler at the appropriate place.  Here's an example: let's say
-you've got a YourSQL adapter.  Create a file at `yoursql/arel_compiler.rb` somewhere on the load path (presumably in
-the YourSQL adapter gem).  The contents of that file can be as simple as:
-
-    module Arel
-      module SqlCompiler
-        class YourSQLCompiler < GenericCompiler
-        end
-      end
-    end
-
-Override any methods as necessary.  See examples at
-[lib/arel/engines/sql/compilers](http://github.com/rails/arel/tree/master/lib/arel/engines/sql/compilers/).

data/Rakefile

@@ -0,0 +1,17 @@
+require "rubygems"
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+
+Hoe.plugin :gemspec # `gem install hoe-gemspec`
+
+Hoe.spec 'arel' do
+  developer('Aaron Patterson', 'aaron@tenderlovemaking.com')
+  developer('Bryan Halmkamp', 'bryan@brynary.com')
+  developer('Emilio Tagua', 'miloops@gmail.com')
+  developer('Nick Kallen', 'nick@example.org') # FIXME: need Nick's email
+
+  self.readme_file      = 'README.markdown'
+  self.extra_rdoc_files = FileList['README.markdown']
+  self.extra_dev_deps << ['rspec', '~> 1.3.0']
+  self.testlib = :rspec
+end

data/arel.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{arel}
+  s.version = "2.0.0.dev.20100924164835"
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Aaron Patterson", "Bryan Halmkamp", "Emilio Tagua", "Nick Kallen"]
+  s.date = %q{2010-09-24}
+  s.description = %q{Arel is a Relational Algebra for Ruby. It 1) simplifies the generation complex of SQL queries and it 2) adapts to various RDBMS systems. It is intended to be a framework framework; that is, you can build your own ORM with it, focusing on innovative object and collection modeling as opposed to database compatibility and query generation.}
+  s.email = ["aaron@tenderlovemaking.com", "bryan@brynary.com", "miloops@gmail.com", "nick@example.org"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.markdown"]
+  s.files = ["History.txt", "Manifest.txt", "README.markdown", "Rakefile", "arel.gemspec", "lib/arel.rb", "lib/arel/attributes.rb", "lib/arel/attributes/attribute.rb", "lib/arel/compatibility/wheres.rb", "lib/arel/crud.rb", "lib/arel/delete_manager.rb", "lib/arel/deprecated.rb", "lib/arel/expression.rb", "lib/arel/expressions.rb", "lib/arel/insert_manager.rb", "lib/arel/nodes.rb", "lib/arel/nodes/and.rb", "lib/arel/nodes/assignment.rb", "lib/arel/nodes/avg.rb", "lib/arel/nodes/between.rb", "lib/arel/nodes/binary.rb", "lib/arel/nodes/count.rb", "lib/arel/nodes/delete_statement.rb", "lib/arel/nodes/equality.rb", "lib/arel/nodes/exists.rb", "lib/arel/nodes/function.rb", "lib/arel/nodes/greater_than.rb", "lib/arel/nodes/greater_than_or_equal.rb", "lib/arel/nodes/group.rb", "lib/arel/nodes/grouping.rb", "lib/arel/nodes/having.rb", "lib/arel/nodes/in.rb", "lib/arel/nodes/inner_join.rb", "lib/arel/nodes/insert_statement.rb", "lib/arel/nodes/join.rb", "lib/arel/nodes/less_than.rb", "lib/arel/nodes/less_than_or_equal.rb", "lib/arel/nodes/lock.rb", "lib/arel/nodes/max.rb", "lib/arel/nodes/min.rb", "lib/arel/nodes/node.rb", "lib/arel/nodes/not_equal.rb", "lib/arel/nodes/offset.rb", "lib/arel/nodes/on.rb", "lib/arel/nodes/or.rb", "lib/arel/nodes/outer_join.rb", "lib/arel/nodes/select_core.rb", "lib/arel/nodes/select_statement.rb", "lib/arel/nodes/sql_literal.rb", "lib/arel/nodes/string_join.rb", "lib/arel/nodes/sum.rb", "lib/arel/nodes/table_alias.rb", "lib/arel/nodes/unqualified_column.rb", "lib/arel/nodes/update_statement.rb", "lib/arel/nodes/values.rb", "lib/arel/relation.rb", "lib/arel/select_manager.rb", "lib/arel/sql/engine.rb", "lib/arel/sql_literal.rb", "lib/arel/table.rb", "lib/arel/tree_manager.rb", "lib/arel/update_manager.rb", "lib/arel/visitors.rb", "lib/arel/visitors/dot.rb", "lib/arel/visitors/join_sql.rb", "lib/arel/visitors/mysql.rb", "lib/arel/visitors/oracle.rb", "lib/arel/visitors/order_clauses.rb", "lib/arel/visitors/postgresql.rb", "lib/arel/visitors/to_sql.rb", "spec/activerecord_compat_spec.rb", "spec/attributes/attribute_spec.rb", "spec/attributes_spec.rb", "spec/crud_spec.rb", "spec/delete_manager_spec.rb", "spec/insert_manager_spec.rb", "spec/nodes/count_spec.rb", "spec/nodes/delete_statement_spec.rb", "spec/nodes/equality_spec.rb", "spec/nodes/insert_statement_spec.rb", "spec/nodes/or_spec.rb", "spec/nodes/select_core_spec.rb", "spec/nodes/select_statement_spec.rb", "spec/nodes/sql_literal_spec.rb", "spec/nodes/sum_spec.rb", "spec/nodes/update_statement_spec.rb", "spec/select_manager_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "spec/support/check.rb", "spec/support/fake_record.rb", "spec/support/matchers.rb", "spec/support/matchers/be_like.rb", "spec/support/shared/tree_manager_shared.rb", "spec/table_spec.rb", "spec/update_manager_spec.rb", "spec/visitors/join_sql_spec.rb", "spec/visitors/oracle_spec.rb", "spec/visitors/to_sql_spec.rb"]
+  s.homepage = %q{http://github.com/rails/arel}
+  s.rdoc_options = ["--main", "README.markdown"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{arel}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Arel is a Relational Algebra for Ruby}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rubyforge>, [">= 2.0.4"])
+      s.add_development_dependency(%q<rspec>, ["~> 1.3.0"])
+      s.add_development_dependency(%q<hoe>, [">= 2.6.0"])
+    else
+      s.add_dependency(%q<rubyforge>, [">= 2.0.4"])
+      s.add_dependency(%q<rspec>, ["~> 1.3.0"])
+      s.add_dependency(%q<hoe>, [">= 2.6.0"])
+    end
+  else
+    s.add_dependency(%q<rubyforge>, [">= 2.0.4"])
+    s.add_dependency(%q<rspec>, ["~> 1.3.0"])
+    s.add_dependency(%q<hoe>, [">= 2.6.0"])
+  end
+end

data/lib/arel.rb

@@ -1,14 +1,35 @@
-require 'active_support/inflector'
-require 'active_support/core_ext/module/delegation'
-require 'active_support/core_ext/object/blank'
+require 'arel/crud'
 
-require 'arel/recursion/base_case'
+require 'arel/expressions'
+require 'arel/table'
+require 'arel/attributes'
+require 'arel/compatibility/wheres'
+
+#### these are deprecated
+# The Arel::Relation constant is referenced in Rails
+require 'arel/relation'
+require 'arel/expression'
+####
+
+require 'arel/visitors'
+
+require 'arel/tree_manager'
+require 'arel/insert_manager'
+require 'arel/select_manager'
+require 'arel/update_manager'
+require 'arel/delete_manager'
+require 'arel/nodes'
+
+#### these are deprecated
+require 'arel/deprecated'
+require 'arel/sql/engine'
+require 'arel/sql_literal'
+####
 
 module Arel
-  require 'arel/algebra'
-  require 'arel/sql_literal'
-  require 'arel/engines'
-  require 'arel/version'
+  VERSION = '2.0.0'
 
-  autoload :Session, 'arel/session'
+  def self.sql raw_sql
+    Arel::Nodes::SqlLiteral.new raw_sql
+  end
 end

data/lib/arel/attributes.rb

@@ -0,0 +1,20 @@
+require 'arel/attributes/attribute'
+
+module Arel
+  module Attributes
+    ###
+    # Factory method to wrap a raw database +column+ to an Arel Attribute.
+    def self.for column
+      case column.type
+      when :string, :text, :binary             then String
+      when :integer                            then Integer
+      when :float                              then Float
+      when :decimal                            then Decimal
+      when :date, :datetime, :timestamp, :time then Time
+      when :boolean                            then Boolean
+      else
+        raise NotImplementedError, "Column type `#{column.type}` is not currently handled"
+      end
+    end
+  end
+end

data/lib/arel/attributes/attribute.rb

@@ -0,0 +1,190 @@
+module Arel
+  module Attributes
+    class Attribute < Struct.new :relation, :name, :column
+      include Arel::Expressions
+
+      def not_eq other
+        Nodes::NotEqual.new self, other
+      end
+
+      def not_eq_any others
+        grouping_any :not_eq, others
+      end
+
+      def not_eq_all others
+        grouping_all :not_eq, others
+      end
+
+      def eq other
+        Nodes::Equality.new self, other
+      end
+
+      def eq_any others
+        grouping_any :eq, others
+      end
+
+      def eq_all others
+        grouping_all :eq, others
+      end
+
+      def in other
+        case other
+        when Arel::SelectManager
+          Nodes::In.new self, other.to_a.map { |x| x.id }
+        when Range
+          if other.exclude_end?
+            left  = Nodes::GreaterThanOrEqual.new(self, other.min)
+            right = Nodes::LessThan.new(self, other.max + 1)
+            Nodes::And.new left, right
+          else
+            Nodes::Between.new(self, Nodes::And.new(other.min, other.max))
+          end
+        else
+          Nodes::In.new self, other
+        end
+      end
+
+      def in_any others
+        grouping_any :in, others
+      end
+
+      def in_all others
+        grouping_all :in, others
+      end
+
+      def not_in other
+        case other
+        when Arel::SelectManager
+          Nodes::NotIn.new self, other.to_a.map { |x| x.id }
+        when Range
+          if other.exclude_end?
+            left  = Nodes::LessThan.new(self, other.min)
+            right = Nodes::GreaterThanOrEqual.new(self, other.max)
+            Nodes::Or.new left, right
+          else
+            left  = Nodes::LessThan.new(self, other.min)
+            right = Nodes::GreaterThan.new(self, other.max)
+            Nodes::Or.new left, right
+          end
+        else
+          Nodes::NotIn.new self, other
+        end
+      end
+
+      def not_in_any others
+        grouping_any :not_in, others
+      end
+
+      def not_in_all others
+        grouping_all :not_in, others
+      end
+
+      def matches other
+        Nodes::Matches.new self, other
+      end
+
+      def matches_any others
+        grouping_any :matches, others
+      end
+
+      def matches_all others
+        grouping_all :matches, others
+      end
+
+      def does_not_match other
+        Nodes::DoesNotMatch.new self, other
+      end
+
+      def does_not_match_any others
+        grouping_any :does_not_match, others
+      end
+
+      def does_not_match_all others
+        grouping_all :does_not_match, others
+      end
+
+      def gteq right
+        Nodes::GreaterThanOrEqual.new self, right
+      end
+
+      def gteq_any others
+        grouping_any :gteq, others
+      end
+
+      def gteq_all others
+        grouping_all :gteq, others
+      end
+
+      def gt right
+        Nodes::GreaterThan.new self, right
+      end
+
+      def gt_any others
+        grouping_any :gt, others
+      end
+
+      def gt_all others
+        grouping_all :gt, others
+      end
+
+      def lt right
+        Nodes::LessThan.new self, right
+      end
+
+      def lt_any others
+        grouping_any :lt, others
+      end
+
+      def lt_all others
+        grouping_all :lt, others
+      end
+
+      def lteq right
+        Nodes::LessThanOrEqual.new self, right
+      end
+
+      def lteq_any others
+        grouping_any :lteq, others
+      end
+
+      def lteq_all others
+        grouping_all :lteq, others
+      end
+
+      def asc
+        Nodes::Ordering.new self, :asc
+      end
+
+      def desc
+        Nodes::Ordering.new self, :desc
+      end
+
+      private
+
+      def grouping_any method_id, others
+        first = send method_id, others.shift
+
+        Nodes::Grouping.new others.inject(first) { |memo,expr|
+          Nodes::Or.new(memo, send(method_id, expr))
+        }
+      end
+
+      def grouping_all method_id, others
+        first = send method_id, others.shift
+
+        Nodes::Grouping.new others.inject(first) { |memo,expr|
+          Nodes::And.new(memo, send(method_id, expr))
+        }
+      end
+    end
+
+    class String  < Attribute; end
+    class Time    < Attribute; end
+    class Boolean < Attribute; end
+    class Decimal < Attribute; end
+    class Float   < Attribute; end
+    class Integer < Attribute; end
+  end
+
+  Attribute = Attributes::Attribute
+end