baby_squeel 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc084f58970dcb50513671717f743e024a391355
-  data.tar.gz: 1a4430236093f7554273c2a4357e0ad81879fe2d
+  metadata.gz: 7011dd272658bb35f29c2fee9bef07432c6fd6b8
+  data.tar.gz: 987fcf1f4682154eefb19e8aeb9e2671f48d04ea
 SHA512:
-  metadata.gz: fc821c6eaca9be86e6559a2c354b47125a8a6c549e6b1b4064bc6354baa7ff6ecf186ebe66141b05681f77656834b787dbce705786f5e785e67fd4df3b859df1
-  data.tar.gz: d9428e48fd5ce4b0d21b88c253616de212e7bda084e5af79888439f2f97180593757cb0a0fdf0efbdd3f952e97e9193412b201557580967802065cbf66b65d93
+  metadata.gz: 9f1b3d6e1f178ab428df6b1c23d7672ba2c53fa0f14814cf72c60c294e1236ba01240f875a3c5bbdde21d25976da72403786325f274bcd28020b0dfbaf474c41
+  data.tar.gz: 72efcf684fe78d5918914384d9f315b173adafa53af5044ce053c4b8ddb11a86067121c87997efd4254550d01064b825c68d5378b327e424dd6763bdc22e0c57

data/CHANGELOG.md

@@ -1,8 +1,17 @@
 ## Unreleased
 
-Nothing yet!
+Nothing yet.
 
-## [0.2.2] - 2015-03-30
+## [0.3.0] - 2016-06-26
+### Added
+- Added Squeel compatibility mode that allows `select`, `order`, `joins`, `group`, `where`, and `having` to accept DSL blocks.
+- Added the ability to query tables that aren't backed by Active Record models.
+- Added `BabySqueel::[]`, which provides a `BabySqueel::Relation` for models, or a `BabySqueel::Table` for symbols/strings.
+
+### Changed
+- Renamed `BabySqueel::Association::AliasingError` to `BabySqueel::AssociationAliasingError`.
+
+## [0.2.2] - 2016-03-30
 ### Added
 - Support for `group` (`grouping`) and `having` (`when_having`).
 - Support for sifters.
@@ -14,14 +23,14 @@ Nothing yet!
 - 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
+## [0.2.1] - 2016-03-27
 ### Added
 - Support for subqueries.
 
 ### Fixed
 - Some Arel nodes did not have access to `as` expressions.
 
-## [0.2.0] - 2015-03-25
+## [0.2.0] - 2016-03-25
 ### Added
 - References to aliased joins in a `select`, `where`, or `order` expression now use the aliased table name.
 
@@ -32,11 +41,12 @@ Nothing yet!
 
 - Associations referencing the same table weren't being aliased.
 
-## [0.1.0] - 2015-03-16
+## [0.1.0] - 2016-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
+[Unreleased]: https://github.com/rzane/baby_squeel/compare/v0.3.0...HEAD
+[0.3.0]: https://github.com/rzane/baby_squeel/compare/v0.2.2...v0.3.0
+[0.2.2]: 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

@@ -6,11 +6,9 @@
 
 <img align="right" src="http://static.thefrisky.com/uploads/2010/07/01/pig_in_boots_070110_m.jpg" alt="biddy piggy">
 
