calculate_in_group 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c5a7b900a5d475fc22804562ef0bac072706dcb251219b5be5c06c302f5dd75a
+  data.tar.gz: 73fa7ceb228a9704acc409ba00b99af5d307b9cfe8739a09496097481ee5b7d0
+SHA512:
+  metadata.gz: 80974131cdfb53dfc1279c516a61c72565ae29a3cc2bd181823298158a7fae24360e7fae377ab4e174984c2d4657650b93ac4d3b5b647f4bca084998d81667ab
+  data.tar.gz: 0d6c1989fa40e2dd60e77f1897467a05dd36caf2ee581d60884e176688c0bf501c7ecb0cc940c3eb04ef25bef5f04c2689e51a70db07ead31925ebd2ae55e027

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Igor Kasyanchuk
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,34 @@
+# CalculateInGroup
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "calculate_in_group"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install calculate_in_group
+```
+
+## Testing
+
+ruby test/calculate_in_group_test.rb
+
+Not sure, why rake test doesn't works for me :)
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/calculate_in_group/railtie.rb

@@ -0,0 +1,4 @@
+module CalculateInGroup
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/calculate_in_group/version.rb

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

data/lib/calculate_in_group.rb

@@ -0,0 +1,91 @@
+require "calculate_in_group/version"
+require "calculate_in_group/railtie"
+
+module CalculateInGroup
+  module QueryMethods
+    def calculate_in_group(operation_type, field, groups = {}, options = {})
+      # check if arguments are good
+      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)
+
+      # init variables
+      table               = self.arel_table
+      group_field         = "__#{field}"
+      operation_attribute = "__#{operation_type}_all"
+      query               = Arel::Nodes::Case.new
+      conditions          = []
+
+      # build conditions
+      groups.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
+          [a, b].compact.inject(&:and)
+        when Array
+          # SQL "IN"
+          table[field].in(v)
+        else
+          # SQL "="
+          table[field].eq(v)
+        end
+        query = query.when(Arel.sql("(" + c.to_sql + ")#{__calculate_in_group_db_addon}")).then(k)
+        conditions.push(where(field => v))
+      end
+
+      # what we actually want to do? count, sum, average...., determine how we start SELECT ...
+      operation = if operation_type == :count
+        Arel.star.count.as(operation_attribute)
+      else
+        table[field].send(operation_type).as(operation_attribute)
+      end
+
+      # time to build query to DB
+      # SELECT + WHERE + GROUP + OPERATION (sum, count, etc..)
+      res = select([operation, query.as(group_field)])
+      res = res.merge(conditions.inject(&:or)) if !options[:include_nil] && conditions.any?
+      res = res.group(group_field)
+
+      # process result from DB#
+      # check if need to include "nil" value
+      result = res.inject({}) do |res, e|
+        key = e.send(group_field)
+        if key.nil? && options[:include_nil].present? && !!options[:include_nil] != options[:include_nil] # not boolean, when option is a label
+          key = options[:include_nil]
+        end
+        res[key] = e.send(operation_attribute)
+        res
+      end
+
+      # 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|
+          result[k] = options[:default_for_missing]
+        end
+      end
+
+      # return :)
+      result
+    end
+
+    private
+    # this is needed for Postgres DB, it want's a bit different SQL in CASE statement
+    def __calculate_in_group_db_addon
+      adapter_type = connection.adapter_name.downcase.to_sym
+      case adapter_type
+      when :mysql, :mysql2, :sqlite3, :sqlite
+        nil # should work normally
+      when :postgresql
+        "::boolean"
+      else
+        raise NotImplementedError, "Unsupported adapter type '#{adapter_type}'"
+      end
+    end
+  end
+
+end
+
+ActiveSupport.on_load(:active_record) do
+  ActiveRecord::Base.extend(CalculateInGroup::QueryMethods)
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: calculate_in_group
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Igor Kasyanchuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rails active record grouping with range
+email:
+- igorkasyanchuk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/calculate_in_group.rb
+- lib/calculate_in_group/railtie.rb
+- lib/calculate_in_group/version.rb
+homepage: https://github.com/igorkasyanchuk/calculate_in_group
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/igorkasyanchuk/calculate_in_group
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key: 
+specification_version: 4
+summary: Rails active record grouping with range
+test_files: []