dbee 2.1.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3c9c1444028bdfd5a4aa9eeb8c98055184f1b2cec2b819376e3f5344850d3b9
-  data.tar.gz: '059ac6adca29bae5a1eb0fc9f13247159047f1e8c82b3b31398d4492913ef595'
+  metadata.gz: 2b8250c307ad60bdb8bc51e19fdb93b2c9eb3db0cccfb5daad0a2e621aab57cb
+  data.tar.gz: db66f66f4a56dd40bbaa347218d0827291c789733b9c3f7086ca416e85a09246
 SHA512:
-  metadata.gz: f67474cd84508029e3f3ca6e91ee2a1192b3cb1f8bf36f6b2d18a9c51e75ba3af897b01ea16676c6c79b000bd8d44d1381a7785fa56a9b81b906d47332e1c687
-  data.tar.gz: 6d6d061db4ef0c39cc1af32368d725c8354af5fc143a562f10e3beed7c3d260f7ddc93ab2aaff6016c483f370e9ccfec5e54c72dffcb8044c723025cb40dfdb5
+  metadata.gz: '0085b06c34404de9b93b728713fd118189a2693920668685e66574c2bd23b8cb2009d0ab4a047dbbc8b4e7c69084a3ec595d1fa80aaf6de06bce023d5fff3d1a'
+  data.tar.gz: a295c963939ce9df84689bd3ab34852df111a7c57e685ac07abdb661498dc269fe85e661fae49b77826e43054030fb09c18fe7da648a1cdc78020024bac15a52

data/.gitignore

@@ -4,3 +4,4 @@
 /coverage
 Gemfile.lock
 /pkg
+.vscode

data/.rubocop.yml

@@ -9,7 +9,7 @@ Metrics/AbcSize:
   Max: 16
 
 Metrics/BlockLength:
-  ExcludedMethods:
+  IgnoredMethods:
     - let
     - it
     - describe
@@ -17,6 +17,9 @@ Metrics/BlockLength:
     - specify
     - define
 
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+
 Metrics/ClassLength:
   Max: 125
 

data/.travis.yml

@@ -1,12 +1,13 @@
 env:
   global:
     - CC_TEST_REPORTER_ID=e7db23dad7560a076e48357331b0362db3741b62dbdd537bc30de27fa9cab69b
+    - DISABLE_RSPEC_FOCUS=true
 language: ruby
 rvm:
   # Build on the latest stable of all supported Rubies (https://www.ruby-lang.org/en/downloads/):
   - 2.5.8
   - 2.6.6
-  - 2.7.1
+  - 2.7.2
 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 @@
+# 3.0.0 (March 11th, 2021)
+
+### Additions
+
+* Support for graph based models. This paves the way for representing more advanced features, such as sub-queries in a more clear way. Since graph based models are similar to DSL models, the hope is that they will be easier to work with and understand.
+
+### Breaking Changes
+
+* The `to_model` method on `Dbee::Base` objects has been removed. Use `to_schema` instead.
+* The `ancestors!` method on `Dbee::Model` has been removed. Use `Dbee::Schema#expand_query_path` instead.
+
 # 2.1.1 (July 14th, 2020)
 
 * Removed guard that ensured a query has at least one field to establish a more rational base-case.

data/README.md

@@ -20,7 +20,7 @@ Both of these solutions ended up closely coupling our domain data layer to ad-ho
 
 ## Installation
 
