mongoid_hash_query 0.2.0 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38cb5283bf7399e66d57f5040f3575d3982ddc98
-  data.tar.gz: 3a3a92fd0fe6a84c51362a0da71f25446c10cb27
+  metadata.gz: e0f4f38de5ee2165660a982868d31884d464d41b
+  data.tar.gz: bd64881083350d33433cba569cc96ff9f3078413
 SHA512:
-  metadata.gz: c7c6c5b45715c6352d487a5f4b7baa2bf7a3c194136e7951bf77c650646681001977cf295927246d8fa7c3758615cf6db45944020a1f99332520084e2c2d9cbe
-  data.tar.gz: 9e8a7e0d5881d1e0f11f4159723b21ccfad4c2eaade7c89fd5807da2432a58849e865d8789f515469e4e96c875ae95be74339b589f629c3e7359681382d3bc03
+  metadata.gz: 0bc9122b1edd0d2bffea199c61705ba2dd05fab09fb100f33a39f541e12558c71ebb0e65f79bd19d26726163cdcec750bf15c2a72414c8ae01328c55a61586c8
+  data.tar.gz: 4e067d3e87dc3ba701401253fd66ca17319cffb62ff11f9f84712e2b77f362b84c2de752dcf865b455a35872590a3635e0d064030719192a440314447c3995e8

data/README.md

