arlj 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 674e9b2df96b4850dc128bc5de58252833a7ba95
-  data.tar.gz: aa92466cd390f09ad567acbad0a05a13cdfa995f
+  metadata.gz: a58db94fac67a5fa42539b8b1cc30beaf1134207
+  data.tar.gz: 3ffd40c1670e27ed4e6eefe82b20df628dd7b361
 SHA512:
-  metadata.gz: f6498872bd416cb091ab5a69ded518af390097483583a72bb00217598373da17f608f2234ce49376978673acbd7b5e479120f1567f261ba0270ad43e449b1253
-  data.tar.gz: 6ed666eb60114b8225dd5ad04e51cc07094cbd81e3be9f8170af3c38e30606c2c7424f2c58aa651dcb17ac6bc4488b52547a9dbbd3f6737260c72c7ffd1ff368
+  metadata.gz: caf5c2c6a30881344c5f75074a5a1131263f68614574b28f3790a475008d638cd8745dbdbc3c0f0d7085d4bc863d112b310020b14ba06d3fa3613d133ef803d8
+  data.tar.gz: 5276383d71fdf062b199cd3370dfac5258fccf7856f5a753e8444dd5a741ab8d64ec19ba2c34b79d005e14d0286502ee4f89108bb5e5d49a159267ab7e2237ff

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+- 1.9.3
+- 2.0.0
+- 2.1.5

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 fengb
+Copyright (c) 2014 Benjamin Feng
 
 MIT License
 

data/README.md

@@ -1,4 +1,4 @@
-# Arlj - ActiveRecord Left Join
+# Arlj - ActiveRecord Left Join [![Travis CI](https://travis-ci.org/fengb/arlj.svg?branch=master)](https://travis-ci.org/fengb/arlj)
 
 Make left joins feel like first-class citizens in ActiveRecord.
 
@@ -37,7 +37,7 @@ ActiveRecord::Base.extend Arlj
 Then begin to left join!
 
 ```ruby
-puts Parent.arlj(:children).group('records.id').select('COUNT(children.id)').to_sql
+puts Parent.left_joins(:children).group('records.id').select('COUNT(children.id)').to_sql
 => SELECT COUNT(children.id)
      FROM "parents"
      LEFT OUTER JOIN "children"
@@ -45,12 +45,12 @@ puts Parent.arlj(:children).group('records.id').select('COUNT(children.id)').to_
     GROUP BY records.id
 ```
 
-`arlj` is purposely low level to be extra chainable.
+`left_joins` is purposely low level to be extra chainable.
 
-Arlj also adds an aggregation syntax:
+Arlj also adds an aggregation method:
 
 ```ruby
-Parent.arlj_aggregate(:children, 'COUNT(*)', 'SUM(col)' => 'total').select('children_count', 'total').to_sql
+Parent.left_joins_aggregate(:children, 'COUNT(*)', 'SUM(col)' => 'total').select('children_count', 'total').to_sql
 => SELECT children_count
         , total
      FROM "parents"
@@ -62,22 +62,29 @@ Parent.arlj_aggregate(:children, 'COUNT(*)', 'SUM(col)' => 'total').select('chil
                   ON arlj_aggregate_children."parent_id" = "parents"."id"
 ```
 
-`arlj_aggregate` currently uses a subquery to hide its aggregation. It's not the
-most efficient implementation but it does offer a much better chaining
+`left_joins_aggregate` currently uses a subquery to hide its aggregation. It is
+not the most efficient implementation but it does offer a much better chaining
 experience than using `group` at the top level.
 
-Arlj can also alias `arlj` and `arlj_aggregate` to `left_joins` and
-`left_joins_aggregate` respectively:
+If you prefer, you may also use `arlj` and `arlj_aggregate` instead of
+`left_joins` and `left_joins_aggregate` respectively. To prevent potential
+naming conflicts, please use `Arlj::Base`:
 
 ```ruby
 class Parent < ActiveRecord::Base
-  extend Arlj::LeftJoins
+  extend Arlj::Base
 end
+```
+
+**Arlj** has an experimental flag that uses the **memoist** gem to memoize the
+generated join SQL:
 
-Parent.left_joins(:children).group('records.id').select('COUNT(children.id)')
-Parent.left_joins_aggregate(:children, 'COUNT(*)', 'SUM(col)' => 'total')
+```ruby
+Arlj.memoize!
 ```
 
+This has not been proven to be faster.
+
 ## TODO
 
 * Relations with conditions

data/Rakefile

@@ -1,2 +1,6 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/arlj.gemspec

@@ -19,10 +19,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'activerecord', '>= 3.1'
-  spec.add_runtime_dependency 'memoist',      '~> 0.11.0'
 
   spec.add_development_dependency 'bundler',  '~> 1.7'
   spec.add_development_dependency 'rake',     '~> 10.0'
   spec.add_development_dependency 'rspec',    '~> 3.0'
   spec.add_development_dependency 'temping',  '~> 3.2'
+  spec.add_development_dependency 'wrong',    '~> 0.7'
 end

data/lib/arlj/base.rb

@@ -0,0 +1,106 @@
+module Arlj
+  module Base
+    def self.memoize!
+      require 'memoist'
+      self.extend Memoist
+      self.memoize :arlj_sql, :arlj_aggregate_sql
+    end
+
+    def arlj(assoc)
+      # Example snippet:
+      #  LEFT JOIN [assoc]
+      #         ON [assoc].source_id = source.id
+
+      joins(arlj_sql(assoc))
+    end
+
+    # Example usage:
+    #   arlj_aggregate(other, 'count(*)', 'sum(col)' => target_name)
+    def arlj_aggregate(assoc, *args)
+      # Example snippet:
+      #  LEFT JOIN(SELECT source_id, [func]([column]) AS [target_name]
+      #              FROM [assoc]
+      #             GROUP BY [assoc].source_id) arlj_aggregate_[assoc]
+      #         ON [assoc].source_id = source.id
+
+      joins(arlj_aggregate_sql(assoc, *args))
+    end
+
+    def arlj_arel(assoc)
+      refl = reflect_on_association(assoc)
+      arlj_left_join_arel(refl.klass.arel_table, refl.foreign_key)
+    end
+
+    def arlj_sql(assoc)
+      arlj_arel(assoc).join_sources
+    end
+
+    def arlj_aggregate_arel(assoc, *args)
+      options = args.extract_options!
+
+      refl = reflect_on_association(assoc)
+      refl_arel = refl.klass.arel_table
+
+      join_name = "arlj_aggregate_#{refl.table_name}"
+
+      columns = [refl_arel[refl.foreign_key]]
+      args.each do |thunk|
+        columns << parse_thunk(refl, assoc, refl_arel, thunk)
+      end
+      options.each do |thunk, name|
+        columns << parse_thunk(refl, assoc, refl_arel, thunk, name)
+      end
+
+      subq_arel =
+        refl_arel.project(columns).
+                  from(refl_arel).
+                  group(refl_arel[refl.foreign_key]).
+                  as(join_name)
+
+      arlj_left_join_arel(subq_arel, refl.foreign_key)
+    end
+
+    def arlj_aggregate_sql(assoc, *args)
+      arlj_aggregate_arel(assoc, *args).join_sources
+    end
+
+    private
+
+    THUNK_PATTERN = /^([a-zA-Z]*)\((.*)\)$/
+    AGGREGATE_FUNCTIONS = {
+      'sum'     => 'sum',
+      'average' => 'average',
+      'avg'     => 'average',
+      'maximum' => 'maximum',
+      'max'     => 'maximum',
+      'minimum' => 'minimum',
+      'min'     => 'minimum',
+      'count'   => 'count',
+    }.freeze
+    def parse_thunk(refl, assoc, arel, thunk, name=nil)
+      matchdata = THUNK_PATTERN.match(thunk)
+      if matchdata.nil?
+        raise "'#{thunk}' not parsable - must be of format 'func(column)'"
+      end
+
+      func = AGGREGATE_FUNCTIONS[matchdata[1].downcase]
+      if func.nil?
+        raise "'#{matchdata[1]}' not recognized - must be one of #{AGGREGATE_FUNCTIONS.keys}"
+      end
+
+      if matchdata[2] == '*'
+        column = refl.active_record_primary_key
+        name ||= "#{assoc}_#{func}"
+      else
+        column = matchdata[2]
+        name ||= "#{assoc}_#{func}_#{column}"
+      end
+      arel[column].send(func).as(name)
+    end
+
+    def arlj_left_join_arel(arel, foreign_key)
+      arel_table.join(arel, Arel::Nodes::OuterJoin).
+                   on(arel[foreign_key].eq(arel_table[self.primary_key]))
+    end
+  end
+end

data/lib/arlj/version.rb

@@ -1,3 +1,3 @@
 module Arlj
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/arlj.rb

@@ -1,98 +1,15 @@
-require 'memoist'
+require 'arlj/base'
 
 module Arlj
-  autoload :LeftJoins, 'arlj/left_joins'
-  autoload :VERSION,   'arlj/version'
+  autoload :Version, 'arlj/version'
+  include Arlj::Base
 
-  extend Memoist
+  alias_method :left_joins, :arlj
+  alias_method :left_joins_aggregate, :arlj_aggregate
+  alias_method :left_joins_arel, :arlj_arel
+  alias_method :left_joins_aggregate_arel, :arlj_aggregate_arel
 
