dbee 1.0.0.pre.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e3da5072dedecfdcd75c8f1478c3a4f60bf477af59a48005044dc0e839e3a85d
+  data.tar.gz: 13bcece761321e1690907a05a87c257ad2829b9607152eab5d0f74f2b64605fa
+SHA512:
+  metadata.gz: 266465af7710306656ff8dc171a89c4f1f190c6d20e1959072a50bbead4e508ab4740f4c047ee187908a4414ee5b7e6f3fba66bbba8a0f2868a449165f4a1ff2
+  data.tar.gz: '09f63b6d657888cbc33d637422632345980f44cd53a56995cdc470585291aa7f77d38c877e7fa6a9c654f3f3f61890ee7a88fddf53d9b349bdddac3d7ef80f89'

data/.editorconfig

@@ -0,0 +1,8 @@
+# See http://editorconfig.org/
+
+[*]
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+end_of_line = lf

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+*.gem
+/tmp
+/coverage
+Gemfile.lock
+/pkg

data/.rubocop.yml

@@ -0,0 +1,23 @@
+Metrics/LineLength:
+  Max: 100
+
+Metrics/BlockLength:
+  ExcludedMethods:
+    - let
+    - it
+    - describe
+    - context
+    - specify
+    - define
+
+Metrics/MethodLength:
+  Max: 25
+
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/AbcSize:
+  Max: 16
+
+Metrics/ClassLength:
+  Max: 125

data/.ruby-version

@@ -0,0 +1 @@
+2.6.3

data/.travis.yml

