rql 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b12840bc8c62d856292ad37398531c76cb8ff422
+  data.tar.gz: ab75b04337811bfff13a03a25f568bf30f7f49a8
+SHA512:
+  metadata.gz: f4a85a36bd4190cc0938d1ccf59ee68d3d7a3386d36059a037fd7d7308f6876cfc07b03481e8e32fbbbd6b46baf606f87ce9197d367cdbd9960d9e167c438cbb
+  data.tar.gz: 604923887ce5168558fce6a30d39b56cf66d727a8862e9ae59299ace1f8851ec1f340ddc9783054bcb34c05435c6f7c5ce6b78dc3098302793adf4f08a9d249e

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rql.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Lief Nikkel
+
+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,39 @@
+# Rql
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rql`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rql'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rql
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/rql.
+
+## 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 "rql"
+
+# 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/lib/rql.rb

@@ -0,0 +1,9 @@
+require "rql/version"
+require "rql/path_builder"
+require "rql/queryable"
+require "rql/dsl"
+require "rql/scope"
+
+module Rql
+
+end

data/lib/rql/dsl.rb

@@ -0,0 +1,13 @@
+require "rql/dsl/aggregations"
+require "rql/dsl/comparisons"
+require "rql/dsl/logic"
+require "rql/dsl/maths"
+require "rql/dsl/orders"
+require "rql/dsl/base"
+require "rql/dsl/context"
+
+module Rql
+  module Scope
+
+  end
+end

data/lib/rql/dsl/aggregations.rb

@@ -0,0 +1,33 @@
+module Rql
+  module Dsl
+    module Aggregations
+      def calculate(attribute, operation)
+        association = @name.to_s.classify.constantize
+        sum_table_name = "#{@model.name.underscore}_#{attribute}_#{operation.to_s.pluralize}"
+        subquery = @scope.joins(@name).group(:id).select(:id, association.arel_table[attribute].send(operation)).arel.as(sum_table_name)
+        query = Arel.sql("COALESCE((#{@model.from(subquery).where(@model.arel_table[:id].eq(subquery[:id])).select(subquery[operation]).to_sql}), 0)")
+        Context.new(@model, query)
+      end
+
+      def sum(attribute)
+        calculate(attribute, :sum)
+      end
+
+      def average(attribute)
+        calculate(attribute, :average)
+      end
+
+      def minimum(attribute)
+        calculate(attribute, :minimum)
+      end
+
+      def maximum(attribute)
+        calculate(attribute, :maximum)
+      end
+
+      def count(attribute = :id)
+        calculate(attribute, :count)
+      end
+    end
+  end
+end

data/lib/rql/dsl/base.rb

@@ -0,0 +1,45 @@
+module Rql
+  module Dsl
+    class Base
+      def initialize(model, alias_derived_attr = false)
+        @model = model
+        @alias_derived_attr = alias_derived_attr
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        derived(method_name) || model?(method_name) || attribute?(method_name) || super
+      end
+
+      def method_missing(method_name, *params)
+        if respond_to_missing?(method_name)
+          raise ArgumentError.new("wrong number of arguments for `#{method_name}' (given #{params.length}, expected 0)") if (params.length > 0)
+
+          derived(method_name) || build_context(method_name)
+        else
+          super
+        end
+      end
+
+      def build_context(name)
+        Context.new(@model, @model.arel_table[name], name)
+      end
+
+      def derived(attribute)
+        derived = @model.try(:derived_attributes)&.fetch(attribute, nil)
+        if derived
+          derived = instance_eval(&derived)
+          derived = derived.as(attribute.to_s) if derived && @alias_derived_attr
+        end
+        derived
+      end
+
+      def model?(attribute)
+        (attribute.to_s.classify.constantize rescue nil)&.ancestors&.include?(ActiveRecord::Base)
+      end
+
+      def attribute?(attribute)
+        @model.column_names.include?(attribute.to_s)
+      end
+    end
+  end
+end

data/lib/rql/dsl/comparisons.rb

@@ -0,0 +1,54 @@
+module Rql
+  module Dsl
+    module Comparisons
+      def ==(value)
+        Context.new(@model, arel.eq(value))
+      end
+
+      def ===(range)
+        min_query = (range.min != -Float::INFINITY) ? arel.gt(range.min) : Arel.sql('1').eq(1)
+        max_query = (range.max != Float::INFINITY) ? arel.lt(range.max) : Arel.sql('1').eq(1)
+        Context.new(@model, min_query.and(max_query))
+      end
+
+      def <(value)
+        Context.new(@model, arel.lt(value))
+      end
+
+      def >(value)
+        Context.new(@model, arel.gt(value))
+      end
+
+      def <=(value)
+        Context.new(@model, arel.lteq(value))
+      end
+
+      def >=(value)
+        Context.new(@model, arel.gteq(value))
+      end
+
+      def starts_with?(value)
+        Context.new(@model, arel.matches("#{value}%"))
+      end
+
+      def ends_with?(value)
+        Context.new(@model, arel.matches("%#{value}"))
+      end
+
+      def include?(value)
+        Context.new(@model, arel.matches("%#{value}%"))
+      end
+
+      def in?(collection)
+        collection = collection.is_a?(Array) ? collection : collection.arel
+        Context.new(@model, arel.in(collection))
+      end
+    end
+  end
+end
+
+class Object
+  def in?(collection)
+    collection.include?(self)
+  end
+end

