dbee 2.0.3 → 2.1.0.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a84b1a2e86f04be67850fa1bfe79aa9a52d1548db6ba8c76df551b5257a00bd8
-  data.tar.gz: 2c7d2d5b847e805f46c94019c72b6d7c79990ebd2d4b7d8a3d940278b267a904
+  metadata.gz: acc518f50b6b9e95165347240882ca415194e6b641e68ff292d5b2a6d3937527
+  data.tar.gz: 954dbcdfac112f2098e7c1828d8c243369092526ee65179c9819ceaafddc70f7
 SHA512:
-  metadata.gz: 83f756643490546309610118e1ff5efb501c3db51c0322e5a2bb7a0fe2bc96b5164362d9531e6ff11371fee8a6096ba38c04f5c269bf590670fa76c03d62bb45
-  data.tar.gz: 449063144c4ba5babd0358e7d8851686d4cf7520d2aef2a9444175e616cc9a9a01fe8c3596c941e24ce4dafa5c7e4aaa0fe8d8ac378953f61d97e2acbc4a36b8
+  metadata.gz: 5731c83ec9b0ded7f36c6b07d16597f97337240bd65bbec7dc82a9ca7f4de4da0cac9063a6e9aa9cf8199e6f5c32e7ab0a2904684b64bebde9e996f9bceb8e41
+  data.tar.gz: c47a038d7fac640a620a13373460bbd8df05a35b209264de1b0fedd727eab072925d0f2cfa82a800ddd2362756f887b0cd227d1e1cd01c98a0334b1c3cd55cd0

data/.rubocop.yml

@@ -1,6 +1,18 @@
-Metrics/LineLength:
+AllCops:
+  TargetRubyVersion: 2.5
+
+Layout/LineLength:
   Max: 100
 
+Lint/RaiseException:
+  Enabled: True
+
+Lint/StructNewOverride:
+  Enabled: True
+
+Metrics/AbcSize:
+  Max: 16
+
 Metrics/BlockLength:
   ExcludedMethods:
     - let
@@ -10,14 +22,17 @@ Metrics/BlockLength:
     - specify
     - define
 
+Metrics/ClassLength:
+  Max: 125
+
 Metrics/MethodLength:
   Max: 25
 
-AllCops:
-  TargetRubyVersion: 2.3
+Style/HashEachMethods:
+  Enabled: True
 
-Metrics/AbcSize:
-  Max: 16
+Style/HashTransformKeys:
+  Enabled: True
 
-Metrics/ClassLength:
-  Max: 125
+Style/HashTransformValues:
+  Enabled: True

data/.ruby-version

@@ -1 +1 @@
-2.6.5
+2.6.6

data/.travis.yml

@@ -4,10 +4,9 @@ env:
 language: ruby
 rvm:
   # Build on the latest stable of all supported Rubies (https://www.ruby-lang.org/en/downloads/):
-  - 2.3.8
-  - 2.4.6
-  - 2.5.5
-  - 2.6.5
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
 cache: bundler
 before_script:
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# 2.1.0 (TBD)
+
+### Additions:
+
+* Added Dbee::Query::Field#aggregator (such as ave, min, max, sum, etc.)
+* Added Dbee::Query::Field#filters (allows for doing select column filtering)
+
+### Changes:
+
+* Bumped minimum Ruby version to 2.5
+
 # 2.0.3 (January 7th, 2020)
 
 ### Fixes:

data/README.md

@@ -407,6 +407,129 @@ sql = Dbee.sql(model, query, provider)
 
 The above examples showed how to use a plugin provider, see the plugin provider's documentation for more information about its options and use.
 