@@ -0,0 +1,26 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=e7db23dad7560a076e48357331b0362db3741b62dbdd537bc30de27fa9cab69b
+language: ruby
+rvm:
+  # Build on the latest stable of all supported Rubies (https://www.ruby-lang.org/en/downloads/):
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - 2.6.0
+  - 2.6.3
+cache: bundler
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rubocop
+  - bundle exec rspec spec --format documentation
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+addons:
+  # https://docs.travis-ci.com/user/uploading-artifacts/
+  artifacts:
+    paths:
+      - Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# 1.0.0-alpha (August 18th, 2019)
+
+Added initial implementation.
+
+# 0.0.1 (August 18th, 2019)
+
+Created Repo Shell

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at oss@bluemarblepayroll.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'DISABLE_SIMPLECOV=true bundle exec rspec --format=documentation' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2019 Blue Marble Payroll, LLC
+
+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,368 @@
+# Dbee
+
+[![Gem Version](https://badge.fury.io/rb/dbee.svg)](https://badge.fury.io/rb/dbee) [![Build Status](https://travis-ci.org/bluemarblepayroll/dbee.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/dbee) [![Maintainability](https://api.codeclimate.com/v1/badges/208b36a1d13751687df9/maintainability)](https://codeclimate.com/github/bluemarblepayroll/dbee/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/208b36a1d13751687df9/test_coverage)](https://codeclimate.com/github/bluemarblepayroll/dbee/test_coverage) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Dbee arose out of a need for an ad-hoc reporting solution that included:
+
+* serializable queries
+* serializable data modeling
+* 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.
+
+Other solutions considered included:
+
+* [Squeel](https://github.com/activerecord-hackery/squeel) - Was in production use up until Rails 5, then saw compatibility issues.
+* [BabySqueel](https://github.com/rzane/baby_squeel) - Tested with some success up until Rails 5.2.1, then saw compatibility issues.
+
+Both of these solutions ended up closely coupling our domain data layer to ad-hoc reporting layer.  One of the primary motivations for this library was to completely de-couple the data modeling from persistence modeling.
+
+## 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.
+
+To install through Rubygems:
+
+````
+gem install install dbee
+````
+
+You can also add this to your Gemfile:
+
+````
+bundle add dbee
+````
+
+## Examples
+
+### The Data Model API
+
+Consider the following simple pseudo-schema:
+
+```
+TABLE practices (
+  id:integer,
+  active:boolean (nullable),
+  name:string
+)
+
+TABLE patients (
+  id:integer,
+  practice_id:integer,
+  first:string,
+  middle:string,
+  last:string,
+  chart_number:string
+)
+
+TABLE notes (
+  id:integer,
+  patient_id:integer,
+  note_type:string,
+  contents:string
+)
+
+TABLE phones (
+  id:integer,
+  patient_id:integer,
+  phone_number_type:string,
+  number:string
+  )
+```
+
+*Note: Do not think too much into the merits of the above schema, it is a contrived and simplified example.*
+
+In this example: a practice has many patients, a patient has many notes, and a patient also has many phones.  It is important to note, though, that a patient can only have one unique phone number per phone number type (such as home, cell, fax, work, etc.)
+
+There are two ways to model this schema using Dbee:
+
+1. code-first
+2. configuration-first
+
+#### Code-First Data Modeling
+
+Code-first data modeling involves creating sub-classes of Dbee::Base that describes the tables, columns, and associations.  We could model the above example as:
+
+````ruby
+module ReadmeDataModels
+  class PhoneNumbers < Dbee::Base
+    table :phones
+  end
+
+  class Notes < Dbee::Base
+  end
+
+  class Patients < Dbee::Base
+    association :notes, model: Notes, constraints: {
+      type: :reference, name: :patient_id, parent: :id
+    }
+
+    association :work_phone_number, model: PhoneNumbers, constraints: [
+      { type: :reference, name: :patient_id, parent: :id },
+      { type: :static, name: :phone_number_type, value: 'work' }
+    ]
+
+    association :cell_phone_number, model: PhoneNumbers, constraints: [
+      { type: :reference, name: :patient_id, parent: :id },
+      { type: :static, name: :phone_number_type, value: 'cell' }
+    ]
+
+    association :fax_phone_number, model: PhoneNumbers, constraints: [
+      { type: :reference, name: :patient_id, parent: :id },
+      { type: :static, name: :phone_number_type, value: 'fax' }
+    ]
+  end
+
+  class Practices < Dbee::Base
+    association :patients, model: Patients, constraints: {
+      type: :reference, name: :practice_id, parent: :id
+    }
+  end
+end
+
+````
+
+*Note: the 'table' directive is optional, and if omitted, the classes name will be turned into snake_case and used.  In the above example you can see we wanted the class name of PhoneNumbers but the table is actually 'phones'*
+
+#### Configuration-First Data Modeling
+
+You can choose to alternatively describe your data model using configuration.  The YAML below is equivalent to the Ruby sub-classes above:
+
+````yaml
+name: 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
+````
+
+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.
+
+### The Query API
+
+The Query API (Dbee::Query) is a simplified and abstract way to model an SQL query.  A Query has the following components:
+
+* fields (SELECT)
+* filters (WHERE)
+* sorters (ORDER BY)
+* limit (LIMIT/TAKE)
+
+One very important concept is that all joins are `LEFT OUTER JOIN's`.  This is an intentional simplification for our key application domain: configurable custom reporting.
+
+#### Key Paths
+
+You use key paths in order to identify columns.  All key paths are relative to the main data model.
+
+#### Sample Queries
+
+Get all practices:
+
+````ruby
+query = {
+  fields: [
+    { key_path: 'id' },
+    { key_path: 'active' },
+    { key_path: 'name' }
+  ]
+}
+````
+
+Get all practices, limit to 10, and sort by name (descending) then id (ascending):
+
+````ruby
+query = {
+  fields: [
+    { key_path: 'id' },
+    { key_path: 'active' },
+    { key_path: 'name' }
+  ],
+  sorters: [
+    { key_path: 'name', direction: :descending },
+    { key_path: 'id' }
+  ],
+  limit: 10
+}
+````
+
+Get top 5 active practices and patient whose name start with 'Sm':
+
+````ruby
+query = {
+  fields: [
+    { key_path: 'name', display: 'Practice Name' },
+    { key_path: 'patients.first', display: 'Patient First Name' },
+    { key_path: 'patients.middle', display: 'Patient Middle Name' },
+    { key_path: 'patients.last', display: 'Patient Last Name' },
+  ],
+  filters: [
+    { type: :equals, key_path: 'active', value: true },
+    { type: :starts_with, key_path: 'patients.last', value: 'Sm' },
+  ],
+  limit: 5
+}
+````
+
+Get practice IDs, patient IDs, names, and cell phone numbers that starts with '555':
+
+````ruby
+query = {
+  fields: [
+    { key_path: 'id', display: 'Practice ID #' },
+    { key_path: 'patients.id', display: 'Patient ID #' },
+    { key_path: 'patients.first', display: 'Patient First Name' },
+    { key_path: 'patients.middle', display: 'Patient Middle Name' },
+    { key_path: 'patients.last', display: 'Patient Last Name' },
+    { key_path: 'patients.cell_phone_numbers.phone_number', display: 'Patient Cell #' },
+  ],
+  filters: [
+    { type: :equals, key_path: 'active', value: true },
+    {
+      type: :starts_with,
+      key_path: 'patients.cell_phone_numbers.phone_number',
+      value: '555'
+    },
+  ]
+}
+````
+
+#### Executing a Query
+
+You execute a Query against a Data Model, using a Provider.  The sample provider: Dbee::Providers::NullProvider is just meant as a stand-in.  You will need to plug in a custom provider for real-world use. [See the reference ActiveRecord plugin implementation here.](https://github.com/bluemarblepayroll/dbee-active_record)
+
+Here are some sample executions based off the preceding examples:
+
+##### Code-First Execution
+
+````ruby
+require 'dbee'
+require 'dbee/providers/active_record_provider'
+
+class Practices < Dbee::Base; end
+
+provider = Dbee::Providers::ActiveRecordProvider.new
+
+query = {
+  fields: [
+    { key_path: 'id' },
+    { key_path: 'active' },
+    { key_path: 'name' }
+  ]
+}
+
+sql = Dbee.sql(Practices, query, provider)
+````
+
+##### Configuration-First Execution
+
+````ruby
+require 'dbee'
+require 'dbee/providers/active_record_provider'
+
+provider = Dbee::Providers::ActiveRecordProvider.new
+
+model = {
+  name: :practices
+}
+
+query = {
+  fields: [
+    { key_path: 'id' },
+    { key_path: 'active' },
+    { key_path: 'name' }
+  ]
+}
+
+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.
+
+
+## Contributing
+
+### Development Environment Configuration
+
+Basic steps to take to get this repository compiling:
+
+1. Install [Ruby](https://www.ruby-lang.org/en/documentation/installation/) (check dbee.gemspec for versions supported)
+2. Install bundler (gem install bundler)
+3. Clone the repository (git clone git@github.com:bluemarblepayroll/dbee.git)
+4. Navigate to the root folder (cd dbee)
+5. Install dependencies (bundle)
+
+### Running Tests
+
+To execute the test suite run:
+
+````bash
+bundle exec rspec spec --format documentation
+````
+
+Alternatively, you can have Guard watch for changes:
+
+````bash
+bundle exec guard
+````
+
+Also, do not forget to run Rubocop:
+
+````bash
+bundle exec rubocop
+````
+
+### Publishing
+
+Note: ensure you have proper authorization before trying to publish new versions.
+
+After code changes have successfully gone through the Pull Request review process then the following steps should be followed for publishing new versions:
+
+1. Merge Pull Request into master
+2. Update `lib/dbee/version.rb` using [semantic versioning](https://semver.org/)
+3. Install dependencies: `bundle`
+4. Update `CHANGELOG.md` with release notes
+5. Commit & push master to remote and ensure CI builds master successfully
+6. 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).
+
+## Code of Conduct
+
+Everyone interacting in this codebase, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bluemarblepayroll/dbee/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+This project is MIT Licensed.

data/Rakefile

@@ -0,0 +1,15 @@
+# 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 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2018-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 'bundler/setup'
+require 'dbee'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require 'pry'
+Pry.start

data/dbee.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require './lib/dbee/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'dbee'
+  s.version     = Dbee::VERSION
+  s.summary     = 'Adhoc Reporting SQL Generator'
+
+  s.description = <<-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.
+  DESCRIPTION
+
+  s.authors     = ['Matthew Ruggio']
+  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.homepage    = 'https://github.com/bluemarblepayroll/dbee'
+  s.license     = 'MIT'
+
+  s.required_ruby_version = '>= 2.3.8'
+
+  s.add_dependency('acts_as_hashable', '~>1', '>=1.1.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('rspec')
+  s.add_development_dependency('rubocop', '~>0.63.1')
+  s.add_development_dependency('simplecov', '~>0.16.1')
+  s.add_development_dependency('simplecov-console', '~>0.4.2')
+end