@@ -19,6 +19,8 @@ on unknown attributes (attributes not returned from the API) by brute forcing
 which might or might not be a security issue. If you don't like that check
 [whitelisting](https://github.com/kollegorna/mongoid_hash_query#whitelisting)._
 
+*New*! You can now do [__aggregation queries__](#aggregation-queries).
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -91,6 +93,9 @@ Soon you will be able to send in regex..
 You can apply an equality filter on hashes like that:
 * `{example_field: {foo: 'bar', bar: 'foo'}}`
 
+Or you can apply a regex in example_field.foo like that:
+* `{example_field: {foo: {regex: true, value: 'bar', ignore_case: true}, bar: 'foo'}}`
+
 
 ### Limit
 A limit param defines the number of returned resources. For instance:
@@ -140,6 +145,31 @@ end
 `Api::V1::ResourceFilter.new(resource, params[resource]).apply_filters` will be
 called to apply the filters in resource association.~~
 
+## Aggregation Queries
+Sometimes we need to ask the database queries that act on the collection but don't want back an array of elements but a value instead! Now you can do that by simply calling the aggregations method inside the controller:
+
+```ruby
+aggregations(resource, {
+  aggregate: {
+    integer_column: { avg: true, max: true, min: true, sum: true },
+    float_column: {avg: true, max: true, min: true },
+    datetime_column: { max: true, min: true }
+  }
+})
+```
+
+and you will get a hash (HashWithIndifferentAccess) back that holds all your aggregations like:
+```ruby
+{
+  aggregations: {
+    "float_column"=>{"avg"=>25.5, "max"=>50, "min"=>1},
+    "integer_column"=>{"avg"=>4.38, "sum"=>219, "max"=>9, "min"=>0},
+    "datetime_at"=>{"max"=>2015-06-11 20:59:14 UTC, "min"=>2015-06-11 20:59:12 UTC}
+  }
+}
+```
+
+These attributes usually go to the "meta" section of your serializer. In that way it's easy to parse them in the front-end (for ember check [here](http://guides.emberjs.com/v1.10.0/models/handling-metadata/)). Please note that you should apply the aggregations __after__ you apply the filters (if there any) but __before__ you apply pagination!
 
 
 ## Contributing

data/lib/mongoid_hash_query.rb

@@ -1,10 +1,13 @@
 require 'mongoid_hash_query/version'
+require 'mongoid_hash_query/helpers'
 require 'mongoid_hash_query/field_filters'
 require 'mongoid_hash_query/limit_filters'
 require 'mongoid_hash_query/sort_filters'
 require 'mongoid_hash_query/scope_filters'
 require 'mongoid_hash_query/filter_applier'
 
+require 'mongoid_hash_query/aggregation'
+
 module MongoidHashQuery
   class << self
     attr_accessor :configuration
@@ -30,6 +33,10 @@ module MongoidHashQuery
     ).apply_filters
   end
 
+  def aggregations(resource, params)
+    Aggregation.new(resource, params).apply
+  end
+
   class Configuration
     attr_accessor :has_filter_classes, :filter_class_prefix, :filter_class_suffix
   end

data/lib/mongoid_hash_query/aggregation.rb

@@ -0,0 +1,68 @@
+module MongoidHashQuery
+  class Aggregation
+    include Helpers
+
+    attr_reader :configuration, :params, :resource, :model
+
+    def initialize(resource, params, model: nil)
+      @configuration = Module.nesting.last.configuration
+      @resource = resource
+      @params = HashWithIndifferentAccess.new(params)
+      @model = model
+
+      unless @model
+        @model = model_class_name(@resource)
+      end
+    end
+
+    def apply
+      if params[:aggregate].is_a? Hash
+        meta_attributes = HashWithIndifferentAccess.new
+
+        params[:aggregate].each do |field, asked_aggrs|
+          #next if @model.fields[field].nil? #allow on embedded documents too
+          next unless params[:aggregate][field].is_a? Hash
+
+          if @model.fields[field]
+            case @model.fields[field].options[:type].to_s.downcase.to_sym
+            when :integer, :float, :bigdecimal
+              meta_attributes[field] = apply_aggregations(
+                {avg: :avg, sum: :sum, max: :max, min: :min},
+                params[:aggregate][field],
+                field
+              )
+
+            when :date, :datetime, :time, :timewithzone,
+              meta_attributes[field] = apply_aggregations(
+                {max: :max, min: :min},
+                params[:aggregate][field],
+                field
+              )
+            end
+          else
+            meta_attributes[field] = apply_aggregations(
+              {avg: :avg, sum: :sum, max: :max, min: :min},
+              params[:aggregate][field],
+              field
+            )
+          end
+        end
+      end
+
+      return {aggregations: meta_attributes}
+    end
+
+    def apply_aggregations(available_aggr, asked_aggr, field)
+      meta_attributes = HashWithIndifferentAccess.new
+
+      available_aggr.each do |k, v|
+        if asked_aggr[k]
+          meta_attributes[k] = resource.send(v,field)
+          meta_attributes[k] = meta_attributes[k].to_f if meta_attributes[k].is_a? BigDecimal
+        end
+      end
+
+      return meta_attributes
+    end
+  end
+end

data/lib/mongoid_hash_query/field_filters.rb

@@ -29,7 +29,11 @@ module MongoidHashQuery::FieldFilters
 
   def filter_hash(resource, field, param)
     param.each do |k, v|
-      resource = resource.where("#{field}.#{k}" => v)
+      if v.is_a?(Hash) && v[:regex]
+        resource = resource.where("#{field}.#{k}" => Regexp.new(v[:value], v[:ignore_case]))
+      else
+        resource = resource.where("#{field}.#{k}" => v)
+      end
     end
 
     return resource

data/lib/mongoid_hash_query/filter_applier.rb

@@ -1,5 +1,6 @@
 module MongoidHashQuery
   class FilterApplier
+    include Helpers
     include FieldFilters
     #include AssociationFilters
     include ScopeFilters
@@ -52,6 +53,8 @@ module MongoidHashQuery
           @resource = filter_symbol(@resource, v.name, @params[v.name])
         when Time.to_s
           @resource = filter_time(@resource, v.name, @params[v.name])
+        else
+          @resource = @resource.where(v.name => @params[v.name])
         end
       end
 
@@ -66,11 +69,5 @@ module MongoidHashQuery
       return @resource
     end
 
-    def filter_class(resource_name)
-    end
-
-    def model_class_name(resource)
-      resource.klass
-    end
   end
 end

data/lib/mongoid_hash_query/helpers.rb

@@ -0,0 +1,7 @@
+module MongoidHashQuery
+  module Helpers
+    def model_class_name(resource)
+      resource.klass
+    end
+  end
+end

data/lib/mongoid_hash_query/scope_filters.rb

@@ -9,4 +9,3 @@ module MongoidHashQuery::ScopeFilters
     return resource
   end
 end
-

data/lib/mongoid_hash_query/version.rb

@@ -1,3 +1,3 @@
 module MongoidHashQuery
-  VERSION = "0.2.0"
+  VERSION = "0.2.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_hash_query
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.4
 platform: ruby
 authors:
 - Filippos Vasilakis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-03 00:00:00.000000000 Z
+date: 2015-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -57,8 +57,10 @@ files:
 - bin/console
 - bin/setup
 - lib/mongoid_hash_query.rb
+- lib/mongoid_hash_query/aggregation.rb
 - lib/mongoid_hash_query/field_filters.rb
 - lib/mongoid_hash_query/filter_applier.rb
+- lib/mongoid_hash_query/helpers.rb
 - lib/mongoid_hash_query/limit_filters.rb
 - lib/mongoid_hash_query/scope_filters.rb
 - lib/mongoid_hash_query/sort_filters.rb