+#### Aggregation
+
+Fields can be configured to use aggregation by setting its `aggregator` attribute.  For example, say we wanted to count the number of patients per practice:
+
+**Data Model**:
+
+````yaml
+name: practice
+models:
+  - name: patients
+    constraints:
+      - type: reference
+        name: practice_id
+        parent: id
+````
+
+**Query**:
+
+````ruby
+query = {
+  fields: [
+    {
+      key_path: 'id',
+      display: 'Practice ID #',
+    },
+    {
+      key_path: 'name',
+      display: 'Practice Name',
+    },
+    {
+      key_path: 'patients.id',
+      display: 'Total Patients',
+      aggregator: :count
+    },
+  ]
+````
+
+An example of a materialized result would be something akin to:
+
+Practice ID # | Practice Name   | Total Patients
+------------- | --------------- | --------------
+1             | Families Choice | 293
+2             | Awesome Choice  | 2305
+3             | Best Value      | 1200
+
+A complete list of aggregator values can be found by inspecting the `Dbee::Query::Field::Aggregator` constant.
+
+#### Field/Column Level Filtering & Pivoting
+
+Fields can also have filters which provide post-filtering (on the select-level instead of at query-level.)  This can be used in conjunction with aggregate functions to provide pivoting.  For example:
+
+**Data/Schema Example**:
+
+patients:
+
+id | first | last
+-- | ----- | -----
+1  | frank | rizzo
+
+patient_fields:
+
+id | patient_id | key             | value
+-- | ---------- | --------------- | -----
+1  | 1          | dob             | 1900-01-01
+2  | 1          | drivers_license | ABC123
+
+**Model Configuration**:
+
+````yaml
+name: patients
+models:
+  - name: patient_fields
+    constraints:
+      - type: reference
+        parent: id
+        name: patient_id
+````
+
+**Query**:
+
+````ruby
+query = {
+  fields: [
+    {
+      key_path: 'id',
+      display: 'ID #'
+    },
+    {
+      key_path: 'first',
+      display: 'First Name'
+    },
+    {
+      aggregator: :max,
+      key_path: 'patient_fields.value',
+      display: 'Date of Birth',
+      filters: [
+        {
+          key_path: 'patient_fields.key',
+          value: 'dob'
+        }
+      ]
+    },
+    {
+      aggregator: :max,
+      key_path: 'patient_fields.value',
+      display: 'Drivers License #',
+      filters: [
+        {
+          key_path: 'patient_fields.key',
+          value: 'drivers_license'
+        }
+      ]
+    }
+  }
+}
+````
+
+Executing the query above against the data and model would yield:
+
+ID # | First Name | Date of Birth | Drivers License #
+--   | ---------- | ------------- | -----------------
+1    | frank      | 1900-01-01    | ABC123
+
 
 ## Contributing
 

data/dbee.gemspec

@@ -15,20 +15,28 @@ Gem::Specification.new do |s|
   s.email       = ['mruggio@bluemarblepayroll.com']
   s.files       = `git ls-files`.split("\n")
   s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.bindir      = 'exe'
+  s.executables = []
   s.homepage    = 'https://github.com/bluemarblepayroll/dbee'
   s.license     = 'MIT'
+  s.metadata    = {
+    'bug_tracker_uri' => 'https://github.com/bluemarblepayroll/dbee/issues',
+    'changelog_uri' => 'https://github.com/bluemarblepayroll/dbee/blob/master/CHANGELOG.md',
+    'documentation_uri' => 'https://www.rubydoc.info/gems/dbee',
+    'homepage_uri' => s.homepage,
+    'source_code_uri' => s.homepage
+  }
 
-  s.required_ruby_version = '>= 2.3.8'
+  s.required_ruby_version = '>= 2.5'
 
-  s.add_dependency('acts_as_hashable', '~>1', '>=1.1.0')
+  s.add_dependency('acts_as_hashable', '~>1', '>=1.2.0')
   s.add_dependency('dry-inflector', '~>0')
 
   s.add_development_dependency('guard-rspec', '~>4.7')
   s.add_development_dependency('pry', '~>0')
   s.add_development_dependency('rake', '~> 13')
   s.add_development_dependency('rspec')
-  s.add_development_dependency('rubocop', '~>0.79.0')
+  s.add_development_dependency('rubocop', '~>0.81.0')
   s.add_development_dependency('simplecov', '~>0.17.0')
-  s.add_development_dependency('simplecov-console', '~>0.6.0')
+  s.add_development_dependency('simplecov-console', '~>0.7.0')
 end

data/lib/dbee/query.rb

@@ -25,10 +25,8 @@ module Dbee
 
     attr_reader :fields, :filters, :limit, :sorters
 
-    def_delegator :fields, :sort, :sorted_fields
-
+    def_delegator :fields,  :sort, :sorted_fields
     def_delegator :filters, :sort, :sorted_filters
-
     def_delegator :sorters, :sort, :sorted_sorters
 
     def initialize(fields:, filters: [], limit: nil, sorters: [])

data/lib/dbee/query/field.rb

@@ -15,24 +15,55 @@ module Dbee
     class Field
       acts_as_hashable
 
-      attr_reader :key_path, :display
+      module Aggregator
+        AVE   = :ave
+        COUNT = :count
+        MAX   = :max
+        MIN   = :min
+        SUM   = :sum
+      end
+      include Aggregator
+
+      attr_reader :aggregator, :display, :filters, :key_path
 
-      def initialize(key_path:, display: nil)
+      def initialize(
+        aggregator: nil,
+        display: nil,
+        filters: [],
+        key_path:
+      )
         raise ArgumentError, 'key_path is required' if key_path.to_s.empty?
 
-        @key_path = KeyPath.get(key_path)
-        @display = (display.to_s.empty? ? key_path : display).to_s
+        @aggregator = aggregator ? Aggregator.const_get(aggregator.to_s.upcase.to_sym) : nil
+        @display    = (display.to_s.empty? ? key_path : display).to_s
+        @filters    = Filters.array(filters).uniq
+        @key_path   = KeyPath.get(key_path)
 
         freeze
       end
 
+      def filters?
+        filters.any?
+      end
+
+      def aggregator?
+        !aggregator.nil?
+      end
+
       def hash
-        "#{key_path}#{display}".hash
+        [
+          aggregator,
+          display,
+          filters,
+          key_path
+        ].hash
       end
 
       def ==(other)
         other.instance_of?(self.class) &&
+          other.aggregator == aggregator &&
           other.key_path == key_path &&
+          other.filters == filters &&
           other.display == display
       end
       alias eql? ==

data/lib/dbee/version.rb

@@ -8,5 +8,5 @@
 #
 
 module Dbee
-  VERSION = '2.0.3'
+  VERSION = '2.1.0-alpha'
 end

data/spec/dbee/query/field_spec.rb

@@ -10,6 +10,31 @@
 require 'spec_helper'
 
 describe Dbee::Query::Field do
+  let(:config) do
+    {
+      display: 'd',
+      key_path: 'a.b.c'
+    }
+  end
+
+  let(:config_with_aggregation_and_filters) do
+    config.merge(
+      aggregator: :ave,
+      filters: [
+        {
+          key_path: 'a.b',
+          value: 'something'
+        }
+      ]
+    )
+  end
+
+  subject { described_class.new(config_with_aggregation_and_filters) }
+
+  let(:subject_without_aggregation_and_filters) do
+    described_class.new(config)
+  end
+
   it 'should act as hashable' do
     expect(described_class).to respond_to(:make)
     expect(described_class).to respond_to(:array)
@@ -24,16 +49,19 @@ describe Dbee::Query::Field do
   end
 
   context 'equality' do
-    let(:config) { { key_path: 'a.b.c', display: 'd' } }
+    specify '#hash produces same output as [aggregator, key_path, and display]' do
+      expected = [
+        subject.aggregator,
+        subject.display,
+        subject.filters,
+        subject.key_path
+      ].hash
 
-    subject { described_class.new(config) }
-
-    specify '#hash produces same output as concatenated string hash of key_path and display' do
-      expect(subject.hash).to eq("#{config[:key_path]}#{config[:display]}".hash)
+      expect(subject.hash).to eq(expected)
     end
 
     specify '#== and #eql? compare attributes' do
-      object2 = described_class.new(config)
+      object2 = described_class.new(config_with_aggregation_and_filters)
 
       expect(subject).to eq(object2)
       expect(subject).to eql(object2)
@@ -44,4 +72,24 @@ describe Dbee::Query::Field do
       expect(subject).not_to eq(nil)
     end
   end
+
+  describe '#aggregator?' do
+    it 'returns true if not nil' do
+      expect(subject.aggregator?).to be true
+    end
+
+    it 'returns false if nil' do
+      expect(subject_without_aggregation_and_filters.aggregator?).to be false
+    end
+  end
+
+  describe '#filters?' do
+    it 'returns true if at least one filter' do
+      expect(subject.filters?).to be true
+    end
+
+    it 'returns false if nil' do
+      expect(subject_without_aggregation_and_filters.filters?).to be false
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dbee
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.1.0.pre.alpha
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2020-01-07 00:00:00.000000000 Z
+date: 2020-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_hashable
@@ -19,7 +19,7 @@ dependencies:
         version: '1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: dry-inflector
   requirement: !ruby/object:Gem::Requirement
@@ -106,14 +106,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.79.0
+        version: 0.81.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.79.0
+        version: 0.81.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -134,22 +134,21 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
 description: "    Dbee provides a simple-to-use data modeling and query API.  The
   query API can produce SQL using other ORMs, such as Arel/ActiveRecord.  The targeted
   use-case for Dbee is ad-hoc reporting, so the total SQL feature-set that Dbee supports
   is rather limited.\n"
 email:
 - mruggio@bluemarblepayroll.com
-executables:
-- console
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -167,6 +166,7 @@ files:
 - Rakefile
 - bin/console
 - dbee.gemspec
+- exe/.gitkeep
 - lib/dbee.rb
 - lib/dbee/base.rb
 - lib/dbee/constant_resolver.rb
@@ -227,7 +227,12 @@ files:
 homepage: https://github.com/bluemarblepayroll/dbee
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/bluemarblepayroll/dbee/issues
+  changelog_uri: https://github.com/bluemarblepayroll/dbee/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/dbee
+  homepage_uri: https://github.com/bluemarblepayroll/dbee
+  source_code_uri: https://github.com/bluemarblepayroll/dbee
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -236,12 +241,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.8
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: