baby_squeel 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 630e302720d471b1ea0e6f618ef01e8592c0b9ab
-  data.tar.gz: 621e74ac8ad305e143e856e1cee8a8c023b3ac9c
+  metadata.gz: bc084f58970dcb50513671717f743e024a391355
+  data.tar.gz: 1a4430236093f7554273c2a4357e0ad81879fe2d
 SHA512:
-  metadata.gz: c91ddbf39dc8e7a153f9be6df8197ac7223d91d4bf003eb55049bb3c0d9f671e7aa4a810ddb122973e609f70e302db90011b1f82a9794133cd1d2f4f688d8d6c
-  data.tar.gz: e71c24fb4bf300ae9806e4664e07c0e07e07cf74997f1259b2e6068fcb304f5d171bea6db2095d1e44a1329fe019f4a381be5e9686c6b9ec33d60b70b7787118
+  metadata.gz: fc821c6eaca9be86e6559a2c354b47125a8a6c549e6b1b4064bc6354baa7ff6ecf186ebe66141b05681f77656834b787dbce705786f5e785e67fd4df3b859df1
+  data.tar.gz: d9428e48fd5ce4b0d21b88c253616de212e7bda084e5af79888439f2f97180593757cb0a0fdf0efbdd3f952e97e9193412b201557580967802065cbf66b65d93

data/CHANGELOG.md

@@ -0,0 +1,42 @@
+## Unreleased
+
+Nothing yet!
+
+## [0.2.2] - 2015-03-30
+### Added
+- Support for `group` (`grouping`) and `having` (`when_having`).
+- Support for sifters.
+- Added `quoted` and `sql` helpers for quoting strings and SQL literals.
+- More descriptive error messages when a column or association is not found.
+
+### Fixed
+- `Arel::Nodes::Grouping` does not include `Arel::Math`, so operations like `(id + 5) + 3` would fail unexpectedly.
+- Fix missing bind values When joining through associations with default scope.
+- Removed `ActiveRecord::VERSION` specific handling of the `WhereChain`.
+
+## [0.2.1] - 2015-03-27
+### Added
+- Support for subqueries.
+
+### Fixed
+- Some Arel nodes did not have access to `as` expressions.
+
+## [0.2.0] - 2015-03-25
+### Added
+- References to aliased joins in a `select`, `where`, or `order` expression now use the aliased table name.
+
+### Changed
+- Rely on `ActiveRecord::Relation#join_sources` for the implicit construction of join nodes, rather than using the `ActiveRecord::Associations::JoinDependency` directly.
+
+### Fixed
+
+- Associations referencing the same table weren't being aliased.
+
+## [0.1.0] - 2015-03-16
+### Added
+- Initial support for selects, orders, wheres, and joins.
+
+[Unreleased]: https://github.com/rzane/baby_squeel/compare/v0.2.2...HEAD
+[0.2.1]: https://github.com/rzane/baby_squeel/compare/v0.2.1...v0.2.2
+[0.2.1]: https://github.com/rzane/baby_squeel/compare/v0.2.0...v0.2.1
+[0.2.0]: https://github.com/rzane/baby_squeel/compare/v0.1.0...v0.2.0

data/README.md

@@ -28,6 +28,34 @@ Or install it yourself as:
 
     $ gem install baby_squeel
 
+## Introduction
+
+With ActiveRecord, you might write something like this:
+
+```ruby
+Post.where('created_at >= ?', 2.weeks.ago)
+```
+
+But then someone tells you, "Hey, you should use Arel!". So you convert your query to use Arel:
+
+```ruby
+Post.where(Post.arel_table[:created_at].gteq(2.weeks.ago))
+```
+
+Well, that's great, but it's also pretty verbose. Why don't you give BabySqueel a try:
+
+```ruby
+Post.where.has { created_at >= 2.weeks.ago }
+```
+
+#### Quick note
+
+BabySqueel's blocks use `instance_eval`, which means you won't have access to your instance variables or methods. Don't worry, there's a really easy solution. Just give arity to the block:
+
+```ruby
+Post.where.has { |post| post.created_at >= 2.weeks.ago }
+```
+
 ## Usage
 
 Okay, so we have some models:
@@ -151,6 +179,15 @@ Post.joining { author.alias('a').on((author.id == author_id) | (author.name == t
 # INNER JOIN "authors" "a" ON ("authors"."id" = "posts"."author_id" OR "authors"."name" = "posts"."title")
 ```
 
+##### Grouping
+
+```ruby
+Post.selecting { id.count }.grouping { author_id }.when_having { id.count > 5 }
+# SELECT COUNT("posts"."id") FROM "posts"
+# GROUP BY "posts"."author_id"
+# HAVING (COUNT("posts"."id") > 5)
+```
+
 ##### Functions
 
 ```ruby
@@ -172,17 +209,53 @@ Post.joins(:author).where.has {
 # )
 ```
 
-## Important Notes
+##### Custom SQL Operators
+
+```ruby
+authors = Author.selecting { name.op('||', quoted('-dizzle')).as('swag') }
+# SELECT "authors"."name" || '-dizzle' AS swag FROM "authors"
+
+authors.first.swag #=> 'Ray Zane-dizzle'
+```
 
-While inside one of BabySqueel's blocks, `self` will be something totally different. You won't have access to your instance variables or methods.
+## Sifters
 
-Don't worry, there's an easy solution. Just give arity to the block:
+Sifters are like little snippets of conditions that take parameters.
 
 ```ruby
-Post.where.has { |table| table.title == 'Test' }
-# SELECT "posts".* WHERE "posts"."title" = 'Test'
+class Post < ActiveRecord::Base
+  sifter :funny do |str|
+    title == 'rabies'
+  end
+end
+
+class Author < ActiveRecord::Base
+  sifter :name_contains do |string|
+    name =~ "%#{string}%"
+  end
+end
+
+Post.joins(:author).where.has {
+  sift(:funny) | author.sift(:name_contains, 'blergh')
+}
+# SELECT "posts".* FROM "posts"
+# INNER JOIN "authors" ON "authors"."id" = "posts"."author_id"
+# WHERE ("posts"."title" = 'rabies' OR "authors"."name" LIKE '%blergh%')
 ```
 
+## What's what?
+
+The following methods give you access to BabySqueel's DSL:
+
+| BabySqueel    | ActiveRecord Equivalent |
+|---------------|-------------------------|
+| `selecting`   | `select`                |
+| `ordering`    | `order`                 |
+| `joining`     | `joins`                 |
+| `grouping`    | `group`                 |
+| `where.has`   | `where`                 |
+| `when_having` | `having`                |
+
 ## Development
 
 1. Pick an ActiveRecord version to develop against, then export it: `export AR=4.2.6`.

data/baby_squeel.gemspec

@@ -15,12 +15,9 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
 
   spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
+  spec.files = Dir.glob('{lib/**/*,*.{md,txt,gemspec}}')
 
   spec.add_dependency 'activerecord', '>= 4.0.0'
 

data/lib/baby_squeel.rb

@@ -6,6 +6,7 @@ require 'baby_squeel/active_record'
 module BabySqueel
 end
 
+::ActiveRecord::Base.extend BabySqueel::ActiveRecord::Sifting
 ::ActiveRecord::Base.extend BabySqueel::ActiveRecord::QueryMethods
 ::ActiveRecord::Relation.prepend BabySqueel::ActiveRecord::QueryMethods
 ::ActiveRecord::QueryMethods::WhereChain.prepend BabySqueel::ActiveRecord::WhereChain

data/lib/baby_squeel/active_record.rb

@@ -2,10 +2,19 @@ require 'baby_squeel/dsl'
 
 module BabySqueel
   module ActiveRecord
+    module Sifting
+      def sifter(name, &block)
+        define_singleton_method "sift_#{name}" do |*args|
+          DSL.evaluate_sifter(self, *args, &block)
+        end
+      end
+    end
+
     module QueryMethods
       # Constructs Arel for ActiveRecord::Base#joins using the DSL.
       def joining(&block)
-        joins DSL.evaluate(unscoped, &block)
+        arel, binds = DSL.evaluate_joins(unscoped, &block)
+        joins(arel).tap { |s| s.bind_values += binds }
       end
 
       # Constructs Arel for ActiveRecord::Base#select using the DSL.
@@ -17,23 +26,23 @@ module BabySqueel
       def ordering(&block)
         order DSL.evaluate(self, &block)
       end
+
+      # Constructs Arel for ActiveRecord::Base#group using the DSL.
+      def grouping(&block)
+        group DSL.evaluate(self, &block)
+      end
+
+      # Constructs Arel for ActiveRecord::Base#having using the DSL.
+      def when_having(&block)
+        having DSL.evaluate(self, &block)
+      end
     end
 
     module WhereChain
-      if ::ActiveRecord::VERSION::MAJOR > 4
-        # Constructs Arel for ActiveRecord::Base#where using the DSL.
-        def has(&block)
-          opts = DSL.evaluate(@scope, &block)
-          factory = @scope.send(:where_clause_factory)
-          @scope.where_clause += factory.build(opts, [])
-          @scope
-        end
-      else
-        # Constructs Arel for ActiveRecord::Base#where using the DSL.
-        def has(&block)
-          @scope.where_values += [DSL.evaluate(@scope, &block)]
-          @scope
-        end
+      # Constructs Arel for ActiveRecord::Base#where using the DSL.
+      def has(&block)
+        @scope.where! DSL.evaluate(@scope, &block)
+        @scope
       end
     end
   end

data/lib/baby_squeel/dsl.rb

@@ -4,9 +4,33 @@ require 'baby_squeel/association'
 
 module BabySqueel
   class DSL < Table
-    # Evaluates a block in the context of a new DSL instance.
-    def self.evaluate(scope, &block)
-      new(scope).evaluate(&block)
+    class << self
+      # Evaluates a block and unwraps the nodes
+      def evaluate(scope, &block)
+        Nodes.unwrap evaluate!(scope, &block)
+      end
+
+      # Evaluates a block in the context of a DSL instance
+      def evaluate!(scope, &block)
+        new(scope).evaluate(&block)
+      end
+
+      # Evaluates a block specifically for a join. In this
+      # case, we'll return an array of Arel join nodes and
+      # a list of bind parameters.
+      def evaluate_joins(scope, &block)
+        dependency = evaluate!(scope, &block)._arel
+        join_arel = Nodes.unwrap(dependency._arel)
+        [join_arel, dependency.bind_values]
+      end
+
+      # Evaluates a block in the context of a new DSL instance
+      # and passes all arguments to the block.
+      def evaluate_sifter(scope, *args, &block)
+        evaluate scope do |root|
+          root.instance_exec(*args, &block)
+        end
+      end
     end
 
     # Create a SQL function. See Arel::Nodes::NamedFunction.
@@ -24,13 +48,23 @@ module BabySqueel
       Nodes.wrap Arel::Nodes::NamedFunction.new(name.to_s, args)
     end
 
+    # See Arel::sql
+    def sql(value)
+      ::Arel.sql value
+    end
+
+    # Quotes a string and marks it as SQL
+    def quoted(value)
+      sql _scope.connection.quote(value)
+    end
+
     # Evaluates a DSL block. If arity is given, this method
     # `yield` itself, rather than `instance_eval`.
     def evaluate(&block)
       if block.arity.zero?
-        Nodes.unwrap instance_eval(&block)
+        instance_eval(&block)
       else
-        Nodes.unwrap yield(self)
+        yield(self)
       end
     end
 

data/lib/baby_squeel/join_dependency.rb

@@ -1,31 +1,50 @@
 module BabySqueel
   class JoinDependency
-    def initialize(scope, associations = [])
-      @scope = scope
+    delegate :_scope, :_join, :_on, :_table, to: :@table
+
+    def initialize(table, associations = [])
+      @table = table
       @associations = associations
     end
 
+    if ActiveRecord::VERSION::STRING < '4.1.0'
+      def bind_values
+        _scope.joins(join_names(@associations)).bind_values
+      end
+    else
+      def bind_values
+        @bind_values ||= begin
+          relation = _scope.joins(join_names(@associations))
+          relation.arel.bind_values + relation.bind_values
+        end
+      end
+    end
+
     # Converts an array of BabySqueel::Associations into an array
     # of Arel join nodes.
     #
     # Each association is built individually so that the correct
     # Arel join node will be used for each individual association.
-    def constraints
-      @associations.each.with_index.inject([]) do |joins, (assoc, i)|
-        inject @associations[0..i], joins, assoc._join
+    def _arel
+      if _on
+        [_join.new(_table, _on)]
+      else
+        @associations.each.with_index.inject([]) do |joins, (assoc, i)|
+          construct @associations[0..i], joins, assoc._join
+        end
       end
     end
 
     private
 
-    def inject(associations, theirs, join_node)
+    def construct(associations, theirs, join_node)
       names = join_names associations
       mine = build names, join_node
       theirs + mine[theirs.length..-1]
     end
 
     def build(names, join_node)
-      @scope.joins(names).join_sources.map do |join|
+      _scope.joins(names).join_sources.map do |join|
         join_node.new(join.left, join.right)
       end
     end

data/lib/baby_squeel/nodes.rb

@@ -17,7 +17,7 @@ module BabySqueel
       # ActiveRecord.
       def unwrap(node)
         if node.respond_to? :_arel
-          node._arel
+          unwrap node._arel
         elsif node.is_a? Array
           node.map { |n| unwrap(n) }
         else
@@ -60,13 +60,22 @@ module BabySqueel
     # include necessary/applicable modules.
     class Generic < Proxy
       extend Operators::ArelAliasing
-      include Arel::AliasPredication
-      include Arel::OrderPredications
       include Operators::Comparison
       include Operators::Equality
       include Operators::Generic
       include Operators::Grouping
       include Operators::Matching
+
+      # Extend the Arel node with some extra modules. For example,
+      # Arel::Nodes::Grouping does not implement Math. InfixOperation doesn't
+      # implement AliasPredication. Without these extensions, the interface
+      # just seems inconsistent.
+      def initialize(node)
+        node.extend Arel::Math
+        node.extend Arel::AliasPredication
+        node.extend Arel::OrderPredications
+        super(node)
+      end
     end
 
     class Attribute < Generic
@@ -85,7 +94,7 @@ module BabySqueel
       end
 
       def _arel
-        parent_arel = @parent._arel
+        parent_arel = @parent._arel._arel
 
         if parent_arel && parent_arel.last
           parent_arel.last.left[@name]

data/lib/baby_squeel/operators.rb

@@ -42,7 +42,7 @@ module BabySqueel
       # * +other+ - The argument to be passed to the SQL operator.
       #
       # ==== Example
-      #    Post.select { title.op('||', 'diddly') }
+      #    Post.select { title.op('||', quoted('diddly')) }
       #    #=> SELECT "posts"."title" || 'diddly' FROM "posts"
       #
       def op(operator, other)

data/lib/baby_squeel/table.rb

@@ -1,17 +1,23 @@
 require 'baby_squeel/join_dependency'
 
 module BabySqueel
+  class NotFoundError < StandardError
+    def initialize(model_name, name)
+      super "There is no column or association named '#{name}' for #{model_name}."
+    end
+  end
+
   class AssociationNotFoundError < StandardError
-    def initialize(scope, name)
-      super "Association named '#{name}' was not found on #{scope.model_name}"
+    def initialize(model_name, name)
+      super "Association named '#{name}' was not found for #{model_name}."
     end
   end
 
   class Table
-    attr_accessor :_on, :_join, :_table
+    attr_accessor :_scope, :_on, :_join, :_table
 
     def initialize(scope)
-      @scope = scope
+      @_scope = scope
       @_table = scope.arel_table
       @_join = Arel::Nodes::InnerJoin
     end
@@ -24,13 +30,17 @@ module BabySqueel
     # Constructs a new BabySqueel::Association. Raises
     # an exception if the association is not found.
     def association(name)
-      if reflection = @scope.reflect_on_association(name)
+      if reflection = _scope.reflect_on_association(name)
         Association.new(self, reflection)
       else
-        raise AssociationNotFoundError.new(@scope, name)
+        raise AssociationNotFoundError.new(_scope.model_name, name)
       end
     end
 
+    def sift(sifter_name, *args)
+      Nodes.wrap _scope.public_send("sift_#{sifter_name}", *args)
+    end
+
     # Alias a table. This is only possible when joining
     # an association explicitly.
     def alias(alias_name)
@@ -79,19 +89,15 @@ module BabySqueel
     # 2. Resolve the assocition's join clauses using ActiveRecord.
     #
     def _arel(associations = [])
-      if _on
-        _join.new(_table, _on)
-      else
-        JoinDependency.new(@scope, associations).constraints
-      end
+      JoinDependency.new(self, associations)
     end
 
     private
 
     def resolve(name)
-      if @scope.column_names.include?(name.to_s)
+      if _scope.column_names.include?(name.to_s)
         self[name]
-      elsif @scope.reflect_on_association(name)
+      elsif _scope.reflect_on_association(name)
         association(name)
       end
     end
@@ -101,10 +107,10 @@ module BabySqueel
     end
 
     def method_missing(name, *args, &block)
-      if !args.empty? || block_given?
-        super
-      else
-        resolve(name) || super
+      return super if !args.empty? || block_given?
+
+      resolve(name) || begin
+        raise NotFoundError.new(_scope.model_name, name)
       end
     end
   end

data/lib/baby_squeel/version.rb

@@ -1,3 +1,3 @@
 module BabySqueel
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.2.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: baby_squeel
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Ray Zane
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-27 00:00:00.000000000 Z
+date: 2016-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -87,16 +87,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
-- Rakefile
 - baby_squeel.gemspec
-- bin/console
-- bin/setup
 - lib/baby_squeel.rb
 - lib/baby_squeel/active_record.rb
 - lib/baby_squeel/association.rb
@@ -126,8 +120,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A tiny squeel implementation without all of the evil.
 test_files: []
+has_rdoc: 

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color

data/.travis.yml

@@ -1,19 +0,0 @@
-language: ruby
-
-rvm:
-  - 2.2.4
-
-before_install: gem install bundler -v 1.11.2
-after_script: bundle exec rake coveralls:push
-
-env:
-  global:
-    - COVERALLS_REPO_TOKEN=X5ZWSPW8VW2JXNJO0qNjlZCQNW4ju89gb
-  matrix:
-    - AR=4.0.0
-    - AR=4.1.0
-    - AR=4.1.15
-    - AR=4.2.0
-    - AR=4.2.6
-    - AR=5.0.0.beta2
-    - AR=5.0.0.beta3

data/Gemfile

@@ -1,17 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in baby_squeel.gemspec
-gemspec
-
-if ar_version = ENV['AR']
-  gem 'activerecord', ar_version
-else
-  gem 'activerecord', github: 'rails/rails'
-end
-
-group :test do
-  gem 'pry'
-  gem 'coveralls'
-  gem 'simplecov'
-end
-

data/Rakefile

@@ -1,41 +0,0 @@
-require 'yaml'
-require 'open3'
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'coveralls/rake/task'
-
-Coveralls::RakeTask.new
-
-RSpec::Core::RakeTask.new(:spec)
-
-def invoke(version, cmd)
-  Bundler.with_clean_env do
-    system({ 'AR' => version, 'SKIPCOV' => '1' }, cmd)
-  end
-end
-
-desc 'Run against a specific ActiveRecord version'
-task 'spec:version', [:version] do |_, args|
-  if args.version.nil? || args.version.empty?
-    abort 'No version given'
-  end
-
-  FileUtils.rm_rf 'Gemfile.lock'
-  invoke args.version, 'bundle install --quiet'
-  invoke args.version, 'bundle exec rspec -f progress' if $?.success?
-  $stderr.puts "#{args.version} failed." unless $?.success?
-end
-
-desc 'Run against all ActiveRecord versions'
-task 'spec:matrix' do
-  travis = YAML.load_file '.travis.yml'
-  spec_task = Rake::Task['spec:version']
-
-  travis['env']['matrix'].each do |matrix|
-    spec_task.invoke matrix[/\=(.+)$/, 1]
-    spec_task.reenable
-    puts "\n\n"
-  end
-end
-
-task default: :spec

data/bin/console

@@ -1,25 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'baby_squeel'
-require_relative '../spec/support/schema'
-require_relative '../spec/support/models'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-puts 'Creating 2 authors...'
-authors = [
-  Author.create!(name: 'Ray Zane'),
-  Author.create!(name: 'Jimmy Hoffa')
-]
-
-puts 'Creating 15 posts...'
-15.times do |n|
-  Post.create! title: "Post #{n}", author: authors.sample
-end
-
-ActiveRecord::Base.logger = Logger.new(STDOUT)
-
-require 'pry'
-Pry.start

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here