dbee 2.0.0.pre.alpha → 2.1.0.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccd40ea06b62b782bc525c069d38b01fc4c486b42507dd8f70e915ba197f01b6
-  data.tar.gz: a2f2fac76927357e5187d922c3da1ffd8e102430a878f8dedbec3aeb654ad0be
+  metadata.gz: acc518f50b6b9e95165347240882ca415194e6b641e68ff292d5b2a6d3937527
+  data.tar.gz: 954dbcdfac112f2098e7c1828d8c243369092526ee65179c9819ceaafddc70f7
 SHA512:
-  metadata.gz: ea4bfb0f14b33d70b7704ba8006189d5d725f90cf7de89d321d7147ab75c7b068644dd4d483b2aa7c1ee187080ae438096d05856b4c9d2b46265b5548a481d4a
-  data.tar.gz: ee4ecf4505be3b1911662de5553a3b38606af539a0bfadbc243fb2d38bf6d11310945bf2664d10795c97d0e6a82bc49262ae9550c0c7a867b25a4c1d9f3a4503
+  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.4
+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.3
+2.6.6

data/.travis.yml

@@ -4,9 +4,9 @@ env:
 language: ruby
 rvm:
   # Build on the latest stable of all supported Rubies (https://www.ruby-lang.org/en/downloads/):
-  - 2.4.6
-  - 2.5.5
-  - 2.6.3
+  - 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,41 @@
+# 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:
+
+* Constant resolution will now explicitly set inherit to false when calling `Object#const_defined?` and `Object#const_get`.  This should equate to less false positives.  For example:
+
+```ruby
+class A; end
+
+module B
+  class A; end
+  class C; end
+end
+```
+
+If `B::A` is the desired class, it would not be suitable to just declare an association on `A` as that would resolve explicitly to `::A`.  It also means C cannot be auto-resolved without prefixing/sharing the namespace with parent association `A`.
+
+# 2.0.2 (November 7th, 2019)
+
+### Additions:
+
+* As of 2019-11-07, it is not recommended to use Ruby 2.3, but support was requested and added for Ruby 2.3.8.  This is subject to being deprecated with next version.
+
+### Fixes:
+
+* Constantizing during inflection will now first check Object#const_defined? and if it is missing, it will now call Object#const_missing.  This should work better with auto-loaded environments where constant names may collide, since Object#const_get will traverse down the entire hierarchy and may lead to false positives.
+
 # 2.0.0 (September 3rd, 2019)
 
 ### Additions:

data/README.md

@@ -9,7 +9,7 @@ Dbee arose out of a need for an ad-hoc reporting solution that included:
 * de-coupling from our main ORM (ActiveRecord)
 * Rails 5.2.1 and above compatibility
 
-Dbee provides a very simple Data Modeling and Query API's and as such it is not meant to replace a traditional ORM or your data persistence layer, but compliment them.  This library's goal is to output the SQL statement needed and **nothing** more.
+Dbee provides very simple Data Modeling and Query API's and as such it is not meant to replace a traditional ORM or your data persistence layer, but compliment them.  This library's goal is to output the SQL statement needed and **nothing** more.
 
 Other solutions considered:
 
@@ -123,7 +123,7 @@ The two DSL methods: parent/child are very similar to ActiveRecord's belongs_to/
 
 ##### Customizing Inflection Rules
 
