esql 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3d0ec66abeb7fa4a711ecc8c7a73be80099c12f3b3211f4814e8e756ab3e1316
+  data.tar.gz: d417589cec6723ff1f8e383a4e00c472766634a654f0f537cee66b75fad39f97
+SHA512:
+  metadata.gz: ba188083f0290e75860dc3ba2dcfa2bcd1176b7826f570bf8dbba308b75aabedb9490bc730904b6d79e943d03600780bc7e12162e548c2307d2a4df0297d8f73
+  data.tar.gz: 2e039c4b8baa125b3a6412a3a780cee6eb9bebb26a4e44239889f5541c554aa6a85ee4f0254f5864612f927e8b039d16b74ffd24509bb3a6f64a0fc0ce119936

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+**/.DS_Store
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Paul Holden
+
+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/README.md

@@ -0,0 +1,113 @@
+# esql
+
+Esql is a library for ActiveRecord scoping using simple expressions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```rb
+gem 'esql'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install esql
+
+## Usage
+
+This gem is easy to use: all you need is an ActiveRecord scope and an
+expression. The result is a scope with any necessary joins applied, to which
+you can use to generate columns, sort results, or apply filters.
+
+One of the primary goals is to allow your applications to unlock the full
+power of SQL without having to hard-code queries or fret about SQL injection.
+
+```rb
+ast = Esql::Parser.new.parse('concat(first_name, " ", last_name)')
+scope, sql = ast.evaluate(Employee.all)
+```
+
+Esql is a minimalist gem. A common use case is generating columns using
+formulas or aggregates. By default they won't be `SELECT`ed (because you
+might want to use your expressions to filter results instead); you will need
+to do that yourself. You can monkey patch the following method to allow
+adding a new column to your `SELECT` list instead of having to write the
+entire list again:
+
+```rb
+# Put this in an initializer
+module ActiveRecord
+  class Relation
+    def select_append(*fields)
+      fields.unshift(arel_table[Arel.star]) if !select_values.any?
+      select(*fields)
+    end
+  end
+end
+```
+
+Another great example of how you can use Esql is as a way to support
+dynamic queries in your REST APIs:
+
+```rb
+class EmployeesController < ApplicationRecord
+  # GET /employees?filter[]=...
+  def index
+    scope = Employee.all
+    filters = request.params.fetch('filter', [])
+    filters.each { |expr|
+      ast = Esql::Parser.new.parse(expr)
+      scope, sql = ast.evaluate(scope)
+      scope = scope.where(sql)
+    }
+    render # ...
+  end
+end
+```
+
+Yes, you will receive a raw SQL string when your expression is evaluated.
+Esql is basically a SQL transpiler—a memoizing parsing expression grammar is
+used behind the scenes to ensure e.g. string literals are always properly
+quoted before being inserted into the resulting SQL.
+
+## Expressions
+
+The expression syntax is simple and unopinionated. As a transpiler, Esql
+basically defers to SQL's rules. It just provides syntactic sugar for things
+like joins and aggregates.
+
+In most cases, Esql can catch issues like improper use of a related
+attributes (i.e. attributes of related records). It does this by evaluating
+the ActiveRecord reflections, so you will need to make sure you properly
+define your relationships in your model classes.
+
+Errors that get past this simple check layer (like type mismatches or even
+query runtime errors) will bubble up as ActiveRecord exceptions that you'll
+have to handle yourself.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+run `rake spec` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/paulholden2/esql.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'esql'
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/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

data/esql.gemspec

@@ -0,0 +1,37 @@
+require_relative 'lib/esql/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'esql'
+  spec.version       = Esql::VERSION
+  spec.authors       = ['Paul Holden']
+  spec.email         = ['paul@codelunker.com']
+
+  spec.summary       = 'A library for ActiveRecord scoping using simple expressions.'
+  spec.description   = 'A library for ActiveRecord scoping using simple expressions.'
+  spec.homepage      = 'https://github.com/paulholden2/esql'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/paulholden2/esql'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord'
+  spec.add_dependency 'babel_bridge', '~> 0.5'
+
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'factory_bot'
+  spec.add_development_dependency 'simplecov'
+end

data/lib/esql.rb

@@ -0,0 +1,30 @@
+require 'esql/version'
+require 'esql/parser'
+
+module Esql
+  class Error < StandardError; end
+
+  class InvalidAttributeError < Error
+    def initialize(attribute)
+      super("No such attribute: #{attribute}")
+    end
+  end
+
+  class InvalidFunctionError < Error
+    def initialize(function)
+      super("No such function: #{function}")
+    end
+  end
+
+  class InvalidRelationshipError < Error
+    def initialize(relationship)
+      super("No such relationship: #{relationship}")
+    end
+  end
+
+  class RelationshipTypeError < Error
+    def initialize(relationship, actual_type)
+      super("#{relationship} is a #{actual_type} relationship")
+    end
+  end
+end

data/lib/esql/parser.rb

@@ -0,0 +1,143 @@
+require 'babel_bridge'
+
+module Esql
+  class Parser < BabelBridge::Parser
+    ignore_whitespace
+
+    def parse(expression)
+      super("(#{expression})")
+    end
+
+    rule :atom, '(', :expression, ')' do
+      def evaluate(scope)
+        scope, sql = expression.evaluate(scope)
+        return scope, "(#{sql})"
+      end
+    end
+
+    binary_operators_rule(
+      :expression,
+      :atom,
+      [
+        [:/, :*],
+        [:+, :-],
+        [:<, :<=, :>, :>=, :==, :!=]
+      ]
+    ) do
+      def evaluate(scope)
+        scope, lval = left.evaluate(scope)
+        scope, rval = right.evaluate(scope)
+        return scope, "#{lval} #{operator == :== ? '=' : operator} #{rval}"
+      end
+    end
+
+    rule :atom, any(
+      :function,
+      :string,
+      :number,
+      :boolean,
+      :related_count,
+      :related_attribute,
+      :attribute
+    )
+
+    rule :function, :attribute, '(', many?(:atom, ','), ')' do
+      def evaluate(scope)
+        if self.respond_to?(attribute.to_sym)
+          self.send(attribute.to_sym, scope, atom)
+        else
+          raise Esql::InvalidFunctionError.new(attribute)
+        end
+      end
+
+      def concat(scope, atoms)
+        atoms = atoms.map { |atom|
+          scope, sql = atom.evaluate(scope)
+          sql
+        }
+        return scope, "#{atoms.join(' || ')}"
+      end
+    end
+
+    rule :attribute, /[a-zA-Z_]+/ do
+      def evaluate(scope)
+        attribute = self.text
+        if scope.attribute_names.include?(attribute)
+          column_name = "#{scope.table_name}.#{attribute}"
+          return scope, column_name
+        else
+          raise Esql::InvalidAttributeError.new(attribute)
+        end
+      end
+    end
+
+    rule :related_attribute, :attribute, '.', :attribute do
+      def evaluate(scope)
+        relationship = attribute[0].text
+        column = attribute[1].text
+        reflection = scope.model.reflections[relationship]
+        if reflection.nil?
+          raise Esql::InvalidRelationshipError.new(relationship)
+        end
+        case reflection
+        when ActiveRecord::Reflection::BelongsToReflection,
+             ActiveRecord::Reflection::HasOneReflection
+          sql = "#{reflection.klass.table_name}.#{column}"
+          scope = scope.joins(relationship.to_sym)
+        else
+          t = reflection.class.to_s.demodulize.gsub(/Reflection/, '')
+          raise Esql::RelationshipTypeError.new(relationship, t)
+        end
+
+        return scope, sql
+      end
+    end
+
+    rule :related_count, :attribute, '.', /count\b/ do
+      def evaluate(scope)
+        relationship = attribute.text
+        reflection = scope.model.reflections[relationship]
+        raise Esql::InvalidRelationshipError.new(relationship) if reflection.nil?
+        case reflection
+        when ActiveRecord::Reflection::HasManyReflection
+          column_name = "#{relationship}__count"
+          foreign_key = reflection.foreign_key
+          primary_key = "#{scope.table_name}.#{scope.primary_key}"
+          scope = scope.joins(<<-SQL)
+            LEFT JOIN (
+              SELECT #{foreign_key}, COUNT(*) AS count
+              FROM #{reflection.klass.table_name}
+              GROUP BY #{foreign_key}
+            ) AS #{column_name}___inner
+              ON #{column_name}___inner.#{foreign_key} = #{primary_key}
+          SQL
+          sql = "#{column_name}___inner.count"
+        else
+          t = reflection.class.to_s.demodulize.gsub(/Reflection/, '')
+          raise Esql::RelationshipTypeError.new(relationship, t)
+        end
+
+        return scope, sql
+      end
+    end
+
+    rule :string, /"(?:[^"\\]|\\(?:["\\]))*"/ do
+      def evaluate(scope)
+        str = self.text[1...-1].gsub(/\\("|\\)/, '\1')
+        return scope, ActiveRecord::Base.connection.quote(str)
+      end
+    end
+
+    rule :number, /-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?/ do
+      def evaluate(scope)
+        return scope, self.text
+      end
+    end
+
+    rule :boolean, /(true|false)/ do
+      def evaluate(scope)
+        return scope, self.text
+      end
+    end
+  end
+end

data/lib/esql/version.rb

@@ -0,0 +1,3 @@
+module Esql
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: esql
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paul Holden
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: babel_bridge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A library for ActiveRecord scoping using simple expressions.
+email:
+- paul@codelunker.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- esql.gemspec
+- lib/esql.rb
+- lib/esql/parser.rb
+- lib/esql/version.rb
+homepage: https://github.com/paulholden2/esql
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/paulholden2/esql
+  source_code_uri: https://github.com/paulholden2/esql
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: A library for ActiveRecord scoping using simple expressions.
+test_files: []