-This specific library is the core modeling component of the Dbee framework, but by itself, it not completely usable.  You will need to provide a SQL generator which understands how to convert the data and query modeling to actual SQL.  This library comes with a stub: Dbee::Providers::NullProvider, while the main reference implementation is split out into its own library: [dbee-active_record](https://github.com/bluemarblepayroll/dbee-active_record). Together these two libraries comprise a complete solution.  Refer to the other library for more information on installation.
+This specific library is the core modeling component of the Dbee framework, but by itself, it is not completely usable.  You will need to provide a SQL generator which understands how to convert the data and query modeling to actual SQL.  This library comes with a stub: Dbee::Providers::NullProvider, while the main reference implementation is split out into its own library: [dbee-active_record](https://github.com/bluemarblepayroll/dbee-active_record). Together these two libraries comprise a complete solution.  Refer to the other library for more information on installation.
 
 To install through Rubygems:
 
@@ -189,49 +189,58 @@ The two code-first examples above should be technically equivalent.
 You can choose to alternatively describe your data model using configuration.  The YAML below is equivalent to the Ruby sub-classes above:
 
 ````yaml
-name: practice
-models:
-  - name: patients
-    constraints:
-      - type: reference
-        name: practice_id
-        parent: id
-    models:
-      - name: notes
-        constraints:
-          - type: reference
-            name: patient_id
-            parent: id
-      - name: work_phone_number
-        table: phones
-        constraints:
-          - type: reference
-            name: patient_id
-            parent: id
-          - type: static
-            name: phone_number_type
-            value: work
-      - name: cell_phone_number
-        table: phones
-        constraints:
-          - type: reference
-            name: patient_id
-            parent: id
-          - type: static
-            name: phone_number_type
-            value: cell
-      - name: fax_phone_number
-        table: phones
-        constraints:
-          - type: reference
-            name: patient_id
-            parent: id
-          - type: static
-            name: phone_number_type
-            value: fax
+practice:
+  table: practices
+  relationships:
+    patients:
+      model: patient
+      constraints:
+        - type: reference
+          name: practice_id
+          parent: id
+patient:
+  table: patients
+  relationships:
+    notes:
+      model: note
+      constraints:
+        - type: reference
+          name: patient_id
+          parent: id
+    work_phone_number:
+      model: phone_number
+      constraints:
+        - type: reference
+          name: patient_id
+          parent: id
+        - type: static
+          name: phone_number_type
+          value: work
+    cell_phone_number:
+      model: phone_number
+      constraints:
+        - type: reference
+          name: patient_id
+          parent: id
+        - type: static
+          name: phone_number_type
+          value: cell
+    fax_phone_number:
+      model: phone_number
+      constraints:
+        - type: reference
+          name: patient_id
+          parent: id
+        - type: static
+          name: phone_number_type
+          value: fax
+note:
+  table: notes
+phone_number:
+  table: phones
 ````
 
-It is up to you to determine which modeling technique to use as both are equivalent.  Technically speaking, the code-first DSL is nothing more than syntactic sugar on top of Dbee::Model.
+It is up to you to determine which modeling technique to use as both are equivalent.  Technically speaking, the code-first DSL is nothing more than syntactic sugar on top of `Dbee::Schema` and `Dbee::Model`. Also note that prior to version three of this project, a more hierarchical tree based model configuration was used. See [Tree Based Model Backward Compatibility](#tree-based-model-backward-compatibility) below for more information on this.
 
 #### Table Partitioning
 
@@ -275,6 +284,7 @@ Cats:
 The Query API (Dbee::Query) is a simplified and abstract way to model an SQL query.  A Query has the following components:
 
 * fields (SELECT)
+* from (FROM)
 * filters (WHERE)
 * sorters (ORDER BY)
 * limit (LIMIT/TAKE)
@@ -291,6 +301,7 @@ Get all practices:
 
 ````ruby
 query = {
+  from: 'practice',
   fields: [
     { key_path: 'id' },
     { key_path: 'active' },
@@ -303,6 +314,7 @@ Get all practices, limit to 10, and sort by name (descending) then id (ascending
 
 ````ruby
 query = {
+  from: 'practice',
   fields: [
     { key_path: 'id' },
     { key_path: 'active' },
@@ -320,6 +332,7 @@ Get top 5 active practices and patient whose name start with 'Sm':
 
 ````ruby
 query = {
+  from: 'practice',
   fields: [
     { key_path: 'name', display: 'Practice Name' },
     { key_path: 'patients.first', display: 'Patient First Name' },
@@ -338,6 +351,7 @@ Get practice IDs, patient IDs, names, and cell phone numbers that starts with '5
 
 ````ruby
 query = {
+  from: 'practice',
   fields: [
     { key_path: 'id', display: 'Practice ID #' },
     { key_path: 'patients.id', display: 'Patient ID #' },
@@ -373,7 +387,7 @@ require 'dbee/providers/active_record_provider'
 class Practice < Dbee::Base; end
 
 provider = Dbee::Providers::ActiveRecordProvider.new
-query    = {}
+query    = { from: 'practice' }
 sql      = Dbee.sql(Practice, query, provider)
 ````
 
@@ -389,6 +403,7 @@ class Practice < Dbee::Base; end
 provider = Dbee::Providers::ActiveRecordProvider.new
 
 query = {
+  from: 'practice',
   fields: [
     { key_path: 'id' },
     { key_path: 'active' },
@@ -407,10 +422,11 @@ require 'dbee/providers/active_record_provider'
 provider = Dbee::Providers::ActiveRecordProvider.new
 
 model = {
-  name: :practice
+  practice: { table: 'practices' }
 }
 
 query = {
+  from: 'practice',
   fields: [
     { key_path: 'id' },
     { key_path: 'active' },
@@ -430,19 +446,24 @@ Fields can be configured to use aggregation by setting its `aggregator` attribut
 **Data Model**:
 
 ````yaml
-name: practice
-models:
-  - name: patients
-    constraints:
-      - type: reference
-        name: practice_id
-        parent: id
+practice:
+  table: practices
+  relationships:
+    patients:
+      model: patient
+      constraints:
+        - type: reference
+          name: practice_id
+          parent: id
+patient:
+  table: patients
 ````
 
 **Query**:
 
 ````ruby
 query = {
+  from: 'practice',
   fields: [
     {
       key_path: 'id',
@@ -492,19 +513,21 @@ id | patient_id | key             | value
 **Model Configuration**:
 
 ````yaml
-name: patients
-models:
-  - name: patient_fields
-    constraints:
-      - type: reference
-        parent: id
-        name: patient_id
+patients:
+  relationships:
+    - patient_fields:
+      constraints:
+        - type: reference
+          parent: id
+          name: patient_id
+patient_fields:
 ````
 
 **Query**:
 
 ````ruby
 query = {
+  from: 'patients',
   fields: [
     {
       key_path: 'id',
@@ -546,7 +569,59 @@ ID # | First Name | Date of Birth | Drivers License #
 --   | ---------- | ------------- | -----------------
 1    | frank      | 1900-01-01    | ABC123
 
+## Tree Based Model Backward Compatibility
+
+In version three of this gem, the representation of configuration based models was changed to be more of a graph structure than the previous tree structure. For backwards compatibility, it is still possible to pass this older tree based structure as the first argument `Dbee.sql`. The practices example would be represented this way in the old structure:
+
+````yaml
+  # Deprecated tree based model configuration:
+  name: practice
+  table: practices
+  models:
+    - name: patients
+      constraints:
+        - type: reference
+          name: practice_id
+          parent: id
+      models:
+        - name: notes
+          constraints:
+            - type: reference
+              name: patient_id
+              parent: id
+        - name: work_phone_number
+          table: phones
+          constraints:
+            - type: reference
+              name: patient_id
+              parent: id
+            - type: static
+              name: phone_number_type
+              value: work
+        - name: cell_phone_number
+          table: phones
+          constraints:
+            - type: reference
+              name: patient_id
+              parent: id
+            - type: static
+              name: phone_number_type
+              value: cell
+        - name: fax_phone_number
+          table: phones
+          constraints:
+            - type: reference
+              name: patient_id
+              parent: id
+            - type: static
+              name: phone_number_type
+              value: fax
+````
 
+Also note to further maintain backwards compatibility, queries issued against
+tree based models do not need the "from" attribute to be defined. This is
+because the from/starting point of the query can be inferred as the model at
+the root of the tree.
 ## Contributing
 
 ### Development Environment Configuration

data/dbee.gemspec

@@ -34,9 +34,12 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency('guard-rspec', '~>4.7')
   s.add_development_dependency('pry', '~>0')
+  s.add_development_dependency('pry-byebug')
   s.add_development_dependency('rake', '~> 13')
   s.add_development_dependency('rspec')
-  s.add_development_dependency('rubocop', '~>0.88.0')
-  s.add_development_dependency('simplecov', '~>0.18.5')
+  s.add_development_dependency('rubocop', '~> 1')
+  s.add_development_dependency('rubocop-rake')
+  s.add_development_dependency('rubocop-rspec')
+  s.add_development_dependency('simplecov', '~>0.19.0')
   s.add_development_dependency('simplecov-console', '~>0.7.0')
 end

data/lib/dbee.rb

@@ -13,11 +13,15 @@ require 'forwardable'
 
 require_relative 'dbee/base'
 require_relative 'dbee/constant_resolver'
+require_relative 'dbee/dsl_schema_builder'
 require_relative 'dbee/key_chain'
 require_relative 'dbee/key_path'
 require_relative 'dbee/model'
-require_relative 'dbee/query'
 require_relative 'dbee/providers'
+require_relative 'dbee/query'
+require_relative 'dbee/schema'
+require_relative 'dbee/schema_creator'
+require_relative 'dbee/schema_from_tree_based_model'
 
 # Top-level namespace that provides the main public API.
 module Dbee
@@ -31,16 +35,11 @@ module Dbee
       @inflector ||= Dry::Inflector.new
     end
 
-    def sql(model, query, provider)
-      query = Query.make(query)
-      model =
-        if model.is_a?(Hash) || model.is_a?(Model)
-          Model.make(model)
-        else
-          model.to_model(query.key_chain)
-        end
+    def sql(schema_or_model, query_input, provider)
+      raise ArgumentError, 'a provider is required' unless provider
 
-      provider.sql(model, query)
+      schema_compat = SchemaCreator.new(schema_or_model, query_input)
+      provider.sql(schema_compat.schema, schema_compat.query)
     end
   end
 end

data/lib/dbee/base.rb

@@ -7,8 +7,8 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-require_relative 'dsl/association'
 require_relative 'dsl/association_builder'
+require_relative 'dsl/association'
 require_relative 'dsl/methods'
 require_relative 'dsl/reflectable'
 
@@ -22,23 +22,9 @@ module Dbee
     BASE_CLASS_CONSTANT = Dbee::Base
 
     class << self
-      # This method is cycle-resistant due to the fact that it is a requirement to send in a
-      # key_chain.  That means each model produced using to_model is specific to a set of desired
-      # fields.  Basically, you cannot derive a Model from a Base subclass without the context
-      # of a Query.  This is not true for configuration-first Model definitions because, in that
-      # case, cycles do not exist since the nature of the configuration is flat.
-      def to_model(key_chain, name = nil, constraints = [], path_parts = [])
-        derived_name  = name.to_s.empty? ? inflected_class_name(self.name) : name.to_s
-        key           = [key_chain, derived_name, constraints, path_parts]
-
-        to_models[key] ||= Model.make(
-          model_config(
-            key_chain,
-            derived_name,
-            constraints,
-            path_parts + [name]
-          )
-        )
+      # Returns the smallest needed Dbee::Schema for the provided key_chain.
+      def to_schema(key_chain)
+        DslSchemaBuilder.new(self, key_chain).to_schema
       end
 
       def inherited_table_name
@@ -58,43 +44,15 @@ module Dbee
         end
       end
 
-      private
-
-      def model_config(key_chain, name, constraints, path_parts)
-        {
-          constraints: constraints,
-          models: associations(key_chain, path_parts),
-          name: name,
-          partitioners: inherited_partitioners,
-          table: inherited_table_name
-        }
-      end
-
-      def associations(key_chain, path_parts)
-        inherited_associations.select { |c| key_chain.ancestor_path?(path_parts, c.name) }
-                              .map do |association|
-          model_constant = association.model_constant
-
-          model_constant.to_model(
-            key_chain,
-            association.name,
-            association.constraints,
-            path_parts
-          )
-        end
+      def inflected_class_name
+        inflector.underscore(inflector.demodulize(name))
       end
 
-      def to_models
-        @to_models ||= {}
-      end
+      private
 
       def inflected_table_name(name)
         inflector.pluralize(inflector.underscore(inflector.demodulize(name)))
       end
-
-      def inflected_class_name(name)
-        inflector.underscore(inflector.demodulize(name))
-      end
     end
   end
 end