data/lib/rql/dsl/context.rb

@@ -0,0 +1,39 @@
+module Rql
+  module Dsl
+    class Context < Base
+      include Aggregations
+      include Comparisons
+      include Maths
+      include Orders
+      include Logic
+
+      def initialize(model, arel, name = nil, scope = nil)
+        @model = model
+        @arel = arel
+        @name = name
+        @scope = scope || model
+      end
+
+      def arel
+        @arel
+      end
+
+      def build_context(name)
+        model = @name.to_s.classify.constantize
+        Context.new(model, model.arel_table[name], name)
+      end
+
+      def as(name)
+        Context.new(@model, arel.as(name.to_s))
+      end
+
+      def rql
+        Context.new(@model, @arel, @name, @scope.rql)
+      end
+
+      def where(*attributes, &block)
+        Context.new(@model, @arel, @name, @scope.where(*attributes, &block))
+      end
+    end
+  end
+end

data/lib/rql/dsl/logic.rb

@@ -0,0 +1,13 @@
+module Rql
+  module Dsl
+    module Logic
+      def |(value)
+        Context.new(@model, arel.or(value.arel))
+      end
+
+      def &(value)
+        Context.new(@model, arel.and(value.arel))
+      end
+    end
+  end
+end

data/lib/rql/dsl/maths.rb

@@ -0,0 +1,21 @@
+module Rql
+  module Dsl
+    module Maths
+      def +(value)
+        Context.new(@model, arel + (value.is_a?(Context) ? value.arel : value))
+      end
+
+      def -(value)
+        Context.new(@model, arel - (value.is_a?(Context) ? value.arel : value))
+      end
+
+      def *(value)
+        Context.new(@model, arel * (value.is_a?(Context) ? value.arel : value))
+      end
+
+      def /(value)
+        Context.new(@model, arel / (value.is_a?(Context) ? value.arel : value))
+      end
+    end
+  end
+end

data/lib/rql/dsl/orders.rb

@@ -0,0 +1,13 @@
+module Rql
+  module Dsl
+    module Orders
+      def desc(flag = true)
+        Context.new(@model, flag ? arel.desc : arel.asc)
+      end
+
+      def asc(flag = true)
+        Context.new(@model, flag ? arel.asc : arel.desc)
+      end
+    end
+  end
+end

data/lib/rql/path_builder.rb

@@ -0,0 +1,19 @@
+module Rql
+  class PathBuilder
+    def initialize(path = nil)
+      @path = path || []
+    end
+
+    def to_h
+      path_hash = nil
+      @path.reverse_each do |name|
+        path_hash = path_hash ? {name.to_sym => path_hash} : name.to_sym
+      end
+      path_hash
+    end
+
+    def method_missing(name)
+      PathBuilder.new(@path.concat([name.to_sym]))
+    end
+  end
+end

data/lib/rql/queryable.rb

@@ -0,0 +1,33 @@
+require "active_support/concern"
+
+module Rql
+  module Queryable
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def rql
+        return Scope::RqlScope.new(all)
+      end
+
+      def eval_rql(&query)
+        Dsl::Base.new(self).instance_eval(&query)
+      end
+
+      def derive_attr(name, &query)
+        define_method(name) do
+          attributes.has_key?(name.to_s) ? attributes[name.to_s] : instance_eval(&query)
+        end
+
+        derived_attributes[name] = query
+      end
+
+      def derive(*attributes)
+        rql.select(self.arel_table[Arel.star], *attributes).all
+      end
+
+      def derived_attributes
+        @derive_attribute ||= {}
+      end
+    end
+  end
+end

data/lib/rql/scope.rb

@@ -0,0 +1,10 @@
+require "rql/scope/method_group"
+require "rql/scope/block_methods"
+require "rql/scope/param_methods"
+require "rql/scope/rql_scope"
+
+module Rql
+  module Scope
+
+  end
+end

data/lib/rql/scope/block_methods.rb

@@ -0,0 +1,38 @@
+module Rql
+  module Scope
+    class BlockMethods < MethodGroup
+      def where(&block)
+        scope.where(scope.eval_rql(&block).arel)
+      end
+
+      def select(&block)
+        scope.select(*build_attributes(&block))
+      end
+
+      def order(&block)
+        scope.order(*build_attributes(&block))
+      end
+
+      def joins(&block)
+        scope.joins(*build_join_path(&block))
+      end
+
+      def includes(&block)
+        scope.includes(*build_join_path(&block))
+      end
+
+      private
+        def build_join_path(&block)
+          joins = PathBuilder.new.instance_eval(&block)
+          joins = [joins] unless joins.is_a?(Array)
+          joins.map(&:to_h)
+        end
+
+        def build_attributes(&block)
+          attributes = scope.eval_rql(&block)
+          attributes = [attributes] unless attributes.is_a?(Array)
+          attributes.map(&:arel)
+        end
+    end
+  end
+end

data/lib/rql/scope/method_group.rb

@@ -0,0 +1,13 @@
+module Rql
+  module Scope
+    class MethodGroup
+      def initialize(scope)
+        @scope = scope
+      end
+
+      def scope
+        @scope
+      end
+    end
+  end
+end

data/lib/rql/scope/param_methods.rb

@@ -0,0 +1,58 @@
+module Rql
+  module Scope
+    class ParamMethods < MethodGroup
+      def where(**conditions)
+        scope.where(build_conditions(conditions))
+      end
+
+      def select(*attributes)
+        scope.select(*attributes.map{|attr| scope.derived_attributes[attr]&.arel&.as(attr.to_s) || attr})
+      end
+
+      def order(*attributes)
+        scope.order(*build_order(attributes))
+      end
+
+      def joins(*attributes)
+        scope.joins(*attributes)
+      end
+
+      def includes(*attributes)
+        scope.includes(*attributes)
+      end
+
+      private
+        def build_conditions(conditions, table = scope.name.underscore)
+          result = nil
+          conditions.each do |key, value|
+            condition =
+              if value.is_a?(Hash)
+                build_conditions(value, key)
+              elsif value.is_a?(Range)
+                scope.eval_rql{send(table).send(key) === value}.arel
+              elsif value.is_a?(Array) || value.methods.include?(:arel)
+                scope.eval_rql{send(table).send(key).in?(value)}.arel
+              else
+                scope.eval_rql{send(table).send(key) == value}.arel
+              end
+            result = result ? result.and(condition) : condition
+          end
+          result
+        end
+
+        def build_order(attributes)
+          order_by =
+            attributes.map do |attr|
+              if attr.is_a?(Symbol)
+                scope.eval_rql{send(attr)}.arel
+              elsif attr.is_a?(Hash)
+                attr.map {|(key, value)| scope.eval_rql{send(key).desc(value.to_sym == :desc)}.arel}
+              else
+                attr
+              end
+            end
+          order_by.flatten
+        end
+    end
+  end
+end

data/lib/rql/scope/rql_scope.rb

@@ -0,0 +1,32 @@
+module Rql
+  module Scope
+    class RqlScope
+      def initialize(scope)
+        @block_methods = BlockMethods.new(scope)
+        @param_methods = ParamMethods.new(scope)
+        @scope = scope
+      end
+
+      def scope
+        @scope
+      end
+
+      def method_missing(method_name, *params, &block)
+        if block && @block_methods.respond_to?(method_name)
+          RqlScope.new(@block_methods.send(method_name, &block))
+        elsif @param_methods.respond_to?(method_name)
+          RqlScope.new(@param_methods.send(method_name, *params))
+        else
+          scope.send(method_name, *params)
+        end
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        @block_methods.respond_to?(method_name, include_private) ||
+          @param_methods.send(method_name, include_private) ||
+          super.respond_to?(method_name, include_private) ||
+          super
+      end
+    end
+  end
+end

data/lib/rql/version.rb

@@ -0,0 +1,3 @@
+module Rql
+  VERSION = "0.1.0"
+end

data/rql.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rql/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rql"
+  spec.version       = Rql::VERSION
+  spec.authors       = ["Lief Nikkel"]
+  spec.email         = ["lief.nikkel@youdo.co.nz"]
+
+  spec.summary       = "A DSL for Active Record Queries"
+  spec.description   = "RQL is a DSL that allows derived attributes in Active Record models to be used in database queries"
+  spec.homepage      = "https://github.com/liefni/rql"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "sqlite3"
+
+  spec.add_runtime_dependency "activerecord", "> 5.0"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: rql
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lief Nikkel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: RQL is a DSL that allows derived attributes in Active Record models to
+  be used in database queries
+email:
+- lief.nikkel@youdo.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rql.rb
+- lib/rql/dsl.rb
+- lib/rql/dsl/aggregations.rb
+- lib/rql/dsl/base.rb
+- lib/rql/dsl/comparisons.rb
+- lib/rql/dsl/context.rb
+- lib/rql/dsl/logic.rb
+- lib/rql/dsl/maths.rb
+- lib/rql/dsl/orders.rb
+- lib/rql/path_builder.rb
+- lib/rql/queryable.rb
+- lib/rql/scope.rb
+- lib/rql/scope/block_methods.rb
+- lib/rql/scope/method_group.rb
+- lib/rql/scope/param_methods.rb
+- lib/rql/scope/rql_scope.rb
+- lib/rql/version.rb
+- rql.gemspec
+homepage: https://github.com/liefni/rql
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A DSL for Active Record Queries
+test_files: []