rql 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b12840bc8c62d856292ad37398531c76cb8ff422
-  data.tar.gz: ab75b04337811bfff13a03a25f568bf30f7f49a8
+  metadata.gz: 7b4ab947240986e99b39fe5a70b079e1fbd6e047
+  data.tar.gz: 3e3962ff1f6062d0c39494f17adeebc443927697
 SHA512:
-  metadata.gz: f4a85a36bd4190cc0938d1ccf59ee68d3d7a3386d36059a037fd7d7308f6876cfc07b03481e8e32fbbbd6b46baf606f87ce9197d367cdbd9960d9e167c438cbb
-  data.tar.gz: 604923887ce5168558fce6a30d39b56cf66d727a8862e9ae59299ace1f8851ec1f340ddc9783054bcb34c05435c6f7c5ce6b78dc3098302793adf4f08a9d249e
+  metadata.gz: dd912988d5e371defaf25597e97b8f6b3b1c162be6f43e4c543eff1db2eca2d5af096de63cccd3982b350e91182137368f7306307b6e3550ed6323788e69cb15
+  data.tar.gz: 249aa513b6aa047032c23732900986e009e4b3090834c85b94995f2c10946c217a462f74a4cba043b7f504a925249547b0e8b37f3f93811dc3ea91f4f0801125

data/README.md

@@ -1,8 +1,6 @@
-# Rql
+# 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
+RQL is a DSL for active record designed to allow derived/calculated attributes on models to be used in database queries.
 
 ## Installation
 
@@ -22,7 +20,27 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+You can define a derived attribute in your model like this:
+```ruby
+class Book < ActiveRecord::Base
+  include Rql::Queryable
+
+  derived_attr :leaves do
+    pages / 2
+  end
+end
+```
+
+and use it in a query like this:
+```ruby
+Book.rql.where(leaves: 100)
+```
+
+or
+
+```ruby
+Book.rql.where{leaves > 100}
+```
 
 ## Development
 
@@ -32,7 +50,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rql.
+Bug reports and pull requests are welcome on GitHub at https://github.com/liefni/rql.
 
 ## License
 

data/lib/rql/dsl/base.rb

@@ -7,39 +7,44 @@ module Rql
       end
 
       def respond_to_missing?(method_name, include_private = false)
-        derived(method_name) || model?(method_name) || attribute?(method_name) || super
+        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)
+          derive(method_name) || build_context(method_name)
         else
           super
         end
       end
 
-      def build_context(name)
-        Context.new(@model, @model.arel_table[name], name)
-      end
+      protected
+        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
+        def derive(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
-        derived
-      end
 
-      def model?(attribute)
-        (attribute.to_s.classify.constantize rescue nil)&.ancestors&.include?(ActiveRecord::Base)
-      end
+        def derived?(attribute)
+          !!@model.try(:derived_attributes)&.fetch(attribute, nil)
+        end
 
-      def attribute?(attribute)
-        @model.column_names.include?(attribute.to_s)
-      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/context.rb

@@ -7,11 +7,11 @@ module Rql
       include Orders
       include Logic
 
-      def initialize(model, arel, name = nil, scope = nil)
-        @model = model
+      def initialize(scope, arel, name = nil)
+        @scope = scope
+        @model = scope.unscoped
         @arel = arel
         @name = name
-        @scope = scope || model
       end
 
       def arel
@@ -28,11 +28,13 @@ module Rql
       end
 
       def rql
-        Context.new(@model, @arel, @name, @scope.rql)
+        Context.new(@scope.rql, @arel, @name)
       end
 
       def where(*attributes, &block)
-        Context.new(@model, @arel, @name, @scope.where(*attributes, &block))
+        model = @name.to_s.classify.constantize
+        model = model.rql if @scope.is_a?(Scope::RqlScope)
+        Context.new(@scope.merge(model.where(*attributes, &block)), @arel, @name)
       end
     end
   end

data/lib/rql/queryable.rb

@@ -9,8 +9,8 @@ module Rql
         return Scope::RqlScope.new(all)
       end
 
-      def eval_rql(&query)
-        Dsl::Base.new(self).instance_eval(&query)
+      def eval_rql(alias_derived_attr = false, &query)
+        Dsl::Base.new(self, alias_derived_attr).instance_eval(&query)
       end
 
       def derive_attr(name, &query)

data/lib/rql/scope/block_methods.rb

@@ -6,7 +6,7 @@ module Rql
       end
 
       def select(&block)
-        scope.select(*build_attributes(&block))
+        scope.select(*build_attributes(true, &block))
       end
 
       def order(&block)
@@ -28,8 +28,8 @@ module Rql
           joins.map(&:to_h)
         end
 
-        def build_attributes(&block)
-          attributes = scope.eval_rql(&block)
+        def build_attributes(alias_derived_attr = false, &block)
+          attributes = scope.eval_rql(alias_derived_attr, &block)
           attributes = [attributes] unless attributes.is_a?(Array)
           attributes.map(&:arel)
         end

data/lib/rql/scope/param_methods.rb

@@ -6,7 +6,7 @@ module Rql
       end
 
       def select(*attributes)
-        scope.select(*attributes.map{|attr| scope.derived_attributes[attr]&.arel&.as(attr.to_s) || attr})
+        scope.select(*attributes.map{|attr| scope.derived_attributes[attr] ? scope.eval_rql(true, &scope.derived_attributes[attr]).arel : attr})
       end
 
       def order(*attributes)

data/lib/rql/scope/rql_scope.rb

@@ -23,10 +23,19 @@ module Rql
 
       def respond_to_missing?(method_name, include_private = false)
         @block_methods.respond_to?(method_name, include_private) ||
-          @param_methods.send(method_name, include_private) ||
+          @param_methods.respond_to?(method_name, include_private) ||
           super.respond_to?(method_name, include_private) ||
           super
       end
+
+      def merge(other)
+        other = other.scope if other.is_a?(RqlScope)
+        RqlScope.new(scope.merge(other))
+      end
+
+      def to_a
+        scope.to_a
+      end
     end
   end
 end

data/lib/rql/version.rb

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

data/rql.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   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_development_dependency "pg"
 
-  spec.add_runtime_dependency "activerecord", "> 5.0"
+  spec.add_runtime_dependency "activerecord", ">= 5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rql
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Lief Nikkel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-13 00:00:00.000000000 Z
+date: 2018-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -70,14 +70,14 @@ dependencies:
   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