-Have you ever used the [squeel](https://github.com/activerecord-hackery/squeel) gem? It's a really nice way to build complex queries. However, squeel monkeypatches ActiveRecord internals, so it has a tendency to break every time a new ActiveRecord version comes out.
+Have you ever used the [Squeel](https://github.com/activerecord-hackery/squeel) gem? It's a really nice way to build complex queries. However, Squeel monkeypatches Active Record internals, because it was aimed at enhancing the existing API with the aim of inclusion into Rails. However, that inclusion never happened, and it left Squeel susceptible to breakage from arbitrary changes in Active Record, eventually burning out the maintainer.
 
-For me, that's a deal breaker. BabySqueel provides a query DSL for ActiveRecord without all of the evil. :heart:
-
-It's really just a layer of sugar on top of Arel.
+BabySqueel provides a Squeel-like query DSL for Active Record while hopefully avoiding the majority of the version upgrade difficulties via a minimum of monkeypatching. :heart:
 
 ## Installation
 
@@ -30,7 +28,7 @@ Or install it yourself as:
 
 ## Introduction
 
-With ActiveRecord, you might write something like this:
+With Active Record, you might write something like this:
 
 ```ruby
 Post.where('created_at >= ?', 2.weeks.ago)
@@ -218,13 +216,25 @@ authors = Author.selecting { name.op('||', quoted('-dizzle')).as('swag') }
 authors.first.swag #=> 'Ray Zane-dizzle'
 ```
 
+##### Querying tables without Active Record models
+
+```ruby
+table = BabySqueel[:some_table]
+
+Post.joining {
+  table.on(table.post_id == id)
+}.where.has {
+  table.some_column == 1
+}
+```
+
 ## Sifters
 
-Sifters are like little snippets of conditions that take parameters.
+Sifters are like little snippets of conditions that can take arguments.
 
 ```ruby
 class Post < ActiveRecord::Base
-  sifter :funny do |str|
+  sifter :funny do
     title == 'rabies'
   end
 end
@@ -247,18 +257,31 @@ Post.joins(:author).where.has {
 
 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`                |
+| BabySqueel    | Active Record Equivalent |
+|---------------|--------------------------|
+| `selecting`   | `select`                 |
+| `ordering`    | `order`                  |
+| `joining`     | `joins`                  |
+| `grouping`    | `group`                  |
+| `where.has`   | `where`                  |
+| `when_having` | `having`                 |
+
+## Compatibility Mode
+
+If you want `select`, `order`, `joins`, `group`, and `having` to be able to accept DSL blocks, you can do so by adding the following to an initializer.
+
+```ruby
+# config/initializers/baby_squeel.rb
+BabySqueel.configure do |config|
+  config.enable_compat!
+end
+```
+
+Calling `enable_compat!` will override methods in Active Record, so use caution.
 
 ## Development
 
-1. Pick an ActiveRecord version to develop against, then export it: `export AR=4.2.6`.
+1. Pick an Active Record version to develop against, then export it: `export AR=4.2.6`.
 2. Run `bin/setup` to install dependencies.
 3. Run `rake` to run the specs.
 
@@ -268,7 +291,6 @@ You can also run `bin/console` to open up a prompt where you'll have access to s
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/rzane/baby_squeel.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/baby_squeel.rb

@@ -1,9 +1,28 @@
 require 'active_record'
 require 'active_record/relation'
 require 'baby_squeel/version'
+require 'baby_squeel/errors'
 require 'baby_squeel/active_record'
 
 module BabySqueel
+  class << self
+    def configure
+      yield self
+    end
+
+    def enable_compatibility!
+      require 'baby_squeel/compat'
+      BabySqueel::Compat.enable!
+    end
+
+    def [](thing)
+      if thing.respond_to?(:model_name)
+        Relation.new(thing)
+      else
+        Table.new(Arel::Table.new(thing))
+      end
+    end
+  end
 end
 
 ::ActiveRecord::Base.extend BabySqueel::ActiveRecord::Sifting

data/lib/baby_squeel/association.rb

@@ -1,18 +1,7 @@
-require 'baby_squeel/table'
+require 'baby_squeel/relation'
 
 module BabySqueel
-  class Association < Table
-    class AliasingError < StandardError
-      MESSAGE =
-        'Attempted to alias \'%{association}\' as \'%{alias_name}\', but the ' \
-        'association was implicitly joined. Either join the association ' \
-        'with `on` or remove the alias.'.freeze
-
-      def initialize(association, alias_name)
-        super format(MESSAGE, association: association, alias_name: alias_name)
-      end
-    end
-
+  class Association < Relation
     attr_reader :_reflection
 
     def initialize(parent, reflection)
@@ -37,7 +26,7 @@ module BabySqueel
       if _on
         super
       elsif _table.is_a? Arel::Nodes::TableAlias
-        raise AliasingError.new(_reflection.name, _table.right)
+        raise AssociationAliasingError.new(_reflection.name, _table.right)
       else
         @parent._arel([self, *associations])
       end

data/lib/baby_squeel/compat.rb

@@ -0,0 +1,66 @@
+module BabySqueel
+  module Compat
+    def self.enable!
+      ::ActiveRecord::Base.singleton_class.prepend QueryMethods
+      ::ActiveRecord::Relation.prepend QueryMethods
+    end
+
+    module QueryMethods
+      def joins(*args, &block)
+        if block_given? && args.empty?
+          joining(&block)
+        else
+          super
+        end
+      end
+
+      # Heads up, Array#select conflicts with
+      # ActiveRecord::QueryMethods#select. So, if arity
+      # is given to the block, we'll use Array#select.
+      # Otherwise, you'll be in a DSL block.
+      #
+      #    Model.select { This is DSL }
+      #    Model.select { |m| This is not DSL }
+      #
+      def select(*args, &block)
+        if block_given? && args.empty? && block.arity.zero?
+          selecting(&block)
+        else
+          super
+        end
+      end
+
+      def order(*args, &block)
+        if block_given? && args.empty?
+          ordering(&block)
+        else
+          super
+        end
+      end
+
+      def group(*args, &block)
+        if block_given? && args.empty?
+          grouping(&block)
+        else
+          super
+        end
+      end
+
+      def having(*args, &block)
+        if block_given? && args.empty?
+          when_having(&block)
+        else
+          super
+        end
+      end
+
+      def where(*args, &block)
+        if block_given? && args.empty?
+          super DSL.evaluate(self, &block)
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/baby_squeel/dsl.rb

@@ -1,9 +1,9 @@
 require 'baby_squeel/nodes'
-require 'baby_squeel/table'
+require 'baby_squeel/relation'
 require 'baby_squeel/association'
 
 module BabySqueel
-  class DSL < Table
+  class DSL < Relation
     class << self
       # Evaluates a block and unwraps the nodes
       def evaluate(scope, &block)

data/lib/baby_squeel/errors.rb

@@ -0,0 +1,24 @@
+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(model_name, name)
+      super "Association named '#{name}' was not found for #{model_name}."
+    end
+  end
+
+  class AssociationAliasingError < StandardError
+    MESSAGE =
+      'Attempted to alias \'%{association}\' as \'%{alias_name}\', but the ' \
+      'association was implicitly joined. Either join the association ' \
+      'with `on` or remove the alias.'.freeze
+
+    def initialize(association, alias_name)
+      super format(MESSAGE, association: association, alias_name: alias_name)
+    end
+  end
+end

data/lib/baby_squeel/join_dependency.rb

@@ -9,14 +9,14 @@ module BabySqueel
 
     if ActiveRecord::VERSION::STRING < '4.1.0'
       def bind_values
+        return [] unless relation?
         _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
+        return [] unless relation?
+        relation = _scope.joins(join_names(@associations))
+        relation.arel.bind_values + relation.bind_values
       end
     end
 
@@ -37,6 +37,10 @@ module BabySqueel
 
     private
 
+    def relation?
+      @table.kind_of? BabySqueel::Relation
+    end
+
     def construct(associations, theirs, join_node)
       names = join_names associations
       mine = build names, join_node

data/lib/baby_squeel/nodes.rb

@@ -94,10 +94,12 @@ module BabySqueel
       end
 
       def _arel
-        parent_arel = @parent._arel._arel
+        parent_arel = @parent._arel
+        parent_arel &&= parent_arel._arel
+        parent_arel &&= parent_arel.last
 
-        if parent_arel && parent_arel.last
-          parent_arel.last.left[@name]
+        if parent_arel
+          parent_arel.left[@name]
         else
           super
         end

data/lib/baby_squeel/operators.rb

@@ -10,7 +10,7 @@ module BabySqueel
       #
       # ==== Example
       #    BabySqueel::Nodes::Generic.arel_alias :unlike, :does_not_match
-      #    Post.where { title.unlike 'something' }
+      #    Post.where.has { title.unlike 'something' }
       #
       def arel_alias(operator, arel_name)
         define_method operator do |other|
@@ -42,7 +42,7 @@ module BabySqueel
       # * +other+ - The argument to be passed to the SQL operator.
       #
       # ==== Example
-      #    Post.select { title.op('||', quoted('diddly')) }
+      #    Post.selecting { title.op('||', quoted('diddly')) }
       #    #=> SELECT "posts"."title" || 'diddly' FROM "posts"
       #
       def op(operator, other)

data/lib/baby_squeel/relation.rb

@@ -0,0 +1,42 @@
+require 'baby_squeel/table'
+
+module BabySqueel
+  class Relation < Table
+    attr_accessor :_scope
+
+    def initialize(scope)
+      super(scope.arel_table)
+      @_scope = scope
+    end
+
+    # Constructs a new BabySqueel::Association. Raises
+    # an exception if the association is not found.
+    def association(name)
+      if reflection = _scope.reflect_on_association(name)
+        Association.new(self, reflection)
+      else
+        raise AssociationNotFoundError.new(_table_name, name)
+      end
+    end
+
+    def sift(sifter_name, *args)
+      Nodes.wrap _scope.public_send("sift_#{sifter_name}", *args)
+    end
+
+    private
+
+    # @override BabySqueel::Table#_table_name
+    def _table_name
+      _scope.model_name
+    end
+
+    # @override BabySqueel::Table#resolve
+    def resolve(name)
+      if _scope.column_names.include?(name.to_s)
+        self[name]
+      elsif _scope.reflect_on_association(name)
+        association(name)
+      end
+    end
+  end
+end

data/lib/baby_squeel/table.rb

@@ -1,24 +1,11 @@
 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(model_name, name)
-      super "Association named '#{name}' was not found for #{model_name}."
-    end
-  end
-
   class Table
-    attr_accessor :_scope, :_on, :_join, :_table
+    attr_accessor :_on, :_join, :_table
 
-    def initialize(scope)
-      @_scope = scope
-      @_table = scope.arel_table
+    def initialize(arel_table)
+      @_table = arel_table
       @_join = Arel::Nodes::InnerJoin
     end
 
@@ -27,20 +14,6 @@ module BabySqueel
       Nodes::Attribute.new(self, key)
     end
 
-    # Constructs a new BabySqueel::Association. Raises
-    # an exception if the association is not found.
-    def association(name)
-      if reflection = _scope.reflect_on_association(name)
-        Association.new(self, reflection)
-      else
-        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)
@@ -89,17 +62,18 @@ module BabySqueel
     # 2. Resolve the assocition's join clauses using ActiveRecord.
     #
     def _arel(associations = [])
+      return unless _on || associations.any?
       JoinDependency.new(self, associations)
     end
 
     private
 
+    def _table_name
+      arel_table.name
+    end
+
     def resolve(name)
-      if _scope.column_names.include?(name.to_s)
-        self[name]
-      elsif _scope.reflect_on_association(name)
-        association(name)
-      end
+      self[name]
     end
 
     def respond_to_missing?(name, *)
@@ -110,7 +84,7 @@ module BabySqueel
       return super if !args.empty? || block_given?
 
       resolve(name) || begin
-        raise NotFoundError.new(_scope.model_name, name)
+        raise NotFoundError.new(_table_name, name)
       end
     end
   end

data/lib/baby_squeel/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: baby_squeel
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Ray Zane
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-31 00:00:00.000000000 Z
+date: 2016-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -94,10 +94,13 @@ files:
 - lib/baby_squeel.rb
 - lib/baby_squeel/active_record.rb
 - lib/baby_squeel/association.rb
+- lib/baby_squeel/compat.rb
 - lib/baby_squeel/dsl.rb
+- lib/baby_squeel/errors.rb
 - lib/baby_squeel/join_dependency.rb
 - lib/baby_squeel/nodes.rb
 - lib/baby_squeel/operators.rb
+- lib/baby_squeel/relation.rb
 - lib/baby_squeel/table.rb
 - lib/baby_squeel/version.rb
 homepage: https://github.com/rzane/baby_squeel
@@ -120,9 +123,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A tiny squeel implementation without all of the evil.
 test_files: []
-has_rdoc: