arel-helpers 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 61f2686d698c0636f36437e6d74562670d5ff0c4
-  data.tar.gz: 1f9126e6e36e9c45104fd11b5ffeb7afb6d82118
+  metadata.gz: a7fcf6cccc8b45ef008f68a1da1ef9e8b468d474
+  data.tar.gz: dc76542898067426f8715ccb4b91b2b1d48f1787
 SHA512:
-  metadata.gz: e4fe390a4e6fb4e1cd8d8ddd105e1172b26e5c378ce74127fad57ed6cc5bcb2469702f264e02f13fb655e3f523d4b75e237ea7ccbce2029d1f60299b14d4f636
-  data.tar.gz: 6b2f0c69c50bdb7e36b8d58614b986861a699bf4f39b930c8c1c7caba393ef8bd189df3f2142035a46b5f775408d046454dfa6f22aa7d997193c369b42582870
+  metadata.gz: 3c95d188bfb80db50e13f8c98d7847bca7abc6c0b95502c22efd0eef043f1a5ec0b71b5c71410cfeaeabfb9533ae9ee02099d5fc55644f886fe95599ecd1631a
+  data.tar.gz: b74df2e5fd0224f8945219944888eea41be7e78532f4e277ae1e17eb3fc5ba792a35e0957e08b1b0dc87cd8a376d4b769c99fb0981c12475ca54efca404e084d

data/History.txt

@@ -4,4 +4,8 @@
 
 == 1.1.0
 
-* Adding the QueryBuilder class.
+* Adding the QueryBuilder class.
+
+== 1.2.0
+
+* Adding Rails 4 support.

data/README.md

@@ -0,0 +1,154 @@
+
+
+## arel-helpers [![Build Status](https://secure.travis-ci.org/camertron/arel-helpers.png?branch=master)](http://travis-ci.org/camertron/arel-helpers)
+
+Useful tools to help construct database queries with ActiveRecord and Arel.
+
+## Installation
+
+`gem install arel-helpers`
+
+## Usage
+
+```ruby
+require 'arel-helpers'
+```
+
+### ArelTable Helper
+
+Usually you'd reference database columns in Arel via the `#arel_table` method on your ActiveRecord models. For example:
+
+```ruby
+class Post < ActiveRecord::Base
+  ...
+end
+
+Post.where(Post.arel_table[:id].eq(1))
+```
+
+Typing ".arel_table" over and over again can get pretty old and make constructing queries unnecessarily verbose. Try using the `ArelTable` helper to clean things up a bit:
+
+```ruby
+class Post < ActiveRecord::Base
+  include ArelHelpers::ArelTable
+  ...
+end
+
+Post.where(Post[:id].eq(1))
+```
+
+### JoinAssociation Helper
+
+Using pure Arel is probably one of the only ways to do an outer join with ActiveRecord. For example, let's say we have these two models:
+
+```ruby
+class Post < ActiveRecord::Base
+  has_many :comments
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :post
+end
+```
+
+A join between posts and comments might look like this:
+
+```ruby
+Post.joins(:comments)
+```
+
+ActiveRecord introspects the association between posts and comments and automatically chooses the right columns to use in the join conditions.
+
+Things start to get messy however if you wanted to do an outer join instead of the default inner join. Your query might look like this:
+
+```ruby
+Post
+  .joins(
+    Post.arel_table.join(Comments.arel_table, Arel::OuterJoin)
+      .on(Post[:id].eq(Coments[:post_id]))
+      .join_sources
+  )
+```
+
+Such verbose. Much code. Very bloat. Wow. We've lost all the awesome association introspection that ActiveRecord would otherwise have given us. Enter `ArelHelpers::JoinAssociation`:
+
+```ruby
+include ArelHelpers::JoinAssociation
+Post.joins(join_association(Post, :comments, Arel::OuterJoin))
+```
+
+Easy peasy.
+
+`JoinAssociation` also allows you to customize the join conditions via a block:
+
+```ruby
+Post.joins(
+  join_association(Post, :comments, Arel::OuterJoin) do |assoc_name, join_conditions|
+    join_conditions.and(Post[:author_id].eq(4))
+  end
+)
+```
+
+### Query Builders
+
+ArelHelpers also contains a very simple class that's designed to provide a light framework for constructing queries using the builder pattern. For example, let's write a class that encapsulates generating queries for blog posts:
+
+```ruby
+class PostQueryBuilder < ArelHelpers::QueryBuilder
+  def initialize(query = nil)
+    # whatever you want your initial query to be
+    super(query || post.unscoped)
+  end
+
+  def with_title_matching(title)
+    reflect(
+      query.where(post[:title].matches("%#{title}%"))
+    )
+  end
+
+  def with_comments_by(usernames)
+    reflect(
+      query
+        .joins(:comments => :author)
+        .where(Author[:username].in(usernames))
+    )
+  end
+
+  def since_yesterday
+    reflect(
+      query.where(post[:created_at].gteq(Date.yesterday))
+    )
+  end
+
+  private
+
+  def author
+    Author
+  end
+
+  def post
+    Post
+  end
+end
+```
+
+The `#reflect` method creates a new instance of `PostQueryBuilder`, copies the query into it and returns the new query builder instance. This allows you to chain your method calls:
+
+```ruby
+PostQueryBuilder.new
+  .with_comments_by(['camertron', 'catwithtail'])
+  .with_title_matching("arel rocks")
+  .since_yesterday
+```
+
+## Requirements
+
+No external requirements. Depends on SQLite for testing purposes.
+
+## Running Tests
+
+`bundle exec rspec`
+
+## Authors
+
+* Cameron C. Dutro: http://github.com/camertron

