calculate_in_group 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5a7b900a5d475fc22804562ef0bac072706dcb251219b5be5c06c302f5dd75a
-  data.tar.gz: 73fa7ceb228a9704acc409ba00b99af5d307b9cfe8739a09496097481ee5b7d0
+  metadata.gz: a355bb8d2b965bf9e26129775305e20c02b7d8fed65331e63aa058c4ea4d26d7
+  data.tar.gz: 2179b1820693525eea6ce4ba9a28d25f0c2351133c0dccad55ac90a0130178d9
 SHA512:
-  metadata.gz: 80974131cdfb53dfc1279c516a61c72565ae29a3cc2bd181823298158a7fae24360e7fae377ab4e174984c2d4657650b93ac4d3b5b647f4bca084998d81667ab
-  data.tar.gz: 0d6c1989fa40e2dd60e77f1897467a05dd36caf2ee581d60884e176688c0bf501c7ecb0cc940c3eb04ef25bef5f04c2689e51a70db07ead31925ebd2ae55e027
+  metadata.gz: 4c4988070914bff246095f5fdce43e3fa77aa1f020760fd6857ce88750f2c675e301c61c4aa9ae9cb9d81a144f498fcf6a840284f62bf8bf45d2654710cf91f7
+  data.tar.gz: 302d7f0906ddee7951cd7a23cb2b4248de37bb3a6686e10b7d7f261b5615a39edd92747a7e4232c50709d22ed9fc4c5fbd8f73539ca01fa706b0cec065a36edf

data/README.md

@@ -1,11 +1,46 @@
-# CalculateInGroup
-Short description and motivation.
+# calculate_in_group
+
+[![RailsJazz](https://github.com/igorkasyanchuk/rails_time_travel/blob/main/docs/my_other.svg?raw=true)](https://www.railsjazz.com)
+[![https://www.patreon.com/igorkasyanchuk](https://github.com/igorkasyanchuk/rails_time_travel/blob/main/docs/patron.svg?raw=true)](https://www.patreon.com/igorkasyanchuk)
+
+Group ActiveRecord models with ranges. No more need to SQL with complex statements. Make your life easier :)
+
+Can solve problems like "I need to group users by age in different categories." or "I need to do some calculations for the reports/charts".
+
+Easy to use, just add to Gemfile `gem "calculate_in_group"` and call `calculate_in_group` on your model.
 
 ## Usage
-How to use my plugin.
+
+See below how to group your model by ranges or arrays and run aggregations for them in one SQL query.
+
+```ruby
+# Grouping can be used with :count, :average, :sum, :maximum, :minimum.
+
+# Group with Ranges
+User.calculate_in_group(:count, :age, [...10, 10...50, 50..] # => {"...10"=>1, "10...50"=>3, "50.."=>3}
+User.calculate_in_group(:count, :created_at, { "old" => 12.hours.ago..1.minutes.ago, "new" => Time.now..10.hours.from_now }) # => {"old" => 2, "new" => 1}
+
+# Group with arrays or just values
+User.calculate_in_group(:count, :role, "with_permissions" => ["admin", "moderator"], "no_permissions" => "user") # => {"with_permissions" => 3, "no_permissions" => 3}
+
+# Other agg functions
+User.calculate_in_group(:average, :age, "young" => 0..25, "old" => 60..100) # => {"young" => 11.0, "old" => 80.0}
+User.calculate_in_group(:average, :age, "young" => 0..25, "old" => 60...100) # => {"young" => 11.0, "old" => 60.0}
+User.calculate_in_group(:maximum, :age, "young" => 0..25, "old" => 60..100) # => {"young" => 20, "old" => 100}
+User.calculate_in_group(:minimum, :age, "young" => 0..25, "old" => 60..100) # => {"young" => 3, "old" => 60}
+User.calculate_in_group(:sum, :age, "young" => 0..25, "old" => 60..100) # => {"young" => 33, "old" => 160}
+User.calculate_in_group(:sum, :age, {"young" => 0..25, "old" => 60..100}) # => {"young" => 33, "old" => 160}
+
+# You can specify "other values" (with custom label) which are out of ranges
+User.calculate_in_group(:count, :age, {"young" => 10, "average" => 25, "old" => 60}, {include_nil: "OTHER"}) # => {"young" => 1, "old" => 1, "OTHER" => 7}
+
+# You can specify default value for keys which are missing in query
+User.calculate_in_group(:count, :age, {"young" => 10, "average" => 25, "old" => 60}, { default_for_missing: 0 }) # => {"young" => 1, "old" => 1, "average" => 0}
+
+# SEE MORE EXAMLES in test/calculate_in_group_test.rb
+```
 
 ## Installation
-Add this line to your application's Gemfile:
 
 ```ruby
 gem "calculate_in_group"
@@ -16,19 +51,16 @@ And then execute:
 $ bundle
 ```
 
-Or install it yourself as:
-```bash
-$ gem install calculate_in_group
-```
-
 ## Testing
 
-ruby test/calculate_in_group_test.rb
+`ruby test/calculate_in_group_test.rb`.
 
 Not sure, why rake test doesn't works for me :)
 
 ## Contributing
-Contribution directions go here.
+
+You are welcome to contribute or share your ideas.
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/calculate_in_group/version.rb

@@ -1,3 +1,3 @@
 module CalculateInGroup
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/calculate_in_group.rb

@@ -3,10 +3,12 @@ require "calculate_in_group/railtie"
 
 module CalculateInGroup
   module QueryMethods
-    def calculate_in_group(operation_type, field, groups = {}, options = {})
+    def calculate_in_group(operation_type, field, groups, options = {})
       # check if arguments are good
+      raise ArgumentError.new("Please specify options for groups. Check the documentation") if groups.empty?
       raise ArgumentError.new("Operation #{operation_type} not supported. Try to use: :count, :average, :sum, :maximum, :minimum") if ![:count, :average, :sum, :maximum, :minimum].include?(operation_type.to_s.to_sym)
       raise ArgumentError.new("Column #{field} not found in `#{table_name}`") if !column_names.include?(field.to_s)
+      raise ArgumentError.new("Groups `#{groups}` can be array or hash. Check the documentation") unless groups.is_a?(Array) || groups.is_a?(Hash)
 
       # init variables
       table               = self.arel_table
@@ -14,14 +16,29 @@ module CalculateInGroup
       operation_attribute = "__#{operation_type}_all"
       query               = Arel::Nodes::Case.new
       conditions          = []
+      groupings           = groups.is_a?(Array) ? groups.inject({}) {|res, e| res[e.to_s] = e; res} : groups
 
       # build conditions
-      groups.each do |(k, v)|
+      groupings.each do |(k, v)|
         c = case v
         when Range
           # range could be endless, so we need to compact and build correct SQL for "between"
           a = table[field].gteq(v.begin) if v.begin
-          b = table[field].lteq(v.end) if v.end
+          if v.end
+            b = if v.exclude_end? # e.g. 5...10 => [5,6,7,8,9]
+              # [3] pry(#<CalculateInGroupTest>)> a = 0...10
+              # a.to_a => [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
+              # [4] pry(#<CalculateInGroupTest>)> a.exclude_end?
+              # => true
+              table[field].lt(v.end)
+            else
+              # [1] pry(#<CalculateInGroupTest>)> a = 0..10
+              # a.to_a => [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
+              # [2] pry(#<CalculateInGroupTest>)> a.exclude_end?
+              # => false
+              table[field].lteq(v.end) # e.g. 5..10 => [5,6,7,8,9,10]
+            end
+          end
           [a, b].compact.inject(&:and)
         when Array
           # SQL "IN"
@@ -60,7 +77,7 @@ module CalculateInGroup
 
       # check if we need to build full hash with all grouped fields
       if options.has_key?(:default_for_missing)
-        (groups.keys.map(&:to_s) - result.keys).each do |k|
+        (groupings.keys.map(&:to_s) - result.keys).each do |k|
           result[k] = options[:default_for_missing]
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: calculate_in_group
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Igor Kasyanchuk