active_hash_relation 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60eec7b209bc819b5c4c678f9350022252ddb7f8
-  data.tar.gz: 157845010e5961cdc7f12adf04fadb40f5369541
+  metadata.gz: c46ec26a67f7a3de70d6ea616c729d074b24b3c6
+  data.tar.gz: 77fcb4801781ce42b1b131897f512a27e99c14c4
 SHA512:
-  metadata.gz: c357b72169fff0f28b4d9cb4b4a61941d8ebc478b80676a161ad176dbe741583b96582af699421389569816397a6487a589c070109ed4d9ab747db029b19fd52
-  data.tar.gz: f614659c194e246c597a9dd4a780ac13f6eb2370101a0a0239191baa09275caacee53eddea951212560738ab6eeb0b3aefc6d372aa13f0ae9c1d94984dd77683
+  metadata.gz: fd1dd4b024765dacd505e2bf4b035ccfc5949c457404e650bbd2a0dc9cdd88bcdc1a661651a4a4d8476afb7309e5aed2920aedda563643bc37d64dbd6d358494
+  data.tar.gz: 467857eaaa1c5742190b336f36489d206a3ae59d068f4540948ad9f39a296bc479a5bed3c052e01c9495c71af687d14caf8f0d46d916c065aeed5c24790e19db

data/README.md

@@ -23,6 +23,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/active_hash_relation#whitelisting)._
 
+*New*! You can now do [__aggregation queries__](https://github.com/kollegorna/active_hash_relation#aggregation_queries).
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -63,7 +65,7 @@ For each param, `apply_filters` method will search in the model's (derived from
 #### Primary
 You can apply a filter a column which is a primary key by value or using an array like:
 * `{primary_key_column: 5}`
-* `{primary_key)column: [1,3,4,5,6,7]}`
+* `{primary_key_column: [1,3,4,5,6,7]}`
 
 #### Integer, Float, Decimal, Date, Time or Datetime/Timestamp
 You can apply an equality filter:
@@ -143,6 +145,28 @@ With the above settings, when the association name is `resource`,
 `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 on an ActiveRecord::Relation by simply calling the aggregations method inside the controller:
+
+```ruby
+apply_filters(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
+{"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.
+
 
 
 ## Contributing

data/lib/active_hash_relation/aggregation.rb

@@ -0,0 +1,58 @@
+module ActiveHashRelation
+  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
+
+        @model.columns.each do |c|
+          next unless params[:aggregate][c.name.to_s].is_a? Hash
+
+          case c.type
+          when :integer, :float, :decimal
+            meta_attributes[c.name.to_s] = apply_aggregations(
+              {avg: :average, sum: :sum, max: :maximum, min: :minimum},
+              params[:aggregate][c.name.to_s],
+              c.name.to_s
+            )
+          when :date, :datetime, :timestamp
+            meta_attributes[c.name.to_s] = apply_aggregations(
+              {max: :maximum, min: :minimum},
+              params[:aggregate][c.name.to_s],
+              c.name.to_s
+            )
+          end
+        end
+      end
+
+      return meta_attributes
+    end
+
+    def apply_aggregations(available_aggr, asked_aggr, column)
+      meta_attributes = HashWithIndifferentAccess.new
+
+      available_aggr.each do |k, v|
+        if asked_aggr[k] == true
+          meta_attributes[k] = resource.send(v,column)
+          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/active_hash_relation/column_filters.rb

@@ -1,8 +1,4 @@
 module ActiveHashRelation::ColumnFilters
-  def model_class_name(resource)
-    resource.class.to_s.split('::').first.constantize
-  end
-
   def filter_primary(resource, column, param)
     resource = resource.where(id: param)
   end

data/lib/active_hash_relation/filter_applier.rb

@@ -1,5 +1,6 @@
 module ActiveHashRelation
   class FilterApplier
+    include Helpers
     include ColumnFilters
     include AssociationFilters
     include ScopeFilters

data/lib/active_hash_relation/helpers.rb

@@ -0,0 +1,7 @@
+module ActiveHashRelation
+  module Helpers
+    def model_class_name(resource)
+      resource.class.to_s.split('::').first.constantize
+    end
+  end
+end

data/lib/active_hash_relation/version.rb

@@ -1,3 +1,3 @@
 module ActiveHashRelation
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/active_hash_relation.rb

@@ -1,5 +1,6 @@
 require "active_record/scope_names"
 require "active_hash_relation/version"
+require "active_hash_relation/helpers"
 require "active_hash_relation/column_filters"
 require "active_hash_relation/scope_filters"
 require "active_hash_relation/sort_filters"
@@ -7,6 +8,8 @@ require "active_hash_relation/limit_filters"
 require "active_hash_relation/association_filters"
 require "active_hash_relation/filter_applier"
 
+require "active_hash_relation/aggregation"
+
 module ActiveHashRelation
   class << self
     attr_accessor :configuration
@@ -32,8 +35,11 @@ module ActiveHashRelation
     ).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
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_hash_relation
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Filippos Vasilakis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-05 00:00:00.000000000 Z
+date: 2015-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,9 +53,11 @@ files:
 - Rakefile
 - active_hash_relation.gemspec
 - lib/active_hash_relation.rb
+- lib/active_hash_relation/aggregation.rb
 - lib/active_hash_relation/association_filters.rb
 - lib/active_hash_relation/column_filters.rb
 - lib/active_hash_relation/filter_applier.rb
+- lib/active_hash_relation/helpers.rb
 - lib/active_hash_relation/limit_filters.rb
 - lib/active_hash_relation/scope_filters.rb
 - lib/active_hash_relation/sort_filters.rb