rql 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da24e3445d8f2175928c882b2cabe6b43e54452b
-  data.tar.gz: 6b0326c51d3d243cbebfc2d4a9a2b44fa1f1b943
+  metadata.gz: 377409fcba26dcedaba557963e2b24c98aaeb947
+  data.tar.gz: 161b3d6a9495f23f604c85ee1a6622f925682e5b
 SHA512:
-  metadata.gz: 4e055053881fef20bf297c193a7efab0304816676a2a457cf369984aa22f420aa2fb3f5e4c7882fc8229289262d1eaed45364c635150b5067b3fc8e4951b1aa5
-  data.tar.gz: d564ddb101947806963720c92bdc6c62ffadd987e3ca2bdd13d2994600f04248fb234c9903eb18cd99b397ac582e688b4b4c31a29fea369ffd49c8e7a1ccb8ed
+  metadata.gz: 0ce38ebc39256f5b07243409eed49efe1501209a41282756f193c812a0f0a74c7425788083ad056c3aca8996b44885088c4bc188091c94d992999c4e738e25c9
+  data.tar.gz: 5717564360f289e9a86bb0f1f204f966d63f366807e786d644b2c28fb7d7835123bb72124f5d63f2ad6ca21797328d065e8fe721a052d97c7dcd83c1532ec160

data/README.md

@@ -1,6 +1,6 @@
 # RQL [![Build Status](https://secure.travis-ci.org/liefni/rql.svg)](http://travis-ci.org/liefni/rql) [![Gem Version](https://badge.fury.io/rb/rql.svg)](https://badge.fury.io/rb/rql)
 
-RQL is a DSL for ActiveRecord designed to allow derived/calculated attributes on models to be used in database queries.
+RQL is a DSL for Ruby on Rails' ActiveRecord, designed to allow derived/calculated attributes on models to be used in database queries.
 
 [Api Documentation](https://www.rubydoc.info/gems/rql/)
 
@@ -81,6 +81,32 @@ If a derived attribute has not been preloaded then the code will be evaluated in
 accessed. For instance calling `Book.first.leaves` will return `pages / 2` just as a normal method would, without having
 to query the database.
 
+### Case Sensitivity and Regexp
+
+As strings in ruby are case sensitive, to get consistent results when derived attributes are both run is the context of 
+model and in the database you will need to configure your database to be case sensitive.
+
+To perform case-insensitive queries downcase the values you are comparing e.g.
+
+```ruby
+Authors.where{name.downcase == my_string.downcase}
+```
+
+Alternatively you can use regexp matching with the =~ operator. This is case sensitive by default but supports the case 
+insensitive flag.
+
+Case sensitive regexp match:
+
+```ruby
+Authors.where{name =~ /[A-Za-z]/}
+```
+
+Case insensitive match using i flag:
+
+```ruby
+Authors.where{name =~ /[A-Z]/i}
+```
+
 ### Query DSL
 
 #### Operators
@@ -94,6 +120,7 @@ to query the database.
 |<         |`Book.rql.where {pages < 200}`        |`SELECT * FROM "book" WHERE "book"."pages" < 200`       |
 |>=        |`Book.rql.where {pages >= 200}`       |`SELECT * FROM "book" WHERE "book"."pages" >= 200`      |
 |<=        |`Book.rql.where {pages <= 200}`       |`SELECT * FROM "book" WHERE "book"."pages" <= 200`      |
+|=~        |`Book.rql.where {name =~ /^[A-Z]*$/}` |`SELECT * FROM "book" WHERE "book"."name" ~ '^[A-Z]*$'` |
 |+         |`Book.rql.where {pages + 2 == 200}`   |`SELECT * FROM "book" WHERE ("book"."pages" + 2) = 200` |
 |-         |`Book.rql.where {pages - 2 == 200}`   |`SELECT * FROM "book" WHERE ("book"."pages" - 2) = 200` |
 |*         |`Book.rql.where {pages * 2 == 200}`   |`SELECT * FROM "book" WHERE "book"."pages" * 2 = 200`   |
@@ -108,7 +135,8 @@ to query the database.
 |`start_with?` |`Book.rql.where {name.start_with?('A')}`  |`SELECT * FROM "book" WHERE "book"."name" ILIKE 'A%'`   |
 |`end_with?`   |`Book.rql.where {name.end_with?('A')}`    |`SELECT * FROM "book" WHERE "book"."name" ILIKE '%A'`   |
 |`include?`    |`Book.rql.where {name.include?('A')}`     |`SELECT * FROM "book" WHERE "book"."name" ILIKE '%A%'`  |
-|`in? `        |`Book.rql.where {name.in?(['A', 'B'])}`   |`SELECT * FROM "book" WHERE "book"."name" IN ('A', 'B')`|
+|`in?`         |`Book.rql.where {name.in?(['A', 'B'])}`   |`SELECT * FROM "book" WHERE "book"."name" IN ('A', 'B')`|
+|`downcase`    |`Book.rql.where {name.downcase == 'a'}`   |`SELECT * FROM "book" WHERE LOWER("book"."name") = 'a'` |
 
 |Aggregates                       |Example                                                   |
 |---------------------------------|----------------------------------------------------------|

data/lib/rql/dsl.rb

@@ -3,6 +3,7 @@ require "rql/dsl/comparisons"
 require "rql/dsl/logic"
 require "rql/dsl/maths"
 require "rql/dsl/orders"
+require "rql/dsl/functions"
 require "rql/dsl/base"
 require "rql/dsl/context"
 

data/lib/rql/dsl/comparisons.rb

@@ -31,16 +31,20 @@ module Rql
         Context.new(@model, arel.gteq(value))
       end
 
+      def =~(value)
+        Context.new(@model, arel.matches_regexp(value.source, !value.casefold?))
+      end
+
       def start_with?(value)
-        Context.new(@model, arel.matches("#{value}%"))
+        Context.new(@model, arel.matches("#{value}%", nil, true))
       end
 
       def end_with?(value)
-        Context.new(@model, arel.matches("%#{value}"))
+        Context.new(@model, arel.matches("%#{value}", nil, true))
       end
 
       def include?(value)
-        Context.new(@model, arel.matches("%#{value}%"))
+        Context.new(@model, arel.matches("%#{value}%", nil, true))
       end
 
       def in?(collection)

data/lib/rql/dsl/context.rb

@@ -6,6 +6,7 @@ module Rql
       include Maths
       include Orders
       include Logic
+      include Functions
 
       attr_accessor :arel, :scope, :model
 

data/lib/rql/dsl/functions.rb

@@ -0,0 +1,9 @@
+module Rql
+  module Dsl
+    module Functions
+      def downcase
+        Context.new(@model, arel.lower, @name)
+      end
+    end
+  end
+end

data/lib/rql/queryable.rb

@@ -18,7 +18,7 @@ module Rql
       # @yield the code block to be converted to sql
       # @return [Rql::Dsl::Context] object wrapping arel for the evaluated block of code
       def eval_rql(alias_derived_attr = false, &block)
-        Dsl::Base.new(self, alias_derived_attr).instance_eval(&block)
+        Dsl::Base.new(self.unscoped, alias_derived_attr).instance_eval(&block)
       end
 
       # Defines a derived attribute on a model

data/lib/rql/scope/block_methods.rb

@@ -17,6 +17,14 @@ module Rql
         scope.select(*build_attributes(true, &block))
       end
 
+      # Plucks the specified attributes, creating and array of values
+      #
+      # @yield RQL block defining the attributes to be selected
+      # @return [Array] an array of values if plucking one value or an array of arrays if plucking multiple values
+      def pluck(&block)
+        scope.pluck(*build_attributes(true, &block))
+      end
+
       # Orders by specified attributes
       #
       # @yield RQL block defining the attributes order by

data/lib/rql/scope/param_methods.rb

@@ -17,6 +17,14 @@ module Rql
         scope.select(*attributes.map{|attr| scope.derived_attributes[attr] ? scope.eval_rql(&scope.derived_attributes[attr]).as(attr).arel : attr})
       end
 
+      # Plucks the specified attributes, creating and array of values
+      #
+      # @param attributes [Array] the attributes to select
+      # @return [Array] an array of values if plucking one value or an array of arrays if plucking multiple values
+      def pluck(*attributes)
+        scope.pluck(*attributes.map{|attr| scope.derived_attributes[attr] ? scope.eval_rql(&scope.derived_attributes[attr]).as(attr).arel : attr})
+      end
+
       # Orders by specified attributes
       #
       # @param attributes [Array] the attributes to order by. Attributes may be a symbol, sql string or a hash specifying attribute and order.

data/lib/rql/version.rb

@@ -1,3 +1,3 @@
 module Rql
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rql
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Lief Nikkel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-04 00:00:00.000000000 Z
+date: 2018-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -137,6 +137,7 @@ files:
 - lib/rql/dsl/base.rb
 - lib/rql/dsl/comparisons.rb
 - lib/rql/dsl/context.rb
+- lib/rql/dsl/functions.rb
 - lib/rql/dsl/logic.rb
 - lib/rql/dsl/maths.rb
 - lib/rql/dsl/orders.rb