-Inflection is provided via the (Dry::Inflector gem)[https://github.com/dry-rb/dry-inflector].  There are options to add custom grammar rules which you can then pass into Dbee.  For example:
+Inflection is provided via the [Dry::Inflector gem](https://github.com/dry-rb/dry-inflector).  There are options to add custom grammar rules which you can then pass into Dbee.  For example:
 
 ````ruby
 Dbee.inflector = Dry::Inflector.new do |inflections|
@@ -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.4.6'
+  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', '~> 12')
+  s.add_development_dependency('rake', '~> 13')
   s.add_development_dependency('rspec')
-  s.add_development_dependency('rubocop', '~>0.74.0')
+  s.add_development_dependency('rubocop', '~>0.81.0')
   s.add_development_dependency('simplecov', '~>0.17.0')
-  s.add_development_dependency('simplecov-console', '~>0.5.0')
+  s.add_development_dependency('simplecov-console', '~>0.7.0')
 end

data/lib/dbee.rb

@@ -12,6 +12,7 @@ require 'dry/inflector'
 require 'forwardable'
 
 require_relative 'dbee/base'
+require_relative 'dbee/constant_resolver'
 require_relative 'dbee/key_chain'
 require_relative 'dbee/key_path'
 require_relative 'dbee/model'

data/lib/dbee/constant_resolver.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module Dbee
+  # This class is responsible for turning strings and symbols into constants.
+  # It does not deal with inflection, simply just constant resolution.
+  class ConstantResolver
+    # Only use Module constant resolution if a string or symbol was passed in.
+    # Any other type is defined as an acceptable constant and is simply returned.
+    def constantize(value)
+      value.is_a?(String) || value.is_a?(Symbol) ? object_constant(value) : value
+    end
+
+    private
+
+    # If the constant has been loaded, we can safely use it through const_get.
+    # If the constant has not been loaded, we need to defer to const_missing to resolve it.
+    # If we blindly call const_get, it may return false positives for namespaced constants
+    # or anything nested.
+    def object_constant(value)
+      if Object.const_defined?(value, false)
+        Object.const_get(value, false)
+      else
+        Object.const_missing(value)
+      end
+    end
+  end
+end

data/lib/dbee/dsl/association.rb

@@ -19,16 +19,17 @@ module Dbee
         raise ArgumentError, 'inflector is required'      unless inflector
         raise ArgumentError, 'name is required'           if name.to_s.empty?
 
-        @on_class_name  = on_class_name
-        @inflector      = inflector
-        @name           = name.to_s
-        @opts           = opts || {}
+        @on_class_name     = on_class_name
+        @inflector         = inflector
+        @name              = name.to_s
+        @opts              = opts || {}
+        @constant_resolver = ConstantResolver.new
 
         freeze
       end
 
       def model_constant
-        constantize(class_name)
+        constant_resolver.constantize(class_name)
       end
 
       def constraints
@@ -37,17 +38,18 @@ module Dbee
 
       private
 
+      attr_reader :constant_resolver
+
       def class_name
         opts[:model] || relative_class_name
       end
 
+      # This will automatically prefix the name of the module within the current classes
+      # hierarchy.  If the class does not happen to be in the same namespace then it needs
+      # to be explicitly set in the association using 'model' option.
       def relative_class_name
         (on_class_name.split('::')[0...-1] + [inflector.classify(name)]).join('::')
       end
-
-      def constantize(value)
-        value.is_a?(String) || value.is_a?(Symbol) ? Object.const_get(value) : value
-      end
     end
   end
 end

data/lib/dbee/dsl/methods.rb

@@ -39,9 +39,7 @@ module Dbee
             Dsl::Association.new(self.name, inflector, name, opts)
           end
 
-        tap do
-          associations_by_name[name.to_s] = value
-        end
+        tap { associations_by_name[name.to_s] = value }
       end
 
       def table_name

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.0-alpha'
+  VERSION = '2.1.0-alpha'
 end

data/spec/dbee/constant_resolver_spec.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'spec_helper'
+
+describe Dbee::ConstantResolver do
+  module A
+    class B; end
+    class E; end
+  end
+
+  class B; end
+
+  module C
+    class D; end
+    class E; end
+
+    module F
+      class G; end
+    end
+  end
+
+  it 'resolves nested constant with the same as an ancestor constants sibling' do
+    expect(subject.constantize('A::B')).to eq(::A::B)
+  end
+
+  it 'resolves root constant' do
+    expect(subject.constantize('B')).to eq(::B)
+  end
+
+  it 'does not resolve constant in a different parent module' do
+    expect { subject.constantize('C::B') }.to raise_error(NameError)
+  end
+
+  it 'does not resolve constant in a different parent module' do
+    expect { subject.constantize('D') }.to raise_error(NameError)
+  end
+
+  it 'resolves same leaf constants specific to their parents' do
+    expect(subject.constantize('A::E')).to eq(::A::E)
+    expect(subject.constantize('C::E')).to eq(::C::E)
+  end
+
+  it 'does not resolve constant without its parent' do
+    expect { subject.constantize('F') }.to raise_error(NameError)
+  end
+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.0.pre.alpha
+  version: 2.1.0.pre.alpha
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2019-09-03 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
@@ -78,14 +78,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -106,14 +106,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.74.0
+        version: 0.81.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.74.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.5.0
+        version: 0.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.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,8 +166,10 @@ files:
 - Rakefile
 - bin/console
 - dbee.gemspec
+- exe/.gitkeep
 - lib/dbee.rb
 - lib/dbee/base.rb
+- lib/dbee/constant_resolver.rb
 - lib/dbee/dsl/association.rb
 - lib/dbee/dsl/association_builder.rb
 - lib/dbee/dsl/methods.rb
@@ -203,6 +204,7 @@ files:
 - lib/dbee/query/sorters/descending.rb
 - lib/dbee/version.rb
 - spec/dbee/base_spec.rb
+- spec/dbee/constant_resolver_spec.rb
 - spec/dbee/key_chain_spec.rb
 - spec/dbee/key_path_spec.rb
 - spec/dbee/model/constraints/base_spec.rb
@@ -225,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:
@@ -234,7 +241,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.6
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
@@ -247,6 +254,7 @@ specification_version: 4
 summary: Adhoc Reporting SQL Generator
 test_files:
 - spec/dbee/base_spec.rb
+- spec/dbee/constant_resolver_spec.rb
 - spec/dbee/key_chain_spec.rb
 - spec/dbee/key_path_spec.rb
 - spec/dbee/model/constraints/base_spec.rb