calculate-all 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 87793b642f35f1a0ac13c64ccc7b18f4dff5214f
+  data.tar.gz: 63106f78ba19a0e937389595464fe167cbd4fe78
+SHA512:
+  metadata.gz: 195576395014c54049f6837ec4e44a4f72ace4b1e97ad4c4523bb85455c12efef59a3af9f5c0969cfb8bed01ce79e4c6c082f4bfc999dd1873682a32d413ebae
+  data.tar.gz: d94eb40b7d9e876d9c6c9d0fd3be3eb89132dd9c0d01ff2cb950d8887f1b17b9f952f978b568fbd1bd27b52fd418da8aebd0c72aec3133864bcd657ac20b0198

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.0
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in calculate-all.gemspec
+gemspec
+
+gem "activerecord"
+gem "pry"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alexey "codesnik" Trofimenko
+
+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,71 @@
+# CalculateAll
+
+Provides `#calculate_all` method on your Active Record models, scopes and relations.
+It's a little addition to Active Record's `#count`, `#maximum`, `#minimum`, `#average` and `#sum`.
+It allows to fetch all of the above and any other aggregate functions results in one request, with respect to grouping.
+
+Tested only with Postgres and Mysql only right now. It relies on automatic values type-casting of underlying driver.
+
+## Usage
+
+```ruby
+results = YourModel.yourscopes.group(:grouping1).group(:grouping2)
+  .calculate_all(:column1_max, :column2_distinct_count,
+    column3_median: 'percentile_cont(0.5) within group (order by column3 desc)')
+```
+
+`#calculate_all` tries to mimic magic level of Active Record's `#group, `#count` and `#pluck`
+so result type depends on arguments and on groupings.
+
+### Container
+
+If you have no `group()` on underlying scope, `#calculate_all` will return just one result.
+If you have one group, it will return hash of results, with simple keys.
+If you have two or more groupings, each result will have an array as a key.
+
+### Results
+
+If you provide just one argument to `#calculate_all`, its calculated value will be returned as is.
+Otherwise results would be returned as hash(es) with symbol keys.
+
+so, `Model.calculate_all(:count)` will return just a single integer,
+but `Model.group(:foo1, :foo2).calculate_all(expr1: 'count(expr1)', expr2: 'count(expr2)')` will return
+something like this:
+
+```ruby
+{
+  ['foo1_1', 'foo2_1'] => {expr1: 0, expr2: 1},
+  ['foo1_1', 'foo2_2'] => {expr1: 2, expr2: 3},
+  ...
+}
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'calculate-all'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install calculate-all
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/codesnik/calculate-all.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "calculate-all"
+
+require './test/test_helper'
+require 'logger'
+ActiveRecord::Base.logger = Logger.new(STDERR)
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/calculate-all.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'calculate-all/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "calculate-all"
+  spec.version       = CalculateAll::VERSION
+  spec.authors       = ["codesnik"]
+  spec.email         = ["aronaxis@gmail.com"]
+
+  spec.summary       = %q{Fetch from database results of several aggregate functions at once}
+  spec.description   = %q{Extends Active Record with #calculate_all method}
+  spec.homepage      = "http://github.com/codesnik/calculate-all"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "pg"
+  spec.add_development_dependency "mysql2"
+end

data/lib/calculate-all.rb

@@ -0,0 +1,78 @@
+require "calculate-all/version"
+require "active_record"
+
+module CalculateAll
+  def calculate_all(*function_aliases, **functions)
+    if function_aliases.size == 1 && functions == {}
+      return_plain_values = true
+    end
+    functions.merge!(
+      CalculateAll::Helpers.decode_function_aliases(function_aliases)
+    )
+    if functions == {}
+      raise ArgumentError, "provide at least one function to calculate"
+    end
+    if functions.size == 1 && group_values.size == 0
+      plain_rows = true
+    end
+
+    results = {}
+
+    pluck(*group_values, *functions.values).each do |row|
+      row = [row] if plain_rows
+      if return_plain_values
+        value = row.last
+      else
+        value = functions.keys.zip(row.last(functions.size)).to_h
+      end
+
+      # Return unwrapped hash directly for scope without any .group()
+      return value if group_values.empty?
+
+      if group_values.size == 1
+        key = row.first
+      else
+        key = row.first(group_values.size)
+      end
+      results[key] = value
+    end
+
+    results
+  end
+
+  module Helpers
+    module_function
+    def decode_function_aliases(aliases)
+      aliases.map do |key|
+        function =
+          case key
+          when String
+            key
+          when :count
+            "COUNT(*)"
+          when /^(.*)_distinct_count$/, /^count_distinct_(.*)$/
+            "COUNT(DISTINCT #{$1})"
+          when /^(.*)_(count|sum|max|min|avg)$/
+            "#{$2.upcase}(#{$1})"
+          when /^(count|sum|max|min|avg)_(.*)$$/
+            "#{$1.upcase}(#{$2})"
+          when /^(.*)_average$/, /^average_(.*)$/
+            "AVG(#{$1})"
+          when /^(.*)_maximum$/, /^maximum_(.*)$/
+            "MAX(#{$1})"
+          when /^(.*)_minimum$/, /^minimum_(.*)$/
+            "MIN(#{$1})"
+          else
+            raise ArgumentError, "Can't recognize function alias #{key}"
+          end
+        [key, function]
+      end.to_h
+    end
+  end
+  module Querying
+    delegate :calculate_all, to: :all
+  end
+end
+
+ActiveRecord::Relation.include CalculateAll
+ActiveRecord::Base.extend CalculateAll::Querying

data/lib/calculate-all/version.rb

@@ -0,0 +1,3 @@
+module CalculateAll
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: calculate-all
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- codesnik
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: 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: 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: 'Extends Active Record with #calculate_all method'
+email:
+- aronaxis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- calculate-all.gemspec
+- lib/calculate-all.rb
+- lib/calculate-all/version.rb
+homepage: http://github.com/codesnik/calculate-all
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Fetch from database results of several aggregate functions at once
+test_files: []