data/arel-helpers.gemspec

@@ -13,7 +13,11 @@ Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
   s.has_rdoc = true
 
-  s.add_dependency 'activerecord', '~> 3.0'
+  if ENV["AR"]
+    s.add_dependency 'activerecord', ENV["AR"]
+  else
+    s.add_dependency 'activerecord', '>= 3.1.0', '<= 4.1.0'
+  end
 
   s.require_path = 'lib'
   s.files = Dir["{lib,spec}/**/*", "Gemfile", "History.txt", "README.md", "Rakefile", "arel-helpers.gemspec"]

data/lib/arel-helpers/join_association.rb

@@ -6,9 +6,19 @@ module ArelHelpers
     # activerecord uses JoinDependency to automagically generate inner join statements for
     # any type of association (belongs_to, has_many, and has_and_belongs_to_many).
     # For example, for HABTM associations, two join statements are required.
-    # This method encapsulates that functionality and returns a SelectManager for chaining.
+    # This method encapsulates that functionality and yields an intermediate object for chaining.
     # It also allows you to use an outer join instead of the default inner via the join_type arg.
-    def join_association(table, association, join_type = Arel::InnerJoin)
+    def join_association(table, association, join_type = Arel::InnerJoin, &block)
+      if ActiveRecord::VERSION::STRING >= '4.1.0'
+        join_association_4_1(table, association, join_type, &block)
+      else
+        join_association_3_1(table, association, join_type, &block)
+      end
+    end
+
+    private
+
+    def join_association_3_1(table, association, join_type)
       associations = association.is_a?(Array) ? association : [association]
       join_dependency = ActiveRecord::Associations::JoinDependency.new(table, associations, [])
       manager = Arel::SelectManager.new(table)
@@ -29,5 +39,20 @@ module ArelHelpers
       end
     end
 
+    def join_association_4_1(table, association, join_type)
+      associations = association.is_a?(Array) ? association : [association]
+      join_dependency = ActiveRecord::Associations::JoinDependency.new(table, associations, [])
+
+      join_dependency.join_constraints([]).map do |constraint|
+        right = if block_given?
+          yield constraint.left.name.to_sym, constraint.right
+        else
+          constraint.right
+        end
+
+        join_type.new(constraint.left, right)
+      end
+    end
+
   end
 end

data/lib/arel-helpers/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 
 module ArelHelpers
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: arel-helpers
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Cameron Dutro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-22 00:00:00.000000000 Z
+date: 2014-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.1.0
+    - - <=
+      - !ruby/object:Gem::Version
+        version: 4.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+    - - <=
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 4.1.0
 description: Useful tools to help construct database queries with ActiveRecord and
   Arel.
 email:
@@ -32,20 +38,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- Gemfile
-- History.txt
-- README.md
-- Rakefile
-- arel-helpers.gemspec
-- lib/arel-helpers.rb
 - lib/arel-helpers/arel_table.rb
 - lib/arel-helpers/join_association.rb
 - lib/arel-helpers/query_builder.rb
 - lib/arel-helpers/version.rb
+- lib/arel-helpers.rb
 - spec/arel_table_spec.rb
 - spec/join_association_spec.rb
 - spec/query_builder_spec.rb
 - spec/spec_helper.rb
+- Gemfile
+- History.txt
+- README.md
+- Rakefile
+- arel-helpers.gemspec
 homepage: http://github.com/camertron
 licenses: []
 metadata: {}
@@ -65,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Useful tools to help construct database queries with ActiveRecord and Arel.