-  def arlj(assoc)
-    # Example snippet:
-    #  LEFT JOIN [assoc]
-    #         ON [assoc].source_id = source.id
-
-    refl = reflect_on_association(assoc)
-    sources = arlj_arel_sources(refl.klass.arel_table, refl.foreign_key)
-    joins(sources)
-  end
-
-  # Example usage:
-  #   arlj_aggregate(other, 'count(*)', 'sum(col)' => target_name)
-  def arlj_aggregate(assoc, *args)
-    # Example snippet:
-    #  LEFT JOIN(SELECT source_id, [func]([column]) AS [target_name]
-    #              FROM [assoc]
-    #             GROUP BY [assoc].source_id) arlj_aggregate_[assoc]
-    #         ON [assoc].source_id = source.id
-
-    sources = arlj_aggregate_sources(assoc, *args)
-    joins(sources)
-  end
-
-  private
-
-  THUNK_PATTERN = /^([a-zA-Z]*)\((.*)\)$/
-  AGGREGATE_FUNCTIONS = {
-    'sum'     => 'sum',
-    'average' => 'average',
-    'avg'     => 'average',
-    'maximum' => 'maximum',
-    'max'     => 'maximum',
-    'minimum' => 'minimum',
-    'min'     => 'minimum',
-    'count'   => 'count',
-  }.freeze
-  def parse_thunk(refl, assoc, arel, thunk, name=nil)
-    matchdata = THUNK_PATTERN.match(thunk)
-    if matchdata.nil?
-      raise "'#{thunk}' not parsable - must be of format 'func(column)'"
-    end
-
-    func = AGGREGATE_FUNCTIONS[matchdata[1].downcase]
-    if func.nil?
-      raise "'#{matchdata[1]}' not recognized - must be one of #{AGGREGATE_FUNCTIONS.keys}"
-    end
-
-    if matchdata[2] == '*'
-      column = refl.active_record_primary_key
-      name ||= "#{assoc}_#{func}"
-    else
-      column = matchdata[2]
-      name ||= "#{assoc}_#{func}_#{column}"
-    end
-    arel[column].send(func).as(name)
-  end
-
-  def arlj_aggregate_sources(assoc, *args)
-    options = args.extract_options!
-
-    refl = reflect_on_association(assoc)
-    refl_arel = refl.klass.arel_table
-
-    join_name = "arlj_aggregate_#{refl.table_name}"
-
-    columns = [refl_arel[refl.foreign_key]]
-    args.each do |thunk|
-      columns << parse_thunk(refl, assoc, refl_arel, thunk)
-    end
-    options.each do |thunk, name|
-      columns << parse_thunk(refl, assoc, refl_arel, thunk, name)
-    end
-
-    subq_arel =
-      refl_arel.project(columns).
-                from(refl_arel).
-                group(refl_arel[refl.foreign_key]).
-                as(join_name)
-
-    arlj_arel_sources(subq_arel, refl.foreign_key)
-  end
-  memoize :arlj_aggregate_sources
-
-  def arlj_arel_sources(arel, foreign_key)
-    arel_join =
-      arel_table.join(arel, Arel::Nodes::OuterJoin).
-                   on(arel[foreign_key].eq(arel_table[self.primary_key]))
-    arel_join.join_sources
+  def self.memoize!
+    Arlj::Base.memoize!
   end
 end

data/spec/{arlj_spec.rb → base_spec.rb}

@@ -3,13 +3,13 @@ require 'spec_helper'
 require 'arlj'
 require 'temping'
 
-RSpec.describe Arlj do
+RSpec.describe Arlj::Base do
   Temping.create :parent do
     with_columns do |t|
       t.string :name
     end
 
-    extend Arlj
+    extend Arlj::Base
 
     has_many :children
   end

data/spec/left_joins_spec.rb

@@ -1,10 +1,10 @@
 require 'spec_helper'
 
-require 'arlj/left_joins'
+require 'arlj'
 
-RSpec.describe Arlj::LeftJoins do
+RSpec.describe Arlj, 'left_joins' do
   class LjParent < Parent
-    extend Arlj::LeftJoins
+    extend Arlj
   end
 
   specify '#left_joins does arlj stuff' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arlj
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Benjamin Feng
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-04 00:00:00.000000000 Z
+date: 2014-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.1'
-- !ruby/object:Gem::Dependency
-  name: memoist
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.11.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: wrong
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 description: Make left joins feel like first-class citizens in ActiveRecord.
 email:
 - contact@fengb.info
@@ -102,15 +102,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - arlj.gemspec
 - lib/arlj.rb
-- lib/arlj/left_joins.rb
+- lib/arlj/base.rb
 - lib/arlj/version.rb
-- spec/arlj_spec.rb
+- spec/base_spec.rb
 - spec/left_joins_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/fengb/arlj
@@ -138,6 +139,6 @@ signing_key:
 specification_version: 4
 summary: ActiveRecord Left Join
 test_files:
-- spec/arlj_spec.rb
+- spec/base_spec.rb
 - spec/left_joins_spec.rb
 - spec/spec_helper.rb

data/lib/arlj/left_joins.rb

@@ -1,10 +0,0 @@
-require 'arlj'
-
-module Arlj
-  module LeftJoins
-    include Arlj
-
-    alias_method :left_joins, :arlj
-    alias_method :left_joins_aggregate, :arlj_aggregate
-  end
-end